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)
2518 SV * const tmpsv = AMG_CALLun(sv,numer);
2519 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2520 return sv_2num(tmpsv);
2522 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2525 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2526 * UV as a string towards the end of buf, and return pointers to start and
2529 * We assume that buf is at least TYPE_CHARS(UV) long.
2533 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2535 char *ptr = buf + TYPE_CHARS(UV);
2536 char * const ebuf = ptr;
2549 *--ptr = '0' + (char)(uv % 10);
2558 =for apidoc sv_2pv_flags
2560 Returns a pointer to the string value of an SV, and sets *lp to its length.
2561 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2563 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2564 usually end up here too.
2570 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2580 if (SvGMAGICAL(sv)) {
2581 if (flags & SV_GMAGIC)
2586 if (flags & SV_MUTABLE_RETURN)
2587 return SvPVX_mutable(sv);
2588 if (flags & SV_CONST_RETURN)
2589 return (char *)SvPVX_const(sv);
2592 if (SvIOKp(sv) || SvNOKp(sv)) {
2593 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2598 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2599 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2601 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2608 #ifdef FIXNEGATIVEZERO
2609 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2615 SvUPGRADE(sv, SVt_PV);
2618 s = SvGROW_mutable(sv, len + 1);
2621 return (char*)memcpy(s, tbuf, len + 1);
2627 assert(SvTYPE(sv) >= SVt_PVMG);
2628 /* This falls through to the report_uninit near the end of the
2630 } else if (SvTHINKFIRST(sv)) {
2634 SV *const tmpstr = AMG_CALLun(sv,string);
2635 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2637 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2641 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2642 if (flags & SV_CONST_RETURN) {
2643 pv = (char *) SvPVX_const(tmpstr);
2645 pv = (flags & SV_MUTABLE_RETURN)
2646 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2649 *lp = SvCUR(tmpstr);
2651 pv = sv_2pv_flags(tmpstr, lp, flags);
2665 const SV *const referent = (SV*)SvRV(sv);
2669 retval = buffer = savepvn("NULLREF", len);
2670 } else if (SvTYPE(referent) == SVt_PVMG
2671 && ((SvFLAGS(referent) &
2672 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2673 == (SVs_OBJECT|SVs_SMG))
2674 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2679 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2684 PL_reginterp_cnt += haseval;
2687 const char *const typestr = sv_reftype(referent, 0);
2688 const STRLEN typelen = strlen(typestr);
2689 UV addr = PTR2UV(referent);
2690 const char *stashname = NULL;
2691 STRLEN stashnamelen = 0; /* hush, gcc */
2692 const char *buffer_end;
2694 if (SvOBJECT(referent)) {
2695 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2698 stashname = HEK_KEY(name);
2699 stashnamelen = HEK_LEN(name);
2701 if (HEK_UTF8(name)) {
2707 stashname = "__ANON__";
2710 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2711 + 2 * sizeof(UV) + 2 /* )\0 */;
2713 len = typelen + 3 /* (0x */
2714 + 2 * sizeof(UV) + 2 /* )\0 */;
2717 Newx(buffer, len, char);
2718 buffer_end = retval = buffer + len;
2720 /* Working backwards */
2724 *--retval = PL_hexdigit[addr & 15];
2725 } while (addr >>= 4);
2731 memcpy(retval, typestr, typelen);
2735 retval -= stashnamelen;
2736 memcpy(retval, stashname, stashnamelen);
2738 /* retval may not neccesarily have reached the start of the
2740 assert (retval >= buffer);
2742 len = buffer_end - retval - 1; /* -1 for that \0 */
2750 if (SvREADONLY(sv) && !SvOK(sv)) {
2751 if (ckWARN(WARN_UNINITIALIZED))
2758 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2759 /* I'm assuming that if both IV and NV are equally valid then
2760 converting the IV is going to be more efficient */
2761 const U32 isUIOK = SvIsUV(sv);
2762 char buf[TYPE_CHARS(UV)];
2766 if (SvTYPE(sv) < SVt_PVIV)
2767 sv_upgrade(sv, SVt_PVIV);
2768 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2770 /* inlined from sv_setpvn */
2771 s = SvGROW_mutable(sv, len + 1);
2772 Move(ptr, s, len, char);
2776 else if (SvNOKp(sv)) {
2777 const int olderrno = errno;
2778 if (SvTYPE(sv) < SVt_PVNV)
2779 sv_upgrade(sv, SVt_PVNV);
2780 /* The +20 is pure guesswork. Configure test needed. --jhi */
2781 s = SvGROW_mutable(sv, NV_DIG + 20);
2782 /* some Xenix systems wipe out errno here */
2784 if (SvNVX(sv) == 0.0)
2785 my_strlcpy(s, "0", SvLEN(sv));
2789 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2792 #ifdef FIXNEGATIVEZERO
2793 if (*s == '-' && s[1] == '0' && !s[2]) {
2805 if (isGV_with_GP(sv))
2806 return glob_2pv((GV *)sv, lp);
2808 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2812 if (SvTYPE(sv) < SVt_PV)
2813 /* Typically the caller expects that sv_any is not NULL now. */
2814 sv_upgrade(sv, SVt_PV);
2818 const STRLEN len = s - SvPVX_const(sv);
2824 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2825 PTR2UV(sv),SvPVX_const(sv)));
2826 if (flags & SV_CONST_RETURN)
2827 return (char *)SvPVX_const(sv);
2828 if (flags & SV_MUTABLE_RETURN)
2829 return SvPVX_mutable(sv);
2834 =for apidoc sv_copypv
2836 Copies a stringified representation of the source SV into the
2837 destination SV. Automatically performs any necessary mg_get and
2838 coercion of numeric values into strings. Guaranteed to preserve
2839 UTF8 flag even from overloaded objects. Similar in nature to
2840 sv_2pv[_flags] but operates directly on an SV instead of just the
2841 string. Mostly uses sv_2pv_flags to do its work, except when that
2842 would lose the UTF-8'ness of the PV.
2848 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2851 const char * const s = SvPV_const(ssv,len);
2852 sv_setpvn(dsv,s,len);
2860 =for apidoc sv_2pvbyte
2862 Return a pointer to the byte-encoded representation of the SV, and set *lp
2863 to its length. May cause the SV to be downgraded from UTF-8 as a
2866 Usually accessed via the C<SvPVbyte> macro.
2872 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2874 sv_utf8_downgrade(sv,0);
2875 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2879 =for apidoc sv_2pvutf8
2881 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2882 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2884 Usually accessed via the C<SvPVutf8> macro.
2890 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2892 sv_utf8_upgrade(sv);
2893 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2898 =for apidoc sv_2bool
2900 This function is only called on magical items, and is only used by
2901 sv_true() or its macro equivalent.
2907 Perl_sv_2bool(pTHX_ register SV *sv)
2916 SV * const tmpsv = AMG_CALLun(sv,bool_);
2917 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2918 return (bool)SvTRUE(tmpsv);
2920 return SvRV(sv) != 0;
2923 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2925 (*sv->sv_u.svu_pv > '0' ||
2926 Xpvtmp->xpv_cur > 1 ||
2927 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2934 return SvIVX(sv) != 0;
2937 return SvNVX(sv) != 0.0;
2939 if (isGV_with_GP(sv))
2949 =for apidoc sv_utf8_upgrade
2951 Converts the PV of an SV to its UTF-8-encoded form.
2952 Forces the SV to string form if it is not already.
2953 Always sets the SvUTF8 flag to avoid future validity checks even
2954 if all the bytes have hibit clear.
2956 This is not as a general purpose byte encoding to Unicode interface:
2957 use the Encode extension for that.
2959 =for apidoc sv_utf8_upgrade_flags
2961 Converts the PV of an SV to its UTF-8-encoded form.
2962 Forces the SV to string form if it is not already.
2963 Always sets the SvUTF8 flag to avoid future validity checks even
2964 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2965 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2966 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2968 This is not as a general purpose byte encoding to Unicode interface:
2969 use the Encode extension for that.
2975 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2978 if (sv == &PL_sv_undef)
2982 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2983 (void) sv_2pv_flags(sv,&len, flags);
2987 (void) SvPV_force(sv,len);
2996 sv_force_normal_flags(sv, 0);
2999 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3000 sv_recode_to_utf8(sv, PL_encoding);
3001 else { /* Assume Latin-1/EBCDIC */
3002 /* This function could be much more efficient if we
3003 * had a FLAG in SVs to signal if there are any hibit
3004 * chars in the PV. Given that there isn't such a flag
3005 * make the loop as fast as possible. */
3006 const U8 * const s = (U8 *) SvPVX_const(sv);
3007 const U8 * const e = (U8 *) SvEND(sv);
3012 /* Check for hi bit */
3013 if (!NATIVE_IS_INVARIANT(ch)) {
3014 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3015 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3017 SvPV_free(sv); /* No longer using what was there before. */
3018 SvPV_set(sv, (char*)recoded);
3019 SvCUR_set(sv, len - 1);
3020 SvLEN_set(sv, len); /* No longer know the real size. */
3024 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3031 =for apidoc sv_utf8_downgrade
3033 Attempts to convert the PV of an SV from characters to bytes.
3034 If the PV contains a character beyond byte, this conversion will fail;
3035 in this case, either returns false or, if C<fail_ok> is not
3038 This is not as a general purpose Unicode to byte encoding interface:
3039 use the Encode extension for that.
3045 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3048 if (SvPOKp(sv) && SvUTF8(sv)) {
3054 sv_force_normal_flags(sv, 0);
3056 s = (U8 *) SvPV(sv, len);
3057 if (!utf8_to_bytes(s, &len)) {
3062 Perl_croak(aTHX_ "Wide character in %s",
3065 Perl_croak(aTHX_ "Wide character");
3076 =for apidoc sv_utf8_encode
3078 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3079 flag off so that it looks like octets again.
3085 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3088 sv_force_normal_flags(sv, 0);
3090 if (SvREADONLY(sv)) {
3091 Perl_croak(aTHX_ PL_no_modify);
3093 (void) sv_utf8_upgrade(sv);
3098 =for apidoc sv_utf8_decode
3100 If the PV of the SV is an octet sequence in UTF-8
3101 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3102 so that it looks like a character. If the PV contains only single-byte
3103 characters, the C<SvUTF8> flag stays being off.
3104 Scans PV for validity and returns false if the PV is invalid UTF-8.
3110 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3116 /* The octets may have got themselves encoded - get them back as
3119 if (!sv_utf8_downgrade(sv, TRUE))
3122 /* it is actually just a matter of turning the utf8 flag on, but
3123 * we want to make sure everything inside is valid utf8 first.
3125 c = (const U8 *) SvPVX_const(sv);
3126 if (!is_utf8_string(c, SvCUR(sv)+1))
3128 e = (const U8 *) SvEND(sv);
3131 if (!UTF8_IS_INVARIANT(ch)) {
3141 =for apidoc sv_setsv
3143 Copies the contents of the source SV C<ssv> into the destination SV
3144 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3145 function if the source SV needs to be reused. Does not handle 'set' magic.
3146 Loosely speaking, it performs a copy-by-value, obliterating any previous
3147 content of the destination.
3149 You probably want to use one of the assortment of wrappers, such as
3150 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3151 C<SvSetMagicSV_nosteal>.
3153 =for apidoc sv_setsv_flags
3155 Copies the contents of the source SV C<ssv> into the destination SV
3156 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3157 function if the source SV needs to be reused. Does not handle 'set' magic.
3158 Loosely speaking, it performs a copy-by-value, obliterating any previous
3159 content of the destination.
3160 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3161 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3162 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3163 and C<sv_setsv_nomg> are implemented in terms of this function.
3165 You probably want to use one of the assortment of wrappers, such as
3166 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3167 C<SvSetMagicSV_nosteal>.
3169 This is the primary function for copying scalars, and most other
3170 copy-ish functions and macros use this underneath.
3176 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3178 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3180 if (dtype != SVt_PVGV) {
3181 const char * const name = GvNAME(sstr);
3182 const STRLEN len = GvNAMELEN(sstr);
3184 if (dtype >= SVt_PV) {
3190 SvUPGRADE(dstr, SVt_PVGV);
3191 (void)SvOK_off(dstr);
3192 /* FIXME - why are we doing this, then turning it off and on again
3194 isGV_with_GP_on(dstr);
3196 GvSTASH(dstr) = GvSTASH(sstr);
3198 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3199 gv_name_set((GV *)dstr, name, len, GV_ADD);
3200 SvFAKE_on(dstr); /* can coerce to non-glob */
3203 #ifdef GV_UNIQUE_CHECK
3204 if (GvUNIQUE((GV*)dstr)) {
3205 Perl_croak(aTHX_ PL_no_modify);
3209 if(GvGP((GV*)sstr)) {
3210 /* If source has method cache entry, clear it */
3212 SvREFCNT_dec(GvCV(sstr));
3216 /* If source has a real method, then a method is
3218 else if(GvCV((GV*)sstr)) {
3223 /* If dest already had a real method, that's a change as well */
3224 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3228 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3232 isGV_with_GP_off(dstr);
3233 (void)SvOK_off(dstr);
3234 isGV_with_GP_on(dstr);
3235 GvINTRO_off(dstr); /* one-shot flag */
3236 GvGP(dstr) = gp_ref(GvGP(sstr));
3237 if (SvTAINTED(sstr))
3239 if (GvIMPORTED(dstr) != GVf_IMPORTED
3240 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3242 GvIMPORTED_on(dstr);
3245 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3246 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3251 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3252 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3254 const int intro = GvINTRO(dstr);
3257 const U32 stype = SvTYPE(sref);
3260 #ifdef GV_UNIQUE_CHECK
3261 if (GvUNIQUE((GV*)dstr)) {
3262 Perl_croak(aTHX_ PL_no_modify);
3267 GvINTRO_off(dstr); /* one-shot flag */
3268 GvLINE(dstr) = CopLINE(PL_curcop);
3269 GvEGV(dstr) = (GV*)dstr;
3274 location = (SV **) &GvCV(dstr);
3275 import_flag = GVf_IMPORTED_CV;
3278 location = (SV **) &GvHV(dstr);
3279 import_flag = GVf_IMPORTED_HV;
3282 location = (SV **) &GvAV(dstr);
3283 import_flag = GVf_IMPORTED_AV;
3286 location = (SV **) &GvIOp(dstr);
3289 location = (SV **) &GvFORM(dstr);
3291 location = &GvSV(dstr);
3292 import_flag = GVf_IMPORTED_SV;
3295 if (stype == SVt_PVCV) {
3296 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3297 if (GvCVGEN(dstr)) {
3298 SvREFCNT_dec(GvCV(dstr));
3300 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3303 SAVEGENERICSV(*location);
3307 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3308 CV* const cv = (CV*)*location;
3310 if (!GvCVGEN((GV*)dstr) &&
3311 (CvROOT(cv) || CvXSUB(cv)))
3313 /* Redefining a sub - warning is mandatory if
3314 it was a const and its value changed. */
3315 if (CvCONST(cv) && CvCONST((CV*)sref)
3316 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3318 /* They are 2 constant subroutines generated from
3319 the same constant. This probably means that
3320 they are really the "same" proxy subroutine
3321 instantiated in 2 places. Most likely this is
3322 when a constant is exported twice. Don't warn.
3325 else if (ckWARN(WARN_REDEFINE)
3327 && (!CvCONST((CV*)sref)
3328 || sv_cmp(cv_const_sv(cv),
3329 cv_const_sv((CV*)sref))))) {
3330 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3333 ? "Constant subroutine %s::%s redefined"
3334 : "Subroutine %s::%s redefined"),
3335 HvNAME_get(GvSTASH((GV*)dstr)),
3336 GvENAME((GV*)dstr));
3340 cv_ckproto_len(cv, (GV*)dstr,
3341 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3342 SvPOK(sref) ? SvCUR(sref) : 0);
3344 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3345 GvASSUMECV_on(dstr);
3346 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3349 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3350 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3351 GvFLAGS(dstr) |= import_flag;
3356 if (SvTAINTED(sstr))
3362 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3365 register U32 sflags;
3367 register svtype stype;
3372 if (SvIS_FREED(dstr)) {
3373 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3374 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3376 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3378 sstr = &PL_sv_undef;
3379 if (SvIS_FREED(sstr)) {
3380 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3381 (void*)sstr, (void*)dstr);
3383 stype = SvTYPE(sstr);
3384 dtype = SvTYPE(dstr);
3386 (void)SvAMAGIC_off(dstr);
3389 /* need to nuke the magic */
3391 SvRMAGICAL_off(dstr);
3394 /* There's a lot of redundancy below but we're going for speed here */
3399 if (dtype != SVt_PVGV) {
3400 (void)SvOK_off(dstr);
3408 sv_upgrade(dstr, SVt_IV);
3413 sv_upgrade(dstr, SVt_PVIV);
3416 goto end_of_first_switch;
3418 (void)SvIOK_only(dstr);
3419 SvIV_set(dstr, SvIVX(sstr));
3422 /* SvTAINTED can only be true if the SV has taint magic, which in
3423 turn means that the SV type is PVMG (or greater). This is the
3424 case statement for SVt_IV, so this cannot be true (whatever gcov
3426 assert(!SvTAINTED(sstr));
3436 sv_upgrade(dstr, SVt_NV);
3441 sv_upgrade(dstr, SVt_PVNV);
3444 goto end_of_first_switch;
3446 SvNV_set(dstr, SvNVX(sstr));
3447 (void)SvNOK_only(dstr);
3448 /* SvTAINTED can only be true if the SV has taint magic, which in
3449 turn means that the SV type is PVMG (or greater). This is the
3450 case statement for SVt_NV, so this cannot be true (whatever gcov
3452 assert(!SvTAINTED(sstr));
3459 sv_upgrade(dstr, SVt_RV);
3462 #ifdef PERL_OLD_COPY_ON_WRITE
3463 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3464 if (dtype < SVt_PVIV)
3465 sv_upgrade(dstr, SVt_PVIV);
3472 sv_upgrade(dstr, SVt_PV);
3475 if (dtype < SVt_PVIV)
3476 sv_upgrade(dstr, SVt_PVIV);
3479 if (dtype < SVt_PVNV)
3480 sv_upgrade(dstr, SVt_PVNV);
3484 const char * const type = sv_reftype(sstr,0);
3486 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3488 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3492 /* case SVt_BIND: */
3495 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3496 glob_assign_glob(dstr, sstr, dtype);
3499 /* SvVALID means that this PVGV is playing at being an FBM. */
3503 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3505 if (SvTYPE(sstr) != stype) {
3506 stype = SvTYPE(sstr);
3507 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3508 glob_assign_glob(dstr, sstr, dtype);
3513 if (stype == SVt_PVLV)
3514 SvUPGRADE(dstr, SVt_PVNV);
3516 SvUPGRADE(dstr, (svtype)stype);
3518 end_of_first_switch:
3520 /* dstr may have been upgraded. */
3521 dtype = SvTYPE(dstr);
3522 sflags = SvFLAGS(sstr);
3524 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3525 /* Assigning to a subroutine sets the prototype. */
3528 const char *const ptr = SvPV_const(sstr, len);
3530 SvGROW(dstr, len + 1);
3531 Copy(ptr, SvPVX(dstr), len + 1, char);
3532 SvCUR_set(dstr, len);
3534 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3538 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3539 const char * const type = sv_reftype(dstr,0);
3541 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3543 Perl_croak(aTHX_ "Cannot copy to %s", type);
3544 } else if (sflags & SVf_ROK) {
3545 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3546 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3549 if (GvIMPORTED(dstr) != GVf_IMPORTED
3550 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3552 GvIMPORTED_on(dstr);
3557 glob_assign_glob(dstr, sstr, dtype);
3561 if (dtype >= SVt_PV) {
3562 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3563 glob_assign_ref(dstr, sstr);
3566 if (SvPVX_const(dstr)) {
3572 (void)SvOK_off(dstr);
3573 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3574 SvFLAGS(dstr) |= sflags & SVf_ROK;
3575 assert(!(sflags & SVp_NOK));
3576 assert(!(sflags & SVp_IOK));
3577 assert(!(sflags & SVf_NOK));
3578 assert(!(sflags & SVf_IOK));
3580 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3581 if (!(sflags & SVf_OK)) {
3582 if (ckWARN(WARN_MISC))
3583 Perl_warner(aTHX_ packWARN(WARN_MISC),
3584 "Undefined value assigned to typeglob");
3587 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3588 if (dstr != (SV*)gv) {
3591 GvGP(dstr) = gp_ref(GvGP(gv));
3595 else if (sflags & SVp_POK) {
3599 * Check to see if we can just swipe the string. If so, it's a
3600 * possible small lose on short strings, but a big win on long ones.
3601 * It might even be a win on short strings if SvPVX_const(dstr)
3602 * has to be allocated and SvPVX_const(sstr) has to be freed.
3603 * Likewise if we can set up COW rather than doing an actual copy, we
3604 * drop to the else clause, as the swipe code and the COW setup code
3605 * have much in common.
3608 /* Whichever path we take through the next code, we want this true,
3609 and doing it now facilitates the COW check. */
3610 (void)SvPOK_only(dstr);
3613 /* If we're already COW then this clause is not true, and if COW
3614 is allowed then we drop down to the else and make dest COW
3615 with us. If caller hasn't said that we're allowed to COW
3616 shared hash keys then we don't do the COW setup, even if the
3617 source scalar is a shared hash key scalar. */
3618 (((flags & SV_COW_SHARED_HASH_KEYS)
3619 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3620 : 1 /* If making a COW copy is forbidden then the behaviour we
3621 desire is as if the source SV isn't actually already
3622 COW, even if it is. So we act as if the source flags
3623 are not COW, rather than actually testing them. */
3625 #ifndef PERL_OLD_COPY_ON_WRITE
3626 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3627 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3628 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3629 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3630 but in turn, it's somewhat dead code, never expected to go
3631 live, but more kept as a placeholder on how to do it better
3632 in a newer implementation. */
3633 /* If we are COW and dstr is a suitable target then we drop down
3634 into the else and make dest a COW of us. */
3635 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3640 (sflags & SVs_TEMP) && /* slated for free anyway? */
3641 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3642 (!(flags & SV_NOSTEAL)) &&
3643 /* and we're allowed to steal temps */
3644 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3645 SvLEN(sstr) && /* and really is a string */
3646 /* and won't be needed again, potentially */
3647 !(PL_op && PL_op->op_type == OP_AASSIGN))
3648 #ifdef PERL_OLD_COPY_ON_WRITE
3649 && ((flags & SV_COW_SHARED_HASH_KEYS)
3650 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3651 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3652 && SvTYPE(sstr) >= SVt_PVIV))
3656 /* Failed the swipe test, and it's not a shared hash key either.
3657 Have to copy the string. */
3658 STRLEN len = SvCUR(sstr);
3659 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3660 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3661 SvCUR_set(dstr, len);
3662 *SvEND(dstr) = '\0';
3664 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3666 /* Either it's a shared hash key, or it's suitable for
3667 copy-on-write or we can swipe the string. */
3669 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3673 #ifdef PERL_OLD_COPY_ON_WRITE
3675 /* I believe I should acquire a global SV mutex if
3676 it's a COW sv (not a shared hash key) to stop
3677 it going un copy-on-write.
3678 If the source SV has gone un copy on write between up there
3679 and down here, then (assert() that) it is of the correct
3680 form to make it copy on write again */
3681 if ((sflags & (SVf_FAKE | SVf_READONLY))
3682 != (SVf_FAKE | SVf_READONLY)) {
3683 SvREADONLY_on(sstr);
3685 /* Make the source SV into a loop of 1.
3686 (about to become 2) */
3687 SV_COW_NEXT_SV_SET(sstr, sstr);
3691 /* Initial code is common. */
3692 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3697 /* making another shared SV. */
3698 STRLEN cur = SvCUR(sstr);
3699 STRLEN len = SvLEN(sstr);
3700 #ifdef PERL_OLD_COPY_ON_WRITE
3702 assert (SvTYPE(dstr) >= SVt_PVIV);
3703 /* SvIsCOW_normal */
3704 /* splice us in between source and next-after-source. */
3705 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3706 SV_COW_NEXT_SV_SET(sstr, dstr);
3707 SvPV_set(dstr, SvPVX_mutable(sstr));
3711 /* SvIsCOW_shared_hash */
3712 DEBUG_C(PerlIO_printf(Perl_debug_log,
3713 "Copy on write: Sharing hash\n"));
3715 assert (SvTYPE(dstr) >= SVt_PV);
3717 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3719 SvLEN_set(dstr, len);
3720 SvCUR_set(dstr, cur);
3721 SvREADONLY_on(dstr);
3723 /* Relesase a global SV mutex. */
3726 { /* Passes the swipe test. */
3727 SvPV_set(dstr, SvPVX_mutable(sstr));
3728 SvLEN_set(dstr, SvLEN(sstr));
3729 SvCUR_set(dstr, SvCUR(sstr));
3732 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3733 SvPV_set(sstr, NULL);
3739 if (sflags & SVp_NOK) {
3740 SvNV_set(dstr, SvNVX(sstr));
3742 if (sflags & SVp_IOK) {
3744 SvIV_set(dstr, SvIVX(sstr));
3745 /* Must do this otherwise some other overloaded use of 0x80000000
3746 gets confused. I guess SVpbm_VALID */
3747 if (sflags & SVf_IVisUV)
3750 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3752 const MAGIC * const smg = SvVSTRING_mg(sstr);
3754 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3755 smg->mg_ptr, smg->mg_len);
3756 SvRMAGICAL_on(dstr);
3760 else if (sflags & (SVp_IOK|SVp_NOK)) {
3761 (void)SvOK_off(dstr);
3762 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3763 if (sflags & SVp_IOK) {
3764 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3765 SvIV_set(dstr, SvIVX(sstr));
3767 if (sflags & SVp_NOK) {
3768 SvNV_set(dstr, SvNVX(sstr));
3772 if (isGV_with_GP(sstr)) {
3773 /* This stringification rule for globs is spread in 3 places.
3774 This feels bad. FIXME. */
3775 const U32 wasfake = sflags & SVf_FAKE;
3777 /* FAKE globs can get coerced, so need to turn this off
3778 temporarily if it is on. */
3780 gv_efullname3(dstr, (GV *)sstr, "*");
3781 SvFLAGS(sstr) |= wasfake;
3784 (void)SvOK_off(dstr);
3786 if (SvTAINTED(sstr))
3791 =for apidoc sv_setsv_mg
3793 Like C<sv_setsv>, but also handles 'set' magic.
3799 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3801 sv_setsv(dstr,sstr);
3805 #ifdef PERL_OLD_COPY_ON_WRITE
3807 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3809 STRLEN cur = SvCUR(sstr);
3810 STRLEN len = SvLEN(sstr);
3811 register char *new_pv;
3814 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3815 (void*)sstr, (void*)dstr);
3822 if (SvTHINKFIRST(dstr))
3823 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3824 else if (SvPVX_const(dstr))
3825 Safefree(SvPVX_const(dstr));
3829 SvUPGRADE(dstr, SVt_PVIV);
3831 assert (SvPOK(sstr));
3832 assert (SvPOKp(sstr));
3833 assert (!SvIOK(sstr));
3834 assert (!SvIOKp(sstr));
3835 assert (!SvNOK(sstr));
3836 assert (!SvNOKp(sstr));
3838 if (SvIsCOW(sstr)) {
3840 if (SvLEN(sstr) == 0) {
3841 /* source is a COW shared hash key. */
3842 DEBUG_C(PerlIO_printf(Perl_debug_log,
3843 "Fast copy on write: Sharing hash\n"));
3844 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3847 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3849 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3850 SvUPGRADE(sstr, SVt_PVIV);
3851 SvREADONLY_on(sstr);
3853 DEBUG_C(PerlIO_printf(Perl_debug_log,
3854 "Fast copy on write: Converting sstr to COW\n"));
3855 SV_COW_NEXT_SV_SET(dstr, sstr);
3857 SV_COW_NEXT_SV_SET(sstr, dstr);
3858 new_pv = SvPVX_mutable(sstr);
3861 SvPV_set(dstr, new_pv);
3862 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3865 SvLEN_set(dstr, len);
3866 SvCUR_set(dstr, cur);
3875 =for apidoc sv_setpvn
3877 Copies a string into an SV. The C<len> parameter indicates the number of
3878 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3879 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3885 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3888 register char *dptr;
3890 SV_CHECK_THINKFIRST_COW_DROP(sv);
3896 /* len is STRLEN which is unsigned, need to copy to signed */
3899 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3901 SvUPGRADE(sv, SVt_PV);
3903 dptr = SvGROW(sv, len + 1);
3904 Move(ptr,dptr,len,char);
3907 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3912 =for apidoc sv_setpvn_mg
3914 Like C<sv_setpvn>, but also handles 'set' magic.
3920 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3922 sv_setpvn(sv,ptr,len);
3927 =for apidoc sv_setpv
3929 Copies a string into an SV. The string must be null-terminated. Does not
3930 handle 'set' magic. See C<sv_setpv_mg>.
3936 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3939 register STRLEN len;
3941 SV_CHECK_THINKFIRST_COW_DROP(sv);
3947 SvUPGRADE(sv, SVt_PV);
3949 SvGROW(sv, len + 1);
3950 Move(ptr,SvPVX(sv),len+1,char);
3952 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3957 =for apidoc sv_setpv_mg
3959 Like C<sv_setpv>, but also handles 'set' magic.
3965 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3972 =for apidoc sv_usepvn_flags
3974 Tells an SV to use C<ptr> to find its string value. Normally the
3975 string is stored inside the SV but sv_usepvn allows the SV to use an
3976 outside string. The C<ptr> should point to memory that was allocated
3977 by C<malloc>. The string length, C<len>, must be supplied. By default
3978 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3979 so that pointer should not be freed or used by the programmer after
3980 giving it to sv_usepvn, and neither should any pointers from "behind"
3981 that pointer (e.g. ptr + 1) be used.
3983 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3984 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3985 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3986 C<len>, and already meets the requirements for storing in C<SvPVX>)
3992 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3996 SV_CHECK_THINKFIRST_COW_DROP(sv);
3997 SvUPGRADE(sv, SVt_PV);
4000 if (flags & SV_SMAGIC)
4004 if (SvPVX_const(sv))
4008 if (flags & SV_HAS_TRAILING_NUL)
4009 assert(ptr[len] == '\0');
4012 allocate = (flags & SV_HAS_TRAILING_NUL)
4013 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4014 if (flags & SV_HAS_TRAILING_NUL) {
4015 /* It's long enough - do nothing.
4016 Specfically Perl_newCONSTSUB is relying on this. */
4019 /* Force a move to shake out bugs in callers. */
4020 char *new_ptr = (char*)safemalloc(allocate);
4021 Copy(ptr, new_ptr, len, char);
4022 PoisonFree(ptr,len,char);
4026 ptr = (char*) saferealloc (ptr, allocate);
4031 SvLEN_set(sv, allocate);
4032 if (!(flags & SV_HAS_TRAILING_NUL)) {
4035 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4037 if (flags & SV_SMAGIC)
4041 #ifdef PERL_OLD_COPY_ON_WRITE
4042 /* Need to do this *after* making the SV normal, as we need the buffer
4043 pointer to remain valid until after we've copied it. If we let go too early,
4044 another thread could invalidate it by unsharing last of the same hash key
4045 (which it can do by means other than releasing copy-on-write Svs)
4046 or by changing the other copy-on-write SVs in the loop. */
4048 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4050 { /* this SV was SvIsCOW_normal(sv) */
4051 /* we need to find the SV pointing to us. */
4052 SV *current = SV_COW_NEXT_SV(after);
4054 if (current == sv) {
4055 /* The SV we point to points back to us (there were only two of us
4057 Hence other SV is no longer copy on write either. */
4059 SvREADONLY_off(after);
4061 /* We need to follow the pointers around the loop. */
4063 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4066 /* don't loop forever if the structure is bust, and we have
4067 a pointer into a closed loop. */
4068 assert (current != after);
4069 assert (SvPVX_const(current) == pvx);
4071 /* Make the SV before us point to the SV after us. */
4072 SV_COW_NEXT_SV_SET(current, after);
4078 =for apidoc sv_force_normal_flags
4080 Undo various types of fakery on an SV: if the PV is a shared string, make
4081 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4082 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4083 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4084 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4085 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4086 set to some other value.) In addition, the C<flags> parameter gets passed to
4087 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4088 with flags set to 0.
4094 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098 if (SvREADONLY(sv)) {
4099 /* At this point I believe I should acquire a global SV mutex. */
4101 const char * const pvx = SvPVX_const(sv);
4102 const STRLEN len = SvLEN(sv);
4103 const STRLEN cur = SvCUR(sv);
4104 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4105 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4106 we'll fail an assertion. */
4107 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4110 PerlIO_printf(Perl_debug_log,
4111 "Copy on write: Force normal %ld\n",
4117 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4120 if (flags & SV_COW_DROP_PV) {
4121 /* OK, so we don't need to copy our buffer. */
4124 SvGROW(sv, cur + 1);
4125 Move(pvx,SvPVX(sv),cur,char);
4130 sv_release_COW(sv, pvx, next);
4132 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4138 else if (IN_PERL_RUNTIME)
4139 Perl_croak(aTHX_ PL_no_modify);
4140 /* At this point I believe that I can drop the global SV mutex. */
4143 if (SvREADONLY(sv)) {
4145 const char * const pvx = SvPVX_const(sv);
4146 const STRLEN len = SvCUR(sv);
4151 SvGROW(sv, len + 1);
4152 Move(pvx,SvPVX(sv),len,char);
4154 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4156 else if (IN_PERL_RUNTIME)
4157 Perl_croak(aTHX_ PL_no_modify);
4161 sv_unref_flags(sv, flags);
4162 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4169 Efficient removal of characters from the beginning of the string buffer.
4170 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4171 the string buffer. The C<ptr> becomes the first character of the adjusted
4172 string. Uses the "OOK hack".
4173 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4174 refer to the same chunk of data.
4180 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4182 register STRLEN delta;
4183 if (!ptr || !SvPOKp(sv))
4185 delta = ptr - SvPVX_const(sv);
4186 SV_CHECK_THINKFIRST(sv);
4187 if (SvTYPE(sv) < SVt_PVIV)
4188 sv_upgrade(sv,SVt_PVIV);
4191 if (!SvLEN(sv)) { /* make copy of shared string */
4192 const char *pvx = SvPVX_const(sv);
4193 const STRLEN len = SvCUR(sv);
4194 SvGROW(sv, len + 1);
4195 Move(pvx,SvPVX(sv),len,char);
4199 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4200 and we do that anyway inside the SvNIOK_off
4202 SvFLAGS(sv) |= SVf_OOK;
4205 SvLEN_set(sv, SvLEN(sv) - delta);
4206 SvCUR_set(sv, SvCUR(sv) - delta);
4207 SvPV_set(sv, SvPVX(sv) + delta);
4208 SvIV_set(sv, SvIVX(sv) + delta);
4212 =for apidoc sv_catpvn
4214 Concatenates the string onto the end of the string which is in the SV. The
4215 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4216 status set, then the bytes appended should be valid UTF-8.
4217 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4219 =for apidoc sv_catpvn_flags
4221 Concatenates the string onto the end of the string which is in the SV. The
4222 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4223 status set, then the bytes appended should be valid UTF-8.
4224 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4225 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4226 in terms of this function.
4232 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4236 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4238 SvGROW(dsv, dlen + slen + 1);
4240 sstr = SvPVX_const(dsv);
4241 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4242 SvCUR_set(dsv, SvCUR(dsv) + slen);
4244 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4246 if (flags & SV_SMAGIC)
4251 =for apidoc sv_catsv
4253 Concatenates the string from SV C<ssv> onto the end of the string in
4254 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4255 not 'set' magic. See C<sv_catsv_mg>.
4257 =for apidoc sv_catsv_flags
4259 Concatenates the string from SV C<ssv> onto the end of the string in
4260 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4261 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4262 and C<sv_catsv_nomg> are implemented in terms of this function.
4267 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4272 const char *spv = SvPV_const(ssv, slen);
4274 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4275 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4276 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4277 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4278 dsv->sv_flags doesn't have that bit set.
4279 Andy Dougherty 12 Oct 2001
4281 const I32 sutf8 = DO_UTF8(ssv);
4284 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4286 dutf8 = DO_UTF8(dsv);
4288 if (dutf8 != sutf8) {
4290 /* Not modifying source SV, so taking a temporary copy. */
4291 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4293 sv_utf8_upgrade(csv);
4294 spv = SvPV_const(csv, slen);
4297 sv_utf8_upgrade_nomg(dsv);
4299 sv_catpvn_nomg(dsv, spv, slen);
4302 if (flags & SV_SMAGIC)
4307 =for apidoc sv_catpv
4309 Concatenates the string onto the end of the string which is in the SV.
4310 If the SV has the UTF-8 status set, then the bytes appended should be
4311 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4316 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4319 register STRLEN len;
4325 junk = SvPV_force(sv, tlen);
4327 SvGROW(sv, tlen + len + 1);
4329 ptr = SvPVX_const(sv);
4330 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4331 SvCUR_set(sv, SvCUR(sv) + len);
4332 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4337 =for apidoc sv_catpv_mg
4339 Like C<sv_catpv>, but also handles 'set' magic.
4345 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4354 Creates a new SV. A non-zero C<len> parameter indicates the number of
4355 bytes of preallocated string space the SV should have. An extra byte for a
4356 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4357 space is allocated.) The reference count for the new SV is set to 1.
4359 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4360 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4361 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4362 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4363 modules supporting older perls.
4369 Perl_newSV(pTHX_ STRLEN len)
4376 sv_upgrade(sv, SVt_PV);
4377 SvGROW(sv, len + 1);
4382 =for apidoc sv_magicext
4384 Adds magic to an SV, upgrading it if necessary. Applies the
4385 supplied vtable and returns a pointer to the magic added.
4387 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4388 In particular, you can add magic to SvREADONLY SVs, and add more than
4389 one instance of the same 'how'.
4391 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4392 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4393 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4394 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4396 (This is now used as a subroutine by C<sv_magic>.)
4401 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4402 const char* name, I32 namlen)
4407 SvUPGRADE(sv, SVt_PVMG);
4408 Newxz(mg, 1, MAGIC);
4409 mg->mg_moremagic = SvMAGIC(sv);
4410 SvMAGIC_set(sv, mg);
4412 /* Sometimes a magic contains a reference loop, where the sv and
4413 object refer to each other. To prevent a reference loop that
4414 would prevent such objects being freed, we look for such loops
4415 and if we find one we avoid incrementing the object refcount.
4417 Note we cannot do this to avoid self-tie loops as intervening RV must
4418 have its REFCNT incremented to keep it in existence.
4421 if (!obj || obj == sv ||
4422 how == PERL_MAGIC_arylen ||
4423 how == PERL_MAGIC_qr ||
4424 how == PERL_MAGIC_symtab ||
4425 (SvTYPE(obj) == SVt_PVGV &&
4426 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4427 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4428 GvFORM(obj) == (CV*)sv)))
4433 mg->mg_obj = SvREFCNT_inc_simple(obj);
4434 mg->mg_flags |= MGf_REFCOUNTED;
4437 /* Normal self-ties simply pass a null object, and instead of
4438 using mg_obj directly, use the SvTIED_obj macro to produce a
4439 new RV as needed. For glob "self-ties", we are tieing the PVIO
4440 with an RV obj pointing to the glob containing the PVIO. In
4441 this case, to avoid a reference loop, we need to weaken the
4445 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4446 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4452 mg->mg_len = namlen;
4455 mg->mg_ptr = savepvn(name, namlen);
4456 else if (namlen == HEf_SVKEY)
4457 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4459 mg->mg_ptr = (char *) name;
4461 mg->mg_virtual = (MGVTBL *) vtable;
4465 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4470 =for apidoc sv_magic
4472 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4473 then adds a new magic item of type C<how> to the head of the magic list.
4475 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4476 handling of the C<name> and C<namlen> arguments.
4478 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4479 to add more than one instance of the same 'how'.
4485 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4488 const MGVTBL *vtable;
4491 #ifdef PERL_OLD_COPY_ON_WRITE
4493 sv_force_normal_flags(sv, 0);
4495 if (SvREADONLY(sv)) {
4497 /* its okay to attach magic to shared strings; the subsequent
4498 * upgrade to PVMG will unshare the string */
4499 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4502 && how != PERL_MAGIC_regex_global
4503 && how != PERL_MAGIC_bm
4504 && how != PERL_MAGIC_fm
4505 && how != PERL_MAGIC_sv
4506 && how != PERL_MAGIC_backref
4509 Perl_croak(aTHX_ PL_no_modify);
4512 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4513 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4514 /* sv_magic() refuses to add a magic of the same 'how' as an
4517 if (how == PERL_MAGIC_taint) {
4519 /* Any scalar which already had taint magic on which someone
4520 (erroneously?) did SvIOK_on() or similar will now be
4521 incorrectly sporting public "OK" flags. */
4522 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4530 vtable = &PL_vtbl_sv;
4532 case PERL_MAGIC_overload:
4533 vtable = &PL_vtbl_amagic;
4535 case PERL_MAGIC_overload_elem:
4536 vtable = &PL_vtbl_amagicelem;
4538 case PERL_MAGIC_overload_table:
4539 vtable = &PL_vtbl_ovrld;
4542 vtable = &PL_vtbl_bm;
4544 case PERL_MAGIC_regdata:
4545 vtable = &PL_vtbl_regdata;
4547 case PERL_MAGIC_regdatum:
4548 vtable = &PL_vtbl_regdatum;
4550 case PERL_MAGIC_env:
4551 vtable = &PL_vtbl_env;
4554 vtable = &PL_vtbl_fm;
4556 case PERL_MAGIC_envelem:
4557 vtable = &PL_vtbl_envelem;
4559 case PERL_MAGIC_regex_global:
4560 vtable = &PL_vtbl_mglob;
4562 case PERL_MAGIC_isa:
4563 vtable = &PL_vtbl_isa;
4565 case PERL_MAGIC_isaelem:
4566 vtable = &PL_vtbl_isaelem;
4568 case PERL_MAGIC_nkeys:
4569 vtable = &PL_vtbl_nkeys;
4571 case PERL_MAGIC_dbfile:
4574 case PERL_MAGIC_dbline:
4575 vtable = &PL_vtbl_dbline;
4577 #ifdef USE_LOCALE_COLLATE
4578 case PERL_MAGIC_collxfrm:
4579 vtable = &PL_vtbl_collxfrm;
4581 #endif /* USE_LOCALE_COLLATE */
4582 case PERL_MAGIC_tied:
4583 vtable = &PL_vtbl_pack;
4585 case PERL_MAGIC_tiedelem:
4586 case PERL_MAGIC_tiedscalar:
4587 vtable = &PL_vtbl_packelem;
4590 vtable = &PL_vtbl_regexp;
4592 case PERL_MAGIC_hints:
4593 /* As this vtable is all NULL, we can reuse it. */
4594 case PERL_MAGIC_sig:
4595 vtable = &PL_vtbl_sig;
4597 case PERL_MAGIC_sigelem:
4598 vtable = &PL_vtbl_sigelem;
4600 case PERL_MAGIC_taint:
4601 vtable = &PL_vtbl_taint;
4603 case PERL_MAGIC_uvar:
4604 vtable = &PL_vtbl_uvar;
4606 case PERL_MAGIC_vec:
4607 vtable = &PL_vtbl_vec;
4609 case PERL_MAGIC_arylen_p:
4610 case PERL_MAGIC_rhash:
4611 case PERL_MAGIC_symtab:
4612 case PERL_MAGIC_vstring:
4615 case PERL_MAGIC_utf8:
4616 vtable = &PL_vtbl_utf8;
4618 case PERL_MAGIC_substr:
4619 vtable = &PL_vtbl_substr;
4621 case PERL_MAGIC_defelem:
4622 vtable = &PL_vtbl_defelem;
4624 case PERL_MAGIC_arylen:
4625 vtable = &PL_vtbl_arylen;
4627 case PERL_MAGIC_pos:
4628 vtable = &PL_vtbl_pos;
4630 case PERL_MAGIC_backref:
4631 vtable = &PL_vtbl_backref;
4633 case PERL_MAGIC_hintselem:
4634 vtable = &PL_vtbl_hintselem;
4636 case PERL_MAGIC_ext:
4637 /* Reserved for use by extensions not perl internals. */
4638 /* Useful for attaching extension internal data to perl vars. */
4639 /* Note that multiple extensions may clash if magical scalars */
4640 /* etc holding private data from one are passed to another. */
4644 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4647 /* Rest of work is done else where */
4648 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4651 case PERL_MAGIC_taint:
4654 case PERL_MAGIC_ext:
4655 case PERL_MAGIC_dbfile:
4662 =for apidoc sv_unmagic
4664 Removes all magic of type C<type> from an SV.
4670 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4674 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4676 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4677 for (mg = *mgp; mg; mg = *mgp) {
4678 if (mg->mg_type == type) {
4679 const MGVTBL* const vtbl = mg->mg_virtual;
4680 *mgp = mg->mg_moremagic;
4681 if (vtbl && vtbl->svt_free)
4682 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4683 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4685 Safefree(mg->mg_ptr);
4686 else if (mg->mg_len == HEf_SVKEY)
4687 SvREFCNT_dec((SV*)mg->mg_ptr);
4688 else if (mg->mg_type == PERL_MAGIC_utf8)
4689 Safefree(mg->mg_ptr);
4691 if (mg->mg_flags & MGf_REFCOUNTED)
4692 SvREFCNT_dec(mg->mg_obj);
4696 mgp = &mg->mg_moremagic;
4700 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4701 SvMAGIC_set(sv, NULL);
4708 =for apidoc sv_rvweaken
4710 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4711 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4712 push a back-reference to this RV onto the array of backreferences
4713 associated with that magic. If the RV is magical, set magic will be
4714 called after the RV is cleared.
4720 Perl_sv_rvweaken(pTHX_ SV *sv)
4723 if (!SvOK(sv)) /* let undefs pass */
4726 Perl_croak(aTHX_ "Can't weaken a nonreference");
4727 else if (SvWEAKREF(sv)) {
4728 if (ckWARN(WARN_MISC))
4729 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4733 Perl_sv_add_backref(aTHX_ tsv, sv);
4739 /* Give tsv backref magic if it hasn't already got it, then push a
4740 * back-reference to sv onto the array associated with the backref magic.
4744 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4749 if (SvTYPE(tsv) == SVt_PVHV) {
4750 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4754 /* There is no AV in the offical place - try a fixup. */
4755 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4758 /* Aha. They've got it stowed in magic. Bring it back. */
4759 av = (AV*)mg->mg_obj;
4760 /* Stop mg_free decreasing the refernce count. */
4762 /* Stop mg_free even calling the destructor, given that
4763 there's no AV to free up. */
4765 sv_unmagic(tsv, PERL_MAGIC_backref);
4769 SvREFCNT_inc_simple_void(av);
4774 const MAGIC *const mg
4775 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4777 av = (AV*)mg->mg_obj;
4781 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4782 /* av now has a refcnt of 2, which avoids it getting freed
4783 * before us during global cleanup. The extra ref is removed
4784 * by magic_killbackrefs() when tsv is being freed */
4787 if (AvFILLp(av) >= AvMAX(av)) {
4788 av_extend(av, AvFILLp(av)+1);
4790 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4793 /* delete a back-reference to ourselves from the backref magic associated
4794 * with the SV we point to.
4798 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4805 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4806 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4807 /* We mustn't attempt to "fix up" the hash here by moving the
4808 backreference array back to the hv_aux structure, as that is stored
4809 in the main HvARRAY(), and hfreentries assumes that no-one
4810 reallocates HvARRAY() while it is running. */
4813 const MAGIC *const mg
4814 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4816 av = (AV *)mg->mg_obj;
4819 if (PL_in_clean_all)
4821 Perl_croak(aTHX_ "panic: del_backref");
4828 /* We shouldn't be in here more than once, but for paranoia reasons lets
4830 for (i = AvFILLp(av); i >= 0; i--) {
4832 const SSize_t fill = AvFILLp(av);
4834 /* We weren't the last entry.
4835 An unordered list has this property that you can take the
4836 last element off the end to fill the hole, and it's still
4837 an unordered list :-)
4842 AvFILLp(av) = fill - 1;
4848 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4850 SV **svp = AvARRAY(av);
4852 PERL_UNUSED_ARG(sv);
4854 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4855 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4856 if (svp && !SvIS_FREED(av)) {
4857 SV *const *const last = svp + AvFILLp(av);
4859 while (svp <= last) {
4861 SV *const referrer = *svp;
4862 if (SvWEAKREF(referrer)) {
4863 /* XXX Should we check that it hasn't changed? */
4864 SvRV_set(referrer, 0);
4866 SvWEAKREF_off(referrer);
4867 SvSETMAGIC(referrer);
4868 } else if (SvTYPE(referrer) == SVt_PVGV ||
4869 SvTYPE(referrer) == SVt_PVLV) {
4870 /* You lookin' at me? */
4871 assert(GvSTASH(referrer));
4872 assert(GvSTASH(referrer) == (HV*)sv);
4873 GvSTASH(referrer) = 0;
4876 "panic: magic_killbackrefs (flags=%"UVxf")",
4877 (UV)SvFLAGS(referrer));
4885 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4890 =for apidoc sv_insert
4892 Inserts a string at the specified offset/length within the SV. Similar to
4893 the Perl substr() function.
4899 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4904 register char *midend;
4905 register char *bigend;
4911 Perl_croak(aTHX_ "Can't modify non-existent substring");
4912 SvPV_force(bigstr, curlen);
4913 (void)SvPOK_only_UTF8(bigstr);
4914 if (offset + len > curlen) {
4915 SvGROW(bigstr, offset+len+1);
4916 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4917 SvCUR_set(bigstr, offset+len);
4921 i = littlelen - len;
4922 if (i > 0) { /* string might grow */
4923 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4924 mid = big + offset + len;
4925 midend = bigend = big + SvCUR(bigstr);
4928 while (midend > mid) /* shove everything down */
4929 *--bigend = *--midend;
4930 Move(little,big+offset,littlelen,char);
4931 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4936 Move(little,SvPVX(bigstr)+offset,len,char);
4941 big = SvPVX(bigstr);
4944 bigend = big + SvCUR(bigstr);
4946 if (midend > bigend)
4947 Perl_croak(aTHX_ "panic: sv_insert");
4949 if (mid - big > bigend - midend) { /* faster to shorten from end */
4951 Move(little, mid, littlelen,char);
4954 i = bigend - midend;
4956 Move(midend, mid, i,char);
4960 SvCUR_set(bigstr, mid - big);
4962 else if ((i = mid - big)) { /* faster from front */
4963 midend -= littlelen;
4965 sv_chop(bigstr,midend-i);
4970 Move(little, mid, littlelen,char);
4972 else if (littlelen) {
4973 midend -= littlelen;
4974 sv_chop(bigstr,midend);
4975 Move(little,midend,littlelen,char);
4978 sv_chop(bigstr,midend);
4984 =for apidoc sv_replace
4986 Make the first argument a copy of the second, then delete the original.
4987 The target SV physically takes over ownership of the body of the source SV
4988 and inherits its flags; however, the target keeps any magic it owns,
4989 and any magic in the source is discarded.
4990 Note that this is a rather specialist SV copying operation; most of the
4991 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4997 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5000 const U32 refcnt = SvREFCNT(sv);
5001 SV_CHECK_THINKFIRST_COW_DROP(sv);
5002 if (SvREFCNT(nsv) != 1) {
5003 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5004 UVuf " != 1)", (UV) SvREFCNT(nsv));
5006 if (SvMAGICAL(sv)) {
5010 sv_upgrade(nsv, SVt_PVMG);
5011 SvMAGIC_set(nsv, SvMAGIC(sv));
5012 SvFLAGS(nsv) |= SvMAGICAL(sv);
5014 SvMAGIC_set(sv, NULL);
5018 assert(!SvREFCNT(sv));
5019 #ifdef DEBUG_LEAKING_SCALARS
5020 sv->sv_flags = nsv->sv_flags;
5021 sv->sv_any = nsv->sv_any;
5022 sv->sv_refcnt = nsv->sv_refcnt;
5023 sv->sv_u = nsv->sv_u;
5025 StructCopy(nsv,sv,SV);
5027 /* Currently could join these into one piece of pointer arithmetic, but
5028 it would be unclear. */
5029 if(SvTYPE(sv) == SVt_IV)
5031 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5032 else if (SvTYPE(sv) == SVt_RV) {
5033 SvANY(sv) = &sv->sv_u.svu_rv;
5037 #ifdef PERL_OLD_COPY_ON_WRITE
5038 if (SvIsCOW_normal(nsv)) {
5039 /* We need to follow the pointers around the loop to make the
5040 previous SV point to sv, rather than nsv. */
5043 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5046 assert(SvPVX_const(current) == SvPVX_const(nsv));
5048 /* Make the SV before us point to the SV after us. */
5050 PerlIO_printf(Perl_debug_log, "previous is\n");
5052 PerlIO_printf(Perl_debug_log,
5053 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5054 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5056 SV_COW_NEXT_SV_SET(current, sv);
5059 SvREFCNT(sv) = refcnt;
5060 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5066 =for apidoc sv_clear
5068 Clear an SV: call any destructors, free up any memory used by the body,
5069 and free the body itself. The SV's head is I<not> freed, although
5070 its type is set to all 1's so that it won't inadvertently be assumed
5071 to be live during global destruction etc.
5072 This function should only be called when REFCNT is zero. Most of the time
5073 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5080 Perl_sv_clear(pTHX_ register SV *sv)
5083 const U32 type = SvTYPE(sv);
5084 const struct body_details *const sv_type_details
5085 = bodies_by_type + type;
5089 assert(SvREFCNT(sv) == 0);
5091 if (type <= SVt_IV) {
5092 /* See the comment in sv.h about the collusion between this early
5093 return and the overloading of the NULL and IV slots in the size
5099 if (PL_defstash) { /* Still have a symbol table? */
5104 stash = SvSTASH(sv);
5105 destructor = StashHANDLER(stash,DESTROY);
5107 SV* const tmpref = newRV(sv);
5108 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5110 PUSHSTACKi(PERLSI_DESTROY);
5115 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5121 if(SvREFCNT(tmpref) < 2) {
5122 /* tmpref is not kept alive! */
5124 SvRV_set(tmpref, NULL);
5127 SvREFCNT_dec(tmpref);
5129 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5133 if (PL_in_clean_objs)
5134 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5136 /* DESTROY gave object new lease on life */
5142 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5143 SvOBJECT_off(sv); /* Curse the object. */
5144 if (type != SVt_PVIO)
5145 --PL_sv_objcount; /* XXX Might want something more general */
5148 if (type >= SVt_PVMG) {
5149 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5150 SvREFCNT_dec(SvOURSTASH(sv));
5151 } else if (SvMAGIC(sv))
5153 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5154 SvREFCNT_dec(SvSTASH(sv));
5157 /* case SVt_BIND: */
5160 IoIFP(sv) != PerlIO_stdin() &&
5161 IoIFP(sv) != PerlIO_stdout() &&
5162 IoIFP(sv) != PerlIO_stderr())
5164 io_close((IO*)sv, FALSE);
5166 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5167 PerlDir_close(IoDIRP(sv));
5168 IoDIRP(sv) = (DIR*)NULL;
5169 Safefree(IoTOP_NAME(sv));
5170 Safefree(IoFMT_NAME(sv));
5171 Safefree(IoBOTTOM_NAME(sv));
5178 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5182 if (PL_comppad == (AV*)sv) {
5189 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5190 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5191 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5192 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5194 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5195 SvREFCNT_dec(LvTARG(sv));
5197 if (isGV_with_GP(sv)) {
5198 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5199 mro_method_changed_in(stash);
5202 unshare_hek(GvNAME_HEK(sv));
5203 /* If we're in a stash, we don't own a reference to it. However it does
5204 have a back reference to us, which needs to be cleared. */
5205 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5206 sv_del_backref((SV*)stash, sv);
5208 /* FIXME. There are probably more unreferenced pointers to SVs in the
5209 interpreter struct that we should check and tidy in a similar
5211 if ((GV*)sv == PL_last_in_gv)
5212 PL_last_in_gv = NULL;
5217 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5219 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5220 /* Don't even bother with turning off the OOK flag. */
5225 SV * const target = SvRV(sv);
5227 sv_del_backref(target, sv);
5229 SvREFCNT_dec(target);
5231 #ifdef PERL_OLD_COPY_ON_WRITE
5232 else if (SvPVX_const(sv)) {
5234 /* I believe I need to grab the global SV mutex here and
5235 then recheck the COW status. */
5237 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5241 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5243 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5246 /* And drop it here. */
5248 } else if (SvLEN(sv)) {
5249 Safefree(SvPVX_const(sv));
5253 else if (SvPVX_const(sv) && SvLEN(sv))
5254 Safefree(SvPVX_mutable(sv));
5255 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5256 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5265 SvFLAGS(sv) &= SVf_BREAK;
5266 SvFLAGS(sv) |= SVTYPEMASK;
5268 if (sv_type_details->arena) {
5269 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5270 &PL_body_roots[type]);
5272 else if (sv_type_details->body_size) {
5273 my_safefree(SvANY(sv));
5278 =for apidoc sv_newref
5280 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5287 Perl_sv_newref(pTHX_ SV *sv)
5289 PERL_UNUSED_CONTEXT;
5298 Decrement an SV's reference count, and if it drops to zero, call
5299 C<sv_clear> to invoke destructors and free up any memory used by
5300 the body; finally, deallocate the SV's head itself.
5301 Normally called via a wrapper macro C<SvREFCNT_dec>.
5307 Perl_sv_free(pTHX_ SV *sv)
5312 if (SvREFCNT(sv) == 0) {
5313 if (SvFLAGS(sv) & SVf_BREAK)
5314 /* this SV's refcnt has been artificially decremented to
5315 * trigger cleanup */
5317 if (PL_in_clean_all) /* All is fair */
5319 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5320 /* make sure SvREFCNT(sv)==0 happens very seldom */
5321 SvREFCNT(sv) = (~(U32)0)/2;
5324 if (ckWARN_d(WARN_INTERNAL)) {
5325 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5326 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5327 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5328 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5329 Perl_dump_sv_child(aTHX_ sv);
5331 #ifdef DEBUG_LEAKING_SCALARS
5338 if (--(SvREFCNT(sv)) > 0)
5340 Perl_sv_free2(aTHX_ sv);
5344 Perl_sv_free2(pTHX_ SV *sv)
5349 if (ckWARN_d(WARN_DEBUGGING))
5350 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5351 "Attempt to free temp prematurely: SV 0x%"UVxf
5352 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5356 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5357 /* make sure SvREFCNT(sv)==0 happens very seldom */
5358 SvREFCNT(sv) = (~(U32)0)/2;
5369 Returns the length of the string in the SV. Handles magic and type
5370 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5376 Perl_sv_len(pTHX_ register SV *sv)
5384 len = mg_length(sv);
5386 (void)SvPV_const(sv, len);
5391 =for apidoc sv_len_utf8
5393 Returns the number of characters in the string in an SV, counting wide
5394 UTF-8 bytes as a single character. Handles magic and type coercion.
5400 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5401 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5402 * (Note that the mg_len is not the length of the mg_ptr field.
5403 * This allows the cache to store the character length of the string without
5404 * needing to malloc() extra storage to attach to the mg_ptr.)
5409 Perl_sv_len_utf8(pTHX_ register SV *sv)
5415 return mg_length(sv);
5419 const U8 *s = (U8*)SvPV_const(sv, len);
5423 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5425 if (mg && mg->mg_len != -1) {
5427 if (PL_utf8cache < 0) {
5428 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5430 /* Need to turn the assertions off otherwise we may
5431 recurse infinitely while printing error messages.
5433 SAVEI8(PL_utf8cache);
5435 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5436 " real %"UVuf" for %"SVf,
5437 (UV) ulen, (UV) real, SVfARG(sv));
5442 ulen = Perl_utf8_length(aTHX_ s, s + len);
5443 if (!SvREADONLY(sv)) {
5445 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5446 &PL_vtbl_utf8, 0, 0);
5454 return Perl_utf8_length(aTHX_ s, s + len);
5458 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5461 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5464 const U8 *s = start;
5466 while (s < send && uoffset--)
5469 /* This is the existing behaviour. Possibly it should be a croak, as
5470 it's actually a bounds error */
5476 /* Given the length of the string in both bytes and UTF-8 characters, decide
5477 whether to walk forwards or backwards to find the byte corresponding to
5478 the passed in UTF-8 offset. */
5480 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5481 STRLEN uoffset, STRLEN uend)
5483 STRLEN backw = uend - uoffset;
5484 if (uoffset < 2 * backw) {
5485 /* The assumption is that going forwards is twice the speed of going
5486 forward (that's where the 2 * backw comes from).
5487 (The real figure of course depends on the UTF-8 data.) */
5488 return sv_pos_u2b_forwards(start, send, uoffset);
5493 while (UTF8_IS_CONTINUATION(*send))
5496 return send - start;
5499 /* For the string representation of the given scalar, find the byte
5500 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5501 give another position in the string, *before* the sought offset, which
5502 (which is always true, as 0, 0 is a valid pair of positions), which should
5503 help reduce the amount of linear searching.
5504 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5505 will be used to reduce the amount of linear searching. The cache will be
5506 created if necessary, and the found value offered to it for update. */
5508 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5509 const U8 *const send, STRLEN uoffset,
5510 STRLEN uoffset0, STRLEN boffset0) {
5511 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5514 assert (uoffset >= uoffset0);
5516 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5517 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5518 if ((*mgp)->mg_ptr) {
5519 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5520 if (cache[0] == uoffset) {
5521 /* An exact match. */
5524 if (cache[2] == uoffset) {
5525 /* An exact match. */
5529 if (cache[0] < uoffset) {
5530 /* The cache already knows part of the way. */
5531 if (cache[0] > uoffset0) {
5532 /* The cache knows more than the passed in pair */
5533 uoffset0 = cache[0];
5534 boffset0 = cache[1];
5536 if ((*mgp)->mg_len != -1) {
5537 /* And we know the end too. */
5539 + sv_pos_u2b_midway(start + boffset0, send,
5541 (*mgp)->mg_len - uoffset0);
5544 + sv_pos_u2b_forwards(start + boffset0,
5545 send, uoffset - uoffset0);
5548 else if (cache[2] < uoffset) {
5549 /* We're between the two cache entries. */
5550 if (cache[2] > uoffset0) {
5551 /* and the cache knows more than the passed in pair */
5552 uoffset0 = cache[2];
5553 boffset0 = cache[3];
5557 + sv_pos_u2b_midway(start + boffset0,
5560 cache[0] - uoffset0);
5563 + sv_pos_u2b_midway(start + boffset0,
5566 cache[2] - uoffset0);
5570 else if ((*mgp)->mg_len != -1) {
5571 /* If we can take advantage of a passed in offset, do so. */
5572 /* In fact, offset0 is either 0, or less than offset, so don't
5573 need to worry about the other possibility. */
5575 + sv_pos_u2b_midway(start + boffset0, send,
5577 (*mgp)->mg_len - uoffset0);
5582 if (!found || PL_utf8cache < 0) {
5583 const STRLEN real_boffset
5584 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5585 send, uoffset - uoffset0);
5587 if (found && PL_utf8cache < 0) {
5588 if (real_boffset != boffset) {
5589 /* Need to turn the assertions off otherwise we may recurse
5590 infinitely while printing error messages. */
5591 SAVEI8(PL_utf8cache);
5593 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5594 " real %"UVuf" for %"SVf,
5595 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5598 boffset = real_boffset;
5601 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5607 =for apidoc sv_pos_u2b
5609 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5610 the start of the string, to a count of the equivalent number of bytes; if
5611 lenp is non-zero, it does the same to lenp, but this time starting from
5612 the offset, rather than from the start of the string. Handles magic and
5619 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5620 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5621 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5626 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5634 start = (U8*)SvPV_const(sv, len);
5636 STRLEN uoffset = (STRLEN) *offsetp;
5637 const U8 * const send = start + len;
5639 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5642 *offsetp = (I32) boffset;
5645 /* Convert the relative offset to absolute. */
5646 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5647 const STRLEN boffset2
5648 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5649 uoffset, boffset) - boffset;
5663 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5664 byte length pairing. The (byte) length of the total SV is passed in too,
5665 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5666 may not have updated SvCUR, so we can't rely on reading it directly.
5668 The proffered utf8/byte length pairing isn't used if the cache already has
5669 two pairs, and swapping either for the proffered pair would increase the
5670 RMS of the intervals between known byte offsets.
5672 The cache itself consists of 4 STRLEN values
5673 0: larger UTF-8 offset
5674 1: corresponding byte offset
5675 2: smaller UTF-8 offset
5676 3: corresponding byte offset
5678 Unused cache pairs have the value 0, 0.
5679 Keeping the cache "backwards" means that the invariant of
5680 cache[0] >= cache[2] is maintained even with empty slots, which means that
5681 the code that uses it doesn't need to worry if only 1 entry has actually
5682 been set to non-zero. It also makes the "position beyond the end of the
5683 cache" logic much simpler, as the first slot is always the one to start
5687 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5695 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5697 (*mgp)->mg_len = -1;
5701 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5702 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5703 (*mgp)->mg_ptr = (char *) cache;
5707 if (PL_utf8cache < 0) {
5708 const U8 *start = (const U8 *) SvPVX_const(sv);
5709 const STRLEN realutf8 = utf8_length(start, start + byte);
5711 if (realutf8 != utf8) {
5712 /* Need to turn the assertions off otherwise we may recurse
5713 infinitely while printing error messages. */
5714 SAVEI8(PL_utf8cache);
5716 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5717 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5721 /* Cache is held with the later position first, to simplify the code
5722 that deals with unbounded ends. */
5724 ASSERT_UTF8_CACHE(cache);
5725 if (cache[1] == 0) {
5726 /* Cache is totally empty */
5729 } else if (cache[3] == 0) {
5730 if (byte > cache[1]) {
5731 /* New one is larger, so goes first. */
5732 cache[2] = cache[0];
5733 cache[3] = cache[1];
5741 #define THREEWAY_SQUARE(a,b,c,d) \
5742 ((float)((d) - (c))) * ((float)((d) - (c))) \
5743 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5744 + ((float)((b) - (a))) * ((float)((b) - (a)))
5746 /* Cache has 2 slots in use, and we know three potential pairs.
5747 Keep the two that give the lowest RMS distance. Do the
5748 calcualation in bytes simply because we always know the byte
5749 length. squareroot has the same ordering as the positive value,
5750 so don't bother with the actual square root. */
5751 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5752 if (byte > cache[1]) {
5753 /* New position is after the existing pair of pairs. */
5754 const float keep_earlier
5755 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5756 const float keep_later
5757 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5759 if (keep_later < keep_earlier) {
5760 if (keep_later < existing) {
5761 cache[2] = cache[0];
5762 cache[3] = cache[1];
5768 if (keep_earlier < existing) {
5774 else if (byte > cache[3]) {
5775 /* New position is between the existing pair of pairs. */
5776 const float keep_earlier
5777 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5778 const float keep_later
5779 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5781 if (keep_later < keep_earlier) {
5782 if (keep_later < existing) {
5788 if (keep_earlier < existing) {
5795 /* New position is before the existing pair of pairs. */
5796 const float keep_earlier
5797 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5798 const float keep_later
5799 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5801 if (keep_later < keep_earlier) {
5802 if (keep_later < existing) {
5808 if (keep_earlier < existing) {
5809 cache[0] = cache[2];
5810 cache[1] = cache[3];
5817 ASSERT_UTF8_CACHE(cache);
5820 /* We already know all of the way, now we may be able to walk back. The same
5821 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5822 backward is half the speed of walking forward. */
5824 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5827 const STRLEN forw = target - s;
5828 STRLEN backw = end - target;
5830 if (forw < 2 * backw) {
5831 return utf8_length(s, target);
5834 while (end > target) {
5836 while (UTF8_IS_CONTINUATION(*end)) {
5845 =for apidoc sv_pos_b2u
5847 Converts the value pointed to by offsetp from a count of bytes from the
5848 start of the string, to a count of the equivalent number of UTF-8 chars.
5849 Handles magic and type coercion.
5855 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5856 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5861 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5864 const STRLEN byte = *offsetp;
5865 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5874 s = (const U8*)SvPV_const(sv, blen);
5877 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5881 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5882 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5884 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5885 if (cache[1] == byte) {
5886 /* An exact match. */
5887 *offsetp = cache[0];
5890 if (cache[3] == byte) {
5891 /* An exact match. */
5892 *offsetp = cache[2];
5896 if (cache[1] < byte) {
5897 /* We already know part of the way. */
5898 if (mg->mg_len != -1) {
5899 /* Actually, we know the end too. */
5901 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5902 s + blen, mg->mg_len - cache[0]);
5904 len = cache[0] + utf8_length(s + cache[1], send);
5907 else if (cache[3] < byte) {
5908 /* We're between the two cached pairs, so we do the calculation
5909 offset by the byte/utf-8 positions for the earlier pair,
5910 then add the utf-8 characters from the string start to
5912 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5913 s + cache[1], cache[0] - cache[2])
5917 else { /* cache[3] > byte */
5918 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5922 ASSERT_UTF8_CACHE(cache);
5924 } else if (mg->mg_len != -1) {
5925 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5929 if (!found || PL_utf8cache < 0) {
5930 const STRLEN real_len = utf8_length(s, send);
5932 if (found && PL_utf8cache < 0) {
5933 if (len != real_len) {
5934 /* Need to turn the assertions off otherwise we may recurse
5935 infinitely while printing error messages. */
5936 SAVEI8(PL_utf8cache);
5938 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5939 " real %"UVuf" for %"SVf,
5940 (UV) len, (UV) real_len, SVfARG(sv));
5947 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5953 Returns a boolean indicating whether the strings in the two SVs are
5954 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5955 coerce its args to strings if necessary.
5961 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5970 SV* svrecode = NULL;
5977 /* if pv1 and pv2 are the same, second SvPV_const call may
5978 * invalidate pv1, so we may need to make a copy */
5979 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5980 pv1 = SvPV_const(sv1, cur1);
5981 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5982 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5984 pv1 = SvPV_const(sv1, cur1);
5992 pv2 = SvPV_const(sv2, cur2);
5994 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5995 /* Differing utf8ness.
5996 * Do not UTF8size the comparands as a side-effect. */
5999 svrecode = newSVpvn(pv2, cur2);
6000 sv_recode_to_utf8(svrecode, PL_encoding);
6001 pv2 = SvPV_const(svrecode, cur2);
6004 svrecode = newSVpvn(pv1, cur1);
6005 sv_recode_to_utf8(svrecode, PL_encoding);
6006 pv1 = SvPV_const(svrecode, cur1);
6008 /* Now both are in UTF-8. */
6010 SvREFCNT_dec(svrecode);
6015 bool is_utf8 = TRUE;
6018 /* sv1 is the UTF-8 one,
6019 * if is equal it must be downgrade-able */
6020 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6026 /* sv2 is the UTF-8 one,
6027 * if is equal it must be downgrade-able */
6028 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6034 /* Downgrade not possible - cannot be eq */
6042 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6044 SvREFCNT_dec(svrecode);
6054 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6055 string in C<sv1> is less than, equal to, or greater than the string in
6056 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6057 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6063 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6067 const char *pv1, *pv2;
6070 SV *svrecode = NULL;
6077 pv1 = SvPV_const(sv1, cur1);
6084 pv2 = SvPV_const(sv2, cur2);
6086 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6087 /* Differing utf8ness.
6088 * Do not UTF8size the comparands as a side-effect. */
6091 svrecode = newSVpvn(pv2, cur2);
6092 sv_recode_to_utf8(svrecode, PL_encoding);
6093 pv2 = SvPV_const(svrecode, cur2);
6096 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6101 svrecode = newSVpvn(pv1, cur1);
6102 sv_recode_to_utf8(svrecode, PL_encoding);
6103 pv1 = SvPV_const(svrecode, cur1);
6106 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6112 cmp = cur2 ? -1 : 0;
6116 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6119 cmp = retval < 0 ? -1 : 1;
6120 } else if (cur1 == cur2) {
6123 cmp = cur1 < cur2 ? -1 : 1;
6127 SvREFCNT_dec(svrecode);
6135 =for apidoc sv_cmp_locale
6137 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6138 'use bytes' aware, handles get magic, and will coerce its args to strings
6139 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6145 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6148 #ifdef USE_LOCALE_COLLATE
6154 if (PL_collation_standard)
6158 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6160 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6162 if (!pv1 || !len1) {
6173 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6176 return retval < 0 ? -1 : 1;
6179 * When the result of collation is equality, that doesn't mean
6180 * that there are no differences -- some locales exclude some
6181 * characters from consideration. So to avoid false equalities,
6182 * we use the raw string as a tiebreaker.
6188 #endif /* USE_LOCALE_COLLATE */
6190 return sv_cmp(sv1, sv2);
6194 #ifdef USE_LOCALE_COLLATE
6197 =for apidoc sv_collxfrm
6199 Add Collate Transform magic to an SV if it doesn't already have it.
6201 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6202 scalar data of the variable, but transformed to such a format that a normal
6203 memory comparison can be used to compare the data according to the locale
6210 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6215 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6216 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6222 Safefree(mg->mg_ptr);
6223 s = SvPV_const(sv, len);
6224 if ((xf = mem_collxfrm(s, len, &xlen))) {
6225 if (SvREADONLY(sv)) {
6228 return xf + sizeof(PL_collation_ix);
6231 #ifdef PERL_OLD_COPY_ON_WRITE
6233 sv_force_normal_flags(sv, 0);
6235 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6249 if (mg && mg->mg_ptr) {
6251 return mg->mg_ptr + sizeof(PL_collation_ix);
6259 #endif /* USE_LOCALE_COLLATE */
6264 Get a line from the filehandle and store it into the SV, optionally
6265 appending to the currently-stored string.
6271 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6276 register STDCHAR rslast;
6277 register STDCHAR *bp;
6282 if (SvTHINKFIRST(sv))
6283 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6284 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6286 However, perlbench says it's slower, because the existing swipe code
6287 is faster than copy on write.
6288 Swings and roundabouts. */
6289 SvUPGRADE(sv, SVt_PV);
6294 if (PerlIO_isutf8(fp)) {
6296 sv_utf8_upgrade_nomg(sv);
6297 sv_pos_u2b(sv,&append,0);
6299 } else if (SvUTF8(sv)) {
6300 SV * const tsv = newSV(0);
6301 sv_gets(tsv, fp, 0);
6302 sv_utf8_upgrade_nomg(tsv);
6303 SvCUR_set(sv,append);
6306 goto return_string_or_null;
6311 if (PerlIO_isutf8(fp))
6314 if (IN_PERL_COMPILETIME) {
6315 /* we always read code in line mode */
6319 else if (RsSNARF(PL_rs)) {
6320 /* If it is a regular disk file use size from stat() as estimate
6321 of amount we are going to read -- may result in mallocing
6322 more memory than we really need if the layers below reduce
6323 the size we read (e.g. CRLF or a gzip layer).
6326 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6327 const Off_t offset = PerlIO_tell(fp);
6328 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6329 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6335 else if (RsRECORD(PL_rs)) {
6340 /* Grab the size of the record we're getting */
6341 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6342 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6345 /* VMS wants read instead of fread, because fread doesn't respect */
6346 /* RMS record boundaries. This is not necessarily a good thing to be */
6347 /* doing, but we've got no other real choice - except avoid stdio
6348 as implementation - perhaps write a :vms layer ?
6350 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6352 bytesread = PerlIO_read(fp, buffer, recsize);
6356 SvCUR_set(sv, bytesread += append);
6357 buffer[bytesread] = '\0';
6358 goto return_string_or_null;
6360 else if (RsPARA(PL_rs)) {
6366 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6367 if (PerlIO_isutf8(fp)) {
6368 rsptr = SvPVutf8(PL_rs, rslen);
6371 if (SvUTF8(PL_rs)) {
6372 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6373 Perl_croak(aTHX_ "Wide character in $/");
6376 rsptr = SvPV_const(PL_rs, rslen);
6380 rslast = rslen ? rsptr[rslen - 1] : '\0';
6382 if (rspara) { /* have to do this both before and after */
6383 do { /* to make sure file boundaries work right */
6386 i = PerlIO_getc(fp);
6390 PerlIO_ungetc(fp,i);
6396 /* See if we know enough about I/O mechanism to cheat it ! */
6398 /* This used to be #ifdef test - it is made run-time test for ease
6399 of abstracting out stdio interface. One call should be cheap
6400 enough here - and may even be a macro allowing compile
6404 if (PerlIO_fast_gets(fp)) {
6407 * We're going to steal some values from the stdio struct
6408 * and put EVERYTHING in the innermost loop into registers.
6410 register STDCHAR *ptr;
6414 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6415 /* An ungetc()d char is handled separately from the regular
6416 * buffer, so we getc() it back out and stuff it in the buffer.
6418 i = PerlIO_getc(fp);
6419 if (i == EOF) return 0;
6420 *(--((*fp)->_ptr)) = (unsigned char) i;
6424 /* Here is some breathtakingly efficient cheating */
6426 cnt = PerlIO_get_cnt(fp); /* get count into register */
6427 /* make sure we have the room */
6428 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6429 /* Not room for all of it
6430 if we are looking for a separator and room for some
6432 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6433 /* just process what we have room for */
6434 shortbuffered = cnt - SvLEN(sv) + append + 1;
6435 cnt -= shortbuffered;
6439 /* remember that cnt can be negative */
6440 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6445 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6446 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6447 DEBUG_P(PerlIO_printf(Perl_debug_log,
6448 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6449 DEBUG_P(PerlIO_printf(Perl_debug_log,
6450 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6451 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6452 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6457 while (cnt > 0) { /* this | eat */
6459 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6460 goto thats_all_folks; /* screams | sed :-) */
6464 Copy(ptr, bp, cnt, char); /* this | eat */
6465 bp += cnt; /* screams | dust */
6466 ptr += cnt; /* louder | sed :-) */
6471 if (shortbuffered) { /* oh well, must extend */
6472 cnt = shortbuffered;
6474 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6476 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6477 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6481 DEBUG_P(PerlIO_printf(Perl_debug_log,
6482 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6483 PTR2UV(ptr),(long)cnt));
6484 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6486 DEBUG_P(PerlIO_printf(Perl_debug_log,
6487 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6488 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6489 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6491 /* This used to call 'filbuf' in stdio form, but as that behaves like
6492 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6493 another abstraction. */
6494 i = PerlIO_getc(fp); /* get more characters */
6496 DEBUG_P(PerlIO_printf(Perl_debug_log,
6497 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6498 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6499 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6501 cnt = PerlIO_get_cnt(fp);
6502 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6503 DEBUG_P(PerlIO_printf(Perl_debug_log,
6504 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6506 if (i == EOF) /* all done for ever? */
6507 goto thats_really_all_folks;
6509 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6511 SvGROW(sv, bpx + cnt + 2);
6512 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6514 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6516 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6517 goto thats_all_folks;
6521 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6522 memNE((char*)bp - rslen, rsptr, rslen))
6523 goto screamer; /* go back to the fray */
6524 thats_really_all_folks:
6526 cnt += shortbuffered;
6527 DEBUG_P(PerlIO_printf(Perl_debug_log,
6528 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6529 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6530 DEBUG_P(PerlIO_printf(Perl_debug_log,
6531 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6532 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6533 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6535 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6536 DEBUG_P(PerlIO_printf(Perl_debug_log,
6537 "Screamer: done, len=%ld, string=|%.*s|\n",
6538 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6542 /*The big, slow, and stupid way. */
6543 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6544 STDCHAR *buf = NULL;
6545 Newx(buf, 8192, STDCHAR);
6553 register const STDCHAR * const bpe = buf + sizeof(buf);
6555 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6556 ; /* keep reading */
6560 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6561 /* Accomodate broken VAXC compiler, which applies U8 cast to
6562 * both args of ?: operator, causing EOF to change into 255
6565 i = (U8)buf[cnt - 1];
6571 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6573 sv_catpvn(sv, (char *) buf, cnt);
6575 sv_setpvn(sv, (char *) buf, cnt);
6577 if (i != EOF && /* joy */
6579 SvCUR(sv) < rslen ||
6580 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6584 * If we're reading from a TTY and we get a short read,
6585 * indicating that the user hit his EOF character, we need
6586 * to notice it now, because if we try to read from the TTY
6587 * again, the EOF condition will disappear.
6589 * The comparison of cnt to sizeof(buf) is an optimization
6590 * that prevents unnecessary calls to feof().
6594 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6598 #ifdef USE_HEAP_INSTEAD_OF_STACK
6603 if (rspara) { /* have to do this both before and after */
6604 while (i != EOF) { /* to make sure file boundaries work right */
6605 i = PerlIO_getc(fp);
6607 PerlIO_ungetc(fp,i);
6613 return_string_or_null:
6614 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6620 Auto-increment of the value in the SV, doing string to numeric conversion
6621 if necessary. Handles 'get' magic.
6627 Perl_sv_inc(pTHX_ register SV *sv)
6636 if (SvTHINKFIRST(sv)) {
6638 sv_force_normal_flags(sv, 0);
6639 if (SvREADONLY(sv)) {
6640 if (IN_PERL_RUNTIME)
6641 Perl_croak(aTHX_ PL_no_modify);
6645 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6647 i = PTR2IV(SvRV(sv));
6652 flags = SvFLAGS(sv);
6653 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6654 /* It's (privately or publicly) a float, but not tested as an
6655 integer, so test it to see. */
6657 flags = SvFLAGS(sv);
6659 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6660 /* It's publicly an integer, or privately an integer-not-float */
6661 #ifdef PERL_PRESERVE_IVUV
6665 if (SvUVX(sv) == UV_MAX)
6666 sv_setnv(sv, UV_MAX_P1);
6668 (void)SvIOK_only_UV(sv);
6669 SvUV_set(sv, SvUVX(sv) + 1);
6671 if (SvIVX(sv) == IV_MAX)
6672 sv_setuv(sv, (UV)IV_MAX + 1);
6674 (void)SvIOK_only(sv);
6675 SvIV_set(sv, SvIVX(sv) + 1);
6680 if (flags & SVp_NOK) {
6681 (void)SvNOK_only(sv);
6682 SvNV_set(sv, SvNVX(sv) + 1.0);
6686 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6687 if ((flags & SVTYPEMASK) < SVt_PVIV)
6688 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6689 (void)SvIOK_only(sv);
6694 while (isALPHA(*d)) d++;
6695 while (isDIGIT(*d)) d++;
6697 #ifdef PERL_PRESERVE_IVUV
6698 /* Got to punt this as an integer if needs be, but we don't issue
6699 warnings. Probably ought to make the sv_iv_please() that does
6700 the conversion if possible, and silently. */
6701 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6702 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6703 /* Need to try really hard to see if it's an integer.
6704 9.22337203685478e+18 is an integer.
6705 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6706 so $a="9.22337203685478e+18"; $a+0; $a++
6707 needs to be the same as $a="9.22337203685478e+18"; $a++
6714 /* sv_2iv *should* have made this an NV */
6715 if (flags & SVp_NOK) {
6716 (void)SvNOK_only(sv);
6717 SvNV_set(sv, SvNVX(sv) + 1.0);
6720 /* I don't think we can get here. Maybe I should assert this
6721 And if we do get here I suspect that sv_setnv will croak. NWC
6723 #if defined(USE_LONG_DOUBLE)
6724 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",
6725 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6727 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6728 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6731 #endif /* PERL_PRESERVE_IVUV */
6732 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6736 while (d >= SvPVX_const(sv)) {
6744 /* MKS: The original code here died if letters weren't consecutive.
6745 * at least it didn't have to worry about non-C locales. The
6746 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6747 * arranged in order (although not consecutively) and that only
6748 * [A-Za-z] are accepted by isALPHA in the C locale.
6750 if (*d != 'z' && *d != 'Z') {
6751 do { ++*d; } while (!isALPHA(*d));
6754 *(d--) -= 'z' - 'a';
6759 *(d--) -= 'z' - 'a' + 1;
6763 /* oh,oh, the number grew */
6764 SvGROW(sv, SvCUR(sv) + 2);
6765 SvCUR_set(sv, SvCUR(sv) + 1);
6766 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6777 Auto-decrement of the value in the SV, doing string to numeric conversion
6778 if necessary. Handles 'get' magic.
6784 Perl_sv_dec(pTHX_ register SV *sv)
6792 if (SvTHINKFIRST(sv)) {
6794 sv_force_normal_flags(sv, 0);
6795 if (SvREADONLY(sv)) {
6796 if (IN_PERL_RUNTIME)
6797 Perl_croak(aTHX_ PL_no_modify);
6801 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6803 i = PTR2IV(SvRV(sv));
6808 /* Unlike sv_inc we don't have to worry about string-never-numbers
6809 and keeping them magic. But we mustn't warn on punting */
6810 flags = SvFLAGS(sv);
6811 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6812 /* It's publicly an integer, or privately an integer-not-float */
6813 #ifdef PERL_PRESERVE_IVUV
6817 if (SvUVX(sv) == 0) {
6818 (void)SvIOK_only(sv);
6822 (void)SvIOK_only_UV(sv);
6823 SvUV_set(sv, SvUVX(sv) - 1);
6826 if (SvIVX(sv) == IV_MIN)
6827 sv_setnv(sv, (NV)IV_MIN - 1.0);
6829 (void)SvIOK_only(sv);
6830 SvIV_set(sv, SvIVX(sv) - 1);
6835 if (flags & SVp_NOK) {
6836 SvNV_set(sv, SvNVX(sv) - 1.0);
6837 (void)SvNOK_only(sv);
6840 if (!(flags & SVp_POK)) {
6841 if ((flags & SVTYPEMASK) < SVt_PVIV)
6842 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6844 (void)SvIOK_only(sv);
6847 #ifdef PERL_PRESERVE_IVUV
6849 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6850 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6851 /* Need to try really hard to see if it's an integer.
6852 9.22337203685478e+18 is an integer.
6853 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6854 so $a="9.22337203685478e+18"; $a+0; $a--
6855 needs to be the same as $a="9.22337203685478e+18"; $a--
6862 /* sv_2iv *should* have made this an NV */
6863 if (flags & SVp_NOK) {
6864 (void)SvNOK_only(sv);
6865 SvNV_set(sv, SvNVX(sv) - 1.0);
6868 /* I don't think we can get here. Maybe I should assert this
6869 And if we do get here I suspect that sv_setnv will croak. NWC
6871 #if defined(USE_LONG_DOUBLE)
6872 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",
6873 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6875 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6876 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6880 #endif /* PERL_PRESERVE_IVUV */
6881 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6885 =for apidoc sv_mortalcopy
6887 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6888 The new SV is marked as mortal. It will be destroyed "soon", either by an
6889 explicit call to FREETMPS, or by an implicit call at places such as
6890 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6895 /* Make a string that will exist for the duration of the expression
6896 * evaluation. Actually, it may have to last longer than that, but
6897 * hopefully we won't free it until it has been assigned to a
6898 * permanent location. */
6901 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6907 sv_setsv(sv,oldstr);
6909 PL_tmps_stack[++PL_tmps_ix] = sv;
6915 =for apidoc sv_newmortal
6917 Creates a new null SV which is mortal. The reference count of the SV is
6918 set to 1. It will be destroyed "soon", either by an explicit call to
6919 FREETMPS, or by an implicit call at places such as statement boundaries.
6920 See also C<sv_mortalcopy> and C<sv_2mortal>.
6926 Perl_sv_newmortal(pTHX)
6932 SvFLAGS(sv) = SVs_TEMP;
6934 PL_tmps_stack[++PL_tmps_ix] = sv;
6939 =for apidoc sv_2mortal
6941 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6942 by an explicit call to FREETMPS, or by an implicit call at places such as
6943 statement boundaries. SvTEMP() is turned on which means that the SV's
6944 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6945 and C<sv_mortalcopy>.
6951 Perl_sv_2mortal(pTHX_ register SV *sv)
6956 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6959 PL_tmps_stack[++PL_tmps_ix] = sv;
6967 Creates a new SV and copies a string into it. The reference count for the
6968 SV is set to 1. If C<len> is zero, Perl will compute the length using
6969 strlen(). For efficiency, consider using C<newSVpvn> instead.
6975 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6981 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6986 =for apidoc newSVpvn
6988 Creates a new SV and copies a string into it. The reference count for the
6989 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6990 string. You are responsible for ensuring that the source string is at least
6991 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6997 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7003 sv_setpvn(sv,s,len);
7009 =for apidoc newSVhek
7011 Creates a new SV from the hash key structure. It will generate scalars that
7012 point to the shared string table where possible. Returns a new (undefined)
7013 SV if the hek is NULL.
7019 Perl_newSVhek(pTHX_ const HEK *hek)
7029 if (HEK_LEN(hek) == HEf_SVKEY) {
7030 return newSVsv(*(SV**)HEK_KEY(hek));
7032 const int flags = HEK_FLAGS(hek);
7033 if (flags & HVhek_WASUTF8) {
7035 Andreas would like keys he put in as utf8 to come back as utf8
7037 STRLEN utf8_len = HEK_LEN(hek);
7038 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7039 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7042 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7044 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7045 /* We don't have a pointer to the hv, so we have to replicate the
7046 flag into every HEK. This hv is using custom a hasing
7047 algorithm. Hence we can't return a shared string scalar, as
7048 that would contain the (wrong) hash value, and might get passed
7049 into an hv routine with a regular hash.
7050 Similarly, a hash that isn't using shared hash keys has to have
7051 the flag in every key so that we know not to try to call
7052 share_hek_kek on it. */
7054 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7059 /* This will be overwhelminly the most common case. */
7061 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7062 more efficient than sharepvn(). */
7066 sv_upgrade(sv, SVt_PV);
7067 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7068 SvCUR_set(sv, HEK_LEN(hek));
7081 =for apidoc newSVpvn_share
7083 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7084 table. If the string does not already exist in the table, it is created
7085 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7086 value is used; otherwise the hash is computed. The string's hash can be later
7087 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7088 that as the string table is used for shared hash keys these strings will have
7089 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7095 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7099 bool is_utf8 = FALSE;
7100 const char *const orig_src = src;
7103 STRLEN tmplen = -len;
7105 /* See the note in hv.c:hv_fetch() --jhi */
7106 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7110 PERL_HASH(hash, src, len);
7112 sv_upgrade(sv, SVt_PV);
7113 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7121 if (src != orig_src)
7127 #if defined(PERL_IMPLICIT_CONTEXT)
7129 /* pTHX_ magic can't cope with varargs, so this is a no-context
7130 * version of the main function, (which may itself be aliased to us).
7131 * Don't access this version directly.
7135 Perl_newSVpvf_nocontext(const char* pat, ...)
7140 va_start(args, pat);
7141 sv = vnewSVpvf(pat, &args);
7148 =for apidoc newSVpvf
7150 Creates a new SV and initializes it with the string formatted like
7157 Perl_newSVpvf(pTHX_ const char* pat, ...)
7161 va_start(args, pat);
7162 sv = vnewSVpvf(pat, &args);
7167 /* backend for newSVpvf() and newSVpvf_nocontext() */
7170 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7175 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7182 Creates a new SV and copies a floating point value into it.
7183 The reference count for the SV is set to 1.
7189 Perl_newSVnv(pTHX_ NV n)
7202 Creates a new SV and copies an integer into it. The reference count for the
7209 Perl_newSViv(pTHX_ IV i)
7222 Creates a new SV and copies an unsigned integer into it.
7223 The reference count for the SV is set to 1.
7229 Perl_newSVuv(pTHX_ UV u)
7240 =for apidoc newSV_type
7242 Creates a new SV, of the type specified. The reference count for the new SV
7249 Perl_newSV_type(pTHX_ svtype type)
7254 sv_upgrade(sv, type);
7259 =for apidoc newRV_noinc
7261 Creates an RV wrapper for an SV. The reference count for the original
7262 SV is B<not> incremented.
7268 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7271 register SV *sv = newSV_type(SVt_RV);
7273 SvRV_set(sv, tmpRef);
7278 /* newRV_inc is the official function name to use now.
7279 * newRV_inc is in fact #defined to newRV in sv.h
7283 Perl_newRV(pTHX_ SV *sv)
7286 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7292 Creates a new SV which is an exact duplicate of the original SV.
7299 Perl_newSVsv(pTHX_ register SV *old)
7306 if (SvTYPE(old) == SVTYPEMASK) {
7307 if (ckWARN_d(WARN_INTERNAL))
7308 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7312 /* SV_GMAGIC is the default for sv_setv()
7313 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7314 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7315 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7320 =for apidoc sv_reset
7322 Underlying implementation for the C<reset> Perl function.
7323 Note that the perl-level function is vaguely deprecated.
7329 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7332 char todo[PERL_UCHAR_MAX+1];
7337 if (!*s) { /* reset ?? searches */
7338 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7340 const U32 count = mg->mg_len / sizeof(PMOP**);
7341 PMOP **pmp = (PMOP**) mg->mg_ptr;
7342 PMOP *const *const end = pmp + count;
7346 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7348 (*pmp)->op_pmflags &= ~PMf_USED;
7356 /* reset variables */
7358 if (!HvARRAY(stash))
7361 Zero(todo, 256, char);
7364 I32 i = (unsigned char)*s;
7368 max = (unsigned char)*s++;
7369 for ( ; i <= max; i++) {
7372 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7374 for (entry = HvARRAY(stash)[i];
7376 entry = HeNEXT(entry))
7381 if (!todo[(U8)*HeKEY(entry)])
7383 gv = (GV*)HeVAL(entry);
7386 if (SvTHINKFIRST(sv)) {
7387 if (!SvREADONLY(sv) && SvROK(sv))
7389 /* XXX Is this continue a bug? Why should THINKFIRST
7390 exempt us from resetting arrays and hashes? */
7394 if (SvTYPE(sv) >= SVt_PV) {
7396 if (SvPVX_const(sv) != NULL)
7404 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7406 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7409 # if defined(USE_ENVIRON_ARRAY)
7412 # endif /* USE_ENVIRON_ARRAY */
7423 Using various gambits, try to get an IO from an SV: the IO slot if its a
7424 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7425 named after the PV if we're a string.
7431 Perl_sv_2io(pTHX_ SV *sv)
7436 switch (SvTYPE(sv)) {
7444 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7448 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7450 return sv_2io(SvRV(sv));
7451 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7457 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7466 Using various gambits, try to get a CV from an SV; in addition, try if
7467 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7468 The flags in C<lref> are passed to sv_fetchsv.
7474 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7485 switch (SvTYPE(sv)) {
7504 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7505 tryAMAGICunDEREF(to_cv);
7508 if (SvTYPE(sv) == SVt_PVCV) {
7517 Perl_croak(aTHX_ "Not a subroutine reference");
7522 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7528 /* Some flags to gv_fetchsv mean don't really create the GV */
7529 if (SvTYPE(gv) != SVt_PVGV) {
7535 if (lref && !GvCVu(gv)) {
7539 gv_efullname3(tmpsv, gv, NULL);
7540 /* XXX this is probably not what they think they're getting.
7541 * It has the same effect as "sub name;", i.e. just a forward
7543 newSUB(start_subparse(FALSE, 0),
7544 newSVOP(OP_CONST, 0, tmpsv),
7548 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7558 Returns true if the SV has a true value by Perl's rules.
7559 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7560 instead use an in-line version.
7566 Perl_sv_true(pTHX_ register SV *sv)
7571 register const XPV* const tXpv = (XPV*)SvANY(sv);
7573 (tXpv->xpv_cur > 1 ||
7574 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7581 return SvIVX(sv) != 0;
7584 return SvNVX(sv) != 0.0;
7586 return sv_2bool(sv);
7592 =for apidoc sv_pvn_force
7594 Get a sensible string out of the SV somehow.
7595 A private implementation of the C<SvPV_force> macro for compilers which
7596 can't cope with complex macro expressions. Always use the macro instead.
7598 =for apidoc sv_pvn_force_flags
7600 Get a sensible string out of the SV somehow.
7601 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7602 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7603 implemented in terms of this function.
7604 You normally want to use the various wrapper macros instead: see
7605 C<SvPV_force> and C<SvPV_force_nomg>
7611 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7614 if (SvTHINKFIRST(sv) && !SvROK(sv))
7615 sv_force_normal_flags(sv, 0);
7625 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7626 const char * const ref = sv_reftype(sv,0);
7628 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7629 ref, OP_NAME(PL_op));
7631 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7633 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7634 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7636 s = sv_2pv_flags(sv, &len, flags);
7640 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7643 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7644 SvGROW(sv, len + 1);
7645 Move(s,SvPVX(sv),len,char);
7647 SvPVX(sv)[len] = '\0';
7650 SvPOK_on(sv); /* validate pointer */
7652 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7653 PTR2UV(sv),SvPVX_const(sv)));
7656 return SvPVX_mutable(sv);
7660 =for apidoc sv_pvbyten_force
7662 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7668 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7670 sv_pvn_force(sv,lp);
7671 sv_utf8_downgrade(sv,0);
7677 =for apidoc sv_pvutf8n_force
7679 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7685 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7687 sv_pvn_force(sv,lp);
7688 sv_utf8_upgrade(sv);
7694 =for apidoc sv_reftype
7696 Returns a string describing what the SV is a reference to.
7702 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7704 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7705 inside return suggests a const propagation bug in g++. */
7706 if (ob && SvOBJECT(sv)) {
7707 char * const name = HvNAME_get(SvSTASH(sv));
7708 return name ? name : (char *) "__ANON__";
7711 switch (SvTYPE(sv)) {
7727 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7728 /* tied lvalues should appear to be
7729 * scalars for backwards compatitbility */
7730 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7731 ? "SCALAR" : "LVALUE");
7732 case SVt_PVAV: return "ARRAY";
7733 case SVt_PVHV: return "HASH";
7734 case SVt_PVCV: return "CODE";
7735 case SVt_PVGV: return "GLOB";
7736 case SVt_PVFM: return "FORMAT";
7737 case SVt_PVIO: return "IO";
7738 case SVt_BIND: return "BIND";
7739 default: return "UNKNOWN";
7745 =for apidoc sv_isobject
7747 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7748 object. If the SV is not an RV, or if the object is not blessed, then this
7755 Perl_sv_isobject(pTHX_ SV *sv)
7771 Returns a boolean indicating whether the SV is blessed into the specified
7772 class. This does not check for subtypes; use C<sv_derived_from> to verify
7773 an inheritance relationship.
7779 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7790 hvname = HvNAME_get(SvSTASH(sv));
7794 return strEQ(hvname, name);
7800 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7801 it will be upgraded to one. If C<classname> is non-null then the new SV will
7802 be blessed in the specified package. The new SV is returned and its
7803 reference count is 1.
7809 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7816 SV_CHECK_THINKFIRST_COW_DROP(rv);
7817 (void)SvAMAGIC_off(rv);
7819 if (SvTYPE(rv) >= SVt_PVMG) {
7820 const U32 refcnt = SvREFCNT(rv);
7824 SvREFCNT(rv) = refcnt;
7826 sv_upgrade(rv, SVt_RV);
7827 } else if (SvROK(rv)) {
7828 SvREFCNT_dec(SvRV(rv));
7829 } else if (SvTYPE(rv) < SVt_RV)
7830 sv_upgrade(rv, SVt_RV);
7831 else if (SvTYPE(rv) > SVt_RV) {
7842 HV* const stash = gv_stashpv(classname, GV_ADD);
7843 (void)sv_bless(rv, stash);
7849 =for apidoc sv_setref_pv
7851 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7852 argument will be upgraded to an RV. That RV will be modified to point to
7853 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7854 into the SV. The C<classname> argument indicates the package for the
7855 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7856 will have a reference count of 1, and the RV will be returned.
7858 Do not use with other Perl types such as HV, AV, SV, CV, because those
7859 objects will become corrupted by the pointer copy process.
7861 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7867 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7871 sv_setsv(rv, &PL_sv_undef);
7875 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7880 =for apidoc sv_setref_iv
7882 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7883 argument will be upgraded to an RV. That RV will be modified to point to
7884 the new SV. The C<classname> argument indicates the package for the
7885 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7886 will have a reference count of 1, and the RV will be returned.
7892 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7894 sv_setiv(newSVrv(rv,classname), iv);
7899 =for apidoc sv_setref_uv
7901 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7902 argument will be upgraded to an RV. That RV will be modified to point to
7903 the new SV. The C<classname> argument indicates the package for the
7904 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7905 will have a reference count of 1, and the RV will be returned.
7911 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7913 sv_setuv(newSVrv(rv,classname), uv);
7918 =for apidoc sv_setref_nv
7920 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7921 argument will be upgraded to an RV. That RV will be modified to point to
7922 the new SV. The C<classname> argument indicates the package for the
7923 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7924 will have a reference count of 1, and the RV will be returned.
7930 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7932 sv_setnv(newSVrv(rv,classname), nv);
7937 =for apidoc sv_setref_pvn
7939 Copies a string into a new SV, optionally blessing the SV. The length of the
7940 string must be specified with C<n>. The C<rv> argument will be upgraded to
7941 an RV. That RV will be modified to point to the new SV. The C<classname>
7942 argument indicates the package for the blessing. Set C<classname> to
7943 C<NULL> to avoid the blessing. The new SV will have a reference count
7944 of 1, and the RV will be returned.
7946 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7952 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7954 sv_setpvn(newSVrv(rv,classname), pv, n);
7959 =for apidoc sv_bless
7961 Blesses an SV into a specified package. The SV must be an RV. The package
7962 must be designated by its stash (see C<gv_stashpv()>). The reference count
7963 of the SV is unaffected.
7969 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7974 Perl_croak(aTHX_ "Can't bless non-reference value");
7976 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7977 if (SvREADONLY(tmpRef))
7978 Perl_croak(aTHX_ PL_no_modify);
7979 if (SvOBJECT(tmpRef)) {
7980 if (SvTYPE(tmpRef) != SVt_PVIO)
7982 SvREFCNT_dec(SvSTASH(tmpRef));
7985 SvOBJECT_on(tmpRef);
7986 if (SvTYPE(tmpRef) != SVt_PVIO)
7988 SvUPGRADE(tmpRef, SVt_PVMG);
7989 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7994 (void)SvAMAGIC_off(sv);
7996 if(SvSMAGICAL(tmpRef))
7997 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8005 /* Downgrades a PVGV to a PVMG.
8009 S_sv_unglob(pTHX_ SV *sv)
8014 SV * const temp = sv_newmortal();
8016 assert(SvTYPE(sv) == SVt_PVGV);
8018 gv_efullname3(temp, (GV *) sv, "*");
8021 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8022 mro_method_changed_in(stash);
8026 sv_del_backref((SV*)GvSTASH(sv), sv);
8030 if (GvNAME_HEK(sv)) {
8031 unshare_hek(GvNAME_HEK(sv));
8033 isGV_with_GP_off(sv);
8035 /* need to keep SvANY(sv) in the right arena */
8036 xpvmg = new_XPVMG();
8037 StructCopy(SvANY(sv), xpvmg, XPVMG);
8038 del_XPVGV(SvANY(sv));
8041 SvFLAGS(sv) &= ~SVTYPEMASK;
8042 SvFLAGS(sv) |= SVt_PVMG;
8044 /* Intentionally not calling any local SET magic, as this isn't so much a
8045 set operation as merely an internal storage change. */
8046 sv_setsv_flags(sv, temp, 0);
8050 =for apidoc sv_unref_flags
8052 Unsets the RV status of the SV, and decrements the reference count of
8053 whatever was being referenced by the RV. This can almost be thought of
8054 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8055 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8056 (otherwise the decrementing is conditional on the reference count being
8057 different from one or the reference being a readonly SV).
8064 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8066 SV* const target = SvRV(ref);
8068 if (SvWEAKREF(ref)) {
8069 sv_del_backref(target, ref);
8071 SvRV_set(ref, NULL);
8074 SvRV_set(ref, NULL);
8076 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8077 assigned to as BEGIN {$a = \"Foo"} will fail. */
8078 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8079 SvREFCNT_dec(target);
8080 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8081 sv_2mortal(target); /* Schedule for freeing later */
8085 =for apidoc sv_untaint
8087 Untaint an SV. Use C<SvTAINTED_off> instead.
8092 Perl_sv_untaint(pTHX_ SV *sv)
8094 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8095 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8102 =for apidoc sv_tainted
8104 Test an SV for taintedness. Use C<SvTAINTED> instead.
8109 Perl_sv_tainted(pTHX_ SV *sv)
8111 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8112 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8113 if (mg && (mg->mg_len & 1) )
8120 =for apidoc sv_setpviv
8122 Copies an integer into the given SV, also updating its string value.
8123 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8129 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8131 char buf[TYPE_CHARS(UV)];
8133 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8135 sv_setpvn(sv, ptr, ebuf - ptr);
8139 =for apidoc sv_setpviv_mg
8141 Like C<sv_setpviv>, but also handles 'set' magic.
8147 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8153 #if defined(PERL_IMPLICIT_CONTEXT)
8155 /* pTHX_ magic can't cope with varargs, so this is a no-context
8156 * version of the main function, (which may itself be aliased to us).
8157 * Don't access this version directly.
8161 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8165 va_start(args, pat);
8166 sv_vsetpvf(sv, pat, &args);
8170 /* pTHX_ magic can't cope with varargs, so this is a no-context
8171 * version of the main function, (which may itself be aliased to us).
8172 * Don't access this version directly.
8176 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8180 va_start(args, pat);
8181 sv_vsetpvf_mg(sv, pat, &args);
8187 =for apidoc sv_setpvf
8189 Works like C<sv_catpvf> but copies the text into the SV instead of
8190 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8196 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8199 va_start(args, pat);
8200 sv_vsetpvf(sv, pat, &args);
8205 =for apidoc sv_vsetpvf
8207 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8208 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8210 Usually used via its frontend C<sv_setpvf>.
8216 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8218 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8222 =for apidoc sv_setpvf_mg
8224 Like C<sv_setpvf>, but also handles 'set' magic.
8230 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8233 va_start(args, pat);
8234 sv_vsetpvf_mg(sv, pat, &args);
8239 =for apidoc sv_vsetpvf_mg
8241 Like C<sv_vsetpvf>, but also handles 'set' magic.
8243 Usually used via its frontend C<sv_setpvf_mg>.
8249 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8251 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8255 #if defined(PERL_IMPLICIT_CONTEXT)
8257 /* pTHX_ magic can't cope with varargs, so this is a no-context
8258 * version of the main function, (which may itself be aliased to us).
8259 * Don't access this version directly.
8263 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8267 va_start(args, pat);
8268 sv_vcatpvf(sv, pat, &args);
8272 /* pTHX_ magic can't cope with varargs, so this is a no-context
8273 * version of the main function, (which may itself be aliased to us).
8274 * Don't access this version directly.
8278 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8282 va_start(args, pat);
8283 sv_vcatpvf_mg(sv, pat, &args);
8289 =for apidoc sv_catpvf
8291 Processes its arguments like C<sprintf> and appends the formatted
8292 output to an SV. If the appended data contains "wide" characters
8293 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8294 and characters >255 formatted with %c), the original SV might get
8295 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8296 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8297 valid UTF-8; if the original SV was bytes, the pattern should be too.
8302 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8305 va_start(args, pat);
8306 sv_vcatpvf(sv, pat, &args);
8311 =for apidoc sv_vcatpvf
8313 Processes its arguments like C<vsprintf> and appends the formatted output
8314 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8316 Usually used via its frontend C<sv_catpvf>.
8322 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8324 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8328 =for apidoc sv_catpvf_mg
8330 Like C<sv_catpvf>, but also handles 'set' magic.
8336 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8339 va_start(args, pat);
8340 sv_vcatpvf_mg(sv, pat, &args);
8345 =for apidoc sv_vcatpvf_mg
8347 Like C<sv_vcatpvf>, but also handles 'set' magic.
8349 Usually used via its frontend C<sv_catpvf_mg>.
8355 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8357 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8362 =for apidoc sv_vsetpvfn
8364 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8367 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8373 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8375 sv_setpvn(sv, "", 0);
8376 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8380 S_expect_number(pTHX_ char** pattern)
8384 switch (**pattern) {
8385 case '1': case '2': case '3':
8386 case '4': case '5': case '6':
8387 case '7': case '8': case '9':
8388 var = *(*pattern)++ - '0';
8389 while (isDIGIT(**pattern)) {
8390 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8392 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8400 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8402 const int neg = nv < 0;
8411 if (uv & 1 && uv == nv)
8412 uv--; /* Round to even */
8414 const unsigned dig = uv % 10;
8427 =for apidoc sv_vcatpvfn
8429 Processes its arguments like C<vsprintf> and appends the formatted output
8430 to an SV. Uses an array of SVs if the C style variable argument list is
8431 missing (NULL). When running with taint checks enabled, indicates via
8432 C<maybe_tainted> if results are untrustworthy (often due to the use of
8435 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8441 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8442 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8443 vec_utf8 = DO_UTF8(vecsv);
8445 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8448 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8456 static const char nullstr[] = "(null)";
8458 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8459 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8461 /* Times 4: a decimal digit takes more than 3 binary digits.
8462 * NV_DIG: mantissa takes than many decimal digits.
8463 * Plus 32: Playing safe. */
8464 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8465 /* large enough for "%#.#f" --chip */
8466 /* what about long double NVs? --jhi */
8468 PERL_UNUSED_ARG(maybe_tainted);
8470 /* no matter what, this is a string now */
8471 (void)SvPV_force(sv, origlen);
8473 /* special-case "", "%s", and "%-p" (SVf - see below) */
8476 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8478 const char * const s = va_arg(*args, char*);
8479 sv_catpv(sv, s ? s : nullstr);
8481 else if (svix < svmax) {
8482 sv_catsv(sv, *svargs);
8486 if (args && patlen == 3 && pat[0] == '%' &&
8487 pat[1] == '-' && pat[2] == 'p') {
8488 argsv = (SV*)va_arg(*args, void*);
8489 sv_catsv(sv, argsv);
8493 #ifndef USE_LONG_DOUBLE
8494 /* special-case "%.<number>[gf]" */
8495 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8496 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8497 unsigned digits = 0;
8501 while (*pp >= '0' && *pp <= '9')
8502 digits = 10 * digits + (*pp++ - '0');
8503 if (pp - pat == (int)patlen - 1) {
8511 /* Add check for digits != 0 because it seems that some
8512 gconverts are buggy in this case, and we don't yet have
8513 a Configure test for this. */
8514 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8515 /* 0, point, slack */
8516 Gconvert(nv, (int)digits, 0, ebuf);
8518 if (*ebuf) /* May return an empty string for digits==0 */
8521 } else if (!digits) {
8524 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8525 sv_catpvn(sv, p, l);
8531 #endif /* !USE_LONG_DOUBLE */
8533 if (!args && svix < svmax && DO_UTF8(*svargs))
8536 patend = (char*)pat + patlen;
8537 for (p = (char*)pat; p < patend; p = q) {
8540 bool vectorize = FALSE;
8541 bool vectorarg = FALSE;
8542 bool vec_utf8 = FALSE;
8548 bool has_precis = FALSE;
8550 const I32 osvix = svix;
8551 bool is_utf8 = FALSE; /* is this item utf8? */
8552 #ifdef HAS_LDBL_SPRINTF_BUG
8553 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8554 with sfio - Allen <allens@cpan.org> */
8555 bool fix_ldbl_sprintf_bug = FALSE;
8559 U8 utf8buf[UTF8_MAXBYTES+1];
8560 STRLEN esignlen = 0;
8562 const char *eptr = NULL;
8565 const U8 *vecstr = NULL;
8572 /* we need a long double target in case HAS_LONG_DOUBLE but
8575 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8583 const char *dotstr = ".";
8584 STRLEN dotstrlen = 1;
8585 I32 efix = 0; /* explicit format parameter index */
8586 I32 ewix = 0; /* explicit width index */
8587 I32 epix = 0; /* explicit precision index */
8588 I32 evix = 0; /* explicit vector index */
8589 bool asterisk = FALSE;
8591 /* echo everything up to the next format specification */
8592 for (q = p; q < patend && *q != '%'; ++q) ;
8594 if (has_utf8 && !pat_utf8)
8595 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8597 sv_catpvn(sv, p, q - p);
8604 We allow format specification elements in this order:
8605 \d+\$ explicit format parameter index
8607 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8608 0 flag (as above): repeated to allow "v02"
8609 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8610 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8612 [%bcdefginopsuxDFOUX] format (mandatory)
8617 As of perl5.9.3, printf format checking is on by default.
8618 Internally, perl uses %p formats to provide an escape to
8619 some extended formatting. This block deals with those
8620 extensions: if it does not match, (char*)q is reset and
8621 the normal format processing code is used.
8623 Currently defined extensions are:
8624 %p include pointer address (standard)
8625 %-p (SVf) include an SV (previously %_)
8626 %-<num>p include an SV with precision <num>
8627 %1p (VDf) include a v-string (as %vd)
8628 %<num>p reserved for future extensions
8630 Robin Barker 2005-07-14
8637 n = expect_number(&q);
8644 argsv = (SV*)va_arg(*args, void*);
8645 eptr = SvPV_const(argsv, elen);
8651 else if (n == vdNUMBER) { /* VDf */
8658 if (ckWARN_d(WARN_INTERNAL))
8659 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8660 "internal %%<num>p might conflict with future printf extensions");
8666 if ( (width = expect_number(&q)) ) {
8681 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8710 if ( (ewix = expect_number(&q)) )
8719 if ((vectorarg = asterisk)) {
8732 width = expect_number(&q);
8738 vecsv = va_arg(*args, SV*);
8740 vecsv = (evix > 0 && evix <= svmax)
8741 ? svargs[evix-1] : &PL_sv_undef;
8743 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8745 dotstr = SvPV_const(vecsv, dotstrlen);
8746 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8747 bad with tied or overloaded values that return UTF8. */
8750 else if (has_utf8) {
8751 vecsv = sv_mortalcopy(vecsv);
8752 sv_utf8_upgrade(vecsv);
8753 dotstr = SvPV_const(vecsv, dotstrlen);
8760 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8761 vecsv = svargs[efix ? efix-1 : svix++];
8762 vecstr = (U8*)SvPV_const(vecsv,veclen);
8763 vec_utf8 = DO_UTF8(vecsv);
8765 /* if this is a version object, we need to convert
8766 * back into v-string notation and then let the
8767 * vectorize happen normally
8769 if (sv_derived_from(vecsv, "version")) {
8770 char *version = savesvpv(vecsv);
8771 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8772 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8773 "vector argument not supported with alpha versions");
8776 vecsv = sv_newmortal();
8777 scan_vstring(version, version + veclen, vecsv);
8778 vecstr = (U8*)SvPV_const(vecsv, veclen);
8779 vec_utf8 = DO_UTF8(vecsv);
8791 i = va_arg(*args, int);
8793 i = (ewix ? ewix <= svmax : svix < svmax) ?
8794 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8796 width = (i < 0) ? -i : i;
8806 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8808 /* XXX: todo, support specified precision parameter */
8812 i = va_arg(*args, int);
8814 i = (ewix ? ewix <= svmax : svix < svmax)
8815 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8817 has_precis = !(i < 0);
8822 precis = precis * 10 + (*q++ - '0');
8831 case 'I': /* Ix, I32x, and I64x */
8833 if (q[1] == '6' && q[2] == '4') {
8839 if (q[1] == '3' && q[2] == '2') {
8849 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8860 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8861 if (*(q + 1) == 'l') { /* lld, llf */
8887 if (!vectorize && !args) {
8889 const I32 i = efix-1;
8890 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8892 argsv = (svix >= 0 && svix < svmax)
8893 ? svargs[svix++] : &PL_sv_undef;
8904 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8906 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8908 eptr = (char*)utf8buf;
8909 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8923 eptr = va_arg(*args, char*);
8925 #ifdef MACOS_TRADITIONAL
8926 /* On MacOS, %#s format is used for Pascal strings */
8931 elen = strlen(eptr);
8933 eptr = (char *)nullstr;
8934 elen = sizeof nullstr - 1;
8938 eptr = SvPV_const(argsv, elen);
8939 if (DO_UTF8(argsv)) {
8940 I32 old_precis = precis;
8941 if (has_precis && precis < elen) {
8943 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8946 if (width) { /* fudge width (can't fudge elen) */
8947 if (has_precis && precis < elen)
8948 width += precis - old_precis;
8950 width += elen - sv_len_utf8(argsv);
8957 if (has_precis && elen > precis)
8964 if (alt || vectorize)
8966 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8987 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8996 esignbuf[esignlen++] = plus;
9000 case 'h': iv = (short)va_arg(*args, int); break;
9001 case 'l': iv = va_arg(*args, long); break;
9002 case 'V': iv = va_arg(*args, IV); break;
9003 default: iv = va_arg(*args, int); break;
9005 case 'q': iv = va_arg(*args, Quad_t); break;
9010 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9012 case 'h': iv = (short)tiv; break;
9013 case 'l': iv = (long)tiv; break;
9015 default: iv = tiv; break;
9017 case 'q': iv = (Quad_t)tiv; break;
9021 if ( !vectorize ) /* we already set uv above */
9026 esignbuf[esignlen++] = plus;
9030 esignbuf[esignlen++] = '-';
9074 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9085 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9086 case 'l': uv = va_arg(*args, unsigned long); break;
9087 case 'V': uv = va_arg(*args, UV); break;
9088 default: uv = va_arg(*args, unsigned); break;
9090 case 'q': uv = va_arg(*args, Uquad_t); break;
9095 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9097 case 'h': uv = (unsigned short)tuv; break;
9098 case 'l': uv = (unsigned long)tuv; break;
9100 default: uv = tuv; break;
9102 case 'q': uv = (Uquad_t)tuv; break;
9109 char *ptr = ebuf + sizeof ebuf;
9110 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9116 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9122 esignbuf[esignlen++] = '0';
9123 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9131 if (alt && *ptr != '0')
9140 esignbuf[esignlen++] = '0';
9141 esignbuf[esignlen++] = c;
9144 default: /* it had better be ten or less */
9148 } while (uv /= base);
9151 elen = (ebuf + sizeof ebuf) - ptr;
9155 zeros = precis - elen;
9156 else if (precis == 0 && elen == 1 && *eptr == '0'
9157 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9160 /* a precision nullifies the 0 flag. */
9167 /* FLOATING POINT */
9170 c = 'f'; /* maybe %F isn't supported here */
9178 /* This is evil, but floating point is even more evil */
9180 /* for SV-style calling, we can only get NV
9181 for C-style calling, we assume %f is double;
9182 for simplicity we allow any of %Lf, %llf, %qf for long double
9186 #if defined(USE_LONG_DOUBLE)
9190 /* [perl #20339] - we should accept and ignore %lf rather than die */
9194 #if defined(USE_LONG_DOUBLE)
9195 intsize = args ? 0 : 'q';
9199 #if defined(HAS_LONG_DOUBLE)
9208 /* now we need (long double) if intsize == 'q', else (double) */
9210 #if LONG_DOUBLESIZE > DOUBLESIZE
9212 va_arg(*args, long double) :
9213 va_arg(*args, double)
9215 va_arg(*args, double)
9220 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9221 else. frexp() has some unspecified behaviour for those three */
9222 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9224 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9225 will cast our (long double) to (double) */
9226 (void)Perl_frexp(nv, &i);
9227 if (i == PERL_INT_MIN)
9228 Perl_die(aTHX_ "panic: frexp");
9230 need = BIT_DIGITS(i);
9232 need += has_precis ? precis : 6; /* known default */
9237 #ifdef HAS_LDBL_SPRINTF_BUG
9238 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9239 with sfio - Allen <allens@cpan.org> */
9242 # define MY_DBL_MAX DBL_MAX
9243 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9244 # if DOUBLESIZE >= 8
9245 # define MY_DBL_MAX 1.7976931348623157E+308L
9247 # define MY_DBL_MAX 3.40282347E+38L
9251 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9252 # define MY_DBL_MAX_BUG 1L
9254 # define MY_DBL_MAX_BUG MY_DBL_MAX
9258 # define MY_DBL_MIN DBL_MIN
9259 # else /* XXX guessing! -Allen */
9260 # if DOUBLESIZE >= 8
9261 # define MY_DBL_MIN 2.2250738585072014E-308L
9263 # define MY_DBL_MIN 1.17549435E-38L
9267 if ((intsize == 'q') && (c == 'f') &&
9268 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9270 /* it's going to be short enough that
9271 * long double precision is not needed */
9273 if ((nv <= 0L) && (nv >= -0L))
9274 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9276 /* would use Perl_fp_class as a double-check but not
9277 * functional on IRIX - see perl.h comments */
9279 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9280 /* It's within the range that a double can represent */
9281 #if defined(DBL_MAX) && !defined(DBL_MIN)
9282 if ((nv >= ((long double)1/DBL_MAX)) ||
9283 (nv <= (-(long double)1/DBL_MAX)))
9285 fix_ldbl_sprintf_bug = TRUE;
9288 if (fix_ldbl_sprintf_bug == TRUE) {
9298 # undef MY_DBL_MAX_BUG
9301 #endif /* HAS_LDBL_SPRINTF_BUG */
9303 need += 20; /* fudge factor */
9304 if (PL_efloatsize < need) {
9305 Safefree(PL_efloatbuf);
9306 PL_efloatsize = need + 20; /* more fudge */
9307 Newx(PL_efloatbuf, PL_efloatsize, char);
9308 PL_efloatbuf[0] = '\0';
9311 if ( !(width || left || plus || alt) && fill != '0'
9312 && has_precis && intsize != 'q' ) { /* Shortcuts */
9313 /* See earlier comment about buggy Gconvert when digits,
9315 if ( c == 'g' && precis) {
9316 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9317 /* May return an empty string for digits==0 */
9318 if (*PL_efloatbuf) {
9319 elen = strlen(PL_efloatbuf);
9320 goto float_converted;
9322 } else if ( c == 'f' && !precis) {
9323 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9328 char *ptr = ebuf + sizeof ebuf;
9331 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9332 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9333 if (intsize == 'q') {
9334 /* Copy the one or more characters in a long double
9335 * format before the 'base' ([efgEFG]) character to
9336 * the format string. */
9337 static char const prifldbl[] = PERL_PRIfldbl;
9338 char const *p = prifldbl + sizeof(prifldbl) - 3;
9339 while (p >= prifldbl) { *--ptr = *p--; }
9344 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9349 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9361 /* No taint. Otherwise we are in the strange situation
9362 * where printf() taints but print($float) doesn't.
9364 #if defined(HAS_LONG_DOUBLE)
9365 elen = ((intsize == 'q')
9366 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9367 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9369 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9373 eptr = PL_efloatbuf;
9381 i = SvCUR(sv) - origlen;
9384 case 'h': *(va_arg(*args, short*)) = i; break;
9385 default: *(va_arg(*args, int*)) = i; break;
9386 case 'l': *(va_arg(*args, long*)) = i; break;
9387 case 'V': *(va_arg(*args, IV*)) = i; break;
9389 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9394 sv_setuv_mg(argsv, (UV)i);
9395 continue; /* not "break" */
9402 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9403 && ckWARN(WARN_PRINTF))
9405 SV * const msg = sv_newmortal();
9406 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9407 (PL_op->op_type == OP_PRTF) ? "" : "s");
9410 Perl_sv_catpvf(aTHX_ msg,
9411 "\"%%%c\"", c & 0xFF);
9413 Perl_sv_catpvf(aTHX_ msg,
9414 "\"%%\\%03"UVof"\"",
9417 sv_catpvs(msg, "end of string");
9418 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9421 /* output mangled stuff ... */
9427 /* ... right here, because formatting flags should not apply */
9428 SvGROW(sv, SvCUR(sv) + elen + 1);
9430 Copy(eptr, p, elen, char);
9433 SvCUR_set(sv, p - SvPVX_const(sv));
9435 continue; /* not "break" */
9438 if (is_utf8 != has_utf8) {
9441 sv_utf8_upgrade(sv);
9444 const STRLEN old_elen = elen;
9445 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9446 sv_utf8_upgrade(nsv);
9447 eptr = SvPVX_const(nsv);
9450 if (width) { /* fudge width (can't fudge elen) */
9451 width += elen - old_elen;
9457 have = esignlen + zeros + elen;
9459 Perl_croak_nocontext(PL_memory_wrap);
9461 need = (have > width ? have : width);
9464 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9465 Perl_croak_nocontext(PL_memory_wrap);
9466 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9468 if (esignlen && fill == '0') {
9470 for (i = 0; i < (int)esignlen; i++)
9474 memset(p, fill, gap);
9477 if (esignlen && fill != '0') {
9479 for (i = 0; i < (int)esignlen; i++)
9484 for (i = zeros; i; i--)
9488 Copy(eptr, p, elen, char);
9492 memset(p, ' ', gap);
9497 Copy(dotstr, p, dotstrlen, char);
9501 vectorize = FALSE; /* done iterating over vecstr */
9508 SvCUR_set(sv, p - SvPVX_const(sv));
9516 /* =========================================================================
9518 =head1 Cloning an interpreter
9520 All the macros and functions in this section are for the private use of
9521 the main function, perl_clone().
9523 The foo_dup() functions make an exact copy of an existing foo thingy.
9524 During the course of a cloning, a hash table is used to map old addresses
9525 to new addresses. The table is created and manipulated with the
9526 ptr_table_* functions.
9530 ============================================================================*/
9533 #if defined(USE_ITHREADS)
9535 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9536 #ifndef GpREFCNT_inc
9537 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9541 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9542 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9543 If this changes, please unmerge ss_dup. */
9544 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9545 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9546 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9547 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9548 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9549 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9550 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9551 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9552 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9553 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9554 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9555 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9556 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9557 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9559 /* clone a parser */
9562 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9569 /* look for it in the table first */
9570 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9574 /* create anew and remember what it is */
9575 Newxz(parser, 1, yy_parser);
9576 ptr_table_store(PL_ptr_table, proto, parser);
9578 parser->yyerrstatus = 0;
9579 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9581 /* XXX these not yet duped */
9582 parser->old_parser = NULL;
9583 parser->stack = NULL;
9585 parser->stack_size = 0;
9586 /* XXX parser->stack->state = 0; */
9588 /* XXX eventually, just Copy() most of the parser struct ? */
9590 parser->lex_brackets = proto->lex_brackets;
9591 parser->lex_casemods = proto->lex_casemods;
9592 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9593 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9594 parser->lex_casestack = savepvn(proto->lex_casestack,
9595 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9596 parser->lex_defer = proto->lex_defer;
9597 parser->lex_dojoin = proto->lex_dojoin;
9598 parser->lex_expect = proto->lex_expect;
9599 parser->lex_formbrack = proto->lex_formbrack;
9600 parser->lex_inpat = proto->lex_inpat;
9601 parser->lex_inwhat = proto->lex_inwhat;
9602 parser->lex_op = proto->lex_op;
9603 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9604 parser->lex_starts = proto->lex_starts;
9605 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9606 parser->multi_close = proto->multi_close;
9607 parser->multi_open = proto->multi_open;
9608 parser->multi_start = proto->multi_start;
9609 parser->multi_end = proto->multi_end;
9610 parser->pending_ident = proto->pending_ident;
9611 parser->preambled = proto->preambled;
9612 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9613 parser->linestr = sv_dup_inc(proto->linestr, param);
9614 parser->expect = proto->expect;
9615 parser->copline = proto->copline;
9616 parser->last_lop_op = proto->last_lop_op;
9617 parser->lex_state = proto->lex_state;
9618 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9619 /* rsfp_filters entries have fake IoDIRP() */
9620 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9621 parser->in_my = proto->in_my;
9622 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9623 parser->error_count = proto->error_count;
9626 parser->linestr = sv_dup_inc(proto->linestr, param);
9629 char * const ols = SvPVX(proto->linestr);
9630 char * const ls = SvPVX(parser->linestr);
9632 parser->bufptr = ls + (proto->bufptr >= ols ?
9633 proto->bufptr - ols : 0);
9634 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9635 proto->oldbufptr - ols : 0);
9636 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9637 proto->oldoldbufptr - ols : 0);
9638 parser->linestart = ls + (proto->linestart >= ols ?
9639 proto->linestart - ols : 0);
9640 parser->last_uni = ls + (proto->last_uni >= ols ?
9641 proto->last_uni - ols : 0);
9642 parser->last_lop = ls + (proto->last_lop >= ols ?
9643 proto->last_lop - ols : 0);
9645 parser->bufend = ls + SvCUR(parser->linestr);
9648 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9652 parser->endwhite = proto->endwhite;
9653 parser->faketokens = proto->faketokens;
9654 parser->lasttoke = proto->lasttoke;
9655 parser->nextwhite = proto->nextwhite;
9656 parser->realtokenstart = proto->realtokenstart;
9657 parser->skipwhite = proto->skipwhite;
9658 parser->thisclose = proto->thisclose;
9659 parser->thismad = proto->thismad;
9660 parser->thisopen = proto->thisopen;
9661 parser->thisstuff = proto->thisstuff;
9662 parser->thistoken = proto->thistoken;
9663 parser->thiswhite = proto->thiswhite;
9665 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9666 parser->curforce = proto->curforce;
9668 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9669 Copy(proto->nexttype, parser->nexttype, 5, I32);
9670 parser->nexttoke = proto->nexttoke;
9676 /* duplicate a file handle */
9679 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9683 PERL_UNUSED_ARG(type);
9686 return (PerlIO*)NULL;
9688 /* look for it in the table first */
9689 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9693 /* create anew and remember what it is */
9694 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9695 ptr_table_store(PL_ptr_table, fp, ret);
9699 /* duplicate a directory handle */
9702 Perl_dirp_dup(pTHX_ DIR *dp)
9704 PERL_UNUSED_CONTEXT;
9711 /* duplicate a typeglob */
9714 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9720 /* look for it in the table first */
9721 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9725 /* create anew and remember what it is */
9727 ptr_table_store(PL_ptr_table, gp, ret);
9730 ret->gp_refcnt = 0; /* must be before any other dups! */
9731 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9732 ret->gp_io = io_dup_inc(gp->gp_io, param);
9733 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9734 ret->gp_av = av_dup_inc(gp->gp_av, param);
9735 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9736 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9737 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9738 ret->gp_cvgen = gp->gp_cvgen;
9739 ret->gp_line = gp->gp_line;
9740 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9744 /* duplicate a chain of magic */
9747 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9749 MAGIC *mgprev = (MAGIC*)NULL;
9752 return (MAGIC*)NULL;
9753 /* look for it in the table first */
9754 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9758 for (; mg; mg = mg->mg_moremagic) {
9760 Newxz(nmg, 1, MAGIC);
9762 mgprev->mg_moremagic = nmg;
9765 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9766 nmg->mg_private = mg->mg_private;
9767 nmg->mg_type = mg->mg_type;
9768 nmg->mg_flags = mg->mg_flags;
9769 if (mg->mg_type == PERL_MAGIC_qr) {
9770 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9772 else if(mg->mg_type == PERL_MAGIC_backref) {
9773 /* The backref AV has its reference count deliberately bumped by
9775 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9778 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9779 ? sv_dup_inc(mg->mg_obj, param)
9780 : sv_dup(mg->mg_obj, param);
9782 nmg->mg_len = mg->mg_len;
9783 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9784 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9785 if (mg->mg_len > 0) {
9786 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9787 if (mg->mg_type == PERL_MAGIC_overload_table &&
9788 AMT_AMAGIC((AMT*)mg->mg_ptr))
9790 const AMT * const amtp = (AMT*)mg->mg_ptr;
9791 AMT * const namtp = (AMT*)nmg->mg_ptr;
9793 for (i = 1; i < NofAMmeth; i++) {
9794 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9798 else if (mg->mg_len == HEf_SVKEY)
9799 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9801 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9802 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9809 #endif /* USE_ITHREADS */
9811 /* create a new pointer-mapping table */
9814 Perl_ptr_table_new(pTHX)
9817 PERL_UNUSED_CONTEXT;
9819 Newxz(tbl, 1, PTR_TBL_t);
9822 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9826 #define PTR_TABLE_HASH(ptr) \
9827 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9830 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9831 following define) and at call to new_body_inline made below in
9832 Perl_ptr_table_store()
9835 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9837 /* map an existing pointer using a table */
9839 STATIC PTR_TBL_ENT_t *
9840 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9841 PTR_TBL_ENT_t *tblent;
9842 const UV hash = PTR_TABLE_HASH(sv);
9844 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9845 for (; tblent; tblent = tblent->next) {
9846 if (tblent->oldval == sv)
9853 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9855 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9856 PERL_UNUSED_CONTEXT;
9857 return tblent ? tblent->newval : NULL;
9860 /* add a new entry to a pointer-mapping table */
9863 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9865 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9866 PERL_UNUSED_CONTEXT;
9869 tblent->newval = newsv;
9871 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9873 new_body_inline(tblent, PTE_SVSLOT);
9875 tblent->oldval = oldsv;
9876 tblent->newval = newsv;
9877 tblent->next = tbl->tbl_ary[entry];
9878 tbl->tbl_ary[entry] = tblent;
9880 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9881 ptr_table_split(tbl);
9885 /* double the hash bucket size of an existing ptr table */
9888 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9890 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9891 const UV oldsize = tbl->tbl_max + 1;
9892 UV newsize = oldsize * 2;
9894 PERL_UNUSED_CONTEXT;
9896 Renew(ary, newsize, PTR_TBL_ENT_t*);
9897 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9898 tbl->tbl_max = --newsize;
9900 for (i=0; i < oldsize; i++, ary++) {
9901 PTR_TBL_ENT_t **curentp, **entp, *ent;
9904 curentp = ary + oldsize;
9905 for (entp = ary, ent = *ary; ent; ent = *entp) {
9906 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9908 ent->next = *curentp;
9918 /* remove all the entries from a ptr table */
9921 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9923 if (tbl && tbl->tbl_items) {
9924 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9925 UV riter = tbl->tbl_max;
9928 PTR_TBL_ENT_t *entry = array[riter];
9931 PTR_TBL_ENT_t * const oentry = entry;
9932 entry = entry->next;
9941 /* clear and free a ptr table */
9944 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9949 ptr_table_clear(tbl);
9950 Safefree(tbl->tbl_ary);
9954 #if defined(USE_ITHREADS)
9957 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9960 SvRV_set(dstr, SvWEAKREF(sstr)
9961 ? sv_dup(SvRV(sstr), param)
9962 : sv_dup_inc(SvRV(sstr), param));
9965 else if (SvPVX_const(sstr)) {
9966 /* Has something there */
9968 /* Normal PV - clone whole allocated space */
9969 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9970 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9971 /* Not that normal - actually sstr is copy on write.
9972 But we are a true, independant SV, so: */
9973 SvREADONLY_off(dstr);
9978 /* Special case - not normally malloced for some reason */
9979 if (isGV_with_GP(sstr)) {
9980 /* Don't need to do anything here. */
9982 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9983 /* A "shared" PV - clone it as "shared" PV */
9985 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9989 /* Some other special case - random pointer */
9990 SvPV_set(dstr, SvPVX(sstr));
9996 if (SvTYPE(dstr) == SVt_RV)
9997 SvRV_set(dstr, NULL);
9999 SvPV_set(dstr, NULL);
10003 /* duplicate an SV of any type (including AV, HV etc) */
10006 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10011 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10013 /* look for it in the table first */
10014 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10018 if(param->flags & CLONEf_JOIN_IN) {
10019 /** We are joining here so we don't want do clone
10020 something that is bad **/
10021 if (SvTYPE(sstr) == SVt_PVHV) {
10022 const HEK * const hvname = HvNAME_HEK(sstr);
10024 /** don't clone stashes if they already exist **/
10025 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10029 /* create anew and remember what it is */
10032 #ifdef DEBUG_LEAKING_SCALARS
10033 dstr->sv_debug_optype = sstr->sv_debug_optype;
10034 dstr->sv_debug_line = sstr->sv_debug_line;
10035 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10036 dstr->sv_debug_cloned = 1;
10037 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10040 ptr_table_store(PL_ptr_table, sstr, dstr);
10043 SvFLAGS(dstr) = SvFLAGS(sstr);
10044 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10045 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10048 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10049 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10050 (void*)PL_watch_pvx, SvPVX_const(sstr));
10053 /* don't clone objects whose class has asked us not to */
10054 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10055 SvFLAGS(dstr) &= ~SVTYPEMASK;
10056 SvOBJECT_off(dstr);
10060 switch (SvTYPE(sstr)) {
10062 SvANY(dstr) = NULL;
10065 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10066 SvIV_set(dstr, SvIVX(sstr));
10069 SvANY(dstr) = new_XNV();
10070 SvNV_set(dstr, SvNVX(sstr));
10073 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10074 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10076 /* case SVt_BIND: */
10079 /* These are all the types that need complex bodies allocating. */
10081 const svtype sv_type = SvTYPE(sstr);
10082 const struct body_details *const sv_type_details
10083 = bodies_by_type + sv_type;
10087 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10091 if (GvUNIQUE((GV*)sstr)) {
10092 NOOP; /* Do sharing here, and fall through */
10104 assert(sv_type_details->body_size);
10105 if (sv_type_details->arena) {
10106 new_body_inline(new_body, sv_type);
10108 = (void*)((char*)new_body - sv_type_details->offset);
10110 new_body = new_NOARENA(sv_type_details);
10114 SvANY(dstr) = new_body;
10117 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10118 ((char*)SvANY(dstr)) + sv_type_details->offset,
10119 sv_type_details->copy, char);
10121 Copy(((char*)SvANY(sstr)),
10122 ((char*)SvANY(dstr)),
10123 sv_type_details->body_size + sv_type_details->offset, char);
10126 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10127 && !isGV_with_GP(dstr))
10128 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10130 /* The Copy above means that all the source (unduplicated) pointers
10131 are now in the destination. We can check the flags and the
10132 pointers in either, but it's possible that there's less cache
10133 missing by always going for the destination.
10134 FIXME - instrument and check that assumption */
10135 if (sv_type >= SVt_PVMG) {
10136 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10137 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10138 } else if (SvMAGIC(dstr))
10139 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10141 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10144 /* The cast silences a GCC warning about unhandled types. */
10145 switch ((int)sv_type) {
10155 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10156 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10157 LvTARG(dstr) = dstr;
10158 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10159 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10161 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10163 if(isGV_with_GP(sstr)) {
10164 if (GvNAME_HEK(dstr))
10165 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10166 /* Don't call sv_add_backref here as it's going to be
10167 created as part of the magic cloning of the symbol
10169 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10170 at the point of this comment. */
10171 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10172 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10173 (void)GpREFCNT_inc(GvGP(dstr));
10175 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10178 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10179 if (IoOFP(dstr) == IoIFP(sstr))
10180 IoOFP(dstr) = IoIFP(dstr);
10182 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10183 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10184 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10185 /* I have no idea why fake dirp (rsfps)
10186 should be treated differently but otherwise
10187 we end up with leaks -- sky*/
10188 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10189 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10190 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10192 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10193 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10194 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10195 if (IoDIRP(dstr)) {
10196 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10199 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10202 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10203 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10204 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10207 if (AvARRAY((AV*)sstr)) {
10208 SV **dst_ary, **src_ary;
10209 SSize_t items = AvFILLp((AV*)sstr) + 1;
10211 src_ary = AvARRAY((AV*)sstr);
10212 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10213 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10214 AvARRAY((AV*)dstr) = dst_ary;
10215 AvALLOC((AV*)dstr) = dst_ary;
10216 if (AvREAL((AV*)sstr)) {
10217 while (items-- > 0)
10218 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10221 while (items-- > 0)
10222 *dst_ary++ = sv_dup(*src_ary++, param);
10224 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10225 while (items-- > 0) {
10226 *dst_ary++ = &PL_sv_undef;
10230 AvARRAY((AV*)dstr) = NULL;
10231 AvALLOC((AV*)dstr) = (SV**)NULL;
10235 if (HvARRAY((HV*)sstr)) {
10237 const bool sharekeys = !!HvSHAREKEYS(sstr);
10238 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10239 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10241 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10242 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10244 HvARRAY(dstr) = (HE**)darray;
10245 while (i <= sxhv->xhv_max) {
10246 const HE * const source = HvARRAY(sstr)[i];
10247 HvARRAY(dstr)[i] = source
10248 ? he_dup(source, sharekeys, param) : 0;
10253 const struct xpvhv_aux * const saux = HvAUX(sstr);
10254 struct xpvhv_aux * const daux = HvAUX(dstr);
10255 /* This flag isn't copied. */
10256 /* SvOOK_on(hv) attacks the IV flags. */
10257 SvFLAGS(dstr) |= SVf_OOK;
10259 hvname = saux->xhv_name;
10260 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10262 daux->xhv_riter = saux->xhv_riter;
10263 daux->xhv_eiter = saux->xhv_eiter
10264 ? he_dup(saux->xhv_eiter,
10265 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10266 daux->xhv_backreferences =
10267 saux->xhv_backreferences
10268 ? (AV*) SvREFCNT_inc(
10269 sv_dup((SV*)saux->xhv_backreferences, param))
10272 daux->xhv_mro_meta = saux->xhv_mro_meta
10273 ? mro_meta_dup(saux->xhv_mro_meta, param)
10276 /* Record stashes for possible cloning in Perl_clone(). */
10278 av_push(param->stashes, dstr);
10282 HvARRAY((HV*)dstr) = NULL;
10285 if (!(param->flags & CLONEf_COPY_STACKS)) {
10289 /* NOTE: not refcounted */
10290 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10292 if (!CvISXSUB(dstr))
10293 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10295 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10296 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10297 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10298 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10300 /* don't dup if copying back - CvGV isn't refcounted, so the
10301 * duped GV may never be freed. A bit of a hack! DAPM */
10302 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10303 NULL : gv_dup(CvGV(dstr), param) ;
10304 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10306 CvWEAKOUTSIDE(sstr)
10307 ? cv_dup( CvOUTSIDE(dstr), param)
10308 : cv_dup_inc(CvOUTSIDE(dstr), param);
10309 if (!CvISXSUB(dstr))
10310 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10316 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10322 /* duplicate a context */
10325 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10327 PERL_CONTEXT *ncxs;
10330 return (PERL_CONTEXT*)NULL;
10332 /* look for it in the table first */
10333 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10337 /* create anew and remember what it is */
10338 Newxz(ncxs, max + 1, PERL_CONTEXT);
10339 ptr_table_store(PL_ptr_table, cxs, ncxs);
10342 PERL_CONTEXT * const cx = &cxs[ix];
10343 PERL_CONTEXT * const ncx = &ncxs[ix];
10344 ncx->cx_type = cx->cx_type;
10345 if (CxTYPE(cx) == CXt_SUBST) {
10346 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10349 ncx->blk_oldsp = cx->blk_oldsp;
10350 ncx->blk_oldcop = cx->blk_oldcop;
10351 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10352 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10353 ncx->blk_oldpm = cx->blk_oldpm;
10354 ncx->blk_gimme = cx->blk_gimme;
10355 switch (CxTYPE(cx)) {
10357 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10358 ? cv_dup_inc(cx->blk_sub.cv, param)
10359 : cv_dup(cx->blk_sub.cv,param));
10360 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10361 ? av_dup_inc(cx->blk_sub.argarray, param)
10363 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10364 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10365 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10366 ncx->blk_sub.lval = cx->blk_sub.lval;
10367 ncx->blk_sub.retop = cx->blk_sub.retop;
10368 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10369 cx->blk_sub.oldcomppad);
10372 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10373 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10374 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10375 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10376 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10377 ncx->blk_eval.retop = cx->blk_eval.retop;
10380 ncx->blk_loop.label = cx->blk_loop.label;
10381 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10382 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10383 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10384 ? cx->blk_loop.iterdata
10385 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10386 ncx->blk_loop.oldcomppad
10387 = (PAD*)ptr_table_fetch(PL_ptr_table,
10388 cx->blk_loop.oldcomppad);
10389 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10390 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10391 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10392 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10393 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10396 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10397 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10398 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10399 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10400 ncx->blk_sub.retop = cx->blk_sub.retop;
10412 /* duplicate a stack info structure */
10415 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10420 return (PERL_SI*)NULL;
10422 /* look for it in the table first */
10423 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10427 /* create anew and remember what it is */
10428 Newxz(nsi, 1, PERL_SI);
10429 ptr_table_store(PL_ptr_table, si, nsi);
10431 nsi->si_stack = av_dup_inc(si->si_stack, param);
10432 nsi->si_cxix = si->si_cxix;
10433 nsi->si_cxmax = si->si_cxmax;
10434 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10435 nsi->si_type = si->si_type;
10436 nsi->si_prev = si_dup(si->si_prev, param);
10437 nsi->si_next = si_dup(si->si_next, param);
10438 nsi->si_markoff = si->si_markoff;
10443 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10444 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10445 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10446 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10447 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10448 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10449 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10450 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10451 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10452 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10453 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10454 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10455 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10456 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10459 #define pv_dup_inc(p) SAVEPV(p)
10460 #define pv_dup(p) SAVEPV(p)
10461 #define svp_dup_inc(p,pp) any_dup(p,pp)
10463 /* map any object to the new equivent - either something in the
10464 * ptr table, or something in the interpreter structure
10468 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10473 return (void*)NULL;
10475 /* look for it in the table first */
10476 ret = ptr_table_fetch(PL_ptr_table, v);
10480 /* see if it is part of the interpreter structure */
10481 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10482 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10490 /* duplicate the save stack */
10493 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10496 ANY * const ss = proto_perl->Isavestack;
10497 const I32 max = proto_perl->Isavestack_max;
10498 I32 ix = proto_perl->Isavestack_ix;
10511 void (*dptr) (void*);
10512 void (*dxptr) (pTHX_ void*);
10514 Newxz(nss, max, ANY);
10517 const I32 type = POPINT(ss,ix);
10518 TOPINT(nss,ix) = type;
10520 case SAVEt_HELEM: /* hash element */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10524 case SAVEt_ITEM: /* normal string */
10525 case SAVEt_SV: /* scalar reference */
10526 sv = (SV*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10530 case SAVEt_MORTALIZESV:
10531 sv = (SV*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10534 case SAVEt_SHARED_PVREF: /* char* in shared space */
10535 c = (char*)POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = savesharedpv(c);
10537 ptr = POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10540 case SAVEt_GENERIC_SVREF: /* generic sv */
10541 case SAVEt_SVREF: /* scalar reference */
10542 sv = (SV*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10547 case SAVEt_HV: /* hash reference */
10548 case SAVEt_AV: /* array reference */
10549 sv = (SV*) POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10552 case SAVEt_COMPPAD:
10554 sv = (SV*) POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = sv_dup(sv, param);
10557 case SAVEt_INT: /* int reference */
10558 ptr = POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10560 intval = (int)POPINT(ss,ix);
10561 TOPINT(nss,ix) = intval;
10563 case SAVEt_LONG: /* long reference */
10564 ptr = POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10567 case SAVEt_CLEARSV:
10568 longval = (long)POPLONG(ss,ix);
10569 TOPLONG(nss,ix) = longval;
10571 case SAVEt_I32: /* I32 reference */
10572 case SAVEt_I16: /* I16 reference */
10573 case SAVEt_I8: /* I8 reference */
10574 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10575 ptr = POPPTR(ss,ix);
10576 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10578 TOPINT(nss,ix) = i;
10580 case SAVEt_IV: /* IV reference */
10581 ptr = POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10584 TOPIV(nss,ix) = iv;
10586 case SAVEt_HPTR: /* HV* reference */
10587 case SAVEt_APTR: /* AV* reference */
10588 case SAVEt_SPTR: /* SV* reference */
10589 ptr = POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 sv = (SV*)POPPTR(ss,ix);
10592 TOPPTR(nss,ix) = sv_dup(sv, param);
10594 case SAVEt_VPTR: /* random* reference */
10595 ptr = POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 ptr = POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600 case SAVEt_GENERIC_PVREF: /* generic char* */
10601 case SAVEt_PPTR: /* char* reference */
10602 ptr = POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10604 c = (char*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = pv_dup(c);
10607 case SAVEt_GP: /* scalar reference */
10608 gp = (GP*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10610 (void)GpREFCNT_inc(gp);
10611 gv = (GV*)POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10615 ptr = POPPTR(ss,ix);
10616 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10617 /* these are assumed to be refcounted properly */
10619 switch (((OP*)ptr)->op_type) {
10621 case OP_LEAVESUBLV:
10625 case OP_LEAVEWRITE:
10626 TOPPTR(nss,ix) = ptr;
10629 (void) OpREFCNT_inc(o);
10633 TOPPTR(nss,ix) = NULL;
10638 TOPPTR(nss,ix) = NULL;
10641 c = (char*)POPPTR(ss,ix);
10642 TOPPTR(nss,ix) = pv_dup_inc(c);
10645 hv = (HV*)POPPTR(ss,ix);
10646 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10647 c = (char*)POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = pv_dup_inc(c);
10650 case SAVEt_STACK_POS: /* Position on Perl stack */
10652 TOPINT(nss,ix) = i;
10654 case SAVEt_DESTRUCTOR:
10655 ptr = POPPTR(ss,ix);
10656 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10657 dptr = POPDPTR(ss,ix);
10658 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10659 any_dup(FPTR2DPTR(void *, dptr),
10662 case SAVEt_DESTRUCTOR_X:
10663 ptr = POPPTR(ss,ix);
10664 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10665 dxptr = POPDXPTR(ss,ix);
10666 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10667 any_dup(FPTR2DPTR(void *, dxptr),
10670 case SAVEt_REGCONTEXT:
10673 TOPINT(nss,ix) = i;
10676 case SAVEt_AELEM: /* array element */
10677 sv = (SV*)POPPTR(ss,ix);
10678 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10680 TOPINT(nss,ix) = i;
10681 av = (AV*)POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = av_dup_inc(av, param);
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = ptr;
10690 TOPINT(nss,ix) = i;
10691 ptr = POPPTR(ss,ix);
10694 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10695 HINTS_REFCNT_UNLOCK;
10697 TOPPTR(nss,ix) = ptr;
10698 if (i & HINT_LOCALIZE_HH) {
10699 hv = (HV*)POPPTR(ss,ix);
10700 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10704 longval = (long)POPLONG(ss,ix);
10705 TOPLONG(nss,ix) = longval;
10706 ptr = POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10708 sv = (SV*)POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = sv_dup(sv, param);
10712 ptr = POPPTR(ss,ix);
10713 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10714 longval = (long)POPBOOL(ss,ix);
10715 TOPBOOL(nss,ix) = (bool)longval;
10717 case SAVEt_SET_SVFLAGS:
10719 TOPINT(nss,ix) = i;
10721 TOPINT(nss,ix) = i;
10722 sv = (SV*)POPPTR(ss,ix);
10723 TOPPTR(nss,ix) = sv_dup(sv, param);
10725 case SAVEt_RE_STATE:
10727 const struct re_save_state *const old_state
10728 = (struct re_save_state *)
10729 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10730 struct re_save_state *const new_state
10731 = (struct re_save_state *)
10732 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10734 Copy(old_state, new_state, 1, struct re_save_state);
10735 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10737 new_state->re_state_bostr
10738 = pv_dup(old_state->re_state_bostr);
10739 new_state->re_state_reginput
10740 = pv_dup(old_state->re_state_reginput);
10741 new_state->re_state_regeol
10742 = pv_dup(old_state->re_state_regeol);
10743 new_state->re_state_regoffs
10744 = (regexp_paren_pair*)
10745 any_dup(old_state->re_state_regoffs, proto_perl);
10746 new_state->re_state_reglastparen
10747 = (U32*) any_dup(old_state->re_state_reglastparen,
10749 new_state->re_state_reglastcloseparen
10750 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10752 /* XXX This just has to be broken. The old save_re_context
10753 code did SAVEGENERICPV(PL_reg_start_tmp);
10754 PL_reg_start_tmp is char **.
10755 Look above to what the dup code does for
10756 SAVEt_GENERIC_PVREF
10757 It can never have worked.
10758 So this is merely a faithful copy of the exiting bug: */
10759 new_state->re_state_reg_start_tmp
10760 = (char **) pv_dup((char *)
10761 old_state->re_state_reg_start_tmp);
10762 /* I assume that it only ever "worked" because no-one called
10763 (pseudo)fork while the regexp engine had re-entered itself.
10765 #ifdef PERL_OLD_COPY_ON_WRITE
10766 new_state->re_state_nrs
10767 = sv_dup(old_state->re_state_nrs, param);
10769 new_state->re_state_reg_magic
10770 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10772 new_state->re_state_reg_oldcurpm
10773 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10775 new_state->re_state_reg_curpm
10776 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10778 new_state->re_state_reg_oldsaved
10779 = pv_dup(old_state->re_state_reg_oldsaved);
10780 new_state->re_state_reg_poscache
10781 = pv_dup(old_state->re_state_reg_poscache);
10782 new_state->re_state_reg_starttry
10783 = pv_dup(old_state->re_state_reg_starttry);
10786 case SAVEt_COMPILE_WARNINGS:
10787 ptr = POPPTR(ss,ix);
10788 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10791 ptr = POPPTR(ss,ix);
10792 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10796 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10804 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10805 * flag to the result. This is done for each stash before cloning starts,
10806 * so we know which stashes want their objects cloned */
10809 do_mark_cloneable_stash(pTHX_ SV *sv)
10811 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10813 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10814 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10815 if (cloner && GvCV(cloner)) {
10822 XPUSHs(sv_2mortal(newSVhek(hvname)));
10824 call_sv((SV*)GvCV(cloner), G_SCALAR);
10831 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10839 =for apidoc perl_clone
10841 Create and return a new interpreter by cloning the current one.
10843 perl_clone takes these flags as parameters:
10845 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10846 without it we only clone the data and zero the stacks,
10847 with it we copy the stacks and the new perl interpreter is
10848 ready to run at the exact same point as the previous one.
10849 The pseudo-fork code uses COPY_STACKS while the
10850 threads->create doesn't.
10852 CLONEf_KEEP_PTR_TABLE
10853 perl_clone keeps a ptr_table with the pointer of the old
10854 variable as a key and the new variable as a value,
10855 this allows it to check if something has been cloned and not
10856 clone it again but rather just use the value and increase the
10857 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10858 the ptr_table using the function
10859 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10860 reason to keep it around is if you want to dup some of your own
10861 variable who are outside the graph perl scans, example of this
10862 code is in threads.xs create
10865 This is a win32 thing, it is ignored on unix, it tells perls
10866 win32host code (which is c++) to clone itself, this is needed on
10867 win32 if you want to run two threads at the same time,
10868 if you just want to do some stuff in a separate perl interpreter
10869 and then throw it away and return to the original one,
10870 you don't need to do anything.
10875 /* XXX the above needs expanding by someone who actually understands it ! */
10876 EXTERN_C PerlInterpreter *
10877 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10880 perl_clone(PerlInterpreter *proto_perl, UV flags)
10883 #ifdef PERL_IMPLICIT_SYS
10885 /* perlhost.h so we need to call into it
10886 to clone the host, CPerlHost should have a c interface, sky */
10888 if (flags & CLONEf_CLONE_HOST) {
10889 return perl_clone_host(proto_perl,flags);
10891 return perl_clone_using(proto_perl, flags,
10893 proto_perl->IMemShared,
10894 proto_perl->IMemParse,
10896 proto_perl->IStdIO,
10900 proto_perl->IProc);
10904 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10905 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10906 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10907 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10908 struct IPerlDir* ipD, struct IPerlSock* ipS,
10909 struct IPerlProc* ipP)
10911 /* XXX many of the string copies here can be optimized if they're
10912 * constants; they need to be allocated as common memory and just
10913 * their pointers copied. */
10916 CLONE_PARAMS clone_params;
10917 CLONE_PARAMS* const param = &clone_params;
10919 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10920 /* for each stash, determine whether its objects should be cloned */
10921 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10922 PERL_SET_THX(my_perl);
10925 PoisonNew(my_perl, 1, PerlInterpreter);
10931 PL_savestack_ix = 0;
10932 PL_savestack_max = -1;
10933 PL_sig_pending = 0;
10935 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10936 # else /* !DEBUGGING */
10937 Zero(my_perl, 1, PerlInterpreter);
10938 # endif /* DEBUGGING */
10940 /* host pointers */
10942 PL_MemShared = ipMS;
10943 PL_MemParse = ipMP;
10950 #else /* !PERL_IMPLICIT_SYS */
10952 CLONE_PARAMS clone_params;
10953 CLONE_PARAMS* param = &clone_params;
10954 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10955 /* for each stash, determine whether its objects should be cloned */
10956 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10957 PERL_SET_THX(my_perl);
10960 PoisonNew(my_perl, 1, PerlInterpreter);
10966 PL_savestack_ix = 0;
10967 PL_savestack_max = -1;
10968 PL_sig_pending = 0;
10970 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10971 # else /* !DEBUGGING */
10972 Zero(my_perl, 1, PerlInterpreter);
10973 # endif /* DEBUGGING */
10974 #endif /* PERL_IMPLICIT_SYS */
10975 param->flags = flags;
10976 param->proto_perl = proto_perl;
10978 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10980 PL_body_arenas = NULL;
10981 Zero(&PL_body_roots, 1, PL_body_roots);
10983 PL_nice_chunk = NULL;
10984 PL_nice_chunk_size = 0;
10986 PL_sv_objcount = 0;
10988 PL_sv_arenaroot = NULL;
10990 PL_debug = proto_perl->Idebug;
10992 PL_hash_seed = proto_perl->Ihash_seed;
10993 PL_rehash_seed = proto_perl->Irehash_seed;
10995 #ifdef USE_REENTRANT_API
10996 /* XXX: things like -Dm will segfault here in perlio, but doing
10997 * PERL_SET_CONTEXT(proto_perl);
10998 * breaks too many other things
11000 Perl_reentrant_init(aTHX);
11003 /* create SV map for pointer relocation */
11004 PL_ptr_table = ptr_table_new();
11006 /* initialize these special pointers as early as possible */
11007 SvANY(&PL_sv_undef) = NULL;
11008 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11009 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11010 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11012 SvANY(&PL_sv_no) = new_XPVNV();
11013 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11014 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11015 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11016 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11017 SvCUR_set(&PL_sv_no, 0);
11018 SvLEN_set(&PL_sv_no, 1);
11019 SvIV_set(&PL_sv_no, 0);
11020 SvNV_set(&PL_sv_no, 0);
11021 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11023 SvANY(&PL_sv_yes) = new_XPVNV();
11024 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11025 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11026 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11027 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11028 SvCUR_set(&PL_sv_yes, 1);
11029 SvLEN_set(&PL_sv_yes, 2);
11030 SvIV_set(&PL_sv_yes, 1);
11031 SvNV_set(&PL_sv_yes, 1);
11032 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11034 /* create (a non-shared!) shared string table */
11035 PL_strtab = newHV();
11036 HvSHAREKEYS_off(PL_strtab);
11037 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11038 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11040 PL_compiling = proto_perl->Icompiling;
11042 /* These two PVs will be free'd special way so must set them same way op.c does */
11043 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11044 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11046 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11047 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11049 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11050 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11051 if (PL_compiling.cop_hints_hash) {
11053 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11054 HINTS_REFCNT_UNLOCK;
11056 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11057 #ifdef PERL_DEBUG_READONLY_OPS
11062 /* pseudo environmental stuff */
11063 PL_origargc = proto_perl->Iorigargc;
11064 PL_origargv = proto_perl->Iorigargv;
11066 param->stashes = newAV(); /* Setup array of objects to call clone on */
11068 /* Set tainting stuff before PerlIO_debug can possibly get called */
11069 PL_tainting = proto_perl->Itainting;
11070 PL_taint_warn = proto_perl->Itaint_warn;
11072 #ifdef PERLIO_LAYERS
11073 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11074 PerlIO_clone(aTHX_ proto_perl, param);
11077 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11078 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11079 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11080 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11081 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11082 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11085 PL_minus_c = proto_perl->Iminus_c;
11086 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11087 PL_localpatches = proto_perl->Ilocalpatches;
11088 PL_splitstr = proto_perl->Isplitstr;
11089 PL_preprocess = proto_perl->Ipreprocess;
11090 PL_minus_n = proto_perl->Iminus_n;
11091 PL_minus_p = proto_perl->Iminus_p;
11092 PL_minus_l = proto_perl->Iminus_l;
11093 PL_minus_a = proto_perl->Iminus_a;
11094 PL_minus_E = proto_perl->Iminus_E;
11095 PL_minus_F = proto_perl->Iminus_F;
11096 PL_doswitches = proto_perl->Idoswitches;
11097 PL_dowarn = proto_perl->Idowarn;
11098 PL_doextract = proto_perl->Idoextract;
11099 PL_sawampersand = proto_perl->Isawampersand;
11100 PL_unsafe = proto_perl->Iunsafe;
11101 PL_inplace = SAVEPV(proto_perl->Iinplace);
11102 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11103 PL_perldb = proto_perl->Iperldb;
11104 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11105 PL_exit_flags = proto_perl->Iexit_flags;
11107 /* magical thingies */
11108 /* XXX time(&PL_basetime) when asked for? */
11109 PL_basetime = proto_perl->Ibasetime;
11110 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11112 PL_maxsysfd = proto_perl->Imaxsysfd;
11113 PL_statusvalue = proto_perl->Istatusvalue;
11115 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11117 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11119 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11121 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11122 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11123 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11126 /* RE engine related */
11127 Zero(&PL_reg_state, 1, struct re_save_state);
11128 PL_reginterp_cnt = 0;
11129 PL_regmatch_slab = NULL;
11131 /* Clone the regex array */
11132 PL_regex_padav = newAV();
11134 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11135 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11137 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11138 for(i = 1; i <= len; i++) {
11139 const SV * const regex = regexen[i];
11142 ? sv_dup_inc(regex, param)
11144 newSViv(PTR2IV(CALLREGDUPE(
11145 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11147 if (SvFLAGS(regex) & SVf_BREAK)
11148 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11149 av_push(PL_regex_padav, sv);
11152 PL_regex_pad = AvARRAY(PL_regex_padav);
11154 /* shortcuts to various I/O objects */
11155 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11156 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11157 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11158 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11159 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11160 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11162 /* shortcuts to regexp stuff */
11163 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11165 /* shortcuts to misc objects */
11166 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11168 /* shortcuts to debugging objects */
11169 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11170 PL_DBline = gv_dup(proto_perl->IDBline, param);
11171 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11172 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11173 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11174 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11175 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11177 /* symbol tables */
11178 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11179 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11180 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11181 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11182 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11184 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11185 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11186 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11187 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11188 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11189 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11190 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11191 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11193 PL_sub_generation = proto_perl->Isub_generation;
11194 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11196 /* funky return mechanisms */
11197 PL_forkprocess = proto_perl->Iforkprocess;
11199 /* subprocess state */
11200 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11202 /* internal state */
11203 PL_maxo = proto_perl->Imaxo;
11204 if (proto_perl->Iop_mask)
11205 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11208 /* PL_asserting = proto_perl->Iasserting; */
11210 /* current interpreter roots */
11211 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11213 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11215 PL_main_start = proto_perl->Imain_start;
11216 PL_eval_root = proto_perl->Ieval_root;
11217 PL_eval_start = proto_perl->Ieval_start;
11219 /* runtime control stuff */
11220 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11222 PL_filemode = proto_perl->Ifilemode;
11223 PL_lastfd = proto_perl->Ilastfd;
11224 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11227 PL_gensym = proto_perl->Igensym;
11228 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11229 PL_laststatval = proto_perl->Ilaststatval;
11230 PL_laststype = proto_perl->Ilaststype;
11233 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11235 /* interpreter atexit processing */
11236 PL_exitlistlen = proto_perl->Iexitlistlen;
11237 if (PL_exitlistlen) {
11238 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11239 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11242 PL_exitlist = (PerlExitListEntry*)NULL;
11244 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11245 if (PL_my_cxt_size) {
11246 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11247 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11248 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11249 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11250 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11254 PL_my_cxt_list = (void**)NULL;
11255 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11256 PL_my_cxt_keys = (const char**)NULL;
11259 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11260 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11261 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11263 PL_profiledata = NULL;
11265 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11267 PAD_CLONE_VARS(proto_perl, param);
11269 #ifdef HAVE_INTERP_INTERN
11270 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11273 /* more statics moved here */
11274 PL_generation = proto_perl->Igeneration;
11275 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11277 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11278 PL_in_clean_all = proto_perl->Iin_clean_all;
11280 PL_uid = proto_perl->Iuid;
11281 PL_euid = proto_perl->Ieuid;
11282 PL_gid = proto_perl->Igid;
11283 PL_egid = proto_perl->Iegid;
11284 PL_nomemok = proto_perl->Inomemok;
11285 PL_an = proto_perl->Ian;
11286 PL_evalseq = proto_perl->Ievalseq;
11287 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11288 PL_origalen = proto_perl->Iorigalen;
11289 #ifdef PERL_USES_PL_PIDSTATUS
11290 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11292 PL_osname = SAVEPV(proto_perl->Iosname);
11293 PL_sighandlerp = proto_perl->Isighandlerp;
11295 PL_runops = proto_perl->Irunops;
11297 PL_parser = parser_dup(proto_perl->Iparser, param);
11299 PL_subline = proto_perl->Isubline;
11300 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11303 PL_cryptseen = proto_perl->Icryptseen;
11306 PL_hints = proto_perl->Ihints;
11308 PL_amagic_generation = proto_perl->Iamagic_generation;
11310 #ifdef USE_LOCALE_COLLATE
11311 PL_collation_ix = proto_perl->Icollation_ix;
11312 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11313 PL_collation_standard = proto_perl->Icollation_standard;
11314 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11315 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11316 #endif /* USE_LOCALE_COLLATE */
11318 #ifdef USE_LOCALE_NUMERIC
11319 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11320 PL_numeric_standard = proto_perl->Inumeric_standard;
11321 PL_numeric_local = proto_perl->Inumeric_local;
11322 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11323 #endif /* !USE_LOCALE_NUMERIC */
11325 /* utf8 character classes */
11326 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11327 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11328 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11329 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11330 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11331 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11332 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11333 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11334 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11335 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11336 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11337 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11338 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11339 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11340 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11341 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11342 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11343 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11344 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11345 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11347 /* Did the locale setup indicate UTF-8? */
11348 PL_utf8locale = proto_perl->Iutf8locale;
11349 /* Unicode features (see perlrun/-C) */
11350 PL_unicode = proto_perl->Iunicode;
11352 /* Pre-5.8 signals control */
11353 PL_signals = proto_perl->Isignals;
11355 /* times() ticks per second */
11356 PL_clocktick = proto_perl->Iclocktick;
11358 /* Recursion stopper for PerlIO_find_layer */
11359 PL_in_load_module = proto_perl->Iin_load_module;
11361 /* sort() routine */
11362 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11364 /* Not really needed/useful since the reenrant_retint is "volatile",
11365 * but do it for consistency's sake. */
11366 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11368 /* Hooks to shared SVs and locks. */
11369 PL_sharehook = proto_perl->Isharehook;
11370 PL_lockhook = proto_perl->Ilockhook;
11371 PL_unlockhook = proto_perl->Iunlockhook;
11372 PL_threadhook = proto_perl->Ithreadhook;
11374 #ifdef THREADS_HAVE_PIDS
11375 PL_ppid = proto_perl->Ippid;
11379 PL_last_swash_hv = NULL; /* reinits on demand */
11380 PL_last_swash_klen = 0;
11381 PL_last_swash_key[0]= '\0';
11382 PL_last_swash_tmps = (U8*)NULL;
11383 PL_last_swash_slen = 0;
11385 PL_glob_index = proto_perl->Iglob_index;
11386 PL_srand_called = proto_perl->Isrand_called;
11387 PL_bitcount = NULL; /* reinits on demand */
11389 if (proto_perl->Ipsig_pend) {
11390 Newxz(PL_psig_pend, SIG_SIZE, int);
11393 PL_psig_pend = (int*)NULL;
11396 if (proto_perl->Ipsig_ptr) {
11397 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11398 Newxz(PL_psig_name, SIG_SIZE, SV*);
11399 for (i = 1; i < SIG_SIZE; i++) {
11400 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11401 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11405 PL_psig_ptr = (SV**)NULL;
11406 PL_psig_name = (SV**)NULL;
11409 /* intrpvar.h stuff */
11411 if (flags & CLONEf_COPY_STACKS) {
11412 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11413 PL_tmps_ix = proto_perl->Itmps_ix;
11414 PL_tmps_max = proto_perl->Itmps_max;
11415 PL_tmps_floor = proto_perl->Itmps_floor;
11416 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11418 while (i <= PL_tmps_ix) {
11419 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11423 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11424 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11425 Newxz(PL_markstack, i, I32);
11426 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11427 - proto_perl->Imarkstack);
11428 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11429 - proto_perl->Imarkstack);
11430 Copy(proto_perl->Imarkstack, PL_markstack,
11431 PL_markstack_ptr - PL_markstack + 1, I32);
11433 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11434 * NOTE: unlike the others! */
11435 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11436 PL_scopestack_max = proto_perl->Iscopestack_max;
11437 Newxz(PL_scopestack, PL_scopestack_max, I32);
11438 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11440 /* NOTE: si_dup() looks at PL_markstack */
11441 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11443 /* PL_curstack = PL_curstackinfo->si_stack; */
11444 PL_curstack = av_dup(proto_perl->Icurstack, param);
11445 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11447 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11448 PL_stack_base = AvARRAY(PL_curstack);
11449 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11450 - proto_perl->Istack_base);
11451 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11453 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11454 * NOTE: unlike the others! */
11455 PL_savestack_ix = proto_perl->Isavestack_ix;
11456 PL_savestack_max = proto_perl->Isavestack_max;
11457 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11458 PL_savestack = ss_dup(proto_perl, param);
11462 ENTER; /* perl_destruct() wants to LEAVE; */
11464 /* although we're not duplicating the tmps stack, we should still
11465 * add entries for any SVs on the tmps stack that got cloned by a
11466 * non-refcount means (eg a temp in @_); otherwise they will be
11469 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11470 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11471 proto_perl->Itmps_stack[i]);
11472 if (nsv && !SvREFCNT(nsv)) {
11474 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11479 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11480 PL_top_env = &PL_start_env;
11482 PL_op = proto_perl->Iop;
11485 PL_Xpv = (XPV*)NULL;
11486 PL_na = proto_perl->Ina;
11488 PL_statbuf = proto_perl->Istatbuf;
11489 PL_statcache = proto_perl->Istatcache;
11490 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11491 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11493 PL_timesbuf = proto_perl->Itimesbuf;
11496 PL_tainted = proto_perl->Itainted;
11497 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11498 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11499 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11500 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11501 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11502 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11503 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11504 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11505 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11507 PL_restartop = proto_perl->Irestartop;
11508 PL_in_eval = proto_perl->Iin_eval;
11509 PL_delaymagic = proto_perl->Idelaymagic;
11510 PL_dirty = proto_perl->Idirty;
11511 PL_localizing = proto_perl->Ilocalizing;
11513 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11514 PL_hv_fetch_ent_mh = NULL;
11515 PL_modcount = proto_perl->Imodcount;
11516 PL_lastgotoprobe = NULL;
11517 PL_dumpindent = proto_perl->Idumpindent;
11519 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11520 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11521 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11522 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11523 PL_efloatbuf = NULL; /* reinits on demand */
11524 PL_efloatsize = 0; /* reinits on demand */
11528 PL_screamfirst = NULL;
11529 PL_screamnext = NULL;
11530 PL_maxscream = -1; /* reinits on demand */
11531 PL_lastscream = NULL;
11534 PL_regdummy = proto_perl->Iregdummy;
11535 PL_colorset = 0; /* reinits PL_colors[] */
11536 /*PL_colors[6] = {0,0,0,0,0,0};*/
11540 /* Pluggable optimizer */
11541 PL_peepp = proto_perl->Ipeepp;
11543 PL_stashcache = newHV();
11545 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11546 proto_perl->Iwatchaddr);
11547 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11548 if (PL_debug && PL_watchaddr) {
11549 PerlIO_printf(Perl_debug_log,
11550 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11551 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11552 PTR2UV(PL_watchok));
11555 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11556 ptr_table_free(PL_ptr_table);
11557 PL_ptr_table = NULL;
11560 /* Call the ->CLONE method, if it exists, for each of the stashes
11561 identified by sv_dup() above.
11563 while(av_len(param->stashes) != -1) {
11564 HV* const stash = (HV*) av_shift(param->stashes);
11565 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11566 if (cloner && GvCV(cloner)) {
11571 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11573 call_sv((SV*)GvCV(cloner), G_DISCARD);
11579 SvREFCNT_dec(param->stashes);
11581 /* orphaned? eg threads->new inside BEGIN or use */
11582 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11583 SvREFCNT_inc_simple_void(PL_compcv);
11584 SAVEFREESV(PL_compcv);
11590 #endif /* USE_ITHREADS */
11593 =head1 Unicode Support
11595 =for apidoc sv_recode_to_utf8
11597 The encoding is assumed to be an Encode object, on entry the PV
11598 of the sv is assumed to be octets in that encoding, and the sv
11599 will be converted into Unicode (and UTF-8).
11601 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11602 is not a reference, nothing is done to the sv. If the encoding is not
11603 an C<Encode::XS> Encoding object, bad things will happen.
11604 (See F<lib/encoding.pm> and L<Encode>).
11606 The PV of the sv is returned.
11611 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11614 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11628 Passing sv_yes is wrong - it needs to be or'ed set of constants
11629 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11630 remove converted chars from source.
11632 Both will default the value - let them.
11634 XPUSHs(&PL_sv_yes);
11637 call_method("decode", G_SCALAR);
11641 s = SvPV_const(uni, len);
11642 if (s != SvPVX_const(sv)) {
11643 SvGROW(sv, len + 1);
11644 Move(s, SvPVX(sv), len + 1, char);
11645 SvCUR_set(sv, len);
11652 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11656 =for apidoc sv_cat_decode
11658 The encoding is assumed to be an Encode object, the PV of the ssv is
11659 assumed to be octets in that encoding and decoding the input starts
11660 from the position which (PV + *offset) pointed to. The dsv will be
11661 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11662 when the string tstr appears in decoding output or the input ends on
11663 the PV of the ssv. The value which the offset points will be modified
11664 to the last input position on the ssv.
11666 Returns TRUE if the terminator was found, else returns FALSE.
11671 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11672 SV *ssv, int *offset, char *tstr, int tlen)
11676 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11687 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11688 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11690 call_method("cat_decode", G_SCALAR);
11692 ret = SvTRUE(TOPs);
11693 *offset = SvIV(offsv);
11699 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11704 /* ---------------------------------------------------------------------
11706 * support functions for report_uninit()
11709 /* the maxiumum size of array or hash where we will scan looking
11710 * for the undefined element that triggered the warning */
11712 #define FUV_MAX_SEARCH_SIZE 1000
11714 /* Look for an entry in the hash whose value has the same SV as val;
11715 * If so, return a mortal copy of the key. */
11718 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11721 register HE **array;
11724 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11725 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11728 array = HvARRAY(hv);
11730 for (i=HvMAX(hv); i>0; i--) {
11731 register HE *entry;
11732 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11733 if (HeVAL(entry) != val)
11735 if ( HeVAL(entry) == &PL_sv_undef ||
11736 HeVAL(entry) == &PL_sv_placeholder)
11740 if (HeKLEN(entry) == HEf_SVKEY)
11741 return sv_mortalcopy(HeKEY_sv(entry));
11742 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11748 /* Look for an entry in the array whose value has the same SV as val;
11749 * If so, return the index, otherwise return -1. */
11752 S_find_array_subscript(pTHX_ AV *av, SV* val)
11755 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11756 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11759 if (val != &PL_sv_undef) {
11760 SV ** const svp = AvARRAY(av);
11763 for (i=AvFILLp(av); i>=0; i--)
11770 /* S_varname(): return the name of a variable, optionally with a subscript.
11771 * If gv is non-zero, use the name of that global, along with gvtype (one
11772 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11773 * targ. Depending on the value of the subscript_type flag, return:
11776 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11777 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11778 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11779 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11782 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11783 SV* keyname, I32 aindex, int subscript_type)
11786 SV * const name = sv_newmortal();
11789 buffer[0] = gvtype;
11792 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11794 gv_fullname4(name, gv, buffer, 0);
11796 if ((unsigned int)SvPVX(name)[1] <= 26) {
11798 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11800 /* Swap the 1 unprintable control character for the 2 byte pretty
11801 version - ie substr($name, 1, 1) = $buffer; */
11802 sv_insert(name, 1, 1, buffer, 2);
11806 CV * const cv = find_runcv(NULL);
11810 if (!cv || !CvPADLIST(cv))
11812 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11813 sv = *av_fetch(av, targ, FALSE);
11814 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11817 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11818 SV * const sv = newSV(0);
11819 *SvPVX(name) = '$';
11820 Perl_sv_catpvf(aTHX_ name, "{%s}",
11821 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11824 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11825 *SvPVX(name) = '$';
11826 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11828 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11829 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11836 =for apidoc find_uninit_var
11838 Find the name of the undefined variable (if any) that caused the operator o
11839 to issue a "Use of uninitialized value" warning.
11840 If match is true, only return a name if it's value matches uninit_sv.
11841 So roughly speaking, if a unary operator (such as OP_COS) generates a
11842 warning, then following the direct child of the op may yield an
11843 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11844 other hand, with OP_ADD there are two branches to follow, so we only print
11845 the variable name if we get an exact match.
11847 The name is returned as a mortal SV.
11849 Assumes that PL_op is the op that originally triggered the error, and that
11850 PL_comppad/PL_curpad points to the currently executing pad.
11856 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11864 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11865 uninit_sv == &PL_sv_placeholder)))
11868 switch (obase->op_type) {
11875 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11876 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11879 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11881 if (pad) { /* @lex, %lex */
11882 sv = PAD_SVl(obase->op_targ);
11886 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11887 /* @global, %global */
11888 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11891 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11893 else /* @{expr}, %{expr} */
11894 return find_uninit_var(cUNOPx(obase)->op_first,
11898 /* attempt to find a match within the aggregate */
11900 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11902 subscript_type = FUV_SUBSCRIPT_HASH;
11905 index = find_array_subscript((AV*)sv, uninit_sv);
11907 subscript_type = FUV_SUBSCRIPT_ARRAY;
11910 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11913 return varname(gv, hash ? '%' : '@', obase->op_targ,
11914 keysv, index, subscript_type);
11918 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11920 return varname(NULL, '$', obase->op_targ,
11921 NULL, 0, FUV_SUBSCRIPT_NONE);
11924 gv = cGVOPx_gv(obase);
11925 if (!gv || (match && GvSV(gv) != uninit_sv))
11927 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11930 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11933 av = (AV*)PAD_SV(obase->op_targ);
11934 if (!av || SvRMAGICAL(av))
11936 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11937 if (!svp || *svp != uninit_sv)
11940 return varname(NULL, '$', obase->op_targ,
11941 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11944 gv = cGVOPx_gv(obase);
11950 if (!av || SvRMAGICAL(av))
11952 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11953 if (!svp || *svp != uninit_sv)
11956 return varname(gv, '$', 0,
11957 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11962 o = cUNOPx(obase)->op_first;
11963 if (!o || o->op_type != OP_NULL ||
11964 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11966 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11970 if (PL_op == obase)
11971 /* $a[uninit_expr] or $h{uninit_expr} */
11972 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11975 o = cBINOPx(obase)->op_first;
11976 kid = cBINOPx(obase)->op_last;
11978 /* get the av or hv, and optionally the gv */
11980 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11981 sv = PAD_SV(o->op_targ);
11983 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11984 && cUNOPo->op_first->op_type == OP_GV)
11986 gv = cGVOPx_gv(cUNOPo->op_first);
11989 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11994 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11995 /* index is constant */
11999 if (obase->op_type == OP_HELEM) {
12000 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12001 if (!he || HeVAL(he) != uninit_sv)
12005 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12006 if (!svp || *svp != uninit_sv)
12010 if (obase->op_type == OP_HELEM)
12011 return varname(gv, '%', o->op_targ,
12012 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12014 return varname(gv, '@', o->op_targ, NULL,
12015 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12018 /* index is an expression;
12019 * attempt to find a match within the aggregate */
12020 if (obase->op_type == OP_HELEM) {
12021 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12023 return varname(gv, '%', o->op_targ,
12024 keysv, 0, FUV_SUBSCRIPT_HASH);
12027 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12029 return varname(gv, '@', o->op_targ,
12030 NULL, index, FUV_SUBSCRIPT_ARRAY);
12035 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12037 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12042 /* only examine RHS */
12043 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12046 o = cUNOPx(obase)->op_first;
12047 if (o->op_type == OP_PUSHMARK)
12050 if (!o->op_sibling) {
12051 /* one-arg version of open is highly magical */
12053 if (o->op_type == OP_GV) { /* open FOO; */
12055 if (match && GvSV(gv) != uninit_sv)
12057 return varname(gv, '$', 0,
12058 NULL, 0, FUV_SUBSCRIPT_NONE);
12060 /* other possibilities not handled are:
12061 * open $x; or open my $x; should return '${*$x}'
12062 * open expr; should return '$'.expr ideally
12068 /* ops where $_ may be an implicit arg */
12072 if ( !(obase->op_flags & OPf_STACKED)) {
12073 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12074 ? PAD_SVl(obase->op_targ)
12077 sv = sv_newmortal();
12078 sv_setpvn(sv, "$_", 2);
12087 /* skip filehandle as it can't produce 'undef' warning */
12088 o = cUNOPx(obase)->op_first;
12089 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12090 o = o->op_sibling->op_sibling;
12097 match = 1; /* XS or custom code could trigger random warnings */
12101 /* def-ness of rval pos() is independent of the def-ness of its arg */
12102 if ( !(obase->op_flags & OPf_MOD))
12107 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12108 return sv_2mortal(newSVpvs("${$/}"));
12113 if (!(obase->op_flags & OPf_KIDS))
12115 o = cUNOPx(obase)->op_first;
12121 /* if all except one arg are constant, or have no side-effects,
12122 * or are optimized away, then it's unambiguous */
12124 for (kid=o; kid; kid = kid->op_sibling) {
12126 const OPCODE type = kid->op_type;
12127 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12128 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12129 || (type == OP_PUSHMARK)
12133 if (o2) { /* more than one found */
12140 return find_uninit_var(o2, uninit_sv, match);
12142 /* scan all args */
12144 sv = find_uninit_var(o, uninit_sv, 1);
12156 =for apidoc report_uninit
12158 Print appropriate "Use of uninitialized variable" warning
12164 Perl_report_uninit(pTHX_ SV* uninit_sv)
12168 SV* varname = NULL;
12170 varname = find_uninit_var(PL_op, uninit_sv,0);
12172 sv_insert(varname, 0, 0, " ", 1);
12174 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12175 varname ? SvPV_nolen_const(varname) : "",
12176 " in ", OP_DESC(PL_op));
12179 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12185 * c-indentation-style: bsd
12186 * c-basic-offset: 4
12187 * indent-tabs-mode: t
12190 * ex: set ts=8 sts=4 sw=4 noet: