3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types,
550 char *arena; /* the raw storage, allocated aligned */
551 size_t size; /* its size ~4k typ */
552 U32 misc; /* type, and in future other things. */
557 /* Get the maximum number of elements in set[] such that struct arena_set
558 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
559 therefore likely to be 1 aligned memory page. */
561 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
562 - 2 * sizeof(int)) / sizeof (struct arena_desc))
565 struct arena_set* next;
566 unsigned int set_size; /* ie ARENAS_PER_SET */
567 unsigned int curr; /* index of next available arena-desc */
568 struct arena_desc set[ARENAS_PER_SET];
572 =for apidoc sv_free_arenas
574 Deallocate the memory used by all arenas. Note that all the individual SV
575 heads and bodies within the arenas must already have been freed.
580 Perl_sv_free_arenas(pTHX)
587 /* Free arenas here, but be careful about fake ones. (We assume
588 contiguity of the fake ones with the corresponding real ones.) */
590 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
591 svanext = (SV*) SvANY(sva);
592 while (svanext && SvFAKE(svanext))
593 svanext = (SV*) SvANY(svanext);
600 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
603 struct arena_set *current = aroot;
606 assert(aroot->set[i].arena);
607 Safefree(aroot->set[i].arena);
615 i = PERL_ARENA_ROOTS_SIZE;
617 PL_body_roots[i] = 0;
619 Safefree(PL_nice_chunk);
620 PL_nice_chunk = NULL;
621 PL_nice_chunk_size = 0;
627 Here are mid-level routines that manage the allocation of bodies out
628 of the various arenas. There are 5 kinds of arenas:
630 1. SV-head arenas, which are discussed and handled above
631 2. regular body arenas
632 3. arenas for reduced-size bodies
634 5. pte arenas (thread related)
636 Arena types 2 & 3 are chained by body-type off an array of
637 arena-root pointers, which is indexed by svtype. Some of the
638 larger/less used body types are malloced singly, since a large
639 unused block of them is wasteful. Also, several svtypes dont have
640 bodies; the data fits into the sv-head itself. The arena-root
641 pointer thus has a few unused root-pointers (which may be hijacked
642 later for arena types 4,5)
644 3 differs from 2 as an optimization; some body types have several
645 unused fields in the front of the structure (which are kept in-place
646 for consistency). These bodies can be allocated in smaller chunks,
647 because the leading fields arent accessed. Pointers to such bodies
648 are decremented to point at the unused 'ghost' memory, knowing that
649 the pointers are used with offsets to the real memory.
651 HE, HEK arenas are managed separately, with separate code, but may
652 be merge-able later..
654 PTE arenas are not sv-bodies, but they share these mid-level
655 mechanics, so are considered here. The new mid-level mechanics rely
656 on the sv_type of the body being allocated, so we just reserve one
657 of the unused body-slots for PTEs, then use it in those (2) PTE
658 contexts below (line ~10k)
661 /* get_arena(size): this creates custom-sized arenas
662 TBD: export properly for hv.c: S_more_he().
665 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
668 struct arena_desc* adesc;
669 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
672 /* shouldnt need this
673 if (!arena_size) arena_size = PERL_ARENA_SIZE;
676 /* may need new arena-set to hold new arena */
677 if (!aroot || aroot->curr >= aroot->set_size) {
678 struct arena_set *newroot;
679 Newxz(newroot, 1, struct arena_set);
680 newroot->set_size = ARENAS_PER_SET;
681 newroot->next = aroot;
683 PL_body_arenas = (void *) newroot;
684 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
687 /* ok, now have arena-set with at least 1 empty/available arena-desc */
688 curr = aroot->curr++;
689 adesc = &(aroot->set[curr]);
690 assert(!adesc->arena);
692 Newx(adesc->arena, arena_size, char);
693 adesc->size = arena_size;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
696 curr, (void*)adesc->arena, (UV)arena_size));
702 /* return a thing to the free list */
704 #define del_body(thing, root) \
706 void ** const thing_copy = (void **)thing;\
707 *thing_copy = *root; \
708 *root = (void*)thing_copy; \
713 =head1 SV-Body Allocation
715 Allocation of SV-bodies is similar to SV-heads, differing as follows;
716 the allocation mechanism is used for many body types, so is somewhat
717 more complicated, it uses arena-sets, and has no need for still-live
720 At the outermost level, (new|del)_X*V macros return bodies of the
721 appropriate type. These macros call either (new|del)_body_type or
722 (new|del)_body_allocated macro pairs, depending on specifics of the
723 type. Most body types use the former pair, the latter pair is used to
724 allocate body types with "ghost fields".
726 "ghost fields" are fields that are unused in certain types, and
727 consequently dont need to actually exist. They are declared because
728 they're part of a "base type", which allows use of functions as
729 methods. The simplest examples are AVs and HVs, 2 aggregate types
730 which don't use the fields which support SCALAR semantics.
732 For these types, the arenas are carved up into *_allocated size
733 chunks, we thus avoid wasted memory for those unaccessed members.
734 When bodies are allocated, we adjust the pointer back in memory by the
735 size of the bit not allocated, so it's as if we allocated the full
736 structure. (But things will all go boom if you write to the part that
737 is "not there", because you'll be overwriting the last members of the
738 preceding structure in memory.)
740 We calculate the correction using the STRUCT_OFFSET macro. For
741 example, if xpv_allocated is the same structure as XPV then the two
742 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
743 structure is smaller (no initial NV actually allocated) then the net
744 effect is to subtract the size of the NV from the pointer, to return a
745 new pointer as if an initial NV were actually allocated.
747 This is the same trick as was used for NV and IV bodies. Ironically it
748 doesn't need to be used for NV bodies any more, because NV is now at
749 the start of the structure. IV bodies don't need it either, because
750 they are no longer allocated.
752 In turn, the new_body_* allocators call S_new_body(), which invokes
753 new_body_inline macro, which takes a lock, and takes a body off the
754 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
755 necessary to refresh an empty list. Then the lock is released, and
756 the body is returned.
758 S_more_bodies calls get_arena(), and carves it up into an array of N
759 bodies, which it strings into a linked list. It looks up arena-size
760 and body-size from the body_details table described below, thus
761 supporting the multiple body-types.
763 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
764 the (new|del)_X*V macros are mapped directly to malloc/free.
770 For each sv-type, struct body_details bodies_by_type[] carries
771 parameters which control these aspects of SV handling:
773 Arena_size determines whether arenas are used for this body type, and if
774 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
775 zero, forcing individual mallocs and frees.
777 Body_size determines how big a body is, and therefore how many fit into
778 each arena. Offset carries the body-pointer adjustment needed for
779 *_allocated body types, and is used in *_allocated macros.
781 But its main purpose is to parameterize info needed in
782 Perl_sv_upgrade(). The info here dramatically simplifies the function
783 vs the implementation in 5.8.7, making it table-driven. All fields
784 are used for this, except for arena_size.
786 For the sv-types that have no bodies, arenas are not used, so those
787 PL_body_roots[sv_type] are unused, and can be overloaded. In
788 something of a special case, SVt_NULL is borrowed for HE arenas;
789 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
790 bodies_by_type[SVt_NULL] slot is not used, as the table is not
793 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
794 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
795 just use the same allocation semantics. At first, PTEs were also
796 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
797 bugs, so was simplified by claiming a new slot. This choice has no
798 consequence at this time.
802 struct body_details {
803 U8 body_size; /* Size to allocate */
804 U8 copy; /* Size of structure to copy (may be shorter) */
806 unsigned int type : 4; /* We have space for a sanity check. */
807 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
808 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
809 unsigned int arena : 1; /* Allocated from an arena */
810 size_t arena_size; /* Size of arena to allocate */
818 /* With -DPURFIY we allocate everything directly, and don't use arenas.
819 This seems a rather elegant way to simplify some of the code below. */
820 #define HASARENA FALSE
822 #define HASARENA TRUE
824 #define NOARENA FALSE
826 /* Size the arenas to exactly fit a given number of bodies. A count
827 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
828 simplifying the default. If count > 0, the arena is sized to fit
829 only that many bodies, allowing arenas to be used for large, rare
830 bodies (XPVFM, XPVIO) without undue waste. The arena size is
831 limited by PERL_ARENA_SIZE, so we can safely oversize the
834 #define FIT_ARENA0(body_size) \
835 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
836 #define FIT_ARENAn(count,body_size) \
837 ( count * body_size <= PERL_ARENA_SIZE) \
838 ? count * body_size \
839 : FIT_ARENA0 (body_size)
840 #define FIT_ARENA(count,body_size) \
842 ? FIT_ARENAn (count, body_size) \
843 : FIT_ARENA0 (body_size)
845 /* A macro to work out the offset needed to subtract from a pointer to (say)
852 to make its members accessible via a pointer to (say)
862 #define relative_STRUCT_OFFSET(longer, shorter, member) \
863 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
865 /* Calculate the length to copy. Specifically work out the length less any
866 final padding the compiler needed to add. See the comment in sv_upgrade
867 for why copying the padding proved to be a bug. */
869 #define copy_length(type, last_member) \
870 STRUCT_OFFSET(type, last_member) \
871 + sizeof (((type*)SvANY((SV*)0))->last_member)
873 static const struct body_details bodies_by_type[] = {
874 { sizeof(HE), 0, 0, SVt_NULL,
875 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
877 /* The bind placeholder pretends to be an RV for now.
878 Also it's marked as "can't upgrade" to stop anyone using it before it's
880 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
882 /* IVs are in the head, so the allocation size is 0.
883 However, the slot is overloaded for PTEs. */
884 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
885 sizeof(IV), /* This is used to copy out the IV body. */
886 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
887 NOARENA /* IVS don't need an arena */,
888 /* But PTEs need to know the size of their arena */
889 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
892 /* 8 bytes on most ILP32 with IEEE doubles */
893 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
894 FIT_ARENA(0, sizeof(NV)) },
896 /* RVs are in the head now. */
897 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
899 /* 8 bytes on most ILP32 with IEEE doubles */
900 { sizeof(xpv_allocated),
901 copy_length(XPV, xpv_len)
902 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
903 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
907 { sizeof(xpviv_allocated),
908 copy_length(XPVIV, xiv_u)
909 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
910 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
914 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
915 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
918 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
919 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
922 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
926 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
929 { sizeof(xpvav_allocated),
930 copy_length(XPVAV, xmg_stash)
931 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
932 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
935 { sizeof(xpvhv_allocated),
936 copy_length(XPVHV, xmg_stash)
937 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
938 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
942 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
943 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
944 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
946 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
947 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
948 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
950 /* XPVIO is 84 bytes, fits 48x */
951 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
952 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
955 #define new_body_type(sv_type) \
956 (void *)((char *)S_new_body(aTHX_ sv_type))
958 #define del_body_type(p, sv_type) \
959 del_body(p, &PL_body_roots[sv_type])
962 #define new_body_allocated(sv_type) \
963 (void *)((char *)S_new_body(aTHX_ sv_type) \
964 - bodies_by_type[sv_type].offset)
966 #define del_body_allocated(p, sv_type) \
967 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
970 #define my_safemalloc(s) (void*)safemalloc(s)
971 #define my_safecalloc(s) (void*)safecalloc(s, 1)
972 #define my_safefree(p) safefree((char*)p)
976 #define new_XNV() my_safemalloc(sizeof(XPVNV))
977 #define del_XNV(p) my_safefree(p)
979 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
980 #define del_XPVNV(p) my_safefree(p)
982 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
983 #define del_XPVAV(p) my_safefree(p)
985 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
986 #define del_XPVHV(p) my_safefree(p)
988 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
989 #define del_XPVMG(p) my_safefree(p)
991 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
992 #define del_XPVGV(p) my_safefree(p)
996 #define new_XNV() new_body_type(SVt_NV)
997 #define del_XNV(p) del_body_type(p, SVt_NV)
999 #define new_XPVNV() new_body_type(SVt_PVNV)
1000 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1002 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1003 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1005 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1006 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1008 #define new_XPVMG() new_body_type(SVt_PVMG)
1009 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1011 #define new_XPVGV() new_body_type(SVt_PVGV)
1012 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1016 /* no arena for you! */
1018 #define new_NOARENA(details) \
1019 my_safemalloc((details)->body_size + (details)->offset)
1020 #define new_NOARENAZ(details) \
1021 my_safecalloc((details)->body_size + (details)->offset)
1024 S_more_bodies (pTHX_ svtype sv_type)
1027 void ** const root = &PL_body_roots[sv_type];
1028 const struct body_details * const bdp = &bodies_by_type[sv_type];
1029 const size_t body_size = bdp->body_size;
1032 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1033 static bool done_sanity_check;
1035 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1036 * variables like done_sanity_check. */
1037 if (!done_sanity_check) {
1038 unsigned int i = SVt_LAST;
1040 done_sanity_check = TRUE;
1043 assert (bodies_by_type[i].type == i);
1047 assert(bdp->arena_size);
1049 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1051 end = start + bdp->arena_size - body_size;
1053 /* computed count doesnt reflect the 1st slot reservation */
1054 DEBUG_m(PerlIO_printf(Perl_debug_log,
1055 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1056 (void*)start, (void*)end,
1057 (int)bdp->arena_size, sv_type, (int)body_size,
1058 (int)bdp->arena_size / (int)body_size));
1060 *root = (void *)start;
1062 while (start < end) {
1063 char * const next = start + body_size;
1064 *(void**) start = (void *)next;
1067 *(void **)start = 0;
1072 /* grab a new thing from the free list, allocating more if necessary.
1073 The inline version is used for speed in hot routines, and the
1074 function using it serves the rest (unless PURIFY).
1076 #define new_body_inline(xpv, sv_type) \
1078 void ** const r3wt = &PL_body_roots[sv_type]; \
1079 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1080 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1081 *(r3wt) = *(void**)(xpv); \
1087 S_new_body(pTHX_ svtype sv_type)
1091 new_body_inline(xpv, sv_type);
1098 =for apidoc sv_upgrade
1100 Upgrade an SV to a more complex form. Generally adds a new body type to the
1101 SV, then copies across as much information as possible from the old body.
1102 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1108 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1113 const svtype old_type = SvTYPE(sv);
1114 const struct body_details *new_type_details;
1115 const struct body_details *const old_type_details
1116 = bodies_by_type + old_type;
1118 if (new_type != SVt_PV && SvIsCOW(sv)) {
1119 sv_force_normal_flags(sv, 0);
1122 if (old_type == new_type)
1125 if (old_type > new_type)
1126 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1127 (int)old_type, (int)new_type);
1130 old_body = SvANY(sv);
1132 /* Copying structures onto other structures that have been neatly zeroed
1133 has a subtle gotcha. Consider XPVMG
1135 +------+------+------+------+------+-------+-------+
1136 | NV | CUR | LEN | IV | MAGIC | STASH |
1137 +------+------+------+------+------+-------+-------+
1138 0 4 8 12 16 20 24 28
1140 where NVs are aligned to 8 bytes, so that sizeof that structure is
1141 actually 32 bytes long, with 4 bytes of padding at the end:
1143 +------+------+------+------+------+-------+-------+------+
1144 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1145 +------+------+------+------+------+-------+-------+------+
1146 0 4 8 12 16 20 24 28 32
1148 so what happens if you allocate memory for this structure:
1150 +------+------+------+------+------+-------+-------+------+------+...
1151 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1152 +------+------+------+------+------+-------+-------+------+------+...
1153 0 4 8 12 16 20 24 28 32 36
1155 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1156 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1157 started out as zero once, but it's quite possible that it isn't. So now,
1158 rather than a nicely zeroed GP, you have it pointing somewhere random.
1161 (In fact, GP ends up pointing at a previous GP structure, because the
1162 principle cause of the padding in XPVMG getting garbage is a copy of
1163 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1164 this happens to be moot because XPVGV has been re-ordered, with GP
1165 no longer after STASH)
1167 So we are careful and work out the size of used parts of all the
1174 if (new_type < SVt_PVIV) {
1175 new_type = (new_type == SVt_NV)
1176 ? SVt_PVNV : SVt_PVIV;
1180 if (new_type < SVt_PVNV) {
1181 new_type = SVt_PVNV;
1187 assert(new_type > SVt_PV);
1188 assert(SVt_IV < SVt_PV);
1189 assert(SVt_NV < SVt_PV);
1196 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1197 there's no way that it can be safely upgraded, because perl.c
1198 expects to Safefree(SvANY(PL_mess_sv)) */
1199 assert(sv != PL_mess_sv);
1200 /* This flag bit is used to mean other things in other scalar types.
1201 Given that it only has meaning inside the pad, it shouldn't be set
1202 on anything that can get upgraded. */
1203 assert(!SvPAD_TYPED(sv));
1206 if (old_type_details->cant_upgrade)
1207 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1208 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1210 new_type_details = bodies_by_type + new_type;
1212 SvFLAGS(sv) &= ~SVTYPEMASK;
1213 SvFLAGS(sv) |= new_type;
1215 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1216 the return statements above will have triggered. */
1217 assert (new_type != SVt_NULL);
1220 assert(old_type == SVt_NULL);
1221 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1225 assert(old_type == SVt_NULL);
1226 SvANY(sv) = new_XNV();
1230 assert(old_type == SVt_NULL);
1231 SvANY(sv) = &sv->sv_u.svu_rv;
1236 assert(new_type_details->body_size);
1239 assert(new_type_details->arena);
1240 assert(new_type_details->arena_size);
1241 /* This points to the start of the allocated area. */
1242 new_body_inline(new_body, new_type);
1243 Zero(new_body, new_type_details->body_size, char);
1244 new_body = ((char *)new_body) - new_type_details->offset;
1246 /* We always allocated the full length item with PURIFY. To do this
1247 we fake things so that arena is false for all 16 types.. */
1248 new_body = new_NOARENAZ(new_type_details);
1250 SvANY(sv) = new_body;
1251 if (new_type == SVt_PVAV) {
1257 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1258 The target created by newSVrv also is, and it can have magic.
1259 However, it never has SvPVX set.
1261 if (old_type >= SVt_RV) {
1262 assert(SvPVX_const(sv) == 0);
1265 if (old_type >= SVt_PVMG) {
1266 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1267 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1269 sv->sv_u.svu_array = NULL; /* or svu_hash */
1275 /* XXX Is this still needed? Was it ever needed? Surely as there is
1276 no route from NV to PVIV, NOK can never be true */
1277 assert(!SvNOKp(sv));
1288 assert(new_type_details->body_size);
1289 /* We always allocated the full length item with PURIFY. To do this
1290 we fake things so that arena is false for all 16 types.. */
1291 if(new_type_details->arena) {
1292 /* This points to the start of the allocated area. */
1293 new_body_inline(new_body, new_type);
1294 Zero(new_body, new_type_details->body_size, char);
1295 new_body = ((char *)new_body) - new_type_details->offset;
1297 new_body = new_NOARENAZ(new_type_details);
1299 SvANY(sv) = new_body;
1301 if (old_type_details->copy) {
1302 /* There is now the potential for an upgrade from something without
1303 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1304 int offset = old_type_details->offset;
1305 int length = old_type_details->copy;
1307 if (new_type_details->offset > old_type_details->offset) {
1308 const int difference
1309 = new_type_details->offset - old_type_details->offset;
1310 offset += difference;
1311 length -= difference;
1313 assert (length >= 0);
1315 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1319 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1320 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1321 * correct 0.0 for us. Otherwise, if the old body didn't have an
1322 * NV slot, but the new one does, then we need to initialise the
1323 * freshly created NV slot with whatever the correct bit pattern is
1325 if (old_type_details->zero_nv && !new_type_details->zero_nv
1326 && !isGV_with_GP(sv))
1330 if (new_type == SVt_PVIO)
1331 IoPAGE_LEN(sv) = 60;
1332 if (old_type < SVt_RV)
1336 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1337 (unsigned long)new_type);
1340 if (old_type_details->arena) {
1341 /* If there was an old body, then we need to free it.
1342 Note that there is an assumption that all bodies of types that
1343 can be upgraded came from arenas. Only the more complex non-
1344 upgradable types are allowed to be directly malloc()ed. */
1346 my_safefree(old_body);
1348 del_body((void*)((char*)old_body + old_type_details->offset),
1349 &PL_body_roots[old_type]);
1355 =for apidoc sv_backoff
1357 Remove any string offset. You should normally use the C<SvOOK_off> macro
1364 Perl_sv_backoff(pTHX_ register SV *sv)
1366 PERL_UNUSED_CONTEXT;
1368 assert(SvTYPE(sv) != SVt_PVHV);
1369 assert(SvTYPE(sv) != SVt_PVAV);
1371 const char * const s = SvPVX_const(sv);
1372 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1373 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1375 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1377 SvFLAGS(sv) &= ~SVf_OOK;
1384 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1385 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1386 Use the C<SvGROW> wrapper instead.
1392 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1396 if (PL_madskills && newlen >= 0x100000) {
1397 PerlIO_printf(Perl_debug_log,
1398 "Allocation too large: %"UVxf"\n", (UV)newlen);
1400 #ifdef HAS_64K_LIMIT
1401 if (newlen >= 0x10000) {
1402 PerlIO_printf(Perl_debug_log,
1403 "Allocation too large: %"UVxf"\n", (UV)newlen);
1406 #endif /* HAS_64K_LIMIT */
1409 if (SvTYPE(sv) < SVt_PV) {
1410 sv_upgrade(sv, SVt_PV);
1411 s = SvPVX_mutable(sv);
1413 else if (SvOOK(sv)) { /* pv is offset? */
1415 s = SvPVX_mutable(sv);
1416 if (newlen > SvLEN(sv))
1417 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1418 #ifdef HAS_64K_LIMIT
1419 if (newlen >= 0x10000)
1424 s = SvPVX_mutable(sv);
1426 if (newlen > SvLEN(sv)) { /* need more room? */
1427 newlen = PERL_STRLEN_ROUNDUP(newlen);
1428 if (SvLEN(sv) && s) {
1430 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1436 s = (char*)saferealloc(s, newlen);
1439 s = (char*)safemalloc(newlen);
1440 if (SvPVX_const(sv) && SvCUR(sv)) {
1441 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1445 SvLEN_set(sv, newlen);
1451 =for apidoc sv_setiv
1453 Copies an integer into the given SV, upgrading first if necessary.
1454 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1460 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1463 SV_CHECK_THINKFIRST_COW_DROP(sv);
1464 switch (SvTYPE(sv)) {
1466 sv_upgrade(sv, SVt_IV);
1469 sv_upgrade(sv, SVt_PVNV);
1473 sv_upgrade(sv, SVt_PVIV);
1482 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1486 (void)SvIOK_only(sv); /* validate number */
1492 =for apidoc sv_setiv_mg
1494 Like C<sv_setiv>, but also handles 'set' magic.
1500 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1507 =for apidoc sv_setuv
1509 Copies an unsigned integer into the given SV, upgrading first if necessary.
1510 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1516 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1518 /* With these two if statements:
1519 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1522 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1524 If you wish to remove them, please benchmark to see what the effect is
1526 if (u <= (UV)IV_MAX) {
1527 sv_setiv(sv, (IV)u);
1536 =for apidoc sv_setuv_mg
1538 Like C<sv_setuv>, but also handles 'set' magic.
1544 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1551 =for apidoc sv_setnv
1553 Copies a double into the given SV, upgrading first if necessary.
1554 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1560 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1563 SV_CHECK_THINKFIRST_COW_DROP(sv);
1564 switch (SvTYPE(sv)) {
1567 sv_upgrade(sv, SVt_NV);
1572 sv_upgrade(sv, SVt_PVNV);
1581 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1586 (void)SvNOK_only(sv); /* validate number */
1591 =for apidoc sv_setnv_mg
1593 Like C<sv_setnv>, but also handles 'set' magic.
1599 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1605 /* Print an "isn't numeric" warning, using a cleaned-up,
1606 * printable version of the offending string
1610 S_not_a_number(pTHX_ SV *sv)
1618 dsv = sv_2mortal(newSVpvs(""));
1619 pv = sv_uni_display(dsv, sv, 10, 0);
1622 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1623 /* each *s can expand to 4 chars + "...\0",
1624 i.e. need room for 8 chars */
1626 const char *s = SvPVX_const(sv);
1627 const char * const end = s + SvCUR(sv);
1628 for ( ; s < end && d < limit; s++ ) {
1630 if (ch & 128 && !isPRINT_LC(ch)) {
1639 else if (ch == '\r') {
1643 else if (ch == '\f') {
1647 else if (ch == '\\') {
1651 else if (ch == '\0') {
1655 else if (isPRINT_LC(ch))
1672 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1673 "Argument \"%s\" isn't numeric in %s", pv,
1676 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1677 "Argument \"%s\" isn't numeric", pv);
1681 =for apidoc looks_like_number
1683 Test if the content of an SV looks like a number (or is a number).
1684 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1685 non-numeric warning), even if your atof() doesn't grok them.
1691 Perl_looks_like_number(pTHX_ SV *sv)
1693 register const char *sbegin;
1697 sbegin = SvPVX_const(sv);
1700 else if (SvPOKp(sv))
1701 sbegin = SvPV_const(sv, len);
1703 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1704 return grok_number(sbegin, len, NULL);
1708 S_glob_2number(pTHX_ GV * const gv)
1710 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1711 SV *const buffer = sv_newmortal();
1713 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1716 gv_efullname3(buffer, gv, "*");
1717 SvFLAGS(gv) |= wasfake;
1719 /* We know that all GVs stringify to something that is not-a-number,
1720 so no need to test that. */
1721 if (ckWARN(WARN_NUMERIC))
1722 not_a_number(buffer);
1723 /* We just want something true to return, so that S_sv_2iuv_common
1724 can tail call us and return true. */
1729 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1731 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1732 SV *const buffer = sv_newmortal();
1734 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1737 gv_efullname3(buffer, gv, "*");
1738 SvFLAGS(gv) |= wasfake;
1740 assert(SvPOK(buffer));
1742 *len = SvCUR(buffer);
1744 return SvPVX(buffer);
1747 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1748 until proven guilty, assume that things are not that bad... */
1753 As 64 bit platforms often have an NV that doesn't preserve all bits of
1754 an IV (an assumption perl has been based on to date) it becomes necessary
1755 to remove the assumption that the NV always carries enough precision to
1756 recreate the IV whenever needed, and that the NV is the canonical form.
1757 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1758 precision as a side effect of conversion (which would lead to insanity
1759 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1760 1) to distinguish between IV/UV/NV slots that have cached a valid
1761 conversion where precision was lost and IV/UV/NV slots that have a
1762 valid conversion which has lost no precision
1763 2) to ensure that if a numeric conversion to one form is requested that
1764 would lose precision, the precise conversion (or differently
1765 imprecise conversion) is also performed and cached, to prevent
1766 requests for different numeric formats on the same SV causing
1767 lossy conversion chains. (lossless conversion chains are perfectly
1772 SvIOKp is true if the IV slot contains a valid value
1773 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1774 SvNOKp is true if the NV slot contains a valid value
1775 SvNOK is true only if the NV value is accurate
1778 while converting from PV to NV, check to see if converting that NV to an
1779 IV(or UV) would lose accuracy over a direct conversion from PV to
1780 IV(or UV). If it would, cache both conversions, return NV, but mark
1781 SV as IOK NOKp (ie not NOK).
1783 While converting from PV to IV, check to see if converting that IV to an
1784 NV would lose accuracy over a direct conversion from PV to NV. If it
1785 would, cache both conversions, flag similarly.
1787 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1788 correctly because if IV & NV were set NV *always* overruled.
1789 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1790 changes - now IV and NV together means that the two are interchangeable:
1791 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1793 The benefit of this is that operations such as pp_add know that if
1794 SvIOK is true for both left and right operands, then integer addition
1795 can be used instead of floating point (for cases where the result won't
1796 overflow). Before, floating point was always used, which could lead to
1797 loss of precision compared with integer addition.
1799 * making IV and NV equal status should make maths accurate on 64 bit
1801 * may speed up maths somewhat if pp_add and friends start to use
1802 integers when possible instead of fp. (Hopefully the overhead in
1803 looking for SvIOK and checking for overflow will not outweigh the
1804 fp to integer speedup)
1805 * will slow down integer operations (callers of SvIV) on "inaccurate"
1806 values, as the change from SvIOK to SvIOKp will cause a call into
1807 sv_2iv each time rather than a macro access direct to the IV slot
1808 * should speed up number->string conversion on integers as IV is
1809 favoured when IV and NV are equally accurate
1811 ####################################################################
1812 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1813 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1814 On the other hand, SvUOK is true iff UV.
1815 ####################################################################
1817 Your mileage will vary depending your CPU's relative fp to integer
1821 #ifndef NV_PRESERVES_UV
1822 # define IS_NUMBER_UNDERFLOW_IV 1
1823 # define IS_NUMBER_UNDERFLOW_UV 2
1824 # define IS_NUMBER_IV_AND_UV 2
1825 # define IS_NUMBER_OVERFLOW_IV 4
1826 # define IS_NUMBER_OVERFLOW_UV 5
1828 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1830 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1832 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1835 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1836 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1837 if (SvNVX(sv) < (NV)IV_MIN) {
1838 (void)SvIOKp_on(sv);
1840 SvIV_set(sv, IV_MIN);
1841 return IS_NUMBER_UNDERFLOW_IV;
1843 if (SvNVX(sv) > (NV)UV_MAX) {
1844 (void)SvIOKp_on(sv);
1847 SvUV_set(sv, UV_MAX);
1848 return IS_NUMBER_OVERFLOW_UV;
1850 (void)SvIOKp_on(sv);
1852 /* Can't use strtol etc to convert this string. (See truth table in
1854 if (SvNVX(sv) <= (UV)IV_MAX) {
1855 SvIV_set(sv, I_V(SvNVX(sv)));
1856 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1857 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1859 /* Integer is imprecise. NOK, IOKp */
1861 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1864 SvUV_set(sv, U_V(SvNVX(sv)));
1865 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1866 if (SvUVX(sv) == UV_MAX) {
1867 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1868 possibly be preserved by NV. Hence, it must be overflow.
1870 return IS_NUMBER_OVERFLOW_UV;
1872 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1874 /* Integer is imprecise. NOK, IOKp */
1876 return IS_NUMBER_OVERFLOW_IV;
1878 #endif /* !NV_PRESERVES_UV*/
1881 S_sv_2iuv_common(pTHX_ SV *sv) {
1884 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1885 * without also getting a cached IV/UV from it at the same time
1886 * (ie PV->NV conversion should detect loss of accuracy and cache
1887 * IV or UV at same time to avoid this. */
1888 /* IV-over-UV optimisation - choose to cache IV if possible */
1890 if (SvTYPE(sv) == SVt_NV)
1891 sv_upgrade(sv, SVt_PVNV);
1893 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1894 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1895 certainly cast into the IV range at IV_MAX, whereas the correct
1896 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1898 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1899 if (Perl_isnan(SvNVX(sv))) {
1905 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1906 SvIV_set(sv, I_V(SvNVX(sv)));
1907 if (SvNVX(sv) == (NV) SvIVX(sv)
1908 #ifndef NV_PRESERVES_UV
1909 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1910 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1911 /* Don't flag it as "accurately an integer" if the number
1912 came from a (by definition imprecise) NV operation, and
1913 we're outside the range of NV integer precision */
1916 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1917 DEBUG_c(PerlIO_printf(Perl_debug_log,
1918 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1924 /* IV not precise. No need to convert from PV, as NV
1925 conversion would already have cached IV if it detected
1926 that PV->IV would be better than PV->NV->IV
1927 flags already correct - don't set public IOK. */
1928 DEBUG_c(PerlIO_printf(Perl_debug_log,
1929 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1934 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1935 but the cast (NV)IV_MIN rounds to a the value less (more
1936 negative) than IV_MIN which happens to be equal to SvNVX ??
1937 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1938 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1939 (NV)UVX == NVX are both true, but the values differ. :-(
1940 Hopefully for 2s complement IV_MIN is something like
1941 0x8000000000000000 which will be exact. NWC */
1944 SvUV_set(sv, U_V(SvNVX(sv)));
1946 (SvNVX(sv) == (NV) SvUVX(sv))
1947 #ifndef NV_PRESERVES_UV
1948 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1949 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1950 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1951 /* Don't flag it as "accurately an integer" if the number
1952 came from a (by definition imprecise) NV operation, and
1953 we're outside the range of NV integer precision */
1958 DEBUG_c(PerlIO_printf(Perl_debug_log,
1959 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1965 else if (SvPOKp(sv) && SvLEN(sv)) {
1967 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1968 /* We want to avoid a possible problem when we cache an IV/ a UV which
1969 may be later translated to an NV, and the resulting NV is not
1970 the same as the direct translation of the initial string
1971 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1972 be careful to ensure that the value with the .456 is around if the
1973 NV value is requested in the future).
1975 This means that if we cache such an IV/a UV, we need to cache the
1976 NV as well. Moreover, we trade speed for space, and do not
1977 cache the NV if we are sure it's not needed.
1980 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1981 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1982 == IS_NUMBER_IN_UV) {
1983 /* It's definitely an integer, only upgrade to PVIV */
1984 if (SvTYPE(sv) < SVt_PVIV)
1985 sv_upgrade(sv, SVt_PVIV);
1987 } else if (SvTYPE(sv) < SVt_PVNV)
1988 sv_upgrade(sv, SVt_PVNV);
1990 /* If NVs preserve UVs then we only use the UV value if we know that
1991 we aren't going to call atof() below. If NVs don't preserve UVs
1992 then the value returned may have more precision than atof() will
1993 return, even though value isn't perfectly accurate. */
1994 if ((numtype & (IS_NUMBER_IN_UV
1995 #ifdef NV_PRESERVES_UV
1998 )) == IS_NUMBER_IN_UV) {
1999 /* This won't turn off the public IOK flag if it was set above */
2000 (void)SvIOKp_on(sv);
2002 if (!(numtype & IS_NUMBER_NEG)) {
2004 if (value <= (UV)IV_MAX) {
2005 SvIV_set(sv, (IV)value);
2007 /* it didn't overflow, and it was positive. */
2008 SvUV_set(sv, value);
2012 /* 2s complement assumption */
2013 if (value <= (UV)IV_MIN) {
2014 SvIV_set(sv, -(IV)value);
2016 /* Too negative for an IV. This is a double upgrade, but
2017 I'm assuming it will be rare. */
2018 if (SvTYPE(sv) < SVt_PVNV)
2019 sv_upgrade(sv, SVt_PVNV);
2023 SvNV_set(sv, -(NV)value);
2024 SvIV_set(sv, IV_MIN);
2028 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2029 will be in the previous block to set the IV slot, and the next
2030 block to set the NV slot. So no else here. */
2032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2033 != IS_NUMBER_IN_UV) {
2034 /* It wasn't an (integer that doesn't overflow the UV). */
2035 SvNV_set(sv, Atof(SvPVX_const(sv)));
2037 if (! numtype && ckWARN(WARN_NUMERIC))
2040 #if defined(USE_LONG_DOUBLE)
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2045 PTR2UV(sv), SvNVX(sv)));
2048 #ifdef NV_PRESERVES_UV
2049 (void)SvIOKp_on(sv);
2051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2052 SvIV_set(sv, I_V(SvNVX(sv)));
2053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2056 NOOP; /* Integer is imprecise. NOK, IOKp */
2058 /* UV will not work better than IV */
2060 if (SvNVX(sv) > (NV)UV_MAX) {
2062 /* Integer is inaccurate. NOK, IOKp, is UV */
2063 SvUV_set(sv, UV_MAX);
2065 SvUV_set(sv, U_V(SvNVX(sv)));
2066 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2067 NV preservse UV so can do correct comparison. */
2068 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2071 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2076 #else /* NV_PRESERVES_UV */
2077 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2078 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2079 /* The IV/UV slot will have been set from value returned by
2080 grok_number above. The NV slot has just been set using
2083 assert (SvIOKp(sv));
2085 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2086 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2087 /* Small enough to preserve all bits. */
2088 (void)SvIOKp_on(sv);
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2093 /* Assumption: first non-preserved integer is < IV_MAX,
2094 this NV is in the preserved range, therefore: */
2095 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2097 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2101 0 0 already failed to read UV.
2102 0 1 already failed to read UV.
2103 1 0 you won't get here in this case. IV/UV
2104 slot set, public IOK, Atof() unneeded.
2105 1 1 already read UV.
2106 so there's no point in sv_2iuv_non_preserve() attempting
2107 to use atol, strtol, strtoul etc. */
2108 sv_2iuv_non_preserve (sv, numtype);
2111 #endif /* NV_PRESERVES_UV */
2115 if (isGV_with_GP(sv))
2116 return glob_2number((GV *)sv);
2118 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2119 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2122 if (SvTYPE(sv) < SVt_IV)
2123 /* Typically the caller expects that sv_any is not NULL now. */
2124 sv_upgrade(sv, SVt_IV);
2125 /* Return 0 from the caller. */
2132 =for apidoc sv_2iv_flags
2134 Return the integer value of an SV, doing any necessary string
2135 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2136 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2142 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2147 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2148 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2149 cache IVs just in case. In practice it seems that they never
2150 actually anywhere accessible by user Perl code, let alone get used
2151 in anything other than a string context. */
2152 if (flags & SV_GMAGIC)
2157 return I_V(SvNVX(sv));
2159 if (SvPOKp(sv) && SvLEN(sv)) {
2162 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2164 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2165 == IS_NUMBER_IN_UV) {
2166 /* It's definitely an integer */
2167 if (numtype & IS_NUMBER_NEG) {
2168 if (value < (UV)IV_MIN)
2171 if (value < (UV)IV_MAX)
2176 if (ckWARN(WARN_NUMERIC))
2179 return I_V(Atof(SvPVX_const(sv)));
2184 assert(SvTYPE(sv) >= SVt_PVMG);
2185 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2186 } else if (SvTHINKFIRST(sv)) {
2190 SV * const tmpstr=AMG_CALLun(sv,numer);
2191 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2192 return SvIV(tmpstr);
2195 return PTR2IV(SvRV(sv));
2198 sv_force_normal_flags(sv, 0);
2200 if (SvREADONLY(sv) && !SvOK(sv)) {
2201 if (ckWARN(WARN_UNINITIALIZED))
2207 if (S_sv_2iuv_common(aTHX_ sv))
2210 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2211 PTR2UV(sv),SvIVX(sv)));
2212 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2216 =for apidoc sv_2uv_flags
2218 Return the unsigned integer value of an SV, doing any necessary string
2219 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2220 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2226 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2231 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2232 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2233 cache IVs just in case. */
2234 if (flags & SV_GMAGIC)
2239 return U_V(SvNVX(sv));
2240 if (SvPOKp(sv) && SvLEN(sv)) {
2243 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2245 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2246 == IS_NUMBER_IN_UV) {
2247 /* It's definitely an integer */
2248 if (!(numtype & IS_NUMBER_NEG))
2252 if (ckWARN(WARN_NUMERIC))
2255 return U_V(Atof(SvPVX_const(sv)));
2260 assert(SvTYPE(sv) >= SVt_PVMG);
2261 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2262 } else if (SvTHINKFIRST(sv)) {
2266 SV *const tmpstr = AMG_CALLun(sv,numer);
2267 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2268 return SvUV(tmpstr);
2271 return PTR2UV(SvRV(sv));
2274 sv_force_normal_flags(sv, 0);
2276 if (SvREADONLY(sv) && !SvOK(sv)) {
2277 if (ckWARN(WARN_UNINITIALIZED))
2283 if (S_sv_2iuv_common(aTHX_ sv))
2287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2288 PTR2UV(sv),SvUVX(sv)));
2289 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2295 Return the num value of an SV, doing any necessary string or integer
2296 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2303 Perl_sv_2nv(pTHX_ register SV *sv)
2308 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2309 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2310 cache IVs just in case. */
2314 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2315 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2316 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2318 return Atof(SvPVX_const(sv));
2322 return (NV)SvUVX(sv);
2324 return (NV)SvIVX(sv);
2329 assert(SvTYPE(sv) >= SVt_PVMG);
2330 /* This falls through to the report_uninit near the end of the
2332 } else if (SvTHINKFIRST(sv)) {
2336 SV *const tmpstr = AMG_CALLun(sv,numer);
2337 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2338 return SvNV(tmpstr);
2341 return PTR2NV(SvRV(sv));
2344 sv_force_normal_flags(sv, 0);
2346 if (SvREADONLY(sv) && !SvOK(sv)) {
2347 if (ckWARN(WARN_UNINITIALIZED))
2352 if (SvTYPE(sv) < SVt_NV) {
2353 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2354 sv_upgrade(sv, SVt_NV);
2355 #ifdef USE_LONG_DOUBLE
2357 STORE_NUMERIC_LOCAL_SET_STANDARD();
2358 PerlIO_printf(Perl_debug_log,
2359 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2360 PTR2UV(sv), SvNVX(sv));
2361 RESTORE_NUMERIC_LOCAL();
2365 STORE_NUMERIC_LOCAL_SET_STANDARD();
2366 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2367 PTR2UV(sv), SvNVX(sv));
2368 RESTORE_NUMERIC_LOCAL();
2372 else if (SvTYPE(sv) < SVt_PVNV)
2373 sv_upgrade(sv, SVt_PVNV);
2378 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2379 #ifdef NV_PRESERVES_UV
2382 /* Only set the public NV OK flag if this NV preserves the IV */
2383 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2384 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2385 : (SvIVX(sv) == I_V(SvNVX(sv))))
2391 else if (SvPOKp(sv) && SvLEN(sv)) {
2393 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2394 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2396 #ifdef NV_PRESERVES_UV
2397 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2398 == IS_NUMBER_IN_UV) {
2399 /* It's definitely an integer */
2400 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2402 SvNV_set(sv, Atof(SvPVX_const(sv)));
2405 SvNV_set(sv, Atof(SvPVX_const(sv)));
2406 /* Only set the public NV OK flag if this NV preserves the value in
2407 the PV at least as well as an IV/UV would.
2408 Not sure how to do this 100% reliably. */
2409 /* if that shift count is out of range then Configure's test is
2410 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2412 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2413 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2414 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2415 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2416 /* Can't use strtol etc to convert this string, so don't try.
2417 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2420 /* value has been set. It may not be precise. */
2421 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2422 /* 2s complement assumption for (UV)IV_MIN */
2423 SvNOK_on(sv); /* Integer is too negative. */
2428 if (numtype & IS_NUMBER_NEG) {
2429 SvIV_set(sv, -(IV)value);
2430 } else if (value <= (UV)IV_MAX) {
2431 SvIV_set(sv, (IV)value);
2433 SvUV_set(sv, value);
2437 if (numtype & IS_NUMBER_NOT_INT) {
2438 /* I believe that even if the original PV had decimals,
2439 they are lost beyond the limit of the FP precision.
2440 However, neither is canonical, so both only get p
2441 flags. NWC, 2000/11/25 */
2442 /* Both already have p flags, so do nothing */
2444 const NV nv = SvNVX(sv);
2445 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2446 if (SvIVX(sv) == I_V(nv)) {
2449 /* It had no "." so it must be integer. */
2453 /* between IV_MAX and NV(UV_MAX).
2454 Could be slightly > UV_MAX */
2456 if (numtype & IS_NUMBER_NOT_INT) {
2457 /* UV and NV both imprecise. */
2459 const UV nv_as_uv = U_V(nv);
2461 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2470 #endif /* NV_PRESERVES_UV */
2473 if (isGV_with_GP(sv)) {
2474 glob_2number((GV *)sv);
2478 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2480 assert (SvTYPE(sv) >= SVt_NV);
2481 /* Typically the caller expects that sv_any is not NULL now. */
2482 /* XXX Ilya implies that this is a bug in callers that assume this
2483 and ideally should be fixed. */
2486 #if defined(USE_LONG_DOUBLE)
2488 STORE_NUMERIC_LOCAL_SET_STANDARD();
2489 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2490 PTR2UV(sv), SvNVX(sv));
2491 RESTORE_NUMERIC_LOCAL();
2495 STORE_NUMERIC_LOCAL_SET_STANDARD();
2496 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2497 PTR2UV(sv), SvNVX(sv));
2498 RESTORE_NUMERIC_LOCAL();
2507 Return an SV with the numeric value of the source SV, doing any necessary
2508 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2509 access this function.
2515 Perl_sv_2num(pTHX_ register SV *sv)
2520 SV * const tmpsv = AMG_CALLun(sv,numer);
2521 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2522 return sv_2num(tmpsv);
2524 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2527 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2528 * UV as a string towards the end of buf, and return pointers to start and
2531 * We assume that buf is at least TYPE_CHARS(UV) long.
2535 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2537 char *ptr = buf + TYPE_CHARS(UV);
2538 char * const ebuf = ptr;
2551 *--ptr = '0' + (char)(uv % 10);
2560 =for apidoc sv_2pv_flags
2562 Returns a pointer to the string value of an SV, and sets *lp to its length.
2563 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2565 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2566 usually end up here too.
2572 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2582 if (SvGMAGICAL(sv)) {
2583 if (flags & SV_GMAGIC)
2588 if (flags & SV_MUTABLE_RETURN)
2589 return SvPVX_mutable(sv);
2590 if (flags & SV_CONST_RETURN)
2591 return (char *)SvPVX_const(sv);
2594 if (SvIOKp(sv) || SvNOKp(sv)) {
2595 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2600 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2601 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2603 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2610 #ifdef FIXNEGATIVEZERO
2611 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2617 SvUPGRADE(sv, SVt_PV);
2620 s = SvGROW_mutable(sv, len + 1);
2623 return (char*)memcpy(s, tbuf, len + 1);
2629 assert(SvTYPE(sv) >= SVt_PVMG);
2630 /* This falls through to the report_uninit near the end of the
2632 } else if (SvTHINKFIRST(sv)) {
2636 SV *const tmpstr = AMG_CALLun(sv,string);
2637 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2639 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2643 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2644 if (flags & SV_CONST_RETURN) {
2645 pv = (char *) SvPVX_const(tmpstr);
2647 pv = (flags & SV_MUTABLE_RETURN)
2648 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2651 *lp = SvCUR(tmpstr);
2653 pv = sv_2pv_flags(tmpstr, lp, flags);
2667 const SV *const referent = (SV*)SvRV(sv);
2671 retval = buffer = savepvn("NULLREF", len);
2672 } else if (SvTYPE(referent) == SVt_PVMG
2673 && ((SvFLAGS(referent) &
2674 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2675 == (SVs_OBJECT|SVs_SMG))
2676 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2681 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2686 PL_reginterp_cnt += haseval;
2689 const char *const typestr = sv_reftype(referent, 0);
2690 const STRLEN typelen = strlen(typestr);
2691 UV addr = PTR2UV(referent);
2692 const char *stashname = NULL;
2693 STRLEN stashnamelen = 0; /* hush, gcc */
2694 const char *buffer_end;
2696 if (SvOBJECT(referent)) {
2697 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2700 stashname = HEK_KEY(name);
2701 stashnamelen = HEK_LEN(name);
2703 if (HEK_UTF8(name)) {
2709 stashname = "__ANON__";
2712 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2713 + 2 * sizeof(UV) + 2 /* )\0 */;
2715 len = typelen + 3 /* (0x */
2716 + 2 * sizeof(UV) + 2 /* )\0 */;
2719 Newx(buffer, len, char);
2720 buffer_end = retval = buffer + len;
2722 /* Working backwards */
2726 *--retval = PL_hexdigit[addr & 15];
2727 } while (addr >>= 4);
2733 memcpy(retval, typestr, typelen);
2737 retval -= stashnamelen;
2738 memcpy(retval, stashname, stashnamelen);
2740 /* retval may not neccesarily have reached the start of the
2742 assert (retval >= buffer);
2744 len = buffer_end - retval - 1; /* -1 for that \0 */
2752 if (SvREADONLY(sv) && !SvOK(sv)) {
2753 if (ckWARN(WARN_UNINITIALIZED))
2760 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2761 /* I'm assuming that if both IV and NV are equally valid then
2762 converting the IV is going to be more efficient */
2763 const U32 isUIOK = SvIsUV(sv);
2764 char buf[TYPE_CHARS(UV)];
2768 if (SvTYPE(sv) < SVt_PVIV)
2769 sv_upgrade(sv, SVt_PVIV);
2770 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2772 /* inlined from sv_setpvn */
2773 s = SvGROW_mutable(sv, len + 1);
2774 Move(ptr, s, len, char);
2778 else if (SvNOKp(sv)) {
2779 const int olderrno = errno;
2780 if (SvTYPE(sv) < SVt_PVNV)
2781 sv_upgrade(sv, SVt_PVNV);
2782 /* The +20 is pure guesswork. Configure test needed. --jhi */
2783 s = SvGROW_mutable(sv, NV_DIG + 20);
2784 /* some Xenix systems wipe out errno here */
2786 if (SvNVX(sv) == 0.0)
2787 my_strlcpy(s, "0", SvLEN(sv));
2791 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2794 #ifdef FIXNEGATIVEZERO
2795 if (*s == '-' && s[1] == '0' && !s[2]) {
2807 if (isGV_with_GP(sv))
2808 return glob_2pv((GV *)sv, lp);
2810 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2814 if (SvTYPE(sv) < SVt_PV)
2815 /* Typically the caller expects that sv_any is not NULL now. */
2816 sv_upgrade(sv, SVt_PV);
2820 const STRLEN len = s - SvPVX_const(sv);
2826 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2827 PTR2UV(sv),SvPVX_const(sv)));
2828 if (flags & SV_CONST_RETURN)
2829 return (char *)SvPVX_const(sv);
2830 if (flags & SV_MUTABLE_RETURN)
2831 return SvPVX_mutable(sv);
2836 =for apidoc sv_copypv
2838 Copies a stringified representation of the source SV into the
2839 destination SV. Automatically performs any necessary mg_get and
2840 coercion of numeric values into strings. Guaranteed to preserve
2841 UTF8 flag even from overloaded objects. Similar in nature to
2842 sv_2pv[_flags] but operates directly on an SV instead of just the
2843 string. Mostly uses sv_2pv_flags to do its work, except when that
2844 would lose the UTF-8'ness of the PV.
2850 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2853 const char * const s = SvPV_const(ssv,len);
2854 sv_setpvn(dsv,s,len);
2862 =for apidoc sv_2pvbyte
2864 Return a pointer to the byte-encoded representation of the SV, and set *lp
2865 to its length. May cause the SV to be downgraded from UTF-8 as a
2868 Usually accessed via the C<SvPVbyte> macro.
2874 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2876 sv_utf8_downgrade(sv,0);
2877 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2881 =for apidoc sv_2pvutf8
2883 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2884 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2886 Usually accessed via the C<SvPVutf8> macro.
2892 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2894 sv_utf8_upgrade(sv);
2895 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2900 =for apidoc sv_2bool
2902 This function is only called on magical items, and is only used by
2903 sv_true() or its macro equivalent.
2909 Perl_sv_2bool(pTHX_ register SV *sv)
2918 SV * const tmpsv = AMG_CALLun(sv,bool_);
2919 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2920 return (bool)SvTRUE(tmpsv);
2922 return SvRV(sv) != 0;
2925 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2927 (*sv->sv_u.svu_pv > '0' ||
2928 Xpvtmp->xpv_cur > 1 ||
2929 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2936 return SvIVX(sv) != 0;
2939 return SvNVX(sv) != 0.0;
2941 if (isGV_with_GP(sv))
2951 =for apidoc sv_utf8_upgrade
2953 Converts the PV of an SV to its UTF-8-encoded form.
2954 Forces the SV to string form if it is not already.
2955 Always sets the SvUTF8 flag to avoid future validity checks even
2956 if all the bytes have hibit clear.
2958 This is not as a general purpose byte encoding to Unicode interface:
2959 use the Encode extension for that.
2961 =for apidoc sv_utf8_upgrade_flags
2963 Converts the PV of an SV to its UTF-8-encoded form.
2964 Forces the SV to string form if it is not already.
2965 Always sets the SvUTF8 flag to avoid future validity checks even
2966 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2967 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2968 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2970 This is not as a general purpose byte encoding to Unicode interface:
2971 use the Encode extension for that.
2977 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2980 if (sv == &PL_sv_undef)
2984 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2985 (void) sv_2pv_flags(sv,&len, flags);
2989 (void) SvPV_force(sv,len);
2998 sv_force_normal_flags(sv, 0);
3001 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3002 sv_recode_to_utf8(sv, PL_encoding);
3003 else { /* Assume Latin-1/EBCDIC */
3004 /* This function could be much more efficient if we
3005 * had a FLAG in SVs to signal if there are any hibit
3006 * chars in the PV. Given that there isn't such a flag
3007 * make the loop as fast as possible. */
3008 const U8 * const s = (U8 *) SvPVX_const(sv);
3009 const U8 * const e = (U8 *) SvEND(sv);
3014 /* Check for hi bit */
3015 if (!NATIVE_IS_INVARIANT(ch)) {
3016 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3017 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3019 SvPV_free(sv); /* No longer using what was there before. */
3020 SvPV_set(sv, (char*)recoded);
3021 SvCUR_set(sv, len - 1);
3022 SvLEN_set(sv, len); /* No longer know the real size. */
3026 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3033 =for apidoc sv_utf8_downgrade
3035 Attempts to convert the PV of an SV from characters to bytes.
3036 If the PV contains a character beyond byte, this conversion will fail;
3037 in this case, either returns false or, if C<fail_ok> is not
3040 This is not as a general purpose Unicode to byte encoding interface:
3041 use the Encode extension for that.
3047 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3050 if (SvPOKp(sv) && SvUTF8(sv)) {
3056 sv_force_normal_flags(sv, 0);
3058 s = (U8 *) SvPV(sv, len);
3059 if (!utf8_to_bytes(s, &len)) {
3064 Perl_croak(aTHX_ "Wide character in %s",
3067 Perl_croak(aTHX_ "Wide character");
3078 =for apidoc sv_utf8_encode
3080 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3081 flag off so that it looks like octets again.
3087 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3090 sv_force_normal_flags(sv, 0);
3092 if (SvREADONLY(sv)) {
3093 Perl_croak(aTHX_ PL_no_modify);
3095 (void) sv_utf8_upgrade(sv);
3100 =for apidoc sv_utf8_decode
3102 If the PV of the SV is an octet sequence in UTF-8
3103 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3104 so that it looks like a character. If the PV contains only single-byte
3105 characters, the C<SvUTF8> flag stays being off.
3106 Scans PV for validity and returns false if the PV is invalid UTF-8.
3112 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3118 /* The octets may have got themselves encoded - get them back as
3121 if (!sv_utf8_downgrade(sv, TRUE))
3124 /* it is actually just a matter of turning the utf8 flag on, but
3125 * we want to make sure everything inside is valid utf8 first.
3127 c = (const U8 *) SvPVX_const(sv);
3128 if (!is_utf8_string(c, SvCUR(sv)+1))
3130 e = (const U8 *) SvEND(sv);
3133 if (!UTF8_IS_INVARIANT(ch)) {
3143 =for apidoc sv_setsv
3145 Copies the contents of the source SV C<ssv> into the destination SV
3146 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3147 function if the source SV needs to be reused. Does not handle 'set' magic.
3148 Loosely speaking, it performs a copy-by-value, obliterating any previous
3149 content of the destination.
3151 You probably want to use one of the assortment of wrappers, such as
3152 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3153 C<SvSetMagicSV_nosteal>.
3155 =for apidoc sv_setsv_flags
3157 Copies the contents of the source SV C<ssv> into the destination SV
3158 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3159 function if the source SV needs to be reused. Does not handle 'set' magic.
3160 Loosely speaking, it performs a copy-by-value, obliterating any previous
3161 content of the destination.
3162 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3163 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3164 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3165 and C<sv_setsv_nomg> are implemented in terms of this function.
3167 You probably want to use one of the assortment of wrappers, such as
3168 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3169 C<SvSetMagicSV_nosteal>.
3171 This is the primary function for copying scalars, and most other
3172 copy-ish functions and macros use this underneath.
3178 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3180 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3182 if (dtype != SVt_PVGV) {
3183 const char * const name = GvNAME(sstr);
3184 const STRLEN len = GvNAMELEN(sstr);
3186 if (dtype >= SVt_PV) {
3192 SvUPGRADE(dstr, SVt_PVGV);
3193 (void)SvOK_off(dstr);
3194 /* FIXME - why are we doing this, then turning it off and on again
3196 isGV_with_GP_on(dstr);
3198 GvSTASH(dstr) = GvSTASH(sstr);
3200 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3201 gv_name_set((GV *)dstr, name, len, GV_ADD);
3202 SvFAKE_on(dstr); /* can coerce to non-glob */
3205 #ifdef GV_UNIQUE_CHECK
3206 if (GvUNIQUE((GV*)dstr)) {
3207 Perl_croak(aTHX_ PL_no_modify);
3211 if(GvGP((GV*)sstr)) {
3212 /* If source has method cache entry, clear it */
3214 SvREFCNT_dec(GvCV(sstr));
3218 /* If source has a real method, then a method is
3220 else if(GvCV((GV*)sstr)) {
3225 /* If dest already had a real method, that's a change as well */
3226 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3230 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3234 isGV_with_GP_off(dstr);
3235 (void)SvOK_off(dstr);
3236 isGV_with_GP_on(dstr);
3237 GvINTRO_off(dstr); /* one-shot flag */
3238 GvGP(dstr) = gp_ref(GvGP(sstr));
3239 if (SvTAINTED(sstr))
3241 if (GvIMPORTED(dstr) != GVf_IMPORTED
3242 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3244 GvIMPORTED_on(dstr);
3247 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3248 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3253 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3254 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3256 const int intro = GvINTRO(dstr);
3259 const U32 stype = SvTYPE(sref);
3262 #ifdef GV_UNIQUE_CHECK
3263 if (GvUNIQUE((GV*)dstr)) {
3264 Perl_croak(aTHX_ PL_no_modify);
3269 GvINTRO_off(dstr); /* one-shot flag */
3270 GvLINE(dstr) = CopLINE(PL_curcop);
3271 GvEGV(dstr) = (GV*)dstr;
3276 location = (SV **) &GvCV(dstr);
3277 import_flag = GVf_IMPORTED_CV;
3280 location = (SV **) &GvHV(dstr);
3281 import_flag = GVf_IMPORTED_HV;
3284 location = (SV **) &GvAV(dstr);
3285 import_flag = GVf_IMPORTED_AV;
3288 location = (SV **) &GvIOp(dstr);
3291 location = (SV **) &GvFORM(dstr);
3293 location = &GvSV(dstr);
3294 import_flag = GVf_IMPORTED_SV;
3297 if (stype == SVt_PVCV) {
3298 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3299 if (GvCVGEN(dstr)) {
3300 SvREFCNT_dec(GvCV(dstr));
3302 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3305 SAVEGENERICSV(*location);
3309 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3310 CV* const cv = (CV*)*location;
3312 if (!GvCVGEN((GV*)dstr) &&
3313 (CvROOT(cv) || CvXSUB(cv)))
3315 /* Redefining a sub - warning is mandatory if
3316 it was a const and its value changed. */
3317 if (CvCONST(cv) && CvCONST((CV*)sref)
3318 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3320 /* They are 2 constant subroutines generated from
3321 the same constant. This probably means that
3322 they are really the "same" proxy subroutine
3323 instantiated in 2 places. Most likely this is
3324 when a constant is exported twice. Don't warn.
3327 else if (ckWARN(WARN_REDEFINE)
3329 && (!CvCONST((CV*)sref)
3330 || sv_cmp(cv_const_sv(cv),
3331 cv_const_sv((CV*)sref))))) {
3332 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3335 ? "Constant subroutine %s::%s redefined"
3336 : "Subroutine %s::%s redefined"),
3337 HvNAME_get(GvSTASH((GV*)dstr)),
3338 GvENAME((GV*)dstr));
3342 cv_ckproto_len(cv, (GV*)dstr,
3343 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3344 SvPOK(sref) ? SvCUR(sref) : 0);
3346 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3347 GvASSUMECV_on(dstr);
3348 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3351 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3352 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3353 GvFLAGS(dstr) |= import_flag;
3358 if (SvTAINTED(sstr))
3364 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3367 register U32 sflags;
3369 register svtype stype;
3374 if (SvIS_FREED(dstr)) {
3375 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3376 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3378 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3380 sstr = &PL_sv_undef;
3381 if (SvIS_FREED(sstr)) {
3382 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3383 (void*)sstr, (void*)dstr);
3385 stype = SvTYPE(sstr);
3386 dtype = SvTYPE(dstr);
3388 (void)SvAMAGIC_off(dstr);
3391 /* need to nuke the magic */
3393 SvRMAGICAL_off(dstr);
3396 /* There's a lot of redundancy below but we're going for speed here */
3401 if (dtype != SVt_PVGV) {
3402 (void)SvOK_off(dstr);
3410 sv_upgrade(dstr, SVt_IV);
3415 sv_upgrade(dstr, SVt_PVIV);
3418 goto end_of_first_switch;
3420 (void)SvIOK_only(dstr);
3421 SvIV_set(dstr, SvIVX(sstr));
3424 /* SvTAINTED can only be true if the SV has taint magic, which in
3425 turn means that the SV type is PVMG (or greater). This is the
3426 case statement for SVt_IV, so this cannot be true (whatever gcov
3428 assert(!SvTAINTED(sstr));
3438 sv_upgrade(dstr, SVt_NV);
3443 sv_upgrade(dstr, SVt_PVNV);
3446 goto end_of_first_switch;
3448 SvNV_set(dstr, SvNVX(sstr));
3449 (void)SvNOK_only(dstr);
3450 /* SvTAINTED can only be true if the SV has taint magic, which in
3451 turn means that the SV type is PVMG (or greater). This is the
3452 case statement for SVt_NV, so this cannot be true (whatever gcov
3454 assert(!SvTAINTED(sstr));
3461 sv_upgrade(dstr, SVt_RV);
3464 #ifdef PERL_OLD_COPY_ON_WRITE
3465 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3466 if (dtype < SVt_PVIV)
3467 sv_upgrade(dstr, SVt_PVIV);
3474 sv_upgrade(dstr, SVt_PV);
3477 if (dtype < SVt_PVIV)
3478 sv_upgrade(dstr, SVt_PVIV);
3481 if (dtype < SVt_PVNV)
3482 sv_upgrade(dstr, SVt_PVNV);
3486 const char * const type = sv_reftype(sstr,0);
3488 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3490 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3494 /* case SVt_BIND: */
3497 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3498 glob_assign_glob(dstr, sstr, dtype);
3501 /* SvVALID means that this PVGV is playing at being an FBM. */
3505 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3507 if (SvTYPE(sstr) != stype) {
3508 stype = SvTYPE(sstr);
3509 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3510 glob_assign_glob(dstr, sstr, dtype);
3515 if (stype == SVt_PVLV)
3516 SvUPGRADE(dstr, SVt_PVNV);
3518 SvUPGRADE(dstr, (svtype)stype);
3520 end_of_first_switch:
3522 /* dstr may have been upgraded. */
3523 dtype = SvTYPE(dstr);
3524 sflags = SvFLAGS(sstr);
3526 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3527 /* Assigning to a subroutine sets the prototype. */
3530 const char *const ptr = SvPV_const(sstr, len);
3532 SvGROW(dstr, len + 1);
3533 Copy(ptr, SvPVX(dstr), len + 1, char);
3534 SvCUR_set(dstr, len);
3536 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3540 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3541 const char * const type = sv_reftype(dstr,0);
3543 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3545 Perl_croak(aTHX_ "Cannot copy to %s", type);
3546 } else if (sflags & SVf_ROK) {
3547 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3548 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3551 if (GvIMPORTED(dstr) != GVf_IMPORTED
3552 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3554 GvIMPORTED_on(dstr);
3559 glob_assign_glob(dstr, sstr, dtype);
3563 if (dtype >= SVt_PV) {
3564 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3565 glob_assign_ref(dstr, sstr);
3568 if (SvPVX_const(dstr)) {
3574 (void)SvOK_off(dstr);
3575 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3576 SvFLAGS(dstr) |= sflags & SVf_ROK;
3577 assert(!(sflags & SVp_NOK));
3578 assert(!(sflags & SVp_IOK));
3579 assert(!(sflags & SVf_NOK));
3580 assert(!(sflags & SVf_IOK));
3582 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3583 if (!(sflags & SVf_OK)) {
3584 if (ckWARN(WARN_MISC))
3585 Perl_warner(aTHX_ packWARN(WARN_MISC),
3586 "Undefined value assigned to typeglob");
3589 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3590 if (dstr != (SV*)gv) {
3593 GvGP(dstr) = gp_ref(GvGP(gv));
3597 else if (sflags & SVp_POK) {
3601 * Check to see if we can just swipe the string. If so, it's a
3602 * possible small lose on short strings, but a big win on long ones.
3603 * It might even be a win on short strings if SvPVX_const(dstr)
3604 * has to be allocated and SvPVX_const(sstr) has to be freed.
3605 * Likewise if we can set up COW rather than doing an actual copy, we
3606 * drop to the else clause, as the swipe code and the COW setup code
3607 * have much in common.
3610 /* Whichever path we take through the next code, we want this true,
3611 and doing it now facilitates the COW check. */
3612 (void)SvPOK_only(dstr);
3615 /* If we're already COW then this clause is not true, and if COW
3616 is allowed then we drop down to the else and make dest COW
3617 with us. If caller hasn't said that we're allowed to COW
3618 shared hash keys then we don't do the COW setup, even if the
3619 source scalar is a shared hash key scalar. */
3620 (((flags & SV_COW_SHARED_HASH_KEYS)
3621 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3622 : 1 /* If making a COW copy is forbidden then the behaviour we
3623 desire is as if the source SV isn't actually already
3624 COW, even if it is. So we act as if the source flags
3625 are not COW, rather than actually testing them. */
3627 #ifndef PERL_OLD_COPY_ON_WRITE
3628 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3629 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3630 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3631 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3632 but in turn, it's somewhat dead code, never expected to go
3633 live, but more kept as a placeholder on how to do it better
3634 in a newer implementation. */
3635 /* If we are COW and dstr is a suitable target then we drop down
3636 into the else and make dest a COW of us. */
3637 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3642 (sflags & SVs_TEMP) && /* slated for free anyway? */
3643 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3644 (!(flags & SV_NOSTEAL)) &&
3645 /* and we're allowed to steal temps */
3646 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3647 SvLEN(sstr) && /* and really is a string */
3648 /* and won't be needed again, potentially */
3649 !(PL_op && PL_op->op_type == OP_AASSIGN))
3650 #ifdef PERL_OLD_COPY_ON_WRITE
3651 && ((flags & SV_COW_SHARED_HASH_KEYS)
3652 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3653 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3654 && SvTYPE(sstr) >= SVt_PVIV))
3658 /* Failed the swipe test, and it's not a shared hash key either.
3659 Have to copy the string. */
3660 STRLEN len = SvCUR(sstr);
3661 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3662 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3663 SvCUR_set(dstr, len);
3664 *SvEND(dstr) = '\0';
3666 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3668 /* Either it's a shared hash key, or it's suitable for
3669 copy-on-write or we can swipe the string. */
3671 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3675 #ifdef PERL_OLD_COPY_ON_WRITE
3677 /* I believe I should acquire a global SV mutex if
3678 it's a COW sv (not a shared hash key) to stop
3679 it going un copy-on-write.
3680 If the source SV has gone un copy on write between up there
3681 and down here, then (assert() that) it is of the correct
3682 form to make it copy on write again */
3683 if ((sflags & (SVf_FAKE | SVf_READONLY))
3684 != (SVf_FAKE | SVf_READONLY)) {
3685 SvREADONLY_on(sstr);
3687 /* Make the source SV into a loop of 1.
3688 (about to become 2) */
3689 SV_COW_NEXT_SV_SET(sstr, sstr);
3693 /* Initial code is common. */
3694 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3699 /* making another shared SV. */
3700 STRLEN cur = SvCUR(sstr);
3701 STRLEN len = SvLEN(sstr);
3702 #ifdef PERL_OLD_COPY_ON_WRITE
3704 assert (SvTYPE(dstr) >= SVt_PVIV);
3705 /* SvIsCOW_normal */
3706 /* splice us in between source and next-after-source. */
3707 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3708 SV_COW_NEXT_SV_SET(sstr, dstr);
3709 SvPV_set(dstr, SvPVX_mutable(sstr));
3713 /* SvIsCOW_shared_hash */
3714 DEBUG_C(PerlIO_printf(Perl_debug_log,
3715 "Copy on write: Sharing hash\n"));
3717 assert (SvTYPE(dstr) >= SVt_PV);
3719 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3721 SvLEN_set(dstr, len);
3722 SvCUR_set(dstr, cur);
3723 SvREADONLY_on(dstr);
3725 /* Relesase a global SV mutex. */
3728 { /* Passes the swipe test. */
3729 SvPV_set(dstr, SvPVX_mutable(sstr));
3730 SvLEN_set(dstr, SvLEN(sstr));
3731 SvCUR_set(dstr, SvCUR(sstr));
3734 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3735 SvPV_set(sstr, NULL);
3741 if (sflags & SVp_NOK) {
3742 SvNV_set(dstr, SvNVX(sstr));
3744 if (sflags & SVp_IOK) {
3746 SvIV_set(dstr, SvIVX(sstr));
3747 /* Must do this otherwise some other overloaded use of 0x80000000
3748 gets confused. I guess SVpbm_VALID */
3749 if (sflags & SVf_IVisUV)
3752 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3754 const MAGIC * const smg = SvVSTRING_mg(sstr);
3756 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3757 smg->mg_ptr, smg->mg_len);
3758 SvRMAGICAL_on(dstr);
3762 else if (sflags & (SVp_IOK|SVp_NOK)) {
3763 (void)SvOK_off(dstr);
3764 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3765 if (sflags & SVp_IOK) {
3766 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3767 SvIV_set(dstr, SvIVX(sstr));
3769 if (sflags & SVp_NOK) {
3770 SvNV_set(dstr, SvNVX(sstr));
3774 if (isGV_with_GP(sstr)) {
3775 /* This stringification rule for globs is spread in 3 places.
3776 This feels bad. FIXME. */
3777 const U32 wasfake = sflags & SVf_FAKE;
3779 /* FAKE globs can get coerced, so need to turn this off
3780 temporarily if it is on. */
3782 gv_efullname3(dstr, (GV *)sstr, "*");
3783 SvFLAGS(sstr) |= wasfake;
3786 (void)SvOK_off(dstr);
3788 if (SvTAINTED(sstr))
3793 =for apidoc sv_setsv_mg
3795 Like C<sv_setsv>, but also handles 'set' magic.
3801 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3803 sv_setsv(dstr,sstr);
3807 #ifdef PERL_OLD_COPY_ON_WRITE
3809 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3811 STRLEN cur = SvCUR(sstr);
3812 STRLEN len = SvLEN(sstr);
3813 register char *new_pv;
3816 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3817 (void*)sstr, (void*)dstr);
3824 if (SvTHINKFIRST(dstr))
3825 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3826 else if (SvPVX_const(dstr))
3827 Safefree(SvPVX_const(dstr));
3831 SvUPGRADE(dstr, SVt_PVIV);
3833 assert (SvPOK(sstr));
3834 assert (SvPOKp(sstr));
3835 assert (!SvIOK(sstr));
3836 assert (!SvIOKp(sstr));
3837 assert (!SvNOK(sstr));
3838 assert (!SvNOKp(sstr));
3840 if (SvIsCOW(sstr)) {
3842 if (SvLEN(sstr) == 0) {
3843 /* source is a COW shared hash key. */
3844 DEBUG_C(PerlIO_printf(Perl_debug_log,
3845 "Fast copy on write: Sharing hash\n"));
3846 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3849 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3851 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3852 SvUPGRADE(sstr, SVt_PVIV);
3853 SvREADONLY_on(sstr);
3855 DEBUG_C(PerlIO_printf(Perl_debug_log,
3856 "Fast copy on write: Converting sstr to COW\n"));
3857 SV_COW_NEXT_SV_SET(dstr, sstr);
3859 SV_COW_NEXT_SV_SET(sstr, dstr);
3860 new_pv = SvPVX_mutable(sstr);
3863 SvPV_set(dstr, new_pv);
3864 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3867 SvLEN_set(dstr, len);
3868 SvCUR_set(dstr, cur);
3877 =for apidoc sv_setpvn
3879 Copies a string into an SV. The C<len> parameter indicates the number of
3880 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3881 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3887 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3890 register char *dptr;
3892 SV_CHECK_THINKFIRST_COW_DROP(sv);
3898 /* len is STRLEN which is unsigned, need to copy to signed */
3901 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3903 SvUPGRADE(sv, SVt_PV);
3905 dptr = SvGROW(sv, len + 1);
3906 Move(ptr,dptr,len,char);
3909 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3914 =for apidoc sv_setpvn_mg
3916 Like C<sv_setpvn>, but also handles 'set' magic.
3922 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3924 sv_setpvn(sv,ptr,len);
3929 =for apidoc sv_setpv
3931 Copies a string into an SV. The string must be null-terminated. Does not
3932 handle 'set' magic. See C<sv_setpv_mg>.
3938 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3941 register STRLEN len;
3943 SV_CHECK_THINKFIRST_COW_DROP(sv);
3949 SvUPGRADE(sv, SVt_PV);
3951 SvGROW(sv, len + 1);
3952 Move(ptr,SvPVX(sv),len+1,char);
3954 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3959 =for apidoc sv_setpv_mg
3961 Like C<sv_setpv>, but also handles 'set' magic.
3967 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3974 =for apidoc sv_usepvn_flags
3976 Tells an SV to use C<ptr> to find its string value. Normally the
3977 string is stored inside the SV but sv_usepvn allows the SV to use an
3978 outside string. The C<ptr> should point to memory that was allocated
3979 by C<malloc>. The string length, C<len>, must be supplied. By default
3980 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3981 so that pointer should not be freed or used by the programmer after
3982 giving it to sv_usepvn, and neither should any pointers from "behind"
3983 that pointer (e.g. ptr + 1) be used.
3985 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3986 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3987 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3988 C<len>, and already meets the requirements for storing in C<SvPVX>)
3994 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3998 SV_CHECK_THINKFIRST_COW_DROP(sv);
3999 SvUPGRADE(sv, SVt_PV);
4002 if (flags & SV_SMAGIC)
4006 if (SvPVX_const(sv))
4010 if (flags & SV_HAS_TRAILING_NUL)
4011 assert(ptr[len] == '\0');
4014 allocate = (flags & SV_HAS_TRAILING_NUL)
4015 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4016 if (flags & SV_HAS_TRAILING_NUL) {
4017 /* It's long enough - do nothing.
4018 Specfically Perl_newCONSTSUB is relying on this. */
4021 /* Force a move to shake out bugs in callers. */
4022 char *new_ptr = (char*)safemalloc(allocate);
4023 Copy(ptr, new_ptr, len, char);
4024 PoisonFree(ptr,len,char);
4028 ptr = (char*) saferealloc (ptr, allocate);
4033 SvLEN_set(sv, allocate);
4034 if (!(flags & SV_HAS_TRAILING_NUL)) {
4037 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4039 if (flags & SV_SMAGIC)
4043 #ifdef PERL_OLD_COPY_ON_WRITE
4044 /* Need to do this *after* making the SV normal, as we need the buffer
4045 pointer to remain valid until after we've copied it. If we let go too early,
4046 another thread could invalidate it by unsharing last of the same hash key
4047 (which it can do by means other than releasing copy-on-write Svs)
4048 or by changing the other copy-on-write SVs in the loop. */
4050 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4052 { /* this SV was SvIsCOW_normal(sv) */
4053 /* we need to find the SV pointing to us. */
4054 SV *current = SV_COW_NEXT_SV(after);
4056 if (current == sv) {
4057 /* The SV we point to points back to us (there were only two of us
4059 Hence other SV is no longer copy on write either. */
4061 SvREADONLY_off(after);
4063 /* We need to follow the pointers around the loop. */
4065 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4068 /* don't loop forever if the structure is bust, and we have
4069 a pointer into a closed loop. */
4070 assert (current != after);
4071 assert (SvPVX_const(current) == pvx);
4073 /* Make the SV before us point to the SV after us. */
4074 SV_COW_NEXT_SV_SET(current, after);
4080 =for apidoc sv_force_normal_flags
4082 Undo various types of fakery on an SV: if the PV is a shared string, make
4083 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4084 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4085 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4086 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4087 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4088 set to some other value.) In addition, the C<flags> parameter gets passed to
4089 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4090 with flags set to 0.
4096 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4099 #ifdef PERL_OLD_COPY_ON_WRITE
4100 if (SvREADONLY(sv)) {
4101 /* At this point I believe I should acquire a global SV mutex. */
4103 const char * const pvx = SvPVX_const(sv);
4104 const STRLEN len = SvLEN(sv);
4105 const STRLEN cur = SvCUR(sv);
4106 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4107 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4108 we'll fail an assertion. */
4109 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4112 PerlIO_printf(Perl_debug_log,
4113 "Copy on write: Force normal %ld\n",
4119 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4122 if (flags & SV_COW_DROP_PV) {
4123 /* OK, so we don't need to copy our buffer. */
4126 SvGROW(sv, cur + 1);
4127 Move(pvx,SvPVX(sv),cur,char);
4132 sv_release_COW(sv, pvx, next);
4134 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4140 else if (IN_PERL_RUNTIME)
4141 Perl_croak(aTHX_ PL_no_modify);
4142 /* At this point I believe that I can drop the global SV mutex. */
4145 if (SvREADONLY(sv)) {
4147 const char * const pvx = SvPVX_const(sv);
4148 const STRLEN len = SvCUR(sv);
4153 SvGROW(sv, len + 1);
4154 Move(pvx,SvPVX(sv),len,char);
4156 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4158 else if (IN_PERL_RUNTIME)
4159 Perl_croak(aTHX_ PL_no_modify);
4163 sv_unref_flags(sv, flags);
4164 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4171 Efficient removal of characters from the beginning of the string buffer.
4172 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4173 the string buffer. The C<ptr> becomes the first character of the adjusted
4174 string. Uses the "OOK hack".
4175 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4176 refer to the same chunk of data.
4182 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4184 register STRLEN delta;
4185 if (!ptr || !SvPOKp(sv))
4187 delta = ptr - SvPVX_const(sv);
4188 SV_CHECK_THINKFIRST(sv);
4189 if (SvTYPE(sv) < SVt_PVIV)
4190 sv_upgrade(sv,SVt_PVIV);
4193 if (!SvLEN(sv)) { /* make copy of shared string */
4194 const char *pvx = SvPVX_const(sv);
4195 const STRLEN len = SvCUR(sv);
4196 SvGROW(sv, len + 1);
4197 Move(pvx,SvPVX(sv),len,char);
4201 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4202 and we do that anyway inside the SvNIOK_off
4204 SvFLAGS(sv) |= SVf_OOK;
4207 SvLEN_set(sv, SvLEN(sv) - delta);
4208 SvCUR_set(sv, SvCUR(sv) - delta);
4209 SvPV_set(sv, SvPVX(sv) + delta);
4210 SvIV_set(sv, SvIVX(sv) + delta);
4214 =for apidoc sv_catpvn
4216 Concatenates the string onto the end of the string which is in the SV. The
4217 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4218 status set, then the bytes appended should be valid UTF-8.
4219 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4221 =for apidoc sv_catpvn_flags
4223 Concatenates the string onto the end of the string which is in the SV. The
4224 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4225 status set, then the bytes appended should be valid UTF-8.
4226 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4227 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4228 in terms of this function.
4234 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4238 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4240 SvGROW(dsv, dlen + slen + 1);
4242 sstr = SvPVX_const(dsv);
4243 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4244 SvCUR_set(dsv, SvCUR(dsv) + slen);
4246 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4248 if (flags & SV_SMAGIC)
4253 =for apidoc sv_catsv
4255 Concatenates the string from SV C<ssv> onto the end of the string in
4256 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4257 not 'set' magic. See C<sv_catsv_mg>.
4259 =for apidoc sv_catsv_flags
4261 Concatenates the string from SV C<ssv> onto the end of the string in
4262 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4263 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4264 and C<sv_catsv_nomg> are implemented in terms of this function.
4269 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4274 const char *spv = SvPV_const(ssv, slen);
4276 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4277 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4278 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4279 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4280 dsv->sv_flags doesn't have that bit set.
4281 Andy Dougherty 12 Oct 2001
4283 const I32 sutf8 = DO_UTF8(ssv);
4286 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4288 dutf8 = DO_UTF8(dsv);
4290 if (dutf8 != sutf8) {
4292 /* Not modifying source SV, so taking a temporary copy. */
4293 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4295 sv_utf8_upgrade(csv);
4296 spv = SvPV_const(csv, slen);
4299 sv_utf8_upgrade_nomg(dsv);
4301 sv_catpvn_nomg(dsv, spv, slen);
4304 if (flags & SV_SMAGIC)
4309 =for apidoc sv_catpv
4311 Concatenates the string onto the end of the string which is in the SV.
4312 If the SV has the UTF-8 status set, then the bytes appended should be
4313 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4318 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4321 register STRLEN len;
4327 junk = SvPV_force(sv, tlen);
4329 SvGROW(sv, tlen + len + 1);
4331 ptr = SvPVX_const(sv);
4332 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4333 SvCUR_set(sv, SvCUR(sv) + len);
4334 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4339 =for apidoc sv_catpv_mg
4341 Like C<sv_catpv>, but also handles 'set' magic.
4347 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4356 Creates a new SV. A non-zero C<len> parameter indicates the number of
4357 bytes of preallocated string space the SV should have. An extra byte for a
4358 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4359 space is allocated.) The reference count for the new SV is set to 1.
4361 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4362 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4363 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4364 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4365 modules supporting older perls.
4371 Perl_newSV(pTHX_ STRLEN len)
4378 sv_upgrade(sv, SVt_PV);
4379 SvGROW(sv, len + 1);
4384 =for apidoc sv_magicext
4386 Adds magic to an SV, upgrading it if necessary. Applies the
4387 supplied vtable and returns a pointer to the magic added.
4389 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4390 In particular, you can add magic to SvREADONLY SVs, and add more than
4391 one instance of the same 'how'.
4393 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4394 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4395 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4396 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4398 (This is now used as a subroutine by C<sv_magic>.)
4403 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4404 const char* name, I32 namlen)
4409 SvUPGRADE(sv, SVt_PVMG);
4410 Newxz(mg, 1, MAGIC);
4411 mg->mg_moremagic = SvMAGIC(sv);
4412 SvMAGIC_set(sv, mg);
4414 /* Sometimes a magic contains a reference loop, where the sv and
4415 object refer to each other. To prevent a reference loop that
4416 would prevent such objects being freed, we look for such loops
4417 and if we find one we avoid incrementing the object refcount.
4419 Note we cannot do this to avoid self-tie loops as intervening RV must
4420 have its REFCNT incremented to keep it in existence.
4423 if (!obj || obj == sv ||
4424 how == PERL_MAGIC_arylen ||
4425 how == PERL_MAGIC_qr ||
4426 how == PERL_MAGIC_symtab ||
4427 (SvTYPE(obj) == SVt_PVGV &&
4428 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4429 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4430 GvFORM(obj) == (CV*)sv)))
4435 mg->mg_obj = SvREFCNT_inc_simple(obj);
4436 mg->mg_flags |= MGf_REFCOUNTED;
4439 /* Normal self-ties simply pass a null object, and instead of
4440 using mg_obj directly, use the SvTIED_obj macro to produce a
4441 new RV as needed. For glob "self-ties", we are tieing the PVIO
4442 with an RV obj pointing to the glob containing the PVIO. In
4443 this case, to avoid a reference loop, we need to weaken the
4447 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4448 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4454 mg->mg_len = namlen;
4457 mg->mg_ptr = savepvn(name, namlen);
4458 else if (namlen == HEf_SVKEY)
4459 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4461 mg->mg_ptr = (char *) name;
4463 mg->mg_virtual = (MGVTBL *) vtable;
4467 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4472 =for apidoc sv_magic
4474 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4475 then adds a new magic item of type C<how> to the head of the magic list.
4477 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4478 handling of the C<name> and C<namlen> arguments.
4480 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4481 to add more than one instance of the same 'how'.
4487 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4490 const MGVTBL *vtable;
4493 #ifdef PERL_OLD_COPY_ON_WRITE
4495 sv_force_normal_flags(sv, 0);
4497 if (SvREADONLY(sv)) {
4499 /* its okay to attach magic to shared strings; the subsequent
4500 * upgrade to PVMG will unshare the string */
4501 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4504 && how != PERL_MAGIC_regex_global
4505 && how != PERL_MAGIC_bm
4506 && how != PERL_MAGIC_fm
4507 && how != PERL_MAGIC_sv
4508 && how != PERL_MAGIC_backref
4511 Perl_croak(aTHX_ PL_no_modify);
4514 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4515 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4516 /* sv_magic() refuses to add a magic of the same 'how' as an
4519 if (how == PERL_MAGIC_taint) {
4521 /* Any scalar which already had taint magic on which someone
4522 (erroneously?) did SvIOK_on() or similar will now be
4523 incorrectly sporting public "OK" flags. */
4524 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4532 vtable = &PL_vtbl_sv;
4534 case PERL_MAGIC_overload:
4535 vtable = &PL_vtbl_amagic;
4537 case PERL_MAGIC_overload_elem:
4538 vtable = &PL_vtbl_amagicelem;
4540 case PERL_MAGIC_overload_table:
4541 vtable = &PL_vtbl_ovrld;
4544 vtable = &PL_vtbl_bm;
4546 case PERL_MAGIC_regdata:
4547 vtable = &PL_vtbl_regdata;
4549 case PERL_MAGIC_regdatum:
4550 vtable = &PL_vtbl_regdatum;
4552 case PERL_MAGIC_env:
4553 vtable = &PL_vtbl_env;
4556 vtable = &PL_vtbl_fm;
4558 case PERL_MAGIC_envelem:
4559 vtable = &PL_vtbl_envelem;
4561 case PERL_MAGIC_regex_global:
4562 vtable = &PL_vtbl_mglob;
4564 case PERL_MAGIC_isa:
4565 vtable = &PL_vtbl_isa;
4567 case PERL_MAGIC_isaelem:
4568 vtable = &PL_vtbl_isaelem;
4570 case PERL_MAGIC_nkeys:
4571 vtable = &PL_vtbl_nkeys;
4573 case PERL_MAGIC_dbfile:
4576 case PERL_MAGIC_dbline:
4577 vtable = &PL_vtbl_dbline;
4579 #ifdef USE_LOCALE_COLLATE
4580 case PERL_MAGIC_collxfrm:
4581 vtable = &PL_vtbl_collxfrm;
4583 #endif /* USE_LOCALE_COLLATE */
4584 case PERL_MAGIC_tied:
4585 vtable = &PL_vtbl_pack;
4587 case PERL_MAGIC_tiedelem:
4588 case PERL_MAGIC_tiedscalar:
4589 vtable = &PL_vtbl_packelem;
4592 vtable = &PL_vtbl_regexp;
4594 case PERL_MAGIC_hints:
4595 /* As this vtable is all NULL, we can reuse it. */
4596 case PERL_MAGIC_sig:
4597 vtable = &PL_vtbl_sig;
4599 case PERL_MAGIC_sigelem:
4600 vtable = &PL_vtbl_sigelem;
4602 case PERL_MAGIC_taint:
4603 vtable = &PL_vtbl_taint;
4605 case PERL_MAGIC_uvar:
4606 vtable = &PL_vtbl_uvar;
4608 case PERL_MAGIC_vec:
4609 vtable = &PL_vtbl_vec;
4611 case PERL_MAGIC_arylen_p:
4612 case PERL_MAGIC_rhash:
4613 case PERL_MAGIC_symtab:
4614 case PERL_MAGIC_vstring:
4617 case PERL_MAGIC_utf8:
4618 vtable = &PL_vtbl_utf8;
4620 case PERL_MAGIC_substr:
4621 vtable = &PL_vtbl_substr;
4623 case PERL_MAGIC_defelem:
4624 vtable = &PL_vtbl_defelem;
4626 case PERL_MAGIC_arylen:
4627 vtable = &PL_vtbl_arylen;
4629 case PERL_MAGIC_pos:
4630 vtable = &PL_vtbl_pos;
4632 case PERL_MAGIC_backref:
4633 vtable = &PL_vtbl_backref;
4635 case PERL_MAGIC_hintselem:
4636 vtable = &PL_vtbl_hintselem;
4638 case PERL_MAGIC_ext:
4639 /* Reserved for use by extensions not perl internals. */
4640 /* Useful for attaching extension internal data to perl vars. */
4641 /* Note that multiple extensions may clash if magical scalars */
4642 /* etc holding private data from one are passed to another. */
4646 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4649 /* Rest of work is done else where */
4650 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4653 case PERL_MAGIC_taint:
4656 case PERL_MAGIC_ext:
4657 case PERL_MAGIC_dbfile:
4664 =for apidoc sv_unmagic
4666 Removes all magic of type C<type> from an SV.
4672 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4676 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4678 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4679 for (mg = *mgp; mg; mg = *mgp) {
4680 if (mg->mg_type == type) {
4681 const MGVTBL* const vtbl = mg->mg_virtual;
4682 *mgp = mg->mg_moremagic;
4683 if (vtbl && vtbl->svt_free)
4684 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4685 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4687 Safefree(mg->mg_ptr);
4688 else if (mg->mg_len == HEf_SVKEY)
4689 SvREFCNT_dec((SV*)mg->mg_ptr);
4690 else if (mg->mg_type == PERL_MAGIC_utf8)
4691 Safefree(mg->mg_ptr);
4693 if (mg->mg_flags & MGf_REFCOUNTED)
4694 SvREFCNT_dec(mg->mg_obj);
4698 mgp = &mg->mg_moremagic;
4702 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4703 SvMAGIC_set(sv, NULL);
4710 =for apidoc sv_rvweaken
4712 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4713 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4714 push a back-reference to this RV onto the array of backreferences
4715 associated with that magic. If the RV is magical, set magic will be
4716 called after the RV is cleared.
4722 Perl_sv_rvweaken(pTHX_ SV *sv)
4725 if (!SvOK(sv)) /* let undefs pass */
4728 Perl_croak(aTHX_ "Can't weaken a nonreference");
4729 else if (SvWEAKREF(sv)) {
4730 if (ckWARN(WARN_MISC))
4731 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4735 Perl_sv_add_backref(aTHX_ tsv, sv);
4741 /* Give tsv backref magic if it hasn't already got it, then push a
4742 * back-reference to sv onto the array associated with the backref magic.
4746 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4751 if (SvTYPE(tsv) == SVt_PVHV) {
4752 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4756 /* There is no AV in the offical place - try a fixup. */
4757 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4760 /* Aha. They've got it stowed in magic. Bring it back. */
4761 av = (AV*)mg->mg_obj;
4762 /* Stop mg_free decreasing the refernce count. */
4764 /* Stop mg_free even calling the destructor, given that
4765 there's no AV to free up. */
4767 sv_unmagic(tsv, PERL_MAGIC_backref);
4771 SvREFCNT_inc_simple_void(av);
4776 const MAGIC *const mg
4777 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4779 av = (AV*)mg->mg_obj;
4783 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4784 /* av now has a refcnt of 2, which avoids it getting freed
4785 * before us during global cleanup. The extra ref is removed
4786 * by magic_killbackrefs() when tsv is being freed */
4789 if (AvFILLp(av) >= AvMAX(av)) {
4790 av_extend(av, AvFILLp(av)+1);
4792 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4795 /* delete a back-reference to ourselves from the backref magic associated
4796 * with the SV we point to.
4800 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4807 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4808 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4809 /* We mustn't attempt to "fix up" the hash here by moving the
4810 backreference array back to the hv_aux structure, as that is stored
4811 in the main HvARRAY(), and hfreentries assumes that no-one
4812 reallocates HvARRAY() while it is running. */
4815 const MAGIC *const mg
4816 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4818 av = (AV *)mg->mg_obj;
4821 if (PL_in_clean_all)
4823 Perl_croak(aTHX_ "panic: del_backref");
4830 /* We shouldn't be in here more than once, but for paranoia reasons lets
4832 for (i = AvFILLp(av); i >= 0; i--) {
4834 const SSize_t fill = AvFILLp(av);
4836 /* We weren't the last entry.
4837 An unordered list has this property that you can take the
4838 last element off the end to fill the hole, and it's still
4839 an unordered list :-)
4844 AvFILLp(av) = fill - 1;
4850 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4852 SV **svp = AvARRAY(av);
4854 PERL_UNUSED_ARG(sv);
4856 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4857 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4858 if (svp && !SvIS_FREED(av)) {
4859 SV *const *const last = svp + AvFILLp(av);
4861 while (svp <= last) {
4863 SV *const referrer = *svp;
4864 if (SvWEAKREF(referrer)) {
4865 /* XXX Should we check that it hasn't changed? */
4866 SvRV_set(referrer, 0);
4868 SvWEAKREF_off(referrer);
4869 SvSETMAGIC(referrer);
4870 } else if (SvTYPE(referrer) == SVt_PVGV ||
4871 SvTYPE(referrer) == SVt_PVLV) {
4872 /* You lookin' at me? */
4873 assert(GvSTASH(referrer));
4874 assert(GvSTASH(referrer) == (HV*)sv);
4875 GvSTASH(referrer) = 0;
4878 "panic: magic_killbackrefs (flags=%"UVxf")",
4879 (UV)SvFLAGS(referrer));
4887 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4892 =for apidoc sv_insert
4894 Inserts a string at the specified offset/length within the SV. Similar to
4895 the Perl substr() function.
4901 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4906 register char *midend;
4907 register char *bigend;
4913 Perl_croak(aTHX_ "Can't modify non-existent substring");
4914 SvPV_force(bigstr, curlen);
4915 (void)SvPOK_only_UTF8(bigstr);
4916 if (offset + len > curlen) {
4917 SvGROW(bigstr, offset+len+1);
4918 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4919 SvCUR_set(bigstr, offset+len);
4923 i = littlelen - len;
4924 if (i > 0) { /* string might grow */
4925 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4926 mid = big + offset + len;
4927 midend = bigend = big + SvCUR(bigstr);
4930 while (midend > mid) /* shove everything down */
4931 *--bigend = *--midend;
4932 Move(little,big+offset,littlelen,char);
4933 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4938 Move(little,SvPVX(bigstr)+offset,len,char);
4943 big = SvPVX(bigstr);
4946 bigend = big + SvCUR(bigstr);
4948 if (midend > bigend)
4949 Perl_croak(aTHX_ "panic: sv_insert");
4951 if (mid - big > bigend - midend) { /* faster to shorten from end */
4953 Move(little, mid, littlelen,char);
4956 i = bigend - midend;
4958 Move(midend, mid, i,char);
4962 SvCUR_set(bigstr, mid - big);
4964 else if ((i = mid - big)) { /* faster from front */
4965 midend -= littlelen;
4967 sv_chop(bigstr,midend-i);
4972 Move(little, mid, littlelen,char);
4974 else if (littlelen) {
4975 midend -= littlelen;
4976 sv_chop(bigstr,midend);
4977 Move(little,midend,littlelen,char);
4980 sv_chop(bigstr,midend);
4986 =for apidoc sv_replace
4988 Make the first argument a copy of the second, then delete the original.
4989 The target SV physically takes over ownership of the body of the source SV
4990 and inherits its flags; however, the target keeps any magic it owns,
4991 and any magic in the source is discarded.
4992 Note that this is a rather specialist SV copying operation; most of the
4993 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4999 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5002 const U32 refcnt = SvREFCNT(sv);
5003 SV_CHECK_THINKFIRST_COW_DROP(sv);
5004 if (SvREFCNT(nsv) != 1) {
5005 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5006 UVuf " != 1)", (UV) SvREFCNT(nsv));
5008 if (SvMAGICAL(sv)) {
5012 sv_upgrade(nsv, SVt_PVMG);
5013 SvMAGIC_set(nsv, SvMAGIC(sv));
5014 SvFLAGS(nsv) |= SvMAGICAL(sv);
5016 SvMAGIC_set(sv, NULL);
5020 assert(!SvREFCNT(sv));
5021 #ifdef DEBUG_LEAKING_SCALARS
5022 sv->sv_flags = nsv->sv_flags;
5023 sv->sv_any = nsv->sv_any;
5024 sv->sv_refcnt = nsv->sv_refcnt;
5025 sv->sv_u = nsv->sv_u;
5027 StructCopy(nsv,sv,SV);
5029 /* Currently could join these into one piece of pointer arithmetic, but
5030 it would be unclear. */
5031 if(SvTYPE(sv) == SVt_IV)
5033 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5034 else if (SvTYPE(sv) == SVt_RV) {
5035 SvANY(sv) = &sv->sv_u.svu_rv;
5039 #ifdef PERL_OLD_COPY_ON_WRITE
5040 if (SvIsCOW_normal(nsv)) {
5041 /* We need to follow the pointers around the loop to make the
5042 previous SV point to sv, rather than nsv. */
5045 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5048 assert(SvPVX_const(current) == SvPVX_const(nsv));
5050 /* Make the SV before us point to the SV after us. */
5052 PerlIO_printf(Perl_debug_log, "previous is\n");
5054 PerlIO_printf(Perl_debug_log,
5055 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5056 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5058 SV_COW_NEXT_SV_SET(current, sv);
5061 SvREFCNT(sv) = refcnt;
5062 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5068 =for apidoc sv_clear
5070 Clear an SV: call any destructors, free up any memory used by the body,
5071 and free the body itself. The SV's head is I<not> freed, although
5072 its type is set to all 1's so that it won't inadvertently be assumed
5073 to be live during global destruction etc.
5074 This function should only be called when REFCNT is zero. Most of the time
5075 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5082 Perl_sv_clear(pTHX_ register SV *sv)
5085 const U32 type = SvTYPE(sv);
5086 const struct body_details *const sv_type_details
5087 = bodies_by_type + type;
5091 assert(SvREFCNT(sv) == 0);
5093 if (type <= SVt_IV) {
5094 /* See the comment in sv.h about the collusion between this early
5095 return and the overloading of the NULL and IV slots in the size
5101 if (PL_defstash) { /* Still have a symbol table? */
5106 stash = SvSTASH(sv);
5107 destructor = StashHANDLER(stash,DESTROY);
5109 SV* const tmpref = newRV(sv);
5110 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5112 PUSHSTACKi(PERLSI_DESTROY);
5117 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5123 if(SvREFCNT(tmpref) < 2) {
5124 /* tmpref is not kept alive! */
5126 SvRV_set(tmpref, NULL);
5129 SvREFCNT_dec(tmpref);
5131 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5135 if (PL_in_clean_objs)
5136 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5138 /* DESTROY gave object new lease on life */
5144 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5145 SvOBJECT_off(sv); /* Curse the object. */
5146 if (type != SVt_PVIO)
5147 --PL_sv_objcount; /* XXX Might want something more general */
5150 if (type >= SVt_PVMG) {
5151 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5152 SvREFCNT_dec(SvOURSTASH(sv));
5153 } else if (SvMAGIC(sv))
5155 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5156 SvREFCNT_dec(SvSTASH(sv));
5159 /* case SVt_BIND: */
5162 IoIFP(sv) != PerlIO_stdin() &&
5163 IoIFP(sv) != PerlIO_stdout() &&
5164 IoIFP(sv) != PerlIO_stderr())
5166 io_close((IO*)sv, FALSE);
5168 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5169 PerlDir_close(IoDIRP(sv));
5170 IoDIRP(sv) = (DIR*)NULL;
5171 Safefree(IoTOP_NAME(sv));
5172 Safefree(IoFMT_NAME(sv));
5173 Safefree(IoBOTTOM_NAME(sv));
5180 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5184 if (PL_comppad == (AV*)sv) {
5191 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5192 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5193 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5194 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5196 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5197 SvREFCNT_dec(LvTARG(sv));
5199 if (isGV_with_GP(sv)) {
5200 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5201 mro_method_changed_in(stash);
5204 unshare_hek(GvNAME_HEK(sv));
5205 /* If we're in a stash, we don't own a reference to it. However it does
5206 have a back reference to us, which needs to be cleared. */
5207 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5208 sv_del_backref((SV*)stash, sv);
5210 /* FIXME. There are probably more unreferenced pointers to SVs in the
5211 interpreter struct that we should check and tidy in a similar
5213 if ((GV*)sv == PL_last_in_gv)
5214 PL_last_in_gv = NULL;
5219 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5221 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5222 /* Don't even bother with turning off the OOK flag. */
5227 SV * const target = SvRV(sv);
5229 sv_del_backref(target, sv);
5231 SvREFCNT_dec(target);
5233 #ifdef PERL_OLD_COPY_ON_WRITE
5234 else if (SvPVX_const(sv)) {
5236 /* I believe I need to grab the global SV mutex here and
5237 then recheck the COW status. */
5239 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5243 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5245 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5248 /* And drop it here. */
5250 } else if (SvLEN(sv)) {
5251 Safefree(SvPVX_const(sv));
5255 else if (SvPVX_const(sv) && SvLEN(sv))
5256 Safefree(SvPVX_mutable(sv));
5257 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5258 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5267 SvFLAGS(sv) &= SVf_BREAK;
5268 SvFLAGS(sv) |= SVTYPEMASK;
5270 if (sv_type_details->arena) {
5271 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5272 &PL_body_roots[type]);
5274 else if (sv_type_details->body_size) {
5275 my_safefree(SvANY(sv));
5280 =for apidoc sv_newref
5282 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5289 Perl_sv_newref(pTHX_ SV *sv)
5291 PERL_UNUSED_CONTEXT;
5300 Decrement an SV's reference count, and if it drops to zero, call
5301 C<sv_clear> to invoke destructors and free up any memory used by
5302 the body; finally, deallocate the SV's head itself.
5303 Normally called via a wrapper macro C<SvREFCNT_dec>.
5309 Perl_sv_free(pTHX_ SV *sv)
5314 if (SvREFCNT(sv) == 0) {
5315 if (SvFLAGS(sv) & SVf_BREAK)
5316 /* this SV's refcnt has been artificially decremented to
5317 * trigger cleanup */
5319 if (PL_in_clean_all) /* All is fair */
5321 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5322 /* make sure SvREFCNT(sv)==0 happens very seldom */
5323 SvREFCNT(sv) = (~(U32)0)/2;
5326 if (ckWARN_d(WARN_INTERNAL)) {
5327 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5328 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5329 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5330 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5331 Perl_dump_sv_child(aTHX_ sv);
5333 #ifdef DEBUG_LEAKING_SCALARS
5340 if (--(SvREFCNT(sv)) > 0)
5342 Perl_sv_free2(aTHX_ sv);
5346 Perl_sv_free2(pTHX_ SV *sv)
5351 if (ckWARN_d(WARN_DEBUGGING))
5352 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5353 "Attempt to free temp prematurely: SV 0x%"UVxf
5354 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5358 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5359 /* make sure SvREFCNT(sv)==0 happens very seldom */
5360 SvREFCNT(sv) = (~(U32)0)/2;
5371 Returns the length of the string in the SV. Handles magic and type
5372 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5378 Perl_sv_len(pTHX_ register SV *sv)
5386 len = mg_length(sv);
5388 (void)SvPV_const(sv, len);
5393 =for apidoc sv_len_utf8
5395 Returns the number of characters in the string in an SV, counting wide
5396 UTF-8 bytes as a single character. Handles magic and type coercion.
5402 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5403 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5404 * (Note that the mg_len is not the length of the mg_ptr field.
5405 * This allows the cache to store the character length of the string without
5406 * needing to malloc() extra storage to attach to the mg_ptr.)
5411 Perl_sv_len_utf8(pTHX_ register SV *sv)
5417 return mg_length(sv);
5421 const U8 *s = (U8*)SvPV_const(sv, len);
5425 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5427 if (mg && mg->mg_len != -1) {
5429 if (PL_utf8cache < 0) {
5430 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5432 /* Need to turn the assertions off otherwise we may
5433 recurse infinitely while printing error messages.
5435 SAVEI8(PL_utf8cache);
5437 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5438 " real %"UVuf" for %"SVf,
5439 (UV) ulen, (UV) real, SVfARG(sv));
5444 ulen = Perl_utf8_length(aTHX_ s, s + len);
5445 if (!SvREADONLY(sv)) {
5447 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5448 &PL_vtbl_utf8, 0, 0);
5456 return Perl_utf8_length(aTHX_ s, s + len);
5460 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5463 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5466 const U8 *s = start;
5468 while (s < send && uoffset--)
5471 /* This is the existing behaviour. Possibly it should be a croak, as
5472 it's actually a bounds error */
5478 /* Given the length of the string in both bytes and UTF-8 characters, decide
5479 whether to walk forwards or backwards to find the byte corresponding to
5480 the passed in UTF-8 offset. */
5482 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5483 STRLEN uoffset, STRLEN uend)
5485 STRLEN backw = uend - uoffset;
5486 if (uoffset < 2 * backw) {
5487 /* The assumption is that going forwards is twice the speed of going
5488 forward (that's where the 2 * backw comes from).
5489 (The real figure of course depends on the UTF-8 data.) */
5490 return sv_pos_u2b_forwards(start, send, uoffset);
5495 while (UTF8_IS_CONTINUATION(*send))
5498 return send - start;
5501 /* For the string representation of the given scalar, find the byte
5502 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5503 give another position in the string, *before* the sought offset, which
5504 (which is always true, as 0, 0 is a valid pair of positions), which should
5505 help reduce the amount of linear searching.
5506 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5507 will be used to reduce the amount of linear searching. The cache will be
5508 created if necessary, and the found value offered to it for update. */
5510 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5511 const U8 *const send, STRLEN uoffset,
5512 STRLEN uoffset0, STRLEN boffset0) {
5513 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5516 assert (uoffset >= uoffset0);
5518 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5519 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5520 if ((*mgp)->mg_ptr) {
5521 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5522 if (cache[0] == uoffset) {
5523 /* An exact match. */
5526 if (cache[2] == uoffset) {
5527 /* An exact match. */
5531 if (cache[0] < uoffset) {
5532 /* The cache already knows part of the way. */
5533 if (cache[0] > uoffset0) {
5534 /* The cache knows more than the passed in pair */
5535 uoffset0 = cache[0];
5536 boffset0 = cache[1];
5538 if ((*mgp)->mg_len != -1) {
5539 /* And we know the end too. */
5541 + sv_pos_u2b_midway(start + boffset0, send,
5543 (*mgp)->mg_len - uoffset0);
5546 + sv_pos_u2b_forwards(start + boffset0,
5547 send, uoffset - uoffset0);
5550 else if (cache[2] < uoffset) {
5551 /* We're between the two cache entries. */
5552 if (cache[2] > uoffset0) {
5553 /* and the cache knows more than the passed in pair */
5554 uoffset0 = cache[2];
5555 boffset0 = cache[3];
5559 + sv_pos_u2b_midway(start + boffset0,
5562 cache[0] - uoffset0);
5565 + sv_pos_u2b_midway(start + boffset0,
5568 cache[2] - uoffset0);
5572 else if ((*mgp)->mg_len != -1) {
5573 /* If we can take advantage of a passed in offset, do so. */
5574 /* In fact, offset0 is either 0, or less than offset, so don't
5575 need to worry about the other possibility. */
5577 + sv_pos_u2b_midway(start + boffset0, send,
5579 (*mgp)->mg_len - uoffset0);
5584 if (!found || PL_utf8cache < 0) {
5585 const STRLEN real_boffset
5586 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5587 send, uoffset - uoffset0);
5589 if (found && PL_utf8cache < 0) {
5590 if (real_boffset != boffset) {
5591 /* Need to turn the assertions off otherwise we may recurse
5592 infinitely while printing error messages. */
5593 SAVEI8(PL_utf8cache);
5595 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5596 " real %"UVuf" for %"SVf,
5597 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5600 boffset = real_boffset;
5603 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5609 =for apidoc sv_pos_u2b
5611 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5612 the start of the string, to a count of the equivalent number of bytes; if
5613 lenp is non-zero, it does the same to lenp, but this time starting from
5614 the offset, rather than from the start of the string. Handles magic and
5621 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5622 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5623 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5628 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5636 start = (U8*)SvPV_const(sv, len);
5638 STRLEN uoffset = (STRLEN) *offsetp;
5639 const U8 * const send = start + len;
5641 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5644 *offsetp = (I32) boffset;
5647 /* Convert the relative offset to absolute. */
5648 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5649 const STRLEN boffset2
5650 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5651 uoffset, boffset) - boffset;
5665 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5666 byte length pairing. The (byte) length of the total SV is passed in too,
5667 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5668 may not have updated SvCUR, so we can't rely on reading it directly.
5670 The proffered utf8/byte length pairing isn't used if the cache already has
5671 two pairs, and swapping either for the proffered pair would increase the
5672 RMS of the intervals between known byte offsets.
5674 The cache itself consists of 4 STRLEN values
5675 0: larger UTF-8 offset
5676 1: corresponding byte offset
5677 2: smaller UTF-8 offset
5678 3: corresponding byte offset
5680 Unused cache pairs have the value 0, 0.
5681 Keeping the cache "backwards" means that the invariant of
5682 cache[0] >= cache[2] is maintained even with empty slots, which means that
5683 the code that uses it doesn't need to worry if only 1 entry has actually
5684 been set to non-zero. It also makes the "position beyond the end of the
5685 cache" logic much simpler, as the first slot is always the one to start
5689 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5697 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5699 (*mgp)->mg_len = -1;
5703 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5704 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5705 (*mgp)->mg_ptr = (char *) cache;
5709 if (PL_utf8cache < 0) {
5710 const U8 *start = (const U8 *) SvPVX_const(sv);
5711 const STRLEN realutf8 = utf8_length(start, start + byte);
5713 if (realutf8 != utf8) {
5714 /* Need to turn the assertions off otherwise we may recurse
5715 infinitely while printing error messages. */
5716 SAVEI8(PL_utf8cache);
5718 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5719 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5723 /* Cache is held with the later position first, to simplify the code
5724 that deals with unbounded ends. */
5726 ASSERT_UTF8_CACHE(cache);
5727 if (cache[1] == 0) {
5728 /* Cache is totally empty */
5731 } else if (cache[3] == 0) {
5732 if (byte > cache[1]) {
5733 /* New one is larger, so goes first. */
5734 cache[2] = cache[0];
5735 cache[3] = cache[1];
5743 #define THREEWAY_SQUARE(a,b,c,d) \
5744 ((float)((d) - (c))) * ((float)((d) - (c))) \
5745 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5746 + ((float)((b) - (a))) * ((float)((b) - (a)))
5748 /* Cache has 2 slots in use, and we know three potential pairs.
5749 Keep the two that give the lowest RMS distance. Do the
5750 calcualation in bytes simply because we always know the byte
5751 length. squareroot has the same ordering as the positive value,
5752 so don't bother with the actual square root. */
5753 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5754 if (byte > cache[1]) {
5755 /* New position is after the existing pair of pairs. */
5756 const float keep_earlier
5757 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5758 const float keep_later
5759 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5761 if (keep_later < keep_earlier) {
5762 if (keep_later < existing) {
5763 cache[2] = cache[0];
5764 cache[3] = cache[1];
5770 if (keep_earlier < existing) {
5776 else if (byte > cache[3]) {
5777 /* New position is between the existing pair of pairs. */
5778 const float keep_earlier
5779 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5780 const float keep_later
5781 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5783 if (keep_later < keep_earlier) {
5784 if (keep_later < existing) {
5790 if (keep_earlier < existing) {
5797 /* New position is before the existing pair of pairs. */
5798 const float keep_earlier
5799 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5800 const float keep_later
5801 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5803 if (keep_later < keep_earlier) {
5804 if (keep_later < existing) {
5810 if (keep_earlier < existing) {
5811 cache[0] = cache[2];
5812 cache[1] = cache[3];
5819 ASSERT_UTF8_CACHE(cache);
5822 /* We already know all of the way, now we may be able to walk back. The same
5823 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5824 backward is half the speed of walking forward. */
5826 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5829 const STRLEN forw = target - s;
5830 STRLEN backw = end - target;
5832 if (forw < 2 * backw) {
5833 return utf8_length(s, target);
5836 while (end > target) {
5838 while (UTF8_IS_CONTINUATION(*end)) {
5847 =for apidoc sv_pos_b2u
5849 Converts the value pointed to by offsetp from a count of bytes from the
5850 start of the string, to a count of the equivalent number of UTF-8 chars.
5851 Handles magic and type coercion.
5857 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5858 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5863 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5866 const STRLEN byte = *offsetp;
5867 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5876 s = (const U8*)SvPV_const(sv, blen);
5879 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5883 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5884 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5886 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5887 if (cache[1] == byte) {
5888 /* An exact match. */
5889 *offsetp = cache[0];
5892 if (cache[3] == byte) {
5893 /* An exact match. */
5894 *offsetp = cache[2];
5898 if (cache[1] < byte) {
5899 /* We already know part of the way. */
5900 if (mg->mg_len != -1) {
5901 /* Actually, we know the end too. */
5903 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5904 s + blen, mg->mg_len - cache[0]);
5906 len = cache[0] + utf8_length(s + cache[1], send);
5909 else if (cache[3] < byte) {
5910 /* We're between the two cached pairs, so we do the calculation
5911 offset by the byte/utf-8 positions for the earlier pair,
5912 then add the utf-8 characters from the string start to
5914 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5915 s + cache[1], cache[0] - cache[2])
5919 else { /* cache[3] > byte */
5920 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5924 ASSERT_UTF8_CACHE(cache);
5926 } else if (mg->mg_len != -1) {
5927 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5931 if (!found || PL_utf8cache < 0) {
5932 const STRLEN real_len = utf8_length(s, send);
5934 if (found && PL_utf8cache < 0) {
5935 if (len != real_len) {
5936 /* Need to turn the assertions off otherwise we may recurse
5937 infinitely while printing error messages. */
5938 SAVEI8(PL_utf8cache);
5940 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5941 " real %"UVuf" for %"SVf,
5942 (UV) len, (UV) real_len, SVfARG(sv));
5949 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5955 Returns a boolean indicating whether the strings in the two SVs are
5956 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5957 coerce its args to strings if necessary.
5963 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5972 SV* svrecode = NULL;
5979 /* if pv1 and pv2 are the same, second SvPV_const call may
5980 * invalidate pv1, so we may need to make a copy */
5981 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5982 pv1 = SvPV_const(sv1, cur1);
5983 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5984 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5986 pv1 = SvPV_const(sv1, cur1);
5994 pv2 = SvPV_const(sv2, cur2);
5996 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5997 /* Differing utf8ness.
5998 * Do not UTF8size the comparands as a side-effect. */
6001 svrecode = newSVpvn(pv2, cur2);
6002 sv_recode_to_utf8(svrecode, PL_encoding);
6003 pv2 = SvPV_const(svrecode, cur2);
6006 svrecode = newSVpvn(pv1, cur1);
6007 sv_recode_to_utf8(svrecode, PL_encoding);
6008 pv1 = SvPV_const(svrecode, cur1);
6010 /* Now both are in UTF-8. */
6012 SvREFCNT_dec(svrecode);
6017 bool is_utf8 = TRUE;
6020 /* sv1 is the UTF-8 one,
6021 * if is equal it must be downgrade-able */
6022 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6028 /* sv2 is the UTF-8 one,
6029 * if is equal it must be downgrade-able */
6030 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6036 /* Downgrade not possible - cannot be eq */
6044 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6046 SvREFCNT_dec(svrecode);
6056 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6057 string in C<sv1> is less than, equal to, or greater than the string in
6058 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6059 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6065 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6069 const char *pv1, *pv2;
6072 SV *svrecode = NULL;
6079 pv1 = SvPV_const(sv1, cur1);
6086 pv2 = SvPV_const(sv2, cur2);
6088 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6089 /* Differing utf8ness.
6090 * Do not UTF8size the comparands as a side-effect. */
6093 svrecode = newSVpvn(pv2, cur2);
6094 sv_recode_to_utf8(svrecode, PL_encoding);
6095 pv2 = SvPV_const(svrecode, cur2);
6098 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6103 svrecode = newSVpvn(pv1, cur1);
6104 sv_recode_to_utf8(svrecode, PL_encoding);
6105 pv1 = SvPV_const(svrecode, cur1);
6108 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6114 cmp = cur2 ? -1 : 0;
6118 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6121 cmp = retval < 0 ? -1 : 1;
6122 } else if (cur1 == cur2) {
6125 cmp = cur1 < cur2 ? -1 : 1;
6129 SvREFCNT_dec(svrecode);
6137 =for apidoc sv_cmp_locale
6139 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6140 'use bytes' aware, handles get magic, and will coerce its args to strings
6141 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6147 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6150 #ifdef USE_LOCALE_COLLATE
6156 if (PL_collation_standard)
6160 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6162 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6164 if (!pv1 || !len1) {
6175 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6178 return retval < 0 ? -1 : 1;
6181 * When the result of collation is equality, that doesn't mean
6182 * that there are no differences -- some locales exclude some
6183 * characters from consideration. So to avoid false equalities,
6184 * we use the raw string as a tiebreaker.
6190 #endif /* USE_LOCALE_COLLATE */
6192 return sv_cmp(sv1, sv2);
6196 #ifdef USE_LOCALE_COLLATE
6199 =for apidoc sv_collxfrm
6201 Add Collate Transform magic to an SV if it doesn't already have it.
6203 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6204 scalar data of the variable, but transformed to such a format that a normal
6205 memory comparison can be used to compare the data according to the locale
6212 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6217 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6218 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6224 Safefree(mg->mg_ptr);
6225 s = SvPV_const(sv, len);
6226 if ((xf = mem_collxfrm(s, len, &xlen))) {
6227 if (SvREADONLY(sv)) {
6230 return xf + sizeof(PL_collation_ix);
6233 #ifdef PERL_OLD_COPY_ON_WRITE
6235 sv_force_normal_flags(sv, 0);
6237 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6251 if (mg && mg->mg_ptr) {
6253 return mg->mg_ptr + sizeof(PL_collation_ix);
6261 #endif /* USE_LOCALE_COLLATE */
6266 Get a line from the filehandle and store it into the SV, optionally
6267 appending to the currently-stored string.
6273 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6278 register STDCHAR rslast;
6279 register STDCHAR *bp;
6284 if (SvTHINKFIRST(sv))
6285 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6286 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6288 However, perlbench says it's slower, because the existing swipe code
6289 is faster than copy on write.
6290 Swings and roundabouts. */
6291 SvUPGRADE(sv, SVt_PV);
6296 if (PerlIO_isutf8(fp)) {
6298 sv_utf8_upgrade_nomg(sv);
6299 sv_pos_u2b(sv,&append,0);
6301 } else if (SvUTF8(sv)) {
6302 SV * const tsv = newSV(0);
6303 sv_gets(tsv, fp, 0);
6304 sv_utf8_upgrade_nomg(tsv);
6305 SvCUR_set(sv,append);
6308 goto return_string_or_null;
6313 if (PerlIO_isutf8(fp))
6316 if (IN_PERL_COMPILETIME) {
6317 /* we always read code in line mode */
6321 else if (RsSNARF(PL_rs)) {
6322 /* If it is a regular disk file use size from stat() as estimate
6323 of amount we are going to read -- may result in mallocing
6324 more memory than we really need if the layers below reduce
6325 the size we read (e.g. CRLF or a gzip layer).
6328 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6329 const Off_t offset = PerlIO_tell(fp);
6330 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6331 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6337 else if (RsRECORD(PL_rs)) {
6342 /* Grab the size of the record we're getting */
6343 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6344 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6347 /* VMS wants read instead of fread, because fread doesn't respect */
6348 /* RMS record boundaries. This is not necessarily a good thing to be */
6349 /* doing, but we've got no other real choice - except avoid stdio
6350 as implementation - perhaps write a :vms layer ?
6352 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6354 bytesread = PerlIO_read(fp, buffer, recsize);
6358 SvCUR_set(sv, bytesread += append);
6359 buffer[bytesread] = '\0';
6360 goto return_string_or_null;
6362 else if (RsPARA(PL_rs)) {
6368 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6369 if (PerlIO_isutf8(fp)) {
6370 rsptr = SvPVutf8(PL_rs, rslen);
6373 if (SvUTF8(PL_rs)) {
6374 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6375 Perl_croak(aTHX_ "Wide character in $/");
6378 rsptr = SvPV_const(PL_rs, rslen);
6382 rslast = rslen ? rsptr[rslen - 1] : '\0';
6384 if (rspara) { /* have to do this both before and after */
6385 do { /* to make sure file boundaries work right */
6388 i = PerlIO_getc(fp);
6392 PerlIO_ungetc(fp,i);
6398 /* See if we know enough about I/O mechanism to cheat it ! */
6400 /* This used to be #ifdef test - it is made run-time test for ease
6401 of abstracting out stdio interface. One call should be cheap
6402 enough here - and may even be a macro allowing compile
6406 if (PerlIO_fast_gets(fp)) {
6409 * We're going to steal some values from the stdio struct
6410 * and put EVERYTHING in the innermost loop into registers.
6412 register STDCHAR *ptr;
6416 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6417 /* An ungetc()d char is handled separately from the regular
6418 * buffer, so we getc() it back out and stuff it in the buffer.
6420 i = PerlIO_getc(fp);
6421 if (i == EOF) return 0;
6422 *(--((*fp)->_ptr)) = (unsigned char) i;
6426 /* Here is some breathtakingly efficient cheating */
6428 cnt = PerlIO_get_cnt(fp); /* get count into register */
6429 /* make sure we have the room */
6430 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6431 /* Not room for all of it
6432 if we are looking for a separator and room for some
6434 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6435 /* just process what we have room for */
6436 shortbuffered = cnt - SvLEN(sv) + append + 1;
6437 cnt -= shortbuffered;
6441 /* remember that cnt can be negative */
6442 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6447 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6448 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6449 DEBUG_P(PerlIO_printf(Perl_debug_log,
6450 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6451 DEBUG_P(PerlIO_printf(Perl_debug_log,
6452 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6453 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6454 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6459 while (cnt > 0) { /* this | eat */
6461 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6462 goto thats_all_folks; /* screams | sed :-) */
6466 Copy(ptr, bp, cnt, char); /* this | eat */
6467 bp += cnt; /* screams | dust */
6468 ptr += cnt; /* louder | sed :-) */
6473 if (shortbuffered) { /* oh well, must extend */
6474 cnt = shortbuffered;
6476 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6478 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6479 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6483 DEBUG_P(PerlIO_printf(Perl_debug_log,
6484 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6485 PTR2UV(ptr),(long)cnt));
6486 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6488 DEBUG_P(PerlIO_printf(Perl_debug_log,
6489 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6490 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6491 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6493 /* This used to call 'filbuf' in stdio form, but as that behaves like
6494 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6495 another abstraction. */
6496 i = PerlIO_getc(fp); /* get more characters */
6498 DEBUG_P(PerlIO_printf(Perl_debug_log,
6499 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6500 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6501 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6503 cnt = PerlIO_get_cnt(fp);
6504 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6505 DEBUG_P(PerlIO_printf(Perl_debug_log,
6506 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6508 if (i == EOF) /* all done for ever? */
6509 goto thats_really_all_folks;
6511 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6513 SvGROW(sv, bpx + cnt + 2);
6514 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6516 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6518 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6519 goto thats_all_folks;
6523 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6524 memNE((char*)bp - rslen, rsptr, rslen))
6525 goto screamer; /* go back to the fray */
6526 thats_really_all_folks:
6528 cnt += shortbuffered;
6529 DEBUG_P(PerlIO_printf(Perl_debug_log,
6530 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6531 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6532 DEBUG_P(PerlIO_printf(Perl_debug_log,
6533 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6534 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6535 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6537 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6538 DEBUG_P(PerlIO_printf(Perl_debug_log,
6539 "Screamer: done, len=%ld, string=|%.*s|\n",
6540 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6544 /*The big, slow, and stupid way. */
6545 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6546 STDCHAR *buf = NULL;
6547 Newx(buf, 8192, STDCHAR);
6555 register const STDCHAR * const bpe = buf + sizeof(buf);
6557 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6558 ; /* keep reading */
6562 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6563 /* Accomodate broken VAXC compiler, which applies U8 cast to
6564 * both args of ?: operator, causing EOF to change into 255
6567 i = (U8)buf[cnt - 1];
6573 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6575 sv_catpvn(sv, (char *) buf, cnt);
6577 sv_setpvn(sv, (char *) buf, cnt);
6579 if (i != EOF && /* joy */
6581 SvCUR(sv) < rslen ||
6582 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6586 * If we're reading from a TTY and we get a short read,
6587 * indicating that the user hit his EOF character, we need
6588 * to notice it now, because if we try to read from the TTY
6589 * again, the EOF condition will disappear.
6591 * The comparison of cnt to sizeof(buf) is an optimization
6592 * that prevents unnecessary calls to feof().
6596 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6600 #ifdef USE_HEAP_INSTEAD_OF_STACK
6605 if (rspara) { /* have to do this both before and after */
6606 while (i != EOF) { /* to make sure file boundaries work right */
6607 i = PerlIO_getc(fp);
6609 PerlIO_ungetc(fp,i);
6615 return_string_or_null:
6616 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6622 Auto-increment of the value in the SV, doing string to numeric conversion
6623 if necessary. Handles 'get' magic.
6629 Perl_sv_inc(pTHX_ register SV *sv)
6638 if (SvTHINKFIRST(sv)) {
6640 sv_force_normal_flags(sv, 0);
6641 if (SvREADONLY(sv)) {
6642 if (IN_PERL_RUNTIME)
6643 Perl_croak(aTHX_ PL_no_modify);
6647 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6649 i = PTR2IV(SvRV(sv));
6654 flags = SvFLAGS(sv);
6655 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6656 /* It's (privately or publicly) a float, but not tested as an
6657 integer, so test it to see. */
6659 flags = SvFLAGS(sv);
6661 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6662 /* It's publicly an integer, or privately an integer-not-float */
6663 #ifdef PERL_PRESERVE_IVUV
6667 if (SvUVX(sv) == UV_MAX)
6668 sv_setnv(sv, UV_MAX_P1);
6670 (void)SvIOK_only_UV(sv);
6671 SvUV_set(sv, SvUVX(sv) + 1);
6673 if (SvIVX(sv) == IV_MAX)
6674 sv_setuv(sv, (UV)IV_MAX + 1);
6676 (void)SvIOK_only(sv);
6677 SvIV_set(sv, SvIVX(sv) + 1);
6682 if (flags & SVp_NOK) {
6683 (void)SvNOK_only(sv);
6684 SvNV_set(sv, SvNVX(sv) + 1.0);
6688 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6689 if ((flags & SVTYPEMASK) < SVt_PVIV)
6690 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6691 (void)SvIOK_only(sv);
6696 while (isALPHA(*d)) d++;
6697 while (isDIGIT(*d)) d++;
6699 #ifdef PERL_PRESERVE_IVUV
6700 /* Got to punt this as an integer if needs be, but we don't issue
6701 warnings. Probably ought to make the sv_iv_please() that does
6702 the conversion if possible, and silently. */
6703 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6704 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6705 /* Need to try really hard to see if it's an integer.
6706 9.22337203685478e+18 is an integer.
6707 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6708 so $a="9.22337203685478e+18"; $a+0; $a++
6709 needs to be the same as $a="9.22337203685478e+18"; $a++
6716 /* sv_2iv *should* have made this an NV */
6717 if (flags & SVp_NOK) {
6718 (void)SvNOK_only(sv);
6719 SvNV_set(sv, SvNVX(sv) + 1.0);
6722 /* I don't think we can get here. Maybe I should assert this
6723 And if we do get here I suspect that sv_setnv will croak. NWC
6725 #if defined(USE_LONG_DOUBLE)
6726 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",
6727 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6729 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6730 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6733 #endif /* PERL_PRESERVE_IVUV */
6734 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6738 while (d >= SvPVX_const(sv)) {
6746 /* MKS: The original code here died if letters weren't consecutive.
6747 * at least it didn't have to worry about non-C locales. The
6748 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6749 * arranged in order (although not consecutively) and that only
6750 * [A-Za-z] are accepted by isALPHA in the C locale.
6752 if (*d != 'z' && *d != 'Z') {
6753 do { ++*d; } while (!isALPHA(*d));
6756 *(d--) -= 'z' - 'a';
6761 *(d--) -= 'z' - 'a' + 1;
6765 /* oh,oh, the number grew */
6766 SvGROW(sv, SvCUR(sv) + 2);
6767 SvCUR_set(sv, SvCUR(sv) + 1);
6768 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6779 Auto-decrement of the value in the SV, doing string to numeric conversion
6780 if necessary. Handles 'get' magic.
6786 Perl_sv_dec(pTHX_ register SV *sv)
6794 if (SvTHINKFIRST(sv)) {
6796 sv_force_normal_flags(sv, 0);
6797 if (SvREADONLY(sv)) {
6798 if (IN_PERL_RUNTIME)
6799 Perl_croak(aTHX_ PL_no_modify);
6803 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6805 i = PTR2IV(SvRV(sv));
6810 /* Unlike sv_inc we don't have to worry about string-never-numbers
6811 and keeping them magic. But we mustn't warn on punting */
6812 flags = SvFLAGS(sv);
6813 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6814 /* It's publicly an integer, or privately an integer-not-float */
6815 #ifdef PERL_PRESERVE_IVUV
6819 if (SvUVX(sv) == 0) {
6820 (void)SvIOK_only(sv);
6824 (void)SvIOK_only_UV(sv);
6825 SvUV_set(sv, SvUVX(sv) - 1);
6828 if (SvIVX(sv) == IV_MIN)
6829 sv_setnv(sv, (NV)IV_MIN - 1.0);
6831 (void)SvIOK_only(sv);
6832 SvIV_set(sv, SvIVX(sv) - 1);
6837 if (flags & SVp_NOK) {
6838 SvNV_set(sv, SvNVX(sv) - 1.0);
6839 (void)SvNOK_only(sv);
6842 if (!(flags & SVp_POK)) {
6843 if ((flags & SVTYPEMASK) < SVt_PVIV)
6844 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6846 (void)SvIOK_only(sv);
6849 #ifdef PERL_PRESERVE_IVUV
6851 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6852 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6853 /* Need to try really hard to see if it's an integer.
6854 9.22337203685478e+18 is an integer.
6855 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6856 so $a="9.22337203685478e+18"; $a+0; $a--
6857 needs to be the same as $a="9.22337203685478e+18"; $a--
6864 /* sv_2iv *should* have made this an NV */
6865 if (flags & SVp_NOK) {
6866 (void)SvNOK_only(sv);
6867 SvNV_set(sv, SvNVX(sv) - 1.0);
6870 /* I don't think we can get here. Maybe I should assert this
6871 And if we do get here I suspect that sv_setnv will croak. NWC
6873 #if defined(USE_LONG_DOUBLE)
6874 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",
6875 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6877 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6878 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6882 #endif /* PERL_PRESERVE_IVUV */
6883 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6887 =for apidoc sv_mortalcopy
6889 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6890 The new SV is marked as mortal. It will be destroyed "soon", either by an
6891 explicit call to FREETMPS, or by an implicit call at places such as
6892 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6897 /* Make a string that will exist for the duration of the expression
6898 * evaluation. Actually, it may have to last longer than that, but
6899 * hopefully we won't free it until it has been assigned to a
6900 * permanent location. */
6903 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6909 sv_setsv(sv,oldstr);
6911 PL_tmps_stack[++PL_tmps_ix] = sv;
6917 =for apidoc sv_newmortal
6919 Creates a new null SV which is mortal. The reference count of the SV is
6920 set to 1. It will be destroyed "soon", either by an explicit call to
6921 FREETMPS, or by an implicit call at places such as statement boundaries.
6922 See also C<sv_mortalcopy> and C<sv_2mortal>.
6928 Perl_sv_newmortal(pTHX)
6934 SvFLAGS(sv) = SVs_TEMP;
6936 PL_tmps_stack[++PL_tmps_ix] = sv;
6941 =for apidoc sv_2mortal
6943 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6944 by an explicit call to FREETMPS, or by an implicit call at places such as
6945 statement boundaries. SvTEMP() is turned on which means that the SV's
6946 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6947 and C<sv_mortalcopy>.
6953 Perl_sv_2mortal(pTHX_ register SV *sv)
6958 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6961 PL_tmps_stack[++PL_tmps_ix] = sv;
6969 Creates a new SV and copies a string into it. The reference count for the
6970 SV is set to 1. If C<len> is zero, Perl will compute the length using
6971 strlen(). For efficiency, consider using C<newSVpvn> instead.
6977 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6983 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6988 =for apidoc newSVpvn
6990 Creates a new SV and copies a string into it. The reference count for the
6991 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6992 string. You are responsible for ensuring that the source string is at least
6993 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6999 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7005 sv_setpvn(sv,s,len);
7011 =for apidoc newSVhek
7013 Creates a new SV from the hash key structure. It will generate scalars that
7014 point to the shared string table where possible. Returns a new (undefined)
7015 SV if the hek is NULL.
7021 Perl_newSVhek(pTHX_ const HEK *hek)
7031 if (HEK_LEN(hek) == HEf_SVKEY) {
7032 return newSVsv(*(SV**)HEK_KEY(hek));
7034 const int flags = HEK_FLAGS(hek);
7035 if (flags & HVhek_WASUTF8) {
7037 Andreas would like keys he put in as utf8 to come back as utf8
7039 STRLEN utf8_len = HEK_LEN(hek);
7040 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7041 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7044 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7046 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7047 /* We don't have a pointer to the hv, so we have to replicate the
7048 flag into every HEK. This hv is using custom a hasing
7049 algorithm. Hence we can't return a shared string scalar, as
7050 that would contain the (wrong) hash value, and might get passed
7051 into an hv routine with a regular hash.
7052 Similarly, a hash that isn't using shared hash keys has to have
7053 the flag in every key so that we know not to try to call
7054 share_hek_kek on it. */
7056 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7061 /* This will be overwhelminly the most common case. */
7063 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7064 more efficient than sharepvn(). */
7068 sv_upgrade(sv, SVt_PV);
7069 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7070 SvCUR_set(sv, HEK_LEN(hek));
7083 =for apidoc newSVpvn_share
7085 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7086 table. If the string does not already exist in the table, it is created
7087 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7088 value is used; otherwise the hash is computed. The string's hash can be later
7089 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7090 that as the string table is used for shared hash keys these strings will have
7091 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7097 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7101 bool is_utf8 = FALSE;
7102 const char *const orig_src = src;
7105 STRLEN tmplen = -len;
7107 /* See the note in hv.c:hv_fetch() --jhi */
7108 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7112 PERL_HASH(hash, src, len);
7114 sv_upgrade(sv, SVt_PV);
7115 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7123 if (src != orig_src)
7129 #if defined(PERL_IMPLICIT_CONTEXT)
7131 /* pTHX_ magic can't cope with varargs, so this is a no-context
7132 * version of the main function, (which may itself be aliased to us).
7133 * Don't access this version directly.
7137 Perl_newSVpvf_nocontext(const char* pat, ...)
7142 va_start(args, pat);
7143 sv = vnewSVpvf(pat, &args);
7150 =for apidoc newSVpvf
7152 Creates a new SV and initializes it with the string formatted like
7159 Perl_newSVpvf(pTHX_ const char* pat, ...)
7163 va_start(args, pat);
7164 sv = vnewSVpvf(pat, &args);
7169 /* backend for newSVpvf() and newSVpvf_nocontext() */
7172 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7177 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7184 Creates a new SV and copies a floating point value into it.
7185 The reference count for the SV is set to 1.
7191 Perl_newSVnv(pTHX_ NV n)
7204 Creates a new SV and copies an integer into it. The reference count for the
7211 Perl_newSViv(pTHX_ IV i)
7224 Creates a new SV and copies an unsigned integer into it.
7225 The reference count for the SV is set to 1.
7231 Perl_newSVuv(pTHX_ UV u)
7242 =for apidoc newSV_type
7244 Creates a new SV, of the type specified. The reference count for the new SV
7251 Perl_newSV_type(pTHX_ svtype type)
7256 sv_upgrade(sv, type);
7261 =for apidoc newRV_noinc
7263 Creates an RV wrapper for an SV. The reference count for the original
7264 SV is B<not> incremented.
7270 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7273 register SV *sv = newSV_type(SVt_RV);
7275 SvRV_set(sv, tmpRef);
7280 /* newRV_inc is the official function name to use now.
7281 * newRV_inc is in fact #defined to newRV in sv.h
7285 Perl_newRV(pTHX_ SV *sv)
7288 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7294 Creates a new SV which is an exact duplicate of the original SV.
7301 Perl_newSVsv(pTHX_ register SV *old)
7308 if (SvTYPE(old) == SVTYPEMASK) {
7309 if (ckWARN_d(WARN_INTERNAL))
7310 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7314 /* SV_GMAGIC is the default for sv_setv()
7315 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7316 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7317 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7322 =for apidoc sv_reset
7324 Underlying implementation for the C<reset> Perl function.
7325 Note that the perl-level function is vaguely deprecated.
7331 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7334 char todo[PERL_UCHAR_MAX+1];
7339 if (!*s) { /* reset ?? searches */
7340 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7342 const U32 count = mg->mg_len / sizeof(PMOP**);
7343 PMOP **pmp = (PMOP**) mg->mg_ptr;
7344 PMOP *const *const end = pmp + count;
7348 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7350 (*pmp)->op_pmflags &= ~PMf_USED;
7358 /* reset variables */
7360 if (!HvARRAY(stash))
7363 Zero(todo, 256, char);
7366 I32 i = (unsigned char)*s;
7370 max = (unsigned char)*s++;
7371 for ( ; i <= max; i++) {
7374 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7376 for (entry = HvARRAY(stash)[i];
7378 entry = HeNEXT(entry))
7383 if (!todo[(U8)*HeKEY(entry)])
7385 gv = (GV*)HeVAL(entry);
7388 if (SvTHINKFIRST(sv)) {
7389 if (!SvREADONLY(sv) && SvROK(sv))
7391 /* XXX Is this continue a bug? Why should THINKFIRST
7392 exempt us from resetting arrays and hashes? */
7396 if (SvTYPE(sv) >= SVt_PV) {
7398 if (SvPVX_const(sv) != NULL)
7406 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7408 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7411 # if defined(USE_ENVIRON_ARRAY)
7414 # endif /* USE_ENVIRON_ARRAY */
7425 Using various gambits, try to get an IO from an SV: the IO slot if its a
7426 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7427 named after the PV if we're a string.
7433 Perl_sv_2io(pTHX_ SV *sv)
7438 switch (SvTYPE(sv)) {
7446 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7450 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7452 return sv_2io(SvRV(sv));
7453 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7459 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7468 Using various gambits, try to get a CV from an SV; in addition, try if
7469 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7470 The flags in C<lref> are passed to sv_fetchsv.
7476 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7487 switch (SvTYPE(sv)) {
7506 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7507 tryAMAGICunDEREF(to_cv);
7510 if (SvTYPE(sv) == SVt_PVCV) {
7519 Perl_croak(aTHX_ "Not a subroutine reference");
7524 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7530 /* Some flags to gv_fetchsv mean don't really create the GV */
7531 if (SvTYPE(gv) != SVt_PVGV) {
7537 if (lref && !GvCVu(gv)) {
7541 gv_efullname3(tmpsv, gv, NULL);
7542 /* XXX this is probably not what they think they're getting.
7543 * It has the same effect as "sub name;", i.e. just a forward
7545 newSUB(start_subparse(FALSE, 0),
7546 newSVOP(OP_CONST, 0, tmpsv),
7550 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7560 Returns true if the SV has a true value by Perl's rules.
7561 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7562 instead use an in-line version.
7568 Perl_sv_true(pTHX_ register SV *sv)
7573 register const XPV* const tXpv = (XPV*)SvANY(sv);
7575 (tXpv->xpv_cur > 1 ||
7576 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7583 return SvIVX(sv) != 0;
7586 return SvNVX(sv) != 0.0;
7588 return sv_2bool(sv);
7594 =for apidoc sv_pvn_force
7596 Get a sensible string out of the SV somehow.
7597 A private implementation of the C<SvPV_force> macro for compilers which
7598 can't cope with complex macro expressions. Always use the macro instead.
7600 =for apidoc sv_pvn_force_flags
7602 Get a sensible string out of the SV somehow.
7603 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7604 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7605 implemented in terms of this function.
7606 You normally want to use the various wrapper macros instead: see
7607 C<SvPV_force> and C<SvPV_force_nomg>
7613 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7616 if (SvTHINKFIRST(sv) && !SvROK(sv))
7617 sv_force_normal_flags(sv, 0);
7627 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7628 const char * const ref = sv_reftype(sv,0);
7630 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7631 ref, OP_NAME(PL_op));
7633 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7635 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7636 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7638 s = sv_2pv_flags(sv, &len, flags);
7642 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7645 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7646 SvGROW(sv, len + 1);
7647 Move(s,SvPVX(sv),len,char);
7649 SvPVX(sv)[len] = '\0';
7652 SvPOK_on(sv); /* validate pointer */
7654 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7655 PTR2UV(sv),SvPVX_const(sv)));
7658 return SvPVX_mutable(sv);
7662 =for apidoc sv_pvbyten_force
7664 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7670 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7672 sv_pvn_force(sv,lp);
7673 sv_utf8_downgrade(sv,0);
7679 =for apidoc sv_pvutf8n_force
7681 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7687 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7689 sv_pvn_force(sv,lp);
7690 sv_utf8_upgrade(sv);
7696 =for apidoc sv_reftype
7698 Returns a string describing what the SV is a reference to.
7704 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7706 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7707 inside return suggests a const propagation bug in g++. */
7708 if (ob && SvOBJECT(sv)) {
7709 char * const name = HvNAME_get(SvSTASH(sv));
7710 return name ? name : (char *) "__ANON__";
7713 switch (SvTYPE(sv)) {
7729 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7730 /* tied lvalues should appear to be
7731 * scalars for backwards compatitbility */
7732 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7733 ? "SCALAR" : "LVALUE");
7734 case SVt_PVAV: return "ARRAY";
7735 case SVt_PVHV: return "HASH";
7736 case SVt_PVCV: return "CODE";
7737 case SVt_PVGV: return "GLOB";
7738 case SVt_PVFM: return "FORMAT";
7739 case SVt_PVIO: return "IO";
7740 case SVt_BIND: return "BIND";
7741 default: return "UNKNOWN";
7747 =for apidoc sv_isobject
7749 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7750 object. If the SV is not an RV, or if the object is not blessed, then this
7757 Perl_sv_isobject(pTHX_ SV *sv)
7773 Returns a boolean indicating whether the SV is blessed into the specified
7774 class. This does not check for subtypes; use C<sv_derived_from> to verify
7775 an inheritance relationship.
7781 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7792 hvname = HvNAME_get(SvSTASH(sv));
7796 return strEQ(hvname, name);
7802 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7803 it will be upgraded to one. If C<classname> is non-null then the new SV will
7804 be blessed in the specified package. The new SV is returned and its
7805 reference count is 1.
7811 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7818 SV_CHECK_THINKFIRST_COW_DROP(rv);
7819 (void)SvAMAGIC_off(rv);
7821 if (SvTYPE(rv) >= SVt_PVMG) {
7822 const U32 refcnt = SvREFCNT(rv);
7826 SvREFCNT(rv) = refcnt;
7828 sv_upgrade(rv, SVt_RV);
7829 } else if (SvROK(rv)) {
7830 SvREFCNT_dec(SvRV(rv));
7831 } else if (SvTYPE(rv) < SVt_RV)
7832 sv_upgrade(rv, SVt_RV);
7833 else if (SvTYPE(rv) > SVt_RV) {
7844 HV* const stash = gv_stashpv(classname, GV_ADD);
7845 (void)sv_bless(rv, stash);
7851 =for apidoc sv_setref_pv
7853 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7854 argument will be upgraded to an RV. That RV will be modified to point to
7855 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7856 into the SV. The C<classname> argument indicates the package for the
7857 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7858 will have a reference count of 1, and the RV will be returned.
7860 Do not use with other Perl types such as HV, AV, SV, CV, because those
7861 objects will become corrupted by the pointer copy process.
7863 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7869 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7873 sv_setsv(rv, &PL_sv_undef);
7877 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7882 =for apidoc sv_setref_iv
7884 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7885 argument will be upgraded to an RV. That RV will be modified to point to
7886 the new SV. The C<classname> argument indicates the package for the
7887 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7888 will have a reference count of 1, and the RV will be returned.
7894 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7896 sv_setiv(newSVrv(rv,classname), iv);
7901 =for apidoc sv_setref_uv
7903 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7904 argument will be upgraded to an RV. That RV will be modified to point to
7905 the new SV. The C<classname> argument indicates the package for the
7906 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7907 will have a reference count of 1, and the RV will be returned.
7913 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7915 sv_setuv(newSVrv(rv,classname), uv);
7920 =for apidoc sv_setref_nv
7922 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7923 argument will be upgraded to an RV. That RV will be modified to point to
7924 the new SV. The C<classname> argument indicates the package for the
7925 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7926 will have a reference count of 1, and the RV will be returned.
7932 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7934 sv_setnv(newSVrv(rv,classname), nv);
7939 =for apidoc sv_setref_pvn
7941 Copies a string into a new SV, optionally blessing the SV. The length of the
7942 string must be specified with C<n>. The C<rv> argument will be upgraded to
7943 an RV. That RV will be modified to point to the new SV. The C<classname>
7944 argument indicates the package for the blessing. Set C<classname> to
7945 C<NULL> to avoid the blessing. The new SV will have a reference count
7946 of 1, and the RV will be returned.
7948 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7954 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7956 sv_setpvn(newSVrv(rv,classname), pv, n);
7961 =for apidoc sv_bless
7963 Blesses an SV into a specified package. The SV must be an RV. The package
7964 must be designated by its stash (see C<gv_stashpv()>). The reference count
7965 of the SV is unaffected.
7971 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7976 Perl_croak(aTHX_ "Can't bless non-reference value");
7978 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7979 if (SvREADONLY(tmpRef))
7980 Perl_croak(aTHX_ PL_no_modify);
7981 if (SvOBJECT(tmpRef)) {
7982 if (SvTYPE(tmpRef) != SVt_PVIO)
7984 SvREFCNT_dec(SvSTASH(tmpRef));
7987 SvOBJECT_on(tmpRef);
7988 if (SvTYPE(tmpRef) != SVt_PVIO)
7990 SvUPGRADE(tmpRef, SVt_PVMG);
7991 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7996 (void)SvAMAGIC_off(sv);
7998 if(SvSMAGICAL(tmpRef))
7999 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8007 /* Downgrades a PVGV to a PVMG.
8011 S_sv_unglob(pTHX_ SV *sv)
8016 SV * const temp = sv_newmortal();
8018 assert(SvTYPE(sv) == SVt_PVGV);
8020 gv_efullname3(temp, (GV *) sv, "*");
8023 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8024 mro_method_changed_in(stash);
8028 sv_del_backref((SV*)GvSTASH(sv), sv);
8032 if (GvNAME_HEK(sv)) {
8033 unshare_hek(GvNAME_HEK(sv));
8035 isGV_with_GP_off(sv);
8037 /* need to keep SvANY(sv) in the right arena */
8038 xpvmg = new_XPVMG();
8039 StructCopy(SvANY(sv), xpvmg, XPVMG);
8040 del_XPVGV(SvANY(sv));
8043 SvFLAGS(sv) &= ~SVTYPEMASK;
8044 SvFLAGS(sv) |= SVt_PVMG;
8046 /* Intentionally not calling any local SET magic, as this isn't so much a
8047 set operation as merely an internal storage change. */
8048 sv_setsv_flags(sv, temp, 0);
8052 =for apidoc sv_unref_flags
8054 Unsets the RV status of the SV, and decrements the reference count of
8055 whatever was being referenced by the RV. This can almost be thought of
8056 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8057 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8058 (otherwise the decrementing is conditional on the reference count being
8059 different from one or the reference being a readonly SV).
8066 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8068 SV* const target = SvRV(ref);
8070 if (SvWEAKREF(ref)) {
8071 sv_del_backref(target, ref);
8073 SvRV_set(ref, NULL);
8076 SvRV_set(ref, NULL);
8078 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8079 assigned to as BEGIN {$a = \"Foo"} will fail. */
8080 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8081 SvREFCNT_dec(target);
8082 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8083 sv_2mortal(target); /* Schedule for freeing later */
8087 =for apidoc sv_untaint
8089 Untaint an SV. Use C<SvTAINTED_off> instead.
8094 Perl_sv_untaint(pTHX_ SV *sv)
8096 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8097 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8104 =for apidoc sv_tainted
8106 Test an SV for taintedness. Use C<SvTAINTED> instead.
8111 Perl_sv_tainted(pTHX_ SV *sv)
8113 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8114 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8115 if (mg && (mg->mg_len & 1) )
8122 =for apidoc sv_setpviv
8124 Copies an integer into the given SV, also updating its string value.
8125 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8131 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8133 char buf[TYPE_CHARS(UV)];
8135 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8137 sv_setpvn(sv, ptr, ebuf - ptr);
8141 =for apidoc sv_setpviv_mg
8143 Like C<sv_setpviv>, but also handles 'set' magic.
8149 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8155 #if defined(PERL_IMPLICIT_CONTEXT)
8157 /* pTHX_ magic can't cope with varargs, so this is a no-context
8158 * version of the main function, (which may itself be aliased to us).
8159 * Don't access this version directly.
8163 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8167 va_start(args, pat);
8168 sv_vsetpvf(sv, pat, &args);
8172 /* pTHX_ magic can't cope with varargs, so this is a no-context
8173 * version of the main function, (which may itself be aliased to us).
8174 * Don't access this version directly.
8178 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8182 va_start(args, pat);
8183 sv_vsetpvf_mg(sv, pat, &args);
8189 =for apidoc sv_setpvf
8191 Works like C<sv_catpvf> but copies the text into the SV instead of
8192 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8198 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8201 va_start(args, pat);
8202 sv_vsetpvf(sv, pat, &args);
8207 =for apidoc sv_vsetpvf
8209 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8210 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8212 Usually used via its frontend C<sv_setpvf>.
8218 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8220 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8224 =for apidoc sv_setpvf_mg
8226 Like C<sv_setpvf>, but also handles 'set' magic.
8232 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8235 va_start(args, pat);
8236 sv_vsetpvf_mg(sv, pat, &args);
8241 =for apidoc sv_vsetpvf_mg
8243 Like C<sv_vsetpvf>, but also handles 'set' magic.
8245 Usually used via its frontend C<sv_setpvf_mg>.
8251 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8253 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8257 #if defined(PERL_IMPLICIT_CONTEXT)
8259 /* pTHX_ magic can't cope with varargs, so this is a no-context
8260 * version of the main function, (which may itself be aliased to us).
8261 * Don't access this version directly.
8265 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8269 va_start(args, pat);
8270 sv_vcatpvf(sv, pat, &args);
8274 /* pTHX_ magic can't cope with varargs, so this is a no-context
8275 * version of the main function, (which may itself be aliased to us).
8276 * Don't access this version directly.
8280 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8284 va_start(args, pat);
8285 sv_vcatpvf_mg(sv, pat, &args);
8291 =for apidoc sv_catpvf
8293 Processes its arguments like C<sprintf> and appends the formatted
8294 output to an SV. If the appended data contains "wide" characters
8295 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8296 and characters >255 formatted with %c), the original SV might get
8297 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8298 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8299 valid UTF-8; if the original SV was bytes, the pattern should be too.
8304 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8307 va_start(args, pat);
8308 sv_vcatpvf(sv, pat, &args);
8313 =for apidoc sv_vcatpvf
8315 Processes its arguments like C<vsprintf> and appends the formatted output
8316 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8318 Usually used via its frontend C<sv_catpvf>.
8324 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8326 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8330 =for apidoc sv_catpvf_mg
8332 Like C<sv_catpvf>, but also handles 'set' magic.
8338 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8341 va_start(args, pat);
8342 sv_vcatpvf_mg(sv, pat, &args);
8347 =for apidoc sv_vcatpvf_mg
8349 Like C<sv_vcatpvf>, but also handles 'set' magic.
8351 Usually used via its frontend C<sv_catpvf_mg>.
8357 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8359 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8364 =for apidoc sv_vsetpvfn
8366 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8369 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8375 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8377 sv_setpvn(sv, "", 0);
8378 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8382 S_expect_number(pTHX_ char** pattern)
8386 switch (**pattern) {
8387 case '1': case '2': case '3':
8388 case '4': case '5': case '6':
8389 case '7': case '8': case '9':
8390 var = *(*pattern)++ - '0';
8391 while (isDIGIT(**pattern)) {
8392 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8394 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8402 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8404 const int neg = nv < 0;
8413 if (uv & 1 && uv == nv)
8414 uv--; /* Round to even */
8416 const unsigned dig = uv % 10;
8429 =for apidoc sv_vcatpvfn
8431 Processes its arguments like C<vsprintf> and appends the formatted output
8432 to an SV. Uses an array of SVs if the C style variable argument list is
8433 missing (NULL). When running with taint checks enabled, indicates via
8434 C<maybe_tainted> if results are untrustworthy (often due to the use of
8437 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8443 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8444 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8445 vec_utf8 = DO_UTF8(vecsv);
8447 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8450 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8458 static const char nullstr[] = "(null)";
8460 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8461 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8463 /* Times 4: a decimal digit takes more than 3 binary digits.
8464 * NV_DIG: mantissa takes than many decimal digits.
8465 * Plus 32: Playing safe. */
8466 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8467 /* large enough for "%#.#f" --chip */
8468 /* what about long double NVs? --jhi */
8470 PERL_UNUSED_ARG(maybe_tainted);
8472 /* no matter what, this is a string now */
8473 (void)SvPV_force(sv, origlen);
8475 /* special-case "", "%s", and "%-p" (SVf - see below) */
8478 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8480 const char * const s = va_arg(*args, char*);
8481 sv_catpv(sv, s ? s : nullstr);
8483 else if (svix < svmax) {
8484 sv_catsv(sv, *svargs);
8488 if (args && patlen == 3 && pat[0] == '%' &&
8489 pat[1] == '-' && pat[2] == 'p') {
8490 argsv = (SV*)va_arg(*args, void*);
8491 sv_catsv(sv, argsv);
8495 #ifndef USE_LONG_DOUBLE
8496 /* special-case "%.<number>[gf]" */
8497 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8498 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8499 unsigned digits = 0;
8503 while (*pp >= '0' && *pp <= '9')
8504 digits = 10 * digits + (*pp++ - '0');
8505 if (pp - pat == (int)patlen - 1) {
8513 /* Add check for digits != 0 because it seems that some
8514 gconverts are buggy in this case, and we don't yet have
8515 a Configure test for this. */
8516 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8517 /* 0, point, slack */
8518 Gconvert(nv, (int)digits, 0, ebuf);
8520 if (*ebuf) /* May return an empty string for digits==0 */
8523 } else if (!digits) {
8526 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8527 sv_catpvn(sv, p, l);
8533 #endif /* !USE_LONG_DOUBLE */
8535 if (!args && svix < svmax && DO_UTF8(*svargs))
8538 patend = (char*)pat + patlen;
8539 for (p = (char*)pat; p < patend; p = q) {
8542 bool vectorize = FALSE;
8543 bool vectorarg = FALSE;
8544 bool vec_utf8 = FALSE;
8550 bool has_precis = FALSE;
8552 const I32 osvix = svix;
8553 bool is_utf8 = FALSE; /* is this item utf8? */
8554 #ifdef HAS_LDBL_SPRINTF_BUG
8555 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8556 with sfio - Allen <allens@cpan.org> */
8557 bool fix_ldbl_sprintf_bug = FALSE;
8561 U8 utf8buf[UTF8_MAXBYTES+1];
8562 STRLEN esignlen = 0;
8564 const char *eptr = NULL;
8567 const U8 *vecstr = NULL;
8574 /* we need a long double target in case HAS_LONG_DOUBLE but
8577 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8585 const char *dotstr = ".";
8586 STRLEN dotstrlen = 1;
8587 I32 efix = 0; /* explicit format parameter index */
8588 I32 ewix = 0; /* explicit width index */
8589 I32 epix = 0; /* explicit precision index */
8590 I32 evix = 0; /* explicit vector index */
8591 bool asterisk = FALSE;
8593 /* echo everything up to the next format specification */
8594 for (q = p; q < patend && *q != '%'; ++q) ;
8596 if (has_utf8 && !pat_utf8)
8597 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8599 sv_catpvn(sv, p, q - p);
8606 We allow format specification elements in this order:
8607 \d+\$ explicit format parameter index
8609 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8610 0 flag (as above): repeated to allow "v02"
8611 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8612 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8614 [%bcdefginopsuxDFOUX] format (mandatory)
8619 As of perl5.9.3, printf format checking is on by default.
8620 Internally, perl uses %p formats to provide an escape to
8621 some extended formatting. This block deals with those
8622 extensions: if it does not match, (char*)q is reset and
8623 the normal format processing code is used.
8625 Currently defined extensions are:
8626 %p include pointer address (standard)
8627 %-p (SVf) include an SV (previously %_)
8628 %-<num>p include an SV with precision <num>
8629 %<num>p reserved for future extensions
8631 Robin Barker 2005-07-14
8633 %1p (VDf) removed. RMB 2007-10-19
8640 n = expect_number(&q);
8647 argsv = (SV*)va_arg(*args, void*);
8648 eptr = SvPV_const(argsv, elen);
8654 if (ckWARN_d(WARN_INTERNAL))
8655 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8656 "internal %%<num>p might conflict with future printf extensions");
8662 if ( (width = expect_number(&q)) ) {
8677 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8706 if ( (ewix = expect_number(&q)) )
8715 if ((vectorarg = asterisk)) {
8728 width = expect_number(&q);
8734 vecsv = va_arg(*args, SV*);
8736 vecsv = (evix > 0 && evix <= svmax)
8737 ? svargs[evix-1] : &PL_sv_undef;
8739 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8741 dotstr = SvPV_const(vecsv, dotstrlen);
8742 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8743 bad with tied or overloaded values that return UTF8. */
8746 else if (has_utf8) {
8747 vecsv = sv_mortalcopy(vecsv);
8748 sv_utf8_upgrade(vecsv);
8749 dotstr = SvPV_const(vecsv, dotstrlen);
8756 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8757 vecsv = svargs[efix ? efix-1 : svix++];
8758 vecstr = (U8*)SvPV_const(vecsv,veclen);
8759 vec_utf8 = DO_UTF8(vecsv);
8761 /* if this is a version object, we need to convert
8762 * back into v-string notation and then let the
8763 * vectorize happen normally
8765 if (sv_derived_from(vecsv, "version")) {
8766 char *version = savesvpv(vecsv);
8767 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8768 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8769 "vector argument not supported with alpha versions");
8772 vecsv = sv_newmortal();
8773 scan_vstring(version, version + veclen, vecsv);
8774 vecstr = (U8*)SvPV_const(vecsv, veclen);
8775 vec_utf8 = DO_UTF8(vecsv);
8787 i = va_arg(*args, int);
8789 i = (ewix ? ewix <= svmax : svix < svmax) ?
8790 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8792 width = (i < 0) ? -i : i;
8802 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8804 /* XXX: todo, support specified precision parameter */
8808 i = va_arg(*args, int);
8810 i = (ewix ? ewix <= svmax : svix < svmax)
8811 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8813 has_precis = !(i < 0);
8818 precis = precis * 10 + (*q++ - '0');
8827 case 'I': /* Ix, I32x, and I64x */
8829 if (q[1] == '6' && q[2] == '4') {
8835 if (q[1] == '3' && q[2] == '2') {
8845 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8856 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8857 if (*(q + 1) == 'l') { /* lld, llf */
8883 if (!vectorize && !args) {
8885 const I32 i = efix-1;
8886 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8888 argsv = (svix >= 0 && svix < svmax)
8889 ? svargs[svix++] : &PL_sv_undef;
8900 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8902 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8904 eptr = (char*)utf8buf;
8905 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8919 eptr = va_arg(*args, char*);
8921 #ifdef MACOS_TRADITIONAL
8922 /* On MacOS, %#s format is used for Pascal strings */
8927 elen = strlen(eptr);
8929 eptr = (char *)nullstr;
8930 elen = sizeof nullstr - 1;
8934 eptr = SvPV_const(argsv, elen);
8935 if (DO_UTF8(argsv)) {
8936 I32 old_precis = precis;
8937 if (has_precis && precis < elen) {
8939 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8942 if (width) { /* fudge width (can't fudge elen) */
8943 if (has_precis && precis < elen)
8944 width += precis - old_precis;
8946 width += elen - sv_len_utf8(argsv);
8953 if (has_precis && elen > precis)
8960 if (alt || vectorize)
8962 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8983 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8992 esignbuf[esignlen++] = plus;
8996 case 'h': iv = (short)va_arg(*args, int); break;
8997 case 'l': iv = va_arg(*args, long); break;
8998 case 'V': iv = va_arg(*args, IV); break;
8999 default: iv = va_arg(*args, int); break;
9001 case 'q': iv = va_arg(*args, Quad_t); break;
9006 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9008 case 'h': iv = (short)tiv; break;
9009 case 'l': iv = (long)tiv; break;
9011 default: iv = tiv; break;
9013 case 'q': iv = (Quad_t)tiv; break;
9017 if ( !vectorize ) /* we already set uv above */
9022 esignbuf[esignlen++] = plus;
9026 esignbuf[esignlen++] = '-';
9070 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9081 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9082 case 'l': uv = va_arg(*args, unsigned long); break;
9083 case 'V': uv = va_arg(*args, UV); break;
9084 default: uv = va_arg(*args, unsigned); break;
9086 case 'q': uv = va_arg(*args, Uquad_t); break;
9091 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9093 case 'h': uv = (unsigned short)tuv; break;
9094 case 'l': uv = (unsigned long)tuv; break;
9096 default: uv = tuv; break;
9098 case 'q': uv = (Uquad_t)tuv; break;
9105 char *ptr = ebuf + sizeof ebuf;
9106 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9112 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9118 esignbuf[esignlen++] = '0';
9119 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9127 if (alt && *ptr != '0')
9136 esignbuf[esignlen++] = '0';
9137 esignbuf[esignlen++] = c;
9140 default: /* it had better be ten or less */
9144 } while (uv /= base);
9147 elen = (ebuf + sizeof ebuf) - ptr;
9151 zeros = precis - elen;
9152 else if (precis == 0 && elen == 1 && *eptr == '0'
9153 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9156 /* a precision nullifies the 0 flag. */
9163 /* FLOATING POINT */
9166 c = 'f'; /* maybe %F isn't supported here */
9174 /* This is evil, but floating point is even more evil */
9176 /* for SV-style calling, we can only get NV
9177 for C-style calling, we assume %f is double;
9178 for simplicity we allow any of %Lf, %llf, %qf for long double
9182 #if defined(USE_LONG_DOUBLE)
9186 /* [perl #20339] - we should accept and ignore %lf rather than die */
9190 #if defined(USE_LONG_DOUBLE)
9191 intsize = args ? 0 : 'q';
9195 #if defined(HAS_LONG_DOUBLE)
9204 /* now we need (long double) if intsize == 'q', else (double) */
9206 #if LONG_DOUBLESIZE > DOUBLESIZE
9208 va_arg(*args, long double) :
9209 va_arg(*args, double)
9211 va_arg(*args, double)
9216 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9217 else. frexp() has some unspecified behaviour for those three */
9218 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9220 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9221 will cast our (long double) to (double) */
9222 (void)Perl_frexp(nv, &i);
9223 if (i == PERL_INT_MIN)
9224 Perl_die(aTHX_ "panic: frexp");
9226 need = BIT_DIGITS(i);
9228 need += has_precis ? precis : 6; /* known default */
9233 #ifdef HAS_LDBL_SPRINTF_BUG
9234 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9235 with sfio - Allen <allens@cpan.org> */
9238 # define MY_DBL_MAX DBL_MAX
9239 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9240 # if DOUBLESIZE >= 8
9241 # define MY_DBL_MAX 1.7976931348623157E+308L
9243 # define MY_DBL_MAX 3.40282347E+38L
9247 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9248 # define MY_DBL_MAX_BUG 1L
9250 # define MY_DBL_MAX_BUG MY_DBL_MAX
9254 # define MY_DBL_MIN DBL_MIN
9255 # else /* XXX guessing! -Allen */
9256 # if DOUBLESIZE >= 8
9257 # define MY_DBL_MIN 2.2250738585072014E-308L
9259 # define MY_DBL_MIN 1.17549435E-38L
9263 if ((intsize == 'q') && (c == 'f') &&
9264 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9266 /* it's going to be short enough that
9267 * long double precision is not needed */
9269 if ((nv <= 0L) && (nv >= -0L))
9270 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9272 /* would use Perl_fp_class as a double-check but not
9273 * functional on IRIX - see perl.h comments */
9275 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9276 /* It's within the range that a double can represent */
9277 #if defined(DBL_MAX) && !defined(DBL_MIN)
9278 if ((nv >= ((long double)1/DBL_MAX)) ||
9279 (nv <= (-(long double)1/DBL_MAX)))
9281 fix_ldbl_sprintf_bug = TRUE;
9284 if (fix_ldbl_sprintf_bug == TRUE) {
9294 # undef MY_DBL_MAX_BUG
9297 #endif /* HAS_LDBL_SPRINTF_BUG */
9299 need += 20; /* fudge factor */
9300 if (PL_efloatsize < need) {
9301 Safefree(PL_efloatbuf);
9302 PL_efloatsize = need + 20; /* more fudge */
9303 Newx(PL_efloatbuf, PL_efloatsize, char);
9304 PL_efloatbuf[0] = '\0';
9307 if ( !(width || left || plus || alt) && fill != '0'
9308 && has_precis && intsize != 'q' ) { /* Shortcuts */
9309 /* See earlier comment about buggy Gconvert when digits,
9311 if ( c == 'g' && precis) {
9312 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9313 /* May return an empty string for digits==0 */
9314 if (*PL_efloatbuf) {
9315 elen = strlen(PL_efloatbuf);
9316 goto float_converted;
9318 } else if ( c == 'f' && !precis) {
9319 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9324 char *ptr = ebuf + sizeof ebuf;
9327 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9328 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9329 if (intsize == 'q') {
9330 /* Copy the one or more characters in a long double
9331 * format before the 'base' ([efgEFG]) character to
9332 * the format string. */
9333 static char const prifldbl[] = PERL_PRIfldbl;
9334 char const *p = prifldbl + sizeof(prifldbl) - 3;
9335 while (p >= prifldbl) { *--ptr = *p--; }
9340 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9345 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9357 /* No taint. Otherwise we are in the strange situation
9358 * where printf() taints but print($float) doesn't.
9360 #if defined(HAS_LONG_DOUBLE)
9361 elen = ((intsize == 'q')
9362 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9363 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9365 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9369 eptr = PL_efloatbuf;
9377 i = SvCUR(sv) - origlen;
9380 case 'h': *(va_arg(*args, short*)) = i; break;
9381 default: *(va_arg(*args, int*)) = i; break;
9382 case 'l': *(va_arg(*args, long*)) = i; break;
9383 case 'V': *(va_arg(*args, IV*)) = i; break;
9385 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9390 sv_setuv_mg(argsv, (UV)i);
9391 continue; /* not "break" */
9398 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9399 && ckWARN(WARN_PRINTF))
9401 SV * const msg = sv_newmortal();
9402 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9403 (PL_op->op_type == OP_PRTF) ? "" : "s");
9406 Perl_sv_catpvf(aTHX_ msg,
9407 "\"%%%c\"", c & 0xFF);
9409 Perl_sv_catpvf(aTHX_ msg,
9410 "\"%%\\%03"UVof"\"",
9413 sv_catpvs(msg, "end of string");
9414 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9417 /* output mangled stuff ... */
9423 /* ... right here, because formatting flags should not apply */
9424 SvGROW(sv, SvCUR(sv) + elen + 1);
9426 Copy(eptr, p, elen, char);
9429 SvCUR_set(sv, p - SvPVX_const(sv));
9431 continue; /* not "break" */
9434 if (is_utf8 != has_utf8) {
9437 sv_utf8_upgrade(sv);
9440 const STRLEN old_elen = elen;
9441 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9442 sv_utf8_upgrade(nsv);
9443 eptr = SvPVX_const(nsv);
9446 if (width) { /* fudge width (can't fudge elen) */
9447 width += elen - old_elen;
9453 have = esignlen + zeros + elen;
9455 Perl_croak_nocontext(PL_memory_wrap);
9457 need = (have > width ? have : width);
9460 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9461 Perl_croak_nocontext(PL_memory_wrap);
9462 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9464 if (esignlen && fill == '0') {
9466 for (i = 0; i < (int)esignlen; i++)
9470 memset(p, fill, gap);
9473 if (esignlen && fill != '0') {
9475 for (i = 0; i < (int)esignlen; i++)
9480 for (i = zeros; i; i--)
9484 Copy(eptr, p, elen, char);
9488 memset(p, ' ', gap);
9493 Copy(dotstr, p, dotstrlen, char);
9497 vectorize = FALSE; /* done iterating over vecstr */
9504 SvCUR_set(sv, p - SvPVX_const(sv));
9512 /* =========================================================================
9514 =head1 Cloning an interpreter
9516 All the macros and functions in this section are for the private use of
9517 the main function, perl_clone().
9519 The foo_dup() functions make an exact copy of an existing foo thingy.
9520 During the course of a cloning, a hash table is used to map old addresses
9521 to new addresses. The table is created and manipulated with the
9522 ptr_table_* functions.
9526 ============================================================================*/
9529 #if defined(USE_ITHREADS)
9531 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9532 #ifndef GpREFCNT_inc
9533 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9537 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9538 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9539 If this changes, please unmerge ss_dup. */
9540 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9541 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9542 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9543 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9544 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9545 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9546 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9547 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9548 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9549 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9550 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9551 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9552 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9553 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9555 /* clone a parser */
9558 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9565 /* look for it in the table first */
9566 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9570 /* create anew and remember what it is */
9571 Newxz(parser, 1, yy_parser);
9572 ptr_table_store(PL_ptr_table, proto, parser);
9574 parser->yyerrstatus = 0;
9575 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9577 /* XXX these not yet duped */
9578 parser->old_parser = NULL;
9579 parser->stack = NULL;
9581 parser->stack_size = 0;
9582 /* XXX parser->stack->state = 0; */
9584 /* XXX eventually, just Copy() most of the parser struct ? */
9586 parser->lex_brackets = proto->lex_brackets;
9587 parser->lex_casemods = proto->lex_casemods;
9588 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9589 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9590 parser->lex_casestack = savepvn(proto->lex_casestack,
9591 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9592 parser->lex_defer = proto->lex_defer;
9593 parser->lex_dojoin = proto->lex_dojoin;
9594 parser->lex_expect = proto->lex_expect;
9595 parser->lex_formbrack = proto->lex_formbrack;
9596 parser->lex_inpat = proto->lex_inpat;
9597 parser->lex_inwhat = proto->lex_inwhat;
9598 parser->lex_op = proto->lex_op;
9599 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9600 parser->lex_starts = proto->lex_starts;
9601 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9602 parser->multi_close = proto->multi_close;
9603 parser->multi_open = proto->multi_open;
9604 parser->multi_start = proto->multi_start;
9605 parser->multi_end = proto->multi_end;
9606 parser->pending_ident = proto->pending_ident;
9607 parser->preambled = proto->preambled;
9608 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9609 parser->linestr = sv_dup_inc(proto->linestr, param);
9610 parser->expect = proto->expect;
9611 parser->copline = proto->copline;
9612 parser->last_lop_op = proto->last_lop_op;
9613 parser->lex_state = proto->lex_state;
9614 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9615 /* rsfp_filters entries have fake IoDIRP() */
9616 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9617 parser->in_my = proto->in_my;
9618 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9619 parser->error_count = proto->error_count;
9622 parser->linestr = sv_dup_inc(proto->linestr, param);
9625 char * const ols = SvPVX(proto->linestr);
9626 char * const ls = SvPVX(parser->linestr);
9628 parser->bufptr = ls + (proto->bufptr >= ols ?
9629 proto->bufptr - ols : 0);
9630 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9631 proto->oldbufptr - ols : 0);
9632 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9633 proto->oldoldbufptr - ols : 0);
9634 parser->linestart = ls + (proto->linestart >= ols ?
9635 proto->linestart - ols : 0);
9636 parser->last_uni = ls + (proto->last_uni >= ols ?
9637 proto->last_uni - ols : 0);
9638 parser->last_lop = ls + (proto->last_lop >= ols ?
9639 proto->last_lop - ols : 0);
9641 parser->bufend = ls + SvCUR(parser->linestr);
9644 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9648 parser->endwhite = proto->endwhite;
9649 parser->faketokens = proto->faketokens;
9650 parser->lasttoke = proto->lasttoke;
9651 parser->nextwhite = proto->nextwhite;
9652 parser->realtokenstart = proto->realtokenstart;
9653 parser->skipwhite = proto->skipwhite;
9654 parser->thisclose = proto->thisclose;
9655 parser->thismad = proto->thismad;
9656 parser->thisopen = proto->thisopen;
9657 parser->thisstuff = proto->thisstuff;
9658 parser->thistoken = proto->thistoken;
9659 parser->thiswhite = proto->thiswhite;
9661 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9662 parser->curforce = proto->curforce;
9664 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9665 Copy(proto->nexttype, parser->nexttype, 5, I32);
9666 parser->nexttoke = proto->nexttoke;
9672 /* duplicate a file handle */
9675 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9679 PERL_UNUSED_ARG(type);
9682 return (PerlIO*)NULL;
9684 /* look for it in the table first */
9685 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9689 /* create anew and remember what it is */
9690 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9691 ptr_table_store(PL_ptr_table, fp, ret);
9695 /* duplicate a directory handle */
9698 Perl_dirp_dup(pTHX_ DIR *dp)
9700 PERL_UNUSED_CONTEXT;
9707 /* duplicate a typeglob */
9710 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9716 /* look for it in the table first */
9717 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9721 /* create anew and remember what it is */
9723 ptr_table_store(PL_ptr_table, gp, ret);
9726 ret->gp_refcnt = 0; /* must be before any other dups! */
9727 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9728 ret->gp_io = io_dup_inc(gp->gp_io, param);
9729 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9730 ret->gp_av = av_dup_inc(gp->gp_av, param);
9731 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9732 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9733 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9734 ret->gp_cvgen = gp->gp_cvgen;
9735 ret->gp_line = gp->gp_line;
9736 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9740 /* duplicate a chain of magic */
9743 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9745 MAGIC *mgprev = (MAGIC*)NULL;
9748 return (MAGIC*)NULL;
9749 /* look for it in the table first */
9750 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9754 for (; mg; mg = mg->mg_moremagic) {
9756 Newxz(nmg, 1, MAGIC);
9758 mgprev->mg_moremagic = nmg;
9761 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9762 nmg->mg_private = mg->mg_private;
9763 nmg->mg_type = mg->mg_type;
9764 nmg->mg_flags = mg->mg_flags;
9765 if (mg->mg_type == PERL_MAGIC_qr) {
9766 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9768 else if(mg->mg_type == PERL_MAGIC_backref) {
9769 /* The backref AV has its reference count deliberately bumped by
9771 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9774 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9775 ? sv_dup_inc(mg->mg_obj, param)
9776 : sv_dup(mg->mg_obj, param);
9778 nmg->mg_len = mg->mg_len;
9779 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9780 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9781 if (mg->mg_len > 0) {
9782 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9783 if (mg->mg_type == PERL_MAGIC_overload_table &&
9784 AMT_AMAGIC((AMT*)mg->mg_ptr))
9786 const AMT * const amtp = (AMT*)mg->mg_ptr;
9787 AMT * const namtp = (AMT*)nmg->mg_ptr;
9789 for (i = 1; i < NofAMmeth; i++) {
9790 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9794 else if (mg->mg_len == HEf_SVKEY)
9795 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9797 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9798 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9805 #endif /* USE_ITHREADS */
9807 /* create a new pointer-mapping table */
9810 Perl_ptr_table_new(pTHX)
9813 PERL_UNUSED_CONTEXT;
9815 Newxz(tbl, 1, PTR_TBL_t);
9818 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9822 #define PTR_TABLE_HASH(ptr) \
9823 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9826 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9827 following define) and at call to new_body_inline made below in
9828 Perl_ptr_table_store()
9831 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9833 /* map an existing pointer using a table */
9835 STATIC PTR_TBL_ENT_t *
9836 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9837 PTR_TBL_ENT_t *tblent;
9838 const UV hash = PTR_TABLE_HASH(sv);
9840 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9841 for (; tblent; tblent = tblent->next) {
9842 if (tblent->oldval == sv)
9849 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9851 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9852 PERL_UNUSED_CONTEXT;
9853 return tblent ? tblent->newval : NULL;
9856 /* add a new entry to a pointer-mapping table */
9859 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9861 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9862 PERL_UNUSED_CONTEXT;
9865 tblent->newval = newsv;
9867 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9869 new_body_inline(tblent, PTE_SVSLOT);
9871 tblent->oldval = oldsv;
9872 tblent->newval = newsv;
9873 tblent->next = tbl->tbl_ary[entry];
9874 tbl->tbl_ary[entry] = tblent;
9876 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9877 ptr_table_split(tbl);
9881 /* double the hash bucket size of an existing ptr table */
9884 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9886 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9887 const UV oldsize = tbl->tbl_max + 1;
9888 UV newsize = oldsize * 2;
9890 PERL_UNUSED_CONTEXT;
9892 Renew(ary, newsize, PTR_TBL_ENT_t*);
9893 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9894 tbl->tbl_max = --newsize;
9896 for (i=0; i < oldsize; i++, ary++) {
9897 PTR_TBL_ENT_t **curentp, **entp, *ent;
9900 curentp = ary + oldsize;
9901 for (entp = ary, ent = *ary; ent; ent = *entp) {
9902 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9904 ent->next = *curentp;
9914 /* remove all the entries from a ptr table */
9917 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9919 if (tbl && tbl->tbl_items) {
9920 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9921 UV riter = tbl->tbl_max;
9924 PTR_TBL_ENT_t *entry = array[riter];
9927 PTR_TBL_ENT_t * const oentry = entry;
9928 entry = entry->next;
9937 /* clear and free a ptr table */
9940 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9945 ptr_table_clear(tbl);
9946 Safefree(tbl->tbl_ary);
9950 #if defined(USE_ITHREADS)
9953 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9956 SvRV_set(dstr, SvWEAKREF(sstr)
9957 ? sv_dup(SvRV(sstr), param)
9958 : sv_dup_inc(SvRV(sstr), param));
9961 else if (SvPVX_const(sstr)) {
9962 /* Has something there */
9964 /* Normal PV - clone whole allocated space */
9965 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9966 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9967 /* Not that normal - actually sstr is copy on write.
9968 But we are a true, independant SV, so: */
9969 SvREADONLY_off(dstr);
9974 /* Special case - not normally malloced for some reason */
9975 if (isGV_with_GP(sstr)) {
9976 /* Don't need to do anything here. */
9978 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9979 /* A "shared" PV - clone it as "shared" PV */
9981 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9985 /* Some other special case - random pointer */
9986 SvPV_set(dstr, SvPVX(sstr));
9992 if (SvTYPE(dstr) == SVt_RV)
9993 SvRV_set(dstr, NULL);
9995 SvPV_set(dstr, NULL);
9999 /* duplicate an SV of any type (including AV, HV etc) */
10002 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10007 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10009 /* look for it in the table first */
10010 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10014 if(param->flags & CLONEf_JOIN_IN) {
10015 /** We are joining here so we don't want do clone
10016 something that is bad **/
10017 if (SvTYPE(sstr) == SVt_PVHV) {
10018 const HEK * const hvname = HvNAME_HEK(sstr);
10020 /** don't clone stashes if they already exist **/
10021 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10025 /* create anew and remember what it is */
10028 #ifdef DEBUG_LEAKING_SCALARS
10029 dstr->sv_debug_optype = sstr->sv_debug_optype;
10030 dstr->sv_debug_line = sstr->sv_debug_line;
10031 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10032 dstr->sv_debug_cloned = 1;
10033 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10036 ptr_table_store(PL_ptr_table, sstr, dstr);
10039 SvFLAGS(dstr) = SvFLAGS(sstr);
10040 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10041 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10044 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10045 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10046 (void*)PL_watch_pvx, SvPVX_const(sstr));
10049 /* don't clone objects whose class has asked us not to */
10050 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10055 switch (SvTYPE(sstr)) {
10057 SvANY(dstr) = NULL;
10060 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10061 SvIV_set(dstr, SvIVX(sstr));
10064 SvANY(dstr) = new_XNV();
10065 SvNV_set(dstr, SvNVX(sstr));
10068 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10069 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10071 /* case SVt_BIND: */
10074 /* These are all the types that need complex bodies allocating. */
10076 const svtype sv_type = SvTYPE(sstr);
10077 const struct body_details *const sv_type_details
10078 = bodies_by_type + sv_type;
10082 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10086 if (GvUNIQUE((GV*)sstr)) {
10087 NOOP; /* Do sharing here, and fall through */
10099 assert(sv_type_details->body_size);
10100 if (sv_type_details->arena) {
10101 new_body_inline(new_body, sv_type);
10103 = (void*)((char*)new_body - sv_type_details->offset);
10105 new_body = new_NOARENA(sv_type_details);
10109 SvANY(dstr) = new_body;
10112 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10113 ((char*)SvANY(dstr)) + sv_type_details->offset,
10114 sv_type_details->copy, char);
10116 Copy(((char*)SvANY(sstr)),
10117 ((char*)SvANY(dstr)),
10118 sv_type_details->body_size + sv_type_details->offset, char);
10121 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10122 && !isGV_with_GP(dstr))
10123 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10125 /* The Copy above means that all the source (unduplicated) pointers
10126 are now in the destination. We can check the flags and the
10127 pointers in either, but it's possible that there's less cache
10128 missing by always going for the destination.
10129 FIXME - instrument and check that assumption */
10130 if (sv_type >= SVt_PVMG) {
10131 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10132 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10133 } else if (SvMAGIC(dstr))
10134 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10136 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10139 /* The cast silences a GCC warning about unhandled types. */
10140 switch ((int)sv_type) {
10150 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10151 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10152 LvTARG(dstr) = dstr;
10153 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10154 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10156 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10158 if(isGV_with_GP(sstr)) {
10159 if (GvNAME_HEK(dstr))
10160 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10161 /* Don't call sv_add_backref here as it's going to be
10162 created as part of the magic cloning of the symbol
10164 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10165 at the point of this comment. */
10166 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10167 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10168 (void)GpREFCNT_inc(GvGP(dstr));
10170 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10173 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10174 if (IoOFP(dstr) == IoIFP(sstr))
10175 IoOFP(dstr) = IoIFP(dstr);
10177 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10178 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10179 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10180 /* I have no idea why fake dirp (rsfps)
10181 should be treated differently but otherwise
10182 we end up with leaks -- sky*/
10183 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10184 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10185 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10187 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10188 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10189 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10190 if (IoDIRP(dstr)) {
10191 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10194 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10197 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10198 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10199 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10202 if (AvARRAY((AV*)sstr)) {
10203 SV **dst_ary, **src_ary;
10204 SSize_t items = AvFILLp((AV*)sstr) + 1;
10206 src_ary = AvARRAY((AV*)sstr);
10207 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10208 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10209 AvARRAY((AV*)dstr) = dst_ary;
10210 AvALLOC((AV*)dstr) = dst_ary;
10211 if (AvREAL((AV*)sstr)) {
10212 while (items-- > 0)
10213 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10216 while (items-- > 0)
10217 *dst_ary++ = sv_dup(*src_ary++, param);
10219 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10220 while (items-- > 0) {
10221 *dst_ary++ = &PL_sv_undef;
10225 AvARRAY((AV*)dstr) = NULL;
10226 AvALLOC((AV*)dstr) = (SV**)NULL;
10230 if (HvARRAY((HV*)sstr)) {
10232 const bool sharekeys = !!HvSHAREKEYS(sstr);
10233 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10234 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10236 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10237 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10239 HvARRAY(dstr) = (HE**)darray;
10240 while (i <= sxhv->xhv_max) {
10241 const HE * const source = HvARRAY(sstr)[i];
10242 HvARRAY(dstr)[i] = source
10243 ? he_dup(source, sharekeys, param) : 0;
10248 const struct xpvhv_aux * const saux = HvAUX(sstr);
10249 struct xpvhv_aux * const daux = HvAUX(dstr);
10250 /* This flag isn't copied. */
10251 /* SvOOK_on(hv) attacks the IV flags. */
10252 SvFLAGS(dstr) |= SVf_OOK;
10254 hvname = saux->xhv_name;
10255 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10257 daux->xhv_riter = saux->xhv_riter;
10258 daux->xhv_eiter = saux->xhv_eiter
10259 ? he_dup(saux->xhv_eiter,
10260 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10261 daux->xhv_backreferences =
10262 saux->xhv_backreferences
10263 ? (AV*) SvREFCNT_inc(
10264 sv_dup((SV*)saux->xhv_backreferences, param))
10267 daux->xhv_mro_meta = saux->xhv_mro_meta
10268 ? mro_meta_dup(saux->xhv_mro_meta, param)
10271 /* Record stashes for possible cloning in Perl_clone(). */
10273 av_push(param->stashes, dstr);
10277 HvARRAY((HV*)dstr) = NULL;
10280 if (!(param->flags & CLONEf_COPY_STACKS)) {
10284 /* NOTE: not refcounted */
10285 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10287 if (!CvISXSUB(dstr))
10288 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10290 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10291 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10292 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10293 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10295 /* don't dup if copying back - CvGV isn't refcounted, so the
10296 * duped GV may never be freed. A bit of a hack! DAPM */
10297 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10298 NULL : gv_dup(CvGV(dstr), param) ;
10299 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10301 CvWEAKOUTSIDE(sstr)
10302 ? cv_dup( CvOUTSIDE(dstr), param)
10303 : cv_dup_inc(CvOUTSIDE(dstr), param);
10304 if (!CvISXSUB(dstr))
10305 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10311 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10317 /* duplicate a context */
10320 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10322 PERL_CONTEXT *ncxs;
10325 return (PERL_CONTEXT*)NULL;
10327 /* look for it in the table first */
10328 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10332 /* create anew and remember what it is */
10333 Newxz(ncxs, max + 1, PERL_CONTEXT);
10334 ptr_table_store(PL_ptr_table, cxs, ncxs);
10337 PERL_CONTEXT * const cx = &cxs[ix];
10338 PERL_CONTEXT * const ncx = &ncxs[ix];
10339 ncx->cx_type = cx->cx_type;
10340 if (CxTYPE(cx) == CXt_SUBST) {
10341 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10344 ncx->blk_oldsp = cx->blk_oldsp;
10345 ncx->blk_oldcop = cx->blk_oldcop;
10346 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10347 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10348 ncx->blk_oldpm = cx->blk_oldpm;
10349 ncx->blk_gimme = cx->blk_gimme;
10350 switch (CxTYPE(cx)) {
10352 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10353 ? cv_dup_inc(cx->blk_sub.cv, param)
10354 : cv_dup(cx->blk_sub.cv,param));
10355 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10356 ? av_dup_inc(cx->blk_sub.argarray, param)
10358 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10359 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10360 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10361 ncx->blk_sub.lval = cx->blk_sub.lval;
10362 ncx->blk_sub.retop = cx->blk_sub.retop;
10363 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10364 cx->blk_sub.oldcomppad);
10367 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10368 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10369 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10370 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10371 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10372 ncx->blk_eval.retop = cx->blk_eval.retop;
10375 ncx->blk_loop.label = cx->blk_loop.label;
10376 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10377 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10378 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10379 ? cx->blk_loop.iterdata
10380 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10381 ncx->blk_loop.oldcomppad
10382 = (PAD*)ptr_table_fetch(PL_ptr_table,
10383 cx->blk_loop.oldcomppad);
10384 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10385 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10386 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10387 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10388 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10391 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10392 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10393 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10394 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10395 ncx->blk_sub.retop = cx->blk_sub.retop;
10407 /* duplicate a stack info structure */
10410 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10415 return (PERL_SI*)NULL;
10417 /* look for it in the table first */
10418 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10422 /* create anew and remember what it is */
10423 Newxz(nsi, 1, PERL_SI);
10424 ptr_table_store(PL_ptr_table, si, nsi);
10426 nsi->si_stack = av_dup_inc(si->si_stack, param);
10427 nsi->si_cxix = si->si_cxix;
10428 nsi->si_cxmax = si->si_cxmax;
10429 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10430 nsi->si_type = si->si_type;
10431 nsi->si_prev = si_dup(si->si_prev, param);
10432 nsi->si_next = si_dup(si->si_next, param);
10433 nsi->si_markoff = si->si_markoff;
10438 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10439 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10440 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10441 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10442 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10443 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10444 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10445 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10446 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10447 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10448 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10449 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10450 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10451 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10454 #define pv_dup_inc(p) SAVEPV(p)
10455 #define pv_dup(p) SAVEPV(p)
10456 #define svp_dup_inc(p,pp) any_dup(p,pp)
10458 /* map any object to the new equivent - either something in the
10459 * ptr table, or something in the interpreter structure
10463 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10468 return (void*)NULL;
10470 /* look for it in the table first */
10471 ret = ptr_table_fetch(PL_ptr_table, v);
10475 /* see if it is part of the interpreter structure */
10476 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10477 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10485 /* duplicate the save stack */
10488 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10491 ANY * const ss = proto_perl->Isavestack;
10492 const I32 max = proto_perl->Isavestack_max;
10493 I32 ix = proto_perl->Isavestack_ix;
10506 void (*dptr) (void*);
10507 void (*dxptr) (pTHX_ void*);
10509 Newxz(nss, max, ANY);
10512 const I32 type = POPINT(ss,ix);
10513 TOPINT(nss,ix) = type;
10515 case SAVEt_HELEM: /* hash element */
10516 sv = (SV*)POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10519 case SAVEt_ITEM: /* normal string */
10520 case SAVEt_SV: /* scalar reference */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10525 case SAVEt_MORTALIZESV:
10526 sv = (SV*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10529 case SAVEt_SHARED_PVREF: /* char* in shared space */
10530 c = (char*)POPPTR(ss,ix);
10531 TOPPTR(nss,ix) = savesharedpv(c);
10532 ptr = POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10535 case SAVEt_GENERIC_SVREF: /* generic sv */
10536 case SAVEt_SVREF: /* scalar reference */
10537 sv = (SV*)POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10539 ptr = POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10542 case SAVEt_HV: /* hash reference */
10543 case SAVEt_AV: /* array reference */
10544 sv = (SV*) POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10547 case SAVEt_COMPPAD:
10549 sv = (SV*) POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup(sv, param);
10552 case SAVEt_INT: /* int reference */
10553 ptr = POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10555 intval = (int)POPINT(ss,ix);
10556 TOPINT(nss,ix) = intval;
10558 case SAVEt_LONG: /* long reference */
10559 ptr = POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10562 case SAVEt_CLEARSV:
10563 longval = (long)POPLONG(ss,ix);
10564 TOPLONG(nss,ix) = longval;
10566 case SAVEt_I32: /* I32 reference */
10567 case SAVEt_I16: /* I16 reference */
10568 case SAVEt_I8: /* I8 reference */
10569 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10570 ptr = POPPTR(ss,ix);
10571 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10573 TOPINT(nss,ix) = i;
10575 case SAVEt_IV: /* IV reference */
10576 ptr = POPPTR(ss,ix);
10577 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10579 TOPIV(nss,ix) = iv;
10581 case SAVEt_HPTR: /* HV* reference */
10582 case SAVEt_APTR: /* AV* reference */
10583 case SAVEt_SPTR: /* SV* reference */
10584 ptr = POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10586 sv = (SV*)POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = sv_dup(sv, param);
10589 case SAVEt_VPTR: /* random* reference */
10590 ptr = POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10595 case SAVEt_GENERIC_PVREF: /* generic char* */
10596 case SAVEt_PPTR: /* char* reference */
10597 ptr = POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10599 c = (char*)POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = pv_dup(c);
10602 case SAVEt_GP: /* scalar reference */
10603 gp = (GP*)POPPTR(ss,ix);
10604 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10605 (void)GpREFCNT_inc(gp);
10606 gv = (GV*)POPPTR(ss,ix);
10607 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10610 ptr = POPPTR(ss,ix);
10611 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10612 /* these are assumed to be refcounted properly */
10614 switch (((OP*)ptr)->op_type) {
10616 case OP_LEAVESUBLV:
10620 case OP_LEAVEWRITE:
10621 TOPPTR(nss,ix) = ptr;
10624 (void) OpREFCNT_inc(o);
10628 TOPPTR(nss,ix) = NULL;
10633 TOPPTR(nss,ix) = NULL;
10636 c = (char*)POPPTR(ss,ix);
10637 TOPPTR(nss,ix) = pv_dup_inc(c);
10640 hv = (HV*)POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10642 c = (char*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = pv_dup_inc(c);
10645 case SAVEt_STACK_POS: /* Position on Perl stack */
10647 TOPINT(nss,ix) = i;
10649 case SAVEt_DESTRUCTOR:
10650 ptr = POPPTR(ss,ix);
10651 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10652 dptr = POPDPTR(ss,ix);
10653 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10654 any_dup(FPTR2DPTR(void *, dptr),
10657 case SAVEt_DESTRUCTOR_X:
10658 ptr = POPPTR(ss,ix);
10659 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10660 dxptr = POPDXPTR(ss,ix);
10661 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10662 any_dup(FPTR2DPTR(void *, dxptr),
10665 case SAVEt_REGCONTEXT:
10668 TOPINT(nss,ix) = i;
10671 case SAVEt_AELEM: /* array element */
10672 sv = (SV*)POPPTR(ss,ix);
10673 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10675 TOPINT(nss,ix) = i;
10676 av = (AV*)POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = av_dup_inc(av, param);
10680 ptr = POPPTR(ss,ix);
10681 TOPPTR(nss,ix) = ptr;
10685 TOPINT(nss,ix) = i;
10686 ptr = POPPTR(ss,ix);
10689 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10690 HINTS_REFCNT_UNLOCK;
10692 TOPPTR(nss,ix) = ptr;
10693 if (i & HINT_LOCALIZE_HH) {
10694 hv = (HV*)POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10699 longval = (long)POPLONG(ss,ix);
10700 TOPLONG(nss,ix) = longval;
10701 ptr = POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10703 sv = (SV*)POPPTR(ss,ix);
10704 TOPPTR(nss,ix) = sv_dup(sv, param);
10707 ptr = POPPTR(ss,ix);
10708 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10709 longval = (long)POPBOOL(ss,ix);
10710 TOPBOOL(nss,ix) = (bool)longval;
10712 case SAVEt_SET_SVFLAGS:
10714 TOPINT(nss,ix) = i;
10716 TOPINT(nss,ix) = i;
10717 sv = (SV*)POPPTR(ss,ix);
10718 TOPPTR(nss,ix) = sv_dup(sv, param);
10720 case SAVEt_RE_STATE:
10722 const struct re_save_state *const old_state
10723 = (struct re_save_state *)
10724 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10725 struct re_save_state *const new_state
10726 = (struct re_save_state *)
10727 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10729 Copy(old_state, new_state, 1, struct re_save_state);
10730 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10732 new_state->re_state_bostr
10733 = pv_dup(old_state->re_state_bostr);
10734 new_state->re_state_reginput
10735 = pv_dup(old_state->re_state_reginput);
10736 new_state->re_state_regeol
10737 = pv_dup(old_state->re_state_regeol);
10738 new_state->re_state_regoffs
10739 = (regexp_paren_pair*)
10740 any_dup(old_state->re_state_regoffs, proto_perl);
10741 new_state->re_state_reglastparen
10742 = (U32*) any_dup(old_state->re_state_reglastparen,
10744 new_state->re_state_reglastcloseparen
10745 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10747 /* XXX This just has to be broken. The old save_re_context
10748 code did SAVEGENERICPV(PL_reg_start_tmp);
10749 PL_reg_start_tmp is char **.
10750 Look above to what the dup code does for
10751 SAVEt_GENERIC_PVREF
10752 It can never have worked.
10753 So this is merely a faithful copy of the exiting bug: */
10754 new_state->re_state_reg_start_tmp
10755 = (char **) pv_dup((char *)
10756 old_state->re_state_reg_start_tmp);
10757 /* I assume that it only ever "worked" because no-one called
10758 (pseudo)fork while the regexp engine had re-entered itself.
10760 #ifdef PERL_OLD_COPY_ON_WRITE
10761 new_state->re_state_nrs
10762 = sv_dup(old_state->re_state_nrs, param);
10764 new_state->re_state_reg_magic
10765 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10767 new_state->re_state_reg_oldcurpm
10768 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10770 new_state->re_state_reg_curpm
10771 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10773 new_state->re_state_reg_oldsaved
10774 = pv_dup(old_state->re_state_reg_oldsaved);
10775 new_state->re_state_reg_poscache
10776 = pv_dup(old_state->re_state_reg_poscache);
10777 new_state->re_state_reg_starttry
10778 = pv_dup(old_state->re_state_reg_starttry);
10781 case SAVEt_COMPILE_WARNINGS:
10782 ptr = POPPTR(ss,ix);
10783 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10786 ptr = POPPTR(ss,ix);
10787 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10791 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10799 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10800 * flag to the result. This is done for each stash before cloning starts,
10801 * so we know which stashes want their objects cloned */
10804 do_mark_cloneable_stash(pTHX_ SV *sv)
10806 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10808 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10809 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10810 if (cloner && GvCV(cloner)) {
10817 XPUSHs(sv_2mortal(newSVhek(hvname)));
10819 call_sv((SV*)GvCV(cloner), G_SCALAR);
10826 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10834 =for apidoc perl_clone
10836 Create and return a new interpreter by cloning the current one.
10838 perl_clone takes these flags as parameters:
10840 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10841 without it we only clone the data and zero the stacks,
10842 with it we copy the stacks and the new perl interpreter is
10843 ready to run at the exact same point as the previous one.
10844 The pseudo-fork code uses COPY_STACKS while the
10845 threads->create doesn't.
10847 CLONEf_KEEP_PTR_TABLE
10848 perl_clone keeps a ptr_table with the pointer of the old
10849 variable as a key and the new variable as a value,
10850 this allows it to check if something has been cloned and not
10851 clone it again but rather just use the value and increase the
10852 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10853 the ptr_table using the function
10854 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10855 reason to keep it around is if you want to dup some of your own
10856 variable who are outside the graph perl scans, example of this
10857 code is in threads.xs create
10860 This is a win32 thing, it is ignored on unix, it tells perls
10861 win32host code (which is c++) to clone itself, this is needed on
10862 win32 if you want to run two threads at the same time,
10863 if you just want to do some stuff in a separate perl interpreter
10864 and then throw it away and return to the original one,
10865 you don't need to do anything.
10870 /* XXX the above needs expanding by someone who actually understands it ! */
10871 EXTERN_C PerlInterpreter *
10872 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10875 perl_clone(PerlInterpreter *proto_perl, UV flags)
10878 #ifdef PERL_IMPLICIT_SYS
10880 /* perlhost.h so we need to call into it
10881 to clone the host, CPerlHost should have a c interface, sky */
10883 if (flags & CLONEf_CLONE_HOST) {
10884 return perl_clone_host(proto_perl,flags);
10886 return perl_clone_using(proto_perl, flags,
10888 proto_perl->IMemShared,
10889 proto_perl->IMemParse,
10891 proto_perl->IStdIO,
10895 proto_perl->IProc);
10899 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10900 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10901 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10902 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10903 struct IPerlDir* ipD, struct IPerlSock* ipS,
10904 struct IPerlProc* ipP)
10906 /* XXX many of the string copies here can be optimized if they're
10907 * constants; they need to be allocated as common memory and just
10908 * their pointers copied. */
10911 CLONE_PARAMS clone_params;
10912 CLONE_PARAMS* const param = &clone_params;
10914 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10915 /* for each stash, determine whether its objects should be cloned */
10916 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10917 PERL_SET_THX(my_perl);
10920 PoisonNew(my_perl, 1, PerlInterpreter);
10926 PL_savestack_ix = 0;
10927 PL_savestack_max = -1;
10928 PL_sig_pending = 0;
10930 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10931 # else /* !DEBUGGING */
10932 Zero(my_perl, 1, PerlInterpreter);
10933 # endif /* DEBUGGING */
10935 /* host pointers */
10937 PL_MemShared = ipMS;
10938 PL_MemParse = ipMP;
10945 #else /* !PERL_IMPLICIT_SYS */
10947 CLONE_PARAMS clone_params;
10948 CLONE_PARAMS* param = &clone_params;
10949 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10950 /* for each stash, determine whether its objects should be cloned */
10951 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10952 PERL_SET_THX(my_perl);
10955 PoisonNew(my_perl, 1, PerlInterpreter);
10961 PL_savestack_ix = 0;
10962 PL_savestack_max = -1;
10963 PL_sig_pending = 0;
10965 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10966 # else /* !DEBUGGING */
10967 Zero(my_perl, 1, PerlInterpreter);
10968 # endif /* DEBUGGING */
10969 #endif /* PERL_IMPLICIT_SYS */
10970 param->flags = flags;
10971 param->proto_perl = proto_perl;
10973 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10975 PL_body_arenas = NULL;
10976 Zero(&PL_body_roots, 1, PL_body_roots);
10978 PL_nice_chunk = NULL;
10979 PL_nice_chunk_size = 0;
10981 PL_sv_objcount = 0;
10983 PL_sv_arenaroot = NULL;
10985 PL_debug = proto_perl->Idebug;
10987 PL_hash_seed = proto_perl->Ihash_seed;
10988 PL_rehash_seed = proto_perl->Irehash_seed;
10990 #ifdef USE_REENTRANT_API
10991 /* XXX: things like -Dm will segfault here in perlio, but doing
10992 * PERL_SET_CONTEXT(proto_perl);
10993 * breaks too many other things
10995 Perl_reentrant_init(aTHX);
10998 /* create SV map for pointer relocation */
10999 PL_ptr_table = ptr_table_new();
11001 /* initialize these special pointers as early as possible */
11002 SvANY(&PL_sv_undef) = NULL;
11003 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11004 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11005 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11007 SvANY(&PL_sv_no) = new_XPVNV();
11008 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11009 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11010 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11011 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11012 SvCUR_set(&PL_sv_no, 0);
11013 SvLEN_set(&PL_sv_no, 1);
11014 SvIV_set(&PL_sv_no, 0);
11015 SvNV_set(&PL_sv_no, 0);
11016 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11018 SvANY(&PL_sv_yes) = new_XPVNV();
11019 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11020 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11021 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11022 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11023 SvCUR_set(&PL_sv_yes, 1);
11024 SvLEN_set(&PL_sv_yes, 2);
11025 SvIV_set(&PL_sv_yes, 1);
11026 SvNV_set(&PL_sv_yes, 1);
11027 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11029 /* create (a non-shared!) shared string table */
11030 PL_strtab = newHV();
11031 HvSHAREKEYS_off(PL_strtab);
11032 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11033 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11035 PL_compiling = proto_perl->Icompiling;
11037 /* These two PVs will be free'd special way so must set them same way op.c does */
11038 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11039 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11041 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11042 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11044 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11045 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11046 if (PL_compiling.cop_hints_hash) {
11048 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11049 HINTS_REFCNT_UNLOCK;
11051 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11052 #ifdef PERL_DEBUG_READONLY_OPS
11057 /* pseudo environmental stuff */
11058 PL_origargc = proto_perl->Iorigargc;
11059 PL_origargv = proto_perl->Iorigargv;
11061 param->stashes = newAV(); /* Setup array of objects to call clone on */
11063 /* Set tainting stuff before PerlIO_debug can possibly get called */
11064 PL_tainting = proto_perl->Itainting;
11065 PL_taint_warn = proto_perl->Itaint_warn;
11067 #ifdef PERLIO_LAYERS
11068 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11069 PerlIO_clone(aTHX_ proto_perl, param);
11072 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11073 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11074 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11075 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11076 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11077 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11080 PL_minus_c = proto_perl->Iminus_c;
11081 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11082 PL_localpatches = proto_perl->Ilocalpatches;
11083 PL_splitstr = proto_perl->Isplitstr;
11084 PL_preprocess = proto_perl->Ipreprocess;
11085 PL_minus_n = proto_perl->Iminus_n;
11086 PL_minus_p = proto_perl->Iminus_p;
11087 PL_minus_l = proto_perl->Iminus_l;
11088 PL_minus_a = proto_perl->Iminus_a;
11089 PL_minus_E = proto_perl->Iminus_E;
11090 PL_minus_F = proto_perl->Iminus_F;
11091 PL_doswitches = proto_perl->Idoswitches;
11092 PL_dowarn = proto_perl->Idowarn;
11093 PL_doextract = proto_perl->Idoextract;
11094 PL_sawampersand = proto_perl->Isawampersand;
11095 PL_unsafe = proto_perl->Iunsafe;
11096 PL_inplace = SAVEPV(proto_perl->Iinplace);
11097 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11098 PL_perldb = proto_perl->Iperldb;
11099 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11100 PL_exit_flags = proto_perl->Iexit_flags;
11102 /* magical thingies */
11103 /* XXX time(&PL_basetime) when asked for? */
11104 PL_basetime = proto_perl->Ibasetime;
11105 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11107 PL_maxsysfd = proto_perl->Imaxsysfd;
11108 PL_statusvalue = proto_perl->Istatusvalue;
11110 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11112 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11114 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11116 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11117 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11118 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11121 /* RE engine related */
11122 Zero(&PL_reg_state, 1, struct re_save_state);
11123 PL_reginterp_cnt = 0;
11124 PL_regmatch_slab = NULL;
11126 /* Clone the regex array */
11127 PL_regex_padav = newAV();
11129 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11130 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11132 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11133 for(i = 1; i <= len; i++) {
11134 const SV * const regex = regexen[i];
11137 ? sv_dup_inc(regex, param)
11139 newSViv(PTR2IV(CALLREGDUPE(
11140 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11142 if (SvFLAGS(regex) & SVf_BREAK)
11143 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11144 av_push(PL_regex_padav, sv);
11147 PL_regex_pad = AvARRAY(PL_regex_padav);
11149 /* shortcuts to various I/O objects */
11150 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11151 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11152 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11153 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11154 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11155 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11157 /* shortcuts to regexp stuff */
11158 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11160 /* shortcuts to misc objects */
11161 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11163 /* shortcuts to debugging objects */
11164 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11165 PL_DBline = gv_dup(proto_perl->IDBline, param);
11166 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11167 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11168 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11169 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11170 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11172 /* symbol tables */
11173 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11174 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11175 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11176 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11177 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11179 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11180 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11181 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11182 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11183 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11184 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11185 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11186 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11188 PL_sub_generation = proto_perl->Isub_generation;
11189 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11191 /* funky return mechanisms */
11192 PL_forkprocess = proto_perl->Iforkprocess;
11194 /* subprocess state */
11195 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11197 /* internal state */
11198 PL_maxo = proto_perl->Imaxo;
11199 if (proto_perl->Iop_mask)
11200 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11203 /* PL_asserting = proto_perl->Iasserting; */
11205 /* current interpreter roots */
11206 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11208 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11210 PL_main_start = proto_perl->Imain_start;
11211 PL_eval_root = proto_perl->Ieval_root;
11212 PL_eval_start = proto_perl->Ieval_start;
11214 /* runtime control stuff */
11215 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11217 PL_filemode = proto_perl->Ifilemode;
11218 PL_lastfd = proto_perl->Ilastfd;
11219 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11222 PL_gensym = proto_perl->Igensym;
11223 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11224 PL_laststatval = proto_perl->Ilaststatval;
11225 PL_laststype = proto_perl->Ilaststype;
11228 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11230 /* interpreter atexit processing */
11231 PL_exitlistlen = proto_perl->Iexitlistlen;
11232 if (PL_exitlistlen) {
11233 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11234 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11237 PL_exitlist = (PerlExitListEntry*)NULL;
11239 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11240 if (PL_my_cxt_size) {
11241 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11242 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11243 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11244 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11245 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11249 PL_my_cxt_list = (void**)NULL;
11250 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11251 PL_my_cxt_keys = (const char**)NULL;
11254 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11255 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11256 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11258 PL_profiledata = NULL;
11260 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11262 PAD_CLONE_VARS(proto_perl, param);
11264 #ifdef HAVE_INTERP_INTERN
11265 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11268 /* more statics moved here */
11269 PL_generation = proto_perl->Igeneration;
11270 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11272 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11273 PL_in_clean_all = proto_perl->Iin_clean_all;
11275 PL_uid = proto_perl->Iuid;
11276 PL_euid = proto_perl->Ieuid;
11277 PL_gid = proto_perl->Igid;
11278 PL_egid = proto_perl->Iegid;
11279 PL_nomemok = proto_perl->Inomemok;
11280 PL_an = proto_perl->Ian;
11281 PL_evalseq = proto_perl->Ievalseq;
11282 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11283 PL_origalen = proto_perl->Iorigalen;
11284 #ifdef PERL_USES_PL_PIDSTATUS
11285 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11287 PL_osname = SAVEPV(proto_perl->Iosname);
11288 PL_sighandlerp = proto_perl->Isighandlerp;
11290 PL_runops = proto_perl->Irunops;
11292 PL_parser = parser_dup(proto_perl->Iparser, param);
11294 PL_subline = proto_perl->Isubline;
11295 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11298 PL_cryptseen = proto_perl->Icryptseen;
11301 PL_hints = proto_perl->Ihints;
11303 PL_amagic_generation = proto_perl->Iamagic_generation;
11305 #ifdef USE_LOCALE_COLLATE
11306 PL_collation_ix = proto_perl->Icollation_ix;
11307 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11308 PL_collation_standard = proto_perl->Icollation_standard;
11309 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11310 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11311 #endif /* USE_LOCALE_COLLATE */
11313 #ifdef USE_LOCALE_NUMERIC
11314 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11315 PL_numeric_standard = proto_perl->Inumeric_standard;
11316 PL_numeric_local = proto_perl->Inumeric_local;
11317 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11318 #endif /* !USE_LOCALE_NUMERIC */
11320 /* utf8 character classes */
11321 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11322 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11323 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11324 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11325 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11326 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11327 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11328 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11329 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11330 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11331 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11332 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11333 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11334 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11335 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11336 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11337 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11338 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11339 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11340 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11342 /* Did the locale setup indicate UTF-8? */
11343 PL_utf8locale = proto_perl->Iutf8locale;
11344 /* Unicode features (see perlrun/-C) */
11345 PL_unicode = proto_perl->Iunicode;
11347 /* Pre-5.8 signals control */
11348 PL_signals = proto_perl->Isignals;
11350 /* times() ticks per second */
11351 PL_clocktick = proto_perl->Iclocktick;
11353 /* Recursion stopper for PerlIO_find_layer */
11354 PL_in_load_module = proto_perl->Iin_load_module;
11356 /* sort() routine */
11357 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11359 /* Not really needed/useful since the reenrant_retint is "volatile",
11360 * but do it for consistency's sake. */
11361 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11363 /* Hooks to shared SVs and locks. */
11364 PL_sharehook = proto_perl->Isharehook;
11365 PL_lockhook = proto_perl->Ilockhook;
11366 PL_unlockhook = proto_perl->Iunlockhook;
11367 PL_threadhook = proto_perl->Ithreadhook;
11369 #ifdef THREADS_HAVE_PIDS
11370 PL_ppid = proto_perl->Ippid;
11374 PL_last_swash_hv = NULL; /* reinits on demand */
11375 PL_last_swash_klen = 0;
11376 PL_last_swash_key[0]= '\0';
11377 PL_last_swash_tmps = (U8*)NULL;
11378 PL_last_swash_slen = 0;
11380 PL_glob_index = proto_perl->Iglob_index;
11381 PL_srand_called = proto_perl->Isrand_called;
11382 PL_bitcount = NULL; /* reinits on demand */
11384 if (proto_perl->Ipsig_pend) {
11385 Newxz(PL_psig_pend, SIG_SIZE, int);
11388 PL_psig_pend = (int*)NULL;
11391 if (proto_perl->Ipsig_ptr) {
11392 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11393 Newxz(PL_psig_name, SIG_SIZE, SV*);
11394 for (i = 1; i < SIG_SIZE; i++) {
11395 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11396 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11400 PL_psig_ptr = (SV**)NULL;
11401 PL_psig_name = (SV**)NULL;
11404 /* intrpvar.h stuff */
11406 if (flags & CLONEf_COPY_STACKS) {
11407 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11408 PL_tmps_ix = proto_perl->Itmps_ix;
11409 PL_tmps_max = proto_perl->Itmps_max;
11410 PL_tmps_floor = proto_perl->Itmps_floor;
11411 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11413 while (i <= PL_tmps_ix) {
11414 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11418 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11419 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11420 Newxz(PL_markstack, i, I32);
11421 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11422 - proto_perl->Imarkstack);
11423 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11424 - proto_perl->Imarkstack);
11425 Copy(proto_perl->Imarkstack, PL_markstack,
11426 PL_markstack_ptr - PL_markstack + 1, I32);
11428 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11429 * NOTE: unlike the others! */
11430 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11431 PL_scopestack_max = proto_perl->Iscopestack_max;
11432 Newxz(PL_scopestack, PL_scopestack_max, I32);
11433 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11435 /* NOTE: si_dup() looks at PL_markstack */
11436 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11438 /* PL_curstack = PL_curstackinfo->si_stack; */
11439 PL_curstack = av_dup(proto_perl->Icurstack, param);
11440 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11442 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11443 PL_stack_base = AvARRAY(PL_curstack);
11444 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11445 - proto_perl->Istack_base);
11446 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11448 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11449 * NOTE: unlike the others! */
11450 PL_savestack_ix = proto_perl->Isavestack_ix;
11451 PL_savestack_max = proto_perl->Isavestack_max;
11452 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11453 PL_savestack = ss_dup(proto_perl, param);
11457 ENTER; /* perl_destruct() wants to LEAVE; */
11459 /* although we're not duplicating the tmps stack, we should still
11460 * add entries for any SVs on the tmps stack that got cloned by a
11461 * non-refcount means (eg a temp in @_); otherwise they will be
11464 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11465 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11466 proto_perl->Itmps_stack[i]);
11467 if (nsv && !SvREFCNT(nsv)) {
11469 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11474 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11475 PL_top_env = &PL_start_env;
11477 PL_op = proto_perl->Iop;
11480 PL_Xpv = (XPV*)NULL;
11481 PL_na = proto_perl->Ina;
11483 PL_statbuf = proto_perl->Istatbuf;
11484 PL_statcache = proto_perl->Istatcache;
11485 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11486 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11488 PL_timesbuf = proto_perl->Itimesbuf;
11491 PL_tainted = proto_perl->Itainted;
11492 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11493 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11494 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11495 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11496 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11497 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11498 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11499 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11500 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11502 PL_restartop = proto_perl->Irestartop;
11503 PL_in_eval = proto_perl->Iin_eval;
11504 PL_delaymagic = proto_perl->Idelaymagic;
11505 PL_dirty = proto_perl->Idirty;
11506 PL_localizing = proto_perl->Ilocalizing;
11508 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11509 PL_hv_fetch_ent_mh = NULL;
11510 PL_modcount = proto_perl->Imodcount;
11511 PL_lastgotoprobe = NULL;
11512 PL_dumpindent = proto_perl->Idumpindent;
11514 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11515 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11516 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11517 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11518 PL_efloatbuf = NULL; /* reinits on demand */
11519 PL_efloatsize = 0; /* reinits on demand */
11523 PL_screamfirst = NULL;
11524 PL_screamnext = NULL;
11525 PL_maxscream = -1; /* reinits on demand */
11526 PL_lastscream = NULL;
11529 PL_regdummy = proto_perl->Iregdummy;
11530 PL_colorset = 0; /* reinits PL_colors[] */
11531 /*PL_colors[6] = {0,0,0,0,0,0};*/
11535 /* Pluggable optimizer */
11536 PL_peepp = proto_perl->Ipeepp;
11538 PL_stashcache = newHV();
11540 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11541 proto_perl->Iwatchaddr);
11542 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11543 if (PL_debug && PL_watchaddr) {
11544 PerlIO_printf(Perl_debug_log,
11545 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11546 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11547 PTR2UV(PL_watchok));
11550 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11551 ptr_table_free(PL_ptr_table);
11552 PL_ptr_table = NULL;
11555 /* Call the ->CLONE method, if it exists, for each of the stashes
11556 identified by sv_dup() above.
11558 while(av_len(param->stashes) != -1) {
11559 HV* const stash = (HV*) av_shift(param->stashes);
11560 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11561 if (cloner && GvCV(cloner)) {
11566 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11568 call_sv((SV*)GvCV(cloner), G_DISCARD);
11574 SvREFCNT_dec(param->stashes);
11576 /* orphaned? eg threads->new inside BEGIN or use */
11577 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11578 SvREFCNT_inc_simple_void(PL_compcv);
11579 SAVEFREESV(PL_compcv);
11585 #endif /* USE_ITHREADS */
11588 =head1 Unicode Support
11590 =for apidoc sv_recode_to_utf8
11592 The encoding is assumed to be an Encode object, on entry the PV
11593 of the sv is assumed to be octets in that encoding, and the sv
11594 will be converted into Unicode (and UTF-8).
11596 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11597 is not a reference, nothing is done to the sv. If the encoding is not
11598 an C<Encode::XS> Encoding object, bad things will happen.
11599 (See F<lib/encoding.pm> and L<Encode>).
11601 The PV of the sv is returned.
11606 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11609 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11623 Passing sv_yes is wrong - it needs to be or'ed set of constants
11624 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11625 remove converted chars from source.
11627 Both will default the value - let them.
11629 XPUSHs(&PL_sv_yes);
11632 call_method("decode", G_SCALAR);
11636 s = SvPV_const(uni, len);
11637 if (s != SvPVX_const(sv)) {
11638 SvGROW(sv, len + 1);
11639 Move(s, SvPVX(sv), len + 1, char);
11640 SvCUR_set(sv, len);
11647 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11651 =for apidoc sv_cat_decode
11653 The encoding is assumed to be an Encode object, the PV of the ssv is
11654 assumed to be octets in that encoding and decoding the input starts
11655 from the position which (PV + *offset) pointed to. The dsv will be
11656 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11657 when the string tstr appears in decoding output or the input ends on
11658 the PV of the ssv. The value which the offset points will be modified
11659 to the last input position on the ssv.
11661 Returns TRUE if the terminator was found, else returns FALSE.
11666 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11667 SV *ssv, int *offset, char *tstr, int tlen)
11671 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11682 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11683 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11685 call_method("cat_decode", G_SCALAR);
11687 ret = SvTRUE(TOPs);
11688 *offset = SvIV(offsv);
11694 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11699 /* ---------------------------------------------------------------------
11701 * support functions for report_uninit()
11704 /* the maxiumum size of array or hash where we will scan looking
11705 * for the undefined element that triggered the warning */
11707 #define FUV_MAX_SEARCH_SIZE 1000
11709 /* Look for an entry in the hash whose value has the same SV as val;
11710 * If so, return a mortal copy of the key. */
11713 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11716 register HE **array;
11719 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11720 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11723 array = HvARRAY(hv);
11725 for (i=HvMAX(hv); i>0; i--) {
11726 register HE *entry;
11727 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11728 if (HeVAL(entry) != val)
11730 if ( HeVAL(entry) == &PL_sv_undef ||
11731 HeVAL(entry) == &PL_sv_placeholder)
11735 if (HeKLEN(entry) == HEf_SVKEY)
11736 return sv_mortalcopy(HeKEY_sv(entry));
11737 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11743 /* Look for an entry in the array whose value has the same SV as val;
11744 * If so, return the index, otherwise return -1. */
11747 S_find_array_subscript(pTHX_ AV *av, SV* val)
11750 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11751 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11754 if (val != &PL_sv_undef) {
11755 SV ** const svp = AvARRAY(av);
11758 for (i=AvFILLp(av); i>=0; i--)
11765 /* S_varname(): return the name of a variable, optionally with a subscript.
11766 * If gv is non-zero, use the name of that global, along with gvtype (one
11767 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11768 * targ. Depending on the value of the subscript_type flag, return:
11771 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11772 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11773 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11774 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11777 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11778 SV* keyname, I32 aindex, int subscript_type)
11781 SV * const name = sv_newmortal();
11784 buffer[0] = gvtype;
11787 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11789 gv_fullname4(name, gv, buffer, 0);
11791 if ((unsigned int)SvPVX(name)[1] <= 26) {
11793 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11795 /* Swap the 1 unprintable control character for the 2 byte pretty
11796 version - ie substr($name, 1, 1) = $buffer; */
11797 sv_insert(name, 1, 1, buffer, 2);
11801 CV * const cv = find_runcv(NULL);
11805 if (!cv || !CvPADLIST(cv))
11807 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11808 sv = *av_fetch(av, targ, FALSE);
11809 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11812 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11813 SV * const sv = newSV(0);
11814 *SvPVX(name) = '$';
11815 Perl_sv_catpvf(aTHX_ name, "{%s}",
11816 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11819 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11820 *SvPVX(name) = '$';
11821 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11823 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11824 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11831 =for apidoc find_uninit_var
11833 Find the name of the undefined variable (if any) that caused the operator o
11834 to issue a "Use of uninitialized value" warning.
11835 If match is true, only return a name if it's value matches uninit_sv.
11836 So roughly speaking, if a unary operator (such as OP_COS) generates a
11837 warning, then following the direct child of the op may yield an
11838 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11839 other hand, with OP_ADD there are two branches to follow, so we only print
11840 the variable name if we get an exact match.
11842 The name is returned as a mortal SV.
11844 Assumes that PL_op is the op that originally triggered the error, and that
11845 PL_comppad/PL_curpad points to the currently executing pad.
11851 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11859 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11860 uninit_sv == &PL_sv_placeholder)))
11863 switch (obase->op_type) {
11870 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11871 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11874 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11876 if (pad) { /* @lex, %lex */
11877 sv = PAD_SVl(obase->op_targ);
11881 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11882 /* @global, %global */
11883 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11886 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11888 else /* @{expr}, %{expr} */
11889 return find_uninit_var(cUNOPx(obase)->op_first,
11893 /* attempt to find a match within the aggregate */
11895 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11897 subscript_type = FUV_SUBSCRIPT_HASH;
11900 index = find_array_subscript((AV*)sv, uninit_sv);
11902 subscript_type = FUV_SUBSCRIPT_ARRAY;
11905 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11908 return varname(gv, hash ? '%' : '@', obase->op_targ,
11909 keysv, index, subscript_type);
11913 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11915 return varname(NULL, '$', obase->op_targ,
11916 NULL, 0, FUV_SUBSCRIPT_NONE);
11919 gv = cGVOPx_gv(obase);
11920 if (!gv || (match && GvSV(gv) != uninit_sv))
11922 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11925 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11928 av = (AV*)PAD_SV(obase->op_targ);
11929 if (!av || SvRMAGICAL(av))
11931 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11932 if (!svp || *svp != uninit_sv)
11935 return varname(NULL, '$', obase->op_targ,
11936 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11939 gv = cGVOPx_gv(obase);
11945 if (!av || SvRMAGICAL(av))
11947 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11948 if (!svp || *svp != uninit_sv)
11951 return varname(gv, '$', 0,
11952 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11957 o = cUNOPx(obase)->op_first;
11958 if (!o || o->op_type != OP_NULL ||
11959 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11961 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11965 if (PL_op == obase)
11966 /* $a[uninit_expr] or $h{uninit_expr} */
11967 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11970 o = cBINOPx(obase)->op_first;
11971 kid = cBINOPx(obase)->op_last;
11973 /* get the av or hv, and optionally the gv */
11975 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11976 sv = PAD_SV(o->op_targ);
11978 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11979 && cUNOPo->op_first->op_type == OP_GV)
11981 gv = cGVOPx_gv(cUNOPo->op_first);
11984 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11989 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11990 /* index is constant */
11994 if (obase->op_type == OP_HELEM) {
11995 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11996 if (!he || HeVAL(he) != uninit_sv)
12000 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12001 if (!svp || *svp != uninit_sv)
12005 if (obase->op_type == OP_HELEM)
12006 return varname(gv, '%', o->op_targ,
12007 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12009 return varname(gv, '@', o->op_targ, NULL,
12010 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12013 /* index is an expression;
12014 * attempt to find a match within the aggregate */
12015 if (obase->op_type == OP_HELEM) {
12016 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12018 return varname(gv, '%', o->op_targ,
12019 keysv, 0, FUV_SUBSCRIPT_HASH);
12022 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12024 return varname(gv, '@', o->op_targ,
12025 NULL, index, FUV_SUBSCRIPT_ARRAY);
12030 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12032 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12037 /* only examine RHS */
12038 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12041 o = cUNOPx(obase)->op_first;
12042 if (o->op_type == OP_PUSHMARK)
12045 if (!o->op_sibling) {
12046 /* one-arg version of open is highly magical */
12048 if (o->op_type == OP_GV) { /* open FOO; */
12050 if (match && GvSV(gv) != uninit_sv)
12052 return varname(gv, '$', 0,
12053 NULL, 0, FUV_SUBSCRIPT_NONE);
12055 /* other possibilities not handled are:
12056 * open $x; or open my $x; should return '${*$x}'
12057 * open expr; should return '$'.expr ideally
12063 /* ops where $_ may be an implicit arg */
12067 if ( !(obase->op_flags & OPf_STACKED)) {
12068 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12069 ? PAD_SVl(obase->op_targ)
12072 sv = sv_newmortal();
12073 sv_setpvn(sv, "$_", 2);
12082 /* skip filehandle as it can't produce 'undef' warning */
12083 o = cUNOPx(obase)->op_first;
12084 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12085 o = o->op_sibling->op_sibling;
12092 match = 1; /* XS or custom code could trigger random warnings */
12096 /* def-ness of rval pos() is independent of the def-ness of its arg */
12097 if ( !(obase->op_flags & OPf_MOD))
12102 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12103 return sv_2mortal(newSVpvs("${$/}"));
12108 if (!(obase->op_flags & OPf_KIDS))
12110 o = cUNOPx(obase)->op_first;
12116 /* if all except one arg are constant, or have no side-effects,
12117 * or are optimized away, then it's unambiguous */
12119 for (kid=o; kid; kid = kid->op_sibling) {
12121 const OPCODE type = kid->op_type;
12122 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12123 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12124 || (type == OP_PUSHMARK)
12128 if (o2) { /* more than one found */
12135 return find_uninit_var(o2, uninit_sv, match);
12137 /* scan all args */
12139 sv = find_uninit_var(o, uninit_sv, 1);
12151 =for apidoc report_uninit
12153 Print appropriate "Use of uninitialized variable" warning
12159 Perl_report_uninit(pTHX_ SV* uninit_sv)
12163 SV* varname = NULL;
12165 varname = find_uninit_var(PL_op, uninit_sv,0);
12167 sv_insert(varname, 0, 0, " ", 1);
12169 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12170 varname ? SvPV_nolen_const(varname) : "",
12171 " in ", OP_DESC(PL_op));
12174 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12180 * c-indentation-style: bsd
12181 * c-basic-offset: 4
12182 * indent-tabs-mode: t
12185 * ex: set ts=8 sts=4 sw=4 noet: