3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's awlays checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types,
550 char *arena; /* the raw storage, allocated aligned */
551 size_t size; /* its size ~4k typ */
552 U32 misc; /* type, and in future other things. */
557 /* Get the maximum number of elements in set[] such that struct arena_set
558 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
559 therefore likely to be 1 aligned memory page. */
561 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
562 - 2 * sizeof(int)) / sizeof (struct arena_desc))
565 struct arena_set* next;
566 unsigned int set_size; /* ie ARENAS_PER_SET */
567 unsigned int curr; /* index of next available arena-desc */
568 struct arena_desc set[ARENAS_PER_SET];
572 =for apidoc sv_free_arenas
574 Deallocate the memory used by all arenas. Note that all the individual SV
575 heads and bodies within the arenas must already have been freed.
580 Perl_sv_free_arenas(pTHX)
587 /* Free arenas here, but be careful about fake ones. (We assume
588 contiguity of the fake ones with the corresponding real ones.) */
590 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
591 svanext = (SV*) SvANY(sva);
592 while (svanext && SvFAKE(svanext))
593 svanext = (SV*) SvANY(svanext);
600 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
603 struct arena_set *current = aroot;
606 assert(aroot->set[i].arena);
607 Safefree(aroot->set[i].arena);
615 i = PERL_ARENA_ROOTS_SIZE;
617 PL_body_roots[i] = 0;
619 Safefree(PL_nice_chunk);
620 PL_nice_chunk = NULL;
621 PL_nice_chunk_size = 0;
627 Here are mid-level routines that manage the allocation of bodies out
628 of the various arenas. There are 5 kinds of arenas:
630 1. SV-head arenas, which are discussed and handled above
631 2. regular body arenas
632 3. arenas for reduced-size bodies
634 5. pte arenas (thread related)
636 Arena types 2 & 3 are chained by body-type off an array of
637 arena-root pointers, which is indexed by svtype. Some of the
638 larger/less used body types are malloced singly, since a large
639 unused block of them is wasteful. Also, several svtypes dont have
640 bodies; the data fits into the sv-head itself. The arena-root
641 pointer thus has a few unused root-pointers (which may be hijacked
642 later for arena types 4,5)
644 3 differs from 2 as an optimization; some body types have several
645 unused fields in the front of the structure (which are kept in-place
646 for consistency). These bodies can be allocated in smaller chunks,
647 because the leading fields arent accessed. Pointers to such bodies
648 are decremented to point at the unused 'ghost' memory, knowing that
649 the pointers are used with offsets to the real memory.
651 HE, HEK arenas are managed separately, with separate code, but may
652 be merge-able later..
654 PTE arenas are not sv-bodies, but they share these mid-level
655 mechanics, so are considered here. The new mid-level mechanics rely
656 on the sv_type of the body being allocated, so we just reserve one
657 of the unused body-slots for PTEs, then use it in those (2) PTE
658 contexts below (line ~10k)
661 /* get_arena(size): this creates custom-sized arenas
662 TBD: export properly for hv.c: S_more_he().
665 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
668 struct arena_desc* adesc;
669 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
672 /* shouldnt need this
673 if (!arena_size) arena_size = PERL_ARENA_SIZE;
676 /* may need new arena-set to hold new arena */
677 if (!aroot || aroot->curr >= aroot->set_size) {
678 struct arena_set *newroot;
679 Newxz(newroot, 1, struct arena_set);
680 newroot->set_size = ARENAS_PER_SET;
681 newroot->next = aroot;
683 PL_body_arenas = (void *) newroot;
684 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
687 /* ok, now have arena-set with at least 1 empty/available arena-desc */
688 curr = aroot->curr++;
689 adesc = &(aroot->set[curr]);
690 assert(!adesc->arena);
692 Newx(adesc->arena, arena_size, char);
693 adesc->size = arena_size;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
696 curr, (void*)adesc->arena, (UV)arena_size));
702 /* return a thing to the free list */
704 #define del_body(thing, root) \
706 void ** const thing_copy = (void **)thing;\
707 *thing_copy = *root; \
708 *root = (void*)thing_copy; \
713 =head1 SV-Body Allocation
715 Allocation of SV-bodies is similar to SV-heads, differing as follows;
716 the allocation mechanism is used for many body types, so is somewhat
717 more complicated, it uses arena-sets, and has no need for still-live
720 At the outermost level, (new|del)_X*V macros return bodies of the
721 appropriate type. These macros call either (new|del)_body_type or
722 (new|del)_body_allocated macro pairs, depending on specifics of the
723 type. Most body types use the former pair, the latter pair is used to
724 allocate body types with "ghost fields".
726 "ghost fields" are fields that are unused in certain types, and
727 consequently dont need to actually exist. They are declared because
728 they're part of a "base type", which allows use of functions as
729 methods. The simplest examples are AVs and HVs, 2 aggregate types
730 which don't use the fields which support SCALAR semantics.
732 For these types, the arenas are carved up into *_allocated size
733 chunks, we thus avoid wasted memory for those unaccessed members.
734 When bodies are allocated, we adjust the pointer back in memory by the
735 size of the bit not allocated, so it's as if we allocated the full
736 structure. (But things will all go boom if you write to the part that
737 is "not there", because you'll be overwriting the last members of the
738 preceding structure in memory.)
740 We calculate the correction using the STRUCT_OFFSET macro. For
741 example, if xpv_allocated is the same structure as XPV then the two
742 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
743 structure is smaller (no initial NV actually allocated) then the net
744 effect is to subtract the size of the NV from the pointer, to return a
745 new pointer as if an initial NV were actually allocated.
747 This is the same trick as was used for NV and IV bodies. Ironically it
748 doesn't need to be used for NV bodies any more, because NV is now at
749 the start of the structure. IV bodies don't need it either, because
750 they are no longer allocated.
752 In turn, the new_body_* allocators call S_new_body(), which invokes
753 new_body_inline macro, which takes a lock, and takes a body off the
754 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
755 necessary to refresh an empty list. Then the lock is released, and
756 the body is returned.
758 S_more_bodies calls get_arena(), and carves it up into an array of N
759 bodies, which it strings into a linked list. It looks up arena-size
760 and body-size from the body_details table described below, thus
761 supporting the multiple body-types.
763 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
764 the (new|del)_X*V macros are mapped directly to malloc/free.
770 For each sv-type, struct body_details bodies_by_type[] carries
771 parameters which control these aspects of SV handling:
773 Arena_size determines whether arenas are used for this body type, and if
774 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
775 zero, forcing individual mallocs and frees.
777 Body_size determines how big a body is, and therefore how many fit into
778 each arena. Offset carries the body-pointer adjustment needed for
779 *_allocated body types, and is used in *_allocated macros.
781 But its main purpose is to parameterize info needed in
782 Perl_sv_upgrade(). The info here dramatically simplifies the function
783 vs the implementation in 5.8.7, making it table-driven. All fields
784 are used for this, except for arena_size.
786 For the sv-types that have no bodies, arenas are not used, so those
787 PL_body_roots[sv_type] are unused, and can be overloaded. In
788 something of a special case, SVt_NULL is borrowed for HE arenas;
789 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
790 bodies_by_type[SVt_NULL] slot is not used, as the table is not
793 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
794 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
795 just use the same allocation semantics. At first, PTEs were also
796 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
797 bugs, so was simplified by claiming a new slot. This choice has no
798 consequence at this time.
802 struct body_details {
803 U8 body_size; /* Size to allocate */
804 U8 copy; /* Size of structure to copy (may be shorter) */
806 unsigned int type : 4; /* We have space for a sanity check. */
807 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
808 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
809 unsigned int arena : 1; /* Allocated from an arena */
810 size_t arena_size; /* Size of arena to allocate */
818 /* With -DPURFIY we allocate everything directly, and don't use arenas.
819 This seems a rather elegant way to simplify some of the code below. */
820 #define HASARENA FALSE
822 #define HASARENA TRUE
824 #define NOARENA FALSE
826 /* Size the arenas to exactly fit a given number of bodies. A count
827 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
828 simplifying the default. If count > 0, the arena is sized to fit
829 only that many bodies, allowing arenas to be used for large, rare
830 bodies (XPVFM, XPVIO) without undue waste. The arena size is
831 limited by PERL_ARENA_SIZE, so we can safely oversize the
834 #define FIT_ARENA0(body_size) \
835 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
836 #define FIT_ARENAn(count,body_size) \
837 ( count * body_size <= PERL_ARENA_SIZE) \
838 ? count * body_size \
839 : FIT_ARENA0 (body_size)
840 #define FIT_ARENA(count,body_size) \
842 ? FIT_ARENAn (count, body_size) \
843 : FIT_ARENA0 (body_size)
845 /* A macro to work out the offset needed to subtract from a pointer to (say)
852 to make its members accessible via a pointer to (say)
862 #define relative_STRUCT_OFFSET(longer, shorter, member) \
863 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
865 /* Calculate the length to copy. Specifically work out the length less any
866 final padding the compiler needed to add. See the comment in sv_upgrade
867 for why copying the padding proved to be a bug. */
869 #define copy_length(type, last_member) \
870 STRUCT_OFFSET(type, last_member) \
871 + sizeof (((type*)SvANY((SV*)0))->last_member)
873 static const struct body_details bodies_by_type[] = {
874 { sizeof(HE), 0, 0, SVt_NULL,
875 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
877 /* The bind placeholder pretends to be an RV for now.
878 Also it's marked as "can't upgrade" to stop anyone using it before it's
880 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
882 /* IVs are in the head, so the allocation size is 0.
883 However, the slot is overloaded for PTEs. */
884 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
885 sizeof(IV), /* This is used to copy out the IV body. */
886 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
887 NOARENA /* IVS don't need an arena */,
888 /* But PTEs need to know the size of their arena */
889 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
892 /* 8 bytes on most ILP32 with IEEE doubles */
893 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
894 FIT_ARENA(0, sizeof(NV)) },
896 /* RVs are in the head now. */
897 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(xpv_allocated),
901 copy_length(XPV, xpv_len)
902 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
903 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
907 { sizeof(xpviv_allocated),
908 copy_length(XPVIV, xiv_u)
909 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
914 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
915 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
918 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
919 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
922 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
926 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
929 { sizeof(xpvav_allocated),
930 copy_length(XPVAV, xmg_stash)
931 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
932 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
935 { sizeof(xpvhv_allocated),
936 copy_length(XPVHV, xmg_stash)
937 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
938 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
942 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
943 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
944 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
946 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
947 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
948 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
950 /* XPVIO is 84 bytes, fits 48x */
951 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
952 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
955 #define new_body_type(sv_type) \
956 (void *)((char *)S_new_body(aTHX_ sv_type))
958 #define del_body_type(p, sv_type) \
959 del_body(p, &PL_body_roots[sv_type])
962 #define new_body_allocated(sv_type) \
963 (void *)((char *)S_new_body(aTHX_ sv_type) \
964 - bodies_by_type[sv_type].offset)
966 #define del_body_allocated(p, sv_type) \
967 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
970 #define my_safemalloc(s) (void*)safemalloc(s)
971 #define my_safecalloc(s) (void*)safecalloc(s, 1)
972 #define my_safefree(p) safefree((char*)p)
976 #define new_XNV() my_safemalloc(sizeof(XPVNV))
977 #define del_XNV(p) my_safefree(p)
979 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
980 #define del_XPVNV(p) my_safefree(p)
982 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
983 #define del_XPVAV(p) my_safefree(p)
985 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
986 #define del_XPVHV(p) my_safefree(p)
988 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
989 #define del_XPVMG(p) my_safefree(p)
991 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
992 #define del_XPVGV(p) my_safefree(p)
996 #define new_XNV() new_body_type(SVt_NV)
997 #define del_XNV(p) del_body_type(p, SVt_NV)
999 #define new_XPVNV() new_body_type(SVt_PVNV)
1000 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1002 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1003 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1005 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1006 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1008 #define new_XPVMG() new_body_type(SVt_PVMG)
1009 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1011 #define new_XPVGV() new_body_type(SVt_PVGV)
1012 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1016 /* no arena for you! */
1018 #define new_NOARENA(details) \
1019 my_safemalloc((details)->body_size + (details)->offset)
1020 #define new_NOARENAZ(details) \
1021 my_safecalloc((details)->body_size + (details)->offset)
1024 S_more_bodies (pTHX_ svtype sv_type)
1027 void ** const root = &PL_body_roots[sv_type];
1028 const struct body_details * const bdp = &bodies_by_type[sv_type];
1029 const size_t body_size = bdp->body_size;
1032 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1033 static bool done_sanity_check;
1035 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1036 * variables like done_sanity_check. */
1037 if (!done_sanity_check) {
1038 unsigned int i = SVt_LAST;
1040 done_sanity_check = TRUE;
1043 assert (bodies_by_type[i].type == i);
1047 assert(bdp->arena_size);
1049 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1051 end = start + bdp->arena_size - body_size;
1053 /* computed count doesnt reflect the 1st slot reservation */
1054 DEBUG_m(PerlIO_printf(Perl_debug_log,
1055 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1056 (void*)start, (void*)end,
1057 (int)bdp->arena_size, sv_type, (int)body_size,
1058 (int)bdp->arena_size / (int)body_size));
1060 *root = (void *)start;
1062 while (start < end) {
1063 char * const next = start + body_size;
1064 *(void**) start = (void *)next;
1067 *(void **)start = 0;
1072 /* grab a new thing from the free list, allocating more if necessary.
1073 The inline version is used for speed in hot routines, and the
1074 function using it serves the rest (unless PURIFY).
1076 #define new_body_inline(xpv, sv_type) \
1078 void ** const r3wt = &PL_body_roots[sv_type]; \
1079 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1080 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1081 *(r3wt) = *(void**)(xpv); \
1087 S_new_body(pTHX_ svtype sv_type)
1091 new_body_inline(xpv, sv_type);
1098 =for apidoc sv_upgrade
1100 Upgrade an SV to a more complex form. Generally adds a new body type to the
1101 SV, then copies across as much information as possible from the old body.
1102 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1108 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1113 const svtype old_type = SvTYPE(sv);
1114 const struct body_details *new_type_details;
1115 const struct body_details *const old_type_details
1116 = bodies_by_type + old_type;
1118 if (new_type != SVt_PV && SvIsCOW(sv)) {
1119 sv_force_normal_flags(sv, 0);
1122 if (old_type == new_type)
1125 if (old_type > new_type)
1126 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1127 (int)old_type, (int)new_type);
1130 old_body = SvANY(sv);
1132 /* Copying structures onto other structures that have been neatly zeroed
1133 has a subtle gotcha. Consider XPVMG
1135 +------+------+------+------+------+-------+-------+
1136 | NV | CUR | LEN | IV | MAGIC | STASH |
1137 +------+------+------+------+------+-------+-------+
1138 0 4 8 12 16 20 24 28
1140 where NVs are aligned to 8 bytes, so that sizeof that structure is
1141 actually 32 bytes long, with 4 bytes of padding at the end:
1143 +------+------+------+------+------+-------+-------+------+
1144 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1145 +------+------+------+------+------+-------+-------+------+
1146 0 4 8 12 16 20 24 28 32
1148 so what happens if you allocate memory for this structure:
1150 +------+------+------+------+------+-------+-------+------+------+...
1151 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1152 +------+------+------+------+------+-------+-------+------+------+...
1153 0 4 8 12 16 20 24 28 32 36
1155 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1156 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1157 started out as zero once, but it's quite possible that it isn't. So now,
1158 rather than a nicely zeroed GP, you have it pointing somewhere random.
1161 (In fact, GP ends up pointing at a previous GP structure, because the
1162 principle cause of the padding in XPVMG getting garbage is a copy of
1163 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1164 this happens to be moot because XPVGV has been re-ordered, with GP
1165 no longer after STASH)
1167 So we are careful and work out the size of used parts of all the
1174 if (new_type < SVt_PVIV) {
1175 new_type = (new_type == SVt_NV)
1176 ? SVt_PVNV : SVt_PVIV;
1180 if (new_type < SVt_PVNV) {
1181 new_type = SVt_PVNV;
1187 assert(new_type > SVt_PV);
1188 assert(SVt_IV < SVt_PV);
1189 assert(SVt_NV < SVt_PV);
1196 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1197 there's no way that it can be safely upgraded, because perl.c
1198 expects to Safefree(SvANY(PL_mess_sv)) */
1199 assert(sv != PL_mess_sv);
1200 /* This flag bit is used to mean other things in other scalar types.
1201 Given that it only has meaning inside the pad, it shouldn't be set
1202 on anything that can get upgraded. */
1203 assert(!SvPAD_TYPED(sv));
1206 if (old_type_details->cant_upgrade)
1207 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1208 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1210 new_type_details = bodies_by_type + new_type;
1212 SvFLAGS(sv) &= ~SVTYPEMASK;
1213 SvFLAGS(sv) |= new_type;
1215 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1216 the return statements above will have triggered. */
1217 assert (new_type != SVt_NULL);
1220 assert(old_type == SVt_NULL);
1221 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1225 assert(old_type == SVt_NULL);
1226 SvANY(sv) = new_XNV();
1230 assert(old_type == SVt_NULL);
1231 SvANY(sv) = &sv->sv_u.svu_rv;
1236 assert(new_type_details->body_size);
1239 assert(new_type_details->arena);
1240 assert(new_type_details->arena_size);
1241 /* This points to the start of the allocated area. */
1242 new_body_inline(new_body, new_type);
1243 Zero(new_body, new_type_details->body_size, char);
1244 new_body = ((char *)new_body) - new_type_details->offset;
1246 /* We always allocated the full length item with PURIFY. To do this
1247 we fake things so that arena is false for all 16 types.. */
1248 new_body = new_NOARENAZ(new_type_details);
1250 SvANY(sv) = new_body;
1251 if (new_type == SVt_PVAV) {
1257 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1258 The target created by newSVrv also is, and it can have magic.
1259 However, it never has SvPVX set.
1261 if (old_type >= SVt_RV) {
1262 assert(SvPVX_const(sv) == 0);
1265 if (old_type >= SVt_PVMG) {
1266 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1267 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1269 sv->sv_u.svu_array = NULL; /* or svu_hash */
1275 /* XXX Is this still needed? Was it ever needed? Surely as there is
1276 no route from NV to PVIV, NOK can never be true */
1277 assert(!SvNOKp(sv));
1288 assert(new_type_details->body_size);
1289 /* We always allocated the full length item with PURIFY. To do this
1290 we fake things so that arena is false for all 16 types.. */
1291 if(new_type_details->arena) {
1292 /* This points to the start of the allocated area. */
1293 new_body_inline(new_body, new_type);
1294 Zero(new_body, new_type_details->body_size, char);
1295 new_body = ((char *)new_body) - new_type_details->offset;
1297 new_body = new_NOARENAZ(new_type_details);
1299 SvANY(sv) = new_body;
1301 if (old_type_details->copy) {
1302 /* There is now the potential for an upgrade from something without
1303 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1304 int offset = old_type_details->offset;
1305 int length = old_type_details->copy;
1307 if (new_type_details->offset > old_type_details->offset) {
1308 const int difference
1309 = new_type_details->offset - old_type_details->offset;
1310 offset += difference;
1311 length -= difference;
1313 assert (length >= 0);
1315 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1319 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1320 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1321 * correct 0.0 for us. Otherwise, if the old body didn't have an
1322 * NV slot, but the new one does, then we need to initialise the
1323 * freshly created NV slot with whatever the correct bit pattern is
1325 if (old_type_details->zero_nv && !new_type_details->zero_nv
1326 && !isGV_with_GP(sv))
1330 if (new_type == SVt_PVIO)
1331 IoPAGE_LEN(sv) = 60;
1332 if (old_type < SVt_RV)
1336 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1337 (unsigned long)new_type);
1340 if (old_type_details->arena) {
1341 /* If there was an old body, then we need to free it.
1342 Note that there is an assumption that all bodies of types that
1343 can be upgraded came from arenas. Only the more complex non-
1344 upgradable types are allowed to be directly malloc()ed. */
1346 my_safefree(old_body);
1348 del_body((void*)((char*)old_body + old_type_details->offset),
1349 &PL_body_roots[old_type]);
1355 =for apidoc sv_backoff
1357 Remove any string offset. You should normally use the C<SvOOK_off> macro
1364 Perl_sv_backoff(pTHX_ register SV *sv)
1366 PERL_UNUSED_CONTEXT;
1368 assert(SvTYPE(sv) != SVt_PVHV);
1369 assert(SvTYPE(sv) != SVt_PVAV);
1371 const char * const s = SvPVX_const(sv);
1372 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1373 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1375 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1377 SvFLAGS(sv) &= ~SVf_OOK;
1384 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1385 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1386 Use the C<SvGROW> wrapper instead.
1392 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1396 if (PL_madskills && newlen >= 0x100000) {
1397 PerlIO_printf(Perl_debug_log,
1398 "Allocation too large: %"UVxf"\n", (UV)newlen);
1400 #ifdef HAS_64K_LIMIT
1401 if (newlen >= 0x10000) {
1402 PerlIO_printf(Perl_debug_log,
1403 "Allocation too large: %"UVxf"\n", (UV)newlen);
1406 #endif /* HAS_64K_LIMIT */
1409 if (SvTYPE(sv) < SVt_PV) {
1410 sv_upgrade(sv, SVt_PV);
1411 s = SvPVX_mutable(sv);
1413 else if (SvOOK(sv)) { /* pv is offset? */
1415 s = SvPVX_mutable(sv);
1416 if (newlen > SvLEN(sv))
1417 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1418 #ifdef HAS_64K_LIMIT
1419 if (newlen >= 0x10000)
1424 s = SvPVX_mutable(sv);
1426 if (newlen > SvLEN(sv)) { /* need more room? */
1427 newlen = PERL_STRLEN_ROUNDUP(newlen);
1428 if (SvLEN(sv) && s) {
1430 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1436 s = (char*)saferealloc(s, newlen);
1439 s = (char*)safemalloc(newlen);
1440 if (SvPVX_const(sv) && SvCUR(sv)) {
1441 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1445 SvLEN_set(sv, newlen);
1451 =for apidoc sv_setiv
1453 Copies an integer into the given SV, upgrading first if necessary.
1454 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1460 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1463 SV_CHECK_THINKFIRST_COW_DROP(sv);
1464 switch (SvTYPE(sv)) {
1466 sv_upgrade(sv, SVt_IV);
1469 sv_upgrade(sv, SVt_PVNV);
1473 sv_upgrade(sv, SVt_PVIV);
1482 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1486 (void)SvIOK_only(sv); /* validate number */
1492 =for apidoc sv_setiv_mg
1494 Like C<sv_setiv>, but also handles 'set' magic.
1500 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1507 =for apidoc sv_setuv
1509 Copies an unsigned integer into the given SV, upgrading first if necessary.
1510 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1516 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1518 /* With these two if statements:
1519 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1522 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1524 If you wish to remove them, please benchmark to see what the effect is
1526 if (u <= (UV)IV_MAX) {
1527 sv_setiv(sv, (IV)u);
1536 =for apidoc sv_setuv_mg
1538 Like C<sv_setuv>, but also handles 'set' magic.
1544 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1551 =for apidoc sv_setnv
1553 Copies a double into the given SV, upgrading first if necessary.
1554 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1560 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1563 SV_CHECK_THINKFIRST_COW_DROP(sv);
1564 switch (SvTYPE(sv)) {
1567 sv_upgrade(sv, SVt_NV);
1572 sv_upgrade(sv, SVt_PVNV);
1581 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1586 (void)SvNOK_only(sv); /* validate number */
1591 =for apidoc sv_setnv_mg
1593 Like C<sv_setnv>, but also handles 'set' magic.
1599 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1605 /* Print an "isn't numeric" warning, using a cleaned-up,
1606 * printable version of the offending string
1610 S_not_a_number(pTHX_ SV *sv)
1618 dsv = sv_2mortal(newSVpvs(""));
1619 pv = sv_uni_display(dsv, sv, 10, 0);
1622 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1623 /* each *s can expand to 4 chars + "...\0",
1624 i.e. need room for 8 chars */
1626 const char *s = SvPVX_const(sv);
1627 const char * const end = s + SvCUR(sv);
1628 for ( ; s < end && d < limit; s++ ) {
1630 if (ch & 128 && !isPRINT_LC(ch)) {
1639 else if (ch == '\r') {
1643 else if (ch == '\f') {
1647 else if (ch == '\\') {
1651 else if (ch == '\0') {
1655 else if (isPRINT_LC(ch))
1672 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1673 "Argument \"%s\" isn't numeric in %s", pv,
1676 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1677 "Argument \"%s\" isn't numeric", pv);
1681 =for apidoc looks_like_number
1683 Test if the content of an SV looks like a number (or is a number).
1684 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1685 non-numeric warning), even if your atof() doesn't grok them.
1691 Perl_looks_like_number(pTHX_ SV *sv)
1693 register const char *sbegin;
1697 sbegin = SvPVX_const(sv);
1700 else if (SvPOKp(sv))
1701 sbegin = SvPV_const(sv, len);
1703 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1704 return grok_number(sbegin, len, NULL);
1708 S_glob_2number(pTHX_ GV * const gv)
1710 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1711 SV *const buffer = sv_newmortal();
1713 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1716 gv_efullname3(buffer, gv, "*");
1717 SvFLAGS(gv) |= wasfake;
1719 /* We know that all GVs stringify to something that is not-a-number,
1720 so no need to test that. */
1721 if (ckWARN(WARN_NUMERIC))
1722 not_a_number(buffer);
1723 /* We just want something true to return, so that S_sv_2iuv_common
1724 can tail call us and return true. */
1729 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1731 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1732 SV *const buffer = sv_newmortal();
1734 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1737 gv_efullname3(buffer, gv, "*");
1738 SvFLAGS(gv) |= wasfake;
1740 assert(SvPOK(buffer));
1742 *len = SvCUR(buffer);
1744 return SvPVX(buffer);
1747 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1748 until proven guilty, assume that things are not that bad... */
1753 As 64 bit platforms often have an NV that doesn't preserve all bits of
1754 an IV (an assumption perl has been based on to date) it becomes necessary
1755 to remove the assumption that the NV always carries enough precision to
1756 recreate the IV whenever needed, and that the NV is the canonical form.
1757 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1758 precision as a side effect of conversion (which would lead to insanity
1759 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1760 1) to distinguish between IV/UV/NV slots that have cached a valid
1761 conversion where precision was lost and IV/UV/NV slots that have a
1762 valid conversion which has lost no precision
1763 2) to ensure that if a numeric conversion to one form is requested that
1764 would lose precision, the precise conversion (or differently
1765 imprecise conversion) is also performed and cached, to prevent
1766 requests for different numeric formats on the same SV causing
1767 lossy conversion chains. (lossless conversion chains are perfectly
1772 SvIOKp is true if the IV slot contains a valid value
1773 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1774 SvNOKp is true if the NV slot contains a valid value
1775 SvNOK is true only if the NV value is accurate
1778 while converting from PV to NV, check to see if converting that NV to an
1779 IV(or UV) would lose accuracy over a direct conversion from PV to
1780 IV(or UV). If it would, cache both conversions, return NV, but mark
1781 SV as IOK NOKp (ie not NOK).
1783 While converting from PV to IV, check to see if converting that IV to an
1784 NV would lose accuracy over a direct conversion from PV to NV. If it
1785 would, cache both conversions, flag similarly.
1787 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1788 correctly because if IV & NV were set NV *always* overruled.
1789 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1790 changes - now IV and NV together means that the two are interchangeable:
1791 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1793 The benefit of this is that operations such as pp_add know that if
1794 SvIOK is true for both left and right operands, then integer addition
1795 can be used instead of floating point (for cases where the result won't
1796 overflow). Before, floating point was always used, which could lead to
1797 loss of precision compared with integer addition.
1799 * making IV and NV equal status should make maths accurate on 64 bit
1801 * may speed up maths somewhat if pp_add and friends start to use
1802 integers when possible instead of fp. (Hopefully the overhead in
1803 looking for SvIOK and checking for overflow will not outweigh the
1804 fp to integer speedup)
1805 * will slow down integer operations (callers of SvIV) on "inaccurate"
1806 values, as the change from SvIOK to SvIOKp will cause a call into
1807 sv_2iv each time rather than a macro access direct to the IV slot
1808 * should speed up number->string conversion on integers as IV is
1809 favoured when IV and NV are equally accurate
1811 ####################################################################
1812 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1813 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1814 On the other hand, SvUOK is true iff UV.
1815 ####################################################################
1817 Your mileage will vary depending your CPU's relative fp to integer
1821 #ifndef NV_PRESERVES_UV
1822 # define IS_NUMBER_UNDERFLOW_IV 1
1823 # define IS_NUMBER_UNDERFLOW_UV 2
1824 # define IS_NUMBER_IV_AND_UV 2
1825 # define IS_NUMBER_OVERFLOW_IV 4
1826 # define IS_NUMBER_OVERFLOW_UV 5
1828 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1830 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1832 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1835 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1836 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1837 if (SvNVX(sv) < (NV)IV_MIN) {
1838 (void)SvIOKp_on(sv);
1840 SvIV_set(sv, IV_MIN);
1841 return IS_NUMBER_UNDERFLOW_IV;
1843 if (SvNVX(sv) > (NV)UV_MAX) {
1844 (void)SvIOKp_on(sv);
1847 SvUV_set(sv, UV_MAX);
1848 return IS_NUMBER_OVERFLOW_UV;
1850 (void)SvIOKp_on(sv);
1852 /* Can't use strtol etc to convert this string. (See truth table in
1854 if (SvNVX(sv) <= (UV)IV_MAX) {
1855 SvIV_set(sv, I_V(SvNVX(sv)));
1856 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1857 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1859 /* Integer is imprecise. NOK, IOKp */
1861 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1864 SvUV_set(sv, U_V(SvNVX(sv)));
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866 if (SvUVX(sv) == UV_MAX) {
1867 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1868 possibly be preserved by NV. Hence, it must be overflow.
1870 return IS_NUMBER_OVERFLOW_UV;
1872 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return IS_NUMBER_OVERFLOW_IV;
1878 #endif /* !NV_PRESERVES_UV*/
1881 S_sv_2iuv_common(pTHX_ SV *sv) {
1884 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1885 * without also getting a cached IV/UV from it at the same time
1886 * (ie PV->NV conversion should detect loss of accuracy and cache
1887 * IV or UV at same time to avoid this. */
1888 /* IV-over-UV optimisation - choose to cache IV if possible */
1890 if (SvTYPE(sv) == SVt_NV)
1891 sv_upgrade(sv, SVt_PVNV);
1893 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1894 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1895 certainly cast into the IV range at IV_MAX, whereas the correct
1896 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1898 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1899 if (Perl_isnan(SvNVX(sv))) {
1905 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1906 SvIV_set(sv, I_V(SvNVX(sv)));
1907 if (SvNVX(sv) == (NV) SvIVX(sv)
1908 #ifndef NV_PRESERVES_UV
1909 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1910 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1911 /* Don't flag it as "accurately an integer" if the number
1912 came from a (by definition imprecise) NV operation, and
1913 we're outside the range of NV integer precision */
1916 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1917 DEBUG_c(PerlIO_printf(Perl_debug_log,
1918 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1924 /* IV not precise. No need to convert from PV, as NV
1925 conversion would already have cached IV if it detected
1926 that PV->IV would be better than PV->NV->IV
1927 flags already correct - don't set public IOK. */
1928 DEBUG_c(PerlIO_printf(Perl_debug_log,
1929 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1934 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1935 but the cast (NV)IV_MIN rounds to a the value less (more
1936 negative) than IV_MIN which happens to be equal to SvNVX ??
1937 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1938 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1939 (NV)UVX == NVX are both true, but the values differ. :-(
1940 Hopefully for 2s complement IV_MIN is something like
1941 0x8000000000000000 which will be exact. NWC */
1944 SvUV_set(sv, U_V(SvNVX(sv)));
1946 (SvNVX(sv) == (NV) SvUVX(sv))
1947 #ifndef NV_PRESERVES_UV
1948 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1949 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1950 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1951 /* Don't flag it as "accurately an integer" if the number
1952 came from a (by definition imprecise) NV operation, and
1953 we're outside the range of NV integer precision */
1958 DEBUG_c(PerlIO_printf(Perl_debug_log,
1959 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1965 else if (SvPOKp(sv) && SvLEN(sv)) {
1967 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1968 /* We want to avoid a possible problem when we cache an IV/ a UV which
1969 may be later translated to an NV, and the resulting NV is not
1970 the same as the direct translation of the initial string
1971 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1972 be careful to ensure that the value with the .456 is around if the
1973 NV value is requested in the future).
1975 This means that if we cache such an IV/a UV, we need to cache the
1976 NV as well. Moreover, we trade speed for space, and do not
1977 cache the NV if we are sure it's not needed.
1980 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1981 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1982 == IS_NUMBER_IN_UV) {
1983 /* It's definitely an integer, only upgrade to PVIV */
1984 if (SvTYPE(sv) < SVt_PVIV)
1985 sv_upgrade(sv, SVt_PVIV);
1987 } else if (SvTYPE(sv) < SVt_PVNV)
1988 sv_upgrade(sv, SVt_PVNV);
1990 /* If NVs preserve UVs then we only use the UV value if we know that
1991 we aren't going to call atof() below. If NVs don't preserve UVs
1992 then the value returned may have more precision than atof() will
1993 return, even though value isn't perfectly accurate. */
1994 if ((numtype & (IS_NUMBER_IN_UV
1995 #ifdef NV_PRESERVES_UV
1998 )) == IS_NUMBER_IN_UV) {
1999 /* This won't turn off the public IOK flag if it was set above */
2000 (void)SvIOKp_on(sv);
2002 if (!(numtype & IS_NUMBER_NEG)) {
2004 if (value <= (UV)IV_MAX) {
2005 SvIV_set(sv, (IV)value);
2007 /* it didn't overflow, and it was positive. */
2008 SvUV_set(sv, value);
2012 /* 2s complement assumption */
2013 if (value <= (UV)IV_MIN) {
2014 SvIV_set(sv, -(IV)value);
2016 /* Too negative for an IV. This is a double upgrade, but
2017 I'm assuming it will be rare. */
2018 if (SvTYPE(sv) < SVt_PVNV)
2019 sv_upgrade(sv, SVt_PVNV);
2023 SvNV_set(sv, -(NV)value);
2024 SvIV_set(sv, IV_MIN);
2028 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2029 will be in the previous block to set the IV slot, and the next
2030 block to set the NV slot. So no else here. */
2032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2033 != IS_NUMBER_IN_UV) {
2034 /* It wasn't an (integer that doesn't overflow the UV). */
2035 SvNV_set(sv, Atof(SvPVX_const(sv)));
2037 if (! numtype && ckWARN(WARN_NUMERIC))
2040 #if defined(USE_LONG_DOUBLE)
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2045 PTR2UV(sv), SvNVX(sv)));
2048 #ifdef NV_PRESERVES_UV
2049 (void)SvIOKp_on(sv);
2051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2052 SvIV_set(sv, I_V(SvNVX(sv)));
2053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 NOOP; /* Integer is imprecise. NOK, IOKp */
2058 /* UV will not work better than IV */
2060 if (SvNVX(sv) > (NV)UV_MAX) {
2062 /* Integer is inaccurate. NOK, IOKp, is UV */
2063 SvUV_set(sv, UV_MAX);
2065 SvUV_set(sv, U_V(SvNVX(sv)));
2066 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2067 NV preservse UV so can do correct comparison. */
2068 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2071 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2076 #else /* NV_PRESERVES_UV */
2077 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2078 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2079 /* The IV/UV slot will have been set from value returned by
2080 grok_number above. The NV slot has just been set using
2083 assert (SvIOKp(sv));
2085 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2086 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2087 /* Small enough to preserve all bits. */
2088 (void)SvIOKp_on(sv);
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2093 /* Assumption: first non-preserved integer is < IV_MAX,
2094 this NV is in the preserved range, therefore: */
2095 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2097 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2101 0 0 already failed to read UV.
2102 0 1 already failed to read UV.
2103 1 0 you won't get here in this case. IV/UV
2104 slot set, public IOK, Atof() unneeded.
2105 1 1 already read UV.
2106 so there's no point in sv_2iuv_non_preserve() attempting
2107 to use atol, strtol, strtoul etc. */
2108 sv_2iuv_non_preserve (sv, numtype);
2111 #endif /* NV_PRESERVES_UV */
2115 if (isGV_with_GP(sv))
2116 return glob_2number((GV *)sv);
2118 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2119 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2122 if (SvTYPE(sv) < SVt_IV)
2123 /* Typically the caller expects that sv_any is not NULL now. */
2124 sv_upgrade(sv, SVt_IV);
2125 /* Return 0 from the caller. */
2132 =for apidoc sv_2iv_flags
2134 Return the integer value of an SV, doing any necessary string
2135 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2136 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2142 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2147 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2148 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2149 cache IVs just in case. In practice it seems that they never
2150 actually anywhere accessible by user Perl code, let alone get used
2151 in anything other than a string context. */
2152 if (flags & SV_GMAGIC)
2157 return I_V(SvNVX(sv));
2159 if (SvPOKp(sv) && SvLEN(sv)) {
2162 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2164 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2165 == IS_NUMBER_IN_UV) {
2166 /* It's definitely an integer */
2167 if (numtype & IS_NUMBER_NEG) {
2168 if (value < (UV)IV_MIN)
2171 if (value < (UV)IV_MAX)
2176 if (ckWARN(WARN_NUMERIC))
2179 return I_V(Atof(SvPVX_const(sv)));
2184 assert(SvTYPE(sv) >= SVt_PVMG);
2185 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2186 } else if (SvTHINKFIRST(sv)) {
2190 SV * const tmpstr=AMG_CALLun(sv,numer);
2191 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2192 return SvIV(tmpstr);
2195 return PTR2IV(SvRV(sv));
2198 sv_force_normal_flags(sv, 0);
2200 if (SvREADONLY(sv) && !SvOK(sv)) {
2201 if (ckWARN(WARN_UNINITIALIZED))
2207 if (S_sv_2iuv_common(aTHX_ sv))
2210 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2211 PTR2UV(sv),SvIVX(sv)));
2212 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2216 =for apidoc sv_2uv_flags
2218 Return the unsigned integer value of an SV, doing any necessary string
2219 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2220 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2226 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2231 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2232 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2233 cache IVs just in case. */
2234 if (flags & SV_GMAGIC)
2239 return U_V(SvNVX(sv));
2240 if (SvPOKp(sv) && SvLEN(sv)) {
2243 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2245 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2246 == IS_NUMBER_IN_UV) {
2247 /* It's definitely an integer */
2248 if (!(numtype & IS_NUMBER_NEG))
2252 if (ckWARN(WARN_NUMERIC))
2255 return U_V(Atof(SvPVX_const(sv)));
2260 assert(SvTYPE(sv) >= SVt_PVMG);
2261 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2262 } else if (SvTHINKFIRST(sv)) {
2266 SV *const tmpstr = AMG_CALLun(sv,numer);
2267 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2268 return SvUV(tmpstr);
2271 return PTR2UV(SvRV(sv));
2274 sv_force_normal_flags(sv, 0);
2276 if (SvREADONLY(sv) && !SvOK(sv)) {
2277 if (ckWARN(WARN_UNINITIALIZED))
2283 if (S_sv_2iuv_common(aTHX_ sv))
2287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2288 PTR2UV(sv),SvUVX(sv)));
2289 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2295 Return the num value of an SV, doing any necessary string or integer
2296 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2303 Perl_sv_2nv(pTHX_ register SV *sv)
2308 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2309 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2310 cache IVs just in case. */
2314 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2315 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2316 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2318 return Atof(SvPVX_const(sv));
2322 return (NV)SvUVX(sv);
2324 return (NV)SvIVX(sv);
2329 assert(SvTYPE(sv) >= SVt_PVMG);
2330 /* This falls through to the report_uninit near the end of the
2332 } else if (SvTHINKFIRST(sv)) {
2336 SV *const tmpstr = AMG_CALLun(sv,numer);
2337 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2338 return SvNV(tmpstr);
2341 return PTR2NV(SvRV(sv));
2344 sv_force_normal_flags(sv, 0);
2346 if (SvREADONLY(sv) && !SvOK(sv)) {
2347 if (ckWARN(WARN_UNINITIALIZED))
2352 if (SvTYPE(sv) < SVt_NV) {
2353 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2354 sv_upgrade(sv, SVt_NV);
2355 #ifdef USE_LONG_DOUBLE
2357 STORE_NUMERIC_LOCAL_SET_STANDARD();
2358 PerlIO_printf(Perl_debug_log,
2359 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2360 PTR2UV(sv), SvNVX(sv));
2361 RESTORE_NUMERIC_LOCAL();
2365 STORE_NUMERIC_LOCAL_SET_STANDARD();
2366 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2367 PTR2UV(sv), SvNVX(sv));
2368 RESTORE_NUMERIC_LOCAL();
2372 else if (SvTYPE(sv) < SVt_PVNV)
2373 sv_upgrade(sv, SVt_PVNV);
2378 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2379 #ifdef NV_PRESERVES_UV
2382 /* Only set the public NV OK flag if this NV preserves the IV */
2383 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2384 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2385 : (SvIVX(sv) == I_V(SvNVX(sv))))
2391 else if (SvPOKp(sv) && SvLEN(sv)) {
2393 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2394 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2396 #ifdef NV_PRESERVES_UV
2397 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2398 == IS_NUMBER_IN_UV) {
2399 /* It's definitely an integer */
2400 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2402 SvNV_set(sv, Atof(SvPVX_const(sv)));
2405 SvNV_set(sv, Atof(SvPVX_const(sv)));
2406 /* Only set the public NV OK flag if this NV preserves the value in
2407 the PV at least as well as an IV/UV would.
2408 Not sure how to do this 100% reliably. */
2409 /* if that shift count is out of range then Configure's test is
2410 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2412 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2413 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2414 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2415 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2416 /* Can't use strtol etc to convert this string, so don't try.
2417 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2420 /* value has been set. It may not be precise. */
2421 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2422 /* 2s complement assumption for (UV)IV_MIN */
2423 SvNOK_on(sv); /* Integer is too negative. */
2428 if (numtype & IS_NUMBER_NEG) {
2429 SvIV_set(sv, -(IV)value);
2430 } else if (value <= (UV)IV_MAX) {
2431 SvIV_set(sv, (IV)value);
2433 SvUV_set(sv, value);
2437 if (numtype & IS_NUMBER_NOT_INT) {
2438 /* I believe that even if the original PV had decimals,
2439 they are lost beyond the limit of the FP precision.
2440 However, neither is canonical, so both only get p
2441 flags. NWC, 2000/11/25 */
2442 /* Both already have p flags, so do nothing */
2444 const NV nv = SvNVX(sv);
2445 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2446 if (SvIVX(sv) == I_V(nv)) {
2449 /* It had no "." so it must be integer. */
2453 /* between IV_MAX and NV(UV_MAX).
2454 Could be slightly > UV_MAX */
2456 if (numtype & IS_NUMBER_NOT_INT) {
2457 /* UV and NV both imprecise. */
2459 const UV nv_as_uv = U_V(nv);
2461 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2470 #endif /* NV_PRESERVES_UV */
2473 if (isGV_with_GP(sv)) {
2474 glob_2number((GV *)sv);
2478 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2480 assert (SvTYPE(sv) >= SVt_NV);
2481 /* Typically the caller expects that sv_any is not NULL now. */
2482 /* XXX Ilya implies that this is a bug in callers that assume this
2483 and ideally should be fixed. */
2486 #if defined(USE_LONG_DOUBLE)
2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
2489 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2490 PTR2UV(sv), SvNVX(sv));
2491 RESTORE_NUMERIC_LOCAL();
2495 STORE_NUMERIC_LOCAL_SET_STANDARD();
2496 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2497 PTR2UV(sv), SvNVX(sv));
2498 RESTORE_NUMERIC_LOCAL();
2504 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2505 * UV as a string towards the end of buf, and return pointers to start and
2508 * We assume that buf is at least TYPE_CHARS(UV) long.
2512 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2514 char *ptr = buf + TYPE_CHARS(UV);
2515 char * const ebuf = ptr;
2528 *--ptr = '0' + (char)(uv % 10);
2537 =for apidoc sv_2pv_flags
2539 Returns a pointer to the string value of an SV, and sets *lp to its length.
2540 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2542 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2543 usually end up here too.
2549 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2559 if (SvGMAGICAL(sv)) {
2560 if (flags & SV_GMAGIC)
2565 if (flags & SV_MUTABLE_RETURN)
2566 return SvPVX_mutable(sv);
2567 if (flags & SV_CONST_RETURN)
2568 return (char *)SvPVX_const(sv);
2571 if (SvIOKp(sv) || SvNOKp(sv)) {
2572 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2577 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2578 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2580 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2587 #ifdef FIXNEGATIVEZERO
2588 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2594 SvUPGRADE(sv, SVt_PV);
2597 s = SvGROW_mutable(sv, len + 1);
2600 return (char*)memcpy(s, tbuf, len + 1);
2606 assert(SvTYPE(sv) >= SVt_PVMG);
2607 /* This falls through to the report_uninit near the end of the
2609 } else if (SvTHINKFIRST(sv)) {
2613 SV *const tmpstr = AMG_CALLun(sv,string);
2614 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2616 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2620 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2621 if (flags & SV_CONST_RETURN) {
2622 pv = (char *) SvPVX_const(tmpstr);
2624 pv = (flags & SV_MUTABLE_RETURN)
2625 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2628 *lp = SvCUR(tmpstr);
2630 pv = sv_2pv_flags(tmpstr, lp, flags);
2644 const SV *const referent = (SV*)SvRV(sv);
2648 retval = buffer = savepvn("NULLREF", len);
2649 } else if (SvTYPE(referent) == SVt_PVMG
2650 && ((SvFLAGS(referent) &
2651 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2652 == (SVs_OBJECT|SVs_SMG))
2653 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2658 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2663 PL_reginterp_cnt += haseval;
2666 const char *const typestr = sv_reftype(referent, 0);
2667 const STRLEN typelen = strlen(typestr);
2668 UV addr = PTR2UV(referent);
2669 const char *stashname = NULL;
2670 STRLEN stashnamelen = 0; /* hush, gcc */
2671 const char *buffer_end;
2673 if (SvOBJECT(referent)) {
2674 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2677 stashname = HEK_KEY(name);
2678 stashnamelen = HEK_LEN(name);
2680 if (HEK_UTF8(name)) {
2686 stashname = "__ANON__";
2689 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2690 + 2 * sizeof(UV) + 2 /* )\0 */;
2692 len = typelen + 3 /* (0x */
2693 + 2 * sizeof(UV) + 2 /* )\0 */;
2696 Newx(buffer, len, char);
2697 buffer_end = retval = buffer + len;
2699 /* Working backwards */
2703 *--retval = PL_hexdigit[addr & 15];
2704 } while (addr >>= 4);
2710 memcpy(retval, typestr, typelen);
2714 retval -= stashnamelen;
2715 memcpy(retval, stashname, stashnamelen);
2717 /* retval may not neccesarily have reached the start of the
2719 assert (retval >= buffer);
2721 len = buffer_end - retval - 1; /* -1 for that \0 */
2729 if (SvREADONLY(sv) && !SvOK(sv)) {
2730 if (ckWARN(WARN_UNINITIALIZED))
2737 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2738 /* I'm assuming that if both IV and NV are equally valid then
2739 converting the IV is going to be more efficient */
2740 const U32 isUIOK = SvIsUV(sv);
2741 char buf[TYPE_CHARS(UV)];
2745 if (SvTYPE(sv) < SVt_PVIV)
2746 sv_upgrade(sv, SVt_PVIV);
2747 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2749 /* inlined from sv_setpvn */
2750 s = SvGROW_mutable(sv, len + 1);
2751 Move(ptr, s, len, char);
2755 else if (SvNOKp(sv)) {
2756 const int olderrno = errno;
2757 if (SvTYPE(sv) < SVt_PVNV)
2758 sv_upgrade(sv, SVt_PVNV);
2759 /* The +20 is pure guesswork. Configure test needed. --jhi */
2760 s = SvGROW_mutable(sv, NV_DIG + 20);
2761 /* some Xenix systems wipe out errno here */
2763 if (SvNVX(sv) == 0.0)
2764 my_strlcpy(s, "0", SvLEN(sv));
2768 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2771 #ifdef FIXNEGATIVEZERO
2772 if (*s == '-' && s[1] == '0' && !s[2])
2773 my_strlcpy(s, "0", SvLEN(s));
2782 if (isGV_with_GP(sv))
2783 return glob_2pv((GV *)sv, lp);
2785 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2789 if (SvTYPE(sv) < SVt_PV)
2790 /* Typically the caller expects that sv_any is not NULL now. */
2791 sv_upgrade(sv, SVt_PV);
2795 const STRLEN len = s - SvPVX_const(sv);
2801 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2802 PTR2UV(sv),SvPVX_const(sv)));
2803 if (flags & SV_CONST_RETURN)
2804 return (char *)SvPVX_const(sv);
2805 if (flags & SV_MUTABLE_RETURN)
2806 return SvPVX_mutable(sv);
2811 =for apidoc sv_copypv
2813 Copies a stringified representation of the source SV into the
2814 destination SV. Automatically performs any necessary mg_get and
2815 coercion of numeric values into strings. Guaranteed to preserve
2816 UTF8 flag even from overloaded objects. Similar in nature to
2817 sv_2pv[_flags] but operates directly on an SV instead of just the
2818 string. Mostly uses sv_2pv_flags to do its work, except when that
2819 would lose the UTF-8'ness of the PV.
2825 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2828 const char * const s = SvPV_const(ssv,len);
2829 sv_setpvn(dsv,s,len);
2837 =for apidoc sv_2pvbyte
2839 Return a pointer to the byte-encoded representation of the SV, and set *lp
2840 to its length. May cause the SV to be downgraded from UTF-8 as a
2843 Usually accessed via the C<SvPVbyte> macro.
2849 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2851 sv_utf8_downgrade(sv,0);
2852 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2856 =for apidoc sv_2pvutf8
2858 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2859 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2861 Usually accessed via the C<SvPVutf8> macro.
2867 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2869 sv_utf8_upgrade(sv);
2870 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2875 =for apidoc sv_2bool
2877 This function is only called on magical items, and is only used by
2878 sv_true() or its macro equivalent.
2884 Perl_sv_2bool(pTHX_ register SV *sv)
2893 SV * const tmpsv = AMG_CALLun(sv,bool_);
2894 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2895 return (bool)SvTRUE(tmpsv);
2897 return SvRV(sv) != 0;
2900 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2902 (*sv->sv_u.svu_pv > '0' ||
2903 Xpvtmp->xpv_cur > 1 ||
2904 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2911 return SvIVX(sv) != 0;
2914 return SvNVX(sv) != 0.0;
2916 if (isGV_with_GP(sv))
2926 =for apidoc sv_utf8_upgrade
2928 Converts the PV of an SV to its UTF-8-encoded form.
2929 Forces the SV to string form if it is not already.
2930 Always sets the SvUTF8 flag to avoid future validity checks even
2931 if all the bytes have hibit clear.
2933 This is not as a general purpose byte encoding to Unicode interface:
2934 use the Encode extension for that.
2936 =for apidoc sv_utf8_upgrade_flags
2938 Converts the PV of an SV to its UTF-8-encoded form.
2939 Forces the SV to string form if it is not already.
2940 Always sets the SvUTF8 flag to avoid future validity checks even
2941 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2942 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2943 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2945 This is not as a general purpose byte encoding to Unicode interface:
2946 use the Encode extension for that.
2952 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2955 if (sv == &PL_sv_undef)
2959 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2960 (void) sv_2pv_flags(sv,&len, flags);
2964 (void) SvPV_force(sv,len);
2973 sv_force_normal_flags(sv, 0);
2976 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2977 sv_recode_to_utf8(sv, PL_encoding);
2978 else { /* Assume Latin-1/EBCDIC */
2979 /* This function could be much more efficient if we
2980 * had a FLAG in SVs to signal if there are any hibit
2981 * chars in the PV. Given that there isn't such a flag
2982 * make the loop as fast as possible. */
2983 const U8 * const s = (U8 *) SvPVX_const(sv);
2984 const U8 * const e = (U8 *) SvEND(sv);
2989 /* Check for hi bit */
2990 if (!NATIVE_IS_INVARIANT(ch)) {
2991 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2992 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2994 SvPV_free(sv); /* No longer using what was there before. */
2995 SvPV_set(sv, (char*)recoded);
2996 SvCUR_set(sv, len - 1);
2997 SvLEN_set(sv, len); /* No longer know the real size. */
3001 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3008 =for apidoc sv_utf8_downgrade
3010 Attempts to convert the PV of an SV from characters to bytes.
3011 If the PV contains a character beyond byte, this conversion will fail;
3012 in this case, either returns false or, if C<fail_ok> is not
3015 This is not as a general purpose Unicode to byte encoding interface:
3016 use the Encode extension for that.
3022 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3025 if (SvPOKp(sv) && SvUTF8(sv)) {
3031 sv_force_normal_flags(sv, 0);
3033 s = (U8 *) SvPV(sv, len);
3034 if (!utf8_to_bytes(s, &len)) {
3039 Perl_croak(aTHX_ "Wide character in %s",
3042 Perl_croak(aTHX_ "Wide character");
3053 =for apidoc sv_utf8_encode
3055 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3056 flag off so that it looks like octets again.
3062 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3065 sv_force_normal_flags(sv, 0);
3067 if (SvREADONLY(sv)) {
3068 Perl_croak(aTHX_ PL_no_modify);
3070 (void) sv_utf8_upgrade(sv);
3075 =for apidoc sv_utf8_decode
3077 If the PV of the SV is an octet sequence in UTF-8
3078 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3079 so that it looks like a character. If the PV contains only single-byte
3080 characters, the C<SvUTF8> flag stays being off.
3081 Scans PV for validity and returns false if the PV is invalid UTF-8.
3087 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3093 /* The octets may have got themselves encoded - get them back as
3096 if (!sv_utf8_downgrade(sv, TRUE))
3099 /* it is actually just a matter of turning the utf8 flag on, but
3100 * we want to make sure everything inside is valid utf8 first.
3102 c = (const U8 *) SvPVX_const(sv);
3103 if (!is_utf8_string(c, SvCUR(sv)+1))
3105 e = (const U8 *) SvEND(sv);
3108 if (!UTF8_IS_INVARIANT(ch)) {
3118 =for apidoc sv_setsv
3120 Copies the contents of the source SV C<ssv> into the destination SV
3121 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3122 function if the source SV needs to be reused. Does not handle 'set' magic.
3123 Loosely speaking, it performs a copy-by-value, obliterating any previous
3124 content of the destination.
3126 You probably want to use one of the assortment of wrappers, such as
3127 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3128 C<SvSetMagicSV_nosteal>.
3130 =for apidoc sv_setsv_flags
3132 Copies the contents of the source SV C<ssv> into the destination SV
3133 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3134 function if the source SV needs to be reused. Does not handle 'set' magic.
3135 Loosely speaking, it performs a copy-by-value, obliterating any previous
3136 content of the destination.
3137 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3138 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3139 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3140 and C<sv_setsv_nomg> are implemented in terms of this function.
3142 You probably want to use one of the assortment of wrappers, such as
3143 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3144 C<SvSetMagicSV_nosteal>.
3146 This is the primary function for copying scalars, and most other
3147 copy-ish functions and macros use this underneath.
3153 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3155 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3157 if (dtype != SVt_PVGV) {
3158 const char * const name = GvNAME(sstr);
3159 const STRLEN len = GvNAMELEN(sstr);
3161 if (dtype >= SVt_PV) {
3167 SvUPGRADE(dstr, SVt_PVGV);
3168 (void)SvOK_off(dstr);
3169 /* FIXME - why are we doing this, then turning it off and on again
3171 isGV_with_GP_on(dstr);
3173 GvSTASH(dstr) = GvSTASH(sstr);
3175 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3176 gv_name_set((GV *)dstr, name, len, GV_ADD);
3177 SvFAKE_on(dstr); /* can coerce to non-glob */
3180 #ifdef GV_UNIQUE_CHECK
3181 if (GvUNIQUE((GV*)dstr)) {
3182 Perl_croak(aTHX_ PL_no_modify);
3186 if(GvGP((GV*)sstr)) {
3187 /* If source has method cache entry, clear it */
3189 SvREFCNT_dec(GvCV(sstr));
3193 /* If source has a real method, then a method is
3195 else if(GvCV((GV*)sstr)) {
3200 /* If dest already had a real method, that's a change as well */
3201 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3205 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3209 isGV_with_GP_off(dstr);
3210 (void)SvOK_off(dstr);
3211 isGV_with_GP_on(dstr);
3212 GvINTRO_off(dstr); /* one-shot flag */
3213 GvGP(dstr) = gp_ref(GvGP(sstr));
3214 if (SvTAINTED(sstr))
3216 if (GvIMPORTED(dstr) != GVf_IMPORTED
3217 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3219 GvIMPORTED_on(dstr);
3222 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3223 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3228 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3229 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3231 const int intro = GvINTRO(dstr);
3234 const U32 stype = SvTYPE(sref);
3237 #ifdef GV_UNIQUE_CHECK
3238 if (GvUNIQUE((GV*)dstr)) {
3239 Perl_croak(aTHX_ PL_no_modify);
3244 GvINTRO_off(dstr); /* one-shot flag */
3245 GvLINE(dstr) = CopLINE(PL_curcop);
3246 GvEGV(dstr) = (GV*)dstr;
3251 location = (SV **) &GvCV(dstr);
3252 import_flag = GVf_IMPORTED_CV;
3255 location = (SV **) &GvHV(dstr);
3256 import_flag = GVf_IMPORTED_HV;
3259 location = (SV **) &GvAV(dstr);
3260 import_flag = GVf_IMPORTED_AV;
3263 location = (SV **) &GvIOp(dstr);
3266 location = (SV **) &GvFORM(dstr);
3268 location = &GvSV(dstr);
3269 import_flag = GVf_IMPORTED_SV;
3272 if (stype == SVt_PVCV) {
3273 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3274 if (GvCVGEN(dstr)) {
3275 SvREFCNT_dec(GvCV(dstr));
3277 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280 SAVEGENERICSV(*location);
3284 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3285 CV* const cv = (CV*)*location;
3287 if (!GvCVGEN((GV*)dstr) &&
3288 (CvROOT(cv) || CvXSUB(cv)))
3290 /* Redefining a sub - warning is mandatory if
3291 it was a const and its value changed. */
3292 if (CvCONST(cv) && CvCONST((CV*)sref)
3293 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3295 /* They are 2 constant subroutines generated from
3296 the same constant. This probably means that
3297 they are really the "same" proxy subroutine
3298 instantiated in 2 places. Most likely this is
3299 when a constant is exported twice. Don't warn.
3302 else if (ckWARN(WARN_REDEFINE)
3304 && (!CvCONST((CV*)sref)
3305 || sv_cmp(cv_const_sv(cv),
3306 cv_const_sv((CV*)sref))))) {
3307 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3310 ? "Constant subroutine %s::%s redefined"
3311 : "Subroutine %s::%s redefined"),
3312 HvNAME_get(GvSTASH((GV*)dstr)),
3313 GvENAME((GV*)dstr));
3317 cv_ckproto_len(cv, (GV*)dstr,
3318 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3319 SvPOK(sref) ? SvCUR(sref) : 0);
3321 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3322 GvASSUMECV_on(dstr);
3323 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3326 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3327 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3328 GvFLAGS(dstr) |= import_flag;
3333 if (SvTAINTED(sstr))
3339 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3342 register U32 sflags;
3344 register svtype stype;
3349 if (SvIS_FREED(dstr)) {
3350 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3351 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3353 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3355 sstr = &PL_sv_undef;
3356 if (SvIS_FREED(sstr)) {
3357 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3358 (void*)sstr, (void*)dstr);
3360 stype = SvTYPE(sstr);
3361 dtype = SvTYPE(dstr);
3363 (void)SvAMAGIC_off(dstr);
3366 /* need to nuke the magic */
3368 SvRMAGICAL_off(dstr);
3371 /* There's a lot of redundancy below but we're going for speed here */
3376 if (dtype != SVt_PVGV) {
3377 (void)SvOK_off(dstr);
3385 sv_upgrade(dstr, SVt_IV);
3390 sv_upgrade(dstr, SVt_PVIV);
3393 goto end_of_first_switch;
3395 (void)SvIOK_only(dstr);
3396 SvIV_set(dstr, SvIVX(sstr));
3399 /* SvTAINTED can only be true if the SV has taint magic, which in
3400 turn means that the SV type is PVMG (or greater). This is the
3401 case statement for SVt_IV, so this cannot be true (whatever gcov
3403 assert(!SvTAINTED(sstr));
3413 sv_upgrade(dstr, SVt_NV);
3418 sv_upgrade(dstr, SVt_PVNV);
3421 goto end_of_first_switch;
3423 SvNV_set(dstr, SvNVX(sstr));
3424 (void)SvNOK_only(dstr);
3425 /* SvTAINTED can only be true if the SV has taint magic, which in
3426 turn means that the SV type is PVMG (or greater). This is the
3427 case statement for SVt_NV, so this cannot be true (whatever gcov
3429 assert(!SvTAINTED(sstr));
3436 sv_upgrade(dstr, SVt_RV);
3439 #ifdef PERL_OLD_COPY_ON_WRITE
3440 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3441 if (dtype < SVt_PVIV)
3442 sv_upgrade(dstr, SVt_PVIV);
3449 sv_upgrade(dstr, SVt_PV);
3452 if (dtype < SVt_PVIV)
3453 sv_upgrade(dstr, SVt_PVIV);
3456 if (dtype < SVt_PVNV)
3457 sv_upgrade(dstr, SVt_PVNV);
3461 const char * const type = sv_reftype(sstr,0);
3463 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3465 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3469 /* case SVt_BIND: */
3472 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3473 glob_assign_glob(dstr, sstr, dtype);
3476 /* SvVALID means that this PVGV is playing at being an FBM. */
3480 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3482 if (SvTYPE(sstr) != stype) {
3483 stype = SvTYPE(sstr);
3484 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3485 glob_assign_glob(dstr, sstr, dtype);
3490 if (stype == SVt_PVLV)
3491 SvUPGRADE(dstr, SVt_PVNV);
3493 SvUPGRADE(dstr, (svtype)stype);
3495 end_of_first_switch:
3497 /* dstr may have been upgraded. */
3498 dtype = SvTYPE(dstr);
3499 sflags = SvFLAGS(sstr);
3501 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3502 /* Assigning to a subroutine sets the prototype. */
3505 const char *const ptr = SvPV_const(sstr, len);
3507 SvGROW(dstr, len + 1);
3508 Copy(ptr, SvPVX(dstr), len + 1, char);
3509 SvCUR_set(dstr, len);
3511 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3515 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3516 const char * const type = sv_reftype(dstr,0);
3518 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3520 Perl_croak(aTHX_ "Cannot copy to %s", type);
3521 } else if (sflags & SVf_ROK) {
3522 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3523 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3526 if (GvIMPORTED(dstr) != GVf_IMPORTED
3527 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3529 GvIMPORTED_on(dstr);
3534 glob_assign_glob(dstr, sstr, dtype);
3538 if (dtype >= SVt_PV) {
3539 if (dtype == SVt_PVGV) {
3540 glob_assign_ref(dstr, sstr);
3543 if (SvPVX_const(dstr)) {
3549 (void)SvOK_off(dstr);
3550 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3551 SvFLAGS(dstr) |= sflags & SVf_ROK;
3552 assert(!(sflags & SVp_NOK));
3553 assert(!(sflags & SVp_IOK));
3554 assert(!(sflags & SVf_NOK));
3555 assert(!(sflags & SVf_IOK));
3557 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3558 if (!(sflags & SVf_OK)) {
3559 if (ckWARN(WARN_MISC))
3560 Perl_warner(aTHX_ packWARN(WARN_MISC),
3561 "Undefined value assigned to typeglob");
3564 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3565 if (dstr != (SV*)gv) {
3568 GvGP(dstr) = gp_ref(GvGP(gv));
3572 else if (sflags & SVp_POK) {
3576 * Check to see if we can just swipe the string. If so, it's a
3577 * possible small lose on short strings, but a big win on long ones.
3578 * It might even be a win on short strings if SvPVX_const(dstr)
3579 * has to be allocated and SvPVX_const(sstr) has to be freed.
3580 * Likewise if we can set up COW rather than doing an actual copy, we
3581 * drop to the else clause, as the swipe code and the COW setup code
3582 * have much in common.
3585 /* Whichever path we take through the next code, we want this true,
3586 and doing it now facilitates the COW check. */
3587 (void)SvPOK_only(dstr);
3590 /* If we're already COW then this clause is not true, and if COW
3591 is allowed then we drop down to the else and make dest COW
3592 with us. If caller hasn't said that we're allowed to COW
3593 shared hash keys then we don't do the COW setup, even if the
3594 source scalar is a shared hash key scalar. */
3595 (((flags & SV_COW_SHARED_HASH_KEYS)
3596 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3597 : 1 /* If making a COW copy is forbidden then the behaviour we
3598 desire is as if the source SV isn't actually already
3599 COW, even if it is. So we act as if the source flags
3600 are not COW, rather than actually testing them. */
3602 #ifndef PERL_OLD_COPY_ON_WRITE
3603 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3604 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3605 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3606 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3607 but in turn, it's somewhat dead code, never expected to go
3608 live, but more kept as a placeholder on how to do it better
3609 in a newer implementation. */
3610 /* If we are COW and dstr is a suitable target then we drop down
3611 into the else and make dest a COW of us. */
3612 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3617 (sflags & SVs_TEMP) && /* slated for free anyway? */
3618 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3619 (!(flags & SV_NOSTEAL)) &&
3620 /* and we're allowed to steal temps */
3621 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3622 SvLEN(sstr) && /* and really is a string */
3623 /* and won't be needed again, potentially */
3624 !(PL_op && PL_op->op_type == OP_AASSIGN))
3625 #ifdef PERL_OLD_COPY_ON_WRITE
3626 && ((flags & SV_COW_SHARED_HASH_KEYS)
3627 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3628 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3629 && SvTYPE(sstr) >= SVt_PVIV))
3633 /* Failed the swipe test, and it's not a shared hash key either.
3634 Have to copy the string. */
3635 STRLEN len = SvCUR(sstr);
3636 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3637 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3638 SvCUR_set(dstr, len);
3639 *SvEND(dstr) = '\0';
3641 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3643 /* Either it's a shared hash key, or it's suitable for
3644 copy-on-write or we can swipe the string. */
3646 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3650 #ifdef PERL_OLD_COPY_ON_WRITE
3652 /* I believe I should acquire a global SV mutex if
3653 it's a COW sv (not a shared hash key) to stop
3654 it going un copy-on-write.
3655 If the source SV has gone un copy on write between up there
3656 and down here, then (assert() that) it is of the correct
3657 form to make it copy on write again */
3658 if ((sflags & (SVf_FAKE | SVf_READONLY))
3659 != (SVf_FAKE | SVf_READONLY)) {
3660 SvREADONLY_on(sstr);
3662 /* Make the source SV into a loop of 1.
3663 (about to become 2) */
3664 SV_COW_NEXT_SV_SET(sstr, sstr);
3668 /* Initial code is common. */
3669 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3674 /* making another shared SV. */
3675 STRLEN cur = SvCUR(sstr);
3676 STRLEN len = SvLEN(sstr);
3677 #ifdef PERL_OLD_COPY_ON_WRITE
3679 assert (SvTYPE(dstr) >= SVt_PVIV);
3680 /* SvIsCOW_normal */
3681 /* splice us in between source and next-after-source. */
3682 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3683 SV_COW_NEXT_SV_SET(sstr, dstr);
3684 SvPV_set(dstr, SvPVX_mutable(sstr));
3688 /* SvIsCOW_shared_hash */
3689 DEBUG_C(PerlIO_printf(Perl_debug_log,
3690 "Copy on write: Sharing hash\n"));
3692 assert (SvTYPE(dstr) >= SVt_PV);
3694 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3696 SvLEN_set(dstr, len);
3697 SvCUR_set(dstr, cur);
3698 SvREADONLY_on(dstr);
3700 /* Relesase a global SV mutex. */
3703 { /* Passes the swipe test. */
3704 SvPV_set(dstr, SvPVX_mutable(sstr));
3705 SvLEN_set(dstr, SvLEN(sstr));
3706 SvCUR_set(dstr, SvCUR(sstr));
3709 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3710 SvPV_set(sstr, NULL);
3716 if (sflags & SVp_NOK) {
3717 SvNV_set(dstr, SvNVX(sstr));
3719 if (sflags & SVp_IOK) {
3721 SvIV_set(dstr, SvIVX(sstr));
3722 /* Must do this otherwise some other overloaded use of 0x80000000
3723 gets confused. I guess SVpbm_VALID */
3724 if (sflags & SVf_IVisUV)
3727 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3729 const MAGIC * const smg = SvVSTRING_mg(sstr);
3731 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3732 smg->mg_ptr, smg->mg_len);
3733 SvRMAGICAL_on(dstr);
3737 else if (sflags & (SVp_IOK|SVp_NOK)) {
3738 (void)SvOK_off(dstr);
3739 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3740 if (sflags & SVp_IOK) {
3741 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3742 SvIV_set(dstr, SvIVX(sstr));
3744 if (sflags & SVp_NOK) {
3745 SvNV_set(dstr, SvNVX(sstr));
3749 if (isGV_with_GP(sstr)) {
3750 /* This stringification rule for globs is spread in 3 places.
3751 This feels bad. FIXME. */
3752 const U32 wasfake = sflags & SVf_FAKE;
3754 /* FAKE globs can get coerced, so need to turn this off
3755 temporarily if it is on. */
3757 gv_efullname3(dstr, (GV *)sstr, "*");
3758 SvFLAGS(sstr) |= wasfake;
3761 (void)SvOK_off(dstr);
3763 if (SvTAINTED(sstr))
3768 =for apidoc sv_setsv_mg
3770 Like C<sv_setsv>, but also handles 'set' magic.
3776 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3778 sv_setsv(dstr,sstr);
3782 #ifdef PERL_OLD_COPY_ON_WRITE
3784 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3786 STRLEN cur = SvCUR(sstr);
3787 STRLEN len = SvLEN(sstr);
3788 register char *new_pv;
3791 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3792 (void*)sstr, (void*)dstr);
3799 if (SvTHINKFIRST(dstr))
3800 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3801 else if (SvPVX_const(dstr))
3802 Safefree(SvPVX_const(dstr));
3806 SvUPGRADE(dstr, SVt_PVIV);
3808 assert (SvPOK(sstr));
3809 assert (SvPOKp(sstr));
3810 assert (!SvIOK(sstr));
3811 assert (!SvIOKp(sstr));
3812 assert (!SvNOK(sstr));
3813 assert (!SvNOKp(sstr));
3815 if (SvIsCOW(sstr)) {
3817 if (SvLEN(sstr) == 0) {
3818 /* source is a COW shared hash key. */
3819 DEBUG_C(PerlIO_printf(Perl_debug_log,
3820 "Fast copy on write: Sharing hash\n"));
3821 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3824 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3826 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3827 SvUPGRADE(sstr, SVt_PVIV);
3828 SvREADONLY_on(sstr);
3830 DEBUG_C(PerlIO_printf(Perl_debug_log,
3831 "Fast copy on write: Converting sstr to COW\n"));
3832 SV_COW_NEXT_SV_SET(dstr, sstr);
3834 SV_COW_NEXT_SV_SET(sstr, dstr);
3835 new_pv = SvPVX_mutable(sstr);
3838 SvPV_set(dstr, new_pv);
3839 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3842 SvLEN_set(dstr, len);
3843 SvCUR_set(dstr, cur);
3852 =for apidoc sv_setpvn
3854 Copies a string into an SV. The C<len> parameter indicates the number of
3855 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3856 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3862 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3865 register char *dptr;
3867 SV_CHECK_THINKFIRST_COW_DROP(sv);
3873 /* len is STRLEN which is unsigned, need to copy to signed */
3876 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3878 SvUPGRADE(sv, SVt_PV);
3880 dptr = SvGROW(sv, len + 1);
3881 Move(ptr,dptr,len,char);
3884 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3889 =for apidoc sv_setpvn_mg
3891 Like C<sv_setpvn>, but also handles 'set' magic.
3897 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3899 sv_setpvn(sv,ptr,len);
3904 =for apidoc sv_setpv
3906 Copies a string into an SV. The string must be null-terminated. Does not
3907 handle 'set' magic. See C<sv_setpv_mg>.
3913 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3916 register STRLEN len;
3918 SV_CHECK_THINKFIRST_COW_DROP(sv);
3924 SvUPGRADE(sv, SVt_PV);
3926 SvGROW(sv, len + 1);
3927 Move(ptr,SvPVX(sv),len+1,char);
3929 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3934 =for apidoc sv_setpv_mg
3936 Like C<sv_setpv>, but also handles 'set' magic.
3942 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3949 =for apidoc sv_usepvn_flags
3951 Tells an SV to use C<ptr> to find its string value. Normally the
3952 string is stored inside the SV but sv_usepvn allows the SV to use an
3953 outside string. The C<ptr> should point to memory that was allocated
3954 by C<malloc>. The string length, C<len>, must be supplied. By default
3955 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3956 so that pointer should not be freed or used by the programmer after
3957 giving it to sv_usepvn, and neither should any pointers from "behind"
3958 that pointer (e.g. ptr + 1) be used.
3960 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3961 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3962 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3963 C<len>, and already meets the requirements for storing in C<SvPVX>)
3969 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3973 SV_CHECK_THINKFIRST_COW_DROP(sv);
3974 SvUPGRADE(sv, SVt_PV);
3977 if (flags & SV_SMAGIC)
3981 if (SvPVX_const(sv))
3985 if (flags & SV_HAS_TRAILING_NUL)
3986 assert(ptr[len] == '\0');
3989 allocate = (flags & SV_HAS_TRAILING_NUL)
3990 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3991 if (flags & SV_HAS_TRAILING_NUL) {
3992 /* It's long enough - do nothing.
3993 Specfically Perl_newCONSTSUB is relying on this. */
3996 /* Force a move to shake out bugs in callers. */
3997 char *new_ptr = (char*)safemalloc(allocate);
3998 Copy(ptr, new_ptr, len, char);
3999 PoisonFree(ptr,len,char);
4003 ptr = (char*) saferealloc (ptr, allocate);
4008 SvLEN_set(sv, allocate);
4009 if (!(flags & SV_HAS_TRAILING_NUL)) {
4012 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4014 if (flags & SV_SMAGIC)
4018 #ifdef PERL_OLD_COPY_ON_WRITE
4019 /* Need to do this *after* making the SV normal, as we need the buffer
4020 pointer to remain valid until after we've copied it. If we let go too early,
4021 another thread could invalidate it by unsharing last of the same hash key
4022 (which it can do by means other than releasing copy-on-write Svs)
4023 or by changing the other copy-on-write SVs in the loop. */
4025 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4027 { /* this SV was SvIsCOW_normal(sv) */
4028 /* we need to find the SV pointing to us. */
4029 SV *current = SV_COW_NEXT_SV(after);
4031 if (current == sv) {
4032 /* The SV we point to points back to us (there were only two of us
4034 Hence other SV is no longer copy on write either. */
4036 SvREADONLY_off(after);
4038 /* We need to follow the pointers around the loop. */
4040 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4043 /* don't loop forever if the structure is bust, and we have
4044 a pointer into a closed loop. */
4045 assert (current != after);
4046 assert (SvPVX_const(current) == pvx);
4048 /* Make the SV before us point to the SV after us. */
4049 SV_COW_NEXT_SV_SET(current, after);
4055 =for apidoc sv_force_normal_flags
4057 Undo various types of fakery on an SV: if the PV is a shared string, make
4058 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4059 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4060 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4061 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4062 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4063 set to some other value.) In addition, the C<flags> parameter gets passed to
4064 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4065 with flags set to 0.
4071 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4074 #ifdef PERL_OLD_COPY_ON_WRITE
4075 if (SvREADONLY(sv)) {
4076 /* At this point I believe I should acquire a global SV mutex. */
4078 const char * const pvx = SvPVX_const(sv);
4079 const STRLEN len = SvLEN(sv);
4080 const STRLEN cur = SvCUR(sv);
4081 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4082 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4083 we'll fail an assertion. */
4084 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4087 PerlIO_printf(Perl_debug_log,
4088 "Copy on write: Force normal %ld\n",
4094 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4097 if (flags & SV_COW_DROP_PV) {
4098 /* OK, so we don't need to copy our buffer. */
4101 SvGROW(sv, cur + 1);
4102 Move(pvx,SvPVX(sv),cur,char);
4107 sv_release_COW(sv, pvx, next);
4109 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4115 else if (IN_PERL_RUNTIME)
4116 Perl_croak(aTHX_ PL_no_modify);
4117 /* At this point I believe that I can drop the global SV mutex. */
4120 if (SvREADONLY(sv)) {
4122 const char * const pvx = SvPVX_const(sv);
4123 const STRLEN len = SvCUR(sv);
4128 SvGROW(sv, len + 1);
4129 Move(pvx,SvPVX(sv),len,char);
4131 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4133 else if (IN_PERL_RUNTIME)
4134 Perl_croak(aTHX_ PL_no_modify);
4138 sv_unref_flags(sv, flags);
4139 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4146 Efficient removal of characters from the beginning of the string buffer.
4147 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4148 the string buffer. The C<ptr> becomes the first character of the adjusted
4149 string. Uses the "OOK hack".
4150 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4151 refer to the same chunk of data.
4157 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4159 register STRLEN delta;
4160 if (!ptr || !SvPOKp(sv))
4162 delta = ptr - SvPVX_const(sv);
4163 SV_CHECK_THINKFIRST(sv);
4164 if (SvTYPE(sv) < SVt_PVIV)
4165 sv_upgrade(sv,SVt_PVIV);
4168 if (!SvLEN(sv)) { /* make copy of shared string */
4169 const char *pvx = SvPVX_const(sv);
4170 const STRLEN len = SvCUR(sv);
4171 SvGROW(sv, len + 1);
4172 Move(pvx,SvPVX(sv),len,char);
4176 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4177 and we do that anyway inside the SvNIOK_off
4179 SvFLAGS(sv) |= SVf_OOK;
4182 SvLEN_set(sv, SvLEN(sv) - delta);
4183 SvCUR_set(sv, SvCUR(sv) - delta);
4184 SvPV_set(sv, SvPVX(sv) + delta);
4185 SvIV_set(sv, SvIVX(sv) + delta);
4189 =for apidoc sv_catpvn
4191 Concatenates the string onto the end of the string which is in the SV. The
4192 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4193 status set, then the bytes appended should be valid UTF-8.
4194 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4196 =for apidoc sv_catpvn_flags
4198 Concatenates the string onto the end of the string which is in the SV. The
4199 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4200 status set, then the bytes appended should be valid UTF-8.
4201 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4202 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4203 in terms of this function.
4209 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4213 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4215 SvGROW(dsv, dlen + slen + 1);
4217 sstr = SvPVX_const(dsv);
4218 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4219 SvCUR_set(dsv, SvCUR(dsv) + slen);
4221 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4223 if (flags & SV_SMAGIC)
4228 =for apidoc sv_catsv
4230 Concatenates the string from SV C<ssv> onto the end of the string in
4231 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4232 not 'set' magic. See C<sv_catsv_mg>.
4234 =for apidoc sv_catsv_flags
4236 Concatenates the string from SV C<ssv> onto the end of the string in
4237 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4238 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4239 and C<sv_catsv_nomg> are implemented in terms of this function.
4244 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4249 const char *spv = SvPV_const(ssv, slen);
4251 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4252 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4253 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4254 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4255 dsv->sv_flags doesn't have that bit set.
4256 Andy Dougherty 12 Oct 2001
4258 const I32 sutf8 = DO_UTF8(ssv);
4261 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4263 dutf8 = DO_UTF8(dsv);
4265 if (dutf8 != sutf8) {
4267 /* Not modifying source SV, so taking a temporary copy. */
4268 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4270 sv_utf8_upgrade(csv);
4271 spv = SvPV_const(csv, slen);
4274 sv_utf8_upgrade_nomg(dsv);
4276 sv_catpvn_nomg(dsv, spv, slen);
4279 if (flags & SV_SMAGIC)
4284 =for apidoc sv_catpv
4286 Concatenates the string onto the end of the string which is in the SV.
4287 If the SV has the UTF-8 status set, then the bytes appended should be
4288 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4293 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4296 register STRLEN len;
4302 junk = SvPV_force(sv, tlen);
4304 SvGROW(sv, tlen + len + 1);
4306 ptr = SvPVX_const(sv);
4307 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4308 SvCUR_set(sv, SvCUR(sv) + len);
4309 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4314 =for apidoc sv_catpv_mg
4316 Like C<sv_catpv>, but also handles 'set' magic.
4322 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4331 Creates a new SV. A non-zero C<len> parameter indicates the number of
4332 bytes of preallocated string space the SV should have. An extra byte for a
4333 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4334 space is allocated.) The reference count for the new SV is set to 1.
4336 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4337 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4338 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4339 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4340 modules supporting older perls.
4346 Perl_newSV(pTHX_ STRLEN len)
4353 sv_upgrade(sv, SVt_PV);
4354 SvGROW(sv, len + 1);
4359 =for apidoc sv_magicext
4361 Adds magic to an SV, upgrading it if necessary. Applies the
4362 supplied vtable and returns a pointer to the magic added.
4364 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4365 In particular, you can add magic to SvREADONLY SVs, and add more than
4366 one instance of the same 'how'.
4368 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4369 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4370 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4371 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4373 (This is now used as a subroutine by C<sv_magic>.)
4378 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4379 const char* name, I32 namlen)
4384 SvUPGRADE(sv, SVt_PVMG);
4385 Newxz(mg, 1, MAGIC);
4386 mg->mg_moremagic = SvMAGIC(sv);
4387 SvMAGIC_set(sv, mg);
4389 /* Sometimes a magic contains a reference loop, where the sv and
4390 object refer to each other. To prevent a reference loop that
4391 would prevent such objects being freed, we look for such loops
4392 and if we find one we avoid incrementing the object refcount.
4394 Note we cannot do this to avoid self-tie loops as intervening RV must
4395 have its REFCNT incremented to keep it in existence.
4398 if (!obj || obj == sv ||
4399 how == PERL_MAGIC_arylen ||
4400 how == PERL_MAGIC_qr ||
4401 how == PERL_MAGIC_symtab ||
4402 (SvTYPE(obj) == SVt_PVGV &&
4403 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4404 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4405 GvFORM(obj) == (CV*)sv)))
4410 mg->mg_obj = SvREFCNT_inc_simple(obj);
4411 mg->mg_flags |= MGf_REFCOUNTED;
4414 /* Normal self-ties simply pass a null object, and instead of
4415 using mg_obj directly, use the SvTIED_obj macro to produce a
4416 new RV as needed. For glob "self-ties", we are tieing the PVIO
4417 with an RV obj pointing to the glob containing the PVIO. In
4418 this case, to avoid a reference loop, we need to weaken the
4422 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4423 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4429 mg->mg_len = namlen;
4432 mg->mg_ptr = savepvn(name, namlen);
4433 else if (namlen == HEf_SVKEY)
4434 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4436 mg->mg_ptr = (char *) name;
4438 mg->mg_virtual = (MGVTBL *) vtable;
4442 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4447 =for apidoc sv_magic
4449 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4450 then adds a new magic item of type C<how> to the head of the magic list.
4452 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4453 handling of the C<name> and C<namlen> arguments.
4455 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4456 to add more than one instance of the same 'how'.
4462 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4465 const MGVTBL *vtable;
4468 #ifdef PERL_OLD_COPY_ON_WRITE
4470 sv_force_normal_flags(sv, 0);
4472 if (SvREADONLY(sv)) {
4474 /* its okay to attach magic to shared strings; the subsequent
4475 * upgrade to PVMG will unshare the string */
4476 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4479 && how != PERL_MAGIC_regex_global
4480 && how != PERL_MAGIC_bm
4481 && how != PERL_MAGIC_fm
4482 && how != PERL_MAGIC_sv
4483 && how != PERL_MAGIC_backref
4486 Perl_croak(aTHX_ PL_no_modify);
4489 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4490 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4491 /* sv_magic() refuses to add a magic of the same 'how' as an
4494 if (how == PERL_MAGIC_taint) {
4496 /* Any scalar which already had taint magic on which someone
4497 (erroneously?) did SvIOK_on() or similar will now be
4498 incorrectly sporting public "OK" flags. */
4499 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4507 vtable = &PL_vtbl_sv;
4509 case PERL_MAGIC_overload:
4510 vtable = &PL_vtbl_amagic;
4512 case PERL_MAGIC_overload_elem:
4513 vtable = &PL_vtbl_amagicelem;
4515 case PERL_MAGIC_overload_table:
4516 vtable = &PL_vtbl_ovrld;
4519 vtable = &PL_vtbl_bm;
4521 case PERL_MAGIC_regdata:
4522 vtable = &PL_vtbl_regdata;
4524 case PERL_MAGIC_regdatum:
4525 vtable = &PL_vtbl_regdatum;
4527 case PERL_MAGIC_env:
4528 vtable = &PL_vtbl_env;
4531 vtable = &PL_vtbl_fm;
4533 case PERL_MAGIC_envelem:
4534 vtable = &PL_vtbl_envelem;
4536 case PERL_MAGIC_regex_global:
4537 vtable = &PL_vtbl_mglob;
4539 case PERL_MAGIC_isa:
4540 vtable = &PL_vtbl_isa;
4542 case PERL_MAGIC_isaelem:
4543 vtable = &PL_vtbl_isaelem;
4545 case PERL_MAGIC_nkeys:
4546 vtable = &PL_vtbl_nkeys;
4548 case PERL_MAGIC_dbfile:
4551 case PERL_MAGIC_dbline:
4552 vtable = &PL_vtbl_dbline;
4554 #ifdef USE_LOCALE_COLLATE
4555 case PERL_MAGIC_collxfrm:
4556 vtable = &PL_vtbl_collxfrm;
4558 #endif /* USE_LOCALE_COLLATE */
4559 case PERL_MAGIC_tied:
4560 vtable = &PL_vtbl_pack;
4562 case PERL_MAGIC_tiedelem:
4563 case PERL_MAGIC_tiedscalar:
4564 vtable = &PL_vtbl_packelem;
4567 vtable = &PL_vtbl_regexp;
4569 case PERL_MAGIC_hints:
4570 /* As this vtable is all NULL, we can reuse it. */
4571 case PERL_MAGIC_sig:
4572 vtable = &PL_vtbl_sig;
4574 case PERL_MAGIC_sigelem:
4575 vtable = &PL_vtbl_sigelem;
4577 case PERL_MAGIC_taint:
4578 vtable = &PL_vtbl_taint;
4580 case PERL_MAGIC_uvar:
4581 vtable = &PL_vtbl_uvar;
4583 case PERL_MAGIC_vec:
4584 vtable = &PL_vtbl_vec;
4586 case PERL_MAGIC_arylen_p:
4587 case PERL_MAGIC_rhash:
4588 case PERL_MAGIC_symtab:
4589 case PERL_MAGIC_vstring:
4592 case PERL_MAGIC_utf8:
4593 vtable = &PL_vtbl_utf8;
4595 case PERL_MAGIC_substr:
4596 vtable = &PL_vtbl_substr;
4598 case PERL_MAGIC_defelem:
4599 vtable = &PL_vtbl_defelem;
4601 case PERL_MAGIC_arylen:
4602 vtable = &PL_vtbl_arylen;
4604 case PERL_MAGIC_pos:
4605 vtable = &PL_vtbl_pos;
4607 case PERL_MAGIC_backref:
4608 vtable = &PL_vtbl_backref;
4610 case PERL_MAGIC_hintselem:
4611 vtable = &PL_vtbl_hintselem;
4613 case PERL_MAGIC_ext:
4614 /* Reserved for use by extensions not perl internals. */
4615 /* Useful for attaching extension internal data to perl vars. */
4616 /* Note that multiple extensions may clash if magical scalars */
4617 /* etc holding private data from one are passed to another. */
4621 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4624 /* Rest of work is done else where */
4625 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4628 case PERL_MAGIC_taint:
4631 case PERL_MAGIC_ext:
4632 case PERL_MAGIC_dbfile:
4639 =for apidoc sv_unmagic
4641 Removes all magic of type C<type> from an SV.
4647 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4651 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4653 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4654 for (mg = *mgp; mg; mg = *mgp) {
4655 if (mg->mg_type == type) {
4656 const MGVTBL* const vtbl = mg->mg_virtual;
4657 *mgp = mg->mg_moremagic;
4658 if (vtbl && vtbl->svt_free)
4659 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4660 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4662 Safefree(mg->mg_ptr);
4663 else if (mg->mg_len == HEf_SVKEY)
4664 SvREFCNT_dec((SV*)mg->mg_ptr);
4665 else if (mg->mg_type == PERL_MAGIC_utf8)
4666 Safefree(mg->mg_ptr);
4668 if (mg->mg_flags & MGf_REFCOUNTED)
4669 SvREFCNT_dec(mg->mg_obj);
4673 mgp = &mg->mg_moremagic;
4677 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4678 SvMAGIC_set(sv, NULL);
4685 =for apidoc sv_rvweaken
4687 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4688 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4689 push a back-reference to this RV onto the array of backreferences
4690 associated with that magic. If the RV is magical, set magic will be
4691 called after the RV is cleared.
4697 Perl_sv_rvweaken(pTHX_ SV *sv)
4700 if (!SvOK(sv)) /* let undefs pass */
4703 Perl_croak(aTHX_ "Can't weaken a nonreference");
4704 else if (SvWEAKREF(sv)) {
4705 if (ckWARN(WARN_MISC))
4706 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4710 Perl_sv_add_backref(aTHX_ tsv, sv);
4716 /* Give tsv backref magic if it hasn't already got it, then push a
4717 * back-reference to sv onto the array associated with the backref magic.
4721 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4726 if (SvTYPE(tsv) == SVt_PVHV) {
4727 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4731 /* There is no AV in the offical place - try a fixup. */
4732 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4735 /* Aha. They've got it stowed in magic. Bring it back. */
4736 av = (AV*)mg->mg_obj;
4737 /* Stop mg_free decreasing the refernce count. */
4739 /* Stop mg_free even calling the destructor, given that
4740 there's no AV to free up. */
4742 sv_unmagic(tsv, PERL_MAGIC_backref);
4746 SvREFCNT_inc_simple_void(av);
4751 const MAGIC *const mg
4752 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4754 av = (AV*)mg->mg_obj;
4758 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4759 /* av now has a refcnt of 2, which avoids it getting freed
4760 * before us during global cleanup. The extra ref is removed
4761 * by magic_killbackrefs() when tsv is being freed */
4764 if (AvFILLp(av) >= AvMAX(av)) {
4765 av_extend(av, AvFILLp(av)+1);
4767 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4770 /* delete a back-reference to ourselves from the backref magic associated
4771 * with the SV we point to.
4775 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4782 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4783 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4784 /* We mustn't attempt to "fix up" the hash here by moving the
4785 backreference array back to the hv_aux structure, as that is stored
4786 in the main HvARRAY(), and hfreentries assumes that no-one
4787 reallocates HvARRAY() while it is running. */
4790 const MAGIC *const mg
4791 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4793 av = (AV *)mg->mg_obj;
4796 if (PL_in_clean_all)
4798 Perl_croak(aTHX_ "panic: del_backref");
4805 /* We shouldn't be in here more than once, but for paranoia reasons lets
4807 for (i = AvFILLp(av); i >= 0; i--) {
4809 const SSize_t fill = AvFILLp(av);
4811 /* We weren't the last entry.
4812 An unordered list has this property that you can take the
4813 last element off the end to fill the hole, and it's still
4814 an unordered list :-)
4819 AvFILLp(av) = fill - 1;
4825 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4827 SV **svp = AvARRAY(av);
4829 PERL_UNUSED_ARG(sv);
4831 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4832 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4833 if (svp && !SvIS_FREED(av)) {
4834 SV *const *const last = svp + AvFILLp(av);
4836 while (svp <= last) {
4838 SV *const referrer = *svp;
4839 if (SvWEAKREF(referrer)) {
4840 /* XXX Should we check that it hasn't changed? */
4841 SvRV_set(referrer, 0);
4843 SvWEAKREF_off(referrer);
4844 SvSETMAGIC(referrer);
4845 } else if (SvTYPE(referrer) == SVt_PVGV ||
4846 SvTYPE(referrer) == SVt_PVLV) {
4847 /* You lookin' at me? */
4848 assert(GvSTASH(referrer));
4849 assert(GvSTASH(referrer) == (HV*)sv);
4850 GvSTASH(referrer) = 0;
4853 "panic: magic_killbackrefs (flags=%"UVxf")",
4854 (UV)SvFLAGS(referrer));
4862 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4867 =for apidoc sv_insert
4869 Inserts a string at the specified offset/length within the SV. Similar to
4870 the Perl substr() function.
4876 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4881 register char *midend;
4882 register char *bigend;
4888 Perl_croak(aTHX_ "Can't modify non-existent substring");
4889 SvPV_force(bigstr, curlen);
4890 (void)SvPOK_only_UTF8(bigstr);
4891 if (offset + len > curlen) {
4892 SvGROW(bigstr, offset+len+1);
4893 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4894 SvCUR_set(bigstr, offset+len);
4898 i = littlelen - len;
4899 if (i > 0) { /* string might grow */
4900 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4901 mid = big + offset + len;
4902 midend = bigend = big + SvCUR(bigstr);
4905 while (midend > mid) /* shove everything down */
4906 *--bigend = *--midend;
4907 Move(little,big+offset,littlelen,char);
4908 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4913 Move(little,SvPVX(bigstr)+offset,len,char);
4918 big = SvPVX(bigstr);
4921 bigend = big + SvCUR(bigstr);
4923 if (midend > bigend)
4924 Perl_croak(aTHX_ "panic: sv_insert");
4926 if (mid - big > bigend - midend) { /* faster to shorten from end */
4928 Move(little, mid, littlelen,char);
4931 i = bigend - midend;
4933 Move(midend, mid, i,char);
4937 SvCUR_set(bigstr, mid - big);
4939 else if ((i = mid - big)) { /* faster from front */
4940 midend -= littlelen;
4942 sv_chop(bigstr,midend-i);
4947 Move(little, mid, littlelen,char);
4949 else if (littlelen) {
4950 midend -= littlelen;
4951 sv_chop(bigstr,midend);
4952 Move(little,midend,littlelen,char);
4955 sv_chop(bigstr,midend);
4961 =for apidoc sv_replace
4963 Make the first argument a copy of the second, then delete the original.
4964 The target SV physically takes over ownership of the body of the source SV
4965 and inherits its flags; however, the target keeps any magic it owns,
4966 and any magic in the source is discarded.
4967 Note that this is a rather specialist SV copying operation; most of the
4968 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4974 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4977 const U32 refcnt = SvREFCNT(sv);
4978 SV_CHECK_THINKFIRST_COW_DROP(sv);
4979 if (SvREFCNT(nsv) != 1) {
4980 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4981 UVuf " != 1)", (UV) SvREFCNT(nsv));
4983 if (SvMAGICAL(sv)) {
4987 sv_upgrade(nsv, SVt_PVMG);
4988 SvMAGIC_set(nsv, SvMAGIC(sv));
4989 SvFLAGS(nsv) |= SvMAGICAL(sv);
4991 SvMAGIC_set(sv, NULL);
4995 assert(!SvREFCNT(sv));
4996 #ifdef DEBUG_LEAKING_SCALARS
4997 sv->sv_flags = nsv->sv_flags;
4998 sv->sv_any = nsv->sv_any;
4999 sv->sv_refcnt = nsv->sv_refcnt;
5000 sv->sv_u = nsv->sv_u;
5002 StructCopy(nsv,sv,SV);
5004 /* Currently could join these into one piece of pointer arithmetic, but
5005 it would be unclear. */
5006 if(SvTYPE(sv) == SVt_IV)
5008 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5009 else if (SvTYPE(sv) == SVt_RV) {
5010 SvANY(sv) = &sv->sv_u.svu_rv;
5014 #ifdef PERL_OLD_COPY_ON_WRITE
5015 if (SvIsCOW_normal(nsv)) {
5016 /* We need to follow the pointers around the loop to make the
5017 previous SV point to sv, rather than nsv. */
5020 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5023 assert(SvPVX_const(current) == SvPVX_const(nsv));
5025 /* Make the SV before us point to the SV after us. */
5027 PerlIO_printf(Perl_debug_log, "previous is\n");
5029 PerlIO_printf(Perl_debug_log,
5030 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5031 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5033 SV_COW_NEXT_SV_SET(current, sv);
5036 SvREFCNT(sv) = refcnt;
5037 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5043 =for apidoc sv_clear
5045 Clear an SV: call any destructors, free up any memory used by the body,
5046 and free the body itself. The SV's head is I<not> freed, although
5047 its type is set to all 1's so that it won't inadvertently be assumed
5048 to be live during global destruction etc.
5049 This function should only be called when REFCNT is zero. Most of the time
5050 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5057 Perl_sv_clear(pTHX_ register SV *sv)
5060 const U32 type = SvTYPE(sv);
5061 const struct body_details *const sv_type_details
5062 = bodies_by_type + type;
5066 assert(SvREFCNT(sv) == 0);
5068 if (type <= SVt_IV) {
5069 /* See the comment in sv.h about the collusion between this early
5070 return and the overloading of the NULL and IV slots in the size
5076 if (PL_defstash) { /* Still have a symbol table? */
5081 stash = SvSTASH(sv);
5082 destructor = StashHANDLER(stash,DESTROY);
5084 SV* const tmpref = newRV(sv);
5085 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5087 PUSHSTACKi(PERLSI_DESTROY);
5092 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5098 if(SvREFCNT(tmpref) < 2) {
5099 /* tmpref is not kept alive! */
5101 SvRV_set(tmpref, NULL);
5104 SvREFCNT_dec(tmpref);
5106 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5110 if (PL_in_clean_objs)
5111 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5113 /* DESTROY gave object new lease on life */
5119 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5120 SvOBJECT_off(sv); /* Curse the object. */
5121 if (type != SVt_PVIO)
5122 --PL_sv_objcount; /* XXX Might want something more general */
5125 if (type >= SVt_PVMG) {
5126 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5127 SvREFCNT_dec(SvOURSTASH(sv));
5128 } else if (SvMAGIC(sv))
5130 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5131 SvREFCNT_dec(SvSTASH(sv));
5134 /* case SVt_BIND: */
5137 IoIFP(sv) != PerlIO_stdin() &&
5138 IoIFP(sv) != PerlIO_stdout() &&
5139 IoIFP(sv) != PerlIO_stderr())
5141 io_close((IO*)sv, FALSE);
5143 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5144 PerlDir_close(IoDIRP(sv));
5145 IoDIRP(sv) = (DIR*)NULL;
5146 Safefree(IoTOP_NAME(sv));
5147 Safefree(IoFMT_NAME(sv));
5148 Safefree(IoBOTTOM_NAME(sv));
5155 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5159 if (PL_comppad == (AV*)sv) {
5166 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5167 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5168 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5169 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5171 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5172 SvREFCNT_dec(LvTARG(sv));
5174 if (isGV_with_GP(sv)) {
5175 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5176 mro_method_changed_in(stash);
5179 unshare_hek(GvNAME_HEK(sv));
5180 /* If we're in a stash, we don't own a reference to it. However it does
5181 have a back reference to us, which needs to be cleared. */
5182 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5183 sv_del_backref((SV*)stash, sv);
5185 /* FIXME. There are probably more unreferenced pointers to SVs in the
5186 interpreter struct that we should check and tidy in a similar
5188 if ((GV*)sv == PL_last_in_gv)
5189 PL_last_in_gv = NULL;
5194 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5196 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5197 /* Don't even bother with turning off the OOK flag. */
5202 SV * const target = SvRV(sv);
5204 sv_del_backref(target, sv);
5206 SvREFCNT_dec(target);
5208 #ifdef PERL_OLD_COPY_ON_WRITE
5209 else if (SvPVX_const(sv)) {
5211 /* I believe I need to grab the global SV mutex here and
5212 then recheck the COW status. */
5214 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5218 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5220 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5223 /* And drop it here. */
5225 } else if (SvLEN(sv)) {
5226 Safefree(SvPVX_const(sv));
5230 else if (SvPVX_const(sv) && SvLEN(sv))
5231 Safefree(SvPVX_mutable(sv));
5232 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5233 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5242 SvFLAGS(sv) &= SVf_BREAK;
5243 SvFLAGS(sv) |= SVTYPEMASK;
5245 if (sv_type_details->arena) {
5246 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5247 &PL_body_roots[type]);
5249 else if (sv_type_details->body_size) {
5250 my_safefree(SvANY(sv));
5255 =for apidoc sv_newref
5257 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5264 Perl_sv_newref(pTHX_ SV *sv)
5266 PERL_UNUSED_CONTEXT;
5275 Decrement an SV's reference count, and if it drops to zero, call
5276 C<sv_clear> to invoke destructors and free up any memory used by
5277 the body; finally, deallocate the SV's head itself.
5278 Normally called via a wrapper macro C<SvREFCNT_dec>.
5284 Perl_sv_free(pTHX_ SV *sv)
5289 if (SvREFCNT(sv) == 0) {
5290 if (SvFLAGS(sv) & SVf_BREAK)
5291 /* this SV's refcnt has been artificially decremented to
5292 * trigger cleanup */
5294 if (PL_in_clean_all) /* All is fair */
5296 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5297 /* make sure SvREFCNT(sv)==0 happens very seldom */
5298 SvREFCNT(sv) = (~(U32)0)/2;
5301 if (ckWARN_d(WARN_INTERNAL)) {
5302 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5303 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5304 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5305 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5306 Perl_dump_sv_child(aTHX_ sv);
5308 #ifdef DEBUG_LEAKING_SCALARS
5315 if (--(SvREFCNT(sv)) > 0)
5317 Perl_sv_free2(aTHX_ sv);
5321 Perl_sv_free2(pTHX_ SV *sv)
5326 if (ckWARN_d(WARN_DEBUGGING))
5327 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5328 "Attempt to free temp prematurely: SV 0x%"UVxf
5329 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5333 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5334 /* make sure SvREFCNT(sv)==0 happens very seldom */
5335 SvREFCNT(sv) = (~(U32)0)/2;
5346 Returns the length of the string in the SV. Handles magic and type
5347 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5353 Perl_sv_len(pTHX_ register SV *sv)
5361 len = mg_length(sv);
5363 (void)SvPV_const(sv, len);
5368 =for apidoc sv_len_utf8
5370 Returns the number of characters in the string in an SV, counting wide
5371 UTF-8 bytes as a single character. Handles magic and type coercion.
5377 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5378 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5379 * (Note that the mg_len is not the length of the mg_ptr field.
5380 * This allows the cache to store the character length of the string without
5381 * needing to malloc() extra storage to attach to the mg_ptr.)
5386 Perl_sv_len_utf8(pTHX_ register SV *sv)
5392 return mg_length(sv);
5396 const U8 *s = (U8*)SvPV_const(sv, len);
5400 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5402 if (mg && mg->mg_len != -1) {
5404 if (PL_utf8cache < 0) {
5405 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5407 /* Need to turn the assertions off otherwise we may
5408 recurse infinitely while printing error messages.
5410 SAVEI8(PL_utf8cache);
5412 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5413 " real %"UVuf" for %"SVf,
5414 (UV) ulen, (UV) real, SVfARG(sv));
5419 ulen = Perl_utf8_length(aTHX_ s, s + len);
5420 if (!SvREADONLY(sv)) {
5422 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5423 &PL_vtbl_utf8, 0, 0);
5431 return Perl_utf8_length(aTHX_ s, s + len);
5435 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5438 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5441 const U8 *s = start;
5443 while (s < send && uoffset--)
5446 /* This is the existing behaviour. Possibly it should be a croak, as
5447 it's actually a bounds error */
5453 /* Given the length of the string in both bytes and UTF-8 characters, decide
5454 whether to walk forwards or backwards to find the byte corresponding to
5455 the passed in UTF-8 offset. */
5457 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5458 STRLEN uoffset, STRLEN uend)
5460 STRLEN backw = uend - uoffset;
5461 if (uoffset < 2 * backw) {
5462 /* The assumption is that going forwards is twice the speed of going
5463 forward (that's where the 2 * backw comes from).
5464 (The real figure of course depends on the UTF-8 data.) */
5465 return sv_pos_u2b_forwards(start, send, uoffset);
5470 while (UTF8_IS_CONTINUATION(*send))
5473 return send - start;
5476 /* For the string representation of the given scalar, find the byte
5477 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5478 give another position in the string, *before* the sought offset, which
5479 (which is always true, as 0, 0 is a valid pair of positions), which should
5480 help reduce the amount of linear searching.
5481 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5482 will be used to reduce the amount of linear searching. The cache will be
5483 created if necessary, and the found value offered to it for update. */
5485 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5486 const U8 *const send, STRLEN uoffset,
5487 STRLEN uoffset0, STRLEN boffset0) {
5488 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5491 assert (uoffset >= uoffset0);
5493 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5494 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5495 if ((*mgp)->mg_ptr) {
5496 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5497 if (cache[0] == uoffset) {
5498 /* An exact match. */
5501 if (cache[2] == uoffset) {
5502 /* An exact match. */
5506 if (cache[0] < uoffset) {
5507 /* The cache already knows part of the way. */
5508 if (cache[0] > uoffset0) {
5509 /* The cache knows more than the passed in pair */
5510 uoffset0 = cache[0];
5511 boffset0 = cache[1];
5513 if ((*mgp)->mg_len != -1) {
5514 /* And we know the end too. */
5516 + sv_pos_u2b_midway(start + boffset0, send,
5518 (*mgp)->mg_len - uoffset0);
5521 + sv_pos_u2b_forwards(start + boffset0,
5522 send, uoffset - uoffset0);
5525 else if (cache[2] < uoffset) {
5526 /* We're between the two cache entries. */
5527 if (cache[2] > uoffset0) {
5528 /* and the cache knows more than the passed in pair */
5529 uoffset0 = cache[2];
5530 boffset0 = cache[3];
5534 + sv_pos_u2b_midway(start + boffset0,
5537 cache[0] - uoffset0);
5540 + sv_pos_u2b_midway(start + boffset0,
5543 cache[2] - uoffset0);
5547 else if ((*mgp)->mg_len != -1) {
5548 /* If we can take advantage of a passed in offset, do so. */
5549 /* In fact, offset0 is either 0, or less than offset, so don't
5550 need to worry about the other possibility. */
5552 + sv_pos_u2b_midway(start + boffset0, send,
5554 (*mgp)->mg_len - uoffset0);
5559 if (!found || PL_utf8cache < 0) {
5560 const STRLEN real_boffset
5561 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5562 send, uoffset - uoffset0);
5564 if (found && PL_utf8cache < 0) {
5565 if (real_boffset != boffset) {
5566 /* Need to turn the assertions off otherwise we may recurse
5567 infinitely while printing error messages. */
5568 SAVEI8(PL_utf8cache);
5570 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5571 " real %"UVuf" for %"SVf,
5572 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5575 boffset = real_boffset;
5578 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5584 =for apidoc sv_pos_u2b
5586 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5587 the start of the string, to a count of the equivalent number of bytes; if
5588 lenp is non-zero, it does the same to lenp, but this time starting from
5589 the offset, rather than from the start of the string. Handles magic and
5596 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5597 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5598 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5603 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5611 start = (U8*)SvPV_const(sv, len);
5613 STRLEN uoffset = (STRLEN) *offsetp;
5614 const U8 * const send = start + len;
5616 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5619 *offsetp = (I32) boffset;
5622 /* Convert the relative offset to absolute. */
5623 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5624 const STRLEN boffset2
5625 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5626 uoffset, boffset) - boffset;
5640 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5641 byte length pairing. The (byte) length of the total SV is passed in too,
5642 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5643 may not have updated SvCUR, so we can't rely on reading it directly.
5645 The proffered utf8/byte length pairing isn't used if the cache already has
5646 two pairs, and swapping either for the proffered pair would increase the
5647 RMS of the intervals between known byte offsets.
5649 The cache itself consists of 4 STRLEN values
5650 0: larger UTF-8 offset
5651 1: corresponding byte offset
5652 2: smaller UTF-8 offset
5653 3: corresponding byte offset
5655 Unused cache pairs have the value 0, 0.
5656 Keeping the cache "backwards" means that the invariant of
5657 cache[0] >= cache[2] is maintained even with empty slots, which means that
5658 the code that uses it doesn't need to worry if only 1 entry has actually
5659 been set to non-zero. It also makes the "position beyond the end of the
5660 cache" logic much simpler, as the first slot is always the one to start
5664 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5672 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5674 (*mgp)->mg_len = -1;
5678 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5679 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5680 (*mgp)->mg_ptr = (char *) cache;
5684 if (PL_utf8cache < 0) {
5685 const U8 *start = (const U8 *) SvPVX_const(sv);
5686 const STRLEN realutf8 = utf8_length(start, start + byte);
5688 if (realutf8 != utf8) {
5689 /* Need to turn the assertions off otherwise we may recurse
5690 infinitely while printing error messages. */
5691 SAVEI8(PL_utf8cache);
5693 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5694 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5698 /* Cache is held with the later position first, to simplify the code
5699 that deals with unbounded ends. */
5701 ASSERT_UTF8_CACHE(cache);
5702 if (cache[1] == 0) {
5703 /* Cache is totally empty */
5706 } else if (cache[3] == 0) {
5707 if (byte > cache[1]) {
5708 /* New one is larger, so goes first. */
5709 cache[2] = cache[0];
5710 cache[3] = cache[1];
5718 #define THREEWAY_SQUARE(a,b,c,d) \
5719 ((float)((d) - (c))) * ((float)((d) - (c))) \
5720 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5721 + ((float)((b) - (a))) * ((float)((b) - (a)))
5723 /* Cache has 2 slots in use, and we know three potential pairs.
5724 Keep the two that give the lowest RMS distance. Do the
5725 calcualation in bytes simply because we always know the byte
5726 length. squareroot has the same ordering as the positive value,
5727 so don't bother with the actual square root. */
5728 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5729 if (byte > cache[1]) {
5730 /* New position is after the existing pair of pairs. */
5731 const float keep_earlier
5732 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5733 const float keep_later
5734 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5736 if (keep_later < keep_earlier) {
5737 if (keep_later < existing) {
5738 cache[2] = cache[0];
5739 cache[3] = cache[1];
5745 if (keep_earlier < existing) {
5751 else if (byte > cache[3]) {
5752 /* New position is between the existing pair of pairs. */
5753 const float keep_earlier
5754 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5755 const float keep_later
5756 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5758 if (keep_later < keep_earlier) {
5759 if (keep_later < existing) {
5765 if (keep_earlier < existing) {
5772 /* New position is before the existing pair of pairs. */
5773 const float keep_earlier
5774 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5775 const float keep_later
5776 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5778 if (keep_later < keep_earlier) {
5779 if (keep_later < existing) {
5785 if (keep_earlier < existing) {
5786 cache[0] = cache[2];
5787 cache[1] = cache[3];
5794 ASSERT_UTF8_CACHE(cache);
5797 /* We already know all of the way, now we may be able to walk back. The same
5798 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5799 backward is half the speed of walking forward. */
5801 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5804 const STRLEN forw = target - s;
5805 STRLEN backw = end - target;
5807 if (forw < 2 * backw) {
5808 return utf8_length(s, target);
5811 while (end > target) {
5813 while (UTF8_IS_CONTINUATION(*end)) {
5822 =for apidoc sv_pos_b2u
5824 Converts the value pointed to by offsetp from a count of bytes from the
5825 start of the string, to a count of the equivalent number of UTF-8 chars.
5826 Handles magic and type coercion.
5832 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5833 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5838 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5841 const STRLEN byte = *offsetp;
5842 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5851 s = (const U8*)SvPV_const(sv, blen);
5854 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5858 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5859 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5861 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5862 if (cache[1] == byte) {
5863 /* An exact match. */
5864 *offsetp = cache[0];
5867 if (cache[3] == byte) {
5868 /* An exact match. */
5869 *offsetp = cache[2];
5873 if (cache[1] < byte) {
5874 /* We already know part of the way. */
5875 if (mg->mg_len != -1) {
5876 /* Actually, we know the end too. */
5878 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5879 s + blen, mg->mg_len - cache[0]);
5881 len = cache[0] + utf8_length(s + cache[1], send);
5884 else if (cache[3] < byte) {
5885 /* We're between the two cached pairs, so we do the calculation
5886 offset by the byte/utf-8 positions for the earlier pair,
5887 then add the utf-8 characters from the string start to
5889 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5890 s + cache[1], cache[0] - cache[2])
5894 else { /* cache[3] > byte */
5895 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5899 ASSERT_UTF8_CACHE(cache);
5901 } else if (mg->mg_len != -1) {
5902 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5906 if (!found || PL_utf8cache < 0) {
5907 const STRLEN real_len = utf8_length(s, send);
5909 if (found && PL_utf8cache < 0) {
5910 if (len != real_len) {
5911 /* Need to turn the assertions off otherwise we may recurse
5912 infinitely while printing error messages. */
5913 SAVEI8(PL_utf8cache);
5915 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5916 " real %"UVuf" for %"SVf,
5917 (UV) len, (UV) real_len, SVfARG(sv));
5924 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5930 Returns a boolean indicating whether the strings in the two SVs are
5931 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5932 coerce its args to strings if necessary.
5938 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5947 SV* svrecode = NULL;
5954 /* if pv1 and pv2 are the same, second SvPV_const call may
5955 * invalidate pv1, so we may need to make a copy */
5956 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5957 pv1 = SvPV_const(sv1, cur1);
5958 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5959 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5961 pv1 = SvPV_const(sv1, cur1);
5969 pv2 = SvPV_const(sv2, cur2);
5971 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5972 /* Differing utf8ness.
5973 * Do not UTF8size the comparands as a side-effect. */
5976 svrecode = newSVpvn(pv2, cur2);
5977 sv_recode_to_utf8(svrecode, PL_encoding);
5978 pv2 = SvPV_const(svrecode, cur2);
5981 svrecode = newSVpvn(pv1, cur1);
5982 sv_recode_to_utf8(svrecode, PL_encoding);
5983 pv1 = SvPV_const(svrecode, cur1);
5985 /* Now both are in UTF-8. */
5987 SvREFCNT_dec(svrecode);
5992 bool is_utf8 = TRUE;
5995 /* sv1 is the UTF-8 one,
5996 * if is equal it must be downgrade-able */
5997 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6003 /* sv2 is the UTF-8 one,
6004 * if is equal it must be downgrade-able */
6005 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6011 /* Downgrade not possible - cannot be eq */
6019 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6021 SvREFCNT_dec(svrecode);
6031 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6032 string in C<sv1> is less than, equal to, or greater than the string in
6033 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6034 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6040 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6044 const char *pv1, *pv2;
6047 SV *svrecode = NULL;
6054 pv1 = SvPV_const(sv1, cur1);
6061 pv2 = SvPV_const(sv2, cur2);
6063 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6064 /* Differing utf8ness.
6065 * Do not UTF8size the comparands as a side-effect. */
6068 svrecode = newSVpvn(pv2, cur2);
6069 sv_recode_to_utf8(svrecode, PL_encoding);
6070 pv2 = SvPV_const(svrecode, cur2);
6073 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6078 svrecode = newSVpvn(pv1, cur1);
6079 sv_recode_to_utf8(svrecode, PL_encoding);
6080 pv1 = SvPV_const(svrecode, cur1);
6083 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6089 cmp = cur2 ? -1 : 0;
6093 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6096 cmp = retval < 0 ? -1 : 1;
6097 } else if (cur1 == cur2) {
6100 cmp = cur1 < cur2 ? -1 : 1;
6104 SvREFCNT_dec(svrecode);
6112 =for apidoc sv_cmp_locale
6114 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6115 'use bytes' aware, handles get magic, and will coerce its args to strings
6116 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6122 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6125 #ifdef USE_LOCALE_COLLATE
6131 if (PL_collation_standard)
6135 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6137 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6139 if (!pv1 || !len1) {
6150 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6153 return retval < 0 ? -1 : 1;
6156 * When the result of collation is equality, that doesn't mean
6157 * that there are no differences -- some locales exclude some
6158 * characters from consideration. So to avoid false equalities,
6159 * we use the raw string as a tiebreaker.
6165 #endif /* USE_LOCALE_COLLATE */
6167 return sv_cmp(sv1, sv2);
6171 #ifdef USE_LOCALE_COLLATE
6174 =for apidoc sv_collxfrm
6176 Add Collate Transform magic to an SV if it doesn't already have it.
6178 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6179 scalar data of the variable, but transformed to such a format that a normal
6180 memory comparison can be used to compare the data according to the locale
6187 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6192 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6193 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6199 Safefree(mg->mg_ptr);
6200 s = SvPV_const(sv, len);
6201 if ((xf = mem_collxfrm(s, len, &xlen))) {
6202 if (SvREADONLY(sv)) {
6205 return xf + sizeof(PL_collation_ix);
6208 #ifdef PERL_OLD_COPY_ON_WRITE
6210 sv_force_normal_flags(sv, 0);
6212 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6226 if (mg && mg->mg_ptr) {
6228 return mg->mg_ptr + sizeof(PL_collation_ix);
6236 #endif /* USE_LOCALE_COLLATE */
6241 Get a line from the filehandle and store it into the SV, optionally
6242 appending to the currently-stored string.
6248 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6253 register STDCHAR rslast;
6254 register STDCHAR *bp;
6259 if (SvTHINKFIRST(sv))
6260 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6261 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6263 However, perlbench says it's slower, because the existing swipe code
6264 is faster than copy on write.
6265 Swings and roundabouts. */
6266 SvUPGRADE(sv, SVt_PV);
6271 if (PerlIO_isutf8(fp)) {
6273 sv_utf8_upgrade_nomg(sv);
6274 sv_pos_u2b(sv,&append,0);
6276 } else if (SvUTF8(sv)) {
6277 SV * const tsv = newSV(0);
6278 sv_gets(tsv, fp, 0);
6279 sv_utf8_upgrade_nomg(tsv);
6280 SvCUR_set(sv,append);
6283 goto return_string_or_null;
6288 if (PerlIO_isutf8(fp))
6291 if (IN_PERL_COMPILETIME) {
6292 /* we always read code in line mode */
6296 else if (RsSNARF(PL_rs)) {
6297 /* If it is a regular disk file use size from stat() as estimate
6298 of amount we are going to read -- may result in mallocing
6299 more memory than we really need if the layers below reduce
6300 the size we read (e.g. CRLF or a gzip layer).
6303 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6304 const Off_t offset = PerlIO_tell(fp);
6305 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6306 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6312 else if (RsRECORD(PL_rs)) {
6317 /* Grab the size of the record we're getting */
6318 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6319 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6322 /* VMS wants read instead of fread, because fread doesn't respect */
6323 /* RMS record boundaries. This is not necessarily a good thing to be */
6324 /* doing, but we've got no other real choice - except avoid stdio
6325 as implementation - perhaps write a :vms layer ?
6327 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6329 bytesread = PerlIO_read(fp, buffer, recsize);
6333 SvCUR_set(sv, bytesread += append);
6334 buffer[bytesread] = '\0';
6335 goto return_string_or_null;
6337 else if (RsPARA(PL_rs)) {
6343 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6344 if (PerlIO_isutf8(fp)) {
6345 rsptr = SvPVutf8(PL_rs, rslen);
6348 if (SvUTF8(PL_rs)) {
6349 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6350 Perl_croak(aTHX_ "Wide character in $/");
6353 rsptr = SvPV_const(PL_rs, rslen);
6357 rslast = rslen ? rsptr[rslen - 1] : '\0';
6359 if (rspara) { /* have to do this both before and after */
6360 do { /* to make sure file boundaries work right */
6363 i = PerlIO_getc(fp);
6367 PerlIO_ungetc(fp,i);
6373 /* See if we know enough about I/O mechanism to cheat it ! */
6375 /* This used to be #ifdef test - it is made run-time test for ease
6376 of abstracting out stdio interface. One call should be cheap
6377 enough here - and may even be a macro allowing compile
6381 if (PerlIO_fast_gets(fp)) {
6384 * We're going to steal some values from the stdio struct
6385 * and put EVERYTHING in the innermost loop into registers.
6387 register STDCHAR *ptr;
6391 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6392 /* An ungetc()d char is handled separately from the regular
6393 * buffer, so we getc() it back out and stuff it in the buffer.
6395 i = PerlIO_getc(fp);
6396 if (i == EOF) return 0;
6397 *(--((*fp)->_ptr)) = (unsigned char) i;
6401 /* Here is some breathtakingly efficient cheating */
6403 cnt = PerlIO_get_cnt(fp); /* get count into register */
6404 /* make sure we have the room */
6405 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6406 /* Not room for all of it
6407 if we are looking for a separator and room for some
6409 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6410 /* just process what we have room for */
6411 shortbuffered = cnt - SvLEN(sv) + append + 1;
6412 cnt -= shortbuffered;
6416 /* remember that cnt can be negative */
6417 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6422 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6423 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6424 DEBUG_P(PerlIO_printf(Perl_debug_log,
6425 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6426 DEBUG_P(PerlIO_printf(Perl_debug_log,
6427 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6428 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6429 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6434 while (cnt > 0) { /* this | eat */
6436 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6437 goto thats_all_folks; /* screams | sed :-) */
6441 Copy(ptr, bp, cnt, char); /* this | eat */
6442 bp += cnt; /* screams | dust */
6443 ptr += cnt; /* louder | sed :-) */
6448 if (shortbuffered) { /* oh well, must extend */
6449 cnt = shortbuffered;
6451 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6453 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6454 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6458 DEBUG_P(PerlIO_printf(Perl_debug_log,
6459 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6460 PTR2UV(ptr),(long)cnt));
6461 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6463 DEBUG_P(PerlIO_printf(Perl_debug_log,
6464 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6465 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6466 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6468 /* This used to call 'filbuf' in stdio form, but as that behaves like
6469 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6470 another abstraction. */
6471 i = PerlIO_getc(fp); /* get more characters */
6473 DEBUG_P(PerlIO_printf(Perl_debug_log,
6474 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6475 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6476 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6478 cnt = PerlIO_get_cnt(fp);
6479 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6480 DEBUG_P(PerlIO_printf(Perl_debug_log,
6481 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6483 if (i == EOF) /* all done for ever? */
6484 goto thats_really_all_folks;
6486 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6488 SvGROW(sv, bpx + cnt + 2);
6489 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6491 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6493 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6494 goto thats_all_folks;
6498 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6499 memNE((char*)bp - rslen, rsptr, rslen))
6500 goto screamer; /* go back to the fray */
6501 thats_really_all_folks:
6503 cnt += shortbuffered;
6504 DEBUG_P(PerlIO_printf(Perl_debug_log,
6505 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6506 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6507 DEBUG_P(PerlIO_printf(Perl_debug_log,
6508 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6509 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6510 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6512 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6513 DEBUG_P(PerlIO_printf(Perl_debug_log,
6514 "Screamer: done, len=%ld, string=|%.*s|\n",
6515 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6519 /*The big, slow, and stupid way. */
6520 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6521 STDCHAR *buf = NULL;
6522 Newx(buf, 8192, STDCHAR);
6530 register const STDCHAR * const bpe = buf + sizeof(buf);
6532 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6533 ; /* keep reading */
6537 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6538 /* Accomodate broken VAXC compiler, which applies U8 cast to
6539 * both args of ?: operator, causing EOF to change into 255
6542 i = (U8)buf[cnt - 1];
6548 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6550 sv_catpvn(sv, (char *) buf, cnt);
6552 sv_setpvn(sv, (char *) buf, cnt);
6554 if (i != EOF && /* joy */
6556 SvCUR(sv) < rslen ||
6557 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6561 * If we're reading from a TTY and we get a short read,
6562 * indicating that the user hit his EOF character, we need
6563 * to notice it now, because if we try to read from the TTY
6564 * again, the EOF condition will disappear.
6566 * The comparison of cnt to sizeof(buf) is an optimization
6567 * that prevents unnecessary calls to feof().
6571 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6575 #ifdef USE_HEAP_INSTEAD_OF_STACK
6580 if (rspara) { /* have to do this both before and after */
6581 while (i != EOF) { /* to make sure file boundaries work right */
6582 i = PerlIO_getc(fp);
6584 PerlIO_ungetc(fp,i);
6590 return_string_or_null:
6591 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6597 Auto-increment of the value in the SV, doing string to numeric conversion
6598 if necessary. Handles 'get' magic.
6604 Perl_sv_inc(pTHX_ register SV *sv)
6613 if (SvTHINKFIRST(sv)) {
6615 sv_force_normal_flags(sv, 0);
6616 if (SvREADONLY(sv)) {
6617 if (IN_PERL_RUNTIME)
6618 Perl_croak(aTHX_ PL_no_modify);
6622 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6624 i = PTR2IV(SvRV(sv));
6629 flags = SvFLAGS(sv);
6630 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6631 /* It's (privately or publicly) a float, but not tested as an
6632 integer, so test it to see. */
6634 flags = SvFLAGS(sv);
6636 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6637 /* It's publicly an integer, or privately an integer-not-float */
6638 #ifdef PERL_PRESERVE_IVUV
6642 if (SvUVX(sv) == UV_MAX)
6643 sv_setnv(sv, UV_MAX_P1);
6645 (void)SvIOK_only_UV(sv);
6646 SvUV_set(sv, SvUVX(sv) + 1);
6648 if (SvIVX(sv) == IV_MAX)
6649 sv_setuv(sv, (UV)IV_MAX + 1);
6651 (void)SvIOK_only(sv);
6652 SvIV_set(sv, SvIVX(sv) + 1);
6657 if (flags & SVp_NOK) {
6658 (void)SvNOK_only(sv);
6659 SvNV_set(sv, SvNVX(sv) + 1.0);
6663 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6664 if ((flags & SVTYPEMASK) < SVt_PVIV)
6665 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6666 (void)SvIOK_only(sv);
6671 while (isALPHA(*d)) d++;
6672 while (isDIGIT(*d)) d++;
6674 #ifdef PERL_PRESERVE_IVUV
6675 /* Got to punt this as an integer if needs be, but we don't issue
6676 warnings. Probably ought to make the sv_iv_please() that does
6677 the conversion if possible, and silently. */
6678 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6679 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6680 /* Need to try really hard to see if it's an integer.
6681 9.22337203685478e+18 is an integer.
6682 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6683 so $a="9.22337203685478e+18"; $a+0; $a++
6684 needs to be the same as $a="9.22337203685478e+18"; $a++
6691 /* sv_2iv *should* have made this an NV */
6692 if (flags & SVp_NOK) {
6693 (void)SvNOK_only(sv);
6694 SvNV_set(sv, SvNVX(sv) + 1.0);
6697 /* I don't think we can get here. Maybe I should assert this
6698 And if we do get here I suspect that sv_setnv will croak. NWC
6700 #if defined(USE_LONG_DOUBLE)
6701 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",
6702 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6704 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6705 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6708 #endif /* PERL_PRESERVE_IVUV */
6709 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6713 while (d >= SvPVX_const(sv)) {
6721 /* MKS: The original code here died if letters weren't consecutive.
6722 * at least it didn't have to worry about non-C locales. The
6723 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6724 * arranged in order (although not consecutively) and that only
6725 * [A-Za-z] are accepted by isALPHA in the C locale.
6727 if (*d != 'z' && *d != 'Z') {
6728 do { ++*d; } while (!isALPHA(*d));
6731 *(d--) -= 'z' - 'a';
6736 *(d--) -= 'z' - 'a' + 1;
6740 /* oh,oh, the number grew */
6741 SvGROW(sv, SvCUR(sv) + 2);
6742 SvCUR_set(sv, SvCUR(sv) + 1);
6743 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6754 Auto-decrement of the value in the SV, doing string to numeric conversion
6755 if necessary. Handles 'get' magic.
6761 Perl_sv_dec(pTHX_ register SV *sv)
6769 if (SvTHINKFIRST(sv)) {
6771 sv_force_normal_flags(sv, 0);
6772 if (SvREADONLY(sv)) {
6773 if (IN_PERL_RUNTIME)
6774 Perl_croak(aTHX_ PL_no_modify);
6778 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6780 i = PTR2IV(SvRV(sv));
6785 /* Unlike sv_inc we don't have to worry about string-never-numbers
6786 and keeping them magic. But we mustn't warn on punting */
6787 flags = SvFLAGS(sv);
6788 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6789 /* It's publicly an integer, or privately an integer-not-float */
6790 #ifdef PERL_PRESERVE_IVUV
6794 if (SvUVX(sv) == 0) {
6795 (void)SvIOK_only(sv);
6799 (void)SvIOK_only_UV(sv);
6800 SvUV_set(sv, SvUVX(sv) - 1);
6803 if (SvIVX(sv) == IV_MIN)
6804 sv_setnv(sv, (NV)IV_MIN - 1.0);
6806 (void)SvIOK_only(sv);
6807 SvIV_set(sv, SvIVX(sv) - 1);
6812 if (flags & SVp_NOK) {
6813 SvNV_set(sv, SvNVX(sv) - 1.0);
6814 (void)SvNOK_only(sv);
6817 if (!(flags & SVp_POK)) {
6818 if ((flags & SVTYPEMASK) < SVt_PVIV)
6819 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6821 (void)SvIOK_only(sv);
6824 #ifdef PERL_PRESERVE_IVUV
6826 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6827 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6828 /* Need to try really hard to see if it's an integer.
6829 9.22337203685478e+18 is an integer.
6830 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6831 so $a="9.22337203685478e+18"; $a+0; $a--
6832 needs to be the same as $a="9.22337203685478e+18"; $a--
6839 /* sv_2iv *should* have made this an NV */
6840 if (flags & SVp_NOK) {
6841 (void)SvNOK_only(sv);
6842 SvNV_set(sv, SvNVX(sv) - 1.0);
6845 /* I don't think we can get here. Maybe I should assert this
6846 And if we do get here I suspect that sv_setnv will croak. NWC
6848 #if defined(USE_LONG_DOUBLE)
6849 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",
6850 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6852 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6853 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6857 #endif /* PERL_PRESERVE_IVUV */
6858 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6862 =for apidoc sv_mortalcopy
6864 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6865 The new SV is marked as mortal. It will be destroyed "soon", either by an
6866 explicit call to FREETMPS, or by an implicit call at places such as
6867 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6872 /* Make a string that will exist for the duration of the expression
6873 * evaluation. Actually, it may have to last longer than that, but
6874 * hopefully we won't free it until it has been assigned to a
6875 * permanent location. */
6878 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6884 sv_setsv(sv,oldstr);
6886 PL_tmps_stack[++PL_tmps_ix] = sv;
6892 =for apidoc sv_newmortal
6894 Creates a new null SV which is mortal. The reference count of the SV is
6895 set to 1. It will be destroyed "soon", either by an explicit call to
6896 FREETMPS, or by an implicit call at places such as statement boundaries.
6897 See also C<sv_mortalcopy> and C<sv_2mortal>.
6903 Perl_sv_newmortal(pTHX)
6909 SvFLAGS(sv) = SVs_TEMP;
6911 PL_tmps_stack[++PL_tmps_ix] = sv;
6916 =for apidoc sv_2mortal
6918 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6919 by an explicit call to FREETMPS, or by an implicit call at places such as
6920 statement boundaries. SvTEMP() is turned on which means that the SV's
6921 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6922 and C<sv_mortalcopy>.
6928 Perl_sv_2mortal(pTHX_ register SV *sv)
6933 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6936 PL_tmps_stack[++PL_tmps_ix] = sv;
6944 Creates a new SV and copies a string into it. The reference count for the
6945 SV is set to 1. If C<len> is zero, Perl will compute the length using
6946 strlen(). For efficiency, consider using C<newSVpvn> instead.
6952 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6958 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6963 =for apidoc newSVpvn
6965 Creates a new SV and copies a string into it. The reference count for the
6966 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6967 string. You are responsible for ensuring that the source string is at least
6968 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6974 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6980 sv_setpvn(sv,s,len);
6986 =for apidoc newSVhek
6988 Creates a new SV from the hash key structure. It will generate scalars that
6989 point to the shared string table where possible. Returns a new (undefined)
6990 SV if the hek is NULL.
6996 Perl_newSVhek(pTHX_ const HEK *hek)
7006 if (HEK_LEN(hek) == HEf_SVKEY) {
7007 return newSVsv(*(SV**)HEK_KEY(hek));
7009 const int flags = HEK_FLAGS(hek);
7010 if (flags & HVhek_WASUTF8) {
7012 Andreas would like keys he put in as utf8 to come back as utf8
7014 STRLEN utf8_len = HEK_LEN(hek);
7015 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7016 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7019 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7021 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7022 /* We don't have a pointer to the hv, so we have to replicate the
7023 flag into every HEK. This hv is using custom a hasing
7024 algorithm. Hence we can't return a shared string scalar, as
7025 that would contain the (wrong) hash value, and might get passed
7026 into an hv routine with a regular hash.
7027 Similarly, a hash that isn't using shared hash keys has to have
7028 the flag in every key so that we know not to try to call
7029 share_hek_kek on it. */
7031 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7036 /* This will be overwhelminly the most common case. */
7038 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7039 more efficient than sharepvn(). */
7043 sv_upgrade(sv, SVt_PV);
7044 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7045 SvCUR_set(sv, HEK_LEN(hek));
7058 =for apidoc newSVpvn_share
7060 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7061 table. If the string does not already exist in the table, it is created
7062 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7063 value is used; otherwise the hash is computed. The string's hash can be later
7064 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7065 that as the string table is used for shared hash keys these strings will have
7066 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7072 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7076 bool is_utf8 = FALSE;
7077 const char *const orig_src = src;
7080 STRLEN tmplen = -len;
7082 /* See the note in hv.c:hv_fetch() --jhi */
7083 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7087 PERL_HASH(hash, src, len);
7089 sv_upgrade(sv, SVt_PV);
7090 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7098 if (src != orig_src)
7104 #if defined(PERL_IMPLICIT_CONTEXT)
7106 /* pTHX_ magic can't cope with varargs, so this is a no-context
7107 * version of the main function, (which may itself be aliased to us).
7108 * Don't access this version directly.
7112 Perl_newSVpvf_nocontext(const char* pat, ...)
7117 va_start(args, pat);
7118 sv = vnewSVpvf(pat, &args);
7125 =for apidoc newSVpvf
7127 Creates a new SV and initializes it with the string formatted like
7134 Perl_newSVpvf(pTHX_ const char* pat, ...)
7138 va_start(args, pat);
7139 sv = vnewSVpvf(pat, &args);
7144 /* backend for newSVpvf() and newSVpvf_nocontext() */
7147 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7152 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7159 Creates a new SV and copies a floating point value into it.
7160 The reference count for the SV is set to 1.
7166 Perl_newSVnv(pTHX_ NV n)
7179 Creates a new SV and copies an integer into it. The reference count for the
7186 Perl_newSViv(pTHX_ IV i)
7199 Creates a new SV and copies an unsigned integer into it.
7200 The reference count for the SV is set to 1.
7206 Perl_newSVuv(pTHX_ UV u)
7217 =for apidoc newSV_type
7219 Creates a new SV, of the type specificied. The reference count for the new SV
7226 Perl_newSV_type(pTHX_ svtype type)
7231 sv_upgrade(sv, type);
7236 =for apidoc newRV_noinc
7238 Creates an RV wrapper for an SV. The reference count for the original
7239 SV is B<not> incremented.
7245 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7248 register SV *sv = newSV_type(SVt_RV);
7250 SvRV_set(sv, tmpRef);
7255 /* newRV_inc is the official function name to use now.
7256 * newRV_inc is in fact #defined to newRV in sv.h
7260 Perl_newRV(pTHX_ SV *sv)
7263 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7269 Creates a new SV which is an exact duplicate of the original SV.
7276 Perl_newSVsv(pTHX_ register SV *old)
7283 if (SvTYPE(old) == SVTYPEMASK) {
7284 if (ckWARN_d(WARN_INTERNAL))
7285 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7289 /* SV_GMAGIC is the default for sv_setv()
7290 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7291 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7292 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7297 =for apidoc sv_reset
7299 Underlying implementation for the C<reset> Perl function.
7300 Note that the perl-level function is vaguely deprecated.
7306 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7309 char todo[PERL_UCHAR_MAX+1];
7314 if (!*s) { /* reset ?? searches */
7315 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7317 const U32 count = mg->mg_len / sizeof(PMOP**);
7318 PMOP **pmp = (PMOP**) mg->mg_ptr;
7319 PMOP *const *const end = pmp + count;
7323 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7325 (*pmp)->op_pmflags &= ~PMf_USED;
7333 /* reset variables */
7335 if (!HvARRAY(stash))
7338 Zero(todo, 256, char);
7341 I32 i = (unsigned char)*s;
7345 max = (unsigned char)*s++;
7346 for ( ; i <= max; i++) {
7349 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7351 for (entry = HvARRAY(stash)[i];
7353 entry = HeNEXT(entry))
7358 if (!todo[(U8)*HeKEY(entry)])
7360 gv = (GV*)HeVAL(entry);
7363 if (SvTHINKFIRST(sv)) {
7364 if (!SvREADONLY(sv) && SvROK(sv))
7366 /* XXX Is this continue a bug? Why should THINKFIRST
7367 exempt us from resetting arrays and hashes? */
7371 if (SvTYPE(sv) >= SVt_PV) {
7373 if (SvPVX_const(sv) != NULL)
7381 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7383 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7386 # if defined(USE_ENVIRON_ARRAY)
7389 # endif /* USE_ENVIRON_ARRAY */
7400 Using various gambits, try to get an IO from an SV: the IO slot if its a
7401 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7402 named after the PV if we're a string.
7408 Perl_sv_2io(pTHX_ SV *sv)
7413 switch (SvTYPE(sv)) {
7421 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7425 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7427 return sv_2io(SvRV(sv));
7428 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7434 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7443 Using various gambits, try to get a CV from an SV; in addition, try if
7444 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7445 The flags in C<lref> are passed to sv_fetchsv.
7451 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7462 switch (SvTYPE(sv)) {
7481 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7482 tryAMAGICunDEREF(to_cv);
7485 if (SvTYPE(sv) == SVt_PVCV) {
7494 Perl_croak(aTHX_ "Not a subroutine reference");
7499 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7505 /* Some flags to gv_fetchsv mean don't really create the GV */
7506 if (SvTYPE(gv) != SVt_PVGV) {
7512 if (lref && !GvCVu(gv)) {
7516 gv_efullname3(tmpsv, gv, NULL);
7517 /* XXX this is probably not what they think they're getting.
7518 * It has the same effect as "sub name;", i.e. just a forward
7520 newSUB(start_subparse(FALSE, 0),
7521 newSVOP(OP_CONST, 0, tmpsv),
7525 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7535 Returns true if the SV has a true value by Perl's rules.
7536 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7537 instead use an in-line version.
7543 Perl_sv_true(pTHX_ register SV *sv)
7548 register const XPV* const tXpv = (XPV*)SvANY(sv);
7550 (tXpv->xpv_cur > 1 ||
7551 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7558 return SvIVX(sv) != 0;
7561 return SvNVX(sv) != 0.0;
7563 return sv_2bool(sv);
7569 =for apidoc sv_pvn_force
7571 Get a sensible string out of the SV somehow.
7572 A private implementation of the C<SvPV_force> macro for compilers which
7573 can't cope with complex macro expressions. Always use the macro instead.
7575 =for apidoc sv_pvn_force_flags
7577 Get a sensible string out of the SV somehow.
7578 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7579 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7580 implemented in terms of this function.
7581 You normally want to use the various wrapper macros instead: see
7582 C<SvPV_force> and C<SvPV_force_nomg>
7588 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7591 if (SvTHINKFIRST(sv) && !SvROK(sv))
7592 sv_force_normal_flags(sv, 0);
7602 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7603 const char * const ref = sv_reftype(sv,0);
7605 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7606 ref, OP_NAME(PL_op));
7608 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7610 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7611 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7613 s = sv_2pv_flags(sv, &len, flags);
7617 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7620 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7621 SvGROW(sv, len + 1);
7622 Move(s,SvPVX(sv),len,char);
7624 SvPVX(sv)[len] = '\0';
7627 SvPOK_on(sv); /* validate pointer */
7629 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7630 PTR2UV(sv),SvPVX_const(sv)));
7633 return SvPVX_mutable(sv);
7637 =for apidoc sv_pvbyten_force
7639 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7645 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7647 sv_pvn_force(sv,lp);
7648 sv_utf8_downgrade(sv,0);
7654 =for apidoc sv_pvutf8n_force
7656 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7662 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7664 sv_pvn_force(sv,lp);
7665 sv_utf8_upgrade(sv);
7671 =for apidoc sv_reftype
7673 Returns a string describing what the SV is a reference to.
7679 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7681 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7682 inside return suggests a const propagation bug in g++. */
7683 if (ob && SvOBJECT(sv)) {
7684 char * const name = HvNAME_get(SvSTASH(sv));
7685 return name ? name : (char *) "__ANON__";
7688 switch (SvTYPE(sv)) {
7704 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7705 /* tied lvalues should appear to be
7706 * scalars for backwards compatitbility */
7707 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7708 ? "SCALAR" : "LVALUE");
7709 case SVt_PVAV: return "ARRAY";
7710 case SVt_PVHV: return "HASH";
7711 case SVt_PVCV: return "CODE";
7712 case SVt_PVGV: return "GLOB";
7713 case SVt_PVFM: return "FORMAT";
7714 case SVt_PVIO: return "IO";
7715 case SVt_BIND: return "BIND";
7716 default: return "UNKNOWN";
7722 =for apidoc sv_isobject
7724 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7725 object. If the SV is not an RV, or if the object is not blessed, then this
7732 Perl_sv_isobject(pTHX_ SV *sv)
7748 Returns a boolean indicating whether the SV is blessed into the specified
7749 class. This does not check for subtypes; use C<sv_derived_from> to verify
7750 an inheritance relationship.
7756 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7767 hvname = HvNAME_get(SvSTASH(sv));
7771 return strEQ(hvname, name);
7777 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7778 it will be upgraded to one. If C<classname> is non-null then the new SV will
7779 be blessed in the specified package. The new SV is returned and its
7780 reference count is 1.
7786 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7793 SV_CHECK_THINKFIRST_COW_DROP(rv);
7794 (void)SvAMAGIC_off(rv);
7796 if (SvTYPE(rv) >= SVt_PVMG) {
7797 const U32 refcnt = SvREFCNT(rv);
7801 SvREFCNT(rv) = refcnt;
7803 sv_upgrade(rv, SVt_RV);
7804 } else if (SvROK(rv)) {
7805 SvREFCNT_dec(SvRV(rv));
7806 } else if (SvTYPE(rv) < SVt_RV)
7807 sv_upgrade(rv, SVt_RV);
7808 else if (SvTYPE(rv) > SVt_RV) {
7819 HV* const stash = gv_stashpv(classname, GV_ADD);
7820 (void)sv_bless(rv, stash);
7826 =for apidoc sv_setref_pv
7828 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7829 argument will be upgraded to an RV. That RV will be modified to point to
7830 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7831 into the SV. The C<classname> argument indicates the package for the
7832 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7833 will have a reference count of 1, and the RV will be returned.
7835 Do not use with other Perl types such as HV, AV, SV, CV, because those
7836 objects will become corrupted by the pointer copy process.
7838 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7844 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7848 sv_setsv(rv, &PL_sv_undef);
7852 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7857 =for apidoc sv_setref_iv
7859 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7860 argument will be upgraded to an RV. That RV will be modified to point to
7861 the new SV. The C<classname> argument indicates the package for the
7862 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7863 will have a reference count of 1, and the RV will be returned.
7869 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7871 sv_setiv(newSVrv(rv,classname), iv);
7876 =for apidoc sv_setref_uv
7878 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7879 argument will be upgraded to an RV. That RV will be modified to point to
7880 the new SV. The C<classname> argument indicates the package for the
7881 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7882 will have a reference count of 1, and the RV will be returned.
7888 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7890 sv_setuv(newSVrv(rv,classname), uv);
7895 =for apidoc sv_setref_nv
7897 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7898 argument will be upgraded to an RV. That RV will be modified to point to
7899 the new SV. The C<classname> argument indicates the package for the
7900 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7901 will have a reference count of 1, and the RV will be returned.
7907 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7909 sv_setnv(newSVrv(rv,classname), nv);
7914 =for apidoc sv_setref_pvn
7916 Copies a string into a new SV, optionally blessing the SV. The length of the
7917 string must be specified with C<n>. The C<rv> argument will be upgraded to
7918 an RV. That RV will be modified to point to the new SV. The C<classname>
7919 argument indicates the package for the blessing. Set C<classname> to
7920 C<NULL> to avoid the blessing. The new SV will have a reference count
7921 of 1, and the RV will be returned.
7923 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7929 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7931 sv_setpvn(newSVrv(rv,classname), pv, n);
7936 =for apidoc sv_bless
7938 Blesses an SV into a specified package. The SV must be an RV. The package
7939 must be designated by its stash (see C<gv_stashpv()>). The reference count
7940 of the SV is unaffected.
7946 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7951 Perl_croak(aTHX_ "Can't bless non-reference value");
7953 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7954 if (SvREADONLY(tmpRef))
7955 Perl_croak(aTHX_ PL_no_modify);
7956 if (SvOBJECT(tmpRef)) {
7957 if (SvTYPE(tmpRef) != SVt_PVIO)
7959 SvREFCNT_dec(SvSTASH(tmpRef));
7962 SvOBJECT_on(tmpRef);
7963 if (SvTYPE(tmpRef) != SVt_PVIO)
7965 SvUPGRADE(tmpRef, SVt_PVMG);
7966 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7971 (void)SvAMAGIC_off(sv);
7973 if(SvSMAGICAL(tmpRef))
7974 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7982 /* Downgrades a PVGV to a PVMG.
7986 S_sv_unglob(pTHX_ SV *sv)
7991 SV * const temp = sv_newmortal();
7993 assert(SvTYPE(sv) == SVt_PVGV);
7995 gv_efullname3(temp, (GV *) sv, "*");
7998 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
7999 mro_method_changed_in(stash);
8003 sv_del_backref((SV*)GvSTASH(sv), sv);
8007 if (GvNAME_HEK(sv)) {
8008 unshare_hek(GvNAME_HEK(sv));
8010 isGV_with_GP_off(sv);
8012 /* need to keep SvANY(sv) in the right arena */
8013 xpvmg = new_XPVMG();
8014 StructCopy(SvANY(sv), xpvmg, XPVMG);
8015 del_XPVGV(SvANY(sv));
8018 SvFLAGS(sv) &= ~SVTYPEMASK;
8019 SvFLAGS(sv) |= SVt_PVMG;
8021 /* Intentionally not calling any local SET magic, as this isn't so much a
8022 set operation as merely an internal storage change. */
8023 sv_setsv_flags(sv, temp, 0);
8027 =for apidoc sv_unref_flags
8029 Unsets the RV status of the SV, and decrements the reference count of
8030 whatever was being referenced by the RV. This can almost be thought of
8031 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8032 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8033 (otherwise the decrementing is conditional on the reference count being
8034 different from one or the reference being a readonly SV).
8041 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8043 SV* const target = SvRV(ref);
8045 if (SvWEAKREF(ref)) {
8046 sv_del_backref(target, ref);
8048 SvRV_set(ref, NULL);
8051 SvRV_set(ref, NULL);
8053 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8054 assigned to as BEGIN {$a = \"Foo"} will fail. */
8055 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8056 SvREFCNT_dec(target);
8057 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8058 sv_2mortal(target); /* Schedule for freeing later */
8062 =for apidoc sv_untaint
8064 Untaint an SV. Use C<SvTAINTED_off> instead.
8069 Perl_sv_untaint(pTHX_ SV *sv)
8071 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8072 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8079 =for apidoc sv_tainted
8081 Test an SV for taintedness. Use C<SvTAINTED> instead.
8086 Perl_sv_tainted(pTHX_ SV *sv)
8088 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8089 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8090 if (mg && (mg->mg_len & 1) )
8097 =for apidoc sv_setpviv
8099 Copies an integer into the given SV, also updating its string value.
8100 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8106 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8108 char buf[TYPE_CHARS(UV)];
8110 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8112 sv_setpvn(sv, ptr, ebuf - ptr);
8116 =for apidoc sv_setpviv_mg
8118 Like C<sv_setpviv>, but also handles 'set' magic.
8124 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8130 #if defined(PERL_IMPLICIT_CONTEXT)
8132 /* pTHX_ magic can't cope with varargs, so this is a no-context
8133 * version of the main function, (which may itself be aliased to us).
8134 * Don't access this version directly.
8138 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8142 va_start(args, pat);
8143 sv_vsetpvf(sv, pat, &args);
8147 /* pTHX_ magic can't cope with varargs, so this is a no-context
8148 * version of the main function, (which may itself be aliased to us).
8149 * Don't access this version directly.
8153 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8157 va_start(args, pat);
8158 sv_vsetpvf_mg(sv, pat, &args);
8164 =for apidoc sv_setpvf
8166 Works like C<sv_catpvf> but copies the text into the SV instead of
8167 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8173 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8176 va_start(args, pat);
8177 sv_vsetpvf(sv, pat, &args);
8182 =for apidoc sv_vsetpvf
8184 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8185 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8187 Usually used via its frontend C<sv_setpvf>.
8193 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8195 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8199 =for apidoc sv_setpvf_mg
8201 Like C<sv_setpvf>, but also handles 'set' magic.
8207 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8210 va_start(args, pat);
8211 sv_vsetpvf_mg(sv, pat, &args);
8216 =for apidoc sv_vsetpvf_mg
8218 Like C<sv_vsetpvf>, but also handles 'set' magic.
8220 Usually used via its frontend C<sv_setpvf_mg>.
8226 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8228 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8232 #if defined(PERL_IMPLICIT_CONTEXT)
8234 /* pTHX_ magic can't cope with varargs, so this is a no-context
8235 * version of the main function, (which may itself be aliased to us).
8236 * Don't access this version directly.
8240 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8244 va_start(args, pat);
8245 sv_vcatpvf(sv, pat, &args);
8249 /* pTHX_ magic can't cope with varargs, so this is a no-context
8250 * version of the main function, (which may itself be aliased to us).
8251 * Don't access this version directly.
8255 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8259 va_start(args, pat);
8260 sv_vcatpvf_mg(sv, pat, &args);
8266 =for apidoc sv_catpvf
8268 Processes its arguments like C<sprintf> and appends the formatted
8269 output to an SV. If the appended data contains "wide" characters
8270 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8271 and characters >255 formatted with %c), the original SV might get
8272 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8273 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8274 valid UTF-8; if the original SV was bytes, the pattern should be too.
8279 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8282 va_start(args, pat);
8283 sv_vcatpvf(sv, pat, &args);
8288 =for apidoc sv_vcatpvf
8290 Processes its arguments like C<vsprintf> and appends the formatted output
8291 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8293 Usually used via its frontend C<sv_catpvf>.
8299 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8301 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8305 =for apidoc sv_catpvf_mg
8307 Like C<sv_catpvf>, but also handles 'set' magic.
8313 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8316 va_start(args, pat);
8317 sv_vcatpvf_mg(sv, pat, &args);
8322 =for apidoc sv_vcatpvf_mg
8324 Like C<sv_vcatpvf>, but also handles 'set' magic.
8326 Usually used via its frontend C<sv_catpvf_mg>.
8332 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8334 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8339 =for apidoc sv_vsetpvfn
8341 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8344 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8350 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8352 sv_setpvn(sv, "", 0);
8353 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8357 S_expect_number(pTHX_ char** pattern)
8361 switch (**pattern) {
8362 case '1': case '2': case '3':
8363 case '4': case '5': case '6':
8364 case '7': case '8': case '9':
8365 var = *(*pattern)++ - '0';
8366 while (isDIGIT(**pattern)) {
8367 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8369 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8377 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8379 const int neg = nv < 0;
8388 if (uv & 1 && uv == nv)
8389 uv--; /* Round to even */
8391 const unsigned dig = uv % 10;
8404 =for apidoc sv_vcatpvfn
8406 Processes its arguments like C<vsprintf> and appends the formatted output
8407 to an SV. Uses an array of SVs if the C style variable argument list is
8408 missing (NULL). When running with taint checks enabled, indicates via
8409 C<maybe_tainted> if results are untrustworthy (often due to the use of
8412 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8418 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8419 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8420 vec_utf8 = DO_UTF8(vecsv);
8422 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8425 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8433 static const char nullstr[] = "(null)";
8435 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8436 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8438 /* Times 4: a decimal digit takes more than 3 binary digits.
8439 * NV_DIG: mantissa takes than many decimal digits.
8440 * Plus 32: Playing safe. */
8441 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8442 /* large enough for "%#.#f" --chip */
8443 /* what about long double NVs? --jhi */
8445 PERL_UNUSED_ARG(maybe_tainted);
8447 /* no matter what, this is a string now */
8448 (void)SvPV_force(sv, origlen);
8450 /* special-case "", "%s", and "%-p" (SVf - see below) */
8453 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8455 const char * const s = va_arg(*args, char*);
8456 sv_catpv(sv, s ? s : nullstr);
8458 else if (svix < svmax) {
8459 sv_catsv(sv, *svargs);
8463 if (args && patlen == 3 && pat[0] == '%' &&
8464 pat[1] == '-' && pat[2] == 'p') {
8465 argsv = (SV*)va_arg(*args, void*);
8466 sv_catsv(sv, argsv);
8470 #ifndef USE_LONG_DOUBLE
8471 /* special-case "%.<number>[gf]" */
8472 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8473 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8474 unsigned digits = 0;
8478 while (*pp >= '0' && *pp <= '9')
8479 digits = 10 * digits + (*pp++ - '0');
8480 if (pp - pat == (int)patlen - 1) {
8488 /* Add check for digits != 0 because it seems that some
8489 gconverts are buggy in this case, and we don't yet have
8490 a Configure test for this. */
8491 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8492 /* 0, point, slack */
8493 Gconvert(nv, (int)digits, 0, ebuf);
8495 if (*ebuf) /* May return an empty string for digits==0 */
8498 } else if (!digits) {
8501 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8502 sv_catpvn(sv, p, l);
8508 #endif /* !USE_LONG_DOUBLE */
8510 if (!args && svix < svmax && DO_UTF8(*svargs))
8513 patend = (char*)pat + patlen;
8514 for (p = (char*)pat; p < patend; p = q) {
8517 bool vectorize = FALSE;
8518 bool vectorarg = FALSE;
8519 bool vec_utf8 = FALSE;
8525 bool has_precis = FALSE;
8527 const I32 osvix = svix;
8528 bool is_utf8 = FALSE; /* is this item utf8? */
8529 #ifdef HAS_LDBL_SPRINTF_BUG
8530 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8531 with sfio - Allen <allens@cpan.org> */
8532 bool fix_ldbl_sprintf_bug = FALSE;
8536 U8 utf8buf[UTF8_MAXBYTES+1];
8537 STRLEN esignlen = 0;
8539 const char *eptr = NULL;
8542 const U8 *vecstr = NULL;
8549 /* we need a long double target in case HAS_LONG_DOUBLE but
8552 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8560 const char *dotstr = ".";
8561 STRLEN dotstrlen = 1;
8562 I32 efix = 0; /* explicit format parameter index */
8563 I32 ewix = 0; /* explicit width index */
8564 I32 epix = 0; /* explicit precision index */
8565 I32 evix = 0; /* explicit vector index */
8566 bool asterisk = FALSE;
8568 /* echo everything up to the next format specification */
8569 for (q = p; q < patend && *q != '%'; ++q) ;
8571 if (has_utf8 && !pat_utf8)
8572 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8574 sv_catpvn(sv, p, q - p);
8581 We allow format specification elements in this order:
8582 \d+\$ explicit format parameter index
8584 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8585 0 flag (as above): repeated to allow "v02"
8586 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8587 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8589 [%bcdefginopsuxDFOUX] format (mandatory)
8594 As of perl5.9.3, printf format checking is on by default.
8595 Internally, perl uses %p formats to provide an escape to
8596 some extended formatting. This block deals with those
8597 extensions: if it does not match, (char*)q is reset and
8598 the normal format processing code is used.
8600 Currently defined extensions are:
8601 %p include pointer address (standard)
8602 %-p (SVf) include an SV (previously %_)
8603 %-<num>p include an SV with precision <num>
8604 %1p (VDf) include a v-string (as %vd)
8605 %<num>p reserved for future extensions
8607 Robin Barker 2005-07-14
8614 n = expect_number(&q);
8621 argsv = (SV*)va_arg(*args, void*);
8622 eptr = SvPV_const(argsv, elen);
8628 else if (n == vdNUMBER) { /* VDf */
8635 if (ckWARN_d(WARN_INTERNAL))
8636 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8637 "internal %%<num>p might conflict with future printf extensions");
8643 if ( (width = expect_number(&q)) ) {
8658 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8687 if ( (ewix = expect_number(&q)) )
8696 if ((vectorarg = asterisk)) {
8709 width = expect_number(&q);
8715 vecsv = va_arg(*args, SV*);
8717 vecsv = (evix > 0 && evix <= svmax)
8718 ? svargs[evix-1] : &PL_sv_undef;
8720 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8722 dotstr = SvPV_const(vecsv, dotstrlen);
8723 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8724 bad with tied or overloaded values that return UTF8. */
8727 else if (has_utf8) {
8728 vecsv = sv_mortalcopy(vecsv);
8729 sv_utf8_upgrade(vecsv);
8730 dotstr = SvPV_const(vecsv, dotstrlen);
8737 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8738 vecsv = svargs[efix ? efix-1 : svix++];
8739 vecstr = (U8*)SvPV_const(vecsv,veclen);
8740 vec_utf8 = DO_UTF8(vecsv);
8742 /* if this is a version object, we need to convert
8743 * back into v-string notation and then let the
8744 * vectorize happen normally
8746 if (sv_derived_from(vecsv, "version")) {
8747 char *version = savesvpv(vecsv);
8748 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8749 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8750 "vector argument not supported with alpha versions");
8753 vecsv = sv_newmortal();
8754 scan_vstring(version, version + veclen, vecsv);
8755 vecstr = (U8*)SvPV_const(vecsv, veclen);
8756 vec_utf8 = DO_UTF8(vecsv);
8768 i = va_arg(*args, int);
8770 i = (ewix ? ewix <= svmax : svix < svmax) ?
8771 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8773 width = (i < 0) ? -i : i;
8783 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8785 /* XXX: todo, support specified precision parameter */
8789 i = va_arg(*args, int);
8791 i = (ewix ? ewix <= svmax : svix < svmax)
8792 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8794 has_precis = !(i < 0);
8799 precis = precis * 10 + (*q++ - '0');
8808 case 'I': /* Ix, I32x, and I64x */
8810 if (q[1] == '6' && q[2] == '4') {
8816 if (q[1] == '3' && q[2] == '2') {
8826 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8837 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8838 if (*(q + 1) == 'l') { /* lld, llf */
8864 if (!vectorize && !args) {
8866 const I32 i = efix-1;
8867 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8869 argsv = (svix >= 0 && svix < svmax)
8870 ? svargs[svix++] : &PL_sv_undef;
8881 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8883 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8885 eptr = (char*)utf8buf;
8886 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8900 eptr = va_arg(*args, char*);
8902 #ifdef MACOS_TRADITIONAL
8903 /* On MacOS, %#s format is used for Pascal strings */
8908 elen = strlen(eptr);
8910 eptr = (char *)nullstr;
8911 elen = sizeof nullstr - 1;
8915 eptr = SvPV_const(argsv, elen);
8916 if (DO_UTF8(argsv)) {
8917 I32 old_precis = precis;
8918 if (has_precis && precis < elen) {
8920 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8923 if (width) { /* fudge width (can't fudge elen) */
8924 if (has_precis && precis < elen)
8925 width += precis - old_precis;
8927 width += elen - sv_len_utf8(argsv);
8934 if (has_precis && elen > precis)
8941 if (alt || vectorize)
8943 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8964 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8973 esignbuf[esignlen++] = plus;
8977 case 'h': iv = (short)va_arg(*args, int); break;
8978 case 'l': iv = va_arg(*args, long); break;
8979 case 'V': iv = va_arg(*args, IV); break;
8980 default: iv = va_arg(*args, int); break;
8982 case 'q': iv = va_arg(*args, Quad_t); break;
8987 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
8989 case 'h': iv = (short)tiv; break;
8990 case 'l': iv = (long)tiv; break;
8992 default: iv = tiv; break;
8994 case 'q': iv = (Quad_t)tiv; break;
8998 if ( !vectorize ) /* we already set uv above */
9003 esignbuf[esignlen++] = plus;
9007 esignbuf[esignlen++] = '-';
9051 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9062 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9063 case 'l': uv = va_arg(*args, unsigned long); break;
9064 case 'V': uv = va_arg(*args, UV); break;
9065 default: uv = va_arg(*args, unsigned); break;
9067 case 'q': uv = va_arg(*args, Uquad_t); break;
9072 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9074 case 'h': uv = (unsigned short)tuv; break;
9075 case 'l': uv = (unsigned long)tuv; break;
9077 default: uv = tuv; break;
9079 case 'q': uv = (Uquad_t)tuv; break;
9086 char *ptr = ebuf + sizeof ebuf;
9087 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9093 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9099 esignbuf[esignlen++] = '0';
9100 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9108 if (alt && *ptr != '0')
9117 esignbuf[esignlen++] = '0';
9118 esignbuf[esignlen++] = c;
9121 default: /* it had better be ten or less */
9125 } while (uv /= base);
9128 elen = (ebuf + sizeof ebuf) - ptr;
9132 zeros = precis - elen;
9133 else if (precis == 0 && elen == 1 && *eptr == '0'
9134 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9137 /* a precision nullifies the 0 flag. */
9144 /* FLOATING POINT */
9147 c = 'f'; /* maybe %F isn't supported here */
9155 /* This is evil, but floating point is even more evil */
9157 /* for SV-style calling, we can only get NV
9158 for C-style calling, we assume %f is double;
9159 for simplicity we allow any of %Lf, %llf, %qf for long double
9163 #if defined(USE_LONG_DOUBLE)
9167 /* [perl #20339] - we should accept and ignore %lf rather than die */
9171 #if defined(USE_LONG_DOUBLE)
9172 intsize = args ? 0 : 'q';
9176 #if defined(HAS_LONG_DOUBLE)
9185 /* now we need (long double) if intsize == 'q', else (double) */
9187 #if LONG_DOUBLESIZE > DOUBLESIZE
9189 va_arg(*args, long double) :
9190 va_arg(*args, double)
9192 va_arg(*args, double)
9197 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
9198 if (c != 'e' && c != 'E' && !Perl_isnan(nv))
9200 if (c != 'e' && c != 'E' && nv == nv)
9204 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9205 will cast our (long double) to (double) */
9206 (void)Perl_frexp(nv, &i);
9207 if (i == PERL_INT_MIN)
9208 Perl_die(aTHX_ "panic: frexp");
9210 need = BIT_DIGITS(i);
9212 need += has_precis ? precis : 6; /* known default */
9217 #ifdef HAS_LDBL_SPRINTF_BUG
9218 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9219 with sfio - Allen <allens@cpan.org> */
9222 # define MY_DBL_MAX DBL_MAX
9223 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9224 # if DOUBLESIZE >= 8
9225 # define MY_DBL_MAX 1.7976931348623157E+308L
9227 # define MY_DBL_MAX 3.40282347E+38L
9231 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9232 # define MY_DBL_MAX_BUG 1L
9234 # define MY_DBL_MAX_BUG MY_DBL_MAX
9238 # define MY_DBL_MIN DBL_MIN
9239 # else /* XXX guessing! -Allen */
9240 # if DOUBLESIZE >= 8
9241 # define MY_DBL_MIN 2.2250738585072014E-308L
9243 # define MY_DBL_MIN 1.17549435E-38L
9247 if ((intsize == 'q') && (c == 'f') &&
9248 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9250 /* it's going to be short enough that
9251 * long double precision is not needed */
9253 if ((nv <= 0L) && (nv >= -0L))
9254 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9256 /* would use Perl_fp_class as a double-check but not
9257 * functional on IRIX - see perl.h comments */
9259 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9260 /* It's within the range that a double can represent */
9261 #if defined(DBL_MAX) && !defined(DBL_MIN)
9262 if ((nv >= ((long double)1/DBL_MAX)) ||
9263 (nv <= (-(long double)1/DBL_MAX)))
9265 fix_ldbl_sprintf_bug = TRUE;
9268 if (fix_ldbl_sprintf_bug == TRUE) {
9278 # undef MY_DBL_MAX_BUG
9281 #endif /* HAS_LDBL_SPRINTF_BUG */
9283 need += 20; /* fudge factor */
9284 if (PL_efloatsize < need) {
9285 Safefree(PL_efloatbuf);
9286 PL_efloatsize = need + 20; /* more fudge */
9287 Newx(PL_efloatbuf, PL_efloatsize, char);
9288 PL_efloatbuf[0] = '\0';
9291 if ( !(width || left || plus || alt) && fill != '0'
9292 && has_precis && intsize != 'q' ) { /* Shortcuts */
9293 /* See earlier comment about buggy Gconvert when digits,
9295 if ( c == 'g' && precis) {
9296 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9297 /* May return an empty string for digits==0 */
9298 if (*PL_efloatbuf) {
9299 elen = strlen(PL_efloatbuf);
9300 goto float_converted;
9302 } else if ( c == 'f' && !precis) {
9303 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9308 char *ptr = ebuf + sizeof ebuf;
9311 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9312 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9313 if (intsize == 'q') {
9314 /* Copy the one or more characters in a long double
9315 * format before the 'base' ([efgEFG]) character to
9316 * the format string. */
9317 static char const prifldbl[] = PERL_PRIfldbl;
9318 char const *p = prifldbl + sizeof(prifldbl) - 3;
9319 while (p >= prifldbl) { *--ptr = *p--; }
9324 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9329 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9341 /* No taint. Otherwise we are in the strange situation
9342 * where printf() taints but print($float) doesn't.
9344 #if defined(HAS_LONG_DOUBLE)
9345 elen = ((intsize == 'q')
9346 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9347 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9349 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9353 eptr = PL_efloatbuf;
9361 i = SvCUR(sv) - origlen;
9364 case 'h': *(va_arg(*args, short*)) = i; break;
9365 default: *(va_arg(*args, int*)) = i; break;
9366 case 'l': *(va_arg(*args, long*)) = i; break;
9367 case 'V': *(va_arg(*args, IV*)) = i; break;
9369 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9374 sv_setuv_mg(argsv, (UV)i);
9375 continue; /* not "break" */
9382 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9383 && ckWARN(WARN_PRINTF))
9385 SV * const msg = sv_newmortal();
9386 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9387 (PL_op->op_type == OP_PRTF) ? "" : "s");
9390 Perl_sv_catpvf(aTHX_ msg,
9391 "\"%%%c\"", c & 0xFF);
9393 Perl_sv_catpvf(aTHX_ msg,
9394 "\"%%\\%03"UVof"\"",
9397 sv_catpvs(msg, "end of string");
9398 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9401 /* output mangled stuff ... */
9407 /* ... right here, because formatting flags should not apply */
9408 SvGROW(sv, SvCUR(sv) + elen + 1);
9410 Copy(eptr, p, elen, char);
9413 SvCUR_set(sv, p - SvPVX_const(sv));
9415 continue; /* not "break" */
9418 if (is_utf8 != has_utf8) {
9421 sv_utf8_upgrade(sv);
9424 const STRLEN old_elen = elen;
9425 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9426 sv_utf8_upgrade(nsv);
9427 eptr = SvPVX_const(nsv);
9430 if (width) { /* fudge width (can't fudge elen) */
9431 width += elen - old_elen;
9437 have = esignlen + zeros + elen;
9439 Perl_croak_nocontext(PL_memory_wrap);
9441 need = (have > width ? have : width);
9444 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9445 Perl_croak_nocontext(PL_memory_wrap);
9446 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9448 if (esignlen && fill == '0') {
9450 for (i = 0; i < (int)esignlen; i++)
9454 memset(p, fill, gap);
9457 if (esignlen && fill != '0') {
9459 for (i = 0; i < (int)esignlen; i++)
9464 for (i = zeros; i; i--)
9468 Copy(eptr, p, elen, char);
9472 memset(p, ' ', gap);
9477 Copy(dotstr, p, dotstrlen, char);
9481 vectorize = FALSE; /* done iterating over vecstr */
9488 SvCUR_set(sv, p - SvPVX_const(sv));
9496 /* =========================================================================
9498 =head1 Cloning an interpreter
9500 All the macros and functions in this section are for the private use of
9501 the main function, perl_clone().
9503 The foo_dup() functions make an exact copy of an existing foo thinngy.
9504 During the course of a cloning, a hash table is used to map old addresses
9505 to new addresses. The table is created and manipulated with the
9506 ptr_table_* functions.
9510 ============================================================================*/
9513 #if defined(USE_ITHREADS)
9515 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9516 #ifndef GpREFCNT_inc
9517 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9521 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9522 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9523 If this changes, please unmerge ss_dup. */
9524 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9525 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9526 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9527 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9528 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9529 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9530 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9531 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9532 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9533 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9534 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9535 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9536 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9537 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9539 /* clone a parser */
9542 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9549 /* look for it in the table first */
9550 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9554 /* create anew and remember what it is */
9555 Newxz(parser, 1, yy_parser);
9556 ptr_table_store(PL_ptr_table, proto, parser);
9558 parser->yyerrstatus = 0;
9559 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9561 /* XXX these not yet duped */
9562 parser->old_parser = NULL;
9563 parser->stack = NULL;
9565 parser->stack_size = 0;
9566 /* XXX parser->stack->state = 0; */
9568 /* XXX eventually, just Copy() most of the parser struct ? */
9570 parser->lex_brackets = proto->lex_brackets;
9571 parser->lex_casemods = proto->lex_casemods;
9572 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9573 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9574 parser->lex_casestack = savepvn(proto->lex_casestack,
9575 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9576 parser->lex_defer = proto->lex_defer;
9577 parser->lex_dojoin = proto->lex_dojoin;
9578 parser->lex_expect = proto->lex_expect;
9579 parser->lex_formbrack = proto->lex_formbrack;
9580 parser->lex_inpat = proto->lex_inpat;
9581 parser->lex_inwhat = proto->lex_inwhat;
9582 parser->lex_op = proto->lex_op;
9583 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9584 parser->lex_starts = proto->lex_starts;
9585 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9586 parser->multi_close = proto->multi_close;
9587 parser->multi_open = proto->multi_open;
9588 parser->multi_start = proto->multi_start;
9589 parser->multi_end = proto->multi_end;
9590 parser->pending_ident = proto->pending_ident;
9591 parser->preambled = proto->preambled;
9592 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9593 parser->linestr = sv_dup_inc(proto->linestr, param);
9594 parser->expect = proto->expect;
9595 parser->copline = proto->copline;
9596 parser->last_lop_op = proto->last_lop_op;
9597 parser->lex_state = proto->lex_state;
9598 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9599 /* rsfp_filters entries have fake IoDIRP() */
9600 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9601 parser->in_my = proto->in_my;
9602 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9603 parser->error_count = proto->error_count;
9606 parser->linestr = sv_dup_inc(proto->linestr, param);
9609 char * const ols = SvPVX(proto->linestr);
9610 char * const ls = SvPVX(parser->linestr);
9612 parser->bufptr = ls + (proto->bufptr >= ols ?
9613 proto->bufptr - ols : 0);
9614 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9615 proto->oldbufptr - ols : 0);
9616 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9617 proto->oldoldbufptr - ols : 0);
9618 parser->linestart = ls + (proto->linestart >= ols ?
9619 proto->linestart - ols : 0);
9620 parser->last_uni = ls + (proto->last_uni >= ols ?
9621 proto->last_uni - ols : 0);
9622 parser->last_lop = ls + (proto->last_lop >= ols ?
9623 proto->last_lop - ols : 0);
9625 parser->bufend = ls + SvCUR(parser->linestr);
9628 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9632 parser->endwhite = proto->endwhite;
9633 parser->faketokens = proto->faketokens;
9634 parser->lasttoke = proto->lasttoke;
9635 parser->nextwhite = proto->nextwhite;
9636 parser->realtokenstart = proto->realtokenstart;
9637 parser->skipwhite = proto->skipwhite;
9638 parser->thisclose = proto->thisclose;
9639 parser->thismad = proto->thismad;
9640 parser->thisopen = proto->thisopen;
9641 parser->thisstuff = proto->thisstuff;
9642 parser->thistoken = proto->thistoken;
9643 parser->thiswhite = proto->thiswhite;
9645 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9646 parser->curforce = proto->curforce;
9648 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9649 Copy(proto->nexttype, parser->nexttype, 5, I32);
9650 parser->nexttoke = proto->nexttoke;
9656 /* duplicate a file handle */
9659 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9663 PERL_UNUSED_ARG(type);
9666 return (PerlIO*)NULL;
9668 /* look for it in the table first */
9669 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9673 /* create anew and remember what it is */
9674 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9675 ptr_table_store(PL_ptr_table, fp, ret);
9679 /* duplicate a directory handle */
9682 Perl_dirp_dup(pTHX_ DIR *dp)
9684 PERL_UNUSED_CONTEXT;
9691 /* duplicate a typeglob */
9694 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9700 /* look for it in the table first */
9701 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9705 /* create anew and remember what it is */
9707 ptr_table_store(PL_ptr_table, gp, ret);
9710 ret->gp_refcnt = 0; /* must be before any other dups! */
9711 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9712 ret->gp_io = io_dup_inc(gp->gp_io, param);
9713 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9714 ret->gp_av = av_dup_inc(gp->gp_av, param);
9715 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9716 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9717 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9718 ret->gp_cvgen = gp->gp_cvgen;
9719 ret->gp_line = gp->gp_line;
9720 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9724 /* duplicate a chain of magic */
9727 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9729 MAGIC *mgprev = (MAGIC*)NULL;
9732 return (MAGIC*)NULL;
9733 /* look for it in the table first */
9734 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9738 for (; mg; mg = mg->mg_moremagic) {
9740 Newxz(nmg, 1, MAGIC);
9742 mgprev->mg_moremagic = nmg;
9745 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9746 nmg->mg_private = mg->mg_private;
9747 nmg->mg_type = mg->mg_type;
9748 nmg->mg_flags = mg->mg_flags;
9749 if (mg->mg_type == PERL_MAGIC_qr) {
9750 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9752 else if(mg->mg_type == PERL_MAGIC_backref) {
9753 /* The backref AV has its reference count deliberately bumped by
9755 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9758 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9759 ? sv_dup_inc(mg->mg_obj, param)
9760 : sv_dup(mg->mg_obj, param);
9762 nmg->mg_len = mg->mg_len;
9763 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9764 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9765 if (mg->mg_len > 0) {
9766 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9767 if (mg->mg_type == PERL_MAGIC_overload_table &&
9768 AMT_AMAGIC((AMT*)mg->mg_ptr))
9770 const AMT * const amtp = (AMT*)mg->mg_ptr;
9771 AMT * const namtp = (AMT*)nmg->mg_ptr;
9773 for (i = 1; i < NofAMmeth; i++) {
9774 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9778 else if (mg->mg_len == HEf_SVKEY)
9779 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9781 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9782 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9789 #endif /* USE_ITHREADS */
9791 /* create a new pointer-mapping table */
9794 Perl_ptr_table_new(pTHX)
9797 PERL_UNUSED_CONTEXT;
9799 Newxz(tbl, 1, PTR_TBL_t);
9802 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9806 #define PTR_TABLE_HASH(ptr) \
9807 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9810 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9811 following define) and at call to new_body_inline made below in
9812 Perl_ptr_table_store()
9815 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9817 /* map an existing pointer using a table */
9819 STATIC PTR_TBL_ENT_t *
9820 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9821 PTR_TBL_ENT_t *tblent;
9822 const UV hash = PTR_TABLE_HASH(sv);
9824 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9825 for (; tblent; tblent = tblent->next) {
9826 if (tblent->oldval == sv)
9833 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9835 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9836 PERL_UNUSED_CONTEXT;
9837 return tblent ? tblent->newval : NULL;
9840 /* add a new entry to a pointer-mapping table */
9843 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9845 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9846 PERL_UNUSED_CONTEXT;
9849 tblent->newval = newsv;
9851 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9853 new_body_inline(tblent, PTE_SVSLOT);
9855 tblent->oldval = oldsv;
9856 tblent->newval = newsv;
9857 tblent->next = tbl->tbl_ary[entry];
9858 tbl->tbl_ary[entry] = tblent;
9860 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9861 ptr_table_split(tbl);
9865 /* double the hash bucket size of an existing ptr table */
9868 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9870 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9871 const UV oldsize = tbl->tbl_max + 1;
9872 UV newsize = oldsize * 2;
9874 PERL_UNUSED_CONTEXT;
9876 Renew(ary, newsize, PTR_TBL_ENT_t*);
9877 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9878 tbl->tbl_max = --newsize;
9880 for (i=0; i < oldsize; i++, ary++) {
9881 PTR_TBL_ENT_t **curentp, **entp, *ent;
9884 curentp = ary + oldsize;
9885 for (entp = ary, ent = *ary; ent; ent = *entp) {
9886 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9888 ent->next = *curentp;
9898 /* remove all the entries from a ptr table */
9901 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9903 if (tbl && tbl->tbl_items) {
9904 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9905 UV riter = tbl->tbl_max;
9908 PTR_TBL_ENT_t *entry = array[riter];
9911 PTR_TBL_ENT_t * const oentry = entry;
9912 entry = entry->next;
9921 /* clear and free a ptr table */
9924 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9929 ptr_table_clear(tbl);
9930 Safefree(tbl->tbl_ary);
9934 #if defined(USE_ITHREADS)
9937 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9940 SvRV_set(dstr, SvWEAKREF(sstr)
9941 ? sv_dup(SvRV(sstr), param)
9942 : sv_dup_inc(SvRV(sstr), param));
9945 else if (SvPVX_const(sstr)) {
9946 /* Has something there */
9948 /* Normal PV - clone whole allocated space */
9949 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9950 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9951 /* Not that normal - actually sstr is copy on write.
9952 But we are a true, independant SV, so: */
9953 SvREADONLY_off(dstr);
9958 /* Special case - not normally malloced for some reason */
9959 if (isGV_with_GP(sstr)) {
9960 /* Don't need to do anything here. */
9962 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9963 /* A "shared" PV - clone it as "shared" PV */
9965 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9969 /* Some other special case - random pointer */
9970 SvPV_set(dstr, SvPVX(sstr));
9976 if (SvTYPE(dstr) == SVt_RV)
9977 SvRV_set(dstr, NULL);
9979 SvPV_set(dstr, NULL);
9983 /* duplicate an SV of any type (including AV, HV etc) */
9986 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9991 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9993 /* look for it in the table first */
9994 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9998 if(param->flags & CLONEf_JOIN_IN) {
9999 /** We are joining here so we don't want do clone
10000 something that is bad **/
10001 if (SvTYPE(sstr) == SVt_PVHV) {
10002 const char * const hvname = HvNAME_get(sstr);
10004 /** don't clone stashes if they already exist **/
10005 return (SV*)gv_stashpv(hvname,0);
10009 /* create anew and remember what it is */
10012 #ifdef DEBUG_LEAKING_SCALARS
10013 dstr->sv_debug_optype = sstr->sv_debug_optype;
10014 dstr->sv_debug_line = sstr->sv_debug_line;
10015 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10016 dstr->sv_debug_cloned = 1;
10017 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10020 ptr_table_store(PL_ptr_table, sstr, dstr);
10023 SvFLAGS(dstr) = SvFLAGS(sstr);
10024 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10025 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10028 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10029 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10030 (void*)PL_watch_pvx, SvPVX_const(sstr));
10033 /* don't clone objects whose class has asked us not to */
10034 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10035 SvFLAGS(dstr) &= ~SVTYPEMASK;
10036 SvOBJECT_off(dstr);
10040 switch (SvTYPE(sstr)) {
10042 SvANY(dstr) = NULL;
10045 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10046 SvIV_set(dstr, SvIVX(sstr));
10049 SvANY(dstr) = new_XNV();
10050 SvNV_set(dstr, SvNVX(sstr));
10053 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10054 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10056 /* case SVt_BIND: */
10059 /* These are all the types that need complex bodies allocating. */
10061 const svtype sv_type = SvTYPE(sstr);
10062 const struct body_details *const sv_type_details
10063 = bodies_by_type + sv_type;
10067 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10071 if (GvUNIQUE((GV*)sstr)) {
10072 NOOP; /* Do sharing here, and fall through */
10084 assert(sv_type_details->body_size);
10085 if (sv_type_details->arena) {
10086 new_body_inline(new_body, sv_type);
10088 = (void*)((char*)new_body - sv_type_details->offset);
10090 new_body = new_NOARENA(sv_type_details);
10094 SvANY(dstr) = new_body;
10097 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10098 ((char*)SvANY(dstr)) + sv_type_details->offset,
10099 sv_type_details->copy, char);
10101 Copy(((char*)SvANY(sstr)),
10102 ((char*)SvANY(dstr)),
10103 sv_type_details->body_size + sv_type_details->offset, char);
10106 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10107 && !isGV_with_GP(dstr))
10108 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10110 /* The Copy above means that all the source (unduplicated) pointers
10111 are now in the destination. We can check the flags and the
10112 pointers in either, but it's possible that there's less cache
10113 missing by always going for the destination.
10114 FIXME - instrument and check that assumption */
10115 if (sv_type >= SVt_PVMG) {
10116 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10117 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10118 } else if (SvMAGIC(dstr))
10119 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10121 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10124 /* The cast silences a GCC warning about unhandled types. */
10125 switch ((int)sv_type) {
10135 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10136 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10137 LvTARG(dstr) = dstr;
10138 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10139 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10141 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10143 if(isGV_with_GP(sstr)) {
10144 if (GvNAME_HEK(dstr))
10145 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10146 /* Don't call sv_add_backref here as it's going to be
10147 created as part of the magic cloning of the symbol
10149 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10150 at the point of this comment. */
10151 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10152 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10153 (void)GpREFCNT_inc(GvGP(dstr));
10155 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10158 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10159 if (IoOFP(dstr) == IoIFP(sstr))
10160 IoOFP(dstr) = IoIFP(dstr);
10162 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10163 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10164 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10165 /* I have no idea why fake dirp (rsfps)
10166 should be treated differently but otherwise
10167 we end up with leaks -- sky*/
10168 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10169 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10170 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10172 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10173 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10174 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10175 if (IoDIRP(dstr)) {
10176 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10179 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10182 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10183 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10184 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10187 if (AvARRAY((AV*)sstr)) {
10188 SV **dst_ary, **src_ary;
10189 SSize_t items = AvFILLp((AV*)sstr) + 1;
10191 src_ary = AvARRAY((AV*)sstr);
10192 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10193 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10194 AvARRAY((AV*)dstr) = dst_ary;
10195 AvALLOC((AV*)dstr) = dst_ary;
10196 if (AvREAL((AV*)sstr)) {
10197 while (items-- > 0)
10198 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10201 while (items-- > 0)
10202 *dst_ary++ = sv_dup(*src_ary++, param);
10204 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10205 while (items-- > 0) {
10206 *dst_ary++ = &PL_sv_undef;
10210 AvARRAY((AV*)dstr) = NULL;
10211 AvALLOC((AV*)dstr) = (SV**)NULL;
10215 if (HvARRAY((HV*)sstr)) {
10217 const bool sharekeys = !!HvSHAREKEYS(sstr);
10218 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10219 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10221 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10222 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10224 HvARRAY(dstr) = (HE**)darray;
10225 while (i <= sxhv->xhv_max) {
10226 const HE * const source = HvARRAY(sstr)[i];
10227 HvARRAY(dstr)[i] = source
10228 ? he_dup(source, sharekeys, param) : 0;
10233 const struct xpvhv_aux * const saux = HvAUX(sstr);
10234 struct xpvhv_aux * const daux = HvAUX(dstr);
10235 /* This flag isn't copied. */
10236 /* SvOOK_on(hv) attacks the IV flags. */
10237 SvFLAGS(dstr) |= SVf_OOK;
10239 hvname = saux->xhv_name;
10240 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10242 daux->xhv_riter = saux->xhv_riter;
10243 daux->xhv_eiter = saux->xhv_eiter
10244 ? he_dup(saux->xhv_eiter,
10245 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10246 daux->xhv_backreferences =
10247 saux->xhv_backreferences
10248 ? (AV*) SvREFCNT_inc(
10249 sv_dup((SV*)saux->xhv_backreferences, param))
10252 daux->xhv_mro_meta = saux->xhv_mro_meta
10253 ? mro_meta_dup(saux->xhv_mro_meta, param)
10256 /* Record stashes for possible cloning in Perl_clone(). */
10258 av_push(param->stashes, dstr);
10262 HvARRAY((HV*)dstr) = NULL;
10265 if (!(param->flags & CLONEf_COPY_STACKS)) {
10269 /* NOTE: not refcounted */
10270 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10272 if (!CvISXSUB(dstr))
10273 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10275 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10276 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10277 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10278 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10280 /* don't dup if copying back - CvGV isn't refcounted, so the
10281 * duped GV may never be freed. A bit of a hack! DAPM */
10282 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10283 NULL : gv_dup(CvGV(dstr), param) ;
10284 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10286 CvWEAKOUTSIDE(sstr)
10287 ? cv_dup( CvOUTSIDE(dstr), param)
10288 : cv_dup_inc(CvOUTSIDE(dstr), param);
10289 if (!CvISXSUB(dstr))
10290 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10296 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10302 /* duplicate a context */
10305 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10307 PERL_CONTEXT *ncxs;
10310 return (PERL_CONTEXT*)NULL;
10312 /* look for it in the table first */
10313 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10317 /* create anew and remember what it is */
10318 Newxz(ncxs, max + 1, PERL_CONTEXT);
10319 ptr_table_store(PL_ptr_table, cxs, ncxs);
10322 PERL_CONTEXT * const cx = &cxs[ix];
10323 PERL_CONTEXT * const ncx = &ncxs[ix];
10324 ncx->cx_type = cx->cx_type;
10325 if (CxTYPE(cx) == CXt_SUBST) {
10326 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10329 ncx->blk_oldsp = cx->blk_oldsp;
10330 ncx->blk_oldcop = cx->blk_oldcop;
10331 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10332 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10333 ncx->blk_oldpm = cx->blk_oldpm;
10334 ncx->blk_gimme = cx->blk_gimme;
10335 switch (CxTYPE(cx)) {
10337 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10338 ? cv_dup_inc(cx->blk_sub.cv, param)
10339 : cv_dup(cx->blk_sub.cv,param));
10340 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10341 ? av_dup_inc(cx->blk_sub.argarray, param)
10343 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10344 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10345 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10346 ncx->blk_sub.lval = cx->blk_sub.lval;
10347 ncx->blk_sub.retop = cx->blk_sub.retop;
10348 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10349 cx->blk_sub.oldcomppad);
10352 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10353 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10354 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10355 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10356 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10357 ncx->blk_eval.retop = cx->blk_eval.retop;
10360 ncx->blk_loop.label = cx->blk_loop.label;
10361 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10362 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10363 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10364 ? cx->blk_loop.iterdata
10365 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10366 ncx->blk_loop.oldcomppad
10367 = (PAD*)ptr_table_fetch(PL_ptr_table,
10368 cx->blk_loop.oldcomppad);
10369 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10370 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10371 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10372 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10373 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10376 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10377 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10378 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10379 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10380 ncx->blk_sub.retop = cx->blk_sub.retop;
10392 /* duplicate a stack info structure */
10395 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10400 return (PERL_SI*)NULL;
10402 /* look for it in the table first */
10403 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10407 /* create anew and remember what it is */
10408 Newxz(nsi, 1, PERL_SI);
10409 ptr_table_store(PL_ptr_table, si, nsi);
10411 nsi->si_stack = av_dup_inc(si->si_stack, param);
10412 nsi->si_cxix = si->si_cxix;
10413 nsi->si_cxmax = si->si_cxmax;
10414 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10415 nsi->si_type = si->si_type;
10416 nsi->si_prev = si_dup(si->si_prev, param);
10417 nsi->si_next = si_dup(si->si_next, param);
10418 nsi->si_markoff = si->si_markoff;
10423 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10424 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10425 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10426 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10427 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10428 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10429 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10430 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10431 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10432 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10433 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10434 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10435 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10436 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10439 #define pv_dup_inc(p) SAVEPV(p)
10440 #define pv_dup(p) SAVEPV(p)
10441 #define svp_dup_inc(p,pp) any_dup(p,pp)
10443 /* map any object to the new equivent - either something in the
10444 * ptr table, or something in the interpreter structure
10448 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10453 return (void*)NULL;
10455 /* look for it in the table first */
10456 ret = ptr_table_fetch(PL_ptr_table, v);
10460 /* see if it is part of the interpreter structure */
10461 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10462 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10470 /* duplicate the save stack */
10473 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10476 ANY * const ss = proto_perl->Isavestack;
10477 const I32 max = proto_perl->Isavestack_max;
10478 I32 ix = proto_perl->Isavestack_ix;
10491 void (*dptr) (void*);
10492 void (*dxptr) (pTHX_ void*);
10494 Newxz(nss, max, ANY);
10497 const I32 type = POPINT(ss,ix);
10498 TOPINT(nss,ix) = type;
10500 case SAVEt_HELEM: /* hash element */
10501 sv = (SV*)POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10504 case SAVEt_ITEM: /* normal string */
10505 case SAVEt_SV: /* scalar reference */
10506 sv = (SV*)POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10510 case SAVEt_MORTALIZESV:
10511 sv = (SV*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10514 case SAVEt_SHARED_PVREF: /* char* in shared space */
10515 c = (char*)POPPTR(ss,ix);
10516 TOPPTR(nss,ix) = savesharedpv(c);
10517 ptr = POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10520 case SAVEt_GENERIC_SVREF: /* generic sv */
10521 case SAVEt_SVREF: /* scalar reference */
10522 sv = (SV*)POPPTR(ss,ix);
10523 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10524 ptr = POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10527 case SAVEt_HV: /* hash reference */
10528 case SAVEt_AV: /* array reference */
10529 sv = (SV*) POPPTR(ss,ix);
10530 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10532 case SAVEt_COMPPAD:
10534 sv = (SV*) POPPTR(ss,ix);
10535 TOPPTR(nss,ix) = sv_dup(sv, param);
10537 case SAVEt_INT: /* int reference */
10538 ptr = POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10540 intval = (int)POPINT(ss,ix);
10541 TOPINT(nss,ix) = intval;
10543 case SAVEt_LONG: /* long reference */
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10547 case SAVEt_CLEARSV:
10548 longval = (long)POPLONG(ss,ix);
10549 TOPLONG(nss,ix) = longval;
10551 case SAVEt_I32: /* I32 reference */
10552 case SAVEt_I16: /* I16 reference */
10553 case SAVEt_I8: /* I8 reference */
10554 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10555 ptr = POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10558 TOPINT(nss,ix) = i;
10560 case SAVEt_IV: /* IV reference */
10561 ptr = POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10564 TOPIV(nss,ix) = iv;
10566 case SAVEt_HPTR: /* HV* reference */
10567 case SAVEt_APTR: /* AV* reference */
10568 case SAVEt_SPTR: /* SV* reference */
10569 ptr = POPPTR(ss,ix);
10570 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10571 sv = (SV*)POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = sv_dup(sv, param);
10574 case SAVEt_VPTR: /* random* reference */
10575 ptr = POPPTR(ss,ix);
10576 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10577 ptr = POPPTR(ss,ix);
10578 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10580 case SAVEt_GENERIC_PVREF: /* generic char* */
10581 case SAVEt_PPTR: /* char* reference */
10582 ptr = POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10584 c = (char*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = pv_dup(c);
10587 case SAVEt_GP: /* scalar reference */
10588 gp = (GP*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10590 (void)GpREFCNT_inc(gp);
10591 gv = (GV*)POPPTR(ss,ix);
10592 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10595 ptr = POPPTR(ss,ix);
10596 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10597 /* these are assumed to be refcounted properly */
10599 switch (((OP*)ptr)->op_type) {
10601 case OP_LEAVESUBLV:
10605 case OP_LEAVEWRITE:
10606 TOPPTR(nss,ix) = ptr;
10609 (void) OpREFCNT_inc(o);
10613 TOPPTR(nss,ix) = NULL;
10618 TOPPTR(nss,ix) = NULL;
10621 c = (char*)POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = pv_dup_inc(c);
10625 hv = (HV*)POPPTR(ss,ix);
10626 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10627 c = (char*)POPPTR(ss,ix);
10628 TOPPTR(nss,ix) = pv_dup_inc(c);
10630 case SAVEt_STACK_POS: /* Position on Perl stack */
10632 TOPINT(nss,ix) = i;
10634 case SAVEt_DESTRUCTOR:
10635 ptr = POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10637 dptr = POPDPTR(ss,ix);
10638 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10639 any_dup(FPTR2DPTR(void *, dptr),
10642 case SAVEt_DESTRUCTOR_X:
10643 ptr = POPPTR(ss,ix);
10644 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10645 dxptr = POPDXPTR(ss,ix);
10646 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10647 any_dup(FPTR2DPTR(void *, dxptr),
10650 case SAVEt_REGCONTEXT:
10653 TOPINT(nss,ix) = i;
10656 case SAVEt_AELEM: /* array element */
10657 sv = (SV*)POPPTR(ss,ix);
10658 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10660 TOPINT(nss,ix) = i;
10661 av = (AV*)POPPTR(ss,ix);
10662 TOPPTR(nss,ix) = av_dup_inc(av, param);
10665 ptr = POPPTR(ss,ix);
10666 TOPPTR(nss,ix) = ptr;
10670 TOPINT(nss,ix) = i;
10671 ptr = POPPTR(ss,ix);
10674 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10675 HINTS_REFCNT_UNLOCK;
10677 TOPPTR(nss,ix) = ptr;
10678 if (i & HINT_LOCALIZE_HH) {
10679 hv = (HV*)POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10684 longval = (long)POPLONG(ss,ix);
10685 TOPLONG(nss,ix) = longval;
10686 ptr = POPPTR(ss,ix);
10687 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10688 sv = (SV*)POPPTR(ss,ix);
10689 TOPPTR(nss,ix) = sv_dup(sv, param);
10692 ptr = POPPTR(ss,ix);
10693 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10694 longval = (long)POPBOOL(ss,ix);
10695 TOPBOOL(nss,ix) = (bool)longval;
10697 case SAVEt_SET_SVFLAGS:
10699 TOPINT(nss,ix) = i;
10701 TOPINT(nss,ix) = i;
10702 sv = (SV*)POPPTR(ss,ix);
10703 TOPPTR(nss,ix) = sv_dup(sv, param);
10705 case SAVEt_RE_STATE:
10707 const struct re_save_state *const old_state
10708 = (struct re_save_state *)
10709 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10710 struct re_save_state *const new_state
10711 = (struct re_save_state *)
10712 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10714 Copy(old_state, new_state, 1, struct re_save_state);
10715 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10717 new_state->re_state_bostr
10718 = pv_dup(old_state->re_state_bostr);
10719 new_state->re_state_reginput
10720 = pv_dup(old_state->re_state_reginput);
10721 new_state->re_state_regeol
10722 = pv_dup(old_state->re_state_regeol);
10723 new_state->re_state_regoffs
10724 = (regexp_paren_pair*)
10725 any_dup(old_state->re_state_regoffs, proto_perl);
10726 new_state->re_state_reglastparen
10727 = (U32*) any_dup(old_state->re_state_reglastparen,
10729 new_state->re_state_reglastcloseparen
10730 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10732 /* XXX This just has to be broken. The old save_re_context
10733 code did SAVEGENERICPV(PL_reg_start_tmp);
10734 PL_reg_start_tmp is char **.
10735 Look above to what the dup code does for
10736 SAVEt_GENERIC_PVREF
10737 It can never have worked.
10738 So this is merely a faithful copy of the exiting bug: */
10739 new_state->re_state_reg_start_tmp
10740 = (char **) pv_dup((char *)
10741 old_state->re_state_reg_start_tmp);
10742 /* I assume that it only ever "worked" because no-one called
10743 (pseudo)fork while the regexp engine had re-entered itself.
10745 #ifdef PERL_OLD_COPY_ON_WRITE
10746 new_state->re_state_nrs
10747 = sv_dup(old_state->re_state_nrs, param);
10749 new_state->re_state_reg_magic
10750 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10752 new_state->re_state_reg_oldcurpm
10753 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10755 new_state->re_state_reg_curpm
10756 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10758 new_state->re_state_reg_oldsaved
10759 = pv_dup(old_state->re_state_reg_oldsaved);
10760 new_state->re_state_reg_poscache
10761 = pv_dup(old_state->re_state_reg_poscache);
10762 new_state->re_state_reg_starttry
10763 = pv_dup(old_state->re_state_reg_starttry);
10766 case SAVEt_COMPILE_WARNINGS:
10767 ptr = POPPTR(ss,ix);
10768 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10771 ptr = POPPTR(ss,ix);
10772 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10776 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10784 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10785 * flag to the result. This is done for each stash before cloning starts,
10786 * so we know which stashes want their objects cloned */
10789 do_mark_cloneable_stash(pTHX_ SV *sv)
10791 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10793 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10794 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10795 if (cloner && GvCV(cloner)) {
10802 XPUSHs(sv_2mortal(newSVhek(hvname)));
10804 call_sv((SV*)GvCV(cloner), G_SCALAR);
10811 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10819 =for apidoc perl_clone
10821 Create and return a new interpreter by cloning the current one.
10823 perl_clone takes these flags as parameters:
10825 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10826 without it we only clone the data and zero the stacks,
10827 with it we copy the stacks and the new perl interpreter is
10828 ready to run at the exact same point as the previous one.
10829 The pseudo-fork code uses COPY_STACKS while the
10830 threads->create doesn't.
10832 CLONEf_KEEP_PTR_TABLE
10833 perl_clone keeps a ptr_table with the pointer of the old
10834 variable as a key and the new variable as a value,
10835 this allows it to check if something has been cloned and not
10836 clone it again but rather just use the value and increase the
10837 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10838 the ptr_table using the function
10839 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10840 reason to keep it around is if you want to dup some of your own
10841 variable who are outside the graph perl scans, example of this
10842 code is in threads.xs create
10845 This is a win32 thing, it is ignored on unix, it tells perls
10846 win32host code (which is c++) to clone itself, this is needed on
10847 win32 if you want to run two threads at the same time,
10848 if you just want to do some stuff in a separate perl interpreter
10849 and then throw it away and return to the original one,
10850 you don't need to do anything.
10855 /* XXX the above needs expanding by someone who actually understands it ! */
10856 EXTERN_C PerlInterpreter *
10857 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10860 perl_clone(PerlInterpreter *proto_perl, UV flags)
10863 #ifdef PERL_IMPLICIT_SYS
10865 /* perlhost.h so we need to call into it
10866 to clone the host, CPerlHost should have a c interface, sky */
10868 if (flags & CLONEf_CLONE_HOST) {
10869 return perl_clone_host(proto_perl,flags);
10871 return perl_clone_using(proto_perl, flags,
10873 proto_perl->IMemShared,
10874 proto_perl->IMemParse,
10876 proto_perl->IStdIO,
10880 proto_perl->IProc);
10884 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10885 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10886 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10887 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10888 struct IPerlDir* ipD, struct IPerlSock* ipS,
10889 struct IPerlProc* ipP)
10891 /* XXX many of the string copies here can be optimized if they're
10892 * constants; they need to be allocated as common memory and just
10893 * their pointers copied. */
10896 CLONE_PARAMS clone_params;
10897 CLONE_PARAMS* const param = &clone_params;
10899 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10900 /* for each stash, determine whether its objects should be cloned */
10901 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10902 PERL_SET_THX(my_perl);
10905 PoisonNew(my_perl, 1, PerlInterpreter);
10911 PL_savestack_ix = 0;
10912 PL_savestack_max = -1;
10913 PL_sig_pending = 0;
10915 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10916 # else /* !DEBUGGING */
10917 Zero(my_perl, 1, PerlInterpreter);
10918 # endif /* DEBUGGING */
10920 /* host pointers */
10922 PL_MemShared = ipMS;
10923 PL_MemParse = ipMP;
10930 #else /* !PERL_IMPLICIT_SYS */
10932 CLONE_PARAMS clone_params;
10933 CLONE_PARAMS* param = &clone_params;
10934 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10935 /* for each stash, determine whether its objects should be cloned */
10936 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10937 PERL_SET_THX(my_perl);
10940 PoisonNew(my_perl, 1, PerlInterpreter);
10946 PL_savestack_ix = 0;
10947 PL_savestack_max = -1;
10948 PL_sig_pending = 0;
10950 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10951 # else /* !DEBUGGING */
10952 Zero(my_perl, 1, PerlInterpreter);
10953 # endif /* DEBUGGING */
10954 #endif /* PERL_IMPLICIT_SYS */
10955 param->flags = flags;
10956 param->proto_perl = proto_perl;
10958 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10960 PL_body_arenas = NULL;
10961 Zero(&PL_body_roots, 1, PL_body_roots);
10963 PL_nice_chunk = NULL;
10964 PL_nice_chunk_size = 0;
10966 PL_sv_objcount = 0;
10968 PL_sv_arenaroot = NULL;
10970 PL_debug = proto_perl->Idebug;
10972 PL_hash_seed = proto_perl->Ihash_seed;
10973 PL_rehash_seed = proto_perl->Irehash_seed;
10975 #ifdef USE_REENTRANT_API
10976 /* XXX: things like -Dm will segfault here in perlio, but doing
10977 * PERL_SET_CONTEXT(proto_perl);
10978 * breaks too many other things
10980 Perl_reentrant_init(aTHX);
10983 /* create SV map for pointer relocation */
10984 PL_ptr_table = ptr_table_new();
10986 /* initialize these special pointers as early as possible */
10987 SvANY(&PL_sv_undef) = NULL;
10988 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10989 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10990 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10992 SvANY(&PL_sv_no) = new_XPVNV();
10993 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10994 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10995 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10996 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10997 SvCUR_set(&PL_sv_no, 0);
10998 SvLEN_set(&PL_sv_no, 1);
10999 SvIV_set(&PL_sv_no, 0);
11000 SvNV_set(&PL_sv_no, 0);
11001 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11003 SvANY(&PL_sv_yes) = new_XPVNV();
11004 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11005 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11006 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11007 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11008 SvCUR_set(&PL_sv_yes, 1);
11009 SvLEN_set(&PL_sv_yes, 2);
11010 SvIV_set(&PL_sv_yes, 1);
11011 SvNV_set(&PL_sv_yes, 1);
11012 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11014 /* create (a non-shared!) shared string table */
11015 PL_strtab = newHV();
11016 HvSHAREKEYS_off(PL_strtab);
11017 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11018 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11020 PL_compiling = proto_perl->Icompiling;
11022 /* These two PVs will be free'd special way so must set them same way op.c does */
11023 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11024 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11026 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11027 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11029 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11030 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11031 if (PL_compiling.cop_hints_hash) {
11033 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11034 HINTS_REFCNT_UNLOCK;
11036 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11037 #ifdef PERL_DEBUG_READONLY_OPS
11042 /* pseudo environmental stuff */
11043 PL_origargc = proto_perl->Iorigargc;
11044 PL_origargv = proto_perl->Iorigargv;
11046 param->stashes = newAV(); /* Setup array of objects to call clone on */
11048 /* Set tainting stuff before PerlIO_debug can possibly get called */
11049 PL_tainting = proto_perl->Itainting;
11050 PL_taint_warn = proto_perl->Itaint_warn;
11052 #ifdef PERLIO_LAYERS
11053 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11054 PerlIO_clone(aTHX_ proto_perl, param);
11057 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11058 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11059 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11060 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11061 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11062 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11065 PL_minus_c = proto_perl->Iminus_c;
11066 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11067 PL_localpatches = proto_perl->Ilocalpatches;
11068 PL_splitstr = proto_perl->Isplitstr;
11069 PL_preprocess = proto_perl->Ipreprocess;
11070 PL_minus_n = proto_perl->Iminus_n;
11071 PL_minus_p = proto_perl->Iminus_p;
11072 PL_minus_l = proto_perl->Iminus_l;
11073 PL_minus_a = proto_perl->Iminus_a;
11074 PL_minus_E = proto_perl->Iminus_E;
11075 PL_minus_F = proto_perl->Iminus_F;
11076 PL_doswitches = proto_perl->Idoswitches;
11077 PL_dowarn = proto_perl->Idowarn;
11078 PL_doextract = proto_perl->Idoextract;
11079 PL_sawampersand = proto_perl->Isawampersand;
11080 PL_unsafe = proto_perl->Iunsafe;
11081 PL_inplace = SAVEPV(proto_perl->Iinplace);
11082 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11083 PL_perldb = proto_perl->Iperldb;
11084 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11085 PL_exit_flags = proto_perl->Iexit_flags;
11087 /* magical thingies */
11088 /* XXX time(&PL_basetime) when asked for? */
11089 PL_basetime = proto_perl->Ibasetime;
11090 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11092 PL_maxsysfd = proto_perl->Imaxsysfd;
11093 PL_statusvalue = proto_perl->Istatusvalue;
11095 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11097 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11099 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11101 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11102 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11103 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11106 /* RE engine related */
11107 Zero(&PL_reg_state, 1, struct re_save_state);
11108 PL_reginterp_cnt = 0;
11109 PL_regmatch_slab = NULL;
11111 /* Clone the regex array */
11112 PL_regex_padav = newAV();
11114 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11115 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11117 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11118 for(i = 1; i <= len; i++) {
11119 const SV * const regex = regexen[i];
11122 ? sv_dup_inc(regex, param)
11124 newSViv(PTR2IV(CALLREGDUPE(
11125 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11127 if (SvFLAGS(regex) & SVf_BREAK)
11128 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11129 av_push(PL_regex_padav, sv);
11132 PL_regex_pad = AvARRAY(PL_regex_padav);
11134 /* shortcuts to various I/O objects */
11135 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11136 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11137 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11138 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11139 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11140 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11142 /* shortcuts to regexp stuff */
11143 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11145 /* shortcuts to misc objects */
11146 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11148 /* shortcuts to debugging objects */
11149 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11150 PL_DBline = gv_dup(proto_perl->IDBline, param);
11151 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11152 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11153 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11154 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11155 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11157 /* symbol tables */
11158 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11159 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11160 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11161 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11162 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11164 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11165 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11166 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11167 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11168 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11169 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11170 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11171 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11173 PL_sub_generation = proto_perl->Isub_generation;
11174 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11176 /* funky return mechanisms */
11177 PL_forkprocess = proto_perl->Iforkprocess;
11179 /* subprocess state */
11180 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11182 /* internal state */
11183 PL_maxo = proto_perl->Imaxo;
11184 if (proto_perl->Iop_mask)
11185 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11188 /* PL_asserting = proto_perl->Iasserting; */
11190 /* current interpreter roots */
11191 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11193 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11195 PL_main_start = proto_perl->Imain_start;
11196 PL_eval_root = proto_perl->Ieval_root;
11197 PL_eval_start = proto_perl->Ieval_start;
11199 /* runtime control stuff */
11200 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11202 PL_filemode = proto_perl->Ifilemode;
11203 PL_lastfd = proto_perl->Ilastfd;
11204 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11207 PL_gensym = proto_perl->Igensym;
11208 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11209 PL_laststatval = proto_perl->Ilaststatval;
11210 PL_laststype = proto_perl->Ilaststype;
11213 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11215 /* interpreter atexit processing */
11216 PL_exitlistlen = proto_perl->Iexitlistlen;
11217 if (PL_exitlistlen) {
11218 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11219 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11222 PL_exitlist = (PerlExitListEntry*)NULL;
11224 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11225 if (PL_my_cxt_size) {
11226 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11227 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11228 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11229 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11230 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11234 PL_my_cxt_list = (void**)NULL;
11235 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11236 PL_my_cxt_keys = (const char**)NULL;
11239 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11240 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11241 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11243 PL_profiledata = NULL;
11245 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11247 PAD_CLONE_VARS(proto_perl, param);
11249 #ifdef HAVE_INTERP_INTERN
11250 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11253 /* more statics moved here */
11254 PL_generation = proto_perl->Igeneration;
11255 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11257 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11258 PL_in_clean_all = proto_perl->Iin_clean_all;
11260 PL_uid = proto_perl->Iuid;
11261 PL_euid = proto_perl->Ieuid;
11262 PL_gid = proto_perl->Igid;
11263 PL_egid = proto_perl->Iegid;
11264 PL_nomemok = proto_perl->Inomemok;
11265 PL_an = proto_perl->Ian;
11266 PL_evalseq = proto_perl->Ievalseq;
11267 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11268 PL_origalen = proto_perl->Iorigalen;
11269 #ifdef PERL_USES_PL_PIDSTATUS
11270 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11272 PL_osname = SAVEPV(proto_perl->Iosname);
11273 PL_sighandlerp = proto_perl->Isighandlerp;
11275 PL_runops = proto_perl->Irunops;
11278 PL_cshlen = proto_perl->Icshlen;
11279 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11282 PL_parser = parser_dup(proto_perl->Iparser, param);
11284 PL_subline = proto_perl->Isubline;
11285 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11288 PL_cryptseen = proto_perl->Icryptseen;
11291 PL_hints = proto_perl->Ihints;
11293 PL_amagic_generation = proto_perl->Iamagic_generation;
11295 #ifdef USE_LOCALE_COLLATE
11296 PL_collation_ix = proto_perl->Icollation_ix;
11297 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11298 PL_collation_standard = proto_perl->Icollation_standard;
11299 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11300 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11301 #endif /* USE_LOCALE_COLLATE */
11303 #ifdef USE_LOCALE_NUMERIC
11304 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11305 PL_numeric_standard = proto_perl->Inumeric_standard;
11306 PL_numeric_local = proto_perl->Inumeric_local;
11307 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11308 #endif /* !USE_LOCALE_NUMERIC */
11310 /* utf8 character classes */
11311 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11312 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11313 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11314 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11315 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11316 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11317 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11318 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11319 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11320 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11321 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11322 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11323 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11324 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11325 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11326 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11327 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11328 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11329 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11330 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11332 /* Did the locale setup indicate UTF-8? */
11333 PL_utf8locale = proto_perl->Iutf8locale;
11334 /* Unicode features (see perlrun/-C) */
11335 PL_unicode = proto_perl->Iunicode;
11337 /* Pre-5.8 signals control */
11338 PL_signals = proto_perl->Isignals;
11340 /* times() ticks per second */
11341 PL_clocktick = proto_perl->Iclocktick;
11343 /* Recursion stopper for PerlIO_find_layer */
11344 PL_in_load_module = proto_perl->Iin_load_module;
11346 /* sort() routine */
11347 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11349 /* Not really needed/useful since the reenrant_retint is "volatile",
11350 * but do it for consistency's sake. */
11351 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11353 /* Hooks to shared SVs and locks. */
11354 PL_sharehook = proto_perl->Isharehook;
11355 PL_lockhook = proto_perl->Ilockhook;
11356 PL_unlockhook = proto_perl->Iunlockhook;
11357 PL_threadhook = proto_perl->Ithreadhook;
11359 #ifdef THREADS_HAVE_PIDS
11360 PL_ppid = proto_perl->Ippid;
11364 PL_last_swash_hv = NULL; /* reinits on demand */
11365 PL_last_swash_klen = 0;
11366 PL_last_swash_key[0]= '\0';
11367 PL_last_swash_tmps = (U8*)NULL;
11368 PL_last_swash_slen = 0;
11370 PL_glob_index = proto_perl->Iglob_index;
11371 PL_srand_called = proto_perl->Isrand_called;
11372 PL_bitcount = NULL; /* reinits on demand */
11374 if (proto_perl->Ipsig_pend) {
11375 Newxz(PL_psig_pend, SIG_SIZE, int);
11378 PL_psig_pend = (int*)NULL;
11381 if (proto_perl->Ipsig_ptr) {
11382 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11383 Newxz(PL_psig_name, SIG_SIZE, SV*);
11384 for (i = 1; i < SIG_SIZE; i++) {
11385 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11386 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11390 PL_psig_ptr = (SV**)NULL;
11391 PL_psig_name = (SV**)NULL;
11394 /* intrpvar.h stuff */
11396 if (flags & CLONEf_COPY_STACKS) {
11397 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11398 PL_tmps_ix = proto_perl->Itmps_ix;
11399 PL_tmps_max = proto_perl->Itmps_max;
11400 PL_tmps_floor = proto_perl->Itmps_floor;
11401 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11403 while (i <= PL_tmps_ix) {
11404 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11408 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11409 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11410 Newxz(PL_markstack, i, I32);
11411 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11412 - proto_perl->Imarkstack);
11413 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11414 - proto_perl->Imarkstack);
11415 Copy(proto_perl->Imarkstack, PL_markstack,
11416 PL_markstack_ptr - PL_markstack + 1, I32);
11418 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11419 * NOTE: unlike the others! */
11420 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11421 PL_scopestack_max = proto_perl->Iscopestack_max;
11422 Newxz(PL_scopestack, PL_scopestack_max, I32);
11423 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11425 /* NOTE: si_dup() looks at PL_markstack */
11426 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11428 /* PL_curstack = PL_curstackinfo->si_stack; */
11429 PL_curstack = av_dup(proto_perl->Icurstack, param);
11430 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11432 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11433 PL_stack_base = AvARRAY(PL_curstack);
11434 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11435 - proto_perl->Istack_base);
11436 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11438 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11439 * NOTE: unlike the others! */
11440 PL_savestack_ix = proto_perl->Isavestack_ix;
11441 PL_savestack_max = proto_perl->Isavestack_max;
11442 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11443 PL_savestack = ss_dup(proto_perl, param);
11447 ENTER; /* perl_destruct() wants to LEAVE; */
11449 /* although we're not duplicating the tmps stack, we should still
11450 * add entries for any SVs on the tmps stack that got cloned by a
11451 * non-refcount means (eg a temp in @_); otherwise they will be
11454 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11455 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11456 proto_perl->Itmps_stack[i]);
11457 if (nsv && !SvREFCNT(nsv)) {
11459 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11464 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11465 PL_top_env = &PL_start_env;
11467 PL_op = proto_perl->Iop;
11470 PL_Xpv = (XPV*)NULL;
11471 PL_na = proto_perl->Ina;
11473 PL_statbuf = proto_perl->Istatbuf;
11474 PL_statcache = proto_perl->Istatcache;
11475 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11476 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11478 PL_timesbuf = proto_perl->Itimesbuf;
11481 PL_tainted = proto_perl->Itainted;
11482 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11483 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11484 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11485 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11486 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11487 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11488 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11489 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11490 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11492 PL_restartop = proto_perl->Irestartop;
11493 PL_in_eval = proto_perl->Iin_eval;
11494 PL_delaymagic = proto_perl->Idelaymagic;
11495 PL_dirty = proto_perl->Idirty;
11496 PL_localizing = proto_perl->Ilocalizing;
11498 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11499 PL_hv_fetch_ent_mh = NULL;
11500 PL_modcount = proto_perl->Imodcount;
11501 PL_lastgotoprobe = NULL;
11502 PL_dumpindent = proto_perl->Idumpindent;
11504 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11505 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11506 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11507 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11508 PL_efloatbuf = NULL; /* reinits on demand */
11509 PL_efloatsize = 0; /* reinits on demand */
11513 PL_screamfirst = NULL;
11514 PL_screamnext = NULL;
11515 PL_maxscream = -1; /* reinits on demand */
11516 PL_lastscream = NULL;
11519 PL_regdummy = proto_perl->Iregdummy;
11520 PL_colorset = 0; /* reinits PL_colors[] */
11521 /*PL_colors[6] = {0,0,0,0,0,0};*/
11525 /* Pluggable optimizer */
11526 PL_peepp = proto_perl->Ipeepp;
11528 PL_stashcache = newHV();
11530 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11531 proto_perl->Iwatchaddr);
11532 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11533 if (PL_debug && PL_watchaddr) {
11534 PerlIO_printf(Perl_debug_log,
11535 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11536 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11537 PTR2UV(PL_watchok));
11540 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11541 ptr_table_free(PL_ptr_table);
11542 PL_ptr_table = NULL;
11545 /* Call the ->CLONE method, if it exists, for each of the stashes
11546 identified by sv_dup() above.
11548 while(av_len(param->stashes) != -1) {
11549 HV* const stash = (HV*) av_shift(param->stashes);
11550 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11551 if (cloner && GvCV(cloner)) {
11556 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11558 call_sv((SV*)GvCV(cloner), G_DISCARD);
11564 SvREFCNT_dec(param->stashes);
11566 /* orphaned? eg threads->new inside BEGIN or use */
11567 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11568 SvREFCNT_inc_simple_void(PL_compcv);
11569 SAVEFREESV(PL_compcv);
11575 #endif /* USE_ITHREADS */
11578 =head1 Unicode Support
11580 =for apidoc sv_recode_to_utf8
11582 The encoding is assumed to be an Encode object, on entry the PV
11583 of the sv is assumed to be octets in that encoding, and the sv
11584 will be converted into Unicode (and UTF-8).
11586 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11587 is not a reference, nothing is done to the sv. If the encoding is not
11588 an C<Encode::XS> Encoding object, bad things will happen.
11589 (See F<lib/encoding.pm> and L<Encode>).
11591 The PV of the sv is returned.
11596 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11599 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11613 Passing sv_yes is wrong - it needs to be or'ed set of constants
11614 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11615 remove converted chars from source.
11617 Both will default the value - let them.
11619 XPUSHs(&PL_sv_yes);
11622 call_method("decode", G_SCALAR);
11626 s = SvPV_const(uni, len);
11627 if (s != SvPVX_const(sv)) {
11628 SvGROW(sv, len + 1);
11629 Move(s, SvPVX(sv), len + 1, char);
11630 SvCUR_set(sv, len);
11637 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11641 =for apidoc sv_cat_decode
11643 The encoding is assumed to be an Encode object, the PV of the ssv is
11644 assumed to be octets in that encoding and decoding the input starts
11645 from the position which (PV + *offset) pointed to. The dsv will be
11646 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11647 when the string tstr appears in decoding output or the input ends on
11648 the PV of the ssv. The value which the offset points will be modified
11649 to the last input position on the ssv.
11651 Returns TRUE if the terminator was found, else returns FALSE.
11656 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11657 SV *ssv, int *offset, char *tstr, int tlen)
11661 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11672 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11673 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11675 call_method("cat_decode", G_SCALAR);
11677 ret = SvTRUE(TOPs);
11678 *offset = SvIV(offsv);
11684 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11689 /* ---------------------------------------------------------------------
11691 * support functions for report_uninit()
11694 /* the maxiumum size of array or hash where we will scan looking
11695 * for the undefined element that triggered the warning */
11697 #define FUV_MAX_SEARCH_SIZE 1000
11699 /* Look for an entry in the hash whose value has the same SV as val;
11700 * If so, return a mortal copy of the key. */
11703 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11706 register HE **array;
11709 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11710 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11713 array = HvARRAY(hv);
11715 for (i=HvMAX(hv); i>0; i--) {
11716 register HE *entry;
11717 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11718 if (HeVAL(entry) != val)
11720 if ( HeVAL(entry) == &PL_sv_undef ||
11721 HeVAL(entry) == &PL_sv_placeholder)
11725 if (HeKLEN(entry) == HEf_SVKEY)
11726 return sv_mortalcopy(HeKEY_sv(entry));
11727 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11733 /* Look for an entry in the array whose value has the same SV as val;
11734 * If so, return the index, otherwise return -1. */
11737 S_find_array_subscript(pTHX_ AV *av, SV* val)
11740 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11741 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11744 if (val != &PL_sv_undef) {
11745 SV ** const svp = AvARRAY(av);
11748 for (i=AvFILLp(av); i>=0; i--)
11755 /* S_varname(): return the name of a variable, optionally with a subscript.
11756 * If gv is non-zero, use the name of that global, along with gvtype (one
11757 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11758 * targ. Depending on the value of the subscript_type flag, return:
11761 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11762 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11763 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11764 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11767 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11768 SV* keyname, I32 aindex, int subscript_type)
11771 SV * const name = sv_newmortal();
11774 buffer[0] = gvtype;
11777 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11779 gv_fullname4(name, gv, buffer, 0);
11781 if ((unsigned int)SvPVX(name)[1] <= 26) {
11783 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11785 /* Swap the 1 unprintable control character for the 2 byte pretty
11786 version - ie substr($name, 1, 1) = $buffer; */
11787 sv_insert(name, 1, 1, buffer, 2);
11791 CV * const cv = find_runcv(NULL);
11795 if (!cv || !CvPADLIST(cv))
11797 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11798 sv = *av_fetch(av, targ, FALSE);
11799 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11802 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11803 SV * const sv = newSV(0);
11804 *SvPVX(name) = '$';
11805 Perl_sv_catpvf(aTHX_ name, "{%s}",
11806 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11809 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11810 *SvPVX(name) = '$';
11811 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11813 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11814 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11821 =for apidoc find_uninit_var
11823 Find the name of the undefined variable (if any) that caused the operator o
11824 to issue a "Use of uninitialized value" warning.
11825 If match is true, only return a name if it's value matches uninit_sv.
11826 So roughly speaking, if a unary operator (such as OP_COS) generates a
11827 warning, then following the direct child of the op may yield an
11828 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11829 other hand, with OP_ADD there are two branches to follow, so we only print
11830 the variable name if we get an exact match.
11832 The name is returned as a mortal SV.
11834 Assumes that PL_op is the op that originally triggered the error, and that
11835 PL_comppad/PL_curpad points to the currently executing pad.
11841 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11849 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11850 uninit_sv == &PL_sv_placeholder)))
11853 switch (obase->op_type) {
11860 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11861 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11864 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11866 if (pad) { /* @lex, %lex */
11867 sv = PAD_SVl(obase->op_targ);
11871 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11872 /* @global, %global */
11873 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11876 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11878 else /* @{expr}, %{expr} */
11879 return find_uninit_var(cUNOPx(obase)->op_first,
11883 /* attempt to find a match within the aggregate */
11885 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11887 subscript_type = FUV_SUBSCRIPT_HASH;
11890 index = find_array_subscript((AV*)sv, uninit_sv);
11892 subscript_type = FUV_SUBSCRIPT_ARRAY;
11895 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11898 return varname(gv, hash ? '%' : '@', obase->op_targ,
11899 keysv, index, subscript_type);
11903 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11905 return varname(NULL, '$', obase->op_targ,
11906 NULL, 0, FUV_SUBSCRIPT_NONE);
11909 gv = cGVOPx_gv(obase);
11910 if (!gv || (match && GvSV(gv) != uninit_sv))
11912 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11915 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11918 av = (AV*)PAD_SV(obase->op_targ);
11919 if (!av || SvRMAGICAL(av))
11921 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11922 if (!svp || *svp != uninit_sv)
11925 return varname(NULL, '$', obase->op_targ,
11926 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11929 gv = cGVOPx_gv(obase);
11935 if (!av || SvRMAGICAL(av))
11937 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11938 if (!svp || *svp != uninit_sv)
11941 return varname(gv, '$', 0,
11942 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11947 o = cUNOPx(obase)->op_first;
11948 if (!o || o->op_type != OP_NULL ||
11949 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11951 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11955 if (PL_op == obase)
11956 /* $a[uninit_expr] or $h{uninit_expr} */
11957 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11960 o = cBINOPx(obase)->op_first;
11961 kid = cBINOPx(obase)->op_last;
11963 /* get the av or hv, and optionally the gv */
11965 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11966 sv = PAD_SV(o->op_targ);
11968 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11969 && cUNOPo->op_first->op_type == OP_GV)
11971 gv = cGVOPx_gv(cUNOPo->op_first);
11974 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11979 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11980 /* index is constant */
11984 if (obase->op_type == OP_HELEM) {
11985 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11986 if (!he || HeVAL(he) != uninit_sv)
11990 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11991 if (!svp || *svp != uninit_sv)
11995 if (obase->op_type == OP_HELEM)
11996 return varname(gv, '%', o->op_targ,
11997 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11999 return varname(gv, '@', o->op_targ, NULL,
12000 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12003 /* index is an expression;
12004 * attempt to find a match within the aggregate */
12005 if (obase->op_type == OP_HELEM) {
12006 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12008 return varname(gv, '%', o->op_targ,
12009 keysv, 0, FUV_SUBSCRIPT_HASH);
12012 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12014 return varname(gv, '@', o->op_targ,
12015 NULL, index, FUV_SUBSCRIPT_ARRAY);
12020 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12022 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12027 /* only examine RHS */
12028 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12031 o = cUNOPx(obase)->op_first;
12032 if (o->op_type == OP_PUSHMARK)
12035 if (!o->op_sibling) {
12036 /* one-arg version of open is highly magical */
12038 if (o->op_type == OP_GV) { /* open FOO; */
12040 if (match && GvSV(gv) != uninit_sv)
12042 return varname(gv, '$', 0,
12043 NULL, 0, FUV_SUBSCRIPT_NONE);
12045 /* other possibilities not handled are:
12046 * open $x; or open my $x; should return '${*$x}'
12047 * open expr; should return '$'.expr ideally
12053 /* ops where $_ may be an implicit arg */
12057 if ( !(obase->op_flags & OPf_STACKED)) {
12058 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12059 ? PAD_SVl(obase->op_targ)
12062 sv = sv_newmortal();
12063 sv_setpvn(sv, "$_", 2);
12072 /* skip filehandle as it can't produce 'undef' warning */
12073 o = cUNOPx(obase)->op_first;
12074 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12075 o = o->op_sibling->op_sibling;
12082 match = 1; /* XS or custom code could trigger random warnings */
12086 /* def-ness of rval pos() is independent of the def-ness of its arg */
12087 if ( !(obase->op_flags & OPf_MOD))
12092 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12093 return sv_2mortal(newSVpvs("${$/}"));
12098 if (!(obase->op_flags & OPf_KIDS))
12100 o = cUNOPx(obase)->op_first;
12106 /* if all except one arg are constant, or have no side-effects,
12107 * or are optimized away, then it's unambiguous */
12109 for (kid=o; kid; kid = kid->op_sibling) {
12111 const OPCODE type = kid->op_type;
12112 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12113 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12114 || (type == OP_PUSHMARK)
12118 if (o2) { /* more than one found */
12125 return find_uninit_var(o2, uninit_sv, match);
12127 /* scan all args */
12129 sv = find_uninit_var(o, uninit_sv, 1);
12141 =for apidoc report_uninit
12143 Print appropriate "Use of uninitialized variable" warning
12149 Perl_report_uninit(pTHX_ SV* uninit_sv)
12153 SV* varname = NULL;
12155 varname = find_uninit_var(PL_op, uninit_sv,0);
12157 sv_insert(varname, 0, 0, " ", 1);
12159 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12160 varname ? SvPV_nolen_const(varname) : "",
12161 " in ", OP_DESC(PL_op));
12164 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12170 * c-indentation-style: bsd
12171 * c-basic-offset: 4
12172 * indent-tabs-mode: t
12175 * ex: set ts=8 sts=4 sw=4 noet: