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? */
5108 stash = SvSTASH(sv);
5109 destructor = StashHANDLER(stash,DESTROY);
5111 SV* const tmpref = newRV(sv);
5112 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5114 PUSHSTACKi(PERLSI_DESTROY);
5119 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5125 if(SvREFCNT(tmpref) < 2) {
5126 /* tmpref is not kept alive! */
5128 SvRV_set(tmpref, NULL);
5131 SvREFCNT_dec(tmpref);
5133 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5137 if (PL_in_clean_objs)
5138 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5140 /* DESTROY gave object new lease on life */
5146 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5147 SvOBJECT_off(sv); /* Curse the object. */
5148 if (type != SVt_PVIO)
5149 --PL_sv_objcount; /* XXX Might want something more general */
5152 if (type >= SVt_PVMG) {
5153 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5154 SvREFCNT_dec(SvOURSTASH(sv));
5155 } else if (SvMAGIC(sv))
5157 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5158 SvREFCNT_dec(SvSTASH(sv));
5161 /* case SVt_BIND: */
5164 IoIFP(sv) != PerlIO_stdin() &&
5165 IoIFP(sv) != PerlIO_stdout() &&
5166 IoIFP(sv) != PerlIO_stderr())
5168 io_close((IO*)sv, FALSE);
5170 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5171 PerlDir_close(IoDIRP(sv));
5172 IoDIRP(sv) = (DIR*)NULL;
5173 Safefree(IoTOP_NAME(sv));
5174 Safefree(IoFMT_NAME(sv));
5175 Safefree(IoBOTTOM_NAME(sv));
5182 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5186 if (PL_comppad == (AV*)sv) {
5193 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5194 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5195 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5196 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5198 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5199 SvREFCNT_dec(LvTARG(sv));
5201 if (isGV_with_GP(sv)) {
5202 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5203 mro_method_changed_in(stash);
5206 unshare_hek(GvNAME_HEK(sv));
5207 /* If we're in a stash, we don't own a reference to it. However it does
5208 have a back reference to us, which needs to be cleared. */
5209 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5210 sv_del_backref((SV*)stash, sv);
5212 /* FIXME. There are probably more unreferenced pointers to SVs in the
5213 interpreter struct that we should check and tidy in a similar
5215 if ((GV*)sv == PL_last_in_gv)
5216 PL_last_in_gv = NULL;
5221 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5223 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5224 /* Don't even bother with turning off the OOK flag. */
5229 SV * const target = SvRV(sv);
5231 sv_del_backref(target, sv);
5233 SvREFCNT_dec(target);
5235 #ifdef PERL_OLD_COPY_ON_WRITE
5236 else if (SvPVX_const(sv)) {
5238 /* I believe I need to grab the global SV mutex here and
5239 then recheck the COW status. */
5241 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5245 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5247 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5250 /* And drop it here. */
5252 } else if (SvLEN(sv)) {
5253 Safefree(SvPVX_const(sv));
5257 else if (SvPVX_const(sv) && SvLEN(sv))
5258 Safefree(SvPVX_mutable(sv));
5259 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5260 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5269 SvFLAGS(sv) &= SVf_BREAK;
5270 SvFLAGS(sv) |= SVTYPEMASK;
5272 if (sv_type_details->arena) {
5273 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5274 &PL_body_roots[type]);
5276 else if (sv_type_details->body_size) {
5277 my_safefree(SvANY(sv));
5282 =for apidoc sv_newref
5284 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5291 Perl_sv_newref(pTHX_ SV *sv)
5293 PERL_UNUSED_CONTEXT;
5302 Decrement an SV's reference count, and if it drops to zero, call
5303 C<sv_clear> to invoke destructors and free up any memory used by
5304 the body; finally, deallocate the SV's head itself.
5305 Normally called via a wrapper macro C<SvREFCNT_dec>.
5311 Perl_sv_free(pTHX_ SV *sv)
5316 if (SvREFCNT(sv) == 0) {
5317 if (SvFLAGS(sv) & SVf_BREAK)
5318 /* this SV's refcnt has been artificially decremented to
5319 * trigger cleanup */
5321 if (PL_in_clean_all) /* All is fair */
5323 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5324 /* make sure SvREFCNT(sv)==0 happens very seldom */
5325 SvREFCNT(sv) = (~(U32)0)/2;
5328 if (ckWARN_d(WARN_INTERNAL)) {
5329 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5330 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5331 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5332 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5333 Perl_dump_sv_child(aTHX_ sv);
5335 #ifdef DEBUG_LEAKING_SCALARS
5342 if (--(SvREFCNT(sv)) > 0)
5344 Perl_sv_free2(aTHX_ sv);
5348 Perl_sv_free2(pTHX_ SV *sv)
5353 if (ckWARN_d(WARN_DEBUGGING))
5354 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5355 "Attempt to free temp prematurely: SV 0x%"UVxf
5356 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5360 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5361 /* make sure SvREFCNT(sv)==0 happens very seldom */
5362 SvREFCNT(sv) = (~(U32)0)/2;
5373 Returns the length of the string in the SV. Handles magic and type
5374 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5380 Perl_sv_len(pTHX_ register SV *sv)
5388 len = mg_length(sv);
5390 (void)SvPV_const(sv, len);
5395 =for apidoc sv_len_utf8
5397 Returns the number of characters in the string in an SV, counting wide
5398 UTF-8 bytes as a single character. Handles magic and type coercion.
5404 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5405 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5406 * (Note that the mg_len is not the length of the mg_ptr field.
5407 * This allows the cache to store the character length of the string without
5408 * needing to malloc() extra storage to attach to the mg_ptr.)
5413 Perl_sv_len_utf8(pTHX_ register SV *sv)
5419 return mg_length(sv);
5423 const U8 *s = (U8*)SvPV_const(sv, len);
5427 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5429 if (mg && mg->mg_len != -1) {
5431 if (PL_utf8cache < 0) {
5432 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5434 /* Need to turn the assertions off otherwise we may
5435 recurse infinitely while printing error messages.
5437 SAVEI8(PL_utf8cache);
5439 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5440 " real %"UVuf" for %"SVf,
5441 (UV) ulen, (UV) real, SVfARG(sv));
5446 ulen = Perl_utf8_length(aTHX_ s, s + len);
5447 if (!SvREADONLY(sv)) {
5449 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5450 &PL_vtbl_utf8, 0, 0);
5458 return Perl_utf8_length(aTHX_ s, s + len);
5462 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5465 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5468 const U8 *s = start;
5470 while (s < send && uoffset--)
5473 /* This is the existing behaviour. Possibly it should be a croak, as
5474 it's actually a bounds error */
5480 /* Given the length of the string in both bytes and UTF-8 characters, decide
5481 whether to walk forwards or backwards to find the byte corresponding to
5482 the passed in UTF-8 offset. */
5484 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5485 STRLEN uoffset, STRLEN uend)
5487 STRLEN backw = uend - uoffset;
5488 if (uoffset < 2 * backw) {
5489 /* The assumption is that going forwards is twice the speed of going
5490 forward (that's where the 2 * backw comes from).
5491 (The real figure of course depends on the UTF-8 data.) */
5492 return sv_pos_u2b_forwards(start, send, uoffset);
5497 while (UTF8_IS_CONTINUATION(*send))
5500 return send - start;
5503 /* For the string representation of the given scalar, find the byte
5504 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5505 give another position in the string, *before* the sought offset, which
5506 (which is always true, as 0, 0 is a valid pair of positions), which should
5507 help reduce the amount of linear searching.
5508 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5509 will be used to reduce the amount of linear searching. The cache will be
5510 created if necessary, and the found value offered to it for update. */
5512 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5513 const U8 *const send, STRLEN uoffset,
5514 STRLEN uoffset0, STRLEN boffset0) {
5515 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5518 assert (uoffset >= uoffset0);
5520 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5521 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5522 if ((*mgp)->mg_ptr) {
5523 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5524 if (cache[0] == uoffset) {
5525 /* An exact match. */
5528 if (cache[2] == uoffset) {
5529 /* An exact match. */
5533 if (cache[0] < uoffset) {
5534 /* The cache already knows part of the way. */
5535 if (cache[0] > uoffset0) {
5536 /* The cache knows more than the passed in pair */
5537 uoffset0 = cache[0];
5538 boffset0 = cache[1];
5540 if ((*mgp)->mg_len != -1) {
5541 /* And we know the end too. */
5543 + sv_pos_u2b_midway(start + boffset0, send,
5545 (*mgp)->mg_len - uoffset0);
5548 + sv_pos_u2b_forwards(start + boffset0,
5549 send, uoffset - uoffset0);
5552 else if (cache[2] < uoffset) {
5553 /* We're between the two cache entries. */
5554 if (cache[2] > uoffset0) {
5555 /* and the cache knows more than the passed in pair */
5556 uoffset0 = cache[2];
5557 boffset0 = cache[3];
5561 + sv_pos_u2b_midway(start + boffset0,
5564 cache[0] - uoffset0);
5567 + sv_pos_u2b_midway(start + boffset0,
5570 cache[2] - uoffset0);
5574 else if ((*mgp)->mg_len != -1) {
5575 /* If we can take advantage of a passed in offset, do so. */
5576 /* In fact, offset0 is either 0, or less than offset, so don't
5577 need to worry about the other possibility. */
5579 + sv_pos_u2b_midway(start + boffset0, send,
5581 (*mgp)->mg_len - uoffset0);
5586 if (!found || PL_utf8cache < 0) {
5587 const STRLEN real_boffset
5588 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5589 send, uoffset - uoffset0);
5591 if (found && PL_utf8cache < 0) {
5592 if (real_boffset != boffset) {
5593 /* Need to turn the assertions off otherwise we may recurse
5594 infinitely while printing error messages. */
5595 SAVEI8(PL_utf8cache);
5597 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5598 " real %"UVuf" for %"SVf,
5599 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5602 boffset = real_boffset;
5605 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5611 =for apidoc sv_pos_u2b
5613 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5614 the start of the string, to a count of the equivalent number of bytes; if
5615 lenp is non-zero, it does the same to lenp, but this time starting from
5616 the offset, rather than from the start of the string. Handles magic and
5623 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5624 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5625 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5630 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5638 start = (U8*)SvPV_const(sv, len);
5640 STRLEN uoffset = (STRLEN) *offsetp;
5641 const U8 * const send = start + len;
5643 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5646 *offsetp = (I32) boffset;
5649 /* Convert the relative offset to absolute. */
5650 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5651 const STRLEN boffset2
5652 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5653 uoffset, boffset) - boffset;
5667 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5668 byte length pairing. The (byte) length of the total SV is passed in too,
5669 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5670 may not have updated SvCUR, so we can't rely on reading it directly.
5672 The proffered utf8/byte length pairing isn't used if the cache already has
5673 two pairs, and swapping either for the proffered pair would increase the
5674 RMS of the intervals between known byte offsets.
5676 The cache itself consists of 4 STRLEN values
5677 0: larger UTF-8 offset
5678 1: corresponding byte offset
5679 2: smaller UTF-8 offset
5680 3: corresponding byte offset
5682 Unused cache pairs have the value 0, 0.
5683 Keeping the cache "backwards" means that the invariant of
5684 cache[0] >= cache[2] is maintained even with empty slots, which means that
5685 the code that uses it doesn't need to worry if only 1 entry has actually
5686 been set to non-zero. It also makes the "position beyond the end of the
5687 cache" logic much simpler, as the first slot is always the one to start
5691 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5699 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5701 (*mgp)->mg_len = -1;
5705 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5706 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5707 (*mgp)->mg_ptr = (char *) cache;
5711 if (PL_utf8cache < 0) {
5712 const U8 *start = (const U8 *) SvPVX_const(sv);
5713 const STRLEN realutf8 = utf8_length(start, start + byte);
5715 if (realutf8 != utf8) {
5716 /* Need to turn the assertions off otherwise we may recurse
5717 infinitely while printing error messages. */
5718 SAVEI8(PL_utf8cache);
5720 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5721 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5725 /* Cache is held with the later position first, to simplify the code
5726 that deals with unbounded ends. */
5728 ASSERT_UTF8_CACHE(cache);
5729 if (cache[1] == 0) {
5730 /* Cache is totally empty */
5733 } else if (cache[3] == 0) {
5734 if (byte > cache[1]) {
5735 /* New one is larger, so goes first. */
5736 cache[2] = cache[0];
5737 cache[3] = cache[1];
5745 #define THREEWAY_SQUARE(a,b,c,d) \
5746 ((float)((d) - (c))) * ((float)((d) - (c))) \
5747 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5748 + ((float)((b) - (a))) * ((float)((b) - (a)))
5750 /* Cache has 2 slots in use, and we know three potential pairs.
5751 Keep the two that give the lowest RMS distance. Do the
5752 calcualation in bytes simply because we always know the byte
5753 length. squareroot has the same ordering as the positive value,
5754 so don't bother with the actual square root. */
5755 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5756 if (byte > cache[1]) {
5757 /* New position is after the existing pair of pairs. */
5758 const float keep_earlier
5759 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5760 const float keep_later
5761 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5763 if (keep_later < keep_earlier) {
5764 if (keep_later < existing) {
5765 cache[2] = cache[0];
5766 cache[3] = cache[1];
5772 if (keep_earlier < existing) {
5778 else if (byte > cache[3]) {
5779 /* New position is between the existing pair of pairs. */
5780 const float keep_earlier
5781 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5782 const float keep_later
5783 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5785 if (keep_later < keep_earlier) {
5786 if (keep_later < existing) {
5792 if (keep_earlier < existing) {
5799 /* New position is before the existing pair of pairs. */
5800 const float keep_earlier
5801 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5802 const float keep_later
5803 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5805 if (keep_later < keep_earlier) {
5806 if (keep_later < existing) {
5812 if (keep_earlier < existing) {
5813 cache[0] = cache[2];
5814 cache[1] = cache[3];
5821 ASSERT_UTF8_CACHE(cache);
5824 /* We already know all of the way, now we may be able to walk back. The same
5825 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5826 backward is half the speed of walking forward. */
5828 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5831 const STRLEN forw = target - s;
5832 STRLEN backw = end - target;
5834 if (forw < 2 * backw) {
5835 return utf8_length(s, target);
5838 while (end > target) {
5840 while (UTF8_IS_CONTINUATION(*end)) {
5849 =for apidoc sv_pos_b2u
5851 Converts the value pointed to by offsetp from a count of bytes from the
5852 start of the string, to a count of the equivalent number of UTF-8 chars.
5853 Handles magic and type coercion.
5859 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5860 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5865 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5868 const STRLEN byte = *offsetp;
5869 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5878 s = (const U8*)SvPV_const(sv, blen);
5881 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5885 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5886 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5888 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5889 if (cache[1] == byte) {
5890 /* An exact match. */
5891 *offsetp = cache[0];
5894 if (cache[3] == byte) {
5895 /* An exact match. */
5896 *offsetp = cache[2];
5900 if (cache[1] < byte) {
5901 /* We already know part of the way. */
5902 if (mg->mg_len != -1) {
5903 /* Actually, we know the end too. */
5905 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5906 s + blen, mg->mg_len - cache[0]);
5908 len = cache[0] + utf8_length(s + cache[1], send);
5911 else if (cache[3] < byte) {
5912 /* We're between the two cached pairs, so we do the calculation
5913 offset by the byte/utf-8 positions for the earlier pair,
5914 then add the utf-8 characters from the string start to
5916 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5917 s + cache[1], cache[0] - cache[2])
5921 else { /* cache[3] > byte */
5922 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5926 ASSERT_UTF8_CACHE(cache);
5928 } else if (mg->mg_len != -1) {
5929 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5933 if (!found || PL_utf8cache < 0) {
5934 const STRLEN real_len = utf8_length(s, send);
5936 if (found && PL_utf8cache < 0) {
5937 if (len != real_len) {
5938 /* Need to turn the assertions off otherwise we may recurse
5939 infinitely while printing error messages. */
5940 SAVEI8(PL_utf8cache);
5942 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5943 " real %"UVuf" for %"SVf,
5944 (UV) len, (UV) real_len, SVfARG(sv));
5951 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5957 Returns a boolean indicating whether the strings in the two SVs are
5958 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5959 coerce its args to strings if necessary.
5965 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5974 SV* svrecode = NULL;
5981 /* if pv1 and pv2 are the same, second SvPV_const call may
5982 * invalidate pv1, so we may need to make a copy */
5983 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5984 pv1 = SvPV_const(sv1, cur1);
5985 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5986 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5988 pv1 = SvPV_const(sv1, cur1);
5996 pv2 = SvPV_const(sv2, cur2);
5998 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5999 /* Differing utf8ness.
6000 * Do not UTF8size the comparands as a side-effect. */
6003 svrecode = newSVpvn(pv2, cur2);
6004 sv_recode_to_utf8(svrecode, PL_encoding);
6005 pv2 = SvPV_const(svrecode, cur2);
6008 svrecode = newSVpvn(pv1, cur1);
6009 sv_recode_to_utf8(svrecode, PL_encoding);
6010 pv1 = SvPV_const(svrecode, cur1);
6012 /* Now both are in UTF-8. */
6014 SvREFCNT_dec(svrecode);
6019 bool is_utf8 = TRUE;
6022 /* sv1 is the UTF-8 one,
6023 * if is equal it must be downgrade-able */
6024 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6030 /* sv2 is the UTF-8 one,
6031 * if is equal it must be downgrade-able */
6032 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6038 /* Downgrade not possible - cannot be eq */
6046 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6048 SvREFCNT_dec(svrecode);
6058 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6059 string in C<sv1> is less than, equal to, or greater than the string in
6060 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6061 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6067 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6071 const char *pv1, *pv2;
6074 SV *svrecode = NULL;
6081 pv1 = SvPV_const(sv1, cur1);
6088 pv2 = SvPV_const(sv2, cur2);
6090 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6091 /* Differing utf8ness.
6092 * Do not UTF8size the comparands as a side-effect. */
6095 svrecode = newSVpvn(pv2, cur2);
6096 sv_recode_to_utf8(svrecode, PL_encoding);
6097 pv2 = SvPV_const(svrecode, cur2);
6100 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6105 svrecode = newSVpvn(pv1, cur1);
6106 sv_recode_to_utf8(svrecode, PL_encoding);
6107 pv1 = SvPV_const(svrecode, cur1);
6110 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6116 cmp = cur2 ? -1 : 0;
6120 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6123 cmp = retval < 0 ? -1 : 1;
6124 } else if (cur1 == cur2) {
6127 cmp = cur1 < cur2 ? -1 : 1;
6131 SvREFCNT_dec(svrecode);
6139 =for apidoc sv_cmp_locale
6141 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6142 'use bytes' aware, handles get magic, and will coerce its args to strings
6143 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6149 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6152 #ifdef USE_LOCALE_COLLATE
6158 if (PL_collation_standard)
6162 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6164 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6166 if (!pv1 || !len1) {
6177 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6180 return retval < 0 ? -1 : 1;
6183 * When the result of collation is equality, that doesn't mean
6184 * that there are no differences -- some locales exclude some
6185 * characters from consideration. So to avoid false equalities,
6186 * we use the raw string as a tiebreaker.
6192 #endif /* USE_LOCALE_COLLATE */
6194 return sv_cmp(sv1, sv2);
6198 #ifdef USE_LOCALE_COLLATE
6201 =for apidoc sv_collxfrm
6203 Add Collate Transform magic to an SV if it doesn't already have it.
6205 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6206 scalar data of the variable, but transformed to such a format that a normal
6207 memory comparison can be used to compare the data according to the locale
6214 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6219 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6220 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6226 Safefree(mg->mg_ptr);
6227 s = SvPV_const(sv, len);
6228 if ((xf = mem_collxfrm(s, len, &xlen))) {
6229 if (SvREADONLY(sv)) {
6232 return xf + sizeof(PL_collation_ix);
6235 #ifdef PERL_OLD_COPY_ON_WRITE
6237 sv_force_normal_flags(sv, 0);
6239 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6253 if (mg && mg->mg_ptr) {
6255 return mg->mg_ptr + sizeof(PL_collation_ix);
6263 #endif /* USE_LOCALE_COLLATE */
6268 Get a line from the filehandle and store it into the SV, optionally
6269 appending to the currently-stored string.
6275 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6280 register STDCHAR rslast;
6281 register STDCHAR *bp;
6286 if (SvTHINKFIRST(sv))
6287 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6288 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6290 However, perlbench says it's slower, because the existing swipe code
6291 is faster than copy on write.
6292 Swings and roundabouts. */
6293 SvUPGRADE(sv, SVt_PV);
6298 if (PerlIO_isutf8(fp)) {
6300 sv_utf8_upgrade_nomg(sv);
6301 sv_pos_u2b(sv,&append,0);
6303 } else if (SvUTF8(sv)) {
6304 SV * const tsv = newSV(0);
6305 sv_gets(tsv, fp, 0);
6306 sv_utf8_upgrade_nomg(tsv);
6307 SvCUR_set(sv,append);
6310 goto return_string_or_null;
6315 if (PerlIO_isutf8(fp))
6318 if (IN_PERL_COMPILETIME) {
6319 /* we always read code in line mode */
6323 else if (RsSNARF(PL_rs)) {
6324 /* If it is a regular disk file use size from stat() as estimate
6325 of amount we are going to read -- may result in mallocing
6326 more memory than we really need if the layers below reduce
6327 the size we read (e.g. CRLF or a gzip layer).
6330 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6331 const Off_t offset = PerlIO_tell(fp);
6332 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6333 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6339 else if (RsRECORD(PL_rs)) {
6344 /* Grab the size of the record we're getting */
6345 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6346 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6349 /* VMS wants read instead of fread, because fread doesn't respect */
6350 /* RMS record boundaries. This is not necessarily a good thing to be */
6351 /* doing, but we've got no other real choice - except avoid stdio
6352 as implementation - perhaps write a :vms layer ?
6354 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6356 bytesread = PerlIO_read(fp, buffer, recsize);
6360 SvCUR_set(sv, bytesread += append);
6361 buffer[bytesread] = '\0';
6362 goto return_string_or_null;
6364 else if (RsPARA(PL_rs)) {
6370 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6371 if (PerlIO_isutf8(fp)) {
6372 rsptr = SvPVutf8(PL_rs, rslen);
6375 if (SvUTF8(PL_rs)) {
6376 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6377 Perl_croak(aTHX_ "Wide character in $/");
6380 rsptr = SvPV_const(PL_rs, rslen);
6384 rslast = rslen ? rsptr[rslen - 1] : '\0';
6386 if (rspara) { /* have to do this both before and after */
6387 do { /* to make sure file boundaries work right */
6390 i = PerlIO_getc(fp);
6394 PerlIO_ungetc(fp,i);
6400 /* See if we know enough about I/O mechanism to cheat it ! */
6402 /* This used to be #ifdef test - it is made run-time test for ease
6403 of abstracting out stdio interface. One call should be cheap
6404 enough here - and may even be a macro allowing compile
6408 if (PerlIO_fast_gets(fp)) {
6411 * We're going to steal some values from the stdio struct
6412 * and put EVERYTHING in the innermost loop into registers.
6414 register STDCHAR *ptr;
6418 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6419 /* An ungetc()d char is handled separately from the regular
6420 * buffer, so we getc() it back out and stuff it in the buffer.
6422 i = PerlIO_getc(fp);
6423 if (i == EOF) return 0;
6424 *(--((*fp)->_ptr)) = (unsigned char) i;
6428 /* Here is some breathtakingly efficient cheating */
6430 cnt = PerlIO_get_cnt(fp); /* get count into register */
6431 /* make sure we have the room */
6432 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6433 /* Not room for all of it
6434 if we are looking for a separator and room for some
6436 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6437 /* just process what we have room for */
6438 shortbuffered = cnt - SvLEN(sv) + append + 1;
6439 cnt -= shortbuffered;
6443 /* remember that cnt can be negative */
6444 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6449 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6450 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6451 DEBUG_P(PerlIO_printf(Perl_debug_log,
6452 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6453 DEBUG_P(PerlIO_printf(Perl_debug_log,
6454 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6455 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6456 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6461 while (cnt > 0) { /* this | eat */
6463 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6464 goto thats_all_folks; /* screams | sed :-) */
6468 Copy(ptr, bp, cnt, char); /* this | eat */
6469 bp += cnt; /* screams | dust */
6470 ptr += cnt; /* louder | sed :-) */
6475 if (shortbuffered) { /* oh well, must extend */
6476 cnt = shortbuffered;
6478 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6480 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6481 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6485 DEBUG_P(PerlIO_printf(Perl_debug_log,
6486 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6487 PTR2UV(ptr),(long)cnt));
6488 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6490 DEBUG_P(PerlIO_printf(Perl_debug_log,
6491 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6492 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6493 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6495 /* This used to call 'filbuf' in stdio form, but as that behaves like
6496 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6497 another abstraction. */
6498 i = PerlIO_getc(fp); /* get more characters */
6500 DEBUG_P(PerlIO_printf(Perl_debug_log,
6501 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6502 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6503 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6505 cnt = PerlIO_get_cnt(fp);
6506 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6507 DEBUG_P(PerlIO_printf(Perl_debug_log,
6508 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6510 if (i == EOF) /* all done for ever? */
6511 goto thats_really_all_folks;
6513 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6515 SvGROW(sv, bpx + cnt + 2);
6516 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6518 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6520 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6521 goto thats_all_folks;
6525 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6526 memNE((char*)bp - rslen, rsptr, rslen))
6527 goto screamer; /* go back to the fray */
6528 thats_really_all_folks:
6530 cnt += shortbuffered;
6531 DEBUG_P(PerlIO_printf(Perl_debug_log,
6532 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6533 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6534 DEBUG_P(PerlIO_printf(Perl_debug_log,
6535 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6536 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6537 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6539 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6540 DEBUG_P(PerlIO_printf(Perl_debug_log,
6541 "Screamer: done, len=%ld, string=|%.*s|\n",
6542 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6546 /*The big, slow, and stupid way. */
6547 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6548 STDCHAR *buf = NULL;
6549 Newx(buf, 8192, STDCHAR);
6557 register const STDCHAR * const bpe = buf + sizeof(buf);
6559 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6560 ; /* keep reading */
6564 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6565 /* Accomodate broken VAXC compiler, which applies U8 cast to
6566 * both args of ?: operator, causing EOF to change into 255
6569 i = (U8)buf[cnt - 1];
6575 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6577 sv_catpvn(sv, (char *) buf, cnt);
6579 sv_setpvn(sv, (char *) buf, cnt);
6581 if (i != EOF && /* joy */
6583 SvCUR(sv) < rslen ||
6584 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6588 * If we're reading from a TTY and we get a short read,
6589 * indicating that the user hit his EOF character, we need
6590 * to notice it now, because if we try to read from the TTY
6591 * again, the EOF condition will disappear.
6593 * The comparison of cnt to sizeof(buf) is an optimization
6594 * that prevents unnecessary calls to feof().
6598 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6602 #ifdef USE_HEAP_INSTEAD_OF_STACK
6607 if (rspara) { /* have to do this both before and after */
6608 while (i != EOF) { /* to make sure file boundaries work right */
6609 i = PerlIO_getc(fp);
6611 PerlIO_ungetc(fp,i);
6617 return_string_or_null:
6618 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6624 Auto-increment of the value in the SV, doing string to numeric conversion
6625 if necessary. Handles 'get' magic.
6631 Perl_sv_inc(pTHX_ register SV *sv)
6640 if (SvTHINKFIRST(sv)) {
6642 sv_force_normal_flags(sv, 0);
6643 if (SvREADONLY(sv)) {
6644 if (IN_PERL_RUNTIME)
6645 Perl_croak(aTHX_ PL_no_modify);
6649 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6651 i = PTR2IV(SvRV(sv));
6656 flags = SvFLAGS(sv);
6657 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6658 /* It's (privately or publicly) a float, but not tested as an
6659 integer, so test it to see. */
6661 flags = SvFLAGS(sv);
6663 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6664 /* It's publicly an integer, or privately an integer-not-float */
6665 #ifdef PERL_PRESERVE_IVUV
6669 if (SvUVX(sv) == UV_MAX)
6670 sv_setnv(sv, UV_MAX_P1);
6672 (void)SvIOK_only_UV(sv);
6673 SvUV_set(sv, SvUVX(sv) + 1);
6675 if (SvIVX(sv) == IV_MAX)
6676 sv_setuv(sv, (UV)IV_MAX + 1);
6678 (void)SvIOK_only(sv);
6679 SvIV_set(sv, SvIVX(sv) + 1);
6684 if (flags & SVp_NOK) {
6685 (void)SvNOK_only(sv);
6686 SvNV_set(sv, SvNVX(sv) + 1.0);
6690 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6691 if ((flags & SVTYPEMASK) < SVt_PVIV)
6692 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6693 (void)SvIOK_only(sv);
6698 while (isALPHA(*d)) d++;
6699 while (isDIGIT(*d)) d++;
6701 #ifdef PERL_PRESERVE_IVUV
6702 /* Got to punt this as an integer if needs be, but we don't issue
6703 warnings. Probably ought to make the sv_iv_please() that does
6704 the conversion if possible, and silently. */
6705 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6706 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6707 /* Need to try really hard to see if it's an integer.
6708 9.22337203685478e+18 is an integer.
6709 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6710 so $a="9.22337203685478e+18"; $a+0; $a++
6711 needs to be the same as $a="9.22337203685478e+18"; $a++
6718 /* sv_2iv *should* have made this an NV */
6719 if (flags & SVp_NOK) {
6720 (void)SvNOK_only(sv);
6721 SvNV_set(sv, SvNVX(sv) + 1.0);
6724 /* I don't think we can get here. Maybe I should assert this
6725 And if we do get here I suspect that sv_setnv will croak. NWC
6727 #if defined(USE_LONG_DOUBLE)
6728 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",
6729 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6731 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6732 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6735 #endif /* PERL_PRESERVE_IVUV */
6736 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6740 while (d >= SvPVX_const(sv)) {
6748 /* MKS: The original code here died if letters weren't consecutive.
6749 * at least it didn't have to worry about non-C locales. The
6750 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6751 * arranged in order (although not consecutively) and that only
6752 * [A-Za-z] are accepted by isALPHA in the C locale.
6754 if (*d != 'z' && *d != 'Z') {
6755 do { ++*d; } while (!isALPHA(*d));
6758 *(d--) -= 'z' - 'a';
6763 *(d--) -= 'z' - 'a' + 1;
6767 /* oh,oh, the number grew */
6768 SvGROW(sv, SvCUR(sv) + 2);
6769 SvCUR_set(sv, SvCUR(sv) + 1);
6770 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6781 Auto-decrement of the value in the SV, doing string to numeric conversion
6782 if necessary. Handles 'get' magic.
6788 Perl_sv_dec(pTHX_ register SV *sv)
6796 if (SvTHINKFIRST(sv)) {
6798 sv_force_normal_flags(sv, 0);
6799 if (SvREADONLY(sv)) {
6800 if (IN_PERL_RUNTIME)
6801 Perl_croak(aTHX_ PL_no_modify);
6805 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6807 i = PTR2IV(SvRV(sv));
6812 /* Unlike sv_inc we don't have to worry about string-never-numbers
6813 and keeping them magic. But we mustn't warn on punting */
6814 flags = SvFLAGS(sv);
6815 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6816 /* It's publicly an integer, or privately an integer-not-float */
6817 #ifdef PERL_PRESERVE_IVUV
6821 if (SvUVX(sv) == 0) {
6822 (void)SvIOK_only(sv);
6826 (void)SvIOK_only_UV(sv);
6827 SvUV_set(sv, SvUVX(sv) - 1);
6830 if (SvIVX(sv) == IV_MIN)
6831 sv_setnv(sv, (NV)IV_MIN - 1.0);
6833 (void)SvIOK_only(sv);
6834 SvIV_set(sv, SvIVX(sv) - 1);
6839 if (flags & SVp_NOK) {
6840 SvNV_set(sv, SvNVX(sv) - 1.0);
6841 (void)SvNOK_only(sv);
6844 if (!(flags & SVp_POK)) {
6845 if ((flags & SVTYPEMASK) < SVt_PVIV)
6846 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6848 (void)SvIOK_only(sv);
6851 #ifdef PERL_PRESERVE_IVUV
6853 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6854 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6855 /* Need to try really hard to see if it's an integer.
6856 9.22337203685478e+18 is an integer.
6857 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6858 so $a="9.22337203685478e+18"; $a+0; $a--
6859 needs to be the same as $a="9.22337203685478e+18"; $a--
6866 /* sv_2iv *should* have made this an NV */
6867 if (flags & SVp_NOK) {
6868 (void)SvNOK_only(sv);
6869 SvNV_set(sv, SvNVX(sv) - 1.0);
6872 /* I don't think we can get here. Maybe I should assert this
6873 And if we do get here I suspect that sv_setnv will croak. NWC
6875 #if defined(USE_LONG_DOUBLE)
6876 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",
6877 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6879 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6880 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6884 #endif /* PERL_PRESERVE_IVUV */
6885 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6889 =for apidoc sv_mortalcopy
6891 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6892 The new SV is marked as mortal. It will be destroyed "soon", either by an
6893 explicit call to FREETMPS, or by an implicit call at places such as
6894 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6899 /* Make a string that will exist for the duration of the expression
6900 * evaluation. Actually, it may have to last longer than that, but
6901 * hopefully we won't free it until it has been assigned to a
6902 * permanent location. */
6905 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6911 sv_setsv(sv,oldstr);
6913 PL_tmps_stack[++PL_tmps_ix] = sv;
6919 =for apidoc sv_newmortal
6921 Creates a new null SV which is mortal. The reference count of the SV is
6922 set to 1. It will be destroyed "soon", either by an explicit call to
6923 FREETMPS, or by an implicit call at places such as statement boundaries.
6924 See also C<sv_mortalcopy> and C<sv_2mortal>.
6930 Perl_sv_newmortal(pTHX)
6936 SvFLAGS(sv) = SVs_TEMP;
6938 PL_tmps_stack[++PL_tmps_ix] = sv;
6943 =for apidoc sv_2mortal
6945 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6946 by an explicit call to FREETMPS, or by an implicit call at places such as
6947 statement boundaries. SvTEMP() is turned on which means that the SV's
6948 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6949 and C<sv_mortalcopy>.
6955 Perl_sv_2mortal(pTHX_ register SV *sv)
6960 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6963 PL_tmps_stack[++PL_tmps_ix] = sv;
6971 Creates a new SV and copies a string into it. The reference count for the
6972 SV is set to 1. If C<len> is zero, Perl will compute the length using
6973 strlen(). For efficiency, consider using C<newSVpvn> instead.
6979 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6985 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6990 =for apidoc newSVpvn
6992 Creates a new SV and copies a string into it. The reference count for the
6993 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6994 string. You are responsible for ensuring that the source string is at least
6995 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7001 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7007 sv_setpvn(sv,s,len);
7013 =for apidoc newSVhek
7015 Creates a new SV from the hash key structure. It will generate scalars that
7016 point to the shared string table where possible. Returns a new (undefined)
7017 SV if the hek is NULL.
7023 Perl_newSVhek(pTHX_ const HEK *hek)
7033 if (HEK_LEN(hek) == HEf_SVKEY) {
7034 return newSVsv(*(SV**)HEK_KEY(hek));
7036 const int flags = HEK_FLAGS(hek);
7037 if (flags & HVhek_WASUTF8) {
7039 Andreas would like keys he put in as utf8 to come back as utf8
7041 STRLEN utf8_len = HEK_LEN(hek);
7042 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7043 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7046 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7048 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7049 /* We don't have a pointer to the hv, so we have to replicate the
7050 flag into every HEK. This hv is using custom a hasing
7051 algorithm. Hence we can't return a shared string scalar, as
7052 that would contain the (wrong) hash value, and might get passed
7053 into an hv routine with a regular hash.
7054 Similarly, a hash that isn't using shared hash keys has to have
7055 the flag in every key so that we know not to try to call
7056 share_hek_kek on it. */
7058 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7063 /* This will be overwhelminly the most common case. */
7065 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7066 more efficient than sharepvn(). */
7070 sv_upgrade(sv, SVt_PV);
7071 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7072 SvCUR_set(sv, HEK_LEN(hek));
7085 =for apidoc newSVpvn_share
7087 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7088 table. If the string does not already exist in the table, it is created
7089 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7090 value is used; otherwise the hash is computed. The string's hash can be later
7091 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7092 that as the string table is used for shared hash keys these strings will have
7093 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7099 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7103 bool is_utf8 = FALSE;
7104 const char *const orig_src = src;
7107 STRLEN tmplen = -len;
7109 /* See the note in hv.c:hv_fetch() --jhi */
7110 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7114 PERL_HASH(hash, src, len);
7116 sv_upgrade(sv, SVt_PV);
7117 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7125 if (src != orig_src)
7131 #if defined(PERL_IMPLICIT_CONTEXT)
7133 /* pTHX_ magic can't cope with varargs, so this is a no-context
7134 * version of the main function, (which may itself be aliased to us).
7135 * Don't access this version directly.
7139 Perl_newSVpvf_nocontext(const char* pat, ...)
7144 va_start(args, pat);
7145 sv = vnewSVpvf(pat, &args);
7152 =for apidoc newSVpvf
7154 Creates a new SV and initializes it with the string formatted like
7161 Perl_newSVpvf(pTHX_ const char* pat, ...)
7165 va_start(args, pat);
7166 sv = vnewSVpvf(pat, &args);
7171 /* backend for newSVpvf() and newSVpvf_nocontext() */
7174 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7179 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7186 Creates a new SV and copies a floating point value into it.
7187 The reference count for the SV is set to 1.
7193 Perl_newSVnv(pTHX_ NV n)
7206 Creates a new SV and copies an integer into it. The reference count for the
7213 Perl_newSViv(pTHX_ IV i)
7226 Creates a new SV and copies an unsigned integer into it.
7227 The reference count for the SV is set to 1.
7233 Perl_newSVuv(pTHX_ UV u)
7244 =for apidoc newSV_type
7246 Creates a new SV, of the type specified. The reference count for the new SV
7253 Perl_newSV_type(pTHX_ svtype type)
7258 sv_upgrade(sv, type);
7263 =for apidoc newRV_noinc
7265 Creates an RV wrapper for an SV. The reference count for the original
7266 SV is B<not> incremented.
7272 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7275 register SV *sv = newSV_type(SVt_RV);
7277 SvRV_set(sv, tmpRef);
7282 /* newRV_inc is the official function name to use now.
7283 * newRV_inc is in fact #defined to newRV in sv.h
7287 Perl_newRV(pTHX_ SV *sv)
7290 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7296 Creates a new SV which is an exact duplicate of the original SV.
7303 Perl_newSVsv(pTHX_ register SV *old)
7310 if (SvTYPE(old) == SVTYPEMASK) {
7311 if (ckWARN_d(WARN_INTERNAL))
7312 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7316 /* SV_GMAGIC is the default for sv_setv()
7317 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7318 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7319 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7324 =for apidoc sv_reset
7326 Underlying implementation for the C<reset> Perl function.
7327 Note that the perl-level function is vaguely deprecated.
7333 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7336 char todo[PERL_UCHAR_MAX+1];
7341 if (!*s) { /* reset ?? searches */
7342 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7344 const U32 count = mg->mg_len / sizeof(PMOP**);
7345 PMOP **pmp = (PMOP**) mg->mg_ptr;
7346 PMOP *const *const end = pmp + count;
7350 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7352 (*pmp)->op_pmflags &= ~PMf_USED;
7360 /* reset variables */
7362 if (!HvARRAY(stash))
7365 Zero(todo, 256, char);
7368 I32 i = (unsigned char)*s;
7372 max = (unsigned char)*s++;
7373 for ( ; i <= max; i++) {
7376 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7378 for (entry = HvARRAY(stash)[i];
7380 entry = HeNEXT(entry))
7385 if (!todo[(U8)*HeKEY(entry)])
7387 gv = (GV*)HeVAL(entry);
7390 if (SvTHINKFIRST(sv)) {
7391 if (!SvREADONLY(sv) && SvROK(sv))
7393 /* XXX Is this continue a bug? Why should THINKFIRST
7394 exempt us from resetting arrays and hashes? */
7398 if (SvTYPE(sv) >= SVt_PV) {
7400 if (SvPVX_const(sv) != NULL)
7408 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7410 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7413 # if defined(USE_ENVIRON_ARRAY)
7416 # endif /* USE_ENVIRON_ARRAY */
7427 Using various gambits, try to get an IO from an SV: the IO slot if its a
7428 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7429 named after the PV if we're a string.
7435 Perl_sv_2io(pTHX_ SV *sv)
7440 switch (SvTYPE(sv)) {
7448 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7452 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7454 return sv_2io(SvRV(sv));
7455 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7461 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7470 Using various gambits, try to get a CV from an SV; in addition, try if
7471 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7472 The flags in C<lref> are passed to sv_fetchsv.
7478 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7489 switch (SvTYPE(sv)) {
7508 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7509 tryAMAGICunDEREF(to_cv);
7512 if (SvTYPE(sv) == SVt_PVCV) {
7521 Perl_croak(aTHX_ "Not a subroutine reference");
7526 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7532 /* Some flags to gv_fetchsv mean don't really create the GV */
7533 if (SvTYPE(gv) != SVt_PVGV) {
7539 if (lref && !GvCVu(gv)) {
7543 gv_efullname3(tmpsv, gv, NULL);
7544 /* XXX this is probably not what they think they're getting.
7545 * It has the same effect as "sub name;", i.e. just a forward
7547 newSUB(start_subparse(FALSE, 0),
7548 newSVOP(OP_CONST, 0, tmpsv),
7552 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7562 Returns true if the SV has a true value by Perl's rules.
7563 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7564 instead use an in-line version.
7570 Perl_sv_true(pTHX_ register SV *sv)
7575 register const XPV* const tXpv = (XPV*)SvANY(sv);
7577 (tXpv->xpv_cur > 1 ||
7578 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7585 return SvIVX(sv) != 0;
7588 return SvNVX(sv) != 0.0;
7590 return sv_2bool(sv);
7596 =for apidoc sv_pvn_force
7598 Get a sensible string out of the SV somehow.
7599 A private implementation of the C<SvPV_force> macro for compilers which
7600 can't cope with complex macro expressions. Always use the macro instead.
7602 =for apidoc sv_pvn_force_flags
7604 Get a sensible string out of the SV somehow.
7605 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7606 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7607 implemented in terms of this function.
7608 You normally want to use the various wrapper macros instead: see
7609 C<SvPV_force> and C<SvPV_force_nomg>
7615 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7618 if (SvTHINKFIRST(sv) && !SvROK(sv))
7619 sv_force_normal_flags(sv, 0);
7629 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7630 const char * const ref = sv_reftype(sv,0);
7632 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7633 ref, OP_NAME(PL_op));
7635 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7637 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7638 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7640 s = sv_2pv_flags(sv, &len, flags);
7644 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7647 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7648 SvGROW(sv, len + 1);
7649 Move(s,SvPVX(sv),len,char);
7651 SvPVX(sv)[len] = '\0';
7654 SvPOK_on(sv); /* validate pointer */
7656 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7657 PTR2UV(sv),SvPVX_const(sv)));
7660 return SvPVX_mutable(sv);
7664 =for apidoc sv_pvbyten_force
7666 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7672 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7674 sv_pvn_force(sv,lp);
7675 sv_utf8_downgrade(sv,0);
7681 =for apidoc sv_pvutf8n_force
7683 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7689 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7691 sv_pvn_force(sv,lp);
7692 sv_utf8_upgrade(sv);
7698 =for apidoc sv_reftype
7700 Returns a string describing what the SV is a reference to.
7706 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7708 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7709 inside return suggests a const propagation bug in g++. */
7710 if (ob && SvOBJECT(sv)) {
7711 char * const name = HvNAME_get(SvSTASH(sv));
7712 return name ? name : (char *) "__ANON__";
7715 switch (SvTYPE(sv)) {
7731 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7732 /* tied lvalues should appear to be
7733 * scalars for backwards compatitbility */
7734 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7735 ? "SCALAR" : "LVALUE");
7736 case SVt_PVAV: return "ARRAY";
7737 case SVt_PVHV: return "HASH";
7738 case SVt_PVCV: return "CODE";
7739 case SVt_PVGV: return "GLOB";
7740 case SVt_PVFM: return "FORMAT";
7741 case SVt_PVIO: return "IO";
7742 case SVt_BIND: return "BIND";
7743 default: return "UNKNOWN";
7749 =for apidoc sv_isobject
7751 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7752 object. If the SV is not an RV, or if the object is not blessed, then this
7759 Perl_sv_isobject(pTHX_ SV *sv)
7775 Returns a boolean indicating whether the SV is blessed into the specified
7776 class. This does not check for subtypes; use C<sv_derived_from> to verify
7777 an inheritance relationship.
7783 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7794 hvname = HvNAME_get(SvSTASH(sv));
7798 return strEQ(hvname, name);
7804 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7805 it will be upgraded to one. If C<classname> is non-null then the new SV will
7806 be blessed in the specified package. The new SV is returned and its
7807 reference count is 1.
7813 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7820 SV_CHECK_THINKFIRST_COW_DROP(rv);
7821 (void)SvAMAGIC_off(rv);
7823 if (SvTYPE(rv) >= SVt_PVMG) {
7824 const U32 refcnt = SvREFCNT(rv);
7828 SvREFCNT(rv) = refcnt;
7830 sv_upgrade(rv, SVt_RV);
7831 } else if (SvROK(rv)) {
7832 SvREFCNT_dec(SvRV(rv));
7833 } else if (SvTYPE(rv) < SVt_RV)
7834 sv_upgrade(rv, SVt_RV);
7835 else if (SvTYPE(rv) > SVt_RV) {
7846 HV* const stash = gv_stashpv(classname, GV_ADD);
7847 (void)sv_bless(rv, stash);
7853 =for apidoc sv_setref_pv
7855 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7856 argument will be upgraded to an RV. That RV will be modified to point to
7857 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7858 into the SV. The C<classname> argument indicates the package for the
7859 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7860 will have a reference count of 1, and the RV will be returned.
7862 Do not use with other Perl types such as HV, AV, SV, CV, because those
7863 objects will become corrupted by the pointer copy process.
7865 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7871 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7875 sv_setsv(rv, &PL_sv_undef);
7879 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7884 =for apidoc sv_setref_iv
7886 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7887 argument will be upgraded to an RV. That RV will be modified to point to
7888 the new SV. The C<classname> argument indicates the package for the
7889 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7890 will have a reference count of 1, and the RV will be returned.
7896 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7898 sv_setiv(newSVrv(rv,classname), iv);
7903 =for apidoc sv_setref_uv
7905 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7906 argument will be upgraded to an RV. That RV will be modified to point to
7907 the new SV. The C<classname> argument indicates the package for the
7908 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7909 will have a reference count of 1, and the RV will be returned.
7915 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7917 sv_setuv(newSVrv(rv,classname), uv);
7922 =for apidoc sv_setref_nv
7924 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7925 argument will be upgraded to an RV. That RV will be modified to point to
7926 the new SV. The C<classname> argument indicates the package for the
7927 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7928 will have a reference count of 1, and the RV will be returned.
7934 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7936 sv_setnv(newSVrv(rv,classname), nv);
7941 =for apidoc sv_setref_pvn
7943 Copies a string into a new SV, optionally blessing the SV. The length of the
7944 string must be specified with C<n>. The C<rv> argument will be upgraded to
7945 an RV. That RV will be modified to point to the new SV. The C<classname>
7946 argument indicates the package for the blessing. Set C<classname> to
7947 C<NULL> to avoid the blessing. The new SV will have a reference count
7948 of 1, and the RV will be returned.
7950 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7956 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7958 sv_setpvn(newSVrv(rv,classname), pv, n);
7963 =for apidoc sv_bless
7965 Blesses an SV into a specified package. The SV must be an RV. The package
7966 must be designated by its stash (see C<gv_stashpv()>). The reference count
7967 of the SV is unaffected.
7973 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7978 Perl_croak(aTHX_ "Can't bless non-reference value");
7980 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7981 if (SvREADONLY(tmpRef))
7982 Perl_croak(aTHX_ PL_no_modify);
7983 if (SvOBJECT(tmpRef)) {
7984 if (SvTYPE(tmpRef) != SVt_PVIO)
7986 SvREFCNT_dec(SvSTASH(tmpRef));
7989 SvOBJECT_on(tmpRef);
7990 if (SvTYPE(tmpRef) != SVt_PVIO)
7992 SvUPGRADE(tmpRef, SVt_PVMG);
7993 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7998 (void)SvAMAGIC_off(sv);
8000 if(SvSMAGICAL(tmpRef))
8001 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8009 /* Downgrades a PVGV to a PVMG.
8013 S_sv_unglob(pTHX_ SV *sv)
8018 SV * const temp = sv_newmortal();
8020 assert(SvTYPE(sv) == SVt_PVGV);
8022 gv_efullname3(temp, (GV *) sv, "*");
8025 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8026 mro_method_changed_in(stash);
8030 sv_del_backref((SV*)GvSTASH(sv), sv);
8034 if (GvNAME_HEK(sv)) {
8035 unshare_hek(GvNAME_HEK(sv));
8037 isGV_with_GP_off(sv);
8039 /* need to keep SvANY(sv) in the right arena */
8040 xpvmg = new_XPVMG();
8041 StructCopy(SvANY(sv), xpvmg, XPVMG);
8042 del_XPVGV(SvANY(sv));
8045 SvFLAGS(sv) &= ~SVTYPEMASK;
8046 SvFLAGS(sv) |= SVt_PVMG;
8048 /* Intentionally not calling any local SET magic, as this isn't so much a
8049 set operation as merely an internal storage change. */
8050 sv_setsv_flags(sv, temp, 0);
8054 =for apidoc sv_unref_flags
8056 Unsets the RV status of the SV, and decrements the reference count of
8057 whatever was being referenced by the RV. This can almost be thought of
8058 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8059 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8060 (otherwise the decrementing is conditional on the reference count being
8061 different from one or the reference being a readonly SV).
8068 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8070 SV* const target = SvRV(ref);
8072 if (SvWEAKREF(ref)) {
8073 sv_del_backref(target, ref);
8075 SvRV_set(ref, NULL);
8078 SvRV_set(ref, NULL);
8080 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8081 assigned to as BEGIN {$a = \"Foo"} will fail. */
8082 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8083 SvREFCNT_dec(target);
8084 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8085 sv_2mortal(target); /* Schedule for freeing later */
8089 =for apidoc sv_untaint
8091 Untaint an SV. Use C<SvTAINTED_off> instead.
8096 Perl_sv_untaint(pTHX_ SV *sv)
8098 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8099 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8106 =for apidoc sv_tainted
8108 Test an SV for taintedness. Use C<SvTAINTED> instead.
8113 Perl_sv_tainted(pTHX_ SV *sv)
8115 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8116 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8117 if (mg && (mg->mg_len & 1) )
8124 =for apidoc sv_setpviv
8126 Copies an integer into the given SV, also updating its string value.
8127 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8133 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8135 char buf[TYPE_CHARS(UV)];
8137 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8139 sv_setpvn(sv, ptr, ebuf - ptr);
8143 =for apidoc sv_setpviv_mg
8145 Like C<sv_setpviv>, but also handles 'set' magic.
8151 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8157 #if defined(PERL_IMPLICIT_CONTEXT)
8159 /* pTHX_ magic can't cope with varargs, so this is a no-context
8160 * version of the main function, (which may itself be aliased to us).
8161 * Don't access this version directly.
8165 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8169 va_start(args, pat);
8170 sv_vsetpvf(sv, pat, &args);
8174 /* pTHX_ magic can't cope with varargs, so this is a no-context
8175 * version of the main function, (which may itself be aliased to us).
8176 * Don't access this version directly.
8180 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8184 va_start(args, pat);
8185 sv_vsetpvf_mg(sv, pat, &args);
8191 =for apidoc sv_setpvf
8193 Works like C<sv_catpvf> but copies the text into the SV instead of
8194 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8200 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8203 va_start(args, pat);
8204 sv_vsetpvf(sv, pat, &args);
8209 =for apidoc sv_vsetpvf
8211 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8212 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8214 Usually used via its frontend C<sv_setpvf>.
8220 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8222 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8226 =for apidoc sv_setpvf_mg
8228 Like C<sv_setpvf>, but also handles 'set' magic.
8234 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8237 va_start(args, pat);
8238 sv_vsetpvf_mg(sv, pat, &args);
8243 =for apidoc sv_vsetpvf_mg
8245 Like C<sv_vsetpvf>, but also handles 'set' magic.
8247 Usually used via its frontend C<sv_setpvf_mg>.
8253 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8255 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8259 #if defined(PERL_IMPLICIT_CONTEXT)
8261 /* pTHX_ magic can't cope with varargs, so this is a no-context
8262 * version of the main function, (which may itself be aliased to us).
8263 * Don't access this version directly.
8267 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8271 va_start(args, pat);
8272 sv_vcatpvf(sv, pat, &args);
8276 /* pTHX_ magic can't cope with varargs, so this is a no-context
8277 * version of the main function, (which may itself be aliased to us).
8278 * Don't access this version directly.
8282 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8286 va_start(args, pat);
8287 sv_vcatpvf_mg(sv, pat, &args);
8293 =for apidoc sv_catpvf
8295 Processes its arguments like C<sprintf> and appends the formatted
8296 output to an SV. If the appended data contains "wide" characters
8297 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8298 and characters >255 formatted with %c), the original SV might get
8299 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8300 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8301 valid UTF-8; if the original SV was bytes, the pattern should be too.
8306 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8309 va_start(args, pat);
8310 sv_vcatpvf(sv, pat, &args);
8315 =for apidoc sv_vcatpvf
8317 Processes its arguments like C<vsprintf> and appends the formatted output
8318 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8320 Usually used via its frontend C<sv_catpvf>.
8326 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8328 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8332 =for apidoc sv_catpvf_mg
8334 Like C<sv_catpvf>, but also handles 'set' magic.
8340 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8343 va_start(args, pat);
8344 sv_vcatpvf_mg(sv, pat, &args);
8349 =for apidoc sv_vcatpvf_mg
8351 Like C<sv_vcatpvf>, but also handles 'set' magic.
8353 Usually used via its frontend C<sv_catpvf_mg>.
8359 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8361 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8366 =for apidoc sv_vsetpvfn
8368 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8371 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8377 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8379 sv_setpvn(sv, "", 0);
8380 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8384 S_expect_number(pTHX_ char** pattern)
8388 switch (**pattern) {
8389 case '1': case '2': case '3':
8390 case '4': case '5': case '6':
8391 case '7': case '8': case '9':
8392 var = *(*pattern)++ - '0';
8393 while (isDIGIT(**pattern)) {
8394 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8396 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8404 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8406 const int neg = nv < 0;
8415 if (uv & 1 && uv == nv)
8416 uv--; /* Round to even */
8418 const unsigned dig = uv % 10;
8431 =for apidoc sv_vcatpvfn
8433 Processes its arguments like C<vsprintf> and appends the formatted output
8434 to an SV. Uses an array of SVs if the C style variable argument list is
8435 missing (NULL). When running with taint checks enabled, indicates via
8436 C<maybe_tainted> if results are untrustworthy (often due to the use of
8439 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8445 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8446 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8447 vec_utf8 = DO_UTF8(vecsv);
8449 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8452 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8460 static const char nullstr[] = "(null)";
8462 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8463 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8465 /* Times 4: a decimal digit takes more than 3 binary digits.
8466 * NV_DIG: mantissa takes than many decimal digits.
8467 * Plus 32: Playing safe. */
8468 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8469 /* large enough for "%#.#f" --chip */
8470 /* what about long double NVs? --jhi */
8472 PERL_UNUSED_ARG(maybe_tainted);
8474 /* no matter what, this is a string now */
8475 (void)SvPV_force(sv, origlen);
8477 /* special-case "", "%s", and "%-p" (SVf - see below) */
8480 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8482 const char * const s = va_arg(*args, char*);
8483 sv_catpv(sv, s ? s : nullstr);
8485 else if (svix < svmax) {
8486 sv_catsv(sv, *svargs);
8490 if (args && patlen == 3 && pat[0] == '%' &&
8491 pat[1] == '-' && pat[2] == 'p') {
8492 argsv = (SV*)va_arg(*args, void*);
8493 sv_catsv(sv, argsv);
8497 #ifndef USE_LONG_DOUBLE
8498 /* special-case "%.<number>[gf]" */
8499 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8500 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8501 unsigned digits = 0;
8505 while (*pp >= '0' && *pp <= '9')
8506 digits = 10 * digits + (*pp++ - '0');
8507 if (pp - pat == (int)patlen - 1) {
8515 /* Add check for digits != 0 because it seems that some
8516 gconverts are buggy in this case, and we don't yet have
8517 a Configure test for this. */
8518 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8519 /* 0, point, slack */
8520 Gconvert(nv, (int)digits, 0, ebuf);
8522 if (*ebuf) /* May return an empty string for digits==0 */
8525 } else if (!digits) {
8528 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8529 sv_catpvn(sv, p, l);
8535 #endif /* !USE_LONG_DOUBLE */
8537 if (!args && svix < svmax && DO_UTF8(*svargs))
8540 patend = (char*)pat + patlen;
8541 for (p = (char*)pat; p < patend; p = q) {
8544 bool vectorize = FALSE;
8545 bool vectorarg = FALSE;
8546 bool vec_utf8 = FALSE;
8552 bool has_precis = FALSE;
8554 const I32 osvix = svix;
8555 bool is_utf8 = FALSE; /* is this item utf8? */
8556 #ifdef HAS_LDBL_SPRINTF_BUG
8557 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8558 with sfio - Allen <allens@cpan.org> */
8559 bool fix_ldbl_sprintf_bug = FALSE;
8563 U8 utf8buf[UTF8_MAXBYTES+1];
8564 STRLEN esignlen = 0;
8566 const char *eptr = NULL;
8569 const U8 *vecstr = NULL;
8576 /* we need a long double target in case HAS_LONG_DOUBLE but
8579 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8587 const char *dotstr = ".";
8588 STRLEN dotstrlen = 1;
8589 I32 efix = 0; /* explicit format parameter index */
8590 I32 ewix = 0; /* explicit width index */
8591 I32 epix = 0; /* explicit precision index */
8592 I32 evix = 0; /* explicit vector index */
8593 bool asterisk = FALSE;
8595 /* echo everything up to the next format specification */
8596 for (q = p; q < patend && *q != '%'; ++q) ;
8598 if (has_utf8 && !pat_utf8)
8599 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8601 sv_catpvn(sv, p, q - p);
8608 We allow format specification elements in this order:
8609 \d+\$ explicit format parameter index
8611 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8612 0 flag (as above): repeated to allow "v02"
8613 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8614 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8616 [%bcdefginopsuxDFOUX] format (mandatory)
8621 As of perl5.9.3, printf format checking is on by default.
8622 Internally, perl uses %p formats to provide an escape to
8623 some extended formatting. This block deals with those
8624 extensions: if it does not match, (char*)q is reset and
8625 the normal format processing code is used.
8627 Currently defined extensions are:
8628 %p include pointer address (standard)
8629 %-p (SVf) include an SV (previously %_)
8630 %-<num>p include an SV with precision <num>
8631 %<num>p reserved for future extensions
8633 Robin Barker 2005-07-14
8635 %1p (VDf) removed. RMB 2007-10-19
8642 n = expect_number(&q);
8649 argsv = (SV*)va_arg(*args, void*);
8650 eptr = SvPV_const(argsv, elen);
8656 if (ckWARN_d(WARN_INTERNAL))
8657 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8658 "internal %%<num>p might conflict with future printf extensions");
8664 if ( (width = expect_number(&q)) ) {
8679 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8708 if ( (ewix = expect_number(&q)) )
8717 if ((vectorarg = asterisk)) {
8730 width = expect_number(&q);
8736 vecsv = va_arg(*args, SV*);
8738 vecsv = (evix > 0 && evix <= svmax)
8739 ? svargs[evix-1] : &PL_sv_undef;
8741 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8743 dotstr = SvPV_const(vecsv, dotstrlen);
8744 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8745 bad with tied or overloaded values that return UTF8. */
8748 else if (has_utf8) {
8749 vecsv = sv_mortalcopy(vecsv);
8750 sv_utf8_upgrade(vecsv);
8751 dotstr = SvPV_const(vecsv, dotstrlen);
8758 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8759 vecsv = svargs[efix ? efix-1 : svix++];
8760 vecstr = (U8*)SvPV_const(vecsv,veclen);
8761 vec_utf8 = DO_UTF8(vecsv);
8763 /* if this is a version object, we need to convert
8764 * back into v-string notation and then let the
8765 * vectorize happen normally
8767 if (sv_derived_from(vecsv, "version")) {
8768 char *version = savesvpv(vecsv);
8769 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8770 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8771 "vector argument not supported with alpha versions");
8774 vecsv = sv_newmortal();
8775 scan_vstring(version, version + veclen, vecsv);
8776 vecstr = (U8*)SvPV_const(vecsv, veclen);
8777 vec_utf8 = DO_UTF8(vecsv);
8789 i = va_arg(*args, int);
8791 i = (ewix ? ewix <= svmax : svix < svmax) ?
8792 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8794 width = (i < 0) ? -i : i;
8804 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8806 /* XXX: todo, support specified precision parameter */
8810 i = va_arg(*args, int);
8812 i = (ewix ? ewix <= svmax : svix < svmax)
8813 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8815 has_precis = !(i < 0);
8820 precis = precis * 10 + (*q++ - '0');
8829 case 'I': /* Ix, I32x, and I64x */
8831 if (q[1] == '6' && q[2] == '4') {
8837 if (q[1] == '3' && q[2] == '2') {
8847 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8858 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8859 if (*(q + 1) == 'l') { /* lld, llf */
8885 if (!vectorize && !args) {
8887 const I32 i = efix-1;
8888 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8890 argsv = (svix >= 0 && svix < svmax)
8891 ? svargs[svix++] : &PL_sv_undef;
8902 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8904 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8906 eptr = (char*)utf8buf;
8907 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8921 eptr = va_arg(*args, char*);
8923 #ifdef MACOS_TRADITIONAL
8924 /* On MacOS, %#s format is used for Pascal strings */
8929 elen = strlen(eptr);
8931 eptr = (char *)nullstr;
8932 elen = sizeof nullstr - 1;
8936 eptr = SvPV_const(argsv, elen);
8937 if (DO_UTF8(argsv)) {
8938 I32 old_precis = precis;
8939 if (has_precis && precis < elen) {
8941 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8944 if (width) { /* fudge width (can't fudge elen) */
8945 if (has_precis && precis < elen)
8946 width += precis - old_precis;
8948 width += elen - sv_len_utf8(argsv);
8955 if (has_precis && elen > precis)
8962 if (alt || vectorize)
8964 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8985 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8994 esignbuf[esignlen++] = plus;
8998 case 'h': iv = (short)va_arg(*args, int); break;
8999 case 'l': iv = va_arg(*args, long); break;
9000 case 'V': iv = va_arg(*args, IV); break;
9001 default: iv = va_arg(*args, int); break;
9003 case 'q': iv = va_arg(*args, Quad_t); break;
9008 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9010 case 'h': iv = (short)tiv; break;
9011 case 'l': iv = (long)tiv; break;
9013 default: iv = tiv; break;
9015 case 'q': iv = (Quad_t)tiv; break;
9019 if ( !vectorize ) /* we already set uv above */
9024 esignbuf[esignlen++] = plus;
9028 esignbuf[esignlen++] = '-';
9072 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9083 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9084 case 'l': uv = va_arg(*args, unsigned long); break;
9085 case 'V': uv = va_arg(*args, UV); break;
9086 default: uv = va_arg(*args, unsigned); break;
9088 case 'q': uv = va_arg(*args, Uquad_t); break;
9093 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9095 case 'h': uv = (unsigned short)tuv; break;
9096 case 'l': uv = (unsigned long)tuv; break;
9098 default: uv = tuv; break;
9100 case 'q': uv = (Uquad_t)tuv; break;
9107 char *ptr = ebuf + sizeof ebuf;
9108 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9114 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9120 esignbuf[esignlen++] = '0';
9121 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9129 if (alt && *ptr != '0')
9138 esignbuf[esignlen++] = '0';
9139 esignbuf[esignlen++] = c;
9142 default: /* it had better be ten or less */
9146 } while (uv /= base);
9149 elen = (ebuf + sizeof ebuf) - ptr;
9153 zeros = precis - elen;
9154 else if (precis == 0 && elen == 1 && *eptr == '0'
9155 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9158 /* a precision nullifies the 0 flag. */
9165 /* FLOATING POINT */
9168 c = 'f'; /* maybe %F isn't supported here */
9176 /* This is evil, but floating point is even more evil */
9178 /* for SV-style calling, we can only get NV
9179 for C-style calling, we assume %f is double;
9180 for simplicity we allow any of %Lf, %llf, %qf for long double
9184 #if defined(USE_LONG_DOUBLE)
9188 /* [perl #20339] - we should accept and ignore %lf rather than die */
9192 #if defined(USE_LONG_DOUBLE)
9193 intsize = args ? 0 : 'q';
9197 #if defined(HAS_LONG_DOUBLE)
9206 /* now we need (long double) if intsize == 'q', else (double) */
9208 #if LONG_DOUBLESIZE > DOUBLESIZE
9210 va_arg(*args, long double) :
9211 va_arg(*args, double)
9213 va_arg(*args, double)
9218 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9219 else. frexp() has some unspecified behaviour for those three */
9220 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9222 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9223 will cast our (long double) to (double) */
9224 (void)Perl_frexp(nv, &i);
9225 if (i == PERL_INT_MIN)
9226 Perl_die(aTHX_ "panic: frexp");
9228 need = BIT_DIGITS(i);
9230 need += has_precis ? precis : 6; /* known default */
9235 #ifdef HAS_LDBL_SPRINTF_BUG
9236 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9237 with sfio - Allen <allens@cpan.org> */
9240 # define MY_DBL_MAX DBL_MAX
9241 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9242 # if DOUBLESIZE >= 8
9243 # define MY_DBL_MAX 1.7976931348623157E+308L
9245 # define MY_DBL_MAX 3.40282347E+38L
9249 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9250 # define MY_DBL_MAX_BUG 1L
9252 # define MY_DBL_MAX_BUG MY_DBL_MAX
9256 # define MY_DBL_MIN DBL_MIN
9257 # else /* XXX guessing! -Allen */
9258 # if DOUBLESIZE >= 8
9259 # define MY_DBL_MIN 2.2250738585072014E-308L
9261 # define MY_DBL_MIN 1.17549435E-38L
9265 if ((intsize == 'q') && (c == 'f') &&
9266 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9268 /* it's going to be short enough that
9269 * long double precision is not needed */
9271 if ((nv <= 0L) && (nv >= -0L))
9272 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9274 /* would use Perl_fp_class as a double-check but not
9275 * functional on IRIX - see perl.h comments */
9277 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9278 /* It's within the range that a double can represent */
9279 #if defined(DBL_MAX) && !defined(DBL_MIN)
9280 if ((nv >= ((long double)1/DBL_MAX)) ||
9281 (nv <= (-(long double)1/DBL_MAX)))
9283 fix_ldbl_sprintf_bug = TRUE;
9286 if (fix_ldbl_sprintf_bug == TRUE) {
9296 # undef MY_DBL_MAX_BUG
9299 #endif /* HAS_LDBL_SPRINTF_BUG */
9301 need += 20; /* fudge factor */
9302 if (PL_efloatsize < need) {
9303 Safefree(PL_efloatbuf);
9304 PL_efloatsize = need + 20; /* more fudge */
9305 Newx(PL_efloatbuf, PL_efloatsize, char);
9306 PL_efloatbuf[0] = '\0';
9309 if ( !(width || left || plus || alt) && fill != '0'
9310 && has_precis && intsize != 'q' ) { /* Shortcuts */
9311 /* See earlier comment about buggy Gconvert when digits,
9313 if ( c == 'g' && precis) {
9314 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9315 /* May return an empty string for digits==0 */
9316 if (*PL_efloatbuf) {
9317 elen = strlen(PL_efloatbuf);
9318 goto float_converted;
9320 } else if ( c == 'f' && !precis) {
9321 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9326 char *ptr = ebuf + sizeof ebuf;
9329 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9330 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9331 if (intsize == 'q') {
9332 /* Copy the one or more characters in a long double
9333 * format before the 'base' ([efgEFG]) character to
9334 * the format string. */
9335 static char const prifldbl[] = PERL_PRIfldbl;
9336 char const *p = prifldbl + sizeof(prifldbl) - 3;
9337 while (p >= prifldbl) { *--ptr = *p--; }
9342 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9347 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9359 /* No taint. Otherwise we are in the strange situation
9360 * where printf() taints but print($float) doesn't.
9362 #if defined(HAS_LONG_DOUBLE)
9363 elen = ((intsize == 'q')
9364 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9365 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9367 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9371 eptr = PL_efloatbuf;
9379 i = SvCUR(sv) - origlen;
9382 case 'h': *(va_arg(*args, short*)) = i; break;
9383 default: *(va_arg(*args, int*)) = i; break;
9384 case 'l': *(va_arg(*args, long*)) = i; break;
9385 case 'V': *(va_arg(*args, IV*)) = i; break;
9387 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9392 sv_setuv_mg(argsv, (UV)i);
9393 continue; /* not "break" */
9400 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9401 && ckWARN(WARN_PRINTF))
9403 SV * const msg = sv_newmortal();
9404 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9405 (PL_op->op_type == OP_PRTF) ? "" : "s");
9408 Perl_sv_catpvf(aTHX_ msg,
9409 "\"%%%c\"", c & 0xFF);
9411 Perl_sv_catpvf(aTHX_ msg,
9412 "\"%%\\%03"UVof"\"",
9415 sv_catpvs(msg, "end of string");
9416 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9419 /* output mangled stuff ... */
9425 /* ... right here, because formatting flags should not apply */
9426 SvGROW(sv, SvCUR(sv) + elen + 1);
9428 Copy(eptr, p, elen, char);
9431 SvCUR_set(sv, p - SvPVX_const(sv));
9433 continue; /* not "break" */
9436 if (is_utf8 != has_utf8) {
9439 sv_utf8_upgrade(sv);
9442 const STRLEN old_elen = elen;
9443 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9444 sv_utf8_upgrade(nsv);
9445 eptr = SvPVX_const(nsv);
9448 if (width) { /* fudge width (can't fudge elen) */
9449 width += elen - old_elen;
9455 have = esignlen + zeros + elen;
9457 Perl_croak_nocontext(PL_memory_wrap);
9459 need = (have > width ? have : width);
9462 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9463 Perl_croak_nocontext(PL_memory_wrap);
9464 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9466 if (esignlen && fill == '0') {
9468 for (i = 0; i < (int)esignlen; i++)
9472 memset(p, fill, gap);
9475 if (esignlen && fill != '0') {
9477 for (i = 0; i < (int)esignlen; i++)
9482 for (i = zeros; i; i--)
9486 Copy(eptr, p, elen, char);
9490 memset(p, ' ', gap);
9495 Copy(dotstr, p, dotstrlen, char);
9499 vectorize = FALSE; /* done iterating over vecstr */
9506 SvCUR_set(sv, p - SvPVX_const(sv));
9514 /* =========================================================================
9516 =head1 Cloning an interpreter
9518 All the macros and functions in this section are for the private use of
9519 the main function, perl_clone().
9521 The foo_dup() functions make an exact copy of an existing foo thingy.
9522 During the course of a cloning, a hash table is used to map old addresses
9523 to new addresses. The table is created and manipulated with the
9524 ptr_table_* functions.
9528 ============================================================================*/
9531 #if defined(USE_ITHREADS)
9533 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9534 #ifndef GpREFCNT_inc
9535 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9539 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9540 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9541 If this changes, please unmerge ss_dup. */
9542 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9543 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9544 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9545 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9546 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9547 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9548 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9549 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9550 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9551 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9552 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9553 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9554 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9555 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9557 /* clone a parser */
9560 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9567 /* look for it in the table first */
9568 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9572 /* create anew and remember what it is */
9573 Newxz(parser, 1, yy_parser);
9574 ptr_table_store(PL_ptr_table, proto, parser);
9576 parser->yyerrstatus = 0;
9577 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9579 /* XXX these not yet duped */
9580 parser->old_parser = NULL;
9581 parser->stack = NULL;
9583 parser->stack_size = 0;
9584 /* XXX parser->stack->state = 0; */
9586 /* XXX eventually, just Copy() most of the parser struct ? */
9588 parser->lex_brackets = proto->lex_brackets;
9589 parser->lex_casemods = proto->lex_casemods;
9590 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9591 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9592 parser->lex_casestack = savepvn(proto->lex_casestack,
9593 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9594 parser->lex_defer = proto->lex_defer;
9595 parser->lex_dojoin = proto->lex_dojoin;
9596 parser->lex_expect = proto->lex_expect;
9597 parser->lex_formbrack = proto->lex_formbrack;
9598 parser->lex_inpat = proto->lex_inpat;
9599 parser->lex_inwhat = proto->lex_inwhat;
9600 parser->lex_op = proto->lex_op;
9601 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9602 parser->lex_starts = proto->lex_starts;
9603 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9604 parser->multi_close = proto->multi_close;
9605 parser->multi_open = proto->multi_open;
9606 parser->multi_start = proto->multi_start;
9607 parser->multi_end = proto->multi_end;
9608 parser->pending_ident = proto->pending_ident;
9609 parser->preambled = proto->preambled;
9610 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9611 parser->linestr = sv_dup_inc(proto->linestr, param);
9612 parser->expect = proto->expect;
9613 parser->copline = proto->copline;
9614 parser->last_lop_op = proto->last_lop_op;
9615 parser->lex_state = proto->lex_state;
9616 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9617 /* rsfp_filters entries have fake IoDIRP() */
9618 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9619 parser->in_my = proto->in_my;
9620 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9621 parser->error_count = proto->error_count;
9624 parser->linestr = sv_dup_inc(proto->linestr, param);
9627 char * const ols = SvPVX(proto->linestr);
9628 char * const ls = SvPVX(parser->linestr);
9630 parser->bufptr = ls + (proto->bufptr >= ols ?
9631 proto->bufptr - ols : 0);
9632 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9633 proto->oldbufptr - ols : 0);
9634 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9635 proto->oldoldbufptr - ols : 0);
9636 parser->linestart = ls + (proto->linestart >= ols ?
9637 proto->linestart - ols : 0);
9638 parser->last_uni = ls + (proto->last_uni >= ols ?
9639 proto->last_uni - ols : 0);
9640 parser->last_lop = ls + (proto->last_lop >= ols ?
9641 proto->last_lop - ols : 0);
9643 parser->bufend = ls + SvCUR(parser->linestr);
9646 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9650 parser->endwhite = proto->endwhite;
9651 parser->faketokens = proto->faketokens;
9652 parser->lasttoke = proto->lasttoke;
9653 parser->nextwhite = proto->nextwhite;
9654 parser->realtokenstart = proto->realtokenstart;
9655 parser->skipwhite = proto->skipwhite;
9656 parser->thisclose = proto->thisclose;
9657 parser->thismad = proto->thismad;
9658 parser->thisopen = proto->thisopen;
9659 parser->thisstuff = proto->thisstuff;
9660 parser->thistoken = proto->thistoken;
9661 parser->thiswhite = proto->thiswhite;
9663 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9664 parser->curforce = proto->curforce;
9666 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9667 Copy(proto->nexttype, parser->nexttype, 5, I32);
9668 parser->nexttoke = proto->nexttoke;
9674 /* duplicate a file handle */
9677 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9681 PERL_UNUSED_ARG(type);
9684 return (PerlIO*)NULL;
9686 /* look for it in the table first */
9687 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9691 /* create anew and remember what it is */
9692 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9693 ptr_table_store(PL_ptr_table, fp, ret);
9697 /* duplicate a directory handle */
9700 Perl_dirp_dup(pTHX_ DIR *dp)
9702 PERL_UNUSED_CONTEXT;
9709 /* duplicate a typeglob */
9712 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9718 /* look for it in the table first */
9719 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9723 /* create anew and remember what it is */
9725 ptr_table_store(PL_ptr_table, gp, ret);
9728 ret->gp_refcnt = 0; /* must be before any other dups! */
9729 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9730 ret->gp_io = io_dup_inc(gp->gp_io, param);
9731 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9732 ret->gp_av = av_dup_inc(gp->gp_av, param);
9733 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9734 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9735 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9736 ret->gp_cvgen = gp->gp_cvgen;
9737 ret->gp_line = gp->gp_line;
9738 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9742 /* duplicate a chain of magic */
9745 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9747 MAGIC *mgprev = (MAGIC*)NULL;
9750 return (MAGIC*)NULL;
9751 /* look for it in the table first */
9752 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9756 for (; mg; mg = mg->mg_moremagic) {
9758 Newxz(nmg, 1, MAGIC);
9760 mgprev->mg_moremagic = nmg;
9763 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9764 nmg->mg_private = mg->mg_private;
9765 nmg->mg_type = mg->mg_type;
9766 nmg->mg_flags = mg->mg_flags;
9767 if (mg->mg_type == PERL_MAGIC_qr) {
9768 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9770 else if(mg->mg_type == PERL_MAGIC_backref) {
9771 /* The backref AV has its reference count deliberately bumped by
9773 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9776 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9777 ? sv_dup_inc(mg->mg_obj, param)
9778 : sv_dup(mg->mg_obj, param);
9780 nmg->mg_len = mg->mg_len;
9781 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9782 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9783 if (mg->mg_len > 0) {
9784 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9785 if (mg->mg_type == PERL_MAGIC_overload_table &&
9786 AMT_AMAGIC((AMT*)mg->mg_ptr))
9788 const AMT * const amtp = (AMT*)mg->mg_ptr;
9789 AMT * const namtp = (AMT*)nmg->mg_ptr;
9791 for (i = 1; i < NofAMmeth; i++) {
9792 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9796 else if (mg->mg_len == HEf_SVKEY)
9797 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9799 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9800 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9807 #endif /* USE_ITHREADS */
9809 /* create a new pointer-mapping table */
9812 Perl_ptr_table_new(pTHX)
9815 PERL_UNUSED_CONTEXT;
9817 Newxz(tbl, 1, PTR_TBL_t);
9820 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9824 #define PTR_TABLE_HASH(ptr) \
9825 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9828 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9829 following define) and at call to new_body_inline made below in
9830 Perl_ptr_table_store()
9833 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9835 /* map an existing pointer using a table */
9837 STATIC PTR_TBL_ENT_t *
9838 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9839 PTR_TBL_ENT_t *tblent;
9840 const UV hash = PTR_TABLE_HASH(sv);
9842 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9843 for (; tblent; tblent = tblent->next) {
9844 if (tblent->oldval == sv)
9851 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9853 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9854 PERL_UNUSED_CONTEXT;
9855 return tblent ? tblent->newval : NULL;
9858 /* add a new entry to a pointer-mapping table */
9861 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9863 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9864 PERL_UNUSED_CONTEXT;
9867 tblent->newval = newsv;
9869 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9871 new_body_inline(tblent, PTE_SVSLOT);
9873 tblent->oldval = oldsv;
9874 tblent->newval = newsv;
9875 tblent->next = tbl->tbl_ary[entry];
9876 tbl->tbl_ary[entry] = tblent;
9878 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9879 ptr_table_split(tbl);
9883 /* double the hash bucket size of an existing ptr table */
9886 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9888 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9889 const UV oldsize = tbl->tbl_max + 1;
9890 UV newsize = oldsize * 2;
9892 PERL_UNUSED_CONTEXT;
9894 Renew(ary, newsize, PTR_TBL_ENT_t*);
9895 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9896 tbl->tbl_max = --newsize;
9898 for (i=0; i < oldsize; i++, ary++) {
9899 PTR_TBL_ENT_t **curentp, **entp, *ent;
9902 curentp = ary + oldsize;
9903 for (entp = ary, ent = *ary; ent; ent = *entp) {
9904 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9906 ent->next = *curentp;
9916 /* remove all the entries from a ptr table */
9919 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9921 if (tbl && tbl->tbl_items) {
9922 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9923 UV riter = tbl->tbl_max;
9926 PTR_TBL_ENT_t *entry = array[riter];
9929 PTR_TBL_ENT_t * const oentry = entry;
9930 entry = entry->next;
9939 /* clear and free a ptr table */
9942 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9947 ptr_table_clear(tbl);
9948 Safefree(tbl->tbl_ary);
9952 #if defined(USE_ITHREADS)
9955 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9958 SvRV_set(dstr, SvWEAKREF(sstr)
9959 ? sv_dup(SvRV(sstr), param)
9960 : sv_dup_inc(SvRV(sstr), param));
9963 else if (SvPVX_const(sstr)) {
9964 /* Has something there */
9966 /* Normal PV - clone whole allocated space */
9967 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9968 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9969 /* Not that normal - actually sstr is copy on write.
9970 But we are a true, independant SV, so: */
9971 SvREADONLY_off(dstr);
9976 /* Special case - not normally malloced for some reason */
9977 if (isGV_with_GP(sstr)) {
9978 /* Don't need to do anything here. */
9980 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9981 /* A "shared" PV - clone it as "shared" PV */
9983 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9987 /* Some other special case - random pointer */
9988 SvPV_set(dstr, SvPVX(sstr));
9994 if (SvTYPE(dstr) == SVt_RV)
9995 SvRV_set(dstr, NULL);
9997 SvPV_set(dstr, NULL);
10001 /* duplicate an SV of any type (including AV, HV etc) */
10004 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10009 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10011 /* look for it in the table first */
10012 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10016 if(param->flags & CLONEf_JOIN_IN) {
10017 /** We are joining here so we don't want do clone
10018 something that is bad **/
10019 if (SvTYPE(sstr) == SVt_PVHV) {
10020 const HEK * const hvname = HvNAME_HEK(sstr);
10022 /** don't clone stashes if they already exist **/
10023 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10027 /* create anew and remember what it is */
10030 #ifdef DEBUG_LEAKING_SCALARS
10031 dstr->sv_debug_optype = sstr->sv_debug_optype;
10032 dstr->sv_debug_line = sstr->sv_debug_line;
10033 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10034 dstr->sv_debug_cloned = 1;
10035 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10038 ptr_table_store(PL_ptr_table, sstr, dstr);
10041 SvFLAGS(dstr) = SvFLAGS(sstr);
10042 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10043 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10046 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10047 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10048 (void*)PL_watch_pvx, SvPVX_const(sstr));
10051 /* don't clone objects whose class has asked us not to */
10052 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10057 switch (SvTYPE(sstr)) {
10059 SvANY(dstr) = NULL;
10062 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10063 SvIV_set(dstr, SvIVX(sstr));
10066 SvANY(dstr) = new_XNV();
10067 SvNV_set(dstr, SvNVX(sstr));
10070 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10071 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10073 /* case SVt_BIND: */
10076 /* These are all the types that need complex bodies allocating. */
10078 const svtype sv_type = SvTYPE(sstr);
10079 const struct body_details *const sv_type_details
10080 = bodies_by_type + sv_type;
10084 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10088 if (GvUNIQUE((GV*)sstr)) {
10089 NOOP; /* Do sharing here, and fall through */
10101 assert(sv_type_details->body_size);
10102 if (sv_type_details->arena) {
10103 new_body_inline(new_body, sv_type);
10105 = (void*)((char*)new_body - sv_type_details->offset);
10107 new_body = new_NOARENA(sv_type_details);
10111 SvANY(dstr) = new_body;
10114 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10115 ((char*)SvANY(dstr)) + sv_type_details->offset,
10116 sv_type_details->copy, char);
10118 Copy(((char*)SvANY(sstr)),
10119 ((char*)SvANY(dstr)),
10120 sv_type_details->body_size + sv_type_details->offset, char);
10123 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10124 && !isGV_with_GP(dstr))
10125 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10127 /* The Copy above means that all the source (unduplicated) pointers
10128 are now in the destination. We can check the flags and the
10129 pointers in either, but it's possible that there's less cache
10130 missing by always going for the destination.
10131 FIXME - instrument and check that assumption */
10132 if (sv_type >= SVt_PVMG) {
10133 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10134 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10135 } else if (SvMAGIC(dstr))
10136 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10138 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10141 /* The cast silences a GCC warning about unhandled types. */
10142 switch ((int)sv_type) {
10152 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10153 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10154 LvTARG(dstr) = dstr;
10155 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10156 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10158 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10160 if(isGV_with_GP(sstr)) {
10161 if (GvNAME_HEK(dstr))
10162 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10163 /* Don't call sv_add_backref here as it's going to be
10164 created as part of the magic cloning of the symbol
10166 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10167 at the point of this comment. */
10168 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10169 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10170 (void)GpREFCNT_inc(GvGP(dstr));
10172 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10175 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10176 if (IoOFP(dstr) == IoIFP(sstr))
10177 IoOFP(dstr) = IoIFP(dstr);
10179 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10180 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10181 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10182 /* I have no idea why fake dirp (rsfps)
10183 should be treated differently but otherwise
10184 we end up with leaks -- sky*/
10185 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10186 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10187 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10189 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10190 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10191 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10192 if (IoDIRP(dstr)) {
10193 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10196 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10199 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10200 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10201 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10204 if (AvARRAY((AV*)sstr)) {
10205 SV **dst_ary, **src_ary;
10206 SSize_t items = AvFILLp((AV*)sstr) + 1;
10208 src_ary = AvARRAY((AV*)sstr);
10209 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10210 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10211 AvARRAY((AV*)dstr) = dst_ary;
10212 AvALLOC((AV*)dstr) = dst_ary;
10213 if (AvREAL((AV*)sstr)) {
10214 while (items-- > 0)
10215 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10218 while (items-- > 0)
10219 *dst_ary++ = sv_dup(*src_ary++, param);
10221 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10222 while (items-- > 0) {
10223 *dst_ary++ = &PL_sv_undef;
10227 AvARRAY((AV*)dstr) = NULL;
10228 AvALLOC((AV*)dstr) = (SV**)NULL;
10232 if (HvARRAY((HV*)sstr)) {
10234 const bool sharekeys = !!HvSHAREKEYS(sstr);
10235 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10236 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10238 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10239 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10241 HvARRAY(dstr) = (HE**)darray;
10242 while (i <= sxhv->xhv_max) {
10243 const HE * const source = HvARRAY(sstr)[i];
10244 HvARRAY(dstr)[i] = source
10245 ? he_dup(source, sharekeys, param) : 0;
10250 const struct xpvhv_aux * const saux = HvAUX(sstr);
10251 struct xpvhv_aux * const daux = HvAUX(dstr);
10252 /* This flag isn't copied. */
10253 /* SvOOK_on(hv) attacks the IV flags. */
10254 SvFLAGS(dstr) |= SVf_OOK;
10256 hvname = saux->xhv_name;
10257 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10259 daux->xhv_riter = saux->xhv_riter;
10260 daux->xhv_eiter = saux->xhv_eiter
10261 ? he_dup(saux->xhv_eiter,
10262 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10263 daux->xhv_backreferences =
10264 saux->xhv_backreferences
10265 ? (AV*) SvREFCNT_inc(
10266 sv_dup((SV*)saux->xhv_backreferences, param))
10269 daux->xhv_mro_meta = saux->xhv_mro_meta
10270 ? mro_meta_dup(saux->xhv_mro_meta, param)
10273 /* Record stashes for possible cloning in Perl_clone(). */
10275 av_push(param->stashes, dstr);
10279 HvARRAY((HV*)dstr) = NULL;
10282 if (!(param->flags & CLONEf_COPY_STACKS)) {
10286 /* NOTE: not refcounted */
10287 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10289 if (!CvISXSUB(dstr))
10290 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10292 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10293 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10294 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10295 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10297 /* don't dup if copying back - CvGV isn't refcounted, so the
10298 * duped GV may never be freed. A bit of a hack! DAPM */
10299 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10300 NULL : gv_dup(CvGV(dstr), param) ;
10301 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10303 CvWEAKOUTSIDE(sstr)
10304 ? cv_dup( CvOUTSIDE(dstr), param)
10305 : cv_dup_inc(CvOUTSIDE(dstr), param);
10306 if (!CvISXSUB(dstr))
10307 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10313 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10319 /* duplicate a context */
10322 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10324 PERL_CONTEXT *ncxs;
10327 return (PERL_CONTEXT*)NULL;
10329 /* look for it in the table first */
10330 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10334 /* create anew and remember what it is */
10335 Newxz(ncxs, max + 1, PERL_CONTEXT);
10336 ptr_table_store(PL_ptr_table, cxs, ncxs);
10339 PERL_CONTEXT * const cx = &cxs[ix];
10340 PERL_CONTEXT * const ncx = &ncxs[ix];
10341 ncx->cx_type = cx->cx_type;
10342 if (CxTYPE(cx) == CXt_SUBST) {
10343 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10346 ncx->blk_oldsp = cx->blk_oldsp;
10347 ncx->blk_oldcop = cx->blk_oldcop;
10348 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10349 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10350 ncx->blk_oldpm = cx->blk_oldpm;
10351 ncx->blk_gimme = cx->blk_gimme;
10352 switch (CxTYPE(cx)) {
10354 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10355 ? cv_dup_inc(cx->blk_sub.cv, param)
10356 : cv_dup(cx->blk_sub.cv,param));
10357 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10358 ? av_dup_inc(cx->blk_sub.argarray, param)
10360 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10361 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10362 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10363 ncx->blk_sub.lval = cx->blk_sub.lval;
10364 ncx->blk_sub.retop = cx->blk_sub.retop;
10365 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10366 cx->blk_sub.oldcomppad);
10369 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10370 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10371 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10372 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10373 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10374 ncx->blk_eval.retop = cx->blk_eval.retop;
10377 ncx->blk_loop.label = cx->blk_loop.label;
10378 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10379 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10380 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10381 ? cx->blk_loop.iterdata
10382 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10383 ncx->blk_loop.oldcomppad
10384 = (PAD*)ptr_table_fetch(PL_ptr_table,
10385 cx->blk_loop.oldcomppad);
10386 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10387 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10388 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10389 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10390 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10393 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10394 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10395 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10396 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10397 ncx->blk_sub.retop = cx->blk_sub.retop;
10409 /* duplicate a stack info structure */
10412 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10417 return (PERL_SI*)NULL;
10419 /* look for it in the table first */
10420 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10424 /* create anew and remember what it is */
10425 Newxz(nsi, 1, PERL_SI);
10426 ptr_table_store(PL_ptr_table, si, nsi);
10428 nsi->si_stack = av_dup_inc(si->si_stack, param);
10429 nsi->si_cxix = si->si_cxix;
10430 nsi->si_cxmax = si->si_cxmax;
10431 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10432 nsi->si_type = si->si_type;
10433 nsi->si_prev = si_dup(si->si_prev, param);
10434 nsi->si_next = si_dup(si->si_next, param);
10435 nsi->si_markoff = si->si_markoff;
10440 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10441 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10442 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10443 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10444 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10445 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10446 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10447 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10448 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10449 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10450 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10451 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10452 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10453 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10456 #define pv_dup_inc(p) SAVEPV(p)
10457 #define pv_dup(p) SAVEPV(p)
10458 #define svp_dup_inc(p,pp) any_dup(p,pp)
10460 /* map any object to the new equivent - either something in the
10461 * ptr table, or something in the interpreter structure
10465 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10470 return (void*)NULL;
10472 /* look for it in the table first */
10473 ret = ptr_table_fetch(PL_ptr_table, v);
10477 /* see if it is part of the interpreter structure */
10478 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10479 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10487 /* duplicate the save stack */
10490 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10493 ANY * const ss = proto_perl->Isavestack;
10494 const I32 max = proto_perl->Isavestack_max;
10495 I32 ix = proto_perl->Isavestack_ix;
10508 void (*dptr) (void*);
10509 void (*dxptr) (pTHX_ void*);
10511 Newxz(nss, max, ANY);
10514 const I32 type = POPINT(ss,ix);
10515 TOPINT(nss,ix) = type;
10517 case SAVEt_HELEM: /* hash element */
10518 sv = (SV*)POPPTR(ss,ix);
10519 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10521 case SAVEt_ITEM: /* normal string */
10522 case SAVEt_SV: /* scalar reference */
10523 sv = (SV*)POPPTR(ss,ix);
10524 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10527 case SAVEt_MORTALIZESV:
10528 sv = (SV*)POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10531 case SAVEt_SHARED_PVREF: /* char* in shared space */
10532 c = (char*)POPPTR(ss,ix);
10533 TOPPTR(nss,ix) = savesharedpv(c);
10534 ptr = POPPTR(ss,ix);
10535 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10537 case SAVEt_GENERIC_SVREF: /* generic sv */
10538 case SAVEt_SVREF: /* scalar reference */
10539 sv = (SV*)POPPTR(ss,ix);
10540 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10541 ptr = POPPTR(ss,ix);
10542 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10544 case SAVEt_HV: /* hash reference */
10545 case SAVEt_AV: /* array reference */
10546 sv = (SV*) POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10549 case SAVEt_COMPPAD:
10551 sv = (SV*) POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = sv_dup(sv, param);
10554 case SAVEt_INT: /* int reference */
10555 ptr = POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10557 intval = (int)POPINT(ss,ix);
10558 TOPINT(nss,ix) = intval;
10560 case SAVEt_LONG: /* long reference */
10561 ptr = POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10564 case SAVEt_CLEARSV:
10565 longval = (long)POPLONG(ss,ix);
10566 TOPLONG(nss,ix) = longval;
10568 case SAVEt_I32: /* I32 reference */
10569 case SAVEt_I16: /* I16 reference */
10570 case SAVEt_I8: /* I8 reference */
10571 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10572 ptr = POPPTR(ss,ix);
10573 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10575 TOPINT(nss,ix) = i;
10577 case SAVEt_IV: /* IV reference */
10578 ptr = POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10581 TOPIV(nss,ix) = iv;
10583 case SAVEt_HPTR: /* HV* reference */
10584 case SAVEt_APTR: /* AV* reference */
10585 case SAVEt_SPTR: /* SV* reference */
10586 ptr = POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10588 sv = (SV*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = sv_dup(sv, param);
10591 case SAVEt_VPTR: /* random* reference */
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10594 ptr = POPPTR(ss,ix);
10595 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 case SAVEt_GENERIC_PVREF: /* generic char* */
10598 case SAVEt_PPTR: /* char* reference */
10599 ptr = POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10601 c = (char*)POPPTR(ss,ix);
10602 TOPPTR(nss,ix) = pv_dup(c);
10604 case SAVEt_GP: /* scalar reference */
10605 gp = (GP*)POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10607 (void)GpREFCNT_inc(gp);
10608 gv = (GV*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10612 ptr = POPPTR(ss,ix);
10613 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10614 /* these are assumed to be refcounted properly */
10616 switch (((OP*)ptr)->op_type) {
10618 case OP_LEAVESUBLV:
10622 case OP_LEAVEWRITE:
10623 TOPPTR(nss,ix) = ptr;
10626 (void) OpREFCNT_inc(o);
10630 TOPPTR(nss,ix) = NULL;
10635 TOPPTR(nss,ix) = NULL;
10638 c = (char*)POPPTR(ss,ix);
10639 TOPPTR(nss,ix) = pv_dup_inc(c);
10642 hv = (HV*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10644 c = (char*)POPPTR(ss,ix);
10645 TOPPTR(nss,ix) = pv_dup_inc(c);
10647 case SAVEt_STACK_POS: /* Position on Perl stack */
10649 TOPINT(nss,ix) = i;
10651 case SAVEt_DESTRUCTOR:
10652 ptr = POPPTR(ss,ix);
10653 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10654 dptr = POPDPTR(ss,ix);
10655 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10656 any_dup(FPTR2DPTR(void *, dptr),
10659 case SAVEt_DESTRUCTOR_X:
10660 ptr = POPPTR(ss,ix);
10661 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10662 dxptr = POPDXPTR(ss,ix);
10663 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10664 any_dup(FPTR2DPTR(void *, dxptr),
10667 case SAVEt_REGCONTEXT:
10670 TOPINT(nss,ix) = i;
10673 case SAVEt_AELEM: /* array element */
10674 sv = (SV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10677 TOPINT(nss,ix) = i;
10678 av = (AV*)POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = av_dup_inc(av, param);
10682 ptr = POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = ptr;
10687 TOPINT(nss,ix) = i;
10688 ptr = POPPTR(ss,ix);
10691 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10692 HINTS_REFCNT_UNLOCK;
10694 TOPPTR(nss,ix) = ptr;
10695 if (i & HINT_LOCALIZE_HH) {
10696 hv = (HV*)POPPTR(ss,ix);
10697 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10701 longval = (long)POPLONG(ss,ix);
10702 TOPLONG(nss,ix) = longval;
10703 ptr = POPPTR(ss,ix);
10704 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10705 sv = (SV*)POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = sv_dup(sv, param);
10709 ptr = POPPTR(ss,ix);
10710 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10711 longval = (long)POPBOOL(ss,ix);
10712 TOPBOOL(nss,ix) = (bool)longval;
10714 case SAVEt_SET_SVFLAGS:
10716 TOPINT(nss,ix) = i;
10718 TOPINT(nss,ix) = i;
10719 sv = (SV*)POPPTR(ss,ix);
10720 TOPPTR(nss,ix) = sv_dup(sv, param);
10722 case SAVEt_RE_STATE:
10724 const struct re_save_state *const old_state
10725 = (struct re_save_state *)
10726 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10727 struct re_save_state *const new_state
10728 = (struct re_save_state *)
10729 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10731 Copy(old_state, new_state, 1, struct re_save_state);
10732 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10734 new_state->re_state_bostr
10735 = pv_dup(old_state->re_state_bostr);
10736 new_state->re_state_reginput
10737 = pv_dup(old_state->re_state_reginput);
10738 new_state->re_state_regeol
10739 = pv_dup(old_state->re_state_regeol);
10740 new_state->re_state_regoffs
10741 = (regexp_paren_pair*)
10742 any_dup(old_state->re_state_regoffs, proto_perl);
10743 new_state->re_state_reglastparen
10744 = (U32*) any_dup(old_state->re_state_reglastparen,
10746 new_state->re_state_reglastcloseparen
10747 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10749 /* XXX This just has to be broken. The old save_re_context
10750 code did SAVEGENERICPV(PL_reg_start_tmp);
10751 PL_reg_start_tmp is char **.
10752 Look above to what the dup code does for
10753 SAVEt_GENERIC_PVREF
10754 It can never have worked.
10755 So this is merely a faithful copy of the exiting bug: */
10756 new_state->re_state_reg_start_tmp
10757 = (char **) pv_dup((char *)
10758 old_state->re_state_reg_start_tmp);
10759 /* I assume that it only ever "worked" because no-one called
10760 (pseudo)fork while the regexp engine had re-entered itself.
10762 #ifdef PERL_OLD_COPY_ON_WRITE
10763 new_state->re_state_nrs
10764 = sv_dup(old_state->re_state_nrs, param);
10766 new_state->re_state_reg_magic
10767 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10769 new_state->re_state_reg_oldcurpm
10770 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10772 new_state->re_state_reg_curpm
10773 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10775 new_state->re_state_reg_oldsaved
10776 = pv_dup(old_state->re_state_reg_oldsaved);
10777 new_state->re_state_reg_poscache
10778 = pv_dup(old_state->re_state_reg_poscache);
10779 new_state->re_state_reg_starttry
10780 = pv_dup(old_state->re_state_reg_starttry);
10783 case SAVEt_COMPILE_WARNINGS:
10784 ptr = POPPTR(ss,ix);
10785 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10788 ptr = POPPTR(ss,ix);
10789 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10793 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10801 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10802 * flag to the result. This is done for each stash before cloning starts,
10803 * so we know which stashes want their objects cloned */
10806 do_mark_cloneable_stash(pTHX_ SV *sv)
10808 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10810 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10811 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10812 if (cloner && GvCV(cloner)) {
10819 XPUSHs(sv_2mortal(newSVhek(hvname)));
10821 call_sv((SV*)GvCV(cloner), G_SCALAR);
10828 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10836 =for apidoc perl_clone
10838 Create and return a new interpreter by cloning the current one.
10840 perl_clone takes these flags as parameters:
10842 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10843 without it we only clone the data and zero the stacks,
10844 with it we copy the stacks and the new perl interpreter is
10845 ready to run at the exact same point as the previous one.
10846 The pseudo-fork code uses COPY_STACKS while the
10847 threads->create doesn't.
10849 CLONEf_KEEP_PTR_TABLE
10850 perl_clone keeps a ptr_table with the pointer of the old
10851 variable as a key and the new variable as a value,
10852 this allows it to check if something has been cloned and not
10853 clone it again but rather just use the value and increase the
10854 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10855 the ptr_table using the function
10856 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10857 reason to keep it around is if you want to dup some of your own
10858 variable who are outside the graph perl scans, example of this
10859 code is in threads.xs create
10862 This is a win32 thing, it is ignored on unix, it tells perls
10863 win32host code (which is c++) to clone itself, this is needed on
10864 win32 if you want to run two threads at the same time,
10865 if you just want to do some stuff in a separate perl interpreter
10866 and then throw it away and return to the original one,
10867 you don't need to do anything.
10872 /* XXX the above needs expanding by someone who actually understands it ! */
10873 EXTERN_C PerlInterpreter *
10874 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10877 perl_clone(PerlInterpreter *proto_perl, UV flags)
10880 #ifdef PERL_IMPLICIT_SYS
10882 /* perlhost.h so we need to call into it
10883 to clone the host, CPerlHost should have a c interface, sky */
10885 if (flags & CLONEf_CLONE_HOST) {
10886 return perl_clone_host(proto_perl,flags);
10888 return perl_clone_using(proto_perl, flags,
10890 proto_perl->IMemShared,
10891 proto_perl->IMemParse,
10893 proto_perl->IStdIO,
10897 proto_perl->IProc);
10901 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10902 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10903 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10904 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10905 struct IPerlDir* ipD, struct IPerlSock* ipS,
10906 struct IPerlProc* ipP)
10908 /* XXX many of the string copies here can be optimized if they're
10909 * constants; they need to be allocated as common memory and just
10910 * their pointers copied. */
10913 CLONE_PARAMS clone_params;
10914 CLONE_PARAMS* const param = &clone_params;
10916 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10917 /* for each stash, determine whether its objects should be cloned */
10918 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10919 PERL_SET_THX(my_perl);
10922 PoisonNew(my_perl, 1, PerlInterpreter);
10928 PL_savestack_ix = 0;
10929 PL_savestack_max = -1;
10930 PL_sig_pending = 0;
10932 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10933 # else /* !DEBUGGING */
10934 Zero(my_perl, 1, PerlInterpreter);
10935 # endif /* DEBUGGING */
10937 /* host pointers */
10939 PL_MemShared = ipMS;
10940 PL_MemParse = ipMP;
10947 #else /* !PERL_IMPLICIT_SYS */
10949 CLONE_PARAMS clone_params;
10950 CLONE_PARAMS* param = &clone_params;
10951 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10952 /* for each stash, determine whether its objects should be cloned */
10953 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10954 PERL_SET_THX(my_perl);
10957 PoisonNew(my_perl, 1, PerlInterpreter);
10963 PL_savestack_ix = 0;
10964 PL_savestack_max = -1;
10965 PL_sig_pending = 0;
10967 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10968 # else /* !DEBUGGING */
10969 Zero(my_perl, 1, PerlInterpreter);
10970 # endif /* DEBUGGING */
10971 #endif /* PERL_IMPLICIT_SYS */
10972 param->flags = flags;
10973 param->proto_perl = proto_perl;
10975 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10977 PL_body_arenas = NULL;
10978 Zero(&PL_body_roots, 1, PL_body_roots);
10980 PL_nice_chunk = NULL;
10981 PL_nice_chunk_size = 0;
10983 PL_sv_objcount = 0;
10985 PL_sv_arenaroot = NULL;
10987 PL_debug = proto_perl->Idebug;
10989 PL_hash_seed = proto_perl->Ihash_seed;
10990 PL_rehash_seed = proto_perl->Irehash_seed;
10992 #ifdef USE_REENTRANT_API
10993 /* XXX: things like -Dm will segfault here in perlio, but doing
10994 * PERL_SET_CONTEXT(proto_perl);
10995 * breaks too many other things
10997 Perl_reentrant_init(aTHX);
11000 /* create SV map for pointer relocation */
11001 PL_ptr_table = ptr_table_new();
11003 /* initialize these special pointers as early as possible */
11004 SvANY(&PL_sv_undef) = NULL;
11005 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11006 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11007 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11009 SvANY(&PL_sv_no) = new_XPVNV();
11010 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11011 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11012 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11013 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11014 SvCUR_set(&PL_sv_no, 0);
11015 SvLEN_set(&PL_sv_no, 1);
11016 SvIV_set(&PL_sv_no, 0);
11017 SvNV_set(&PL_sv_no, 0);
11018 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11020 SvANY(&PL_sv_yes) = new_XPVNV();
11021 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11022 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11023 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11024 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11025 SvCUR_set(&PL_sv_yes, 1);
11026 SvLEN_set(&PL_sv_yes, 2);
11027 SvIV_set(&PL_sv_yes, 1);
11028 SvNV_set(&PL_sv_yes, 1);
11029 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11031 /* create (a non-shared!) shared string table */
11032 PL_strtab = newHV();
11033 HvSHAREKEYS_off(PL_strtab);
11034 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11035 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11037 PL_compiling = proto_perl->Icompiling;
11039 /* These two PVs will be free'd special way so must set them same way op.c does */
11040 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11041 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11043 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11044 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11046 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11047 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11048 if (PL_compiling.cop_hints_hash) {
11050 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11051 HINTS_REFCNT_UNLOCK;
11053 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11054 #ifdef PERL_DEBUG_READONLY_OPS
11059 /* pseudo environmental stuff */
11060 PL_origargc = proto_perl->Iorigargc;
11061 PL_origargv = proto_perl->Iorigargv;
11063 param->stashes = newAV(); /* Setup array of objects to call clone on */
11065 /* Set tainting stuff before PerlIO_debug can possibly get called */
11066 PL_tainting = proto_perl->Itainting;
11067 PL_taint_warn = proto_perl->Itaint_warn;
11069 #ifdef PERLIO_LAYERS
11070 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11071 PerlIO_clone(aTHX_ proto_perl, param);
11074 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11075 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11076 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11077 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11078 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11079 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11082 PL_minus_c = proto_perl->Iminus_c;
11083 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11084 PL_localpatches = proto_perl->Ilocalpatches;
11085 PL_splitstr = proto_perl->Isplitstr;
11086 PL_preprocess = proto_perl->Ipreprocess;
11087 PL_minus_n = proto_perl->Iminus_n;
11088 PL_minus_p = proto_perl->Iminus_p;
11089 PL_minus_l = proto_perl->Iminus_l;
11090 PL_minus_a = proto_perl->Iminus_a;
11091 PL_minus_E = proto_perl->Iminus_E;
11092 PL_minus_F = proto_perl->Iminus_F;
11093 PL_doswitches = proto_perl->Idoswitches;
11094 PL_dowarn = proto_perl->Idowarn;
11095 PL_doextract = proto_perl->Idoextract;
11096 PL_sawampersand = proto_perl->Isawampersand;
11097 PL_unsafe = proto_perl->Iunsafe;
11098 PL_inplace = SAVEPV(proto_perl->Iinplace);
11099 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11100 PL_perldb = proto_perl->Iperldb;
11101 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11102 PL_exit_flags = proto_perl->Iexit_flags;
11104 /* magical thingies */
11105 /* XXX time(&PL_basetime) when asked for? */
11106 PL_basetime = proto_perl->Ibasetime;
11107 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11109 PL_maxsysfd = proto_perl->Imaxsysfd;
11110 PL_statusvalue = proto_perl->Istatusvalue;
11112 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11114 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11116 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11118 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11119 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11120 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11123 /* RE engine related */
11124 Zero(&PL_reg_state, 1, struct re_save_state);
11125 PL_reginterp_cnt = 0;
11126 PL_regmatch_slab = NULL;
11128 /* Clone the regex array */
11129 PL_regex_padav = newAV();
11131 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11132 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11134 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11135 for(i = 1; i <= len; i++) {
11136 const SV * const regex = regexen[i];
11139 ? sv_dup_inc(regex, param)
11141 newSViv(PTR2IV(CALLREGDUPE(
11142 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11144 if (SvFLAGS(regex) & SVf_BREAK)
11145 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11146 av_push(PL_regex_padav, sv);
11149 PL_regex_pad = AvARRAY(PL_regex_padav);
11151 /* shortcuts to various I/O objects */
11152 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11153 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11154 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11155 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11156 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11157 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11159 /* shortcuts to regexp stuff */
11160 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11162 /* shortcuts to misc objects */
11163 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11165 /* shortcuts to debugging objects */
11166 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11167 PL_DBline = gv_dup(proto_perl->IDBline, param);
11168 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11169 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11170 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11171 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11172 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11174 /* symbol tables */
11175 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11176 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11177 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11178 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11179 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11181 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11182 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11183 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11184 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11185 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11186 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11187 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11188 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11190 PL_sub_generation = proto_perl->Isub_generation;
11191 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11193 /* funky return mechanisms */
11194 PL_forkprocess = proto_perl->Iforkprocess;
11196 /* subprocess state */
11197 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11199 /* internal state */
11200 PL_maxo = proto_perl->Imaxo;
11201 if (proto_perl->Iop_mask)
11202 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11205 /* PL_asserting = proto_perl->Iasserting; */
11207 /* current interpreter roots */
11208 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11210 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11212 PL_main_start = proto_perl->Imain_start;
11213 PL_eval_root = proto_perl->Ieval_root;
11214 PL_eval_start = proto_perl->Ieval_start;
11216 /* runtime control stuff */
11217 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11219 PL_filemode = proto_perl->Ifilemode;
11220 PL_lastfd = proto_perl->Ilastfd;
11221 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11224 PL_gensym = proto_perl->Igensym;
11225 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11226 PL_laststatval = proto_perl->Ilaststatval;
11227 PL_laststype = proto_perl->Ilaststype;
11230 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11232 /* interpreter atexit processing */
11233 PL_exitlistlen = proto_perl->Iexitlistlen;
11234 if (PL_exitlistlen) {
11235 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11236 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11239 PL_exitlist = (PerlExitListEntry*)NULL;
11241 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11242 if (PL_my_cxt_size) {
11243 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11244 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11245 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11246 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11247 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11251 PL_my_cxt_list = (void**)NULL;
11252 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11253 PL_my_cxt_keys = (const char**)NULL;
11256 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11257 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11258 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11260 PL_profiledata = NULL;
11262 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11264 PAD_CLONE_VARS(proto_perl, param);
11266 #ifdef HAVE_INTERP_INTERN
11267 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11270 /* more statics moved here */
11271 PL_generation = proto_perl->Igeneration;
11272 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11274 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11275 PL_in_clean_all = proto_perl->Iin_clean_all;
11277 PL_uid = proto_perl->Iuid;
11278 PL_euid = proto_perl->Ieuid;
11279 PL_gid = proto_perl->Igid;
11280 PL_egid = proto_perl->Iegid;
11281 PL_nomemok = proto_perl->Inomemok;
11282 PL_an = proto_perl->Ian;
11283 PL_evalseq = proto_perl->Ievalseq;
11284 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11285 PL_origalen = proto_perl->Iorigalen;
11286 #ifdef PERL_USES_PL_PIDSTATUS
11287 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11289 PL_osname = SAVEPV(proto_perl->Iosname);
11290 PL_sighandlerp = proto_perl->Isighandlerp;
11292 PL_runops = proto_perl->Irunops;
11294 PL_parser = parser_dup(proto_perl->Iparser, param);
11296 PL_subline = proto_perl->Isubline;
11297 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11300 PL_cryptseen = proto_perl->Icryptseen;
11303 PL_hints = proto_perl->Ihints;
11305 PL_amagic_generation = proto_perl->Iamagic_generation;
11307 #ifdef USE_LOCALE_COLLATE
11308 PL_collation_ix = proto_perl->Icollation_ix;
11309 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11310 PL_collation_standard = proto_perl->Icollation_standard;
11311 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11312 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11313 #endif /* USE_LOCALE_COLLATE */
11315 #ifdef USE_LOCALE_NUMERIC
11316 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11317 PL_numeric_standard = proto_perl->Inumeric_standard;
11318 PL_numeric_local = proto_perl->Inumeric_local;
11319 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11320 #endif /* !USE_LOCALE_NUMERIC */
11322 /* utf8 character classes */
11323 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11324 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11325 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11326 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11327 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11328 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11329 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11330 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11331 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11332 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11333 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11334 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11335 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11336 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11337 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11338 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11339 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11340 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11341 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11342 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11344 /* Did the locale setup indicate UTF-8? */
11345 PL_utf8locale = proto_perl->Iutf8locale;
11346 /* Unicode features (see perlrun/-C) */
11347 PL_unicode = proto_perl->Iunicode;
11349 /* Pre-5.8 signals control */
11350 PL_signals = proto_perl->Isignals;
11352 /* times() ticks per second */
11353 PL_clocktick = proto_perl->Iclocktick;
11355 /* Recursion stopper for PerlIO_find_layer */
11356 PL_in_load_module = proto_perl->Iin_load_module;
11358 /* sort() routine */
11359 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11361 /* Not really needed/useful since the reenrant_retint is "volatile",
11362 * but do it for consistency's sake. */
11363 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11365 /* Hooks to shared SVs and locks. */
11366 PL_sharehook = proto_perl->Isharehook;
11367 PL_lockhook = proto_perl->Ilockhook;
11368 PL_unlockhook = proto_perl->Iunlockhook;
11369 PL_threadhook = proto_perl->Ithreadhook;
11370 PL_destroyhook = proto_perl->Idestroyhook;
11372 #ifdef THREADS_HAVE_PIDS
11373 PL_ppid = proto_perl->Ippid;
11377 PL_last_swash_hv = NULL; /* reinits on demand */
11378 PL_last_swash_klen = 0;
11379 PL_last_swash_key[0]= '\0';
11380 PL_last_swash_tmps = (U8*)NULL;
11381 PL_last_swash_slen = 0;
11383 PL_glob_index = proto_perl->Iglob_index;
11384 PL_srand_called = proto_perl->Isrand_called;
11385 PL_bitcount = NULL; /* reinits on demand */
11387 if (proto_perl->Ipsig_pend) {
11388 Newxz(PL_psig_pend, SIG_SIZE, int);
11391 PL_psig_pend = (int*)NULL;
11394 if (proto_perl->Ipsig_ptr) {
11395 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11396 Newxz(PL_psig_name, SIG_SIZE, SV*);
11397 for (i = 1; i < SIG_SIZE; i++) {
11398 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11399 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11403 PL_psig_ptr = (SV**)NULL;
11404 PL_psig_name = (SV**)NULL;
11407 /* intrpvar.h stuff */
11409 if (flags & CLONEf_COPY_STACKS) {
11410 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11411 PL_tmps_ix = proto_perl->Itmps_ix;
11412 PL_tmps_max = proto_perl->Itmps_max;
11413 PL_tmps_floor = proto_perl->Itmps_floor;
11414 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11416 while (i <= PL_tmps_ix) {
11417 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11421 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11422 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11423 Newxz(PL_markstack, i, I32);
11424 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11425 - proto_perl->Imarkstack);
11426 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11427 - proto_perl->Imarkstack);
11428 Copy(proto_perl->Imarkstack, PL_markstack,
11429 PL_markstack_ptr - PL_markstack + 1, I32);
11431 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11432 * NOTE: unlike the others! */
11433 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11434 PL_scopestack_max = proto_perl->Iscopestack_max;
11435 Newxz(PL_scopestack, PL_scopestack_max, I32);
11436 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11438 /* NOTE: si_dup() looks at PL_markstack */
11439 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11441 /* PL_curstack = PL_curstackinfo->si_stack; */
11442 PL_curstack = av_dup(proto_perl->Icurstack, param);
11443 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11445 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11446 PL_stack_base = AvARRAY(PL_curstack);
11447 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11448 - proto_perl->Istack_base);
11449 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11451 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11452 * NOTE: unlike the others! */
11453 PL_savestack_ix = proto_perl->Isavestack_ix;
11454 PL_savestack_max = proto_perl->Isavestack_max;
11455 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11456 PL_savestack = ss_dup(proto_perl, param);
11460 ENTER; /* perl_destruct() wants to LEAVE; */
11462 /* although we're not duplicating the tmps stack, we should still
11463 * add entries for any SVs on the tmps stack that got cloned by a
11464 * non-refcount means (eg a temp in @_); otherwise they will be
11467 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11468 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11469 proto_perl->Itmps_stack[i]);
11470 if (nsv && !SvREFCNT(nsv)) {
11472 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11477 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11478 PL_top_env = &PL_start_env;
11480 PL_op = proto_perl->Iop;
11483 PL_Xpv = (XPV*)NULL;
11484 PL_na = proto_perl->Ina;
11486 PL_statbuf = proto_perl->Istatbuf;
11487 PL_statcache = proto_perl->Istatcache;
11488 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11489 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11491 PL_timesbuf = proto_perl->Itimesbuf;
11494 PL_tainted = proto_perl->Itainted;
11495 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11496 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11497 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11498 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11499 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11500 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11501 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11502 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11503 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11505 PL_restartop = proto_perl->Irestartop;
11506 PL_in_eval = proto_perl->Iin_eval;
11507 PL_delaymagic = proto_perl->Idelaymagic;
11508 PL_dirty = proto_perl->Idirty;
11509 PL_localizing = proto_perl->Ilocalizing;
11511 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11512 PL_hv_fetch_ent_mh = NULL;
11513 PL_modcount = proto_perl->Imodcount;
11514 PL_lastgotoprobe = NULL;
11515 PL_dumpindent = proto_perl->Idumpindent;
11517 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11518 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11519 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11520 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11521 PL_efloatbuf = NULL; /* reinits on demand */
11522 PL_efloatsize = 0; /* reinits on demand */
11526 PL_screamfirst = NULL;
11527 PL_screamnext = NULL;
11528 PL_maxscream = -1; /* reinits on demand */
11529 PL_lastscream = NULL;
11532 PL_regdummy = proto_perl->Iregdummy;
11533 PL_colorset = 0; /* reinits PL_colors[] */
11534 /*PL_colors[6] = {0,0,0,0,0,0};*/
11538 /* Pluggable optimizer */
11539 PL_peepp = proto_perl->Ipeepp;
11541 PL_stashcache = newHV();
11543 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11544 proto_perl->Iwatchaddr);
11545 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11546 if (PL_debug && PL_watchaddr) {
11547 PerlIO_printf(Perl_debug_log,
11548 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11549 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11550 PTR2UV(PL_watchok));
11553 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11554 ptr_table_free(PL_ptr_table);
11555 PL_ptr_table = NULL;
11558 /* Call the ->CLONE method, if it exists, for each of the stashes
11559 identified by sv_dup() above.
11561 while(av_len(param->stashes) != -1) {
11562 HV* const stash = (HV*) av_shift(param->stashes);
11563 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11564 if (cloner && GvCV(cloner)) {
11569 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11571 call_sv((SV*)GvCV(cloner), G_DISCARD);
11577 SvREFCNT_dec(param->stashes);
11579 /* orphaned? eg threads->new inside BEGIN or use */
11580 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11581 SvREFCNT_inc_simple_void(PL_compcv);
11582 SAVEFREESV(PL_compcv);
11588 #endif /* USE_ITHREADS */
11591 =head1 Unicode Support
11593 =for apidoc sv_recode_to_utf8
11595 The encoding is assumed to be an Encode object, on entry the PV
11596 of the sv is assumed to be octets in that encoding, and the sv
11597 will be converted into Unicode (and UTF-8).
11599 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11600 is not a reference, nothing is done to the sv. If the encoding is not
11601 an C<Encode::XS> Encoding object, bad things will happen.
11602 (See F<lib/encoding.pm> and L<Encode>).
11604 The PV of the sv is returned.
11609 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11612 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11626 Passing sv_yes is wrong - it needs to be or'ed set of constants
11627 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11628 remove converted chars from source.
11630 Both will default the value - let them.
11632 XPUSHs(&PL_sv_yes);
11635 call_method("decode", G_SCALAR);
11639 s = SvPV_const(uni, len);
11640 if (s != SvPVX_const(sv)) {
11641 SvGROW(sv, len + 1);
11642 Move(s, SvPVX(sv), len + 1, char);
11643 SvCUR_set(sv, len);
11650 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11654 =for apidoc sv_cat_decode
11656 The encoding is assumed to be an Encode object, the PV of the ssv is
11657 assumed to be octets in that encoding and decoding the input starts
11658 from the position which (PV + *offset) pointed to. The dsv will be
11659 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11660 when the string tstr appears in decoding output or the input ends on
11661 the PV of the ssv. The value which the offset points will be modified
11662 to the last input position on the ssv.
11664 Returns TRUE if the terminator was found, else returns FALSE.
11669 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11670 SV *ssv, int *offset, char *tstr, int tlen)
11674 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11685 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11686 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11688 call_method("cat_decode", G_SCALAR);
11690 ret = SvTRUE(TOPs);
11691 *offset = SvIV(offsv);
11697 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11702 /* ---------------------------------------------------------------------
11704 * support functions for report_uninit()
11707 /* the maxiumum size of array or hash where we will scan looking
11708 * for the undefined element that triggered the warning */
11710 #define FUV_MAX_SEARCH_SIZE 1000
11712 /* Look for an entry in the hash whose value has the same SV as val;
11713 * If so, return a mortal copy of the key. */
11716 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11719 register HE **array;
11722 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11723 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11726 array = HvARRAY(hv);
11728 for (i=HvMAX(hv); i>0; i--) {
11729 register HE *entry;
11730 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11731 if (HeVAL(entry) != val)
11733 if ( HeVAL(entry) == &PL_sv_undef ||
11734 HeVAL(entry) == &PL_sv_placeholder)
11738 if (HeKLEN(entry) == HEf_SVKEY)
11739 return sv_mortalcopy(HeKEY_sv(entry));
11740 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11746 /* Look for an entry in the array whose value has the same SV as val;
11747 * If so, return the index, otherwise return -1. */
11750 S_find_array_subscript(pTHX_ AV *av, SV* val)
11753 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11754 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11757 if (val != &PL_sv_undef) {
11758 SV ** const svp = AvARRAY(av);
11761 for (i=AvFILLp(av); i>=0; i--)
11768 /* S_varname(): return the name of a variable, optionally with a subscript.
11769 * If gv is non-zero, use the name of that global, along with gvtype (one
11770 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11771 * targ. Depending on the value of the subscript_type flag, return:
11774 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11775 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11776 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11777 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11780 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11781 SV* keyname, I32 aindex, int subscript_type)
11784 SV * const name = sv_newmortal();
11787 buffer[0] = gvtype;
11790 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11792 gv_fullname4(name, gv, buffer, 0);
11794 if ((unsigned int)SvPVX(name)[1] <= 26) {
11796 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11798 /* Swap the 1 unprintable control character for the 2 byte pretty
11799 version - ie substr($name, 1, 1) = $buffer; */
11800 sv_insert(name, 1, 1, buffer, 2);
11804 CV * const cv = find_runcv(NULL);
11808 if (!cv || !CvPADLIST(cv))
11810 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11811 sv = *av_fetch(av, targ, FALSE);
11812 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11815 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11816 SV * const sv = newSV(0);
11817 *SvPVX(name) = '$';
11818 Perl_sv_catpvf(aTHX_ name, "{%s}",
11819 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11822 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11823 *SvPVX(name) = '$';
11824 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11826 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11827 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11834 =for apidoc find_uninit_var
11836 Find the name of the undefined variable (if any) that caused the operator o
11837 to issue a "Use of uninitialized value" warning.
11838 If match is true, only return a name if it's value matches uninit_sv.
11839 So roughly speaking, if a unary operator (such as OP_COS) generates a
11840 warning, then following the direct child of the op may yield an
11841 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11842 other hand, with OP_ADD there are two branches to follow, so we only print
11843 the variable name if we get an exact match.
11845 The name is returned as a mortal SV.
11847 Assumes that PL_op is the op that originally triggered the error, and that
11848 PL_comppad/PL_curpad points to the currently executing pad.
11854 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11862 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11863 uninit_sv == &PL_sv_placeholder)))
11866 switch (obase->op_type) {
11873 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11874 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11877 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11879 if (pad) { /* @lex, %lex */
11880 sv = PAD_SVl(obase->op_targ);
11884 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11885 /* @global, %global */
11886 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11889 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11891 else /* @{expr}, %{expr} */
11892 return find_uninit_var(cUNOPx(obase)->op_first,
11896 /* attempt to find a match within the aggregate */
11898 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11900 subscript_type = FUV_SUBSCRIPT_HASH;
11903 index = find_array_subscript((AV*)sv, uninit_sv);
11905 subscript_type = FUV_SUBSCRIPT_ARRAY;
11908 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11911 return varname(gv, hash ? '%' : '@', obase->op_targ,
11912 keysv, index, subscript_type);
11916 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11918 return varname(NULL, '$', obase->op_targ,
11919 NULL, 0, FUV_SUBSCRIPT_NONE);
11922 gv = cGVOPx_gv(obase);
11923 if (!gv || (match && GvSV(gv) != uninit_sv))
11925 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11928 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11931 av = (AV*)PAD_SV(obase->op_targ);
11932 if (!av || SvRMAGICAL(av))
11934 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11935 if (!svp || *svp != uninit_sv)
11938 return varname(NULL, '$', obase->op_targ,
11939 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11942 gv = cGVOPx_gv(obase);
11948 if (!av || SvRMAGICAL(av))
11950 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11951 if (!svp || *svp != uninit_sv)
11954 return varname(gv, '$', 0,
11955 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11960 o = cUNOPx(obase)->op_first;
11961 if (!o || o->op_type != OP_NULL ||
11962 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11964 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11968 if (PL_op == obase)
11969 /* $a[uninit_expr] or $h{uninit_expr} */
11970 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11973 o = cBINOPx(obase)->op_first;
11974 kid = cBINOPx(obase)->op_last;
11976 /* get the av or hv, and optionally the gv */
11978 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11979 sv = PAD_SV(o->op_targ);
11981 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11982 && cUNOPo->op_first->op_type == OP_GV)
11984 gv = cGVOPx_gv(cUNOPo->op_first);
11987 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11992 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11993 /* index is constant */
11997 if (obase->op_type == OP_HELEM) {
11998 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11999 if (!he || HeVAL(he) != uninit_sv)
12003 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12004 if (!svp || *svp != uninit_sv)
12008 if (obase->op_type == OP_HELEM)
12009 return varname(gv, '%', o->op_targ,
12010 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12012 return varname(gv, '@', o->op_targ, NULL,
12013 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12016 /* index is an expression;
12017 * attempt to find a match within the aggregate */
12018 if (obase->op_type == OP_HELEM) {
12019 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12021 return varname(gv, '%', o->op_targ,
12022 keysv, 0, FUV_SUBSCRIPT_HASH);
12025 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12027 return varname(gv, '@', o->op_targ,
12028 NULL, index, FUV_SUBSCRIPT_ARRAY);
12033 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12035 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12040 /* only examine RHS */
12041 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12044 o = cUNOPx(obase)->op_first;
12045 if (o->op_type == OP_PUSHMARK)
12048 if (!o->op_sibling) {
12049 /* one-arg version of open is highly magical */
12051 if (o->op_type == OP_GV) { /* open FOO; */
12053 if (match && GvSV(gv) != uninit_sv)
12055 return varname(gv, '$', 0,
12056 NULL, 0, FUV_SUBSCRIPT_NONE);
12058 /* other possibilities not handled are:
12059 * open $x; or open my $x; should return '${*$x}'
12060 * open expr; should return '$'.expr ideally
12066 /* ops where $_ may be an implicit arg */
12070 if ( !(obase->op_flags & OPf_STACKED)) {
12071 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12072 ? PAD_SVl(obase->op_targ)
12075 sv = sv_newmortal();
12076 sv_setpvn(sv, "$_", 2);
12085 /* skip filehandle as it can't produce 'undef' warning */
12086 o = cUNOPx(obase)->op_first;
12087 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12088 o = o->op_sibling->op_sibling;
12094 match = 1; /* XS or custom code could trigger random warnings */
12099 /* XXX tmp hack: these two may call an XS sub, and currently
12100 XS subs don't have a SUB entry on the context stack, so CV and
12101 pad determination goes wrong, and BAD things happen. So, just
12102 don't try to determine the value under those circumstances.
12103 Need a better fix at dome point. DAPM 11/2007 */
12107 /* def-ness of rval pos() is independent of the def-ness of its arg */
12108 if ( !(obase->op_flags & OPf_MOD))
12113 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12114 return sv_2mortal(newSVpvs("${$/}"));
12119 if (!(obase->op_flags & OPf_KIDS))
12121 o = cUNOPx(obase)->op_first;
12127 /* if all except one arg are constant, or have no side-effects,
12128 * or are optimized away, then it's unambiguous */
12130 for (kid=o; kid; kid = kid->op_sibling) {
12132 const OPCODE type = kid->op_type;
12133 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12134 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12135 || (type == OP_PUSHMARK)
12139 if (o2) { /* more than one found */
12146 return find_uninit_var(o2, uninit_sv, match);
12148 /* scan all args */
12150 sv = find_uninit_var(o, uninit_sv, 1);
12162 =for apidoc report_uninit
12164 Print appropriate "Use of uninitialized variable" warning
12170 Perl_report_uninit(pTHX_ SV* uninit_sv)
12174 SV* varname = NULL;
12176 varname = find_uninit_var(PL_op, uninit_sv,0);
12178 sv_insert(varname, 0, 0, " ", 1);
12180 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12181 varname ? SvPV_nolen_const(varname) : "",
12182 " in ", OP_DESC(PL_op));
12185 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12191 * c-indentation-style: bsd
12192 * c-basic-offset: 4
12193 * indent-tabs-mode: t
12196 * ex: set ts=8 sts=4 sw=4 noet: