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 *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
176 #ifdef DEBUG_LEAKING_SCALARS
177 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
179 # define FREE_SV_DEBUG_FILE(sv)
183 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
184 /* Whilst I'd love to do this, it seems that things like to check on
186 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
188 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
189 PoisonNew(&SvREFCNT(sv), 1, U32)
191 # define SvARENA_CHAIN(sv) SvANY(sv)
192 # define POSION_SV_HEAD(sv)
195 #define plant_SV(p) \
197 FREE_SV_DEBUG_FILE(p); \
199 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 #define uproot_SV(p) \
208 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
213 /* make some more SVs by adding another arena */
222 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
223 PL_nice_chunk = NULL;
224 PL_nice_chunk_size = 0;
227 char *chunk; /* must use New here to match call to */
228 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
229 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
235 /* new_SV(): return a new, empty SV head */
237 #ifdef DEBUG_LEAKING_SCALARS
238 /* provide a real function for a debugger to play with */
247 sv = S_more_sv(aTHX);
251 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
252 sv->sv_debug_line = (U16) (PL_parser
253 ? PL_parser->copline == NOLINE
259 sv->sv_debug_inpad = 0;
260 sv->sv_debug_cloned = 0;
261 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
265 # define new_SV(p) (p)=S_new_SV(aTHX)
273 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
294 S_del_sv(pTHX_ SV *p)
298 PERL_ARGS_ASSERT_DEL_SV;
303 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
304 const SV * const sv = sva + 1;
305 const SV * const svend = &sva[SvREFCNT(sva)];
306 if (p >= sv && p < svend) {
312 if (ckWARN_d(WARN_INTERNAL))
313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
314 "Attempt to free non-arena SV: 0x%"UVxf
315 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
322 #else /* ! DEBUGGING */
324 #define del_SV(p) plant_SV(p)
326 #endif /* DEBUGGING */
330 =head1 SV Manipulation Functions
332 =for apidoc sv_add_arena
334 Given a chunk of memory, link it to the head of the list of arenas,
335 and split it into a list of free SVs.
341 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
344 SV* const sva = (SV*)ptr;
348 PERL_ARGS_ASSERT_SV_ADD_ARENA;
350 /* The first SV in an arena isn't an SV. */
351 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
352 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
353 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
355 PL_sv_arenaroot = sva;
356 PL_sv_root = sva + 1;
358 svend = &sva[SvREFCNT(sva) - 1];
361 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
365 /* Must always set typemask because it's always checked in on cleanup
366 when the arenas are walked looking for objects. */
367 SvFLAGS(sv) = SVTYPEMASK;
370 SvARENA_CHAIN(sv) = 0;
374 SvFLAGS(sv) = SVTYPEMASK;
377 /* visit(): call the named function for each non-free SV in the arenas
378 * whose flags field matches the flags/mask args. */
381 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
387 PERL_ARGS_ASSERT_VISIT;
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
437 /* called by sv_clean_objs() for each live SV */
440 do_clean_objs(pTHX_ SV *const ref)
445 SV * const target = SvRV(ref);
446 if (SvOBJECT(target)) {
447 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
448 if (SvWEAKREF(ref)) {
449 sv_del_backref(target, ref);
455 SvREFCNT_dec(target);
460 /* XXX Might want to check arrays, etc. */
463 /* called by sv_clean_objs() for each live SV */
465 #ifndef DISABLE_DESTRUCTOR_KLUDGE
467 do_clean_named_objs(pTHX_ SV *const sv)
470 assert(SvTYPE(sv) == SVt_PVGV);
471 assert(isGV_with_GP(sv));
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
481 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *const sv)
519 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
520 SvFLAGS(sv) |= SVf_BREAK;
525 =for apidoc sv_clean_all
527 Decrement the refcnt of each remaining SV, possibly triggering a
528 cleanup. This function may have to be called multiple times to free
529 SVs which are in complex self-referential hierarchies.
535 Perl_sv_clean_all(pTHX)
539 PL_in_clean_all = TRUE;
540 cleaned = visit(do_clean_all, 0,0);
541 PL_in_clean_all = FALSE;
546 ARENASETS: a meta-arena implementation which separates arena-info
547 into struct arena_set, which contains an array of struct
548 arena_descs, each holding info for a single arena. By separating
549 the meta-info from the arena, we recover the 1st slot, formerly
550 borrowed for list management. The arena_set is about the size of an
551 arena, avoiding the needless malloc overhead of a naive linked-list.
553 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
554 memory in the last arena-set (1/2 on average). In trade, we get
555 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
556 smaller types). The recovery of the wasted space allows use of
557 small arenas for large, rare body types, by changing array* fields
558 in body_details_by_type[] below.
561 char *arena; /* the raw storage, allocated aligned */
562 size_t size; /* its size ~4k typ */
563 U32 misc; /* type, and in future other things. */
568 /* Get the maximum number of elements in set[] such that struct arena_set
569 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
570 therefore likely to be 1 aligned memory page. */
572 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
573 - 2 * sizeof(int)) / sizeof (struct arena_desc))
576 struct arena_set* next;
577 unsigned int set_size; /* ie ARENAS_PER_SET */
578 unsigned int curr; /* index of next available arena-desc */
579 struct arena_desc set[ARENAS_PER_SET];
583 =for apidoc sv_free_arenas
585 Deallocate the memory used by all arenas. Note that all the individual SV
586 heads and bodies within the arenas must already have been freed.
591 Perl_sv_free_arenas(pTHX)
598 /* Free arenas here, but be careful about fake ones. (We assume
599 contiguity of the fake ones with the corresponding real ones.) */
601 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
602 svanext = (SV*) SvANY(sva);
603 while (svanext && SvFAKE(svanext))
604 svanext = (SV*) SvANY(svanext);
611 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
614 struct arena_set *current = aroot;
617 assert(aroot->set[i].arena);
618 Safefree(aroot->set[i].arena);
626 i = PERL_ARENA_ROOTS_SIZE;
628 PL_body_roots[i] = 0;
630 Safefree(PL_nice_chunk);
631 PL_nice_chunk = NULL;
632 PL_nice_chunk_size = 0;
638 Here are mid-level routines that manage the allocation of bodies out
639 of the various arenas. There are 5 kinds of arenas:
641 1. SV-head arenas, which are discussed and handled above
642 2. regular body arenas
643 3. arenas for reduced-size bodies
645 5. pte arenas (thread related)
647 Arena types 2 & 3 are chained by body-type off an array of
648 arena-root pointers, which is indexed by svtype. Some of the
649 larger/less used body types are malloced singly, since a large
650 unused block of them is wasteful. Also, several svtypes dont have
651 bodies; the data fits into the sv-head itself. The arena-root
652 pointer thus has a few unused root-pointers (which may be hijacked
653 later for arena types 4,5)
655 3 differs from 2 as an optimization; some body types have several
656 unused fields in the front of the structure (which are kept in-place
657 for consistency). These bodies can be allocated in smaller chunks,
658 because the leading fields arent accessed. Pointers to such bodies
659 are decremented to point at the unused 'ghost' memory, knowing that
660 the pointers are used with offsets to the real memory.
662 HE, HEK arenas are managed separately, with separate code, but may
663 be merge-able later..
665 PTE arenas are not sv-bodies, but they share these mid-level
666 mechanics, so are considered here. The new mid-level mechanics rely
667 on the sv_type of the body being allocated, so we just reserve one
668 of the unused body-slots for PTEs, then use it in those (2) PTE
669 contexts below (line ~10k)
672 /* get_arena(size): this creates custom-sized arenas
673 TBD: export properly for hv.c: S_more_he().
676 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
679 struct arena_desc* adesc;
680 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
683 /* shouldnt need this
684 if (!arena_size) arena_size = PERL_ARENA_SIZE;
687 /* may need new arena-set to hold new arena */
688 if (!aroot || aroot->curr >= aroot->set_size) {
689 struct arena_set *newroot;
690 Newxz(newroot, 1, struct arena_set);
691 newroot->set_size = ARENAS_PER_SET;
692 newroot->next = aroot;
694 PL_body_arenas = (void *) newroot;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
698 /* ok, now have arena-set with at least 1 empty/available arena-desc */
699 curr = aroot->curr++;
700 adesc = &(aroot->set[curr]);
701 assert(!adesc->arena);
703 Newx(adesc->arena, arena_size, char);
704 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
707 curr, (void*)adesc->arena, (UV)arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
718 *thing_copy = *root; \
719 *root = (void*)thing_copy; \
724 =head1 SV-Body Allocation
726 Allocation of SV-bodies is similar to SV-heads, differing as follows;
727 the allocation mechanism is used for many body types, so is somewhat
728 more complicated, it uses arena-sets, and has no need for still-live
731 At the outermost level, (new|del)_X*V macros return bodies of the
732 appropriate type. These macros call either (new|del)_body_type or
733 (new|del)_body_allocated macro pairs, depending on specifics of the
734 type. Most body types use the former pair, the latter pair is used to
735 allocate body types with "ghost fields".
737 "ghost fields" are fields that are unused in certain types, and
738 consequently dont need to actually exist. They are declared because
739 they're part of a "base type", which allows use of functions as
740 methods. The simplest examples are AVs and HVs, 2 aggregate types
741 which don't use the fields which support SCALAR semantics.
743 For these types, the arenas are carved up into *_allocated size
744 chunks, we thus avoid wasted memory for those unaccessed members.
745 When bodies are allocated, we adjust the pointer back in memory by the
746 size of the bit not allocated, so it's as if we allocated the full
747 structure. (But things will all go boom if you write to the part that
748 is "not there", because you'll be overwriting the last members of the
749 preceding structure in memory.)
751 We calculate the correction using the STRUCT_OFFSET macro. For
752 example, if xpv_allocated is the same structure as XPV then the two
753 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
754 structure is smaller (no initial NV actually allocated) then the net
755 effect is to subtract the size of the NV from the pointer, to return a
756 new pointer as if an initial NV were actually allocated.
758 This is the same trick as was used for NV and IV bodies. Ironically it
759 doesn't need to be used for NV bodies any more, because NV is now at
760 the start of the structure. IV bodies don't need it either, because
761 they are no longer allocated.
763 In turn, the new_body_* allocators call S_new_body(), which invokes
764 new_body_inline macro, which takes a lock, and takes a body off the
765 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
766 necessary to refresh an empty list. Then the lock is released, and
767 the body is returned.
769 S_more_bodies calls get_arena(), and carves it up into an array of N
770 bodies, which it strings into a linked list. It looks up arena-size
771 and body-size from the body_details table described below, thus
772 supporting the multiple body-types.
774 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
775 the (new|del)_X*V macros are mapped directly to malloc/free.
781 For each sv-type, struct body_details bodies_by_type[] carries
782 parameters which control these aspects of SV handling:
784 Arena_size determines whether arenas are used for this body type, and if
785 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
786 zero, forcing individual mallocs and frees.
788 Body_size determines how big a body is, and therefore how many fit into
789 each arena. Offset carries the body-pointer adjustment needed for
790 *_allocated body types, and is used in *_allocated macros.
792 But its main purpose is to parameterize info needed in
793 Perl_sv_upgrade(). The info here dramatically simplifies the function
794 vs the implementation in 5.8.7, making it table-driven. All fields
795 are used for this, except for arena_size.
797 For the sv-types that have no bodies, arenas are not used, so those
798 PL_body_roots[sv_type] are unused, and can be overloaded. In
799 something of a special case, SVt_NULL is borrowed for HE arenas;
800 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
801 bodies_by_type[SVt_NULL] slot is not used, as the table is not
804 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
805 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
806 just use the same allocation semantics. At first, PTEs were also
807 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
808 bugs, so was simplified by claiming a new slot. This choice has no
809 consequence at this time.
813 struct body_details {
814 U8 body_size; /* Size to allocate */
815 U8 copy; /* Size of structure to copy (may be shorter) */
817 unsigned int type : 4; /* We have space for a sanity check. */
818 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
819 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
820 unsigned int arena : 1; /* Allocated from an arena */
821 size_t arena_size; /* Size of arena to allocate */
829 /* With -DPURFIY we allocate everything directly, and don't use arenas.
830 This seems a rather elegant way to simplify some of the code below. */
831 #define HASARENA FALSE
833 #define HASARENA TRUE
835 #define NOARENA FALSE
837 /* Size the arenas to exactly fit a given number of bodies. A count
838 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
839 simplifying the default. If count > 0, the arena is sized to fit
840 only that many bodies, allowing arenas to be used for large, rare
841 bodies (XPVFM, XPVIO) without undue waste. The arena size is
842 limited by PERL_ARENA_SIZE, so we can safely oversize the
845 #define FIT_ARENA0(body_size) \
846 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
847 #define FIT_ARENAn(count,body_size) \
848 ( count * body_size <= PERL_ARENA_SIZE) \
849 ? count * body_size \
850 : FIT_ARENA0 (body_size)
851 #define FIT_ARENA(count,body_size) \
853 ? FIT_ARENAn (count, body_size) \
854 : FIT_ARENA0 (body_size)
856 /* A macro to work out the offset needed to subtract from a pointer to (say)
863 to make its members accessible via a pointer to (say)
873 #define relative_STRUCT_OFFSET(longer, shorter, member) \
874 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
876 /* Calculate the length to copy. Specifically work out the length less any
877 final padding the compiler needed to add. See the comment in sv_upgrade
878 for why copying the padding proved to be a bug. */
880 #define copy_length(type, last_member) \
881 STRUCT_OFFSET(type, last_member) \
882 + sizeof (((type*)SvANY((SV*)0))->last_member)
884 static const struct body_details bodies_by_type[] = {
885 { sizeof(HE), 0, 0, SVt_NULL,
886 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
888 /* The bind placeholder pretends to be an RV for now.
889 Also it's marked as "can't upgrade" to stop anyone using it before it's
891 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
893 /* IVs are in the head, so the allocation size is 0.
894 However, the slot is overloaded for PTEs. */
895 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
896 sizeof(IV), /* This is used to copy out the IV body. */
897 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
898 NOARENA /* IVS don't need an arena */,
899 /* But PTEs need to know the size of their arena */
900 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
903 /* 8 bytes on most ILP32 with IEEE doubles */
904 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
905 FIT_ARENA(0, sizeof(NV)) },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
931 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
932 SVt_REGEXP, FALSE, NONV, HASARENA,
933 FIT_ARENA(0, sizeof(struct regexp_allocated))
937 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
938 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
941 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
944 { sizeof(xpvav_allocated),
945 copy_length(XPVAV, xmg_stash)
946 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
947 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
948 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
950 { sizeof(xpvhv_allocated),
951 copy_length(XPVHV, xmg_stash)
952 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
953 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
954 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
957 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
958 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
959 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
961 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
962 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
963 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
965 /* XPVIO is 84 bytes, fits 48x */
966 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
967 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
968 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
971 #define new_body_type(sv_type) \
972 (void *)((char *)S_new_body(aTHX_ sv_type))
974 #define del_body_type(p, sv_type) \
975 del_body(p, &PL_body_roots[sv_type])
978 #define new_body_allocated(sv_type) \
979 (void *)((char *)S_new_body(aTHX_ sv_type) \
980 - bodies_by_type[sv_type].offset)
982 #define del_body_allocated(p, sv_type) \
983 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
986 #define my_safemalloc(s) (void*)safemalloc(s)
987 #define my_safecalloc(s) (void*)safecalloc(s, 1)
988 #define my_safefree(p) safefree((char*)p)
992 #define new_XNV() my_safemalloc(sizeof(XPVNV))
993 #define del_XNV(p) my_safefree(p)
995 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XPVNV(p) my_safefree(p)
998 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
999 #define del_XPVAV(p) my_safefree(p)
1001 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1002 #define del_XPVHV(p) my_safefree(p)
1004 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1005 #define del_XPVMG(p) my_safefree(p)
1007 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1008 #define del_XPVGV(p) my_safefree(p)
1012 #define new_XNV() new_body_type(SVt_NV)
1013 #define del_XNV(p) del_body_type(p, SVt_NV)
1015 #define new_XPVNV() new_body_type(SVt_PVNV)
1016 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1018 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1019 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1021 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1022 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1024 #define new_XPVMG() new_body_type(SVt_PVMG)
1025 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1027 #define new_XPVGV() new_body_type(SVt_PVGV)
1028 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1032 /* no arena for you! */
1034 #define new_NOARENA(details) \
1035 my_safemalloc((details)->body_size + (details)->offset)
1036 #define new_NOARENAZ(details) \
1037 my_safecalloc((details)->body_size + (details)->offset)
1040 S_more_bodies (pTHX_ const svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1048 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1049 static bool done_sanity_check;
1051 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1052 * variables like done_sanity_check. */
1053 if (!done_sanity_check) {
1054 unsigned int i = SVt_LAST;
1056 done_sanity_check = TRUE;
1059 assert (bodies_by_type[i].type == i);
1063 assert(bdp->arena_size);
1065 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1067 end = start + bdp->arena_size - body_size;
1069 /* computed count doesnt reflect the 1st slot reservation */
1070 DEBUG_m(PerlIO_printf(Perl_debug_log,
1071 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (void*)start, (void*)end,
1073 (int)bdp->arena_size, sv_type, (int)body_size,
1074 (int)bdp->arena_size / (int)body_size));
1076 *root = (void *)start;
1078 while (start < end) {
1079 char * const next = start + body_size;
1080 *(void**) start = (void *)next;
1083 *(void **)start = 0;
1088 /* grab a new thing from the free list, allocating more if necessary.
1089 The inline version is used for speed in hot routines, and the
1090 function using it serves the rest (unless PURIFY).
1092 #define new_body_inline(xpv, sv_type) \
1094 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1103 S_new_body(pTHX_ const svtype sv_type)
1107 new_body_inline(xpv, sv_type);
1113 static const struct body_details fake_rv =
1114 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1117 =for apidoc sv_upgrade
1119 Upgrade an SV to a more complex form. Generally adds a new body type to the
1120 SV, then copies across as much information as possible from the old body.
1121 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1127 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1132 const svtype old_type = SvTYPE(sv);
1133 const struct body_details *new_type_details;
1134 const struct body_details *old_type_details
1135 = bodies_by_type + old_type;
1136 SV *referant = NULL;
1138 PERL_ARGS_ASSERT_SV_UPGRADE;
1140 if (new_type != SVt_PV && SvIsCOW(sv)) {
1141 sv_force_normal_flags(sv, 0);
1144 if (old_type == new_type)
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1181 this happens to be moot because XPVGV has been re-ordered, with GP
1182 no longer after STASH)
1184 So we are careful and work out the size of used parts of all the
1192 referant = SvRV(sv);
1193 old_type_details = &fake_rv;
1194 if (new_type == SVt_NV)
1195 new_type = SVt_PVNV;
1197 if (new_type < SVt_PVIV) {
1198 new_type = (new_type == SVt_NV)
1199 ? SVt_PVNV : SVt_PVIV;
1204 if (new_type < SVt_PVNV) {
1205 new_type = SVt_PVNV;
1209 assert(new_type > SVt_PV);
1210 assert(SVt_IV < SVt_PV);
1211 assert(SVt_NV < SVt_PV);
1218 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1219 there's no way that it can be safely upgraded, because perl.c
1220 expects to Safefree(SvANY(PL_mess_sv)) */
1221 assert(sv != PL_mess_sv);
1222 /* This flag bit is used to mean other things in other scalar types.
1223 Given that it only has meaning inside the pad, it shouldn't be set
1224 on anything that can get upgraded. */
1225 assert(!SvPAD_TYPED(sv));
1228 if (old_type_details->cant_upgrade)
1229 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1230 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1233 if (old_type > new_type)
1234 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1235 (int)old_type, (int)new_type);
1237 new_type_details = bodies_by_type + new_type;
1239 SvFLAGS(sv) &= ~SVTYPEMASK;
1240 SvFLAGS(sv) |= new_type;
1242 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1243 the return statements above will have triggered. */
1244 assert (new_type != SVt_NULL);
1247 assert(old_type == SVt_NULL);
1248 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1252 assert(old_type == SVt_NULL);
1253 SvANY(sv) = new_XNV();
1258 assert(new_type_details->body_size);
1261 assert(new_type_details->arena);
1262 assert(new_type_details->arena_size);
1263 /* This points to the start of the allocated area. */
1264 new_body_inline(new_body, new_type);
1265 Zero(new_body, new_type_details->body_size, char);
1266 new_body = ((char *)new_body) - new_type_details->offset;
1268 /* We always allocated the full length item with PURIFY. To do this
1269 we fake things so that arena is false for all 16 types.. */
1270 new_body = new_NOARENAZ(new_type_details);
1272 SvANY(sv) = new_body;
1273 if (new_type == SVt_PVAV) {
1277 if (old_type_details->body_size) {
1280 /* It will have been zeroed when the new body was allocated.
1281 Lets not write to it, in case it confuses a write-back
1287 #ifndef NODEFAULT_SHAREKEYS
1288 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1290 HvMAX(sv) = 7; /* (start with 8 buckets) */
1291 if (old_type_details->body_size) {
1294 /* It will have been zeroed when the new body was allocated.
1295 Lets not write to it, in case it confuses a write-back
1300 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1301 The target created by newSVrv also is, and it can have magic.
1302 However, it never has SvPVX set.
1304 if (old_type == SVt_IV) {
1306 } else if (old_type >= SVt_PV) {
1307 assert(SvPVX_const(sv) == 0);
1310 if (old_type >= SVt_PVMG) {
1311 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1312 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1314 sv->sv_u.svu_array = NULL; /* or svu_hash */
1320 /* XXX Is this still needed? Was it ever needed? Surely as there is
1321 no route from NV to PVIV, NOK can never be true */
1322 assert(!SvNOKp(sv));
1334 assert(new_type_details->body_size);
1335 /* We always allocated the full length item with PURIFY. To do this
1336 we fake things so that arena is false for all 16 types.. */
1337 if(new_type_details->arena) {
1338 /* This points to the start of the allocated area. */
1339 new_body_inline(new_body, new_type);
1340 Zero(new_body, new_type_details->body_size, char);
1341 new_body = ((char *)new_body) - new_type_details->offset;
1343 new_body = new_NOARENAZ(new_type_details);
1345 SvANY(sv) = new_body;
1347 if (old_type_details->copy) {
1348 /* There is now the potential for an upgrade from something without
1349 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1350 int offset = old_type_details->offset;
1351 int length = old_type_details->copy;
1353 if (new_type_details->offset > old_type_details->offset) {
1354 const int difference
1355 = new_type_details->offset - old_type_details->offset;
1356 offset += difference;
1357 length -= difference;
1359 assert (length >= 0);
1361 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1365 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1366 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1367 * correct 0.0 for us. Otherwise, if the old body didn't have an
1368 * NV slot, but the new one does, then we need to initialise the
1369 * freshly created NV slot with whatever the correct bit pattern is
1371 if (old_type_details->zero_nv && !new_type_details->zero_nv
1372 && !isGV_with_GP(sv))
1376 if (new_type == SVt_PVIO)
1377 IoPAGE_LEN(sv) = 60;
1378 if (old_type < SVt_PV) {
1379 /* referant will be NULL unless the old type was SVt_IV emulating
1381 sv->sv_u.svu_rv = referant;
1385 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1386 (unsigned long)new_type);
1389 if (old_type_details->arena) {
1390 /* If there was an old body, then we need to free it.
1391 Note that there is an assumption that all bodies of types that
1392 can be upgraded came from arenas. Only the more complex non-
1393 upgradable types are allowed to be directly malloc()ed. */
1395 my_safefree(old_body);
1397 del_body((void*)((char*)old_body + old_type_details->offset),
1398 &PL_body_roots[old_type]);
1404 =for apidoc sv_backoff
1406 Remove any string offset. You should normally use the C<SvOOK_off> macro
1413 Perl_sv_backoff(pTHX_ register SV *const sv)
1416 const char * const s = SvPVX_const(sv);
1418 PERL_ARGS_ASSERT_SV_BACKOFF;
1419 PERL_UNUSED_CONTEXT;
1422 assert(SvTYPE(sv) != SVt_PVHV);
1423 assert(SvTYPE(sv) != SVt_PVAV);
1425 SvOOK_offset(sv, delta);
1427 SvLEN_set(sv, SvLEN(sv) + delta);
1428 SvPV_set(sv, SvPVX(sv) - delta);
1429 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1430 SvFLAGS(sv) &= ~SVf_OOK;
1437 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1438 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1439 Use the C<SvGROW> wrapper instead.
1445 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1449 PERL_ARGS_ASSERT_SV_GROW;
1451 if (PL_madskills && newlen >= 0x100000) {
1452 PerlIO_printf(Perl_debug_log,
1453 "Allocation too large: %"UVxf"\n", (UV)newlen);
1455 #ifdef HAS_64K_LIMIT
1456 if (newlen >= 0x10000) {
1457 PerlIO_printf(Perl_debug_log,
1458 "Allocation too large: %"UVxf"\n", (UV)newlen);
1461 #endif /* HAS_64K_LIMIT */
1464 if (SvTYPE(sv) < SVt_PV) {
1465 sv_upgrade(sv, SVt_PV);
1466 s = SvPVX_mutable(sv);
1468 else if (SvOOK(sv)) { /* pv is offset? */
1470 s = SvPVX_mutable(sv);
1471 if (newlen > SvLEN(sv))
1472 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1473 #ifdef HAS_64K_LIMIT
1474 if (newlen >= 0x10000)
1479 s = SvPVX_mutable(sv);
1481 if (newlen > SvLEN(sv)) { /* need more room? */
1483 newlen = PERL_STRLEN_ROUNDUP(newlen);
1485 if (SvLEN(sv) && s) {
1486 s = (char*)saferealloc(s, newlen);
1489 s = (char*)safemalloc(newlen);
1490 if (SvPVX_const(sv) && SvCUR(sv)) {
1491 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1495 #ifdef Perl_safesysmalloc_size
1496 /* Do this here, do it once, do it right, and then we will never get
1497 called back into sv_grow() unless there really is some growing
1499 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1501 SvLEN_set(sv, newlen);
1508 =for apidoc sv_setiv
1510 Copies an integer into the given SV, upgrading first if necessary.
1511 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1517 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1521 PERL_ARGS_ASSERT_SV_SETIV;
1523 SV_CHECK_THINKFIRST_COW_DROP(sv);
1524 switch (SvTYPE(sv)) {
1527 sv_upgrade(sv, SVt_IV);
1530 sv_upgrade(sv, SVt_PVIV);
1539 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1543 (void)SvIOK_only(sv); /* validate number */
1549 =for apidoc sv_setiv_mg
1551 Like C<sv_setiv>, but also handles 'set' magic.
1557 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1559 PERL_ARGS_ASSERT_SV_SETIV_MG;
1566 =for apidoc sv_setuv
1568 Copies an unsigned integer into the given SV, upgrading first if necessary.
1569 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1575 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1577 PERL_ARGS_ASSERT_SV_SETUV;
1579 /* With these two if statements:
1580 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1583 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1585 If you wish to remove them, please benchmark to see what the effect is
1587 if (u <= (UV)IV_MAX) {
1588 sv_setiv(sv, (IV)u);
1597 =for apidoc sv_setuv_mg
1599 Like C<sv_setuv>, but also handles 'set' magic.
1605 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1607 PERL_ARGS_ASSERT_SV_SETUV_MG;
1614 =for apidoc sv_setnv
1616 Copies a double into the given SV, upgrading first if necessary.
1617 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1623 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1627 PERL_ARGS_ASSERT_SV_SETNV;
1629 SV_CHECK_THINKFIRST_COW_DROP(sv);
1630 switch (SvTYPE(sv)) {
1633 sv_upgrade(sv, SVt_NV);
1637 sv_upgrade(sv, SVt_PVNV);
1646 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1651 (void)SvNOK_only(sv); /* validate number */
1656 =for apidoc sv_setnv_mg
1658 Like C<sv_setnv>, but also handles 'set' magic.
1664 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1666 PERL_ARGS_ASSERT_SV_SETNV_MG;
1672 /* Print an "isn't numeric" warning, using a cleaned-up,
1673 * printable version of the offending string
1677 S_not_a_number(pTHX_ SV *const sv)
1684 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1687 dsv = newSVpvs_flags("", SVs_TEMP);
1688 pv = sv_uni_display(dsv, sv, 10, 0);
1691 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1692 /* each *s can expand to 4 chars + "...\0",
1693 i.e. need room for 8 chars */
1695 const char *s = SvPVX_const(sv);
1696 const char * const end = s + SvCUR(sv);
1697 for ( ; s < end && d < limit; s++ ) {
1699 if (ch & 128 && !isPRINT_LC(ch)) {
1708 else if (ch == '\r') {
1712 else if (ch == '\f') {
1716 else if (ch == '\\') {
1720 else if (ch == '\0') {
1724 else if (isPRINT_LC(ch))
1741 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1742 "Argument \"%s\" isn't numeric in %s", pv,
1745 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1746 "Argument \"%s\" isn't numeric", pv);
1750 =for apidoc looks_like_number
1752 Test if the content of an SV looks like a number (or is a number).
1753 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1754 non-numeric warning), even if your atof() doesn't grok them.
1760 Perl_looks_like_number(pTHX_ SV *const sv)
1762 register const char *sbegin;
1765 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1768 sbegin = SvPVX_const(sv);
1771 else if (SvPOKp(sv))
1772 sbegin = SvPV_const(sv, len);
1774 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1775 return grok_number(sbegin, len, NULL);
1779 S_glob_2number(pTHX_ GV * const gv)
1781 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1782 SV *const buffer = sv_newmortal();
1784 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1786 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1789 gv_efullname3(buffer, gv, "*");
1790 SvFLAGS(gv) |= wasfake;
1792 /* We know that all GVs stringify to something that is not-a-number,
1793 so no need to test that. */
1794 if (ckWARN(WARN_NUMERIC))
1795 not_a_number(buffer);
1796 /* We just want something true to return, so that S_sv_2iuv_common
1797 can tail call us and return true. */
1802 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1804 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1805 SV *const buffer = sv_newmortal();
1807 PERL_ARGS_ASSERT_GLOB_2PV;
1809 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1812 gv_efullname3(buffer, gv, "*");
1813 SvFLAGS(gv) |= wasfake;
1815 assert(SvPOK(buffer));
1817 *len = SvCUR(buffer);
1819 return SvPVX(buffer);
1822 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1823 until proven guilty, assume that things are not that bad... */
1828 As 64 bit platforms often have an NV that doesn't preserve all bits of
1829 an IV (an assumption perl has been based on to date) it becomes necessary
1830 to remove the assumption that the NV always carries enough precision to
1831 recreate the IV whenever needed, and that the NV is the canonical form.
1832 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1833 precision as a side effect of conversion (which would lead to insanity
1834 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1835 1) to distinguish between IV/UV/NV slots that have cached a valid
1836 conversion where precision was lost and IV/UV/NV slots that have a
1837 valid conversion which has lost no precision
1838 2) to ensure that if a numeric conversion to one form is requested that
1839 would lose precision, the precise conversion (or differently
1840 imprecise conversion) is also performed and cached, to prevent
1841 requests for different numeric formats on the same SV causing
1842 lossy conversion chains. (lossless conversion chains are perfectly
1847 SvIOKp is true if the IV slot contains a valid value
1848 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1849 SvNOKp is true if the NV slot contains a valid value
1850 SvNOK is true only if the NV value is accurate
1853 while converting from PV to NV, check to see if converting that NV to an
1854 IV(or UV) would lose accuracy over a direct conversion from PV to
1855 IV(or UV). If it would, cache both conversions, return NV, but mark
1856 SV as IOK NOKp (ie not NOK).
1858 While converting from PV to IV, check to see if converting that IV to an
1859 NV would lose accuracy over a direct conversion from PV to NV. If it
1860 would, cache both conversions, flag similarly.
1862 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1863 correctly because if IV & NV were set NV *always* overruled.
1864 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1865 changes - now IV and NV together means that the two are interchangeable:
1866 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1868 The benefit of this is that operations such as pp_add know that if
1869 SvIOK is true for both left and right operands, then integer addition
1870 can be used instead of floating point (for cases where the result won't
1871 overflow). Before, floating point was always used, which could lead to
1872 loss of precision compared with integer addition.
1874 * making IV and NV equal status should make maths accurate on 64 bit
1876 * may speed up maths somewhat if pp_add and friends start to use
1877 integers when possible instead of fp. (Hopefully the overhead in
1878 looking for SvIOK and checking for overflow will not outweigh the
1879 fp to integer speedup)
1880 * will slow down integer operations (callers of SvIV) on "inaccurate"
1881 values, as the change from SvIOK to SvIOKp will cause a call into
1882 sv_2iv each time rather than a macro access direct to the IV slot
1883 * should speed up number->string conversion on integers as IV is
1884 favoured when IV and NV are equally accurate
1886 ####################################################################
1887 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1888 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1889 On the other hand, SvUOK is true iff UV.
1890 ####################################################################
1892 Your mileage will vary depending your CPU's relative fp to integer
1896 #ifndef NV_PRESERVES_UV
1897 # define IS_NUMBER_UNDERFLOW_IV 1
1898 # define IS_NUMBER_UNDERFLOW_UV 2
1899 # define IS_NUMBER_IV_AND_UV 2
1900 # define IS_NUMBER_OVERFLOW_IV 4
1901 # define IS_NUMBER_OVERFLOW_UV 5
1903 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1905 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1907 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1915 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1917 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));
1918 if (SvNVX(sv) < (NV)IV_MIN) {
1919 (void)SvIOKp_on(sv);
1921 SvIV_set(sv, IV_MIN);
1922 return IS_NUMBER_UNDERFLOW_IV;
1924 if (SvNVX(sv) > (NV)UV_MAX) {
1925 (void)SvIOKp_on(sv);
1928 SvUV_set(sv, UV_MAX);
1929 return IS_NUMBER_OVERFLOW_UV;
1931 (void)SvIOKp_on(sv);
1933 /* Can't use strtol etc to convert this string. (See truth table in
1935 if (SvNVX(sv) <= (UV)IV_MAX) {
1936 SvIV_set(sv, I_V(SvNVX(sv)));
1937 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1938 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1940 /* Integer is imprecise. NOK, IOKp */
1942 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1945 SvUV_set(sv, U_V(SvNVX(sv)));
1946 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1947 if (SvUVX(sv) == UV_MAX) {
1948 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1949 possibly be preserved by NV. Hence, it must be overflow.
1951 return IS_NUMBER_OVERFLOW_UV;
1953 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1955 /* Integer is imprecise. NOK, IOKp */
1957 return IS_NUMBER_OVERFLOW_IV;
1959 #endif /* !NV_PRESERVES_UV*/
1962 S_sv_2iuv_common(pTHX_ SV *const sv)
1966 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1969 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1970 * without also getting a cached IV/UV from it at the same time
1971 * (ie PV->NV conversion should detect loss of accuracy and cache
1972 * IV or UV at same time to avoid this. */
1973 /* IV-over-UV optimisation - choose to cache IV if possible */
1975 if (SvTYPE(sv) == SVt_NV)
1976 sv_upgrade(sv, SVt_PVNV);
1978 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1979 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1980 certainly cast into the IV range at IV_MAX, whereas the correct
1981 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1983 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1984 if (Perl_isnan(SvNVX(sv))) {
1990 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1991 SvIV_set(sv, I_V(SvNVX(sv)));
1992 if (SvNVX(sv) == (NV) SvIVX(sv)
1993 #ifndef NV_PRESERVES_UV
1994 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1995 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1996 /* Don't flag it as "accurately an integer" if the number
1997 came from a (by definition imprecise) NV operation, and
1998 we're outside the range of NV integer precision */
2002 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2004 /* scalar has trailing garbage, eg "42a" */
2006 DEBUG_c(PerlIO_printf(Perl_debug_log,
2007 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2013 /* IV not precise. No need to convert from PV, as NV
2014 conversion would already have cached IV if it detected
2015 that PV->IV would be better than PV->NV->IV
2016 flags already correct - don't set public IOK. */
2017 DEBUG_c(PerlIO_printf(Perl_debug_log,
2018 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2023 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2024 but the cast (NV)IV_MIN rounds to a the value less (more
2025 negative) than IV_MIN which happens to be equal to SvNVX ??
2026 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2027 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2028 (NV)UVX == NVX are both true, but the values differ. :-(
2029 Hopefully for 2s complement IV_MIN is something like
2030 0x8000000000000000 which will be exact. NWC */
2033 SvUV_set(sv, U_V(SvNVX(sv)));
2035 (SvNVX(sv) == (NV) SvUVX(sv))
2036 #ifndef NV_PRESERVES_UV
2037 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2038 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2039 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2040 /* Don't flag it as "accurately an integer" if the number
2041 came from a (by definition imprecise) NV operation, and
2042 we're outside the range of NV integer precision */
2048 DEBUG_c(PerlIO_printf(Perl_debug_log,
2049 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2055 else if (SvPOKp(sv) && SvLEN(sv)) {
2057 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2058 /* We want to avoid a possible problem when we cache an IV/ a UV which
2059 may be later translated to an NV, and the resulting NV is not
2060 the same as the direct translation of the initial string
2061 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2062 be careful to ensure that the value with the .456 is around if the
2063 NV value is requested in the future).
2065 This means that if we cache such an IV/a UV, we need to cache the
2066 NV as well. Moreover, we trade speed for space, and do not
2067 cache the NV if we are sure it's not needed.
2070 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2071 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2072 == IS_NUMBER_IN_UV) {
2073 /* It's definitely an integer, only upgrade to PVIV */
2074 if (SvTYPE(sv) < SVt_PVIV)
2075 sv_upgrade(sv, SVt_PVIV);
2077 } else if (SvTYPE(sv) < SVt_PVNV)
2078 sv_upgrade(sv, SVt_PVNV);
2080 /* If NVs preserve UVs then we only use the UV value if we know that
2081 we aren't going to call atof() below. If NVs don't preserve UVs
2082 then the value returned may have more precision than atof() will
2083 return, even though value isn't perfectly accurate. */
2084 if ((numtype & (IS_NUMBER_IN_UV
2085 #ifdef NV_PRESERVES_UV
2088 )) == IS_NUMBER_IN_UV) {
2089 /* This won't turn off the public IOK flag if it was set above */
2090 (void)SvIOKp_on(sv);
2092 if (!(numtype & IS_NUMBER_NEG)) {
2094 if (value <= (UV)IV_MAX) {
2095 SvIV_set(sv, (IV)value);
2097 /* it didn't overflow, and it was positive. */
2098 SvUV_set(sv, value);
2102 /* 2s complement assumption */
2103 if (value <= (UV)IV_MIN) {
2104 SvIV_set(sv, -(IV)value);
2106 /* Too negative for an IV. This is a double upgrade, but
2107 I'm assuming it will be rare. */
2108 if (SvTYPE(sv) < SVt_PVNV)
2109 sv_upgrade(sv, SVt_PVNV);
2113 SvNV_set(sv, -(NV)value);
2114 SvIV_set(sv, IV_MIN);
2118 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2119 will be in the previous block to set the IV slot, and the next
2120 block to set the NV slot. So no else here. */
2122 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2123 != IS_NUMBER_IN_UV) {
2124 /* It wasn't an (integer that doesn't overflow the UV). */
2125 SvNV_set(sv, Atof(SvPVX_const(sv)));
2127 if (! numtype && ckWARN(WARN_NUMERIC))
2130 #if defined(USE_LONG_DOUBLE)
2131 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2132 PTR2UV(sv), SvNVX(sv)));
2134 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2135 PTR2UV(sv), SvNVX(sv)));
2138 #ifdef NV_PRESERVES_UV
2139 (void)SvIOKp_on(sv);
2141 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2142 SvIV_set(sv, I_V(SvNVX(sv)));
2143 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2146 NOOP; /* Integer is imprecise. NOK, IOKp */
2148 /* UV will not work better than IV */
2150 if (SvNVX(sv) > (NV)UV_MAX) {
2152 /* Integer is inaccurate. NOK, IOKp, is UV */
2153 SvUV_set(sv, UV_MAX);
2155 SvUV_set(sv, U_V(SvNVX(sv)));
2156 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2157 NV preservse UV so can do correct comparison. */
2158 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2161 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2166 #else /* NV_PRESERVES_UV */
2167 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2168 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2169 /* The IV/UV slot will have been set from value returned by
2170 grok_number above. The NV slot has just been set using
2173 assert (SvIOKp(sv));
2175 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2176 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2177 /* Small enough to preserve all bits. */
2178 (void)SvIOKp_on(sv);
2180 SvIV_set(sv, I_V(SvNVX(sv)));
2181 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2183 /* Assumption: first non-preserved integer is < IV_MAX,
2184 this NV is in the preserved range, therefore: */
2185 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2187 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);
2191 0 0 already failed to read UV.
2192 0 1 already failed to read UV.
2193 1 0 you won't get here in this case. IV/UV
2194 slot set, public IOK, Atof() unneeded.
2195 1 1 already read UV.
2196 so there's no point in sv_2iuv_non_preserve() attempting
2197 to use atol, strtol, strtoul etc. */
2199 sv_2iuv_non_preserve (sv, numtype);
2201 sv_2iuv_non_preserve (sv);
2205 #endif /* NV_PRESERVES_UV */
2206 /* It might be more code efficient to go through the entire logic above
2207 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2208 gets complex and potentially buggy, so more programmer efficient
2209 to do it this way, by turning off the public flags: */
2211 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2215 if (isGV_with_GP(sv))
2216 return glob_2number((GV *)sv);
2218 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2219 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2222 if (SvTYPE(sv) < SVt_IV)
2223 /* Typically the caller expects that sv_any is not NULL now. */
2224 sv_upgrade(sv, SVt_IV);
2225 /* Return 0 from the caller. */
2232 =for apidoc sv_2iv_flags
2234 Return the integer value of an SV, doing any necessary string
2235 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2236 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2242 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2247 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2248 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2249 cache IVs just in case. In practice it seems that they never
2250 actually anywhere accessible by user Perl code, let alone get used
2251 in anything other than a string context. */
2252 if (flags & SV_GMAGIC)
2257 return I_V(SvNVX(sv));
2259 if (SvPOKp(sv) && SvLEN(sv)) {
2262 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2264 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2265 == IS_NUMBER_IN_UV) {
2266 /* It's definitely an integer */
2267 if (numtype & IS_NUMBER_NEG) {
2268 if (value < (UV)IV_MIN)
2271 if (value < (UV)IV_MAX)
2276 if (ckWARN(WARN_NUMERIC))
2279 return I_V(Atof(SvPVX_const(sv)));
2284 assert(SvTYPE(sv) >= SVt_PVMG);
2285 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2286 } else if (SvTHINKFIRST(sv)) {
2290 SV * const tmpstr=AMG_CALLun(sv,numer);
2291 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2292 return SvIV(tmpstr);
2295 return PTR2IV(SvRV(sv));
2298 sv_force_normal_flags(sv, 0);
2300 if (SvREADONLY(sv) && !SvOK(sv)) {
2301 if (ckWARN(WARN_UNINITIALIZED))
2307 if (S_sv_2iuv_common(aTHX_ sv))
2310 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2311 PTR2UV(sv),SvIVX(sv)));
2312 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2316 =for apidoc sv_2uv_flags
2318 Return the unsigned integer value of an SV, doing any necessary string
2319 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2320 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2326 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2331 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2332 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2333 cache IVs just in case. */
2334 if (flags & SV_GMAGIC)
2339 return U_V(SvNVX(sv));
2340 if (SvPOKp(sv) && SvLEN(sv)) {
2343 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2345 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2346 == IS_NUMBER_IN_UV) {
2347 /* It's definitely an integer */
2348 if (!(numtype & IS_NUMBER_NEG))
2352 if (ckWARN(WARN_NUMERIC))
2355 return U_V(Atof(SvPVX_const(sv)));
2360 assert(SvTYPE(sv) >= SVt_PVMG);
2361 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2362 } else if (SvTHINKFIRST(sv)) {
2366 SV *const tmpstr = AMG_CALLun(sv,numer);
2367 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2368 return SvUV(tmpstr);
2371 return PTR2UV(SvRV(sv));
2374 sv_force_normal_flags(sv, 0);
2376 if (SvREADONLY(sv) && !SvOK(sv)) {
2377 if (ckWARN(WARN_UNINITIALIZED))
2383 if (S_sv_2iuv_common(aTHX_ sv))
2387 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2388 PTR2UV(sv),SvUVX(sv)));
2389 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2395 Return the num value of an SV, doing any necessary string or integer
2396 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2403 Perl_sv_2nv(pTHX_ register SV *const sv)
2408 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2409 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2410 cache IVs just in case. */
2414 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2415 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2416 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2418 return Atof(SvPVX_const(sv));
2422 return (NV)SvUVX(sv);
2424 return (NV)SvIVX(sv);
2429 assert(SvTYPE(sv) >= SVt_PVMG);
2430 /* This falls through to the report_uninit near the end of the
2432 } else if (SvTHINKFIRST(sv)) {
2436 SV *const tmpstr = AMG_CALLun(sv,numer);
2437 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2438 return SvNV(tmpstr);
2441 return PTR2NV(SvRV(sv));
2444 sv_force_normal_flags(sv, 0);
2446 if (SvREADONLY(sv) && !SvOK(sv)) {
2447 if (ckWARN(WARN_UNINITIALIZED))
2452 if (SvTYPE(sv) < SVt_NV) {
2453 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2454 sv_upgrade(sv, SVt_NV);
2455 #ifdef USE_LONG_DOUBLE
2457 STORE_NUMERIC_LOCAL_SET_STANDARD();
2458 PerlIO_printf(Perl_debug_log,
2459 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2460 PTR2UV(sv), SvNVX(sv));
2461 RESTORE_NUMERIC_LOCAL();
2465 STORE_NUMERIC_LOCAL_SET_STANDARD();
2466 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2467 PTR2UV(sv), SvNVX(sv));
2468 RESTORE_NUMERIC_LOCAL();
2472 else if (SvTYPE(sv) < SVt_PVNV)
2473 sv_upgrade(sv, SVt_PVNV);
2478 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2479 #ifdef NV_PRESERVES_UV
2485 /* Only set the public NV OK flag if this NV preserves the IV */
2486 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2488 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2489 : (SvIVX(sv) == I_V(SvNVX(sv))))
2495 else if (SvPOKp(sv) && SvLEN(sv)) {
2497 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2498 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2500 #ifdef NV_PRESERVES_UV
2501 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2502 == IS_NUMBER_IN_UV) {
2503 /* It's definitely an integer */
2504 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2506 SvNV_set(sv, Atof(SvPVX_const(sv)));
2512 SvNV_set(sv, Atof(SvPVX_const(sv)));
2513 /* Only set the public NV OK flag if this NV preserves the value in
2514 the PV at least as well as an IV/UV would.
2515 Not sure how to do this 100% reliably. */
2516 /* if that shift count is out of range then Configure's test is
2517 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2519 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2520 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2521 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2522 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2523 /* Can't use strtol etc to convert this string, so don't try.
2524 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2527 /* value has been set. It may not be precise. */
2528 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2529 /* 2s complement assumption for (UV)IV_MIN */
2530 SvNOK_on(sv); /* Integer is too negative. */
2535 if (numtype & IS_NUMBER_NEG) {
2536 SvIV_set(sv, -(IV)value);
2537 } else if (value <= (UV)IV_MAX) {
2538 SvIV_set(sv, (IV)value);
2540 SvUV_set(sv, value);
2544 if (numtype & IS_NUMBER_NOT_INT) {
2545 /* I believe that even if the original PV had decimals,
2546 they are lost beyond the limit of the FP precision.
2547 However, neither is canonical, so both only get p
2548 flags. NWC, 2000/11/25 */
2549 /* Both already have p flags, so do nothing */
2551 const NV nv = SvNVX(sv);
2552 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2553 if (SvIVX(sv) == I_V(nv)) {
2556 /* It had no "." so it must be integer. */
2560 /* between IV_MAX and NV(UV_MAX).
2561 Could be slightly > UV_MAX */
2563 if (numtype & IS_NUMBER_NOT_INT) {
2564 /* UV and NV both imprecise. */
2566 const UV nv_as_uv = U_V(nv);
2568 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2577 /* It might be more code efficient to go through the entire logic above
2578 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2579 gets complex and potentially buggy, so more programmer efficient
2580 to do it this way, by turning off the public flags: */
2582 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2583 #endif /* NV_PRESERVES_UV */
2586 if (isGV_with_GP(sv)) {
2587 glob_2number((GV *)sv);
2591 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2593 assert (SvTYPE(sv) >= SVt_NV);
2594 /* Typically the caller expects that sv_any is not NULL now. */
2595 /* XXX Ilya implies that this is a bug in callers that assume this
2596 and ideally should be fixed. */
2599 #if defined(USE_LONG_DOUBLE)
2601 STORE_NUMERIC_LOCAL_SET_STANDARD();
2602 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2603 PTR2UV(sv), SvNVX(sv));
2604 RESTORE_NUMERIC_LOCAL();
2608 STORE_NUMERIC_LOCAL_SET_STANDARD();
2609 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2610 PTR2UV(sv), SvNVX(sv));
2611 RESTORE_NUMERIC_LOCAL();
2620 Return an SV with the numeric value of the source SV, doing any necessary
2621 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2622 access this function.
2628 Perl_sv_2num(pTHX_ register SV *const sv)
2630 PERL_ARGS_ASSERT_SV_2NUM;
2635 SV * const tmpsv = AMG_CALLun(sv,numer);
2636 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2637 return sv_2num(tmpsv);
2639 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2642 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2643 * UV as a string towards the end of buf, and return pointers to start and
2646 * We assume that buf is at least TYPE_CHARS(UV) long.
2650 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2652 char *ptr = buf + TYPE_CHARS(UV);
2653 char * const ebuf = ptr;
2656 PERL_ARGS_ASSERT_UIV_2BUF;
2668 *--ptr = '0' + (char)(uv % 10);
2677 =for apidoc sv_2pv_flags
2679 Returns a pointer to the string value of an SV, and sets *lp to its length.
2680 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2682 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2683 usually end up here too.
2689 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2699 if (SvGMAGICAL(sv)) {
2700 if (flags & SV_GMAGIC)
2705 if (flags & SV_MUTABLE_RETURN)
2706 return SvPVX_mutable(sv);
2707 if (flags & SV_CONST_RETURN)
2708 return (char *)SvPVX_const(sv);
2711 if (SvIOKp(sv) || SvNOKp(sv)) {
2712 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2717 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2718 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2720 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2727 #ifdef FIXNEGATIVEZERO
2728 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2734 SvUPGRADE(sv, SVt_PV);
2737 s = SvGROW_mutable(sv, len + 1);
2740 return (char*)memcpy(s, tbuf, len + 1);
2746 assert(SvTYPE(sv) >= SVt_PVMG);
2747 /* This falls through to the report_uninit near the end of the
2749 } else if (SvTHINKFIRST(sv)) {
2753 SV *const tmpstr = AMG_CALLun(sv,string);
2754 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2756 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2760 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2761 if (flags & SV_CONST_RETURN) {
2762 pv = (char *) SvPVX_const(tmpstr);
2764 pv = (flags & SV_MUTABLE_RETURN)
2765 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2768 *lp = SvCUR(tmpstr);
2770 pv = sv_2pv_flags(tmpstr, lp, flags);
2783 const SV *const referent = (SV*)SvRV(sv);
2787 retval = buffer = savepvn("NULLREF", len);
2788 } else if (SvTYPE(referent) == SVt_REGEXP) {
2789 const REGEXP * const re = (REGEXP *)referent;
2794 /* If the regex is UTF-8 we want the containing scalar to
2795 have an UTF-8 flag too */
2801 if ((seen_evals = RX_SEEN_EVALS(re)))
2802 PL_reginterp_cnt += seen_evals;
2805 *lp = RX_WRAPLEN(re);
2807 return RX_WRAPPED(re);
2809 const char *const typestr = sv_reftype(referent, 0);
2810 const STRLEN typelen = strlen(typestr);
2811 UV addr = PTR2UV(referent);
2812 const char *stashname = NULL;
2813 STRLEN stashnamelen = 0; /* hush, gcc */
2814 const char *buffer_end;
2816 if (SvOBJECT(referent)) {
2817 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2820 stashname = HEK_KEY(name);
2821 stashnamelen = HEK_LEN(name);
2823 if (HEK_UTF8(name)) {
2829 stashname = "__ANON__";
2832 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2833 + 2 * sizeof(UV) + 2 /* )\0 */;
2835 len = typelen + 3 /* (0x */
2836 + 2 * sizeof(UV) + 2 /* )\0 */;
2839 Newx(buffer, len, char);
2840 buffer_end = retval = buffer + len;
2842 /* Working backwards */
2846 *--retval = PL_hexdigit[addr & 15];
2847 } while (addr >>= 4);
2853 memcpy(retval, typestr, typelen);
2857 retval -= stashnamelen;
2858 memcpy(retval, stashname, stashnamelen);
2860 /* retval may not neccesarily have reached the start of the
2862 assert (retval >= buffer);
2864 len = buffer_end - retval - 1; /* -1 for that \0 */
2872 if (SvREADONLY(sv) && !SvOK(sv)) {
2875 if (flags & SV_UNDEF_RETURNS_NULL)
2877 if (ckWARN(WARN_UNINITIALIZED))
2882 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2883 /* I'm assuming that if both IV and NV are equally valid then
2884 converting the IV is going to be more efficient */
2885 const U32 isUIOK = SvIsUV(sv);
2886 char buf[TYPE_CHARS(UV)];
2890 if (SvTYPE(sv) < SVt_PVIV)
2891 sv_upgrade(sv, SVt_PVIV);
2892 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2894 /* inlined from sv_setpvn */
2895 s = SvGROW_mutable(sv, len + 1);
2896 Move(ptr, s, len, char);
2900 else if (SvNOKp(sv)) {
2901 const int olderrno = errno;
2902 if (SvTYPE(sv) < SVt_PVNV)
2903 sv_upgrade(sv, SVt_PVNV);
2904 /* The +20 is pure guesswork. Configure test needed. --jhi */
2905 s = SvGROW_mutable(sv, NV_DIG + 20);
2906 /* some Xenix systems wipe out errno here */
2908 if (SvNVX(sv) == 0.0)
2909 my_strlcpy(s, "0", SvLEN(sv));
2913 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2916 #ifdef FIXNEGATIVEZERO
2917 if (*s == '-' && s[1] == '0' && !s[2]) {
2929 if (isGV_with_GP(sv))
2930 return glob_2pv((GV *)sv, lp);
2934 if (flags & SV_UNDEF_RETURNS_NULL)
2936 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2938 if (SvTYPE(sv) < SVt_PV)
2939 /* Typically the caller expects that sv_any is not NULL now. */
2940 sv_upgrade(sv, SVt_PV);
2944 const STRLEN len = s - SvPVX_const(sv);
2950 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2951 PTR2UV(sv),SvPVX_const(sv)));
2952 if (flags & SV_CONST_RETURN)
2953 return (char *)SvPVX_const(sv);
2954 if (flags & SV_MUTABLE_RETURN)
2955 return SvPVX_mutable(sv);
2960 =for apidoc sv_copypv
2962 Copies a stringified representation of the source SV into the
2963 destination SV. Automatically performs any necessary mg_get and
2964 coercion of numeric values into strings. Guaranteed to preserve
2965 UTF8 flag even from overloaded objects. Similar in nature to
2966 sv_2pv[_flags] but operates directly on an SV instead of just the
2967 string. Mostly uses sv_2pv_flags to do its work, except when that
2968 would lose the UTF-8'ness of the PV.
2974 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2977 const char * const s = SvPV_const(ssv,len);
2979 PERL_ARGS_ASSERT_SV_COPYPV;
2981 sv_setpvn(dsv,s,len);
2989 =for apidoc sv_2pvbyte
2991 Return a pointer to the byte-encoded representation of the SV, and set *lp
2992 to its length. May cause the SV to be downgraded from UTF-8 as a
2995 Usually accessed via the C<SvPVbyte> macro.
3001 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3003 PERL_ARGS_ASSERT_SV_2PVBYTE;
3005 sv_utf8_downgrade(sv,0);
3006 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3010 =for apidoc sv_2pvutf8
3012 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3013 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3015 Usually accessed via the C<SvPVutf8> macro.
3021 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3023 PERL_ARGS_ASSERT_SV_2PVUTF8;
3025 sv_utf8_upgrade(sv);
3026 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3031 =for apidoc sv_2bool
3033 This function is only called on magical items, and is only used by
3034 sv_true() or its macro equivalent.
3040 Perl_sv_2bool(pTHX_ register SV *sv)
3044 PERL_ARGS_ASSERT_SV_2BOOL;
3052 SV * const tmpsv = AMG_CALLun(sv,bool_);
3053 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3054 return (bool)SvTRUE(tmpsv);
3056 return SvRV(sv) != 0;
3059 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3061 (*sv->sv_u.svu_pv > '0' ||
3062 Xpvtmp->xpv_cur > 1 ||
3063 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3070 return SvIVX(sv) != 0;
3073 return SvNVX(sv) != 0.0;
3075 if (isGV_with_GP(sv))
3085 =for apidoc sv_utf8_upgrade
3087 Converts the PV of an SV to its UTF-8-encoded form.
3088 Forces the SV to string form if it is not already.
3089 Always sets the SvUTF8 flag to avoid future validity checks even
3090 if all the bytes have hibit clear.
3092 This is not as a general purpose byte encoding to Unicode interface:
3093 use the Encode extension for that.
3095 =for apidoc sv_utf8_upgrade_flags
3097 Converts the PV of an SV to its UTF-8-encoded form.
3098 Forces the SV to string form if it is not already.
3099 Always sets the SvUTF8 flag to avoid future validity checks even
3100 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3101 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3102 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3104 This is not as a general purpose byte encoding to Unicode interface:
3105 use the Encode extension for that.
3111 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3115 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3117 if (sv == &PL_sv_undef)
3121 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3122 (void) sv_2pv_flags(sv,&len, flags);
3126 (void) SvPV_force(sv,len);
3135 sv_force_normal_flags(sv, 0);
3138 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3139 sv_recode_to_utf8(sv, PL_encoding);
3140 else { /* Assume Latin-1/EBCDIC */
3141 /* This function could be much more efficient if we
3142 * had a FLAG in SVs to signal if there are any hibit
3143 * chars in the PV. Given that there isn't such a flag
3144 * make the loop as fast as possible. */
3145 const U8 * const s = (U8 *) SvPVX_const(sv);
3146 const U8 * const e = (U8 *) SvEND(sv);
3151 /* Check for hi bit */
3152 if (!NATIVE_IS_INVARIANT(ch)) {
3153 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3154 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3156 SvPV_free(sv); /* No longer using what was there before. */
3157 SvPV_set(sv, (char*)recoded);
3158 SvCUR_set(sv, len - 1);
3159 SvLEN_set(sv, len); /* No longer know the real size. */
3163 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3170 =for apidoc sv_utf8_downgrade
3172 Attempts to convert the PV of an SV from characters to bytes.
3173 If the PV contains a character beyond byte, this conversion will fail;
3174 in this case, either returns false or, if C<fail_ok> is not
3177 This is not as a general purpose Unicode to byte encoding interface:
3178 use the Encode extension for that.
3184 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3188 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3190 if (SvPOKp(sv) && SvUTF8(sv)) {
3196 sv_force_normal_flags(sv, 0);
3198 s = (U8 *) SvPV(sv, len);
3199 if (!utf8_to_bytes(s, &len)) {
3204 Perl_croak(aTHX_ "Wide character in %s",
3207 Perl_croak(aTHX_ "Wide character");
3218 =for apidoc sv_utf8_encode
3220 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3221 flag off so that it looks like octets again.
3227 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3229 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3232 sv_force_normal_flags(sv, 0);
3234 if (SvREADONLY(sv)) {
3235 Perl_croak(aTHX_ PL_no_modify);
3237 (void) sv_utf8_upgrade(sv);
3242 =for apidoc sv_utf8_decode
3244 If the PV of the SV is an octet sequence in UTF-8
3245 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3246 so that it looks like a character. If the PV contains only single-byte
3247 characters, the C<SvUTF8> flag stays being off.
3248 Scans PV for validity and returns false if the PV is invalid UTF-8.
3254 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3256 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3262 /* The octets may have got themselves encoded - get them back as
3265 if (!sv_utf8_downgrade(sv, TRUE))
3268 /* it is actually just a matter of turning the utf8 flag on, but
3269 * we want to make sure everything inside is valid utf8 first.
3271 c = (const U8 *) SvPVX_const(sv);
3272 if (!is_utf8_string(c, SvCUR(sv)+1))
3274 e = (const U8 *) SvEND(sv);
3277 if (!UTF8_IS_INVARIANT(ch)) {
3287 =for apidoc sv_setsv
3289 Copies the contents of the source SV C<ssv> into the destination SV
3290 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3291 function if the source SV needs to be reused. Does not handle 'set' magic.
3292 Loosely speaking, it performs a copy-by-value, obliterating any previous
3293 content of the destination.
3295 You probably want to use one of the assortment of wrappers, such as
3296 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3297 C<SvSetMagicSV_nosteal>.
3299 =for apidoc sv_setsv_flags
3301 Copies the contents of the source SV C<ssv> into the destination SV
3302 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3303 function if the source SV needs to be reused. Does not handle 'set' magic.
3304 Loosely speaking, it performs a copy-by-value, obliterating any previous
3305 content of the destination.
3306 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3307 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3308 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3309 and C<sv_setsv_nomg> are implemented in terms of this function.
3311 You probably want to use one of the assortment of wrappers, such as
3312 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3313 C<SvSetMagicSV_nosteal>.
3315 This is the primary function for copying scalars, and most other
3316 copy-ish functions and macros use this underneath.
3322 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3324 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3326 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3328 if (dtype != SVt_PVGV) {
3329 const char * const name = GvNAME(sstr);
3330 const STRLEN len = GvNAMELEN(sstr);
3332 if (dtype >= SVt_PV) {
3338 SvUPGRADE(dstr, SVt_PVGV);
3339 (void)SvOK_off(dstr);
3340 /* FIXME - why are we doing this, then turning it off and on again
3342 isGV_with_GP_on(dstr);
3344 GvSTASH(dstr) = GvSTASH(sstr);
3346 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3347 gv_name_set((GV *)dstr, name, len, GV_ADD);
3348 SvFAKE_on(dstr); /* can coerce to non-glob */
3351 #ifdef GV_UNIQUE_CHECK
3352 if (GvUNIQUE((GV*)dstr)) {
3353 Perl_croak(aTHX_ PL_no_modify);
3357 if(GvGP((GV*)sstr)) {
3358 /* If source has method cache entry, clear it */
3360 SvREFCNT_dec(GvCV(sstr));
3364 /* If source has a real method, then a method is
3366 else if(GvCV((GV*)sstr)) {
3371 /* If dest already had a real method, that's a change as well */
3372 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3376 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3380 isGV_with_GP_off(dstr);
3381 (void)SvOK_off(dstr);
3382 isGV_with_GP_on(dstr);
3383 GvINTRO_off(dstr); /* one-shot flag */
3384 GvGP(dstr) = gp_ref(GvGP(sstr));
3385 if (SvTAINTED(sstr))
3387 if (GvIMPORTED(dstr) != GVf_IMPORTED
3388 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3390 GvIMPORTED_on(dstr);
3393 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3394 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3399 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr)
3401 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3403 const int intro = GvINTRO(dstr);
3406 const U32 stype = SvTYPE(sref);
3408 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3410 #ifdef GV_UNIQUE_CHECK
3411 if (GvUNIQUE((GV*)dstr)) {
3412 Perl_croak(aTHX_ PL_no_modify);
3417 GvINTRO_off(dstr); /* one-shot flag */
3418 GvLINE(dstr) = CopLINE(PL_curcop);
3419 GvEGV(dstr) = (GV*)dstr;
3424 location = (SV **) &GvCV(dstr);
3425 import_flag = GVf_IMPORTED_CV;
3428 location = (SV **) &GvHV(dstr);
3429 import_flag = GVf_IMPORTED_HV;
3432 location = (SV **) &GvAV(dstr);
3433 import_flag = GVf_IMPORTED_AV;
3436 location = (SV **) &GvIOp(dstr);
3439 location = (SV **) &GvFORM(dstr);
3441 location = &GvSV(dstr);
3442 import_flag = GVf_IMPORTED_SV;
3445 if (stype == SVt_PVCV) {
3446 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3447 if (GvCVGEN(dstr)) {
3448 SvREFCNT_dec(GvCV(dstr));
3450 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3453 SAVEGENERICSV(*location);
3457 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3458 CV* const cv = (CV*)*location;
3460 if (!GvCVGEN((GV*)dstr) &&
3461 (CvROOT(cv) || CvXSUB(cv)))
3463 /* Redefining a sub - warning is mandatory if
3464 it was a const and its value changed. */
3465 if (CvCONST(cv) && CvCONST((CV*)sref)
3466 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3468 /* They are 2 constant subroutines generated from
3469 the same constant. This probably means that
3470 they are really the "same" proxy subroutine
3471 instantiated in 2 places. Most likely this is
3472 when a constant is exported twice. Don't warn.
3475 else if (ckWARN(WARN_REDEFINE)
3477 && (!CvCONST((CV*)sref)
3478 || sv_cmp(cv_const_sv(cv),
3479 cv_const_sv((CV*)sref))))) {
3480 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3483 ? "Constant subroutine %s::%s redefined"
3484 : "Subroutine %s::%s redefined"),
3485 HvNAME_get(GvSTASH((GV*)dstr)),
3486 GvENAME((GV*)dstr));
3490 cv_ckproto_len(cv, (GV*)dstr,
3491 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3492 SvPOK(sref) ? SvCUR(sref) : 0);
3494 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3495 GvASSUMECV_on(dstr);
3496 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3499 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3500 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3501 GvFLAGS(dstr) |= import_flag;
3506 if (SvTAINTED(sstr))
3512 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3515 register U32 sflags;
3517 register svtype stype;
3519 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3524 if (SvIS_FREED(dstr)) {
3525 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3526 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3528 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3530 sstr = &PL_sv_undef;
3531 if (SvIS_FREED(sstr)) {
3532 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3533 (void*)sstr, (void*)dstr);
3535 stype = SvTYPE(sstr);
3536 dtype = SvTYPE(dstr);
3538 (void)SvAMAGIC_off(dstr);
3541 /* need to nuke the magic */
3543 SvRMAGICAL_off(dstr);
3546 /* There's a lot of redundancy below but we're going for speed here */
3551 if (dtype != SVt_PVGV) {
3552 (void)SvOK_off(dstr);
3560 sv_upgrade(dstr, SVt_IV);
3564 sv_upgrade(dstr, SVt_PVIV);
3567 goto end_of_first_switch;
3569 (void)SvIOK_only(dstr);
3570 SvIV_set(dstr, SvIVX(sstr));
3573 /* SvTAINTED can only be true if the SV has taint magic, which in
3574 turn means that the SV type is PVMG (or greater). This is the
3575 case statement for SVt_IV, so this cannot be true (whatever gcov
3577 assert(!SvTAINTED(sstr));
3582 if (dtype < SVt_PV && dtype != SVt_IV)
3583 sv_upgrade(dstr, SVt_IV);
3591 sv_upgrade(dstr, SVt_NV);
3595 sv_upgrade(dstr, SVt_PVNV);
3598 goto end_of_first_switch;
3600 SvNV_set(dstr, SvNVX(sstr));
3601 (void)SvNOK_only(dstr);
3602 /* SvTAINTED can only be true if the SV has taint magic, which in
3603 turn means that the SV type is PVMG (or greater). This is the
3604 case statement for SVt_NV, so this cannot be true (whatever gcov
3606 assert(!SvTAINTED(sstr));
3612 #ifdef PERL_OLD_COPY_ON_WRITE
3613 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3614 if (dtype < SVt_PVIV)
3615 sv_upgrade(dstr, SVt_PVIV);
3623 sv_upgrade(dstr, SVt_PV);
3626 if (dtype < SVt_PVIV)
3627 sv_upgrade(dstr, SVt_PVIV);
3630 if (dtype < SVt_PVNV)
3631 sv_upgrade(dstr, SVt_PVNV);
3635 const char * const type = sv_reftype(sstr,0);
3637 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3639 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3643 /* case SVt_BIND: */
3646 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3647 glob_assign_glob(dstr, sstr, dtype);
3650 /* SvVALID means that this PVGV is playing at being an FBM. */
3654 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3656 if (SvTYPE(sstr) != stype) {
3657 stype = SvTYPE(sstr);
3658 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3659 glob_assign_glob(dstr, sstr, dtype);
3664 if (stype == SVt_PVLV)
3665 SvUPGRADE(dstr, SVt_PVNV);
3667 SvUPGRADE(dstr, (svtype)stype);
3669 end_of_first_switch:
3671 /* dstr may have been upgraded. */
3672 dtype = SvTYPE(dstr);
3673 sflags = SvFLAGS(sstr);
3675 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3676 /* Assigning to a subroutine sets the prototype. */
3679 const char *const ptr = SvPV_const(sstr, len);
3681 SvGROW(dstr, len + 1);
3682 Copy(ptr, SvPVX(dstr), len + 1, char);
3683 SvCUR_set(dstr, len);
3685 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3689 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3690 const char * const type = sv_reftype(dstr,0);
3692 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3694 Perl_croak(aTHX_ "Cannot copy to %s", type);
3695 } else if (sflags & SVf_ROK) {
3696 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3697 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3700 if (GvIMPORTED(dstr) != GVf_IMPORTED
3701 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3703 GvIMPORTED_on(dstr);
3708 glob_assign_glob(dstr, sstr, dtype);
3712 if (dtype >= SVt_PV) {
3713 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3714 glob_assign_ref(dstr, sstr);
3717 if (SvPVX_const(dstr)) {
3723 (void)SvOK_off(dstr);
3724 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3725 SvFLAGS(dstr) |= sflags & SVf_ROK;
3726 assert(!(sflags & SVp_NOK));
3727 assert(!(sflags & SVp_IOK));
3728 assert(!(sflags & SVf_NOK));
3729 assert(!(sflags & SVf_IOK));
3731 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3732 if (!(sflags & SVf_OK)) {
3733 if (ckWARN(WARN_MISC))
3734 Perl_warner(aTHX_ packWARN(WARN_MISC),
3735 "Undefined value assigned to typeglob");
3738 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3739 if (dstr != (SV*)gv) {
3742 GvGP(dstr) = gp_ref(GvGP(gv));
3746 else if (sflags & SVp_POK) {
3750 * Check to see if we can just swipe the string. If so, it's a
3751 * possible small lose on short strings, but a big win on long ones.
3752 * It might even be a win on short strings if SvPVX_const(dstr)
3753 * has to be allocated and SvPVX_const(sstr) has to be freed.
3754 * Likewise if we can set up COW rather than doing an actual copy, we
3755 * drop to the else clause, as the swipe code and the COW setup code
3756 * have much in common.
3759 /* Whichever path we take through the next code, we want this true,
3760 and doing it now facilitates the COW check. */
3761 (void)SvPOK_only(dstr);
3764 /* If we're already COW then this clause is not true, and if COW
3765 is allowed then we drop down to the else and make dest COW
3766 with us. If caller hasn't said that we're allowed to COW
3767 shared hash keys then we don't do the COW setup, even if the
3768 source scalar is a shared hash key scalar. */
3769 (((flags & SV_COW_SHARED_HASH_KEYS)
3770 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3771 : 1 /* If making a COW copy is forbidden then the behaviour we
3772 desire is as if the source SV isn't actually already
3773 COW, even if it is. So we act as if the source flags
3774 are not COW, rather than actually testing them. */
3776 #ifndef PERL_OLD_COPY_ON_WRITE
3777 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3778 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3779 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3780 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3781 but in turn, it's somewhat dead code, never expected to go
3782 live, but more kept as a placeholder on how to do it better
3783 in a newer implementation. */
3784 /* If we are COW and dstr is a suitable target then we drop down
3785 into the else and make dest a COW of us. */
3786 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3791 (sflags & SVs_TEMP) && /* slated for free anyway? */
3792 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3793 (!(flags & SV_NOSTEAL)) &&
3794 /* and we're allowed to steal temps */
3795 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3796 SvLEN(sstr) && /* and really is a string */
3797 /* and won't be needed again, potentially */
3798 !(PL_op && PL_op->op_type == OP_AASSIGN))
3799 #ifdef PERL_OLD_COPY_ON_WRITE
3800 && ((flags & SV_COW_SHARED_HASH_KEYS)
3801 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3802 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3803 && SvTYPE(sstr) >= SVt_PVIV))
3807 /* Failed the swipe test, and it's not a shared hash key either.
3808 Have to copy the string. */
3809 STRLEN len = SvCUR(sstr);
3810 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3811 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3812 SvCUR_set(dstr, len);
3813 *SvEND(dstr) = '\0';
3815 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3817 /* Either it's a shared hash key, or it's suitable for
3818 copy-on-write or we can swipe the string. */
3820 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3824 #ifdef PERL_OLD_COPY_ON_WRITE
3826 /* I believe I should acquire a global SV mutex if
3827 it's a COW sv (not a shared hash key) to stop
3828 it going un copy-on-write.
3829 If the source SV has gone un copy on write between up there
3830 and down here, then (assert() that) it is of the correct
3831 form to make it copy on write again */
3832 if ((sflags & (SVf_FAKE | SVf_READONLY))
3833 != (SVf_FAKE | SVf_READONLY)) {
3834 SvREADONLY_on(sstr);
3836 /* Make the source SV into a loop of 1.
3837 (about to become 2) */
3838 SV_COW_NEXT_SV_SET(sstr, sstr);
3842 /* Initial code is common. */
3843 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3848 /* making another shared SV. */
3849 STRLEN cur = SvCUR(sstr);
3850 STRLEN len = SvLEN(sstr);
3851 #ifdef PERL_OLD_COPY_ON_WRITE
3853 assert (SvTYPE(dstr) >= SVt_PVIV);
3854 /* SvIsCOW_normal */
3855 /* splice us in between source and next-after-source. */
3856 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3857 SV_COW_NEXT_SV_SET(sstr, dstr);
3858 SvPV_set(dstr, SvPVX_mutable(sstr));
3862 /* SvIsCOW_shared_hash */
3863 DEBUG_C(PerlIO_printf(Perl_debug_log,
3864 "Copy on write: Sharing hash\n"));
3866 assert (SvTYPE(dstr) >= SVt_PV);
3868 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3870 SvLEN_set(dstr, len);
3871 SvCUR_set(dstr, cur);
3872 SvREADONLY_on(dstr);
3874 /* Relesase a global SV mutex. */
3877 { /* Passes the swipe test. */
3878 SvPV_set(dstr, SvPVX_mutable(sstr));
3879 SvLEN_set(dstr, SvLEN(sstr));
3880 SvCUR_set(dstr, SvCUR(sstr));
3883 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3884 SvPV_set(sstr, NULL);
3890 if (sflags & SVp_NOK) {
3891 SvNV_set(dstr, SvNVX(sstr));
3893 if (sflags & SVp_IOK) {
3894 SvIV_set(dstr, SvIVX(sstr));
3895 /* Must do this otherwise some other overloaded use of 0x80000000
3896 gets confused. I guess SVpbm_VALID */
3897 if (sflags & SVf_IVisUV)
3900 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3902 const MAGIC * const smg = SvVSTRING_mg(sstr);
3904 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3905 smg->mg_ptr, smg->mg_len);
3906 SvRMAGICAL_on(dstr);
3910 else if (sflags & (SVp_IOK|SVp_NOK)) {
3911 (void)SvOK_off(dstr);
3912 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3913 if (sflags & SVp_IOK) {
3914 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3915 SvIV_set(dstr, SvIVX(sstr));
3917 if (sflags & SVp_NOK) {
3918 SvNV_set(dstr, SvNVX(sstr));
3922 if (isGV_with_GP(sstr)) {
3923 /* This stringification rule for globs is spread in 3 places.
3924 This feels bad. FIXME. */
3925 const U32 wasfake = sflags & SVf_FAKE;
3927 /* FAKE globs can get coerced, so need to turn this off
3928 temporarily if it is on. */
3930 gv_efullname3(dstr, (GV *)sstr, "*");
3931 SvFLAGS(sstr) |= wasfake;
3934 (void)SvOK_off(dstr);
3936 if (SvTAINTED(sstr))
3941 =for apidoc sv_setsv_mg
3943 Like C<sv_setsv>, but also handles 'set' magic.
3949 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3951 PERL_ARGS_ASSERT_SV_SETSV_MG;
3953 sv_setsv(dstr,sstr);
3957 #ifdef PERL_OLD_COPY_ON_WRITE
3959 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3961 STRLEN cur = SvCUR(sstr);
3962 STRLEN len = SvLEN(sstr);
3963 register char *new_pv;
3965 PERL_ARGS_ASSERT_SV_SETSV_COW;
3968 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3969 (void*)sstr, (void*)dstr);
3976 if (SvTHINKFIRST(dstr))
3977 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3978 else if (SvPVX_const(dstr))
3979 Safefree(SvPVX_const(dstr));
3983 SvUPGRADE(dstr, SVt_PVIV);
3985 assert (SvPOK(sstr));
3986 assert (SvPOKp(sstr));
3987 assert (!SvIOK(sstr));
3988 assert (!SvIOKp(sstr));
3989 assert (!SvNOK(sstr));
3990 assert (!SvNOKp(sstr));
3992 if (SvIsCOW(sstr)) {
3994 if (SvLEN(sstr) == 0) {
3995 /* source is a COW shared hash key. */
3996 DEBUG_C(PerlIO_printf(Perl_debug_log,
3997 "Fast copy on write: Sharing hash\n"));
3998 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4001 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4003 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4004 SvUPGRADE(sstr, SVt_PVIV);
4005 SvREADONLY_on(sstr);
4007 DEBUG_C(PerlIO_printf(Perl_debug_log,
4008 "Fast copy on write: Converting sstr to COW\n"));
4009 SV_COW_NEXT_SV_SET(dstr, sstr);
4011 SV_COW_NEXT_SV_SET(sstr, dstr);
4012 new_pv = SvPVX_mutable(sstr);
4015 SvPV_set(dstr, new_pv);
4016 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4019 SvLEN_set(dstr, len);
4020 SvCUR_set(dstr, cur);
4029 =for apidoc sv_setpvn
4031 Copies a string into an SV. The C<len> parameter indicates the number of
4032 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4033 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4039 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4042 register char *dptr;
4044 PERL_ARGS_ASSERT_SV_SETPVN;
4046 SV_CHECK_THINKFIRST_COW_DROP(sv);
4052 /* len is STRLEN which is unsigned, need to copy to signed */
4055 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4057 SvUPGRADE(sv, SVt_PV);
4059 dptr = SvGROW(sv, len + 1);
4060 Move(ptr,dptr,len,char);
4063 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4068 =for apidoc sv_setpvn_mg
4070 Like C<sv_setpvn>, but also handles 'set' magic.
4076 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4078 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4080 sv_setpvn(sv,ptr,len);
4085 =for apidoc sv_setpv
4087 Copies a string into an SV. The string must be null-terminated. Does not
4088 handle 'set' magic. See C<sv_setpv_mg>.
4094 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4097 register STRLEN len;
4099 PERL_ARGS_ASSERT_SV_SETPV;
4101 SV_CHECK_THINKFIRST_COW_DROP(sv);
4107 SvUPGRADE(sv, SVt_PV);
4109 SvGROW(sv, len + 1);
4110 Move(ptr,SvPVX(sv),len+1,char);
4112 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4117 =for apidoc sv_setpv_mg
4119 Like C<sv_setpv>, but also handles 'set' magic.
4125 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4127 PERL_ARGS_ASSERT_SV_SETPV_MG;
4134 =for apidoc sv_usepvn_flags
4136 Tells an SV to use C<ptr> to find its string value. Normally the
4137 string is stored inside the SV but sv_usepvn allows the SV to use an
4138 outside string. The C<ptr> should point to memory that was allocated
4139 by C<malloc>. The string length, C<len>, must be supplied. By default
4140 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4141 so that pointer should not be freed or used by the programmer after
4142 giving it to sv_usepvn, and neither should any pointers from "behind"
4143 that pointer (e.g. ptr + 1) be used.
4145 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4146 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4147 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4148 C<len>, and already meets the requirements for storing in C<SvPVX>)
4154 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4159 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4161 SV_CHECK_THINKFIRST_COW_DROP(sv);
4162 SvUPGRADE(sv, SVt_PV);
4165 if (flags & SV_SMAGIC)
4169 if (SvPVX_const(sv))
4173 if (flags & SV_HAS_TRAILING_NUL)
4174 assert(ptr[len] == '\0');
4177 allocate = (flags & SV_HAS_TRAILING_NUL)
4179 #ifdef Perl_safesysmalloc_size
4182 PERL_STRLEN_ROUNDUP(len + 1);
4184 if (flags & SV_HAS_TRAILING_NUL) {
4185 /* It's long enough - do nothing.
4186 Specfically Perl_newCONSTSUB is relying on this. */
4189 /* Force a move to shake out bugs in callers. */
4190 char *new_ptr = (char*)safemalloc(allocate);
4191 Copy(ptr, new_ptr, len, char);
4192 PoisonFree(ptr,len,char);
4196 ptr = (char*) saferealloc (ptr, allocate);
4199 #ifdef Perl_safesysmalloc_size
4200 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4202 SvLEN_set(sv, allocate);
4206 if (!(flags & SV_HAS_TRAILING_NUL)) {
4209 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4211 if (flags & SV_SMAGIC)
4215 #ifdef PERL_OLD_COPY_ON_WRITE
4216 /* Need to do this *after* making the SV normal, as we need the buffer
4217 pointer to remain valid until after we've copied it. If we let go too early,
4218 another thread could invalidate it by unsharing last of the same hash key
4219 (which it can do by means other than releasing copy-on-write Svs)
4220 or by changing the other copy-on-write SVs in the loop. */
4222 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4224 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4226 { /* this SV was SvIsCOW_normal(sv) */
4227 /* we need to find the SV pointing to us. */
4228 SV *current = SV_COW_NEXT_SV(after);
4230 if (current == sv) {
4231 /* The SV we point to points back to us (there were only two of us
4233 Hence other SV is no longer copy on write either. */
4235 SvREADONLY_off(after);
4237 /* We need to follow the pointers around the loop. */
4239 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4242 /* don't loop forever if the structure is bust, and we have
4243 a pointer into a closed loop. */
4244 assert (current != after);
4245 assert (SvPVX_const(current) == pvx);
4247 /* Make the SV before us point to the SV after us. */
4248 SV_COW_NEXT_SV_SET(current, after);
4254 =for apidoc sv_force_normal_flags
4256 Undo various types of fakery on an SV: if the PV is a shared string, make
4257 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4258 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4259 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4260 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4261 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4262 set to some other value.) In addition, the C<flags> parameter gets passed to
4263 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4264 with flags set to 0.
4270 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4274 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4276 #ifdef PERL_OLD_COPY_ON_WRITE
4277 if (SvREADONLY(sv)) {
4278 /* At this point I believe I should acquire a global SV mutex. */
4280 const char * const pvx = SvPVX_const(sv);
4281 const STRLEN len = SvLEN(sv);
4282 const STRLEN cur = SvCUR(sv);
4283 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4284 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4285 we'll fail an assertion. */
4286 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4289 PerlIO_printf(Perl_debug_log,
4290 "Copy on write: Force normal %ld\n",
4296 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4299 if (flags & SV_COW_DROP_PV) {
4300 /* OK, so we don't need to copy our buffer. */
4303 SvGROW(sv, cur + 1);
4304 Move(pvx,SvPVX(sv),cur,char);
4309 sv_release_COW(sv, pvx, next);
4311 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4317 else if (IN_PERL_RUNTIME)
4318 Perl_croak(aTHX_ PL_no_modify);
4319 /* At this point I believe that I can drop the global SV mutex. */
4322 if (SvREADONLY(sv)) {
4324 const char * const pvx = SvPVX_const(sv);
4325 const STRLEN len = SvCUR(sv);
4330 SvGROW(sv, len + 1);
4331 Move(pvx,SvPVX(sv),len,char);
4333 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4335 else if (IN_PERL_RUNTIME)
4336 Perl_croak(aTHX_ PL_no_modify);
4340 sv_unref_flags(sv, flags);
4341 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4348 Efficient removal of characters from the beginning of the string buffer.
4349 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4350 the string buffer. The C<ptr> becomes the first character of the adjusted
4351 string. Uses the "OOK hack".
4352 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4353 refer to the same chunk of data.
4359 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4365 const U8 *real_start;
4368 PERL_ARGS_ASSERT_SV_CHOP;
4370 if (!ptr || !SvPOKp(sv))
4372 delta = ptr - SvPVX_const(sv);
4374 /* Nothing to do. */
4377 assert(ptr > SvPVX_const(sv));
4378 SV_CHECK_THINKFIRST(sv);
4381 if (!SvLEN(sv)) { /* make copy of shared string */
4382 const char *pvx = SvPVX_const(sv);
4383 const STRLEN len = SvCUR(sv);
4384 SvGROW(sv, len + 1);
4385 Move(pvx,SvPVX(sv),len,char);
4388 SvFLAGS(sv) |= SVf_OOK;
4391 SvOOK_offset(sv, old_delta);
4393 SvLEN_set(sv, SvLEN(sv) - delta);
4394 SvCUR_set(sv, SvCUR(sv) - delta);
4395 SvPV_set(sv, SvPVX(sv) + delta);
4397 p = (U8 *)SvPVX_const(sv);
4402 real_start = p - delta;
4406 if (delta < 0x100) {
4410 p -= sizeof(STRLEN);
4411 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4415 /* Fill the preceding buffer with sentinals to verify that no-one is
4417 while (p > real_start) {
4425 =for apidoc sv_catpvn
4427 Concatenates the string onto the end of the string which is in the SV. The
4428 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4429 status set, then the bytes appended should be valid UTF-8.
4430 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4432 =for apidoc sv_catpvn_flags
4434 Concatenates the string onto the end of the string which is in the SV. The
4435 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4436 status set, then the bytes appended should be valid UTF-8.
4437 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4438 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4439 in terms of this function.
4445 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4449 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4451 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4453 SvGROW(dsv, dlen + slen + 1);
4455 sstr = SvPVX_const(dsv);
4456 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4457 SvCUR_set(dsv, SvCUR(dsv) + slen);
4459 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4461 if (flags & SV_SMAGIC)
4466 =for apidoc sv_catsv
4468 Concatenates the string from SV C<ssv> onto the end of the string in
4469 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4470 not 'set' magic. See C<sv_catsv_mg>.
4472 =for apidoc sv_catsv_flags
4474 Concatenates the string from SV C<ssv> onto the end of the string in
4475 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4476 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4477 and C<sv_catsv_nomg> are implemented in terms of this function.
4482 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4486 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4490 const char *spv = SvPV_const(ssv, slen);
4492 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4493 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4494 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4495 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4496 dsv->sv_flags doesn't have that bit set.
4497 Andy Dougherty 12 Oct 2001
4499 const I32 sutf8 = DO_UTF8(ssv);
4502 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4504 dutf8 = DO_UTF8(dsv);
4506 if (dutf8 != sutf8) {
4508 /* Not modifying source SV, so taking a temporary copy. */
4509 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4511 sv_utf8_upgrade(csv);
4512 spv = SvPV_const(csv, slen);
4515 sv_utf8_upgrade_nomg(dsv);
4517 sv_catpvn_nomg(dsv, spv, slen);
4520 if (flags & SV_SMAGIC)
4525 =for apidoc sv_catpv
4527 Concatenates the string onto the end of the string which is in the SV.
4528 If the SV has the UTF-8 status set, then the bytes appended should be
4529 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4534 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4537 register STRLEN len;
4541 PERL_ARGS_ASSERT_SV_CATPV;
4545 junk = SvPV_force(sv, tlen);
4547 SvGROW(sv, tlen + len + 1);
4549 ptr = SvPVX_const(sv);
4550 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4551 SvCUR_set(sv, SvCUR(sv) + len);
4552 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4557 =for apidoc sv_catpv_mg
4559 Like C<sv_catpv>, but also handles 'set' magic.
4565 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4567 PERL_ARGS_ASSERT_SV_CATPV_MG;
4576 Creates a new SV. A non-zero C<len> parameter indicates the number of
4577 bytes of preallocated string space the SV should have. An extra byte for a
4578 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4579 space is allocated.) The reference count for the new SV is set to 1.
4581 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4582 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4583 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4584 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4585 modules supporting older perls.
4591 Perl_newSV(pTHX_ STRLEN len)
4598 sv_upgrade(sv, SVt_PV);
4599 SvGROW(sv, len + 1);
4604 =for apidoc sv_magicext
4606 Adds magic to an SV, upgrading it if necessary. Applies the
4607 supplied vtable and returns a pointer to the magic added.
4609 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4610 In particular, you can add magic to SvREADONLY SVs, and add more than
4611 one instance of the same 'how'.
4613 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4614 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4615 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4616 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4618 (This is now used as a subroutine by C<sv_magic>.)
4623 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4624 const char* name, I32 namlen)
4629 PERL_ARGS_ASSERT_SV_MAGICEXT;
4631 SvUPGRADE(sv, SVt_PVMG);
4632 Newxz(mg, 1, MAGIC);
4633 mg->mg_moremagic = SvMAGIC(sv);
4634 SvMAGIC_set(sv, mg);
4636 /* Sometimes a magic contains a reference loop, where the sv and
4637 object refer to each other. To prevent a reference loop that
4638 would prevent such objects being freed, we look for such loops
4639 and if we find one we avoid incrementing the object refcount.
4641 Note we cannot do this to avoid self-tie loops as intervening RV must
4642 have its REFCNT incremented to keep it in existence.
4645 if (!obj || obj == sv ||
4646 how == PERL_MAGIC_arylen ||
4647 how == PERL_MAGIC_symtab ||
4648 (SvTYPE(obj) == SVt_PVGV &&
4649 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4650 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4651 GvFORM(obj) == (CV*)sv)))
4656 mg->mg_obj = SvREFCNT_inc_simple(obj);
4657 mg->mg_flags |= MGf_REFCOUNTED;
4660 /* Normal self-ties simply pass a null object, and instead of
4661 using mg_obj directly, use the SvTIED_obj macro to produce a
4662 new RV as needed. For glob "self-ties", we are tieing the PVIO
4663 with an RV obj pointing to the glob containing the PVIO. In
4664 this case, to avoid a reference loop, we need to weaken the
4668 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4669 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4675 mg->mg_len = namlen;
4678 mg->mg_ptr = savepvn(name, namlen);
4679 else if (namlen == HEf_SVKEY)
4680 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4682 mg->mg_ptr = (char *) name;
4684 mg->mg_virtual = (MGVTBL *) vtable;
4688 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4693 =for apidoc sv_magic
4695 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4696 then adds a new magic item of type C<how> to the head of the magic list.
4698 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4699 handling of the C<name> and C<namlen> arguments.
4701 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4702 to add more than one instance of the same 'how'.
4708 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4711 const MGVTBL *vtable;
4714 PERL_ARGS_ASSERT_SV_MAGIC;
4716 #ifdef PERL_OLD_COPY_ON_WRITE
4718 sv_force_normal_flags(sv, 0);
4720 if (SvREADONLY(sv)) {
4722 /* its okay to attach magic to shared strings; the subsequent
4723 * upgrade to PVMG will unshare the string */
4724 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4727 && how != PERL_MAGIC_regex_global
4728 && how != PERL_MAGIC_bm
4729 && how != PERL_MAGIC_fm
4730 && how != PERL_MAGIC_sv
4731 && how != PERL_MAGIC_backref
4734 Perl_croak(aTHX_ PL_no_modify);
4737 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4738 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4739 /* sv_magic() refuses to add a magic of the same 'how' as an
4742 if (how == PERL_MAGIC_taint) {
4744 /* Any scalar which already had taint magic on which someone
4745 (erroneously?) did SvIOK_on() or similar will now be
4746 incorrectly sporting public "OK" flags. */
4747 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4755 vtable = &PL_vtbl_sv;
4757 case PERL_MAGIC_overload:
4758 vtable = &PL_vtbl_amagic;
4760 case PERL_MAGIC_overload_elem:
4761 vtable = &PL_vtbl_amagicelem;
4763 case PERL_MAGIC_overload_table:
4764 vtable = &PL_vtbl_ovrld;
4767 vtable = &PL_vtbl_bm;
4769 case PERL_MAGIC_regdata:
4770 vtable = &PL_vtbl_regdata;
4772 case PERL_MAGIC_regdatum:
4773 vtable = &PL_vtbl_regdatum;
4775 case PERL_MAGIC_env:
4776 vtable = &PL_vtbl_env;
4779 vtable = &PL_vtbl_fm;
4781 case PERL_MAGIC_envelem:
4782 vtable = &PL_vtbl_envelem;
4784 case PERL_MAGIC_regex_global:
4785 vtable = &PL_vtbl_mglob;
4787 case PERL_MAGIC_isa:
4788 vtable = &PL_vtbl_isa;
4790 case PERL_MAGIC_isaelem:
4791 vtable = &PL_vtbl_isaelem;
4793 case PERL_MAGIC_nkeys:
4794 vtable = &PL_vtbl_nkeys;
4796 case PERL_MAGIC_dbfile:
4799 case PERL_MAGIC_dbline:
4800 vtable = &PL_vtbl_dbline;
4802 #ifdef USE_LOCALE_COLLATE
4803 case PERL_MAGIC_collxfrm:
4804 vtable = &PL_vtbl_collxfrm;
4806 #endif /* USE_LOCALE_COLLATE */
4807 case PERL_MAGIC_tied:
4808 vtable = &PL_vtbl_pack;
4810 case PERL_MAGIC_tiedelem:
4811 case PERL_MAGIC_tiedscalar:
4812 vtable = &PL_vtbl_packelem;
4815 vtable = &PL_vtbl_regexp;
4817 case PERL_MAGIC_hints:
4818 /* As this vtable is all NULL, we can reuse it. */
4819 case PERL_MAGIC_sig:
4820 vtable = &PL_vtbl_sig;
4822 case PERL_MAGIC_sigelem:
4823 vtable = &PL_vtbl_sigelem;
4825 case PERL_MAGIC_taint:
4826 vtable = &PL_vtbl_taint;
4828 case PERL_MAGIC_uvar:
4829 vtable = &PL_vtbl_uvar;
4831 case PERL_MAGIC_vec:
4832 vtable = &PL_vtbl_vec;
4834 case PERL_MAGIC_arylen_p:
4835 case PERL_MAGIC_rhash:
4836 case PERL_MAGIC_symtab:
4837 case PERL_MAGIC_vstring:
4840 case PERL_MAGIC_utf8:
4841 vtable = &PL_vtbl_utf8;
4843 case PERL_MAGIC_substr:
4844 vtable = &PL_vtbl_substr;
4846 case PERL_MAGIC_defelem:
4847 vtable = &PL_vtbl_defelem;
4849 case PERL_MAGIC_arylen:
4850 vtable = &PL_vtbl_arylen;
4852 case PERL_MAGIC_pos:
4853 vtable = &PL_vtbl_pos;
4855 case PERL_MAGIC_backref:
4856 vtable = &PL_vtbl_backref;
4858 case PERL_MAGIC_hintselem:
4859 vtable = &PL_vtbl_hintselem;
4861 case PERL_MAGIC_ext:
4862 /* Reserved for use by extensions not perl internals. */
4863 /* Useful for attaching extension internal data to perl vars. */
4864 /* Note that multiple extensions may clash if magical scalars */
4865 /* etc holding private data from one are passed to another. */
4869 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4872 /* Rest of work is done else where */
4873 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4876 case PERL_MAGIC_taint:
4879 case PERL_MAGIC_ext:
4880 case PERL_MAGIC_dbfile:
4887 =for apidoc sv_unmagic
4889 Removes all magic of type C<type> from an SV.
4895 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4900 PERL_ARGS_ASSERT_SV_UNMAGIC;
4902 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4904 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4905 for (mg = *mgp; mg; mg = *mgp) {
4906 if (mg->mg_type == type) {
4907 const MGVTBL* const vtbl = mg->mg_virtual;
4908 *mgp = mg->mg_moremagic;
4909 if (vtbl && vtbl->svt_free)
4910 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4911 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4913 Safefree(mg->mg_ptr);
4914 else if (mg->mg_len == HEf_SVKEY)
4915 SvREFCNT_dec((SV*)mg->mg_ptr);
4916 else if (mg->mg_type == PERL_MAGIC_utf8)
4917 Safefree(mg->mg_ptr);
4919 if (mg->mg_flags & MGf_REFCOUNTED)
4920 SvREFCNT_dec(mg->mg_obj);
4924 mgp = &mg->mg_moremagic;
4928 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4929 SvMAGIC_set(sv, NULL);
4936 =for apidoc sv_rvweaken
4938 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4939 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4940 push a back-reference to this RV onto the array of backreferences
4941 associated with that magic. If the RV is magical, set magic will be
4942 called after the RV is cleared.
4948 Perl_sv_rvweaken(pTHX_ SV *sv)
4952 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4954 if (!SvOK(sv)) /* let undefs pass */
4957 Perl_croak(aTHX_ "Can't weaken a nonreference");
4958 else if (SvWEAKREF(sv)) {
4959 if (ckWARN(WARN_MISC))
4960 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4964 Perl_sv_add_backref(aTHX_ tsv, sv);
4970 /* Give tsv backref magic if it hasn't already got it, then push a
4971 * back-reference to sv onto the array associated with the backref magic.
4975 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4980 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4982 if (SvTYPE(tsv) == SVt_PVHV) {
4983 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4987 /* There is no AV in the offical place - try a fixup. */
4988 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4991 /* Aha. They've got it stowed in magic. Bring it back. */
4992 av = (AV*)mg->mg_obj;
4993 /* Stop mg_free decreasing the refernce count. */
4995 /* Stop mg_free even calling the destructor, given that
4996 there's no AV to free up. */
4998 sv_unmagic(tsv, PERL_MAGIC_backref);
5002 SvREFCNT_inc_simple_void(av);
5007 const MAGIC *const mg
5008 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5010 av = (AV*)mg->mg_obj;
5014 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5015 /* av now has a refcnt of 2, which avoids it getting freed
5016 * before us during global cleanup. The extra ref is removed
5017 * by magic_killbackrefs() when tsv is being freed */
5020 if (AvFILLp(av) >= AvMAX(av)) {
5021 av_extend(av, AvFILLp(av)+1);
5023 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5026 /* delete a back-reference to ourselves from the backref magic associated
5027 * with the SV we point to.
5031 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5038 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5040 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5041 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5042 /* We mustn't attempt to "fix up" the hash here by moving the
5043 backreference array back to the hv_aux structure, as that is stored
5044 in the main HvARRAY(), and hfreentries assumes that no-one
5045 reallocates HvARRAY() while it is running. */
5048 const MAGIC *const mg
5049 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5051 av = (AV *)mg->mg_obj;
5054 if (PL_in_clean_all)
5056 Perl_croak(aTHX_ "panic: del_backref");
5063 /* We shouldn't be in here more than once, but for paranoia reasons lets
5065 for (i = AvFILLp(av); i >= 0; i--) {
5067 const SSize_t fill = AvFILLp(av);
5069 /* We weren't the last entry.
5070 An unordered list has this property that you can take the
5071 last element off the end to fill the hole, and it's still
5072 an unordered list :-)
5077 AvFILLp(av) = fill - 1;
5083 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
5085 SV **svp = AvARRAY(av);
5087 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5088 PERL_UNUSED_ARG(sv);
5090 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5091 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5092 if (svp && !SvIS_FREED(av)) {
5093 SV *const *const last = svp + AvFILLp(av);
5095 while (svp <= last) {
5097 SV *const referrer = *svp;
5098 if (SvWEAKREF(referrer)) {
5099 /* XXX Should we check that it hasn't changed? */
5100 SvRV_set(referrer, 0);
5102 SvWEAKREF_off(referrer);
5103 SvSETMAGIC(referrer);
5104 } else if (SvTYPE(referrer) == SVt_PVGV ||
5105 SvTYPE(referrer) == SVt_PVLV) {
5106 /* You lookin' at me? */
5107 assert(GvSTASH(referrer));
5108 assert(GvSTASH(referrer) == (HV*)sv);
5109 GvSTASH(referrer) = 0;
5112 "panic: magic_killbackrefs (flags=%"UVxf")",
5113 (UV)SvFLAGS(referrer));
5121 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5126 =for apidoc sv_insert
5128 Inserts a string at the specified offset/length within the SV. Similar to
5129 the Perl substr() function.
5135 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5140 register char *midend;
5141 register char *bigend;
5145 PERL_ARGS_ASSERT_SV_INSERT;
5148 Perl_croak(aTHX_ "Can't modify non-existent substring");
5149 SvPV_force(bigstr, curlen);
5150 (void)SvPOK_only_UTF8(bigstr);
5151 if (offset + len > curlen) {
5152 SvGROW(bigstr, offset+len+1);
5153 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5154 SvCUR_set(bigstr, offset+len);
5158 i = littlelen - len;
5159 if (i > 0) { /* string might grow */
5160 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5161 mid = big + offset + len;
5162 midend = bigend = big + SvCUR(bigstr);
5165 while (midend > mid) /* shove everything down */
5166 *--bigend = *--midend;
5167 Move(little,big+offset,littlelen,char);
5168 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5173 Move(little,SvPVX(bigstr)+offset,len,char);
5178 big = SvPVX(bigstr);
5181 bigend = big + SvCUR(bigstr);
5183 if (midend > bigend)
5184 Perl_croak(aTHX_ "panic: sv_insert");
5186 if (mid - big > bigend - midend) { /* faster to shorten from end */
5188 Move(little, mid, littlelen,char);
5191 i = bigend - midend;
5193 Move(midend, mid, i,char);
5197 SvCUR_set(bigstr, mid - big);
5199 else if ((i = mid - big)) { /* faster from front */
5200 midend -= littlelen;
5202 Move(big, midend - i, i, char);
5203 sv_chop(bigstr,midend-i);
5205 Move(little, mid, littlelen,char);
5207 else if (littlelen) {
5208 midend -= littlelen;
5209 sv_chop(bigstr,midend);
5210 Move(little,midend,littlelen,char);
5213 sv_chop(bigstr,midend);
5219 =for apidoc sv_replace
5221 Make the first argument a copy of the second, then delete the original.
5222 The target SV physically takes over ownership of the body of the source SV
5223 and inherits its flags; however, the target keeps any magic it owns,
5224 and any magic in the source is discarded.
5225 Note that this is a rather specialist SV copying operation; most of the
5226 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5232 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5235 const U32 refcnt = SvREFCNT(sv);
5237 PERL_ARGS_ASSERT_SV_REPLACE;
5239 SV_CHECK_THINKFIRST_COW_DROP(sv);
5240 if (SvREFCNT(nsv) != 1) {
5241 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5242 UVuf " != 1)", (UV) SvREFCNT(nsv));
5244 if (SvMAGICAL(sv)) {
5248 sv_upgrade(nsv, SVt_PVMG);
5249 SvMAGIC_set(nsv, SvMAGIC(sv));
5250 SvFLAGS(nsv) |= SvMAGICAL(sv);
5252 SvMAGIC_set(sv, NULL);
5256 assert(!SvREFCNT(sv));
5257 #ifdef DEBUG_LEAKING_SCALARS
5258 sv->sv_flags = nsv->sv_flags;
5259 sv->sv_any = nsv->sv_any;
5260 sv->sv_refcnt = nsv->sv_refcnt;
5261 sv->sv_u = nsv->sv_u;
5263 StructCopy(nsv,sv,SV);
5265 if(SvTYPE(sv) == SVt_IV) {
5267 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5271 #ifdef PERL_OLD_COPY_ON_WRITE
5272 if (SvIsCOW_normal(nsv)) {
5273 /* We need to follow the pointers around the loop to make the
5274 previous SV point to sv, rather than nsv. */
5277 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5280 assert(SvPVX_const(current) == SvPVX_const(nsv));
5282 /* Make the SV before us point to the SV after us. */
5284 PerlIO_printf(Perl_debug_log, "previous is\n");
5286 PerlIO_printf(Perl_debug_log,
5287 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5288 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5290 SV_COW_NEXT_SV_SET(current, sv);
5293 SvREFCNT(sv) = refcnt;
5294 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5300 =for apidoc sv_clear
5302 Clear an SV: call any destructors, free up any memory used by the body,
5303 and free the body itself. The SV's head is I<not> freed, although
5304 its type is set to all 1's so that it won't inadvertently be assumed
5305 to be live during global destruction etc.
5306 This function should only be called when REFCNT is zero. Most of the time
5307 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5314 Perl_sv_clear(pTHX_ register SV *sv)
5317 const U32 type = SvTYPE(sv);
5318 const struct body_details *const sv_type_details
5319 = bodies_by_type + type;
5322 PERL_ARGS_ASSERT_SV_CLEAR;
5323 assert(SvREFCNT(sv) == 0);
5324 assert(SvTYPE(sv) != SVTYPEMASK);
5326 if (type <= SVt_IV) {
5327 /* See the comment in sv.h about the collusion between this early
5328 return and the overloading of the NULL and IV slots in the size
5331 SV * const target = SvRV(sv);
5333 sv_del_backref(target, sv);
5335 SvREFCNT_dec(target);
5337 SvFLAGS(sv) &= SVf_BREAK;
5338 SvFLAGS(sv) |= SVTYPEMASK;
5343 if (PL_defstash && /* Still have a symbol table? */
5350 stash = SvSTASH(sv);
5351 destructor = StashHANDLER(stash,DESTROY);
5353 SV* const tmpref = newRV(sv);
5354 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5356 PUSHSTACKi(PERLSI_DESTROY);
5361 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5367 if(SvREFCNT(tmpref) < 2) {
5368 /* tmpref is not kept alive! */
5370 SvRV_set(tmpref, NULL);
5373 SvREFCNT_dec(tmpref);
5375 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5379 if (PL_in_clean_objs)
5380 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5382 /* DESTROY gave object new lease on life */
5388 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5389 SvOBJECT_off(sv); /* Curse the object. */
5390 if (type != SVt_PVIO)
5391 --PL_sv_objcount; /* XXX Might want something more general */
5394 if (type >= SVt_PVMG) {
5395 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5396 SvREFCNT_dec(SvOURSTASH(sv));
5397 } else if (SvMAGIC(sv))
5399 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5400 SvREFCNT_dec(SvSTASH(sv));
5403 /* case SVt_BIND: */
5406 IoIFP(sv) != PerlIO_stdin() &&
5407 IoIFP(sv) != PerlIO_stdout() &&
5408 IoIFP(sv) != PerlIO_stderr())
5410 io_close((IO*)sv, FALSE);
5412 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5413 PerlDir_close(IoDIRP(sv));
5414 IoDIRP(sv) = (DIR*)NULL;
5415 Safefree(IoTOP_NAME(sv));
5416 Safefree(IoFMT_NAME(sv));
5417 Safefree(IoBOTTOM_NAME(sv));
5420 /* FIXME for plugins */
5421 pregfree2((REGEXP*) sv);
5428 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5432 if (PL_comppad == (AV*)sv) {
5439 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5440 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5441 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5442 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5444 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5445 SvREFCNT_dec(LvTARG(sv));
5447 if (isGV_with_GP(sv)) {
5448 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5449 mro_method_changed_in(stash);
5452 unshare_hek(GvNAME_HEK(sv));
5453 /* If we're in a stash, we don't own a reference to it. However it does
5454 have a back reference to us, which needs to be cleared. */
5455 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5456 sv_del_backref((SV*)stash, sv);
5458 /* FIXME. There are probably more unreferenced pointers to SVs in the
5459 interpreter struct that we should check and tidy in a similar
5461 if ((GV*)sv == PL_last_in_gv)
5462 PL_last_in_gv = NULL;
5468 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5471 SvOOK_offset(sv, offset);
5472 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5473 /* Don't even bother with turning off the OOK flag. */
5476 SV * const target = SvRV(sv);
5478 sv_del_backref(target, sv);
5480 SvREFCNT_dec(target);
5482 #ifdef PERL_OLD_COPY_ON_WRITE
5483 else if (SvPVX_const(sv)) {
5485 /* I believe I need to grab the global SV mutex here and
5486 then recheck the COW status. */
5488 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5492 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5494 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5497 /* And drop it here. */
5499 } else if (SvLEN(sv)) {
5500 Safefree(SvPVX_const(sv));
5504 else if (SvPVX_const(sv) && SvLEN(sv))
5505 Safefree(SvPVX_mutable(sv));
5506 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5507 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5516 SvFLAGS(sv) &= SVf_BREAK;
5517 SvFLAGS(sv) |= SVTYPEMASK;
5519 if (sv_type_details->arena) {
5520 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5521 &PL_body_roots[type]);
5523 else if (sv_type_details->body_size) {
5524 my_safefree(SvANY(sv));
5529 =for apidoc sv_newref
5531 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5538 Perl_sv_newref(pTHX_ SV *sv)
5540 PERL_UNUSED_CONTEXT;
5549 Decrement an SV's reference count, and if it drops to zero, call
5550 C<sv_clear> to invoke destructors and free up any memory used by
5551 the body; finally, deallocate the SV's head itself.
5552 Normally called via a wrapper macro C<SvREFCNT_dec>.
5558 Perl_sv_free(pTHX_ SV *sv)
5563 if (SvREFCNT(sv) == 0) {
5564 if (SvFLAGS(sv) & SVf_BREAK)
5565 /* this SV's refcnt has been artificially decremented to
5566 * trigger cleanup */
5568 if (PL_in_clean_all) /* All is fair */
5570 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5571 /* make sure SvREFCNT(sv)==0 happens very seldom */
5572 SvREFCNT(sv) = (~(U32)0)/2;
5575 if (ckWARN_d(WARN_INTERNAL)) {
5576 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5577 Perl_dump_sv_child(aTHX_ sv);
5579 #ifdef DEBUG_LEAKING_SCALARS
5582 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5583 if (PL_warnhook == PERL_WARNHOOK_FATAL
5584 || ckDEAD(packWARN(WARN_INTERNAL))) {
5585 /* Don't let Perl_warner cause us to escape our fate: */
5589 /* This may not return: */
5590 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5591 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5592 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5595 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5600 if (--(SvREFCNT(sv)) > 0)
5602 Perl_sv_free2(aTHX_ sv);
5606 Perl_sv_free2(pTHX_ SV *sv)
5610 PERL_ARGS_ASSERT_SV_FREE2;
5614 if (ckWARN_d(WARN_DEBUGGING))
5615 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5616 "Attempt to free temp prematurely: SV 0x%"UVxf
5617 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5621 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5622 /* make sure SvREFCNT(sv)==0 happens very seldom */
5623 SvREFCNT(sv) = (~(U32)0)/2;
5634 Returns the length of the string in the SV. Handles magic and type
5635 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5641 Perl_sv_len(pTHX_ register SV *sv)
5649 len = mg_length(sv);
5651 (void)SvPV_const(sv, len);
5656 =for apidoc sv_len_utf8
5658 Returns the number of characters in the string in an SV, counting wide
5659 UTF-8 bytes as a single character. Handles magic and type coercion.
5665 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5666 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5667 * (Note that the mg_len is not the length of the mg_ptr field.
5668 * This allows the cache to store the character length of the string without
5669 * needing to malloc() extra storage to attach to the mg_ptr.)
5674 Perl_sv_len_utf8(pTHX_ register SV *sv)
5680 return mg_length(sv);
5684 const U8 *s = (U8*)SvPV_const(sv, len);
5688 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5690 if (mg && mg->mg_len != -1) {
5692 if (PL_utf8cache < 0) {
5693 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5695 /* Need to turn the assertions off otherwise we may
5696 recurse infinitely while printing error messages.
5698 SAVEI8(PL_utf8cache);
5700 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5701 " real %"UVuf" for %"SVf,
5702 (UV) ulen, (UV) real, SVfARG(sv));
5707 ulen = Perl_utf8_length(aTHX_ s, s + len);
5708 if (!SvREADONLY(sv)) {
5710 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5711 &PL_vtbl_utf8, 0, 0);
5719 return Perl_utf8_length(aTHX_ s, s + len);
5723 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5726 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5729 const U8 *s = start;
5731 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5733 while (s < send && uoffset--)
5736 /* This is the existing behaviour. Possibly it should be a croak, as
5737 it's actually a bounds error */
5743 /* Given the length of the string in both bytes and UTF-8 characters, decide
5744 whether to walk forwards or backwards to find the byte corresponding to
5745 the passed in UTF-8 offset. */
5747 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5748 STRLEN uoffset, STRLEN uend)
5750 STRLEN backw = uend - uoffset;
5752 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5754 if (uoffset < 2 * backw) {
5755 /* The assumption is that going forwards is twice the speed of going
5756 forward (that's where the 2 * backw comes from).
5757 (The real figure of course depends on the UTF-8 data.) */
5758 return sv_pos_u2b_forwards(start, send, uoffset);
5763 while (UTF8_IS_CONTINUATION(*send))
5766 return send - start;
5769 /* For the string representation of the given scalar, find the byte
5770 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5771 give another position in the string, *before* the sought offset, which
5772 (which is always true, as 0, 0 is a valid pair of positions), which should
5773 help reduce the amount of linear searching.
5774 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5775 will be used to reduce the amount of linear searching. The cache will be
5776 created if necessary, and the found value offered to it for update. */
5778 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5779 const U8 *const send, STRLEN uoffset,
5780 STRLEN uoffset0, STRLEN boffset0)
5782 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5785 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5787 assert (uoffset >= uoffset0);
5789 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5790 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5791 if ((*mgp)->mg_ptr) {
5792 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5793 if (cache[0] == uoffset) {
5794 /* An exact match. */
5797 if (cache[2] == uoffset) {
5798 /* An exact match. */
5802 if (cache[0] < uoffset) {
5803 /* The cache already knows part of the way. */
5804 if (cache[0] > uoffset0) {
5805 /* The cache knows more than the passed in pair */
5806 uoffset0 = cache[0];
5807 boffset0 = cache[1];
5809 if ((*mgp)->mg_len != -1) {
5810 /* And we know the end too. */
5812 + sv_pos_u2b_midway(start + boffset0, send,
5814 (*mgp)->mg_len - uoffset0);
5817 + sv_pos_u2b_forwards(start + boffset0,
5818 send, uoffset - uoffset0);
5821 else if (cache[2] < uoffset) {
5822 /* We're between the two cache entries. */
5823 if (cache[2] > uoffset0) {
5824 /* and the cache knows more than the passed in pair */
5825 uoffset0 = cache[2];
5826 boffset0 = cache[3];
5830 + sv_pos_u2b_midway(start + boffset0,
5833 cache[0] - uoffset0);
5836 + sv_pos_u2b_midway(start + boffset0,
5839 cache[2] - uoffset0);
5843 else if ((*mgp)->mg_len != -1) {
5844 /* If we can take advantage of a passed in offset, do so. */
5845 /* In fact, offset0 is either 0, or less than offset, so don't
5846 need to worry about the other possibility. */
5848 + sv_pos_u2b_midway(start + boffset0, send,
5850 (*mgp)->mg_len - uoffset0);
5855 if (!found || PL_utf8cache < 0) {
5856 const STRLEN real_boffset
5857 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5858 send, uoffset - uoffset0);
5860 if (found && PL_utf8cache < 0) {
5861 if (real_boffset != boffset) {
5862 /* Need to turn the assertions off otherwise we may recurse
5863 infinitely while printing error messages. */
5864 SAVEI8(PL_utf8cache);
5866 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5867 " real %"UVuf" for %"SVf,
5868 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5871 boffset = real_boffset;
5874 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5880 =for apidoc sv_pos_u2b
5882 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5883 the start of the string, to a count of the equivalent number of bytes; if
5884 lenp is non-zero, it does the same to lenp, but this time starting from
5885 the offset, rather than from the start of the string. Handles magic and
5892 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5893 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5894 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5899 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5904 PERL_ARGS_ASSERT_SV_POS_U2B;
5909 start = (U8*)SvPV_const(sv, len);
5911 STRLEN uoffset = (STRLEN) *offsetp;
5912 const U8 * const send = start + len;
5914 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5917 *offsetp = (I32) boffset;
5920 /* Convert the relative offset to absolute. */
5921 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5922 const STRLEN boffset2
5923 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5924 uoffset, boffset) - boffset;
5938 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5939 byte length pairing. The (byte) length of the total SV is passed in too,
5940 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5941 may not have updated SvCUR, so we can't rely on reading it directly.
5943 The proffered utf8/byte length pairing isn't used if the cache already has
5944 two pairs, and swapping either for the proffered pair would increase the
5945 RMS of the intervals between known byte offsets.
5947 The cache itself consists of 4 STRLEN values
5948 0: larger UTF-8 offset
5949 1: corresponding byte offset
5950 2: smaller UTF-8 offset
5951 3: corresponding byte offset
5953 Unused cache pairs have the value 0, 0.
5954 Keeping the cache "backwards" means that the invariant of
5955 cache[0] >= cache[2] is maintained even with empty slots, which means that
5956 the code that uses it doesn't need to worry if only 1 entry has actually
5957 been set to non-zero. It also makes the "position beyond the end of the
5958 cache" logic much simpler, as the first slot is always the one to start
5962 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5967 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5973 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5975 (*mgp)->mg_len = -1;
5979 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5980 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5981 (*mgp)->mg_ptr = (char *) cache;
5985 if (PL_utf8cache < 0) {
5986 const U8 *start = (const U8 *) SvPVX_const(sv);
5987 const STRLEN realutf8 = utf8_length(start, start + byte);
5989 if (realutf8 != utf8) {
5990 /* Need to turn the assertions off otherwise we may recurse
5991 infinitely while printing error messages. */
5992 SAVEI8(PL_utf8cache);
5994 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5995 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5999 /* Cache is held with the later position first, to simplify the code
6000 that deals with unbounded ends. */
6002 ASSERT_UTF8_CACHE(cache);
6003 if (cache[1] == 0) {
6004 /* Cache is totally empty */
6007 } else if (cache[3] == 0) {
6008 if (byte > cache[1]) {
6009 /* New one is larger, so goes first. */
6010 cache[2] = cache[0];
6011 cache[3] = cache[1];
6019 #define THREEWAY_SQUARE(a,b,c,d) \
6020 ((float)((d) - (c))) * ((float)((d) - (c))) \
6021 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6022 + ((float)((b) - (a))) * ((float)((b) - (a)))
6024 /* Cache has 2 slots in use, and we know three potential pairs.
6025 Keep the two that give the lowest RMS distance. Do the
6026 calcualation in bytes simply because we always know the byte
6027 length. squareroot has the same ordering as the positive value,
6028 so don't bother with the actual square root. */
6029 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6030 if (byte > cache[1]) {
6031 /* New position is after the existing pair of pairs. */
6032 const float keep_earlier
6033 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6034 const float keep_later
6035 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6037 if (keep_later < keep_earlier) {
6038 if (keep_later < existing) {
6039 cache[2] = cache[0];
6040 cache[3] = cache[1];
6046 if (keep_earlier < existing) {
6052 else if (byte > cache[3]) {
6053 /* New position is between the existing pair of pairs. */
6054 const float keep_earlier
6055 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6056 const float keep_later
6057 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6059 if (keep_later < keep_earlier) {
6060 if (keep_later < existing) {
6066 if (keep_earlier < existing) {
6073 /* New position is before the existing pair of pairs. */
6074 const float keep_earlier
6075 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6076 const float keep_later
6077 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6079 if (keep_later < keep_earlier) {
6080 if (keep_later < existing) {
6086 if (keep_earlier < existing) {
6087 cache[0] = cache[2];
6088 cache[1] = cache[3];
6095 ASSERT_UTF8_CACHE(cache);
6098 /* We already know all of the way, now we may be able to walk back. The same
6099 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6100 backward is half the speed of walking forward. */
6102 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
6105 const STRLEN forw = target - s;
6106 STRLEN backw = end - target;
6108 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6110 if (forw < 2 * backw) {
6111 return utf8_length(s, target);
6114 while (end > target) {
6116 while (UTF8_IS_CONTINUATION(*end)) {
6125 =for apidoc sv_pos_b2u
6127 Converts the value pointed to by offsetp from a count of bytes from the
6128 start of the string, to a count of the equivalent number of UTF-8 chars.
6129 Handles magic and type coercion.
6135 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6136 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6141 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6144 const STRLEN byte = *offsetp;
6145 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6151 PERL_ARGS_ASSERT_SV_POS_B2U;
6156 s = (const U8*)SvPV_const(sv, blen);
6159 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6163 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6164 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6166 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6167 if (cache[1] == byte) {
6168 /* An exact match. */
6169 *offsetp = cache[0];
6172 if (cache[3] == byte) {
6173 /* An exact match. */
6174 *offsetp = cache[2];
6178 if (cache[1] < byte) {
6179 /* We already know part of the way. */
6180 if (mg->mg_len != -1) {
6181 /* Actually, we know the end too. */
6183 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6184 s + blen, mg->mg_len - cache[0]);
6186 len = cache[0] + utf8_length(s + cache[1], send);
6189 else if (cache[3] < byte) {
6190 /* We're between the two cached pairs, so we do the calculation
6191 offset by the byte/utf-8 positions for the earlier pair,
6192 then add the utf-8 characters from the string start to
6194 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6195 s + cache[1], cache[0] - cache[2])
6199 else { /* cache[3] > byte */
6200 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6204 ASSERT_UTF8_CACHE(cache);
6206 } else if (mg->mg_len != -1) {
6207 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6211 if (!found || PL_utf8cache < 0) {
6212 const STRLEN real_len = utf8_length(s, send);
6214 if (found && PL_utf8cache < 0) {
6215 if (len != real_len) {
6216 /* Need to turn the assertions off otherwise we may recurse
6217 infinitely while printing error messages. */
6218 SAVEI8(PL_utf8cache);
6220 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6221 " real %"UVuf" for %"SVf,
6222 (UV) len, (UV) real_len, SVfARG(sv));
6229 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6235 Returns a boolean indicating whether the strings in the two SVs are
6236 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6237 coerce its args to strings if necessary.
6243 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6252 SV* svrecode = NULL;
6259 /* if pv1 and pv2 are the same, second SvPV_const call may
6260 * invalidate pv1, so we may need to make a copy */
6261 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6262 pv1 = SvPV_const(sv1, cur1);
6263 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6265 pv1 = SvPV_const(sv1, cur1);
6273 pv2 = SvPV_const(sv2, cur2);
6275 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6276 /* Differing utf8ness.
6277 * Do not UTF8size the comparands as a side-effect. */
6280 svrecode = newSVpvn(pv2, cur2);
6281 sv_recode_to_utf8(svrecode, PL_encoding);
6282 pv2 = SvPV_const(svrecode, cur2);
6285 svrecode = newSVpvn(pv1, cur1);
6286 sv_recode_to_utf8(svrecode, PL_encoding);
6287 pv1 = SvPV_const(svrecode, cur1);
6289 /* Now both are in UTF-8. */
6291 SvREFCNT_dec(svrecode);
6296 bool is_utf8 = TRUE;
6299 /* sv1 is the UTF-8 one,
6300 * if is equal it must be downgrade-able */
6301 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6307 /* sv2 is the UTF-8 one,
6308 * if is equal it must be downgrade-able */
6309 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6315 /* Downgrade not possible - cannot be eq */
6323 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6325 SvREFCNT_dec(svrecode);
6335 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6336 string in C<sv1> is less than, equal to, or greater than the string in
6337 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6338 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6344 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6348 const char *pv1, *pv2;
6351 SV *svrecode = NULL;
6358 pv1 = SvPV_const(sv1, cur1);
6365 pv2 = SvPV_const(sv2, cur2);
6367 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6368 /* Differing utf8ness.
6369 * Do not UTF8size the comparands as a side-effect. */
6372 svrecode = newSVpvn(pv2, cur2);
6373 sv_recode_to_utf8(svrecode, PL_encoding);
6374 pv2 = SvPV_const(svrecode, cur2);
6377 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6382 svrecode = newSVpvn(pv1, cur1);
6383 sv_recode_to_utf8(svrecode, PL_encoding);
6384 pv1 = SvPV_const(svrecode, cur1);
6387 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6393 cmp = cur2 ? -1 : 0;
6397 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6400 cmp = retval < 0 ? -1 : 1;
6401 } else if (cur1 == cur2) {
6404 cmp = cur1 < cur2 ? -1 : 1;
6408 SvREFCNT_dec(svrecode);
6416 =for apidoc sv_cmp_locale
6418 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6419 'use bytes' aware, handles get magic, and will coerce its args to strings
6420 if necessary. See also C<sv_cmp>.
6426 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6429 #ifdef USE_LOCALE_COLLATE
6435 if (PL_collation_standard)
6439 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6441 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6443 if (!pv1 || !len1) {
6454 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6457 return retval < 0 ? -1 : 1;
6460 * When the result of collation is equality, that doesn't mean
6461 * that there are no differences -- some locales exclude some
6462 * characters from consideration. So to avoid false equalities,
6463 * we use the raw string as a tiebreaker.
6469 #endif /* USE_LOCALE_COLLATE */
6471 return sv_cmp(sv1, sv2);
6475 #ifdef USE_LOCALE_COLLATE
6478 =for apidoc sv_collxfrm
6480 Add Collate Transform magic to an SV if it doesn't already have it.
6482 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6483 scalar data of the variable, but transformed to such a format that a normal
6484 memory comparison can be used to compare the data according to the locale
6491 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6496 PERL_ARGS_ASSERT_SV_COLLXFRM;
6498 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6499 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6505 Safefree(mg->mg_ptr);
6506 s = SvPV_const(sv, len);
6507 if ((xf = mem_collxfrm(s, len, &xlen))) {
6509 #ifdef PERL_OLD_COPY_ON_WRITE
6511 sv_force_normal_flags(sv, 0);
6513 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6527 if (mg && mg->mg_ptr) {
6529 return mg->mg_ptr + sizeof(PL_collation_ix);
6537 #endif /* USE_LOCALE_COLLATE */
6542 Get a line from the filehandle and store it into the SV, optionally
6543 appending to the currently-stored string.
6549 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6554 register STDCHAR rslast;
6555 register STDCHAR *bp;
6560 PERL_ARGS_ASSERT_SV_GETS;
6562 if (SvTHINKFIRST(sv))
6563 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6564 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6566 However, perlbench says it's slower, because the existing swipe code
6567 is faster than copy on write.
6568 Swings and roundabouts. */
6569 SvUPGRADE(sv, SVt_PV);
6574 if (PerlIO_isutf8(fp)) {
6576 sv_utf8_upgrade_nomg(sv);
6577 sv_pos_u2b(sv,&append,0);
6579 } else if (SvUTF8(sv)) {
6580 SV * const tsv = newSV(0);
6581 sv_gets(tsv, fp, 0);
6582 sv_utf8_upgrade_nomg(tsv);
6583 SvCUR_set(sv,append);
6586 goto return_string_or_null;
6591 if (PerlIO_isutf8(fp))
6594 if (IN_PERL_COMPILETIME) {
6595 /* we always read code in line mode */
6599 else if (RsSNARF(PL_rs)) {
6600 /* If it is a regular disk file use size from stat() as estimate
6601 of amount we are going to read -- may result in mallocing
6602 more memory than we really need if the layers below reduce
6603 the size we read (e.g. CRLF or a gzip layer).
6606 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6607 const Off_t offset = PerlIO_tell(fp);
6608 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6609 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6615 else if (RsRECORD(PL_rs)) {
6620 /* Grab the size of the record we're getting */
6621 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6622 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6625 /* VMS wants read instead of fread, because fread doesn't respect */
6626 /* RMS record boundaries. This is not necessarily a good thing to be */
6627 /* doing, but we've got no other real choice - except avoid stdio
6628 as implementation - perhaps write a :vms layer ?
6630 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6632 bytesread = PerlIO_read(fp, buffer, recsize);
6636 SvCUR_set(sv, bytesread += append);
6637 buffer[bytesread] = '\0';
6638 goto return_string_or_null;
6640 else if (RsPARA(PL_rs)) {
6646 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6647 if (PerlIO_isutf8(fp)) {
6648 rsptr = SvPVutf8(PL_rs, rslen);
6651 if (SvUTF8(PL_rs)) {
6652 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6653 Perl_croak(aTHX_ "Wide character in $/");
6656 rsptr = SvPV_const(PL_rs, rslen);
6660 rslast = rslen ? rsptr[rslen - 1] : '\0';
6662 if (rspara) { /* have to do this both before and after */
6663 do { /* to make sure file boundaries work right */
6666 i = PerlIO_getc(fp);
6670 PerlIO_ungetc(fp,i);
6676 /* See if we know enough about I/O mechanism to cheat it ! */
6678 /* This used to be #ifdef test - it is made run-time test for ease
6679 of abstracting out stdio interface. One call should be cheap
6680 enough here - and may even be a macro allowing compile
6684 if (PerlIO_fast_gets(fp)) {
6687 * We're going to steal some values from the stdio struct
6688 * and put EVERYTHING in the innermost loop into registers.
6690 register STDCHAR *ptr;
6694 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6695 /* An ungetc()d char is handled separately from the regular
6696 * buffer, so we getc() it back out and stuff it in the buffer.
6698 i = PerlIO_getc(fp);
6699 if (i == EOF) return 0;
6700 *(--((*fp)->_ptr)) = (unsigned char) i;
6704 /* Here is some breathtakingly efficient cheating */
6706 cnt = PerlIO_get_cnt(fp); /* get count into register */
6707 /* make sure we have the room */
6708 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6709 /* Not room for all of it
6710 if we are looking for a separator and room for some
6712 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6713 /* just process what we have room for */
6714 shortbuffered = cnt - SvLEN(sv) + append + 1;
6715 cnt -= shortbuffered;
6719 /* remember that cnt can be negative */
6720 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6725 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6726 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6727 DEBUG_P(PerlIO_printf(Perl_debug_log,
6728 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6729 DEBUG_P(PerlIO_printf(Perl_debug_log,
6730 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6731 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6732 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6737 while (cnt > 0) { /* this | eat */
6739 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6740 goto thats_all_folks; /* screams | sed :-) */
6744 Copy(ptr, bp, cnt, char); /* this | eat */
6745 bp += cnt; /* screams | dust */
6746 ptr += cnt; /* louder | sed :-) */
6751 if (shortbuffered) { /* oh well, must extend */
6752 cnt = shortbuffered;
6754 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6756 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6757 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6761 DEBUG_P(PerlIO_printf(Perl_debug_log,
6762 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6763 PTR2UV(ptr),(long)cnt));
6764 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6766 DEBUG_P(PerlIO_printf(Perl_debug_log,
6767 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6768 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6769 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6771 /* This used to call 'filbuf' in stdio form, but as that behaves like
6772 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6773 another abstraction. */
6774 i = PerlIO_getc(fp); /* get more characters */
6776 DEBUG_P(PerlIO_printf(Perl_debug_log,
6777 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6778 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6779 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6781 cnt = PerlIO_get_cnt(fp);
6782 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6783 DEBUG_P(PerlIO_printf(Perl_debug_log,
6784 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6786 if (i == EOF) /* all done for ever? */
6787 goto thats_really_all_folks;
6789 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6791 SvGROW(sv, bpx + cnt + 2);
6792 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6794 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6796 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6797 goto thats_all_folks;
6801 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6802 memNE((char*)bp - rslen, rsptr, rslen))
6803 goto screamer; /* go back to the fray */
6804 thats_really_all_folks:
6806 cnt += shortbuffered;
6807 DEBUG_P(PerlIO_printf(Perl_debug_log,
6808 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6809 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6810 DEBUG_P(PerlIO_printf(Perl_debug_log,
6811 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6812 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6813 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6815 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6816 DEBUG_P(PerlIO_printf(Perl_debug_log,
6817 "Screamer: done, len=%ld, string=|%.*s|\n",
6818 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6822 /*The big, slow, and stupid way. */
6823 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6824 STDCHAR *buf = NULL;
6825 Newx(buf, 8192, STDCHAR);
6833 register const STDCHAR * const bpe = buf + sizeof(buf);
6835 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6836 ; /* keep reading */
6840 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6841 /* Accomodate broken VAXC compiler, which applies U8 cast to
6842 * both args of ?: operator, causing EOF to change into 255
6845 i = (U8)buf[cnt - 1];
6851 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6853 sv_catpvn(sv, (char *) buf, cnt);
6855 sv_setpvn(sv, (char *) buf, cnt);
6857 if (i != EOF && /* joy */
6859 SvCUR(sv) < rslen ||
6860 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6864 * If we're reading from a TTY and we get a short read,
6865 * indicating that the user hit his EOF character, we need
6866 * to notice it now, because if we try to read from the TTY
6867 * again, the EOF condition will disappear.
6869 * The comparison of cnt to sizeof(buf) is an optimization
6870 * that prevents unnecessary calls to feof().
6874 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6878 #ifdef USE_HEAP_INSTEAD_OF_STACK
6883 if (rspara) { /* have to do this both before and after */
6884 while (i != EOF) { /* to make sure file boundaries work right */
6885 i = PerlIO_getc(fp);
6887 PerlIO_ungetc(fp,i);
6893 return_string_or_null:
6894 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6900 Auto-increment of the value in the SV, doing string to numeric conversion
6901 if necessary. Handles 'get' magic.
6907 Perl_sv_inc(pTHX_ register SV *sv)
6916 if (SvTHINKFIRST(sv)) {
6918 sv_force_normal_flags(sv, 0);
6919 if (SvREADONLY(sv)) {
6920 if (IN_PERL_RUNTIME)
6921 Perl_croak(aTHX_ PL_no_modify);
6925 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6927 i = PTR2IV(SvRV(sv));
6932 flags = SvFLAGS(sv);
6933 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6934 /* It's (privately or publicly) a float, but not tested as an
6935 integer, so test it to see. */
6937 flags = SvFLAGS(sv);
6939 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6940 /* It's publicly an integer, or privately an integer-not-float */
6941 #ifdef PERL_PRESERVE_IVUV
6945 if (SvUVX(sv) == UV_MAX)
6946 sv_setnv(sv, UV_MAX_P1);
6948 (void)SvIOK_only_UV(sv);
6949 SvUV_set(sv, SvUVX(sv) + 1);
6951 if (SvIVX(sv) == IV_MAX)
6952 sv_setuv(sv, (UV)IV_MAX + 1);
6954 (void)SvIOK_only(sv);
6955 SvIV_set(sv, SvIVX(sv) + 1);
6960 if (flags & SVp_NOK) {
6961 const NV was = SvNVX(sv);
6962 if (NV_OVERFLOWS_INTEGERS_AT &&
6963 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6964 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6965 "Lost precision when incrementing %" NVff " by 1",
6968 (void)SvNOK_only(sv);
6969 SvNV_set(sv, was + 1.0);
6973 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6974 if ((flags & SVTYPEMASK) < SVt_PVIV)
6975 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6976 (void)SvIOK_only(sv);
6981 while (isALPHA(*d)) d++;
6982 while (isDIGIT(*d)) d++;
6984 #ifdef PERL_PRESERVE_IVUV
6985 /* Got to punt this as an integer if needs be, but we don't issue
6986 warnings. Probably ought to make the sv_iv_please() that does
6987 the conversion if possible, and silently. */
6988 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6989 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6990 /* Need to try really hard to see if it's an integer.
6991 9.22337203685478e+18 is an integer.
6992 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6993 so $a="9.22337203685478e+18"; $a+0; $a++
6994 needs to be the same as $a="9.22337203685478e+18"; $a++
7001 /* sv_2iv *should* have made this an NV */
7002 if (flags & SVp_NOK) {
7003 (void)SvNOK_only(sv);
7004 SvNV_set(sv, SvNVX(sv) + 1.0);
7007 /* I don't think we can get here. Maybe I should assert this
7008 And if we do get here I suspect that sv_setnv will croak. NWC
7010 #if defined(USE_LONG_DOUBLE)
7011 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",
7012 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7014 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7015 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7018 #endif /* PERL_PRESERVE_IVUV */
7019 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7023 while (d >= SvPVX_const(sv)) {
7031 /* MKS: The original code here died if letters weren't consecutive.
7032 * at least it didn't have to worry about non-C locales. The
7033 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7034 * arranged in order (although not consecutively) and that only
7035 * [A-Za-z] are accepted by isALPHA in the C locale.
7037 if (*d != 'z' && *d != 'Z') {
7038 do { ++*d; } while (!isALPHA(*d));
7041 *(d--) -= 'z' - 'a';
7046 *(d--) -= 'z' - 'a' + 1;
7050 /* oh,oh, the number grew */
7051 SvGROW(sv, SvCUR(sv) + 2);
7052 SvCUR_set(sv, SvCUR(sv) + 1);
7053 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7064 Auto-decrement of the value in the SV, doing string to numeric conversion
7065 if necessary. Handles 'get' magic.
7071 Perl_sv_dec(pTHX_ register SV *sv)
7079 if (SvTHINKFIRST(sv)) {
7081 sv_force_normal_flags(sv, 0);
7082 if (SvREADONLY(sv)) {
7083 if (IN_PERL_RUNTIME)
7084 Perl_croak(aTHX_ PL_no_modify);
7088 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7090 i = PTR2IV(SvRV(sv));
7095 /* Unlike sv_inc we don't have to worry about string-never-numbers
7096 and keeping them magic. But we mustn't warn on punting */
7097 flags = SvFLAGS(sv);
7098 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7099 /* It's publicly an integer, or privately an integer-not-float */
7100 #ifdef PERL_PRESERVE_IVUV
7104 if (SvUVX(sv) == 0) {
7105 (void)SvIOK_only(sv);
7109 (void)SvIOK_only_UV(sv);
7110 SvUV_set(sv, SvUVX(sv) - 1);
7113 if (SvIVX(sv) == IV_MIN) {
7114 sv_setnv(sv, (NV)IV_MIN);
7118 (void)SvIOK_only(sv);
7119 SvIV_set(sv, SvIVX(sv) - 1);
7124 if (flags & SVp_NOK) {
7127 const NV was = SvNVX(sv);
7128 if (NV_OVERFLOWS_INTEGERS_AT &&
7129 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7130 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7131 "Lost precision when decrementing %" NVff " by 1",
7134 (void)SvNOK_only(sv);
7135 SvNV_set(sv, was - 1.0);
7139 if (!(flags & SVp_POK)) {
7140 if ((flags & SVTYPEMASK) < SVt_PVIV)
7141 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7143 (void)SvIOK_only(sv);
7146 #ifdef PERL_PRESERVE_IVUV
7148 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7149 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7150 /* Need to try really hard to see if it's an integer.
7151 9.22337203685478e+18 is an integer.
7152 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7153 so $a="9.22337203685478e+18"; $a+0; $a--
7154 needs to be the same as $a="9.22337203685478e+18"; $a--
7161 /* sv_2iv *should* have made this an NV */
7162 if (flags & SVp_NOK) {
7163 (void)SvNOK_only(sv);
7164 SvNV_set(sv, SvNVX(sv) - 1.0);
7167 /* I don't think we can get here. Maybe I should assert this
7168 And if we do get here I suspect that sv_setnv will croak. NWC
7170 #if defined(USE_LONG_DOUBLE)
7171 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",
7172 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7174 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7175 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7179 #endif /* PERL_PRESERVE_IVUV */
7180 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7184 =for apidoc sv_mortalcopy
7186 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7187 The new SV is marked as mortal. It will be destroyed "soon", either by an
7188 explicit call to FREETMPS, or by an implicit call at places such as
7189 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7194 /* Make a string that will exist for the duration of the expression
7195 * evaluation. Actually, it may have to last longer than that, but
7196 * hopefully we won't free it until it has been assigned to a
7197 * permanent location. */
7200 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7206 sv_setsv(sv,oldstr);
7208 PL_tmps_stack[++PL_tmps_ix] = sv;
7214 =for apidoc sv_newmortal
7216 Creates a new null SV which is mortal. The reference count of the SV is
7217 set to 1. It will be destroyed "soon", either by an explicit call to
7218 FREETMPS, or by an implicit call at places such as statement boundaries.
7219 See also C<sv_mortalcopy> and C<sv_2mortal>.
7225 Perl_sv_newmortal(pTHX)
7231 SvFLAGS(sv) = SVs_TEMP;
7233 PL_tmps_stack[++PL_tmps_ix] = sv;
7239 =for apidoc newSVpvn_flags
7241 Creates a new SV and copies a string into it. The reference count for the
7242 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7243 string. You are responsible for ensuring that the source string is at least
7244 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7245 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7246 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7247 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7248 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7250 #define newSVpvn_utf8(s, len, u) \
7251 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7257 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7262 /* All the flags we don't support must be zero.
7263 And we're new code so I'm going to assert this from the start. */
7264 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7266 sv_setpvn(sv,s,len);
7267 SvFLAGS(sv) |= (flags & SVf_UTF8);
7268 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7272 =for apidoc sv_2mortal
7274 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7275 by an explicit call to FREETMPS, or by an implicit call at places such as
7276 statement boundaries. SvTEMP() is turned on which means that the SV's
7277 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7278 and C<sv_mortalcopy>.
7284 Perl_sv_2mortal(pTHX_ register SV *sv)
7289 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7292 PL_tmps_stack[++PL_tmps_ix] = sv;
7300 Creates a new SV and copies a string into it. The reference count for the
7301 SV is set to 1. If C<len> is zero, Perl will compute the length using
7302 strlen(). For efficiency, consider using C<newSVpvn> instead.
7308 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7314 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7319 =for apidoc newSVpvn
7321 Creates a new SV and copies a string into it. The reference count for the
7322 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7323 string. You are responsible for ensuring that the source string is at least
7324 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7330 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7336 sv_setpvn(sv,s,len);
7341 =for apidoc newSVhek
7343 Creates a new SV from the hash key structure. It will generate scalars that
7344 point to the shared string table where possible. Returns a new (undefined)
7345 SV if the hek is NULL.
7351 Perl_newSVhek(pTHX_ const HEK *hek)
7361 if (HEK_LEN(hek) == HEf_SVKEY) {
7362 return newSVsv(*(SV**)HEK_KEY(hek));
7364 const int flags = HEK_FLAGS(hek);
7365 if (flags & HVhek_WASUTF8) {
7367 Andreas would like keys he put in as utf8 to come back as utf8
7369 STRLEN utf8_len = HEK_LEN(hek);
7370 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7371 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7374 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7376 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7377 /* We don't have a pointer to the hv, so we have to replicate the
7378 flag into every HEK. This hv is using custom a hasing
7379 algorithm. Hence we can't return a shared string scalar, as
7380 that would contain the (wrong) hash value, and might get passed
7381 into an hv routine with a regular hash.
7382 Similarly, a hash that isn't using shared hash keys has to have
7383 the flag in every key so that we know not to try to call
7384 share_hek_kek on it. */
7386 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7391 /* This will be overwhelminly the most common case. */
7393 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7394 more efficient than sharepvn(). */
7398 sv_upgrade(sv, SVt_PV);
7399 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7400 SvCUR_set(sv, HEK_LEN(hek));
7413 =for apidoc newSVpvn_share
7415 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7416 table. If the string does not already exist in the table, it is created
7417 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7418 value is used; otherwise the hash is computed. The string's hash can be later
7419 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7420 that as the string table is used for shared hash keys these strings will have
7421 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7427 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7431 bool is_utf8 = FALSE;
7432 const char *const orig_src = src;
7435 STRLEN tmplen = -len;
7437 /* See the note in hv.c:hv_fetch() --jhi */
7438 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7442 PERL_HASH(hash, src, len);
7444 sv_upgrade(sv, SVt_PV);
7445 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7453 if (src != orig_src)
7459 #if defined(PERL_IMPLICIT_CONTEXT)
7461 /* pTHX_ magic can't cope with varargs, so this is a no-context
7462 * version of the main function, (which may itself be aliased to us).
7463 * Don't access this version directly.
7467 Perl_newSVpvf_nocontext(const char* pat, ...)
7473 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7475 va_start(args, pat);
7476 sv = vnewSVpvf(pat, &args);
7483 =for apidoc newSVpvf
7485 Creates a new SV and initializes it with the string formatted like
7492 Perl_newSVpvf(pTHX_ const char* pat, ...)
7497 PERL_ARGS_ASSERT_NEWSVPVF;
7499 va_start(args, pat);
7500 sv = vnewSVpvf(pat, &args);
7505 /* backend for newSVpvf() and newSVpvf_nocontext() */
7508 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7513 PERL_ARGS_ASSERT_VNEWSVPVF;
7516 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7523 Creates a new SV and copies a floating point value into it.
7524 The reference count for the SV is set to 1.
7530 Perl_newSVnv(pTHX_ NV n)
7543 Creates a new SV and copies an integer into it. The reference count for the
7550 Perl_newSViv(pTHX_ IV i)
7563 Creates a new SV and copies an unsigned integer into it.
7564 The reference count for the SV is set to 1.
7570 Perl_newSVuv(pTHX_ UV u)
7581 =for apidoc newSV_type
7583 Creates a new SV, of the type specified. The reference count for the new SV
7590 Perl_newSV_type(pTHX_ const svtype type)
7595 sv_upgrade(sv, type);
7600 =for apidoc newRV_noinc
7602 Creates an RV wrapper for an SV. The reference count for the original
7603 SV is B<not> incremented.
7609 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7612 register SV *sv = newSV_type(SVt_IV);
7614 PERL_ARGS_ASSERT_NEWRV_NOINC;
7617 SvRV_set(sv, tmpRef);
7622 /* newRV_inc is the official function name to use now.
7623 * newRV_inc is in fact #defined to newRV in sv.h
7627 Perl_newRV(pTHX_ SV *sv)
7631 PERL_ARGS_ASSERT_NEWRV;
7633 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7639 Creates a new SV which is an exact duplicate of the original SV.
7646 Perl_newSVsv(pTHX_ register SV *old)
7653 if (SvTYPE(old) == SVTYPEMASK) {
7654 if (ckWARN_d(WARN_INTERNAL))
7655 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7659 /* SV_GMAGIC is the default for sv_setv()
7660 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7661 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7662 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7667 =for apidoc sv_reset
7669 Underlying implementation for the C<reset> Perl function.
7670 Note that the perl-level function is vaguely deprecated.
7676 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7679 char todo[PERL_UCHAR_MAX+1];
7681 PERL_ARGS_ASSERT_SV_RESET;
7686 if (!*s) { /* reset ?? searches */
7687 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7689 const U32 count = mg->mg_len / sizeof(PMOP**);
7690 PMOP **pmp = (PMOP**) mg->mg_ptr;
7691 PMOP *const *const end = pmp + count;
7695 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7697 (*pmp)->op_pmflags &= ~PMf_USED;
7705 /* reset variables */
7707 if (!HvARRAY(stash))
7710 Zero(todo, 256, char);
7713 I32 i = (unsigned char)*s;
7717 max = (unsigned char)*s++;
7718 for ( ; i <= max; i++) {
7721 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7723 for (entry = HvARRAY(stash)[i];
7725 entry = HeNEXT(entry))
7730 if (!todo[(U8)*HeKEY(entry)])
7732 gv = (GV*)HeVAL(entry);
7735 if (SvTHINKFIRST(sv)) {
7736 if (!SvREADONLY(sv) && SvROK(sv))
7738 /* XXX Is this continue a bug? Why should THINKFIRST
7739 exempt us from resetting arrays and hashes? */
7743 if (SvTYPE(sv) >= SVt_PV) {
7745 if (SvPVX_const(sv) != NULL)
7753 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7755 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7758 # if defined(USE_ENVIRON_ARRAY)
7761 # endif /* USE_ENVIRON_ARRAY */
7772 Using various gambits, try to get an IO from an SV: the IO slot if its a
7773 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7774 named after the PV if we're a string.
7780 Perl_sv_2io(pTHX_ SV *sv)
7785 PERL_ARGS_ASSERT_SV_2IO;
7787 switch (SvTYPE(sv)) {
7795 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7799 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7801 return sv_2io(SvRV(sv));
7802 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7808 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7817 Using various gambits, try to get a CV from an SV; in addition, try if
7818 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7819 The flags in C<lref> are passed to sv_fetchsv.
7825 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7831 PERL_ARGS_ASSERT_SV_2CV;
7838 switch (SvTYPE(sv)) {
7857 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7858 tryAMAGICunDEREF(to_cv);
7861 if (SvTYPE(sv) == SVt_PVCV) {
7870 Perl_croak(aTHX_ "Not a subroutine reference");
7875 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7881 /* Some flags to gv_fetchsv mean don't really create the GV */
7882 if (SvTYPE(gv) != SVt_PVGV) {
7888 if (lref && !GvCVu(gv)) {
7892 gv_efullname3(tmpsv, gv, NULL);
7893 /* XXX this is probably not what they think they're getting.
7894 * It has the same effect as "sub name;", i.e. just a forward
7896 newSUB(start_subparse(FALSE, 0),
7897 newSVOP(OP_CONST, 0, tmpsv),
7901 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7911 Returns true if the SV has a true value by Perl's rules.
7912 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7913 instead use an in-line version.
7919 Perl_sv_true(pTHX_ register SV *sv)
7924 register const XPV* const tXpv = (XPV*)SvANY(sv);
7926 (tXpv->xpv_cur > 1 ||
7927 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7934 return SvIVX(sv) != 0;
7937 return SvNVX(sv) != 0.0;
7939 return sv_2bool(sv);
7945 =for apidoc sv_pvn_force
7947 Get a sensible string out of the SV somehow.
7948 A private implementation of the C<SvPV_force> macro for compilers which
7949 can't cope with complex macro expressions. Always use the macro instead.
7951 =for apidoc sv_pvn_force_flags
7953 Get a sensible string out of the SV somehow.
7954 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7955 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7956 implemented in terms of this function.
7957 You normally want to use the various wrapper macros instead: see
7958 C<SvPV_force> and C<SvPV_force_nomg>
7964 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7968 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7970 if (SvTHINKFIRST(sv) && !SvROK(sv))
7971 sv_force_normal_flags(sv, 0);
7981 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7982 const char * const ref = sv_reftype(sv,0);
7984 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7985 ref, OP_NAME(PL_op));
7987 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7989 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7990 || isGV_with_GP(sv))
7991 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7993 s = sv_2pv_flags(sv, &len, flags);
7997 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8000 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8001 SvGROW(sv, len + 1);
8002 Move(s,SvPVX(sv),len,char);
8004 SvPVX(sv)[len] = '\0';
8007 SvPOK_on(sv); /* validate pointer */
8009 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8010 PTR2UV(sv),SvPVX_const(sv)));
8013 return SvPVX_mutable(sv);
8017 =for apidoc sv_pvbyten_force
8019 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8025 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8027 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8029 sv_pvn_force(sv,lp);
8030 sv_utf8_downgrade(sv,0);
8036 =for apidoc sv_pvutf8n_force
8038 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8044 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8046 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8048 sv_pvn_force(sv,lp);
8049 sv_utf8_upgrade(sv);
8055 =for apidoc sv_reftype
8057 Returns a string describing what the SV is a reference to.
8063 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8065 PERL_ARGS_ASSERT_SV_REFTYPE;
8067 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8068 inside return suggests a const propagation bug in g++. */
8069 if (ob && SvOBJECT(sv)) {
8070 char * const name = HvNAME_get(SvSTASH(sv));
8071 return name ? name : (char *) "__ANON__";
8074 switch (SvTYPE(sv)) {
8089 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8090 /* tied lvalues should appear to be
8091 * scalars for backwards compatitbility */
8092 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8093 ? "SCALAR" : "LVALUE");
8094 case SVt_PVAV: return "ARRAY";
8095 case SVt_PVHV: return "HASH";
8096 case SVt_PVCV: return "CODE";
8097 case SVt_PVGV: return "GLOB";
8098 case SVt_PVFM: return "FORMAT";
8099 case SVt_PVIO: return "IO";
8100 case SVt_BIND: return "BIND";
8101 case SVt_REGEXP: return "REGEXP";
8102 default: return "UNKNOWN";
8108 =for apidoc sv_isobject
8110 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8111 object. If the SV is not an RV, or if the object is not blessed, then this
8118 Perl_sv_isobject(pTHX_ SV *sv)
8134 Returns a boolean indicating whether the SV is blessed into the specified
8135 class. This does not check for subtypes; use C<sv_derived_from> to verify
8136 an inheritance relationship.
8142 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8146 PERL_ARGS_ASSERT_SV_ISA;
8156 hvname = HvNAME_get(SvSTASH(sv));
8160 return strEQ(hvname, name);
8166 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8167 it will be upgraded to one. If C<classname> is non-null then the new SV will
8168 be blessed in the specified package. The new SV is returned and its
8169 reference count is 1.
8175 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8180 PERL_ARGS_ASSERT_NEWSVRV;
8184 SV_CHECK_THINKFIRST_COW_DROP(rv);
8185 (void)SvAMAGIC_off(rv);
8187 if (SvTYPE(rv) >= SVt_PVMG) {
8188 const U32 refcnt = SvREFCNT(rv);
8192 SvREFCNT(rv) = refcnt;
8194 sv_upgrade(rv, SVt_IV);
8195 } else if (SvROK(rv)) {
8196 SvREFCNT_dec(SvRV(rv));
8198 prepare_SV_for_RV(rv);
8206 HV* const stash = gv_stashpv(classname, GV_ADD);
8207 (void)sv_bless(rv, stash);
8213 =for apidoc sv_setref_pv
8215 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8216 argument will be upgraded to an RV. That RV will be modified to point to
8217 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8218 into the SV. The C<classname> argument indicates the package for the
8219 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8220 will have a reference count of 1, and the RV will be returned.
8222 Do not use with other Perl types such as HV, AV, SV, CV, because those
8223 objects will become corrupted by the pointer copy process.
8225 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8231 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8235 PERL_ARGS_ASSERT_SV_SETREF_PV;
8238 sv_setsv(rv, &PL_sv_undef);
8242 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8247 =for apidoc sv_setref_iv
8249 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8250 argument will be upgraded to an RV. That RV will be modified to point to
8251 the new SV. The C<classname> argument indicates the package for the
8252 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8253 will have a reference count of 1, and the RV will be returned.
8259 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8261 PERL_ARGS_ASSERT_SV_SETREF_IV;
8263 sv_setiv(newSVrv(rv,classname), iv);
8268 =for apidoc sv_setref_uv
8270 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8271 argument will be upgraded to an RV. That RV will be modified to point to
8272 the new SV. The C<classname> argument indicates the package for the
8273 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8274 will have a reference count of 1, and the RV will be returned.
8280 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8282 PERL_ARGS_ASSERT_SV_SETREF_UV;
8284 sv_setuv(newSVrv(rv,classname), uv);
8289 =for apidoc sv_setref_nv
8291 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8292 argument will be upgraded to an RV. That RV will be modified to point to
8293 the new SV. The C<classname> argument indicates the package for the
8294 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8295 will have a reference count of 1, and the RV will be returned.
8301 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8303 PERL_ARGS_ASSERT_SV_SETREF_NV;
8305 sv_setnv(newSVrv(rv,classname), nv);
8310 =for apidoc sv_setref_pvn
8312 Copies a string into a new SV, optionally blessing the SV. The length of the
8313 string must be specified with C<n>. The C<rv> argument will be upgraded to
8314 an RV. That RV will be modified to point to the new SV. The C<classname>
8315 argument indicates the package for the blessing. Set C<classname> to
8316 C<NULL> to avoid the blessing. The new SV will have a reference count
8317 of 1, and the RV will be returned.
8319 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8325 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8327 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8329 sv_setpvn(newSVrv(rv,classname), pv, n);
8334 =for apidoc sv_bless
8336 Blesses an SV into a specified package. The SV must be an RV. The package
8337 must be designated by its stash (see C<gv_stashpv()>). The reference count
8338 of the SV is unaffected.
8344 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8349 PERL_ARGS_ASSERT_SV_BLESS;
8352 Perl_croak(aTHX_ "Can't bless non-reference value");
8354 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8355 if (SvIsCOW(tmpRef))
8356 sv_force_normal_flags(tmpRef, 0);
8357 if (SvREADONLY(tmpRef))
8358 Perl_croak(aTHX_ PL_no_modify);
8359 if (SvOBJECT(tmpRef)) {
8360 if (SvTYPE(tmpRef) != SVt_PVIO)
8362 SvREFCNT_dec(SvSTASH(tmpRef));
8365 SvOBJECT_on(tmpRef);
8366 if (SvTYPE(tmpRef) != SVt_PVIO)
8368 SvUPGRADE(tmpRef, SVt_PVMG);
8369 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8374 (void)SvAMAGIC_off(sv);
8376 if(SvSMAGICAL(tmpRef))
8377 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8385 /* Downgrades a PVGV to a PVMG.
8389 S_sv_unglob(pTHX_ SV *sv)
8394 SV * const temp = sv_newmortal();
8396 PERL_ARGS_ASSERT_SV_UNGLOB;
8398 assert(SvTYPE(sv) == SVt_PVGV);
8400 gv_efullname3(temp, (GV *) sv, "*");
8403 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8404 mro_method_changed_in(stash);
8408 sv_del_backref((SV*)GvSTASH(sv), sv);
8412 if (GvNAME_HEK(sv)) {
8413 unshare_hek(GvNAME_HEK(sv));
8415 isGV_with_GP_off(sv);
8417 /* need to keep SvANY(sv) in the right arena */
8418 xpvmg = new_XPVMG();
8419 StructCopy(SvANY(sv), xpvmg, XPVMG);
8420 del_XPVGV(SvANY(sv));
8423 SvFLAGS(sv) &= ~SVTYPEMASK;
8424 SvFLAGS(sv) |= SVt_PVMG;
8426 /* Intentionally not calling any local SET magic, as this isn't so much a
8427 set operation as merely an internal storage change. */
8428 sv_setsv_flags(sv, temp, 0);
8432 =for apidoc sv_unref_flags
8434 Unsets the RV status of the SV, and decrements the reference count of
8435 whatever was being referenced by the RV. This can almost be thought of
8436 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8437 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8438 (otherwise the decrementing is conditional on the reference count being
8439 different from one or the reference being a readonly SV).
8446 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8448 SV* const target = SvRV(ref);
8450 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8452 if (SvWEAKREF(ref)) {
8453 sv_del_backref(target, ref);
8455 SvRV_set(ref, NULL);
8458 SvRV_set(ref, NULL);
8460 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8461 assigned to as BEGIN {$a = \"Foo"} will fail. */
8462 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8463 SvREFCNT_dec(target);
8464 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8465 sv_2mortal(target); /* Schedule for freeing later */
8469 =for apidoc sv_untaint
8471 Untaint an SV. Use C<SvTAINTED_off> instead.
8476 Perl_sv_untaint(pTHX_ SV *sv)
8478 PERL_ARGS_ASSERT_SV_UNTAINT;
8480 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8481 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8488 =for apidoc sv_tainted
8490 Test an SV for taintedness. Use C<SvTAINTED> instead.
8495 Perl_sv_tainted(pTHX_ SV *sv)
8497 PERL_ARGS_ASSERT_SV_TAINTED;
8499 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8500 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8501 if (mg && (mg->mg_len & 1) )
8508 =for apidoc sv_setpviv
8510 Copies an integer into the given SV, also updating its string value.
8511 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8517 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8519 char buf[TYPE_CHARS(UV)];
8521 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8523 PERL_ARGS_ASSERT_SV_SETPVIV;
8525 sv_setpvn(sv, ptr, ebuf - ptr);
8529 =for apidoc sv_setpviv_mg
8531 Like C<sv_setpviv>, but also handles 'set' magic.
8537 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8539 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8545 #if defined(PERL_IMPLICIT_CONTEXT)
8547 /* pTHX_ magic can't cope with varargs, so this is a no-context
8548 * version of the main function, (which may itself be aliased to us).
8549 * Don't access this version directly.
8553 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8558 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8560 va_start(args, pat);
8561 sv_vsetpvf(sv, pat, &args);
8565 /* pTHX_ magic can't cope with varargs, so this is a no-context
8566 * version of the main function, (which may itself be aliased to us).
8567 * Don't access this version directly.
8571 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8576 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8578 va_start(args, pat);
8579 sv_vsetpvf_mg(sv, pat, &args);
8585 =for apidoc sv_setpvf
8587 Works like C<sv_catpvf> but copies the text into the SV instead of
8588 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8594 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8598 PERL_ARGS_ASSERT_SV_SETPVF;
8600 va_start(args, pat);
8601 sv_vsetpvf(sv, pat, &args);
8606 =for apidoc sv_vsetpvf
8608 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8609 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8611 Usually used via its frontend C<sv_setpvf>.
8617 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8619 PERL_ARGS_ASSERT_SV_VSETPVF;
8621 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8625 =for apidoc sv_setpvf_mg
8627 Like C<sv_setpvf>, but also handles 'set' magic.
8633 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8637 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8639 va_start(args, pat);
8640 sv_vsetpvf_mg(sv, pat, &args);
8645 =for apidoc sv_vsetpvf_mg
8647 Like C<sv_vsetpvf>, but also handles 'set' magic.
8649 Usually used via its frontend C<sv_setpvf_mg>.
8655 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8657 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8659 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8663 #if defined(PERL_IMPLICIT_CONTEXT)
8665 /* pTHX_ magic can't cope with varargs, so this is a no-context
8666 * version of the main function, (which may itself be aliased to us).
8667 * Don't access this version directly.
8671 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8676 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8678 va_start(args, pat);
8679 sv_vcatpvf(sv, pat, &args);
8683 /* pTHX_ magic can't cope with varargs, so this is a no-context
8684 * version of the main function, (which may itself be aliased to us).
8685 * Don't access this version directly.
8689 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8694 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8696 va_start(args, pat);
8697 sv_vcatpvf_mg(sv, pat, &args);
8703 =for apidoc sv_catpvf
8705 Processes its arguments like C<sprintf> and appends the formatted
8706 output to an SV. If the appended data contains "wide" characters
8707 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8708 and characters >255 formatted with %c), the original SV might get
8709 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8710 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8711 valid UTF-8; if the original SV was bytes, the pattern should be too.
8716 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8720 PERL_ARGS_ASSERT_SV_CATPVF;
8722 va_start(args, pat);
8723 sv_vcatpvf(sv, pat, &args);
8728 =for apidoc sv_vcatpvf
8730 Processes its arguments like C<vsprintf> and appends the formatted output
8731 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8733 Usually used via its frontend C<sv_catpvf>.
8739 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8741 PERL_ARGS_ASSERT_SV_VCATPVF;
8743 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8747 =for apidoc sv_catpvf_mg
8749 Like C<sv_catpvf>, but also handles 'set' magic.
8755 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8759 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8761 va_start(args, pat);
8762 sv_vcatpvf_mg(sv, pat, &args);
8767 =for apidoc sv_vcatpvf_mg
8769 Like C<sv_vcatpvf>, but also handles 'set' magic.
8771 Usually used via its frontend C<sv_catpvf_mg>.
8777 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8779 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8781 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8786 =for apidoc sv_vsetpvfn
8788 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8791 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8797 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8799 PERL_ARGS_ASSERT_SV_VSETPVFN;
8801 sv_setpvn(sv, "", 0);
8802 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8806 S_expect_number(pTHX_ char** pattern)
8811 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8813 switch (**pattern) {
8814 case '1': case '2': case '3':
8815 case '4': case '5': case '6':
8816 case '7': case '8': case '9':
8817 var = *(*pattern)++ - '0';
8818 while (isDIGIT(**pattern)) {
8819 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8821 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8829 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8831 const int neg = nv < 0;
8834 PERL_ARGS_ASSERT_F0CONVERT;
8842 if (uv & 1 && uv == nv)
8843 uv--; /* Round to even */
8845 const unsigned dig = uv % 10;
8858 =for apidoc sv_vcatpvfn
8860 Processes its arguments like C<vsprintf> and appends the formatted output
8861 to an SV. Uses an array of SVs if the C style variable argument list is
8862 missing (NULL). When running with taint checks enabled, indicates via
8863 C<maybe_tainted> if results are untrustworthy (often due to the use of
8866 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8872 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8873 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8874 vec_utf8 = DO_UTF8(vecsv);
8876 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8879 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8887 static const char nullstr[] = "(null)";
8889 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8890 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8892 /* Times 4: a decimal digit takes more than 3 binary digits.
8893 * NV_DIG: mantissa takes than many decimal digits.
8894 * Plus 32: Playing safe. */
8895 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8896 /* large enough for "%#.#f" --chip */
8897 /* what about long double NVs? --jhi */
8899 PERL_ARGS_ASSERT_SV_VCATPVFN;
8900 PERL_UNUSED_ARG(maybe_tainted);
8902 /* no matter what, this is a string now */
8903 (void)SvPV_force(sv, origlen);
8905 /* special-case "", "%s", and "%-p" (SVf - see below) */
8908 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8910 const char * const s = va_arg(*args, char*);
8911 sv_catpv(sv, s ? s : nullstr);
8913 else if (svix < svmax) {
8914 sv_catsv(sv, *svargs);
8918 if (args && patlen == 3 && pat[0] == '%' &&
8919 pat[1] == '-' && pat[2] == 'p') {
8920 argsv = (SV*)va_arg(*args, void*);
8921 sv_catsv(sv, argsv);
8925 #ifndef USE_LONG_DOUBLE
8926 /* special-case "%.<number>[gf]" */
8927 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8928 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8929 unsigned digits = 0;
8933 while (*pp >= '0' && *pp <= '9')
8934 digits = 10 * digits + (*pp++ - '0');
8935 if (pp - pat == (int)patlen - 1) {
8943 /* Add check for digits != 0 because it seems that some
8944 gconverts are buggy in this case, and we don't yet have
8945 a Configure test for this. */
8946 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8947 /* 0, point, slack */
8948 Gconvert(nv, (int)digits, 0, ebuf);
8950 if (*ebuf) /* May return an empty string for digits==0 */
8953 } else if (!digits) {
8956 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8957 sv_catpvn(sv, p, l);
8963 #endif /* !USE_LONG_DOUBLE */
8965 if (!args && svix < svmax && DO_UTF8(*svargs))
8968 patend = (char*)pat + patlen;
8969 for (p = (char*)pat; p < patend; p = q) {
8972 bool vectorize = FALSE;
8973 bool vectorarg = FALSE;
8974 bool vec_utf8 = FALSE;
8980 bool has_precis = FALSE;
8982 const I32 osvix = svix;
8983 bool is_utf8 = FALSE; /* is this item utf8? */
8984 #ifdef HAS_LDBL_SPRINTF_BUG
8985 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8986 with sfio - Allen <allens@cpan.org> */
8987 bool fix_ldbl_sprintf_bug = FALSE;
8991 U8 utf8buf[UTF8_MAXBYTES+1];
8992 STRLEN esignlen = 0;
8994 const char *eptr = NULL;
8997 const U8 *vecstr = NULL;
9004 /* we need a long double target in case HAS_LONG_DOUBLE but
9007 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9015 const char *dotstr = ".";
9016 STRLEN dotstrlen = 1;
9017 I32 efix = 0; /* explicit format parameter index */
9018 I32 ewix = 0; /* explicit width index */
9019 I32 epix = 0; /* explicit precision index */
9020 I32 evix = 0; /* explicit vector index */
9021 bool asterisk = FALSE;
9023 /* echo everything up to the next format specification */
9024 for (q = p; q < patend && *q != '%'; ++q) ;
9026 if (has_utf8 && !pat_utf8)
9027 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9029 sv_catpvn(sv, p, q - p);
9036 We allow format specification elements in this order:
9037 \d+\$ explicit format parameter index
9039 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9040 0 flag (as above): repeated to allow "v02"
9041 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9042 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9044 [%bcdefginopsuxDFOUX] format (mandatory)
9049 As of perl5.9.3, printf format checking is on by default.
9050 Internally, perl uses %p formats to provide an escape to
9051 some extended formatting. This block deals with those
9052 extensions: if it does not match, (char*)q is reset and
9053 the normal format processing code is used.
9055 Currently defined extensions are:
9056 %p include pointer address (standard)
9057 %-p (SVf) include an SV (previously %_)
9058 %-<num>p include an SV with precision <num>
9059 %<num>p reserved for future extensions
9061 Robin Barker 2005-07-14
9063 %1p (VDf) removed. RMB 2007-10-19
9070 n = expect_number(&q);
9077 argsv = (SV*)va_arg(*args, void*);
9078 eptr = SvPV_const(argsv, elen);
9084 if (ckWARN_d(WARN_INTERNAL))
9085 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9086 "internal %%<num>p might conflict with future printf extensions");
9092 if ( (width = expect_number(&q)) ) {
9107 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9136 if ( (ewix = expect_number(&q)) )
9145 if ((vectorarg = asterisk)) {
9158 width = expect_number(&q);
9164 vecsv = va_arg(*args, SV*);
9166 vecsv = (evix > 0 && evix <= svmax)
9167 ? svargs[evix-1] : &PL_sv_undef;
9169 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9171 dotstr = SvPV_const(vecsv, dotstrlen);
9172 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9173 bad with tied or overloaded values that return UTF8. */
9176 else if (has_utf8) {
9177 vecsv = sv_mortalcopy(vecsv);
9178 sv_utf8_upgrade(vecsv);
9179 dotstr = SvPV_const(vecsv, dotstrlen);
9186 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9187 vecsv = svargs[efix ? efix-1 : svix++];
9188 vecstr = (U8*)SvPV_const(vecsv,veclen);
9189 vec_utf8 = DO_UTF8(vecsv);
9191 /* if this is a version object, we need to convert
9192 * back into v-string notation and then let the
9193 * vectorize happen normally
9195 if (sv_derived_from(vecsv, "version")) {
9196 char *version = savesvpv(vecsv);
9197 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9198 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9199 "vector argument not supported with alpha versions");
9202 vecsv = sv_newmortal();
9203 scan_vstring(version, version + veclen, vecsv);
9204 vecstr = (U8*)SvPV_const(vecsv, veclen);
9205 vec_utf8 = DO_UTF8(vecsv);
9217 i = va_arg(*args, int);
9219 i = (ewix ? ewix <= svmax : svix < svmax) ?
9220 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9222 width = (i < 0) ? -i : i;
9232 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9234 /* XXX: todo, support specified precision parameter */
9238 i = va_arg(*args, int);
9240 i = (ewix ? ewix <= svmax : svix < svmax)
9241 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9243 has_precis = !(i < 0);
9248 precis = precis * 10 + (*q++ - '0');
9257 case 'I': /* Ix, I32x, and I64x */
9259 if (q[1] == '6' && q[2] == '4') {
9265 if (q[1] == '3' && q[2] == '2') {
9275 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9286 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9287 if (*(q + 1) == 'l') { /* lld, llf */
9313 if (!vectorize && !args) {
9315 const I32 i = efix-1;
9316 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9318 argsv = (svix >= 0 && svix < svmax)
9319 ? svargs[svix++] : &PL_sv_undef;
9330 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9332 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9334 eptr = (char*)utf8buf;
9335 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9349 eptr = va_arg(*args, char*);
9351 #ifdef MACOS_TRADITIONAL
9352 /* On MacOS, %#s format is used for Pascal strings */
9357 elen = strlen(eptr);
9359 eptr = (char *)nullstr;
9360 elen = sizeof nullstr - 1;
9364 eptr = SvPV_const(argsv, elen);
9365 if (DO_UTF8(argsv)) {
9366 I32 old_precis = precis;
9367 if (has_precis && precis < elen) {
9369 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9372 if (width) { /* fudge width (can't fudge elen) */
9373 if (has_precis && precis < elen)
9374 width += precis - old_precis;
9376 width += elen - sv_len_utf8(argsv);
9383 if (has_precis && elen > precis)
9390 if (alt || vectorize)
9392 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9413 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9422 esignbuf[esignlen++] = plus;
9426 case 'h': iv = (short)va_arg(*args, int); break;
9427 case 'l': iv = va_arg(*args, long); break;
9428 case 'V': iv = va_arg(*args, IV); break;
9429 default: iv = va_arg(*args, int); break;
9431 case 'q': iv = va_arg(*args, Quad_t); break;
9436 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9438 case 'h': iv = (short)tiv; break;
9439 case 'l': iv = (long)tiv; break;
9441 default: iv = tiv; break;
9443 case 'q': iv = (Quad_t)tiv; break;
9447 if ( !vectorize ) /* we already set uv above */
9452 esignbuf[esignlen++] = plus;
9456 esignbuf[esignlen++] = '-';
9500 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9511 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9512 case 'l': uv = va_arg(*args, unsigned long); break;
9513 case 'V': uv = va_arg(*args, UV); break;
9514 default: uv = va_arg(*args, unsigned); break;
9516 case 'q': uv = va_arg(*args, Uquad_t); break;
9521 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9523 case 'h': uv = (unsigned short)tuv; break;
9524 case 'l': uv = (unsigned long)tuv; break;
9526 default: uv = tuv; break;
9528 case 'q': uv = (Uquad_t)tuv; break;
9535 char *ptr = ebuf + sizeof ebuf;
9536 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9542 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9548 esignbuf[esignlen++] = '0';
9549 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9557 if (alt && *ptr != '0')
9566 esignbuf[esignlen++] = '0';
9567 esignbuf[esignlen++] = c;
9570 default: /* it had better be ten or less */
9574 } while (uv /= base);
9577 elen = (ebuf + sizeof ebuf) - ptr;
9581 zeros = precis - elen;
9582 else if (precis == 0 && elen == 1 && *eptr == '0'
9583 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9586 /* a precision nullifies the 0 flag. */
9593 /* FLOATING POINT */
9596 c = 'f'; /* maybe %F isn't supported here */
9604 /* This is evil, but floating point is even more evil */
9606 /* for SV-style calling, we can only get NV
9607 for C-style calling, we assume %f is double;
9608 for simplicity we allow any of %Lf, %llf, %qf for long double
9612 #if defined(USE_LONG_DOUBLE)
9616 /* [perl #20339] - we should accept and ignore %lf rather than die */
9620 #if defined(USE_LONG_DOUBLE)
9621 intsize = args ? 0 : 'q';
9625 #if defined(HAS_LONG_DOUBLE)
9634 /* now we need (long double) if intsize == 'q', else (double) */
9636 #if LONG_DOUBLESIZE > DOUBLESIZE
9638 va_arg(*args, long double) :
9639 va_arg(*args, double)
9641 va_arg(*args, double)
9646 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9647 else. frexp() has some unspecified behaviour for those three */
9648 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9650 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9651 will cast our (long double) to (double) */
9652 (void)Perl_frexp(nv, &i);
9653 if (i == PERL_INT_MIN)
9654 Perl_die(aTHX_ "panic: frexp");
9656 need = BIT_DIGITS(i);
9658 need += has_precis ? precis : 6; /* known default */
9663 #ifdef HAS_LDBL_SPRINTF_BUG
9664 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9665 with sfio - Allen <allens@cpan.org> */
9668 # define MY_DBL_MAX DBL_MAX
9669 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9670 # if DOUBLESIZE >= 8
9671 # define MY_DBL_MAX 1.7976931348623157E+308L
9673 # define MY_DBL_MAX 3.40282347E+38L
9677 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9678 # define MY_DBL_MAX_BUG 1L
9680 # define MY_DBL_MAX_BUG MY_DBL_MAX
9684 # define MY_DBL_MIN DBL_MIN
9685 # else /* XXX guessing! -Allen */
9686 # if DOUBLESIZE >= 8
9687 # define MY_DBL_MIN 2.2250738585072014E-308L
9689 # define MY_DBL_MIN 1.17549435E-38L
9693 if ((intsize == 'q') && (c == 'f') &&
9694 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9696 /* it's going to be short enough that
9697 * long double precision is not needed */
9699 if ((nv <= 0L) && (nv >= -0L))
9700 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9702 /* would use Perl_fp_class as a double-check but not
9703 * functional on IRIX - see perl.h comments */
9705 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9706 /* It's within the range that a double can represent */
9707 #if defined(DBL_MAX) && !defined(DBL_MIN)
9708 if ((nv >= ((long double)1/DBL_MAX)) ||
9709 (nv <= (-(long double)1/DBL_MAX)))
9711 fix_ldbl_sprintf_bug = TRUE;
9714 if (fix_ldbl_sprintf_bug == TRUE) {
9724 # undef MY_DBL_MAX_BUG
9727 #endif /* HAS_LDBL_SPRINTF_BUG */
9729 need += 20; /* fudge factor */
9730 if (PL_efloatsize < need) {
9731 Safefree(PL_efloatbuf);
9732 PL_efloatsize = need + 20; /* more fudge */
9733 Newx(PL_efloatbuf, PL_efloatsize, char);
9734 PL_efloatbuf[0] = '\0';
9737 if ( !(width || left || plus || alt) && fill != '0'
9738 && has_precis && intsize != 'q' ) { /* Shortcuts */
9739 /* See earlier comment about buggy Gconvert when digits,
9741 if ( c == 'g' && precis) {
9742 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9743 /* May return an empty string for digits==0 */
9744 if (*PL_efloatbuf) {
9745 elen = strlen(PL_efloatbuf);
9746 goto float_converted;
9748 } else if ( c == 'f' && !precis) {
9749 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9754 char *ptr = ebuf + sizeof ebuf;
9757 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9758 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9759 if (intsize == 'q') {
9760 /* Copy the one or more characters in a long double
9761 * format before the 'base' ([efgEFG]) character to
9762 * the format string. */
9763 static char const prifldbl[] = PERL_PRIfldbl;
9764 char const *p = prifldbl + sizeof(prifldbl) - 3;
9765 while (p >= prifldbl) { *--ptr = *p--; }
9770 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9775 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9787 /* No taint. Otherwise we are in the strange situation
9788 * where printf() taints but print($float) doesn't.
9790 #if defined(HAS_LONG_DOUBLE)
9791 elen = ((intsize == 'q')
9792 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9793 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9795 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9799 eptr = PL_efloatbuf;
9807 i = SvCUR(sv) - origlen;
9810 case 'h': *(va_arg(*args, short*)) = i; break;
9811 default: *(va_arg(*args, int*)) = i; break;
9812 case 'l': *(va_arg(*args, long*)) = i; break;
9813 case 'V': *(va_arg(*args, IV*)) = i; break;
9815 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9820 sv_setuv_mg(argsv, (UV)i);
9821 continue; /* not "break" */
9828 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9829 && ckWARN(WARN_PRINTF))
9831 SV * const msg = sv_newmortal();
9832 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9833 (PL_op->op_type == OP_PRTF) ? "" : "s");
9836 Perl_sv_catpvf(aTHX_ msg,
9837 "\"%%%c\"", c & 0xFF);
9839 Perl_sv_catpvf(aTHX_ msg,
9840 "\"%%\\%03"UVof"\"",
9843 sv_catpvs(msg, "end of string");
9844 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9847 /* output mangled stuff ... */
9853 /* ... right here, because formatting flags should not apply */
9854 SvGROW(sv, SvCUR(sv) + elen + 1);
9856 Copy(eptr, p, elen, char);
9859 SvCUR_set(sv, p - SvPVX_const(sv));
9861 continue; /* not "break" */
9864 if (is_utf8 != has_utf8) {
9867 sv_utf8_upgrade(sv);
9870 const STRLEN old_elen = elen;
9871 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9872 sv_utf8_upgrade(nsv);
9873 eptr = SvPVX_const(nsv);
9876 if (width) { /* fudge width (can't fudge elen) */
9877 width += elen - old_elen;
9883 have = esignlen + zeros + elen;
9885 Perl_croak_nocontext(PL_memory_wrap);
9887 need = (have > width ? have : width);
9890 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9891 Perl_croak_nocontext(PL_memory_wrap);
9892 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9894 if (esignlen && fill == '0') {
9896 for (i = 0; i < (int)esignlen; i++)
9900 memset(p, fill, gap);
9903 if (esignlen && fill != '0') {
9905 for (i = 0; i < (int)esignlen; i++)
9910 for (i = zeros; i; i--)
9914 Copy(eptr, p, elen, char);
9918 memset(p, ' ', gap);
9923 Copy(dotstr, p, dotstrlen, char);
9927 vectorize = FALSE; /* done iterating over vecstr */
9934 SvCUR_set(sv, p - SvPVX_const(sv));
9942 /* =========================================================================
9944 =head1 Cloning an interpreter
9946 All the macros and functions in this section are for the private use of
9947 the main function, perl_clone().
9949 The foo_dup() functions make an exact copy of an existing foo thingy.
9950 During the course of a cloning, a hash table is used to map old addresses
9951 to new addresses. The table is created and manipulated with the
9952 ptr_table_* functions.
9956 ============================================================================*/
9959 #if defined(USE_ITHREADS)
9961 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9962 #ifndef GpREFCNT_inc
9963 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9967 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9968 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9969 If this changes, please unmerge ss_dup. */
9970 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9971 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9972 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9973 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9974 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9975 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9976 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9977 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9978 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9979 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9980 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9981 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9982 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9983 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9985 /* clone a parser */
9988 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9992 PERL_ARGS_ASSERT_PARSER_DUP;
9997 /* look for it in the table first */
9998 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10002 /* create anew and remember what it is */
10003 Newxz(parser, 1, yy_parser);
10004 ptr_table_store(PL_ptr_table, proto, parser);
10006 parser->yyerrstatus = 0;
10007 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10009 /* XXX these not yet duped */
10010 parser->old_parser = NULL;
10011 parser->stack = NULL;
10013 parser->stack_size = 0;
10014 /* XXX parser->stack->state = 0; */
10016 /* XXX eventually, just Copy() most of the parser struct ? */
10018 parser->lex_brackets = proto->lex_brackets;
10019 parser->lex_casemods = proto->lex_casemods;
10020 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10021 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10022 parser->lex_casestack = savepvn(proto->lex_casestack,
10023 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10024 parser->lex_defer = proto->lex_defer;
10025 parser->lex_dojoin = proto->lex_dojoin;
10026 parser->lex_expect = proto->lex_expect;
10027 parser->lex_formbrack = proto->lex_formbrack;
10028 parser->lex_inpat = proto->lex_inpat;
10029 parser->lex_inwhat = proto->lex_inwhat;
10030 parser->lex_op = proto->lex_op;
10031 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10032 parser->lex_starts = proto->lex_starts;
10033 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10034 parser->multi_close = proto->multi_close;
10035 parser->multi_open = proto->multi_open;
10036 parser->multi_start = proto->multi_start;
10037 parser->multi_end = proto->multi_end;
10038 parser->pending_ident = proto->pending_ident;
10039 parser->preambled = proto->preambled;
10040 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10041 parser->linestr = sv_dup_inc(proto->linestr, param);
10042 parser->expect = proto->expect;
10043 parser->copline = proto->copline;
10044 parser->last_lop_op = proto->last_lop_op;
10045 parser->lex_state = proto->lex_state;
10046 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10047 /* rsfp_filters entries have fake IoDIRP() */
10048 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10049 parser->in_my = proto->in_my;
10050 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10051 parser->error_count = proto->error_count;
10054 parser->linestr = sv_dup_inc(proto->linestr, param);
10057 char * const ols = SvPVX(proto->linestr);
10058 char * const ls = SvPVX(parser->linestr);
10060 parser->bufptr = ls + (proto->bufptr >= ols ?
10061 proto->bufptr - ols : 0);
10062 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10063 proto->oldbufptr - ols : 0);
10064 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10065 proto->oldoldbufptr - ols : 0);
10066 parser->linestart = ls + (proto->linestart >= ols ?
10067 proto->linestart - ols : 0);
10068 parser->last_uni = ls + (proto->last_uni >= ols ?
10069 proto->last_uni - ols : 0);
10070 parser->last_lop = ls + (proto->last_lop >= ols ?
10071 proto->last_lop - ols : 0);
10073 parser->bufend = ls + SvCUR(parser->linestr);
10076 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10080 parser->endwhite = proto->endwhite;
10081 parser->faketokens = proto->faketokens;
10082 parser->lasttoke = proto->lasttoke;
10083 parser->nextwhite = proto->nextwhite;
10084 parser->realtokenstart = proto->realtokenstart;
10085 parser->skipwhite = proto->skipwhite;
10086 parser->thisclose = proto->thisclose;
10087 parser->thismad = proto->thismad;
10088 parser->thisopen = proto->thisopen;
10089 parser->thisstuff = proto->thisstuff;
10090 parser->thistoken = proto->thistoken;
10091 parser->thiswhite = proto->thiswhite;
10093 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10094 parser->curforce = proto->curforce;
10096 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10097 Copy(proto->nexttype, parser->nexttype, 5, I32);
10098 parser->nexttoke = proto->nexttoke;
10104 /* duplicate a file handle */
10107 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10111 PERL_ARGS_ASSERT_FP_DUP;
10112 PERL_UNUSED_ARG(type);
10115 return (PerlIO*)NULL;
10117 /* look for it in the table first */
10118 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10122 /* create anew and remember what it is */
10123 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10124 ptr_table_store(PL_ptr_table, fp, ret);
10128 /* duplicate a directory handle */
10131 Perl_dirp_dup(pTHX_ DIR *dp)
10133 PERL_UNUSED_CONTEXT;
10140 /* duplicate a typeglob */
10143 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10147 PERL_ARGS_ASSERT_GP_DUP;
10151 /* look for it in the table first */
10152 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10156 /* create anew and remember what it is */
10158 ptr_table_store(PL_ptr_table, gp, ret);
10161 ret->gp_refcnt = 0; /* must be before any other dups! */
10162 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10163 ret->gp_io = io_dup_inc(gp->gp_io, param);
10164 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10165 ret->gp_av = av_dup_inc(gp->gp_av, param);
10166 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10167 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10168 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10169 ret->gp_cvgen = gp->gp_cvgen;
10170 ret->gp_line = gp->gp_line;
10171 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10175 /* duplicate a chain of magic */
10178 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10180 MAGIC *mgprev = (MAGIC*)NULL;
10183 PERL_ARGS_ASSERT_MG_DUP;
10186 return (MAGIC*)NULL;
10187 /* look for it in the table first */
10188 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10192 for (; mg; mg = mg->mg_moremagic) {
10194 Newxz(nmg, 1, MAGIC);
10196 mgprev->mg_moremagic = nmg;
10199 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10200 nmg->mg_private = mg->mg_private;
10201 nmg->mg_type = mg->mg_type;
10202 nmg->mg_flags = mg->mg_flags;
10203 /* FIXME for plugins
10204 if (mg->mg_type == PERL_MAGIC_qr) {
10205 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10209 if(mg->mg_type == PERL_MAGIC_backref) {
10210 /* The backref AV has its reference count deliberately bumped by
10212 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10215 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10216 ? sv_dup_inc(mg->mg_obj, param)
10217 : sv_dup(mg->mg_obj, param);
10219 nmg->mg_len = mg->mg_len;
10220 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10221 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10222 if (mg->mg_len > 0) {
10223 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10224 if (mg->mg_type == PERL_MAGIC_overload_table &&
10225 AMT_AMAGIC((AMT*)mg->mg_ptr))
10227 const AMT * const amtp = (AMT*)mg->mg_ptr;
10228 AMT * const namtp = (AMT*)nmg->mg_ptr;
10230 for (i = 1; i < NofAMmeth; i++) {
10231 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10235 else if (mg->mg_len == HEf_SVKEY)
10236 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10238 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10239 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10246 #endif /* USE_ITHREADS */
10248 /* create a new pointer-mapping table */
10251 Perl_ptr_table_new(pTHX)
10254 PERL_UNUSED_CONTEXT;
10256 Newxz(tbl, 1, PTR_TBL_t);
10257 tbl->tbl_max = 511;
10258 tbl->tbl_items = 0;
10259 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10263 #define PTR_TABLE_HASH(ptr) \
10264 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10267 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10268 following define) and at call to new_body_inline made below in
10269 Perl_ptr_table_store()
10272 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10274 /* map an existing pointer using a table */
10276 STATIC PTR_TBL_ENT_t *
10277 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv)
10279 PTR_TBL_ENT_t *tblent;
10280 const UV hash = PTR_TABLE_HASH(sv);
10282 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10284 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10285 for (; tblent; tblent = tblent->next) {
10286 if (tblent->oldval == sv)
10293 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10295 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10297 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10298 PERL_UNUSED_CONTEXT;
10300 return tblent ? tblent->newval : NULL;
10303 /* add a new entry to a pointer-mapping table */
10306 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10308 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10310 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10311 PERL_UNUSED_CONTEXT;
10314 tblent->newval = newsv;
10316 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10318 new_body_inline(tblent, PTE_SVSLOT);
10320 tblent->oldval = oldsv;
10321 tblent->newval = newsv;
10322 tblent->next = tbl->tbl_ary[entry];
10323 tbl->tbl_ary[entry] = tblent;
10325 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10326 ptr_table_split(tbl);
10330 /* double the hash bucket size of an existing ptr table */
10333 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10335 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10336 const UV oldsize = tbl->tbl_max + 1;
10337 UV newsize = oldsize * 2;
10340 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10341 PERL_UNUSED_CONTEXT;
10343 Renew(ary, newsize, PTR_TBL_ENT_t*);
10344 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10345 tbl->tbl_max = --newsize;
10346 tbl->tbl_ary = ary;
10347 for (i=0; i < oldsize; i++, ary++) {
10348 PTR_TBL_ENT_t **curentp, **entp, *ent;
10351 curentp = ary + oldsize;
10352 for (entp = ary, ent = *ary; ent; ent = *entp) {
10353 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10355 ent->next = *curentp;
10365 /* remove all the entries from a ptr table */
10368 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10370 if (tbl && tbl->tbl_items) {
10371 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10372 UV riter = tbl->tbl_max;
10375 PTR_TBL_ENT_t *entry = array[riter];
10378 PTR_TBL_ENT_t * const oentry = entry;
10379 entry = entry->next;
10384 tbl->tbl_items = 0;
10388 /* clear and free a ptr table */
10391 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10396 ptr_table_clear(tbl);
10397 Safefree(tbl->tbl_ary);
10401 #if defined(USE_ITHREADS)
10404 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10406 PERL_ARGS_ASSERT_RVPV_DUP;
10409 SvRV_set(dstr, SvWEAKREF(sstr)
10410 ? sv_dup(SvRV(sstr), param)
10411 : sv_dup_inc(SvRV(sstr), param));
10414 else if (SvPVX_const(sstr)) {
10415 /* Has something there */
10417 /* Normal PV - clone whole allocated space */
10418 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10419 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10420 /* Not that normal - actually sstr is copy on write.
10421 But we are a true, independant SV, so: */
10422 SvREADONLY_off(dstr);
10427 /* Special case - not normally malloced for some reason */
10428 if (isGV_with_GP(sstr)) {
10429 /* Don't need to do anything here. */
10431 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10432 /* A "shared" PV - clone it as "shared" PV */
10434 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10438 /* Some other special case - random pointer */
10439 SvPV_set(dstr, SvPVX(sstr));
10444 /* Copy the NULL */
10445 SvPV_set(dstr, NULL);
10449 /* duplicate an SV of any type (including AV, HV etc) */
10452 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10457 PERL_ARGS_ASSERT_SV_DUP;
10461 if (SvTYPE(sstr) == SVTYPEMASK) {
10462 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10467 /* look for it in the table first */
10468 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10472 if(param->flags & CLONEf_JOIN_IN) {
10473 /** We are joining here so we don't want do clone
10474 something that is bad **/
10475 if (SvTYPE(sstr) == SVt_PVHV) {
10476 const HEK * const hvname = HvNAME_HEK(sstr);
10478 /** don't clone stashes if they already exist **/
10479 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10483 /* create anew and remember what it is */
10486 #ifdef DEBUG_LEAKING_SCALARS
10487 dstr->sv_debug_optype = sstr->sv_debug_optype;
10488 dstr->sv_debug_line = sstr->sv_debug_line;
10489 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10490 dstr->sv_debug_cloned = 1;
10491 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10494 ptr_table_store(PL_ptr_table, sstr, dstr);
10497 SvFLAGS(dstr) = SvFLAGS(sstr);
10498 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10499 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10502 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10503 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10504 (void*)PL_watch_pvx, SvPVX_const(sstr));
10507 /* don't clone objects whose class has asked us not to */
10508 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10513 switch (SvTYPE(sstr)) {
10515 SvANY(dstr) = NULL;
10518 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10520 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10522 SvIV_set(dstr, SvIVX(sstr));
10526 SvANY(dstr) = new_XNV();
10527 SvNV_set(dstr, SvNVX(sstr));
10529 /* case SVt_BIND: */
10532 /* These are all the types that need complex bodies allocating. */
10534 const svtype sv_type = SvTYPE(sstr);
10535 const struct body_details *const sv_type_details
10536 = bodies_by_type + sv_type;
10540 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10544 if (GvUNIQUE((GV*)sstr)) {
10545 NOOP; /* Do sharing here, and fall through */
10558 assert(sv_type_details->body_size);
10559 if (sv_type_details->arena) {
10560 new_body_inline(new_body, sv_type);
10562 = (void*)((char*)new_body - sv_type_details->offset);
10564 new_body = new_NOARENA(sv_type_details);
10568 SvANY(dstr) = new_body;
10571 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10572 ((char*)SvANY(dstr)) + sv_type_details->offset,
10573 sv_type_details->copy, char);
10575 Copy(((char*)SvANY(sstr)),
10576 ((char*)SvANY(dstr)),
10577 sv_type_details->body_size + sv_type_details->offset, char);
10580 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10581 && !isGV_with_GP(dstr))
10582 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10584 /* The Copy above means that all the source (unduplicated) pointers
10585 are now in the destination. We can check the flags and the
10586 pointers in either, but it's possible that there's less cache
10587 missing by always going for the destination.
10588 FIXME - instrument and check that assumption */
10589 if (sv_type >= SVt_PVMG) {
10590 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10591 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10592 } else if (SvMAGIC(dstr))
10593 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10595 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10598 /* The cast silences a GCC warning about unhandled types. */
10599 switch ((int)sv_type) {
10609 /* FIXME for plugins */
10610 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10613 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10614 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10615 LvTARG(dstr) = dstr;
10616 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10617 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10619 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10621 if(isGV_with_GP(sstr)) {
10622 if (GvNAME_HEK(dstr))
10623 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10624 /* Don't call sv_add_backref here as it's going to be
10625 created as part of the magic cloning of the symbol
10627 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10628 at the point of this comment. */
10629 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10630 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10631 (void)GpREFCNT_inc(GvGP(dstr));
10633 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10636 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10637 if (IoOFP(dstr) == IoIFP(sstr))
10638 IoOFP(dstr) = IoIFP(dstr);
10640 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10641 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10642 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10643 /* I have no idea why fake dirp (rsfps)
10644 should be treated differently but otherwise
10645 we end up with leaks -- sky*/
10646 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10647 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10648 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10650 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10651 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10652 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10653 if (IoDIRP(dstr)) {
10654 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10657 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10660 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10661 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10662 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10665 if (AvARRAY((AV*)sstr)) {
10666 SV **dst_ary, **src_ary;
10667 SSize_t items = AvFILLp((AV*)sstr) + 1;
10669 src_ary = AvARRAY((AV*)sstr);
10670 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10671 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10672 AvARRAY((AV*)dstr) = dst_ary;
10673 AvALLOC((AV*)dstr) = dst_ary;
10674 if (AvREAL((AV*)sstr)) {
10675 while (items-- > 0)
10676 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10679 while (items-- > 0)
10680 *dst_ary++ = sv_dup(*src_ary++, param);
10682 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10683 while (items-- > 0) {
10684 *dst_ary++ = &PL_sv_undef;
10688 AvARRAY((AV*)dstr) = NULL;
10689 AvALLOC((AV*)dstr) = (SV**)NULL;
10693 if (HvARRAY((HV*)sstr)) {
10695 const bool sharekeys = !!HvSHAREKEYS(sstr);
10696 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10697 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10699 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10700 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10702 HvARRAY(dstr) = (HE**)darray;
10703 while (i <= sxhv->xhv_max) {
10704 const HE * const source = HvARRAY(sstr)[i];
10705 HvARRAY(dstr)[i] = source
10706 ? he_dup(source, sharekeys, param) : 0;
10711 const struct xpvhv_aux * const saux = HvAUX(sstr);
10712 struct xpvhv_aux * const daux = HvAUX(dstr);
10713 /* This flag isn't copied. */
10714 /* SvOOK_on(hv) attacks the IV flags. */
10715 SvFLAGS(dstr) |= SVf_OOK;
10717 hvname = saux->xhv_name;
10718 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10720 daux->xhv_riter = saux->xhv_riter;
10721 daux->xhv_eiter = saux->xhv_eiter
10722 ? he_dup(saux->xhv_eiter,
10723 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10724 daux->xhv_backreferences =
10725 saux->xhv_backreferences
10726 ? (AV*) SvREFCNT_inc(
10727 sv_dup((SV*)saux->xhv_backreferences, param))
10730 daux->xhv_mro_meta = saux->xhv_mro_meta
10731 ? mro_meta_dup(saux->xhv_mro_meta, param)
10734 /* Record stashes for possible cloning in Perl_clone(). */
10736 av_push(param->stashes, dstr);
10740 HvARRAY((HV*)dstr) = NULL;
10743 if (!(param->flags & CLONEf_COPY_STACKS)) {
10747 /* NOTE: not refcounted */
10748 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10750 if (!CvISXSUB(dstr))
10751 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10753 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10754 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10755 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10756 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10758 /* don't dup if copying back - CvGV isn't refcounted, so the
10759 * duped GV may never be freed. A bit of a hack! DAPM */
10760 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10761 NULL : gv_dup(CvGV(dstr), param) ;
10762 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10764 CvWEAKOUTSIDE(sstr)
10765 ? cv_dup( CvOUTSIDE(dstr), param)
10766 : cv_dup_inc(CvOUTSIDE(dstr), param);
10767 if (!CvISXSUB(dstr))
10768 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10774 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10780 /* duplicate a context */
10783 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10785 PERL_CONTEXT *ncxs;
10787 PERL_ARGS_ASSERT_CX_DUP;
10790 return (PERL_CONTEXT*)NULL;
10792 /* look for it in the table first */
10793 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10797 /* create anew and remember what it is */
10798 Newx(ncxs, max + 1, PERL_CONTEXT);
10799 ptr_table_store(PL_ptr_table, cxs, ncxs);
10800 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10803 PERL_CONTEXT * const ncx = &ncxs[ix];
10804 if (CxTYPE(ncx) == CXt_SUBST) {
10805 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10808 switch (CxTYPE(ncx)) {
10810 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10811 ? cv_dup_inc(ncx->blk_sub.cv, param)
10812 : cv_dup(ncx->blk_sub.cv,param));
10813 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10814 ? av_dup_inc(ncx->blk_sub.argarray,
10817 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10819 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10820 ncx->blk_sub.oldcomppad);
10823 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10825 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10827 case CXt_LOOP_LAZYSV:
10828 ncx->blk_loop.state_u.lazysv.end
10829 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10830 /* We are taking advantage of av_dup_inc and sv_dup_inc
10831 actually being the same function, and order equivalance of
10833 We can assert the later [but only at run time :-(] */
10834 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10835 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10837 ncx->blk_loop.state_u.ary.ary
10838 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10839 case CXt_LOOP_LAZYIV:
10840 case CXt_LOOP_PLAIN:
10841 if (CxPADLOOP(ncx)) {
10842 ncx->blk_loop.oldcomppad
10843 = (PAD*)ptr_table_fetch(PL_ptr_table,
10844 ncx->blk_loop.oldcomppad);
10846 ncx->blk_loop.oldcomppad
10847 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10851 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10852 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10853 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10866 /* duplicate a stack info structure */
10869 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10873 PERL_ARGS_ASSERT_SI_DUP;
10876 return (PERL_SI*)NULL;
10878 /* look for it in the table first */
10879 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10883 /* create anew and remember what it is */
10884 Newxz(nsi, 1, PERL_SI);
10885 ptr_table_store(PL_ptr_table, si, nsi);
10887 nsi->si_stack = av_dup_inc(si->si_stack, param);
10888 nsi->si_cxix = si->si_cxix;
10889 nsi->si_cxmax = si->si_cxmax;
10890 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10891 nsi->si_type = si->si_type;
10892 nsi->si_prev = si_dup(si->si_prev, param);
10893 nsi->si_next = si_dup(si->si_next, param);
10894 nsi->si_markoff = si->si_markoff;
10899 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10900 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10901 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10902 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10903 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10904 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10905 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10906 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10907 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10908 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10909 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10910 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10911 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10912 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10915 #define pv_dup_inc(p) SAVEPV(p)
10916 #define pv_dup(p) SAVEPV(p)
10917 #define svp_dup_inc(p,pp) any_dup(p,pp)
10919 /* map any object to the new equivent - either something in the
10920 * ptr table, or something in the interpreter structure
10924 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10928 PERL_ARGS_ASSERT_ANY_DUP;
10931 return (void*)NULL;
10933 /* look for it in the table first */
10934 ret = ptr_table_fetch(PL_ptr_table, v);
10938 /* see if it is part of the interpreter structure */
10939 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10940 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10948 /* duplicate the save stack */
10951 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10954 ANY * const ss = proto_perl->Isavestack;
10955 const I32 max = proto_perl->Isavestack_max;
10956 I32 ix = proto_perl->Isavestack_ix;
10969 void (*dptr) (void*);
10970 void (*dxptr) (pTHX_ void*);
10972 PERL_ARGS_ASSERT_SS_DUP;
10974 Newxz(nss, max, ANY);
10977 const I32 type = POPINT(ss,ix);
10978 TOPINT(nss,ix) = type;
10980 case SAVEt_HELEM: /* hash element */
10981 sv = (SV*)POPPTR(ss,ix);
10982 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10984 case SAVEt_ITEM: /* normal string */
10985 case SAVEt_SV: /* scalar reference */
10986 sv = (SV*)POPPTR(ss,ix);
10987 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10990 case SAVEt_MORTALIZESV:
10991 sv = (SV*)POPPTR(ss,ix);
10992 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10994 case SAVEt_SHARED_PVREF: /* char* in shared space */
10995 c = (char*)POPPTR(ss,ix);
10996 TOPPTR(nss,ix) = savesharedpv(c);
10997 ptr = POPPTR(ss,ix);
10998 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11000 case SAVEt_GENERIC_SVREF: /* generic sv */
11001 case SAVEt_SVREF: /* scalar reference */
11002 sv = (SV*)POPPTR(ss,ix);
11003 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11004 ptr = POPPTR(ss,ix);
11005 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11007 case SAVEt_HV: /* hash reference */
11008 case SAVEt_AV: /* array reference */
11009 sv = (SV*) POPPTR(ss,ix);
11010 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11012 case SAVEt_COMPPAD:
11014 sv = (SV*) POPPTR(ss,ix);
11015 TOPPTR(nss,ix) = sv_dup(sv, param);
11017 case SAVEt_INT: /* int reference */
11018 ptr = POPPTR(ss,ix);
11019 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11020 intval = (int)POPINT(ss,ix);
11021 TOPINT(nss,ix) = intval;
11023 case SAVEt_LONG: /* long reference */
11024 ptr = POPPTR(ss,ix);
11025 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11027 case SAVEt_CLEARSV:
11028 longval = (long)POPLONG(ss,ix);
11029 TOPLONG(nss,ix) = longval;
11031 case SAVEt_I32: /* I32 reference */
11032 case SAVEt_I16: /* I16 reference */
11033 case SAVEt_I8: /* I8 reference */
11034 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11035 ptr = POPPTR(ss,ix);
11036 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11038 TOPINT(nss,ix) = i;
11040 case SAVEt_IV: /* IV reference */
11041 ptr = POPPTR(ss,ix);
11042 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11044 TOPIV(nss,ix) = iv;
11046 case SAVEt_HPTR: /* HV* reference */
11047 case SAVEt_APTR: /* AV* reference */
11048 case SAVEt_SPTR: /* SV* reference */
11049 ptr = POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11051 sv = (SV*)POPPTR(ss,ix);
11052 TOPPTR(nss,ix) = sv_dup(sv, param);
11054 case SAVEt_VPTR: /* random* reference */
11055 ptr = POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11057 ptr = POPPTR(ss,ix);
11058 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11060 case SAVEt_GENERIC_PVREF: /* generic char* */
11061 case SAVEt_PPTR: /* char* reference */
11062 ptr = POPPTR(ss,ix);
11063 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11064 c = (char*)POPPTR(ss,ix);
11065 TOPPTR(nss,ix) = pv_dup(c);
11067 case SAVEt_GP: /* scalar reference */
11068 gp = (GP*)POPPTR(ss,ix);
11069 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11070 (void)GpREFCNT_inc(gp);
11071 gv = (GV*)POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11075 ptr = POPPTR(ss,ix);
11076 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11077 /* these are assumed to be refcounted properly */
11079 switch (((OP*)ptr)->op_type) {
11081 case OP_LEAVESUBLV:
11085 case OP_LEAVEWRITE:
11086 TOPPTR(nss,ix) = ptr;
11089 (void) OpREFCNT_inc(o);
11093 TOPPTR(nss,ix) = NULL;
11098 TOPPTR(nss,ix) = NULL;
11101 c = (char*)POPPTR(ss,ix);
11102 TOPPTR(nss,ix) = pv_dup_inc(c);
11105 hv = (HV*)POPPTR(ss,ix);
11106 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11107 c = (char*)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = pv_dup_inc(c);
11110 case SAVEt_STACK_POS: /* Position on Perl stack */
11112 TOPINT(nss,ix) = i;
11114 case SAVEt_DESTRUCTOR:
11115 ptr = POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11117 dptr = POPDPTR(ss,ix);
11118 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11119 any_dup(FPTR2DPTR(void *, dptr),
11122 case SAVEt_DESTRUCTOR_X:
11123 ptr = POPPTR(ss,ix);
11124 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11125 dxptr = POPDXPTR(ss,ix);
11126 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11127 any_dup(FPTR2DPTR(void *, dxptr),
11130 case SAVEt_REGCONTEXT:
11133 TOPINT(nss,ix) = i;
11136 case SAVEt_AELEM: /* array element */
11137 sv = (SV*)POPPTR(ss,ix);
11138 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11140 TOPINT(nss,ix) = i;
11141 av = (AV*)POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = av_dup_inc(av, param);
11145 ptr = POPPTR(ss,ix);
11146 TOPPTR(nss,ix) = ptr;
11150 TOPINT(nss,ix) = i;
11151 ptr = POPPTR(ss,ix);
11154 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11155 HINTS_REFCNT_UNLOCK;
11157 TOPPTR(nss,ix) = ptr;
11158 if (i & HINT_LOCALIZE_HH) {
11159 hv = (HV*)POPPTR(ss,ix);
11160 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11163 case SAVEt_PADSV_AND_MORTALIZE:
11164 longval = (long)POPLONG(ss,ix);
11165 TOPLONG(nss,ix) = longval;
11166 ptr = POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11168 sv = (SV*)POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11172 ptr = POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11174 longval = (long)POPBOOL(ss,ix);
11175 TOPBOOL(nss,ix) = (bool)longval;
11177 case SAVEt_SET_SVFLAGS:
11179 TOPINT(nss,ix) = i;
11181 TOPINT(nss,ix) = i;
11182 sv = (SV*)POPPTR(ss,ix);
11183 TOPPTR(nss,ix) = sv_dup(sv, param);
11185 case SAVEt_RE_STATE:
11187 const struct re_save_state *const old_state
11188 = (struct re_save_state *)
11189 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11190 struct re_save_state *const new_state
11191 = (struct re_save_state *)
11192 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11194 Copy(old_state, new_state, 1, struct re_save_state);
11195 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11197 new_state->re_state_bostr
11198 = pv_dup(old_state->re_state_bostr);
11199 new_state->re_state_reginput
11200 = pv_dup(old_state->re_state_reginput);
11201 new_state->re_state_regeol
11202 = pv_dup(old_state->re_state_regeol);
11203 new_state->re_state_regoffs
11204 = (regexp_paren_pair*)
11205 any_dup(old_state->re_state_regoffs, proto_perl);
11206 new_state->re_state_reglastparen
11207 = (U32*) any_dup(old_state->re_state_reglastparen,
11209 new_state->re_state_reglastcloseparen
11210 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11212 /* XXX This just has to be broken. The old save_re_context
11213 code did SAVEGENERICPV(PL_reg_start_tmp);
11214 PL_reg_start_tmp is char **.
11215 Look above to what the dup code does for
11216 SAVEt_GENERIC_PVREF
11217 It can never have worked.
11218 So this is merely a faithful copy of the exiting bug: */
11219 new_state->re_state_reg_start_tmp
11220 = (char **) pv_dup((char *)
11221 old_state->re_state_reg_start_tmp);
11222 /* I assume that it only ever "worked" because no-one called
11223 (pseudo)fork while the regexp engine had re-entered itself.
11225 #ifdef PERL_OLD_COPY_ON_WRITE
11226 new_state->re_state_nrs
11227 = sv_dup(old_state->re_state_nrs, param);
11229 new_state->re_state_reg_magic
11230 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11232 new_state->re_state_reg_oldcurpm
11233 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11235 new_state->re_state_reg_curpm
11236 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11238 new_state->re_state_reg_oldsaved
11239 = pv_dup(old_state->re_state_reg_oldsaved);
11240 new_state->re_state_reg_poscache
11241 = pv_dup(old_state->re_state_reg_poscache);
11242 new_state->re_state_reg_starttry
11243 = pv_dup(old_state->re_state_reg_starttry);
11246 case SAVEt_COMPILE_WARNINGS:
11247 ptr = POPPTR(ss,ix);
11248 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11251 ptr = POPPTR(ss,ix);
11252 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11256 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11264 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11265 * flag to the result. This is done for each stash before cloning starts,
11266 * so we know which stashes want their objects cloned */
11269 do_mark_cloneable_stash(pTHX_ SV *const sv)
11271 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11273 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11274 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11275 if (cloner && GvCV(cloner)) {
11282 mXPUSHs(newSVhek(hvname));
11284 call_sv((SV*)GvCV(cloner), G_SCALAR);
11291 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11299 =for apidoc perl_clone
11301 Create and return a new interpreter by cloning the current one.
11303 perl_clone takes these flags as parameters:
11305 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11306 without it we only clone the data and zero the stacks,
11307 with it we copy the stacks and the new perl interpreter is
11308 ready to run at the exact same point as the previous one.
11309 The pseudo-fork code uses COPY_STACKS while the
11310 threads->create doesn't.
11312 CLONEf_KEEP_PTR_TABLE
11313 perl_clone keeps a ptr_table with the pointer of the old
11314 variable as a key and the new variable as a value,
11315 this allows it to check if something has been cloned and not
11316 clone it again but rather just use the value and increase the
11317 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11318 the ptr_table using the function
11319 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11320 reason to keep it around is if you want to dup some of your own
11321 variable who are outside the graph perl scans, example of this
11322 code is in threads.xs create
11325 This is a win32 thing, it is ignored on unix, it tells perls
11326 win32host code (which is c++) to clone itself, this is needed on
11327 win32 if you want to run two threads at the same time,
11328 if you just want to do some stuff in a separate perl interpreter
11329 and then throw it away and return to the original one,
11330 you don't need to do anything.
11335 /* XXX the above needs expanding by someone who actually understands it ! */
11336 EXTERN_C PerlInterpreter *
11337 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11340 perl_clone(PerlInterpreter *proto_perl, UV flags)
11343 #ifdef PERL_IMPLICIT_SYS
11345 PERL_ARGS_ASSERT_PERL_CLONE;
11347 /* perlhost.h so we need to call into it
11348 to clone the host, CPerlHost should have a c interface, sky */
11350 if (flags & CLONEf_CLONE_HOST) {
11351 return perl_clone_host(proto_perl,flags);
11353 return perl_clone_using(proto_perl, flags,
11355 proto_perl->IMemShared,
11356 proto_perl->IMemParse,
11358 proto_perl->IStdIO,
11362 proto_perl->IProc);
11366 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11367 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11368 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11369 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11370 struct IPerlDir* ipD, struct IPerlSock* ipS,
11371 struct IPerlProc* ipP)
11373 /* XXX many of the string copies here can be optimized if they're
11374 * constants; they need to be allocated as common memory and just
11375 * their pointers copied. */
11378 CLONE_PARAMS clone_params;
11379 CLONE_PARAMS* const param = &clone_params;
11381 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11383 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11385 /* for each stash, determine whether its objects should be cloned */
11386 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11387 PERL_SET_THX(my_perl);
11390 PoisonNew(my_perl, 1, PerlInterpreter);
11396 PL_savestack_ix = 0;
11397 PL_savestack_max = -1;
11398 PL_sig_pending = 0;
11400 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11401 # else /* !DEBUGGING */
11402 Zero(my_perl, 1, PerlInterpreter);
11403 # endif /* DEBUGGING */
11405 /* host pointers */
11407 PL_MemShared = ipMS;
11408 PL_MemParse = ipMP;
11415 #else /* !PERL_IMPLICIT_SYS */
11417 CLONE_PARAMS clone_params;
11418 CLONE_PARAMS* param = &clone_params;
11419 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11421 PERL_ARGS_ASSERT_PERL_CLONE;
11423 /* for each stash, determine whether its objects should be cloned */
11424 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11425 PERL_SET_THX(my_perl);
11428 PoisonNew(my_perl, 1, PerlInterpreter);
11434 PL_savestack_ix = 0;
11435 PL_savestack_max = -1;
11436 PL_sig_pending = 0;
11438 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11439 # else /* !DEBUGGING */
11440 Zero(my_perl, 1, PerlInterpreter);
11441 # endif /* DEBUGGING */
11442 #endif /* PERL_IMPLICIT_SYS */
11443 param->flags = flags;
11444 param->proto_perl = proto_perl;
11446 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11448 PL_body_arenas = NULL;
11449 Zero(&PL_body_roots, 1, PL_body_roots);
11451 PL_nice_chunk = NULL;
11452 PL_nice_chunk_size = 0;
11454 PL_sv_objcount = 0;
11456 PL_sv_arenaroot = NULL;
11458 PL_debug = proto_perl->Idebug;
11460 PL_hash_seed = proto_perl->Ihash_seed;
11461 PL_rehash_seed = proto_perl->Irehash_seed;
11463 #ifdef USE_REENTRANT_API
11464 /* XXX: things like -Dm will segfault here in perlio, but doing
11465 * PERL_SET_CONTEXT(proto_perl);
11466 * breaks too many other things
11468 Perl_reentrant_init(aTHX);
11471 /* create SV map for pointer relocation */
11472 PL_ptr_table = ptr_table_new();
11474 /* initialize these special pointers as early as possible */
11475 SvANY(&PL_sv_undef) = NULL;
11476 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11477 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11478 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11480 SvANY(&PL_sv_no) = new_XPVNV();
11481 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11482 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11483 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11484 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11485 SvCUR_set(&PL_sv_no, 0);
11486 SvLEN_set(&PL_sv_no, 1);
11487 SvIV_set(&PL_sv_no, 0);
11488 SvNV_set(&PL_sv_no, 0);
11489 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11491 SvANY(&PL_sv_yes) = new_XPVNV();
11492 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11493 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11494 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11495 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11496 SvCUR_set(&PL_sv_yes, 1);
11497 SvLEN_set(&PL_sv_yes, 2);
11498 SvIV_set(&PL_sv_yes, 1);
11499 SvNV_set(&PL_sv_yes, 1);
11500 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11502 /* create (a non-shared!) shared string table */
11503 PL_strtab = newHV();
11504 HvSHAREKEYS_off(PL_strtab);
11505 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11506 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11508 PL_compiling = proto_perl->Icompiling;
11510 /* These two PVs will be free'd special way so must set them same way op.c does */
11511 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11512 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11514 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11515 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11517 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11518 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11519 if (PL_compiling.cop_hints_hash) {
11521 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11522 HINTS_REFCNT_UNLOCK;
11524 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11525 #ifdef PERL_DEBUG_READONLY_OPS
11530 /* pseudo environmental stuff */
11531 PL_origargc = proto_perl->Iorigargc;
11532 PL_origargv = proto_perl->Iorigargv;
11534 param->stashes = newAV(); /* Setup array of objects to call clone on */
11536 /* Set tainting stuff before PerlIO_debug can possibly get called */
11537 PL_tainting = proto_perl->Itainting;
11538 PL_taint_warn = proto_perl->Itaint_warn;
11540 #ifdef PERLIO_LAYERS
11541 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11542 PerlIO_clone(aTHX_ proto_perl, param);
11545 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11546 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11547 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11548 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11549 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11550 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11553 PL_minus_c = proto_perl->Iminus_c;
11554 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11555 PL_localpatches = proto_perl->Ilocalpatches;
11556 PL_splitstr = proto_perl->Isplitstr;
11557 PL_minus_n = proto_perl->Iminus_n;
11558 PL_minus_p = proto_perl->Iminus_p;
11559 PL_minus_l = proto_perl->Iminus_l;
11560 PL_minus_a = proto_perl->Iminus_a;
11561 PL_minus_E = proto_perl->Iminus_E;
11562 PL_minus_F = proto_perl->Iminus_F;
11563 PL_doswitches = proto_perl->Idoswitches;
11564 PL_dowarn = proto_perl->Idowarn;
11565 PL_doextract = proto_perl->Idoextract;
11566 PL_sawampersand = proto_perl->Isawampersand;
11567 PL_unsafe = proto_perl->Iunsafe;
11568 PL_inplace = SAVEPV(proto_perl->Iinplace);
11569 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11570 PL_perldb = proto_perl->Iperldb;
11571 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11572 PL_exit_flags = proto_perl->Iexit_flags;
11574 /* magical thingies */
11575 /* XXX time(&PL_basetime) when asked for? */
11576 PL_basetime = proto_perl->Ibasetime;
11577 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11579 PL_maxsysfd = proto_perl->Imaxsysfd;
11580 PL_statusvalue = proto_perl->Istatusvalue;
11582 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11584 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11586 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11588 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11589 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11590 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11593 /* RE engine related */
11594 Zero(&PL_reg_state, 1, struct re_save_state);
11595 PL_reginterp_cnt = 0;
11596 PL_regmatch_slab = NULL;
11598 /* Clone the regex array */
11599 /* ORANGE FIXME for plugins, probably in the SV dup code.
11600 newSViv(PTR2IV(CALLREGDUPE(
11601 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11603 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11604 PL_regex_pad = AvARRAY(PL_regex_padav);
11606 /* shortcuts to various I/O objects */
11607 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11608 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11609 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11610 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11611 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11612 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11614 /* shortcuts to regexp stuff */
11615 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11617 /* shortcuts to misc objects */
11618 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11620 /* shortcuts to debugging objects */
11621 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11622 PL_DBline = gv_dup(proto_perl->IDBline, param);
11623 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11624 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11625 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11626 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11627 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11629 /* symbol tables */
11630 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11631 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11632 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11633 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11634 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11636 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11637 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11638 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11639 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11640 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11641 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11642 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11643 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11645 PL_sub_generation = proto_perl->Isub_generation;
11646 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11648 /* funky return mechanisms */
11649 PL_forkprocess = proto_perl->Iforkprocess;
11651 /* subprocess state */
11652 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11654 /* internal state */
11655 PL_maxo = proto_perl->Imaxo;
11656 if (proto_perl->Iop_mask)
11657 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11660 /* PL_asserting = proto_perl->Iasserting; */
11662 /* current interpreter roots */
11663 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11665 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11667 PL_main_start = proto_perl->Imain_start;
11668 PL_eval_root = proto_perl->Ieval_root;
11669 PL_eval_start = proto_perl->Ieval_start;
11671 /* runtime control stuff */
11672 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11674 PL_filemode = proto_perl->Ifilemode;
11675 PL_lastfd = proto_perl->Ilastfd;
11676 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11679 PL_gensym = proto_perl->Igensym;
11680 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11681 PL_laststatval = proto_perl->Ilaststatval;
11682 PL_laststype = proto_perl->Ilaststype;
11685 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11687 /* interpreter atexit processing */
11688 PL_exitlistlen = proto_perl->Iexitlistlen;
11689 if (PL_exitlistlen) {
11690 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11691 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11694 PL_exitlist = (PerlExitListEntry*)NULL;
11696 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11697 if (PL_my_cxt_size) {
11698 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11699 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11700 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11701 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11702 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11706 PL_my_cxt_list = (void**)NULL;
11707 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11708 PL_my_cxt_keys = (const char**)NULL;
11711 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11712 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11713 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11715 PL_profiledata = NULL;
11717 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11719 PAD_CLONE_VARS(proto_perl, param);
11721 #ifdef HAVE_INTERP_INTERN
11722 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11725 /* more statics moved here */
11726 PL_generation = proto_perl->Igeneration;
11727 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11729 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11730 PL_in_clean_all = proto_perl->Iin_clean_all;
11732 PL_uid = proto_perl->Iuid;
11733 PL_euid = proto_perl->Ieuid;
11734 PL_gid = proto_perl->Igid;
11735 PL_egid = proto_perl->Iegid;
11736 PL_nomemok = proto_perl->Inomemok;
11737 PL_an = proto_perl->Ian;
11738 PL_evalseq = proto_perl->Ievalseq;
11739 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11740 PL_origalen = proto_perl->Iorigalen;
11741 #ifdef PERL_USES_PL_PIDSTATUS
11742 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11744 PL_osname = SAVEPV(proto_perl->Iosname);
11745 PL_sighandlerp = proto_perl->Isighandlerp;
11747 PL_runops = proto_perl->Irunops;
11749 PL_parser = parser_dup(proto_perl->Iparser, param);
11751 PL_subline = proto_perl->Isubline;
11752 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11755 PL_cryptseen = proto_perl->Icryptseen;
11758 PL_hints = proto_perl->Ihints;
11760 PL_amagic_generation = proto_perl->Iamagic_generation;
11762 #ifdef USE_LOCALE_COLLATE
11763 PL_collation_ix = proto_perl->Icollation_ix;
11764 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11765 PL_collation_standard = proto_perl->Icollation_standard;
11766 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11767 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11768 #endif /* USE_LOCALE_COLLATE */
11770 #ifdef USE_LOCALE_NUMERIC
11771 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11772 PL_numeric_standard = proto_perl->Inumeric_standard;
11773 PL_numeric_local = proto_perl->Inumeric_local;
11774 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11775 #endif /* !USE_LOCALE_NUMERIC */
11777 /* utf8 character classes */
11778 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11779 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11780 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11781 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11782 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11783 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11784 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11785 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11786 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11787 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11788 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11789 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11790 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11791 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11792 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11793 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11794 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11795 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11796 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11797 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11799 /* Did the locale setup indicate UTF-8? */
11800 PL_utf8locale = proto_perl->Iutf8locale;
11801 /* Unicode features (see perlrun/-C) */
11802 PL_unicode = proto_perl->Iunicode;
11804 /* Pre-5.8 signals control */
11805 PL_signals = proto_perl->Isignals;
11807 /* times() ticks per second */
11808 PL_clocktick = proto_perl->Iclocktick;
11810 /* Recursion stopper for PerlIO_find_layer */
11811 PL_in_load_module = proto_perl->Iin_load_module;
11813 /* sort() routine */
11814 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11816 /* Not really needed/useful since the reenrant_retint is "volatile",
11817 * but do it for consistency's sake. */
11818 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11820 /* Hooks to shared SVs and locks. */
11821 PL_sharehook = proto_perl->Isharehook;
11822 PL_lockhook = proto_perl->Ilockhook;
11823 PL_unlockhook = proto_perl->Iunlockhook;
11824 PL_threadhook = proto_perl->Ithreadhook;
11825 PL_destroyhook = proto_perl->Idestroyhook;
11827 #ifdef THREADS_HAVE_PIDS
11828 PL_ppid = proto_perl->Ippid;
11832 PL_last_swash_hv = NULL; /* reinits on demand */
11833 PL_last_swash_klen = 0;
11834 PL_last_swash_key[0]= '\0';
11835 PL_last_swash_tmps = (U8*)NULL;
11836 PL_last_swash_slen = 0;
11838 PL_glob_index = proto_perl->Iglob_index;
11839 PL_srand_called = proto_perl->Isrand_called;
11840 PL_bitcount = NULL; /* reinits on demand */
11842 if (proto_perl->Ipsig_pend) {
11843 Newxz(PL_psig_pend, SIG_SIZE, int);
11846 PL_psig_pend = (int*)NULL;
11849 if (proto_perl->Ipsig_ptr) {
11850 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11851 Newxz(PL_psig_name, SIG_SIZE, SV*);
11852 for (i = 1; i < SIG_SIZE; i++) {
11853 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11854 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11858 PL_psig_ptr = (SV**)NULL;
11859 PL_psig_name = (SV**)NULL;
11862 /* intrpvar.h stuff */
11864 if (flags & CLONEf_COPY_STACKS) {
11865 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11866 PL_tmps_ix = proto_perl->Itmps_ix;
11867 PL_tmps_max = proto_perl->Itmps_max;
11868 PL_tmps_floor = proto_perl->Itmps_floor;
11869 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11871 while (i <= PL_tmps_ix) {
11872 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11876 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11877 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11878 Newxz(PL_markstack, i, I32);
11879 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11880 - proto_perl->Imarkstack);
11881 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11882 - proto_perl->Imarkstack);
11883 Copy(proto_perl->Imarkstack, PL_markstack,
11884 PL_markstack_ptr - PL_markstack + 1, I32);
11886 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11887 * NOTE: unlike the others! */
11888 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11889 PL_scopestack_max = proto_perl->Iscopestack_max;
11890 Newxz(PL_scopestack, PL_scopestack_max, I32);
11891 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11893 /* NOTE: si_dup() looks at PL_markstack */
11894 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11896 /* PL_curstack = PL_curstackinfo->si_stack; */
11897 PL_curstack = av_dup(proto_perl->Icurstack, param);
11898 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11900 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11901 PL_stack_base = AvARRAY(PL_curstack);
11902 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11903 - proto_perl->Istack_base);
11904 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11906 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11907 * NOTE: unlike the others! */
11908 PL_savestack_ix = proto_perl->Isavestack_ix;
11909 PL_savestack_max = proto_perl->Isavestack_max;
11910 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11911 PL_savestack = ss_dup(proto_perl, param);
11915 ENTER; /* perl_destruct() wants to LEAVE; */
11917 /* although we're not duplicating the tmps stack, we should still
11918 * add entries for any SVs on the tmps stack that got cloned by a
11919 * non-refcount means (eg a temp in @_); otherwise they will be
11922 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11923 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11924 proto_perl->Itmps_stack[i]);
11925 if (nsv && !SvREFCNT(nsv)) {
11927 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11932 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11933 PL_top_env = &PL_start_env;
11935 PL_op = proto_perl->Iop;
11938 PL_Xpv = (XPV*)NULL;
11939 my_perl->Ina = proto_perl->Ina;
11941 PL_statbuf = proto_perl->Istatbuf;
11942 PL_statcache = proto_perl->Istatcache;
11943 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11944 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11946 PL_timesbuf = proto_perl->Itimesbuf;
11949 PL_tainted = proto_perl->Itainted;
11950 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11951 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11952 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11953 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11954 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11955 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11956 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11957 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11958 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11960 PL_restartop = proto_perl->Irestartop;
11961 PL_in_eval = proto_perl->Iin_eval;
11962 PL_delaymagic = proto_perl->Idelaymagic;
11963 PL_dirty = proto_perl->Idirty;
11964 PL_localizing = proto_perl->Ilocalizing;
11966 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11967 PL_hv_fetch_ent_mh = NULL;
11968 PL_modcount = proto_perl->Imodcount;
11969 PL_lastgotoprobe = NULL;
11970 PL_dumpindent = proto_perl->Idumpindent;
11972 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11973 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11974 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11975 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11976 PL_efloatbuf = NULL; /* reinits on demand */
11977 PL_efloatsize = 0; /* reinits on demand */
11981 PL_screamfirst = NULL;
11982 PL_screamnext = NULL;
11983 PL_maxscream = -1; /* reinits on demand */
11984 PL_lastscream = NULL;
11987 PL_regdummy = proto_perl->Iregdummy;
11988 PL_colorset = 0; /* reinits PL_colors[] */
11989 /*PL_colors[6] = {0,0,0,0,0,0};*/
11993 /* Pluggable optimizer */
11994 PL_peepp = proto_perl->Ipeepp;
11996 PL_stashcache = newHV();
11998 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11999 proto_perl->Iwatchaddr);
12000 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12001 if (PL_debug && PL_watchaddr) {
12002 PerlIO_printf(Perl_debug_log,
12003 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12004 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12005 PTR2UV(PL_watchok));
12008 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12009 ptr_table_free(PL_ptr_table);
12010 PL_ptr_table = NULL;
12013 /* Call the ->CLONE method, if it exists, for each of the stashes
12014 identified by sv_dup() above.
12016 while(av_len(param->stashes) != -1) {
12017 HV* const stash = (HV*) av_shift(param->stashes);
12018 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12019 if (cloner && GvCV(cloner)) {
12024 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12026 call_sv((SV*)GvCV(cloner), G_DISCARD);
12032 SvREFCNT_dec(param->stashes);
12034 /* orphaned? eg threads->new inside BEGIN or use */
12035 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12036 SvREFCNT_inc_simple_void(PL_compcv);
12037 SAVEFREESV(PL_compcv);
12043 #endif /* USE_ITHREADS */
12046 =head1 Unicode Support
12048 =for apidoc sv_recode_to_utf8
12050 The encoding is assumed to be an Encode object, on entry the PV
12051 of the sv is assumed to be octets in that encoding, and the sv
12052 will be converted into Unicode (and UTF-8).
12054 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12055 is not a reference, nothing is done to the sv. If the encoding is not
12056 an C<Encode::XS> Encoding object, bad things will happen.
12057 (See F<lib/encoding.pm> and L<Encode>).
12059 The PV of the sv is returned.
12064 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12068 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12070 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12084 Passing sv_yes is wrong - it needs to be or'ed set of constants
12085 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12086 remove converted chars from source.
12088 Both will default the value - let them.
12090 XPUSHs(&PL_sv_yes);
12093 call_method("decode", G_SCALAR);
12097 s = SvPV_const(uni, len);
12098 if (s != SvPVX_const(sv)) {
12099 SvGROW(sv, len + 1);
12100 Move(s, SvPVX(sv), len + 1, char);
12101 SvCUR_set(sv, len);
12108 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12112 =for apidoc sv_cat_decode
12114 The encoding is assumed to be an Encode object, the PV of the ssv is
12115 assumed to be octets in that encoding and decoding the input starts
12116 from the position which (PV + *offset) pointed to. The dsv will be
12117 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12118 when the string tstr appears in decoding output or the input ends on
12119 the PV of the ssv. The value which the offset points will be modified
12120 to the last input position on the ssv.
12122 Returns TRUE if the terminator was found, else returns FALSE.
12127 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12128 SV *ssv, int *offset, char *tstr, int tlen)
12133 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12135 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12146 offsv = newSViv(*offset);
12148 mXPUSHp(tstr, tlen);
12150 call_method("cat_decode", G_SCALAR);
12152 ret = SvTRUE(TOPs);
12153 *offset = SvIV(offsv);
12159 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12164 /* ---------------------------------------------------------------------
12166 * support functions for report_uninit()
12169 /* the maxiumum size of array or hash where we will scan looking
12170 * for the undefined element that triggered the warning */
12172 #define FUV_MAX_SEARCH_SIZE 1000
12174 /* Look for an entry in the hash whose value has the same SV as val;
12175 * If so, return a mortal copy of the key. */
12178 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12181 register HE **array;
12184 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12186 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12187 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12190 array = HvARRAY(hv);
12192 for (i=HvMAX(hv); i>0; i--) {
12193 register HE *entry;
12194 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12195 if (HeVAL(entry) != val)
12197 if ( HeVAL(entry) == &PL_sv_undef ||
12198 HeVAL(entry) == &PL_sv_placeholder)
12202 if (HeKLEN(entry) == HEf_SVKEY)
12203 return sv_mortalcopy(HeKEY_sv(entry));
12204 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12210 /* Look for an entry in the array whose value has the same SV as val;
12211 * If so, return the index, otherwise return -1. */
12214 S_find_array_subscript(pTHX_ AV *av, SV* val)
12218 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12220 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12221 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12224 if (val != &PL_sv_undef) {
12225 SV ** const svp = AvARRAY(av);
12228 for (i=AvFILLp(av); i>=0; i--)
12235 /* S_varname(): return the name of a variable, optionally with a subscript.
12236 * If gv is non-zero, use the name of that global, along with gvtype (one
12237 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12238 * targ. Depending on the value of the subscript_type flag, return:
12241 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12242 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12243 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12244 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12247 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12248 SV* keyname, I32 aindex, int subscript_type)
12251 SV * const name = sv_newmortal();
12254 buffer[0] = gvtype;
12257 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12259 gv_fullname4(name, gv, buffer, 0);
12261 if ((unsigned int)SvPVX(name)[1] <= 26) {
12263 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12265 /* Swap the 1 unprintable control character for the 2 byte pretty
12266 version - ie substr($name, 1, 1) = $buffer; */
12267 sv_insert(name, 1, 1, buffer, 2);
12271 CV * const cv = find_runcv(NULL);
12275 if (!cv || !CvPADLIST(cv))
12277 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12278 sv = *av_fetch(av, targ, FALSE);
12279 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12282 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12283 SV * const sv = newSV(0);
12284 *SvPVX(name) = '$';
12285 Perl_sv_catpvf(aTHX_ name, "{%s}",
12286 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12289 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12290 *SvPVX(name) = '$';
12291 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12293 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
12294 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
12301 =for apidoc find_uninit_var
12303 Find the name of the undefined variable (if any) that caused the operator o
12304 to issue a "Use of uninitialized value" warning.
12305 If match is true, only return a name if it's value matches uninit_sv.
12306 So roughly speaking, if a unary operator (such as OP_COS) generates a
12307 warning, then following the direct child of the op may yield an
12308 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12309 other hand, with OP_ADD there are two branches to follow, so we only print
12310 the variable name if we get an exact match.
12312 The name is returned as a mortal SV.
12314 Assumes that PL_op is the op that originally triggered the error, and that
12315 PL_comppad/PL_curpad points to the currently executing pad.
12321 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12329 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12330 uninit_sv == &PL_sv_placeholder)))
12333 switch (obase->op_type) {
12340 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12341 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12344 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12346 if (pad) { /* @lex, %lex */
12347 sv = PAD_SVl(obase->op_targ);
12351 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12352 /* @global, %global */
12353 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12356 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12358 else /* @{expr}, %{expr} */
12359 return find_uninit_var(cUNOPx(obase)->op_first,
12363 /* attempt to find a match within the aggregate */
12365 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12367 subscript_type = FUV_SUBSCRIPT_HASH;
12370 index = find_array_subscript((AV*)sv, uninit_sv);
12372 subscript_type = FUV_SUBSCRIPT_ARRAY;
12375 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12378 return varname(gv, hash ? '%' : '@', obase->op_targ,
12379 keysv, index, subscript_type);
12383 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12385 return varname(NULL, '$', obase->op_targ,
12386 NULL, 0, FUV_SUBSCRIPT_NONE);
12389 gv = cGVOPx_gv(obase);
12390 if (!gv || (match && GvSV(gv) != uninit_sv))
12392 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12395 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12398 av = (AV*)PAD_SV(obase->op_targ);
12399 if (!av || SvRMAGICAL(av))
12401 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12402 if (!svp || *svp != uninit_sv)
12405 return varname(NULL, '$', obase->op_targ,
12406 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12409 gv = cGVOPx_gv(obase);
12415 if (!av || SvRMAGICAL(av))
12417 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12418 if (!svp || *svp != uninit_sv)
12421 return varname(gv, '$', 0,
12422 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12427 o = cUNOPx(obase)->op_first;
12428 if (!o || o->op_type != OP_NULL ||
12429 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12431 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12435 if (PL_op == obase)
12436 /* $a[uninit_expr] or $h{uninit_expr} */
12437 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12440 o = cBINOPx(obase)->op_first;
12441 kid = cBINOPx(obase)->op_last;
12443 /* get the av or hv, and optionally the gv */
12445 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12446 sv = PAD_SV(o->op_targ);
12448 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12449 && cUNOPo->op_first->op_type == OP_GV)
12451 gv = cGVOPx_gv(cUNOPo->op_first);
12454 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12459 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12460 /* index is constant */
12464 if (obase->op_type == OP_HELEM) {
12465 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12466 if (!he || HeVAL(he) != uninit_sv)
12470 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12471 if (!svp || *svp != uninit_sv)
12475 if (obase->op_type == OP_HELEM)
12476 return varname(gv, '%', o->op_targ,
12477 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12479 return varname(gv, '@', o->op_targ, NULL,
12480 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12483 /* index is an expression;
12484 * attempt to find a match within the aggregate */
12485 if (obase->op_type == OP_HELEM) {
12486 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12488 return varname(gv, '%', o->op_targ,
12489 keysv, 0, FUV_SUBSCRIPT_HASH);
12492 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12494 return varname(gv, '@', o->op_targ,
12495 NULL, index, FUV_SUBSCRIPT_ARRAY);
12500 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12502 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12507 /* only examine RHS */
12508 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12511 o = cUNOPx(obase)->op_first;
12512 if (o->op_type == OP_PUSHMARK)
12515 if (!o->op_sibling) {
12516 /* one-arg version of open is highly magical */
12518 if (o->op_type == OP_GV) { /* open FOO; */
12520 if (match && GvSV(gv) != uninit_sv)
12522 return varname(gv, '$', 0,
12523 NULL, 0, FUV_SUBSCRIPT_NONE);
12525 /* other possibilities not handled are:
12526 * open $x; or open my $x; should return '${*$x}'
12527 * open expr; should return '$'.expr ideally
12533 /* ops where $_ may be an implicit arg */
12537 if ( !(obase->op_flags & OPf_STACKED)) {
12538 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12539 ? PAD_SVl(obase->op_targ)
12542 sv = sv_newmortal();
12543 sv_setpvn(sv, "$_", 2);
12552 /* skip filehandle as it can't produce 'undef' warning */
12553 o = cUNOPx(obase)->op_first;
12554 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12555 o = o->op_sibling->op_sibling;
12559 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12562 match = 1; /* XS or custom code could trigger random warnings */
12567 /* XXX tmp hack: these two may call an XS sub, and currently
12568 XS subs don't have a SUB entry on the context stack, so CV and
12569 pad determination goes wrong, and BAD things happen. So, just
12570 don't try to determine the value under those circumstances.
12571 Need a better fix at dome point. DAPM 11/2007 */
12575 /* def-ness of rval pos() is independent of the def-ness of its arg */
12576 if ( !(obase->op_flags & OPf_MOD))
12581 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12582 return newSVpvs_flags("${$/}", SVs_TEMP);
12587 if (!(obase->op_flags & OPf_KIDS))
12589 o = cUNOPx(obase)->op_first;
12595 /* if all except one arg are constant, or have no side-effects,
12596 * or are optimized away, then it's unambiguous */
12598 for (kid=o; kid; kid = kid->op_sibling) {
12600 const OPCODE type = kid->op_type;
12601 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12602 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12603 || (type == OP_PUSHMARK)
12607 if (o2) { /* more than one found */
12614 return find_uninit_var(o2, uninit_sv, match);
12616 /* scan all args */
12618 sv = find_uninit_var(o, uninit_sv, 1);
12630 =for apidoc report_uninit
12632 Print appropriate "Use of uninitialized variable" warning
12638 Perl_report_uninit(pTHX_ SV* uninit_sv)
12642 SV* varname = NULL;
12644 varname = find_uninit_var(PL_op, uninit_sv,0);
12646 sv_insert(varname, 0, 0, " ", 1);
12648 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12649 varname ? SvPV_nolen_const(varname) : "",
12650 " in ", OP_DESC(PL_op));
12653 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12659 * c-indentation-style: bsd
12660 * c-basic-offset: 4
12661 * indent-tabs-mode: t
12664 * ex: set ts=8 sts=4 sw=4 noet: