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 *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? */
1482 newlen = PERL_STRLEN_ROUNDUP(newlen);
1483 if (SvLEN(sv) && s) {
1485 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1491 s = (char*)saferealloc(s, newlen);
1494 s = (char*)safemalloc(newlen);
1495 if (SvPVX_const(sv) && SvCUR(sv)) {
1496 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1500 SvLEN_set(sv, newlen);
1506 =for apidoc sv_setiv
1508 Copies an integer into the given SV, upgrading first if necessary.
1509 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1515 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1519 PERL_ARGS_ASSERT_SV_SETIV;
1521 SV_CHECK_THINKFIRST_COW_DROP(sv);
1522 switch (SvTYPE(sv)) {
1525 sv_upgrade(sv, SVt_IV);
1528 sv_upgrade(sv, SVt_PVIV);
1537 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1541 (void)SvIOK_only(sv); /* validate number */
1547 =for apidoc sv_setiv_mg
1549 Like C<sv_setiv>, but also handles 'set' magic.
1555 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1557 PERL_ARGS_ASSERT_SV_SETIV_MG;
1564 =for apidoc sv_setuv
1566 Copies an unsigned integer into the given SV, upgrading first if necessary.
1567 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1573 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1575 PERL_ARGS_ASSERT_SV_SETUV;
1577 /* With these two if statements:
1578 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1581 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1583 If you wish to remove them, please benchmark to see what the effect is
1585 if (u <= (UV)IV_MAX) {
1586 sv_setiv(sv, (IV)u);
1595 =for apidoc sv_setuv_mg
1597 Like C<sv_setuv>, but also handles 'set' magic.
1603 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1605 PERL_ARGS_ASSERT_SV_SETUV_MG;
1612 =for apidoc sv_setnv
1614 Copies a double into the given SV, upgrading first if necessary.
1615 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1621 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1625 PERL_ARGS_ASSERT_SV_SETNV;
1627 SV_CHECK_THINKFIRST_COW_DROP(sv);
1628 switch (SvTYPE(sv)) {
1631 sv_upgrade(sv, SVt_NV);
1635 sv_upgrade(sv, SVt_PVNV);
1644 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1649 (void)SvNOK_only(sv); /* validate number */
1654 =for apidoc sv_setnv_mg
1656 Like C<sv_setnv>, but also handles 'set' magic.
1662 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1664 PERL_ARGS_ASSERT_SV_SETNV_MG;
1670 /* Print an "isn't numeric" warning, using a cleaned-up,
1671 * printable version of the offending string
1675 S_not_a_number(pTHX_ SV *const sv)
1682 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1685 dsv = newSVpvs_flags("", SVs_TEMP);
1686 pv = sv_uni_display(dsv, sv, 10, 0);
1689 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1690 /* each *s can expand to 4 chars + "...\0",
1691 i.e. need room for 8 chars */
1693 const char *s = SvPVX_const(sv);
1694 const char * const end = s + SvCUR(sv);
1695 for ( ; s < end && d < limit; s++ ) {
1697 if (ch & 128 && !isPRINT_LC(ch)) {
1706 else if (ch == '\r') {
1710 else if (ch == '\f') {
1714 else if (ch == '\\') {
1718 else if (ch == '\0') {
1722 else if (isPRINT_LC(ch))
1739 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1740 "Argument \"%s\" isn't numeric in %s", pv,
1743 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1744 "Argument \"%s\" isn't numeric", pv);
1748 =for apidoc looks_like_number
1750 Test if the content of an SV looks like a number (or is a number).
1751 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1752 non-numeric warning), even if your atof() doesn't grok them.
1758 Perl_looks_like_number(pTHX_ SV *const sv)
1760 register const char *sbegin;
1763 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1766 sbegin = SvPVX_const(sv);
1769 else if (SvPOKp(sv))
1770 sbegin = SvPV_const(sv, len);
1772 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1773 return grok_number(sbegin, len, NULL);
1777 S_glob_2number(pTHX_ GV * const gv)
1779 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1780 SV *const buffer = sv_newmortal();
1782 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1784 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1787 gv_efullname3(buffer, gv, "*");
1788 SvFLAGS(gv) |= wasfake;
1790 /* We know that all GVs stringify to something that is not-a-number,
1791 so no need to test that. */
1792 if (ckWARN(WARN_NUMERIC))
1793 not_a_number(buffer);
1794 /* We just want something true to return, so that S_sv_2iuv_common
1795 can tail call us and return true. */
1800 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1802 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1803 SV *const buffer = sv_newmortal();
1805 PERL_ARGS_ASSERT_GLOB_2PV;
1807 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1810 gv_efullname3(buffer, gv, "*");
1811 SvFLAGS(gv) |= wasfake;
1813 assert(SvPOK(buffer));
1815 *len = SvCUR(buffer);
1817 return SvPVX(buffer);
1820 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1821 until proven guilty, assume that things are not that bad... */
1826 As 64 bit platforms often have an NV that doesn't preserve all bits of
1827 an IV (an assumption perl has been based on to date) it becomes necessary
1828 to remove the assumption that the NV always carries enough precision to
1829 recreate the IV whenever needed, and that the NV is the canonical form.
1830 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1831 precision as a side effect of conversion (which would lead to insanity
1832 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1833 1) to distinguish between IV/UV/NV slots that have cached a valid
1834 conversion where precision was lost and IV/UV/NV slots that have a
1835 valid conversion which has lost no precision
1836 2) to ensure that if a numeric conversion to one form is requested that
1837 would lose precision, the precise conversion (or differently
1838 imprecise conversion) is also performed and cached, to prevent
1839 requests for different numeric formats on the same SV causing
1840 lossy conversion chains. (lossless conversion chains are perfectly
1845 SvIOKp is true if the IV slot contains a valid value
1846 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1847 SvNOKp is true if the NV slot contains a valid value
1848 SvNOK is true only if the NV value is accurate
1851 while converting from PV to NV, check to see if converting that NV to an
1852 IV(or UV) would lose accuracy over a direct conversion from PV to
1853 IV(or UV). If it would, cache both conversions, return NV, but mark
1854 SV as IOK NOKp (ie not NOK).
1856 While converting from PV to IV, check to see if converting that IV to an
1857 NV would lose accuracy over a direct conversion from PV to NV. If it
1858 would, cache both conversions, flag similarly.
1860 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1861 correctly because if IV & NV were set NV *always* overruled.
1862 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1863 changes - now IV and NV together means that the two are interchangeable:
1864 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1866 The benefit of this is that operations such as pp_add know that if
1867 SvIOK is true for both left and right operands, then integer addition
1868 can be used instead of floating point (for cases where the result won't
1869 overflow). Before, floating point was always used, which could lead to
1870 loss of precision compared with integer addition.
1872 * making IV and NV equal status should make maths accurate on 64 bit
1874 * may speed up maths somewhat if pp_add and friends start to use
1875 integers when possible instead of fp. (Hopefully the overhead in
1876 looking for SvIOK and checking for overflow will not outweigh the
1877 fp to integer speedup)
1878 * will slow down integer operations (callers of SvIV) on "inaccurate"
1879 values, as the change from SvIOK to SvIOKp will cause a call into
1880 sv_2iv each time rather than a macro access direct to the IV slot
1881 * should speed up number->string conversion on integers as IV is
1882 favoured when IV and NV are equally accurate
1884 ####################################################################
1885 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1886 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1887 On the other hand, SvUOK is true iff UV.
1888 ####################################################################
1890 Your mileage will vary depending your CPU's relative fp to integer
1894 #ifndef NV_PRESERVES_UV
1895 # define IS_NUMBER_UNDERFLOW_IV 1
1896 # define IS_NUMBER_UNDERFLOW_UV 2
1897 # define IS_NUMBER_IV_AND_UV 2
1898 # define IS_NUMBER_OVERFLOW_IV 4
1899 # define IS_NUMBER_OVERFLOW_UV 5
1901 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1903 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1905 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1913 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1915 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));
1916 if (SvNVX(sv) < (NV)IV_MIN) {
1917 (void)SvIOKp_on(sv);
1919 SvIV_set(sv, IV_MIN);
1920 return IS_NUMBER_UNDERFLOW_IV;
1922 if (SvNVX(sv) > (NV)UV_MAX) {
1923 (void)SvIOKp_on(sv);
1926 SvUV_set(sv, UV_MAX);
1927 return IS_NUMBER_OVERFLOW_UV;
1929 (void)SvIOKp_on(sv);
1931 /* Can't use strtol etc to convert this string. (See truth table in
1933 if (SvNVX(sv) <= (UV)IV_MAX) {
1934 SvIV_set(sv, I_V(SvNVX(sv)));
1935 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1936 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1938 /* Integer is imprecise. NOK, IOKp */
1940 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1943 SvUV_set(sv, U_V(SvNVX(sv)));
1944 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1945 if (SvUVX(sv) == UV_MAX) {
1946 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1947 possibly be preserved by NV. Hence, it must be overflow.
1949 return IS_NUMBER_OVERFLOW_UV;
1951 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1953 /* Integer is imprecise. NOK, IOKp */
1955 return IS_NUMBER_OVERFLOW_IV;
1957 #endif /* !NV_PRESERVES_UV*/
1960 S_sv_2iuv_common(pTHX_ SV *const sv)
1964 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1967 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1968 * without also getting a cached IV/UV from it at the same time
1969 * (ie PV->NV conversion should detect loss of accuracy and cache
1970 * IV or UV at same time to avoid this. */
1971 /* IV-over-UV optimisation - choose to cache IV if possible */
1973 if (SvTYPE(sv) == SVt_NV)
1974 sv_upgrade(sv, SVt_PVNV);
1976 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1977 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1978 certainly cast into the IV range at IV_MAX, whereas the correct
1979 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1981 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1982 if (Perl_isnan(SvNVX(sv))) {
1988 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1989 SvIV_set(sv, I_V(SvNVX(sv)));
1990 if (SvNVX(sv) == (NV) SvIVX(sv)
1991 #ifndef NV_PRESERVES_UV
1992 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1993 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1994 /* Don't flag it as "accurately an integer" if the number
1995 came from a (by definition imprecise) NV operation, and
1996 we're outside the range of NV integer precision */
2000 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2002 /* scalar has trailing garbage, eg "42a" */
2004 DEBUG_c(PerlIO_printf(Perl_debug_log,
2005 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2011 /* IV not precise. No need to convert from PV, as NV
2012 conversion would already have cached IV if it detected
2013 that PV->IV would be better than PV->NV->IV
2014 flags already correct - don't set public IOK. */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2021 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2022 but the cast (NV)IV_MIN rounds to a the value less (more
2023 negative) than IV_MIN which happens to be equal to SvNVX ??
2024 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2025 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2026 (NV)UVX == NVX are both true, but the values differ. :-(
2027 Hopefully for 2s complement IV_MIN is something like
2028 0x8000000000000000 which will be exact. NWC */
2031 SvUV_set(sv, U_V(SvNVX(sv)));
2033 (SvNVX(sv) == (NV) SvUVX(sv))
2034 #ifndef NV_PRESERVES_UV
2035 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2036 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2037 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2038 /* Don't flag it as "accurately an integer" if the number
2039 came from a (by definition imprecise) NV operation, and
2040 we're outside the range of NV integer precision */
2046 DEBUG_c(PerlIO_printf(Perl_debug_log,
2047 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2053 else if (SvPOKp(sv) && SvLEN(sv)) {
2055 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2056 /* We want to avoid a possible problem when we cache an IV/ a UV which
2057 may be later translated to an NV, and the resulting NV is not
2058 the same as the direct translation of the initial string
2059 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2060 be careful to ensure that the value with the .456 is around if the
2061 NV value is requested in the future).
2063 This means that if we cache such an IV/a UV, we need to cache the
2064 NV as well. Moreover, we trade speed for space, and do not
2065 cache the NV if we are sure it's not needed.
2068 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2069 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2070 == IS_NUMBER_IN_UV) {
2071 /* It's definitely an integer, only upgrade to PVIV */
2072 if (SvTYPE(sv) < SVt_PVIV)
2073 sv_upgrade(sv, SVt_PVIV);
2075 } else if (SvTYPE(sv) < SVt_PVNV)
2076 sv_upgrade(sv, SVt_PVNV);
2078 /* If NVs preserve UVs then we only use the UV value if we know that
2079 we aren't going to call atof() below. If NVs don't preserve UVs
2080 then the value returned may have more precision than atof() will
2081 return, even though value isn't perfectly accurate. */
2082 if ((numtype & (IS_NUMBER_IN_UV
2083 #ifdef NV_PRESERVES_UV
2086 )) == IS_NUMBER_IN_UV) {
2087 /* This won't turn off the public IOK flag if it was set above */
2088 (void)SvIOKp_on(sv);
2090 if (!(numtype & IS_NUMBER_NEG)) {
2092 if (value <= (UV)IV_MAX) {
2093 SvIV_set(sv, (IV)value);
2095 /* it didn't overflow, and it was positive. */
2096 SvUV_set(sv, value);
2100 /* 2s complement assumption */
2101 if (value <= (UV)IV_MIN) {
2102 SvIV_set(sv, -(IV)value);
2104 /* Too negative for an IV. This is a double upgrade, but
2105 I'm assuming it will be rare. */
2106 if (SvTYPE(sv) < SVt_PVNV)
2107 sv_upgrade(sv, SVt_PVNV);
2111 SvNV_set(sv, -(NV)value);
2112 SvIV_set(sv, IV_MIN);
2116 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2117 will be in the previous block to set the IV slot, and the next
2118 block to set the NV slot. So no else here. */
2120 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2121 != IS_NUMBER_IN_UV) {
2122 /* It wasn't an (integer that doesn't overflow the UV). */
2123 SvNV_set(sv, Atof(SvPVX_const(sv)));
2125 if (! numtype && ckWARN(WARN_NUMERIC))
2128 #if defined(USE_LONG_DOUBLE)
2129 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2130 PTR2UV(sv), SvNVX(sv)));
2132 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2133 PTR2UV(sv), SvNVX(sv)));
2136 #ifdef NV_PRESERVES_UV
2137 (void)SvIOKp_on(sv);
2139 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2140 SvIV_set(sv, I_V(SvNVX(sv)));
2141 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2144 NOOP; /* Integer is imprecise. NOK, IOKp */
2146 /* UV will not work better than IV */
2148 if (SvNVX(sv) > (NV)UV_MAX) {
2150 /* Integer is inaccurate. NOK, IOKp, is UV */
2151 SvUV_set(sv, UV_MAX);
2153 SvUV_set(sv, U_V(SvNVX(sv)));
2154 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2155 NV preservse UV so can do correct comparison. */
2156 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2159 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2164 #else /* NV_PRESERVES_UV */
2165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2166 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2167 /* The IV/UV slot will have been set from value returned by
2168 grok_number above. The NV slot has just been set using
2171 assert (SvIOKp(sv));
2173 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2174 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2175 /* Small enough to preserve all bits. */
2176 (void)SvIOKp_on(sv);
2178 SvIV_set(sv, I_V(SvNVX(sv)));
2179 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2181 /* Assumption: first non-preserved integer is < IV_MAX,
2182 this NV is in the preserved range, therefore: */
2183 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2185 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);
2189 0 0 already failed to read UV.
2190 0 1 already failed to read UV.
2191 1 0 you won't get here in this case. IV/UV
2192 slot set, public IOK, Atof() unneeded.
2193 1 1 already read UV.
2194 so there's no point in sv_2iuv_non_preserve() attempting
2195 to use atol, strtol, strtoul etc. */
2197 sv_2iuv_non_preserve (sv, numtype);
2199 sv_2iuv_non_preserve (sv);
2203 #endif /* NV_PRESERVES_UV */
2204 /* It might be more code efficient to go through the entire logic above
2205 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2206 gets complex and potentially buggy, so more programmer efficient
2207 to do it this way, by turning off the public flags: */
2209 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2213 if (isGV_with_GP(sv))
2214 return glob_2number((GV *)sv);
2216 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2217 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2220 if (SvTYPE(sv) < SVt_IV)
2221 /* Typically the caller expects that sv_any is not NULL now. */
2222 sv_upgrade(sv, SVt_IV);
2223 /* Return 0 from the caller. */
2230 =for apidoc sv_2iv_flags
2232 Return the integer value of an SV, doing any necessary string
2233 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2234 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2240 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2245 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2246 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2247 cache IVs just in case. In practice it seems that they never
2248 actually anywhere accessible by user Perl code, let alone get used
2249 in anything other than a string context. */
2250 if (flags & SV_GMAGIC)
2255 return I_V(SvNVX(sv));
2257 if (SvPOKp(sv) && SvLEN(sv)) {
2260 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2262 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2263 == IS_NUMBER_IN_UV) {
2264 /* It's definitely an integer */
2265 if (numtype & IS_NUMBER_NEG) {
2266 if (value < (UV)IV_MIN)
2269 if (value < (UV)IV_MAX)
2274 if (ckWARN(WARN_NUMERIC))
2277 return I_V(Atof(SvPVX_const(sv)));
2282 assert(SvTYPE(sv) >= SVt_PVMG);
2283 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2284 } else if (SvTHINKFIRST(sv)) {
2288 SV * const tmpstr=AMG_CALLun(sv,numer);
2289 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2290 return SvIV(tmpstr);
2293 return PTR2IV(SvRV(sv));
2296 sv_force_normal_flags(sv, 0);
2298 if (SvREADONLY(sv) && !SvOK(sv)) {
2299 if (ckWARN(WARN_UNINITIALIZED))
2305 if (S_sv_2iuv_common(aTHX_ sv))
2308 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2309 PTR2UV(sv),SvIVX(sv)));
2310 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2314 =for apidoc sv_2uv_flags
2316 Return the unsigned integer value of an SV, doing any necessary string
2317 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2318 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2324 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2329 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2330 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2331 cache IVs just in case. */
2332 if (flags & SV_GMAGIC)
2337 return U_V(SvNVX(sv));
2338 if (SvPOKp(sv) && SvLEN(sv)) {
2341 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2343 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2344 == IS_NUMBER_IN_UV) {
2345 /* It's definitely an integer */
2346 if (!(numtype & IS_NUMBER_NEG))
2350 if (ckWARN(WARN_NUMERIC))
2353 return U_V(Atof(SvPVX_const(sv)));
2358 assert(SvTYPE(sv) >= SVt_PVMG);
2359 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2360 } else if (SvTHINKFIRST(sv)) {
2364 SV *const tmpstr = AMG_CALLun(sv,numer);
2365 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2366 return SvUV(tmpstr);
2369 return PTR2UV(SvRV(sv));
2372 sv_force_normal_flags(sv, 0);
2374 if (SvREADONLY(sv) && !SvOK(sv)) {
2375 if (ckWARN(WARN_UNINITIALIZED))
2381 if (S_sv_2iuv_common(aTHX_ sv))
2385 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2386 PTR2UV(sv),SvUVX(sv)));
2387 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2393 Return the num value of an SV, doing any necessary string or integer
2394 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2401 Perl_sv_2nv(pTHX_ register SV *const sv)
2406 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2407 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2408 cache IVs just in case. */
2412 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2413 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2414 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2416 return Atof(SvPVX_const(sv));
2420 return (NV)SvUVX(sv);
2422 return (NV)SvIVX(sv);
2427 assert(SvTYPE(sv) >= SVt_PVMG);
2428 /* This falls through to the report_uninit near the end of the
2430 } else if (SvTHINKFIRST(sv)) {
2434 SV *const tmpstr = AMG_CALLun(sv,numer);
2435 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2436 return SvNV(tmpstr);
2439 return PTR2NV(SvRV(sv));
2442 sv_force_normal_flags(sv, 0);
2444 if (SvREADONLY(sv) && !SvOK(sv)) {
2445 if (ckWARN(WARN_UNINITIALIZED))
2450 if (SvTYPE(sv) < SVt_NV) {
2451 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2452 sv_upgrade(sv, SVt_NV);
2453 #ifdef USE_LONG_DOUBLE
2455 STORE_NUMERIC_LOCAL_SET_STANDARD();
2456 PerlIO_printf(Perl_debug_log,
2457 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2458 PTR2UV(sv), SvNVX(sv));
2459 RESTORE_NUMERIC_LOCAL();
2463 STORE_NUMERIC_LOCAL_SET_STANDARD();
2464 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2465 PTR2UV(sv), SvNVX(sv));
2466 RESTORE_NUMERIC_LOCAL();
2470 else if (SvTYPE(sv) < SVt_PVNV)
2471 sv_upgrade(sv, SVt_PVNV);
2476 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2477 #ifdef NV_PRESERVES_UV
2483 /* Only set the public NV OK flag if this NV preserves the IV */
2484 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2486 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2487 : (SvIVX(sv) == I_V(SvNVX(sv))))
2493 else if (SvPOKp(sv) && SvLEN(sv)) {
2495 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2496 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2498 #ifdef NV_PRESERVES_UV
2499 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2500 == IS_NUMBER_IN_UV) {
2501 /* It's definitely an integer */
2502 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2504 SvNV_set(sv, Atof(SvPVX_const(sv)));
2510 SvNV_set(sv, Atof(SvPVX_const(sv)));
2511 /* Only set the public NV OK flag if this NV preserves the value in
2512 the PV at least as well as an IV/UV would.
2513 Not sure how to do this 100% reliably. */
2514 /* if that shift count is out of range then Configure's test is
2515 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2517 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2518 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2519 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2520 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2521 /* Can't use strtol etc to convert this string, so don't try.
2522 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2525 /* value has been set. It may not be precise. */
2526 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2527 /* 2s complement assumption for (UV)IV_MIN */
2528 SvNOK_on(sv); /* Integer is too negative. */
2533 if (numtype & IS_NUMBER_NEG) {
2534 SvIV_set(sv, -(IV)value);
2535 } else if (value <= (UV)IV_MAX) {
2536 SvIV_set(sv, (IV)value);
2538 SvUV_set(sv, value);
2542 if (numtype & IS_NUMBER_NOT_INT) {
2543 /* I believe that even if the original PV had decimals,
2544 they are lost beyond the limit of the FP precision.
2545 However, neither is canonical, so both only get p
2546 flags. NWC, 2000/11/25 */
2547 /* Both already have p flags, so do nothing */
2549 const NV nv = SvNVX(sv);
2550 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2551 if (SvIVX(sv) == I_V(nv)) {
2554 /* It had no "." so it must be integer. */
2558 /* between IV_MAX and NV(UV_MAX).
2559 Could be slightly > UV_MAX */
2561 if (numtype & IS_NUMBER_NOT_INT) {
2562 /* UV and NV both imprecise. */
2564 const UV nv_as_uv = U_V(nv);
2566 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2575 /* It might be more code efficient to go through the entire logic above
2576 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2577 gets complex and potentially buggy, so more programmer efficient
2578 to do it this way, by turning off the public flags: */
2580 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2581 #endif /* NV_PRESERVES_UV */
2584 if (isGV_with_GP(sv)) {
2585 glob_2number((GV *)sv);
2589 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2591 assert (SvTYPE(sv) >= SVt_NV);
2592 /* Typically the caller expects that sv_any is not NULL now. */
2593 /* XXX Ilya implies that this is a bug in callers that assume this
2594 and ideally should be fixed. */
2597 #if defined(USE_LONG_DOUBLE)
2599 STORE_NUMERIC_LOCAL_SET_STANDARD();
2600 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2601 PTR2UV(sv), SvNVX(sv));
2602 RESTORE_NUMERIC_LOCAL();
2606 STORE_NUMERIC_LOCAL_SET_STANDARD();
2607 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2608 PTR2UV(sv), SvNVX(sv));
2609 RESTORE_NUMERIC_LOCAL();
2618 Return an SV with the numeric value of the source SV, doing any necessary
2619 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2620 access this function.
2626 Perl_sv_2num(pTHX_ register SV *const sv)
2628 PERL_ARGS_ASSERT_SV_2NUM;
2633 SV * const tmpsv = AMG_CALLun(sv,numer);
2634 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2635 return sv_2num(tmpsv);
2637 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2640 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2641 * UV as a string towards the end of buf, and return pointers to start and
2644 * We assume that buf is at least TYPE_CHARS(UV) long.
2648 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2650 char *ptr = buf + TYPE_CHARS(UV);
2651 char * const ebuf = ptr;
2654 PERL_ARGS_ASSERT_UIV_2BUF;
2666 *--ptr = '0' + (char)(uv % 10);
2675 =for apidoc sv_2pv_flags
2677 Returns a pointer to the string value of an SV, and sets *lp to its length.
2678 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2680 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2681 usually end up here too.
2687 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2697 if (SvGMAGICAL(sv)) {
2698 if (flags & SV_GMAGIC)
2703 if (flags & SV_MUTABLE_RETURN)
2704 return SvPVX_mutable(sv);
2705 if (flags & SV_CONST_RETURN)
2706 return (char *)SvPVX_const(sv);
2709 if (SvIOKp(sv) || SvNOKp(sv)) {
2710 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2715 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2716 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2718 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2725 #ifdef FIXNEGATIVEZERO
2726 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2732 SvUPGRADE(sv, SVt_PV);
2735 s = SvGROW_mutable(sv, len + 1);
2738 return (char*)memcpy(s, tbuf, len + 1);
2744 assert(SvTYPE(sv) >= SVt_PVMG);
2745 /* This falls through to the report_uninit near the end of the
2747 } else if (SvTHINKFIRST(sv)) {
2751 SV *const tmpstr = AMG_CALLun(sv,string);
2752 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2754 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2758 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2759 if (flags & SV_CONST_RETURN) {
2760 pv = (char *) SvPVX_const(tmpstr);
2762 pv = (flags & SV_MUTABLE_RETURN)
2763 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2766 *lp = SvCUR(tmpstr);
2768 pv = sv_2pv_flags(tmpstr, lp, flags);
2781 const SV *const referent = (SV*)SvRV(sv);
2785 retval = buffer = savepvn("NULLREF", len);
2786 } else if (SvTYPE(referent) == SVt_REGEXP) {
2787 const REGEXP * const re = (REGEXP *)referent;
2792 /* If the regex is UTF-8 we want the containing scalar to
2793 have an UTF-8 flag too */
2799 if ((seen_evals = RX_SEEN_EVALS(re)))
2800 PL_reginterp_cnt += seen_evals;
2803 *lp = RX_WRAPLEN(re);
2805 return RX_WRAPPED(re);
2807 const char *const typestr = sv_reftype(referent, 0);
2808 const STRLEN typelen = strlen(typestr);
2809 UV addr = PTR2UV(referent);
2810 const char *stashname = NULL;
2811 STRLEN stashnamelen = 0; /* hush, gcc */
2812 const char *buffer_end;
2814 if (SvOBJECT(referent)) {
2815 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2818 stashname = HEK_KEY(name);
2819 stashnamelen = HEK_LEN(name);
2821 if (HEK_UTF8(name)) {
2827 stashname = "__ANON__";
2830 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2831 + 2 * sizeof(UV) + 2 /* )\0 */;
2833 len = typelen + 3 /* (0x */
2834 + 2 * sizeof(UV) + 2 /* )\0 */;
2837 Newx(buffer, len, char);
2838 buffer_end = retval = buffer + len;
2840 /* Working backwards */
2844 *--retval = PL_hexdigit[addr & 15];
2845 } while (addr >>= 4);
2851 memcpy(retval, typestr, typelen);
2855 retval -= stashnamelen;
2856 memcpy(retval, stashname, stashnamelen);
2858 /* retval may not neccesarily have reached the start of the
2860 assert (retval >= buffer);
2862 len = buffer_end - retval - 1; /* -1 for that \0 */
2870 if (SvREADONLY(sv) && !SvOK(sv)) {
2873 if (flags & SV_UNDEF_RETURNS_NULL)
2875 if (ckWARN(WARN_UNINITIALIZED))
2880 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2881 /* I'm assuming that if both IV and NV are equally valid then
2882 converting the IV is going to be more efficient */
2883 const U32 isUIOK = SvIsUV(sv);
2884 char buf[TYPE_CHARS(UV)];
2888 if (SvTYPE(sv) < SVt_PVIV)
2889 sv_upgrade(sv, SVt_PVIV);
2890 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2892 /* inlined from sv_setpvn */
2893 s = SvGROW_mutable(sv, len + 1);
2894 Move(ptr, s, len, char);
2898 else if (SvNOKp(sv)) {
2899 const int olderrno = errno;
2900 if (SvTYPE(sv) < SVt_PVNV)
2901 sv_upgrade(sv, SVt_PVNV);
2902 /* The +20 is pure guesswork. Configure test needed. --jhi */
2903 s = SvGROW_mutable(sv, NV_DIG + 20);
2904 /* some Xenix systems wipe out errno here */
2906 if (SvNVX(sv) == 0.0)
2907 my_strlcpy(s, "0", SvLEN(sv));
2911 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2914 #ifdef FIXNEGATIVEZERO
2915 if (*s == '-' && s[1] == '0' && !s[2]) {
2927 if (isGV_with_GP(sv))
2928 return glob_2pv((GV *)sv, lp);
2932 if (flags & SV_UNDEF_RETURNS_NULL)
2934 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2936 if (SvTYPE(sv) < SVt_PV)
2937 /* Typically the caller expects that sv_any is not NULL now. */
2938 sv_upgrade(sv, SVt_PV);
2942 const STRLEN len = s - SvPVX_const(sv);
2948 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2949 PTR2UV(sv),SvPVX_const(sv)));
2950 if (flags & SV_CONST_RETURN)
2951 return (char *)SvPVX_const(sv);
2952 if (flags & SV_MUTABLE_RETURN)
2953 return SvPVX_mutable(sv);
2958 =for apidoc sv_copypv
2960 Copies a stringified representation of the source SV into the
2961 destination SV. Automatically performs any necessary mg_get and
2962 coercion of numeric values into strings. Guaranteed to preserve
2963 UTF8 flag even from overloaded objects. Similar in nature to
2964 sv_2pv[_flags] but operates directly on an SV instead of just the
2965 string. Mostly uses sv_2pv_flags to do its work, except when that
2966 would lose the UTF-8'ness of the PV.
2972 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2975 const char * const s = SvPV_const(ssv,len);
2977 PERL_ARGS_ASSERT_SV_COPYPV;
2979 sv_setpvn(dsv,s,len);
2987 =for apidoc sv_2pvbyte
2989 Return a pointer to the byte-encoded representation of the SV, and set *lp
2990 to its length. May cause the SV to be downgraded from UTF-8 as a
2993 Usually accessed via the C<SvPVbyte> macro.
2999 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3001 PERL_ARGS_ASSERT_SV_2PVBYTE;
3003 sv_utf8_downgrade(sv,0);
3004 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3008 =for apidoc sv_2pvutf8
3010 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3011 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3013 Usually accessed via the C<SvPVutf8> macro.
3019 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3021 PERL_ARGS_ASSERT_SV_2PVUTF8;
3023 sv_utf8_upgrade(sv);
3024 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3029 =for apidoc sv_2bool
3031 This function is only called on magical items, and is only used by
3032 sv_true() or its macro equivalent.
3038 Perl_sv_2bool(pTHX_ register SV *sv)
3042 PERL_ARGS_ASSERT_SV_2BOOL;
3050 SV * const tmpsv = AMG_CALLun(sv,bool_);
3051 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3052 return (bool)SvTRUE(tmpsv);
3054 return SvRV(sv) != 0;
3057 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3059 (*sv->sv_u.svu_pv > '0' ||
3060 Xpvtmp->xpv_cur > 1 ||
3061 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3068 return SvIVX(sv) != 0;
3071 return SvNVX(sv) != 0.0;
3073 if (isGV_with_GP(sv))
3083 =for apidoc sv_utf8_upgrade
3085 Converts the PV of an SV to its UTF-8-encoded form.
3086 Forces the SV to string form if it is not already.
3087 Always sets the SvUTF8 flag to avoid future validity checks even
3088 if all the bytes have hibit clear.
3090 This is not as a general purpose byte encoding to Unicode interface:
3091 use the Encode extension for that.
3093 =for apidoc sv_utf8_upgrade_flags
3095 Converts the PV of an SV to its UTF-8-encoded form.
3096 Forces the SV to string form if it is not already.
3097 Always sets the SvUTF8 flag to avoid future validity checks even
3098 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3099 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3100 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3102 This is not as a general purpose byte encoding to Unicode interface:
3103 use the Encode extension for that.
3109 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3113 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3115 if (sv == &PL_sv_undef)
3119 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3120 (void) sv_2pv_flags(sv,&len, flags);
3124 (void) SvPV_force(sv,len);
3133 sv_force_normal_flags(sv, 0);
3136 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3137 sv_recode_to_utf8(sv, PL_encoding);
3138 else { /* Assume Latin-1/EBCDIC */
3139 /* This function could be much more efficient if we
3140 * had a FLAG in SVs to signal if there are any hibit
3141 * chars in the PV. Given that there isn't such a flag
3142 * make the loop as fast as possible. */
3143 const U8 * const s = (U8 *) SvPVX_const(sv);
3144 const U8 * const e = (U8 *) SvEND(sv);
3149 /* Check for hi bit */
3150 if (!NATIVE_IS_INVARIANT(ch)) {
3151 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3152 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3154 SvPV_free(sv); /* No longer using what was there before. */
3155 SvPV_set(sv, (char*)recoded);
3156 SvCUR_set(sv, len - 1);
3157 SvLEN_set(sv, len); /* No longer know the real size. */
3161 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3168 =for apidoc sv_utf8_downgrade
3170 Attempts to convert the PV of an SV from characters to bytes.
3171 If the PV contains a character beyond byte, this conversion will fail;
3172 in this case, either returns false or, if C<fail_ok> is not
3175 This is not as a general purpose Unicode to byte encoding interface:
3176 use the Encode extension for that.
3182 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3186 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3188 if (SvPOKp(sv) && SvUTF8(sv)) {
3194 sv_force_normal_flags(sv, 0);
3196 s = (U8 *) SvPV(sv, len);
3197 if (!utf8_to_bytes(s, &len)) {
3202 Perl_croak(aTHX_ "Wide character in %s",
3205 Perl_croak(aTHX_ "Wide character");
3216 =for apidoc sv_utf8_encode
3218 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3219 flag off so that it looks like octets again.
3225 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3227 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3230 sv_force_normal_flags(sv, 0);
3232 if (SvREADONLY(sv)) {
3233 Perl_croak(aTHX_ PL_no_modify);
3235 (void) sv_utf8_upgrade(sv);
3240 =for apidoc sv_utf8_decode
3242 If the PV of the SV is an octet sequence in UTF-8
3243 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3244 so that it looks like a character. If the PV contains only single-byte
3245 characters, the C<SvUTF8> flag stays being off.
3246 Scans PV for validity and returns false if the PV is invalid UTF-8.
3252 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3254 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3260 /* The octets may have got themselves encoded - get them back as
3263 if (!sv_utf8_downgrade(sv, TRUE))
3266 /* it is actually just a matter of turning the utf8 flag on, but
3267 * we want to make sure everything inside is valid utf8 first.
3269 c = (const U8 *) SvPVX_const(sv);
3270 if (!is_utf8_string(c, SvCUR(sv)+1))
3272 e = (const U8 *) SvEND(sv);
3275 if (!UTF8_IS_INVARIANT(ch)) {
3285 =for apidoc sv_setsv
3287 Copies the contents of the source SV C<ssv> into the destination SV
3288 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3289 function if the source SV needs to be reused. Does not handle 'set' magic.
3290 Loosely speaking, it performs a copy-by-value, obliterating any previous
3291 content of the destination.
3293 You probably want to use one of the assortment of wrappers, such as
3294 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3295 C<SvSetMagicSV_nosteal>.
3297 =for apidoc sv_setsv_flags
3299 Copies the contents of the source SV C<ssv> into the destination SV
3300 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3301 function if the source SV needs to be reused. Does not handle 'set' magic.
3302 Loosely speaking, it performs a copy-by-value, obliterating any previous
3303 content of the destination.
3304 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3305 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3306 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3307 and C<sv_setsv_nomg> are implemented in terms of this function.
3309 You probably want to use one of the assortment of wrappers, such as
3310 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3311 C<SvSetMagicSV_nosteal>.
3313 This is the primary function for copying scalars, and most other
3314 copy-ish functions and macros use this underneath.
3320 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3322 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3324 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3326 if (dtype != SVt_PVGV) {
3327 const char * const name = GvNAME(sstr);
3328 const STRLEN len = GvNAMELEN(sstr);
3330 if (dtype >= SVt_PV) {
3336 SvUPGRADE(dstr, SVt_PVGV);
3337 (void)SvOK_off(dstr);
3338 /* FIXME - why are we doing this, then turning it off and on again
3340 isGV_with_GP_on(dstr);
3342 GvSTASH(dstr) = GvSTASH(sstr);
3344 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3345 gv_name_set((GV *)dstr, name, len, GV_ADD);
3346 SvFAKE_on(dstr); /* can coerce to non-glob */
3349 #ifdef GV_UNIQUE_CHECK
3350 if (GvUNIQUE((GV*)dstr)) {
3351 Perl_croak(aTHX_ PL_no_modify);
3355 if(GvGP((GV*)sstr)) {
3356 /* If source has method cache entry, clear it */
3358 SvREFCNT_dec(GvCV(sstr));
3362 /* If source has a real method, then a method is
3364 else if(GvCV((GV*)sstr)) {
3369 /* If dest already had a real method, that's a change as well */
3370 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3374 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3378 isGV_with_GP_off(dstr);
3379 (void)SvOK_off(dstr);
3380 isGV_with_GP_on(dstr);
3381 GvINTRO_off(dstr); /* one-shot flag */
3382 GvGP(dstr) = gp_ref(GvGP(sstr));
3383 if (SvTAINTED(sstr))
3385 if (GvIMPORTED(dstr) != GVf_IMPORTED
3386 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3388 GvIMPORTED_on(dstr);
3391 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3392 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3397 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr)
3399 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3401 const int intro = GvINTRO(dstr);
3404 const U32 stype = SvTYPE(sref);
3406 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3408 #ifdef GV_UNIQUE_CHECK
3409 if (GvUNIQUE((GV*)dstr)) {
3410 Perl_croak(aTHX_ PL_no_modify);
3415 GvINTRO_off(dstr); /* one-shot flag */
3416 GvLINE(dstr) = CopLINE(PL_curcop);
3417 GvEGV(dstr) = (GV*)dstr;
3422 location = (SV **) &GvCV(dstr);
3423 import_flag = GVf_IMPORTED_CV;
3426 location = (SV **) &GvHV(dstr);
3427 import_flag = GVf_IMPORTED_HV;
3430 location = (SV **) &GvAV(dstr);
3431 import_flag = GVf_IMPORTED_AV;
3434 location = (SV **) &GvIOp(dstr);
3437 location = (SV **) &GvFORM(dstr);
3439 location = &GvSV(dstr);
3440 import_flag = GVf_IMPORTED_SV;
3443 if (stype == SVt_PVCV) {
3444 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3445 if (GvCVGEN(dstr)) {
3446 SvREFCNT_dec(GvCV(dstr));
3448 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3451 SAVEGENERICSV(*location);
3455 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3456 CV* const cv = (CV*)*location;
3458 if (!GvCVGEN((GV*)dstr) &&
3459 (CvROOT(cv) || CvXSUB(cv)))
3461 /* Redefining a sub - warning is mandatory if
3462 it was a const and its value changed. */
3463 if (CvCONST(cv) && CvCONST((CV*)sref)
3464 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3466 /* They are 2 constant subroutines generated from
3467 the same constant. This probably means that
3468 they are really the "same" proxy subroutine
3469 instantiated in 2 places. Most likely this is
3470 when a constant is exported twice. Don't warn.
3473 else if (ckWARN(WARN_REDEFINE)
3475 && (!CvCONST((CV*)sref)
3476 || sv_cmp(cv_const_sv(cv),
3477 cv_const_sv((CV*)sref))))) {
3478 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3481 ? "Constant subroutine %s::%s redefined"
3482 : "Subroutine %s::%s redefined"),
3483 HvNAME_get(GvSTASH((GV*)dstr)),
3484 GvENAME((GV*)dstr));
3488 cv_ckproto_len(cv, (GV*)dstr,
3489 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3490 SvPOK(sref) ? SvCUR(sref) : 0);
3492 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3493 GvASSUMECV_on(dstr);
3494 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3497 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3498 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3499 GvFLAGS(dstr) |= import_flag;
3504 if (SvTAINTED(sstr))
3510 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3513 register U32 sflags;
3515 register svtype stype;
3517 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3522 if (SvIS_FREED(dstr)) {
3523 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3524 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3526 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3528 sstr = &PL_sv_undef;
3529 if (SvIS_FREED(sstr)) {
3530 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3531 (void*)sstr, (void*)dstr);
3533 stype = SvTYPE(sstr);
3534 dtype = SvTYPE(dstr);
3536 (void)SvAMAGIC_off(dstr);
3539 /* need to nuke the magic */
3541 SvRMAGICAL_off(dstr);
3544 /* There's a lot of redundancy below but we're going for speed here */
3549 if (dtype != SVt_PVGV) {
3550 (void)SvOK_off(dstr);
3558 sv_upgrade(dstr, SVt_IV);
3562 sv_upgrade(dstr, SVt_PVIV);
3565 goto end_of_first_switch;
3567 (void)SvIOK_only(dstr);
3568 SvIV_set(dstr, SvIVX(sstr));
3571 /* SvTAINTED can only be true if the SV has taint magic, which in
3572 turn means that the SV type is PVMG (or greater). This is the
3573 case statement for SVt_IV, so this cannot be true (whatever gcov
3575 assert(!SvTAINTED(sstr));
3580 if (dtype < SVt_PV && dtype != SVt_IV)
3581 sv_upgrade(dstr, SVt_IV);
3589 sv_upgrade(dstr, SVt_NV);
3593 sv_upgrade(dstr, SVt_PVNV);
3596 goto end_of_first_switch;
3598 SvNV_set(dstr, SvNVX(sstr));
3599 (void)SvNOK_only(dstr);
3600 /* SvTAINTED can only be true if the SV has taint magic, which in
3601 turn means that the SV type is PVMG (or greater). This is the
3602 case statement for SVt_NV, so this cannot be true (whatever gcov
3604 assert(!SvTAINTED(sstr));
3610 #ifdef PERL_OLD_COPY_ON_WRITE
3611 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3612 if (dtype < SVt_PVIV)
3613 sv_upgrade(dstr, SVt_PVIV);
3621 sv_upgrade(dstr, SVt_PV);
3624 if (dtype < SVt_PVIV)
3625 sv_upgrade(dstr, SVt_PVIV);
3628 if (dtype < SVt_PVNV)
3629 sv_upgrade(dstr, SVt_PVNV);
3633 const char * const type = sv_reftype(sstr,0);
3635 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3637 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3641 /* case SVt_BIND: */
3644 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3645 glob_assign_glob(dstr, sstr, dtype);
3648 /* SvVALID means that this PVGV is playing at being an FBM. */
3652 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3654 if (SvTYPE(sstr) != stype) {
3655 stype = SvTYPE(sstr);
3656 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3657 glob_assign_glob(dstr, sstr, dtype);
3662 if (stype == SVt_PVLV)
3663 SvUPGRADE(dstr, SVt_PVNV);
3665 SvUPGRADE(dstr, (svtype)stype);
3667 end_of_first_switch:
3669 /* dstr may have been upgraded. */
3670 dtype = SvTYPE(dstr);
3671 sflags = SvFLAGS(sstr);
3673 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3674 /* Assigning to a subroutine sets the prototype. */
3677 const char *const ptr = SvPV_const(sstr, len);
3679 SvGROW(dstr, len + 1);
3680 Copy(ptr, SvPVX(dstr), len + 1, char);
3681 SvCUR_set(dstr, len);
3683 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3687 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3688 const char * const type = sv_reftype(dstr,0);
3690 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3692 Perl_croak(aTHX_ "Cannot copy to %s", type);
3693 } else if (sflags & SVf_ROK) {
3694 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3695 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3698 if (GvIMPORTED(dstr) != GVf_IMPORTED
3699 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3701 GvIMPORTED_on(dstr);
3706 glob_assign_glob(dstr, sstr, dtype);
3710 if (dtype >= SVt_PV) {
3711 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3712 glob_assign_ref(dstr, sstr);
3715 if (SvPVX_const(dstr)) {
3721 (void)SvOK_off(dstr);
3722 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3723 SvFLAGS(dstr) |= sflags & SVf_ROK;
3724 assert(!(sflags & SVp_NOK));
3725 assert(!(sflags & SVp_IOK));
3726 assert(!(sflags & SVf_NOK));
3727 assert(!(sflags & SVf_IOK));
3729 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3730 if (!(sflags & SVf_OK)) {
3731 if (ckWARN(WARN_MISC))
3732 Perl_warner(aTHX_ packWARN(WARN_MISC),
3733 "Undefined value assigned to typeglob");
3736 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3737 if (dstr != (SV*)gv) {
3740 GvGP(dstr) = gp_ref(GvGP(gv));
3744 else if (sflags & SVp_POK) {
3748 * Check to see if we can just swipe the string. If so, it's a
3749 * possible small lose on short strings, but a big win on long ones.
3750 * It might even be a win on short strings if SvPVX_const(dstr)
3751 * has to be allocated and SvPVX_const(sstr) has to be freed.
3752 * Likewise if we can set up COW rather than doing an actual copy, we
3753 * drop to the else clause, as the swipe code and the COW setup code
3754 * have much in common.
3757 /* Whichever path we take through the next code, we want this true,
3758 and doing it now facilitates the COW check. */
3759 (void)SvPOK_only(dstr);
3762 /* If we're already COW then this clause is not true, and if COW
3763 is allowed then we drop down to the else and make dest COW
3764 with us. If caller hasn't said that we're allowed to COW
3765 shared hash keys then we don't do the COW setup, even if the
3766 source scalar is a shared hash key scalar. */
3767 (((flags & SV_COW_SHARED_HASH_KEYS)
3768 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3769 : 1 /* If making a COW copy is forbidden then the behaviour we
3770 desire is as if the source SV isn't actually already
3771 COW, even if it is. So we act as if the source flags
3772 are not COW, rather than actually testing them. */
3774 #ifndef PERL_OLD_COPY_ON_WRITE
3775 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3776 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3777 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3778 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3779 but in turn, it's somewhat dead code, never expected to go
3780 live, but more kept as a placeholder on how to do it better
3781 in a newer implementation. */
3782 /* If we are COW and dstr is a suitable target then we drop down
3783 into the else and make dest a COW of us. */
3784 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3789 (sflags & SVs_TEMP) && /* slated for free anyway? */
3790 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3791 (!(flags & SV_NOSTEAL)) &&
3792 /* and we're allowed to steal temps */
3793 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3794 SvLEN(sstr) && /* and really is a string */
3795 /* and won't be needed again, potentially */
3796 !(PL_op && PL_op->op_type == OP_AASSIGN))
3797 #ifdef PERL_OLD_COPY_ON_WRITE
3798 && ((flags & SV_COW_SHARED_HASH_KEYS)
3799 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3800 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3801 && SvTYPE(sstr) >= SVt_PVIV))
3805 /* Failed the swipe test, and it's not a shared hash key either.
3806 Have to copy the string. */
3807 STRLEN len = SvCUR(sstr);
3808 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3809 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3810 SvCUR_set(dstr, len);
3811 *SvEND(dstr) = '\0';
3813 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3815 /* Either it's a shared hash key, or it's suitable for
3816 copy-on-write or we can swipe the string. */
3818 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3822 #ifdef PERL_OLD_COPY_ON_WRITE
3824 /* I believe I should acquire a global SV mutex if
3825 it's a COW sv (not a shared hash key) to stop
3826 it going un copy-on-write.
3827 If the source SV has gone un copy on write between up there
3828 and down here, then (assert() that) it is of the correct
3829 form to make it copy on write again */
3830 if ((sflags & (SVf_FAKE | SVf_READONLY))
3831 != (SVf_FAKE | SVf_READONLY)) {
3832 SvREADONLY_on(sstr);
3834 /* Make the source SV into a loop of 1.
3835 (about to become 2) */
3836 SV_COW_NEXT_SV_SET(sstr, sstr);
3840 /* Initial code is common. */
3841 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3846 /* making another shared SV. */
3847 STRLEN cur = SvCUR(sstr);
3848 STRLEN len = SvLEN(sstr);
3849 #ifdef PERL_OLD_COPY_ON_WRITE
3851 assert (SvTYPE(dstr) >= SVt_PVIV);
3852 /* SvIsCOW_normal */
3853 /* splice us in between source and next-after-source. */
3854 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3855 SV_COW_NEXT_SV_SET(sstr, dstr);
3856 SvPV_set(dstr, SvPVX_mutable(sstr));
3860 /* SvIsCOW_shared_hash */
3861 DEBUG_C(PerlIO_printf(Perl_debug_log,
3862 "Copy on write: Sharing hash\n"));
3864 assert (SvTYPE(dstr) >= SVt_PV);
3866 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3868 SvLEN_set(dstr, len);
3869 SvCUR_set(dstr, cur);
3870 SvREADONLY_on(dstr);
3872 /* Relesase a global SV mutex. */
3875 { /* Passes the swipe test. */
3876 SvPV_set(dstr, SvPVX_mutable(sstr));
3877 SvLEN_set(dstr, SvLEN(sstr));
3878 SvCUR_set(dstr, SvCUR(sstr));
3881 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3882 SvPV_set(sstr, NULL);
3888 if (sflags & SVp_NOK) {
3889 SvNV_set(dstr, SvNVX(sstr));
3891 if (sflags & SVp_IOK) {
3892 SvIV_set(dstr, SvIVX(sstr));
3893 /* Must do this otherwise some other overloaded use of 0x80000000
3894 gets confused. I guess SVpbm_VALID */
3895 if (sflags & SVf_IVisUV)
3898 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3900 const MAGIC * const smg = SvVSTRING_mg(sstr);
3902 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3903 smg->mg_ptr, smg->mg_len);
3904 SvRMAGICAL_on(dstr);
3908 else if (sflags & (SVp_IOK|SVp_NOK)) {
3909 (void)SvOK_off(dstr);
3910 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3911 if (sflags & SVp_IOK) {
3912 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3913 SvIV_set(dstr, SvIVX(sstr));
3915 if (sflags & SVp_NOK) {
3916 SvNV_set(dstr, SvNVX(sstr));
3920 if (isGV_with_GP(sstr)) {
3921 /* This stringification rule for globs is spread in 3 places.
3922 This feels bad. FIXME. */
3923 const U32 wasfake = sflags & SVf_FAKE;
3925 /* FAKE globs can get coerced, so need to turn this off
3926 temporarily if it is on. */
3928 gv_efullname3(dstr, (GV *)sstr, "*");
3929 SvFLAGS(sstr) |= wasfake;
3932 (void)SvOK_off(dstr);
3934 if (SvTAINTED(sstr))
3939 =for apidoc sv_setsv_mg
3941 Like C<sv_setsv>, but also handles 'set' magic.
3947 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3949 PERL_ARGS_ASSERT_SV_SETSV_MG;
3951 sv_setsv(dstr,sstr);
3955 #ifdef PERL_OLD_COPY_ON_WRITE
3957 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3959 STRLEN cur = SvCUR(sstr);
3960 STRLEN len = SvLEN(sstr);
3961 register char *new_pv;
3963 PERL_ARGS_ASSERT_SV_SETSV_COW;
3966 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3967 (void*)sstr, (void*)dstr);
3974 if (SvTHINKFIRST(dstr))
3975 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3976 else if (SvPVX_const(dstr))
3977 Safefree(SvPVX_const(dstr));
3981 SvUPGRADE(dstr, SVt_PVIV);
3983 assert (SvPOK(sstr));
3984 assert (SvPOKp(sstr));
3985 assert (!SvIOK(sstr));
3986 assert (!SvIOKp(sstr));
3987 assert (!SvNOK(sstr));
3988 assert (!SvNOKp(sstr));
3990 if (SvIsCOW(sstr)) {
3992 if (SvLEN(sstr) == 0) {
3993 /* source is a COW shared hash key. */
3994 DEBUG_C(PerlIO_printf(Perl_debug_log,
3995 "Fast copy on write: Sharing hash\n"));
3996 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3999 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4001 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4002 SvUPGRADE(sstr, SVt_PVIV);
4003 SvREADONLY_on(sstr);
4005 DEBUG_C(PerlIO_printf(Perl_debug_log,
4006 "Fast copy on write: Converting sstr to COW\n"));
4007 SV_COW_NEXT_SV_SET(dstr, sstr);
4009 SV_COW_NEXT_SV_SET(sstr, dstr);
4010 new_pv = SvPVX_mutable(sstr);
4013 SvPV_set(dstr, new_pv);
4014 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4017 SvLEN_set(dstr, len);
4018 SvCUR_set(dstr, cur);
4027 =for apidoc sv_setpvn
4029 Copies a string into an SV. The C<len> parameter indicates the number of
4030 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4031 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4037 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4040 register char *dptr;
4042 PERL_ARGS_ASSERT_SV_SETPVN;
4044 SV_CHECK_THINKFIRST_COW_DROP(sv);
4050 /* len is STRLEN which is unsigned, need to copy to signed */
4053 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4055 SvUPGRADE(sv, SVt_PV);
4057 dptr = SvGROW(sv, len + 1);
4058 Move(ptr,dptr,len,char);
4061 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4066 =for apidoc sv_setpvn_mg
4068 Like C<sv_setpvn>, but also handles 'set' magic.
4074 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4076 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4078 sv_setpvn(sv,ptr,len);
4083 =for apidoc sv_setpv
4085 Copies a string into an SV. The string must be null-terminated. Does not
4086 handle 'set' magic. See C<sv_setpv_mg>.
4092 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4095 register STRLEN len;
4097 PERL_ARGS_ASSERT_SV_SETPV;
4099 SV_CHECK_THINKFIRST_COW_DROP(sv);
4105 SvUPGRADE(sv, SVt_PV);
4107 SvGROW(sv, len + 1);
4108 Move(ptr,SvPVX(sv),len+1,char);
4110 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4115 =for apidoc sv_setpv_mg
4117 Like C<sv_setpv>, but also handles 'set' magic.
4123 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4125 PERL_ARGS_ASSERT_SV_SETPV_MG;
4132 =for apidoc sv_usepvn_flags
4134 Tells an SV to use C<ptr> to find its string value. Normally the
4135 string is stored inside the SV but sv_usepvn allows the SV to use an
4136 outside string. The C<ptr> should point to memory that was allocated
4137 by C<malloc>. The string length, C<len>, must be supplied. By default
4138 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4139 so that pointer should not be freed or used by the programmer after
4140 giving it to sv_usepvn, and neither should any pointers from "behind"
4141 that pointer (e.g. ptr + 1) be used.
4143 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4144 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4145 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4146 C<len>, and already meets the requirements for storing in C<SvPVX>)
4152 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4157 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4159 SV_CHECK_THINKFIRST_COW_DROP(sv);
4160 SvUPGRADE(sv, SVt_PV);
4163 if (flags & SV_SMAGIC)
4167 if (SvPVX_const(sv))
4171 if (flags & SV_HAS_TRAILING_NUL)
4172 assert(ptr[len] == '\0');
4175 allocate = (flags & SV_HAS_TRAILING_NUL)
4176 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4177 if (flags & SV_HAS_TRAILING_NUL) {
4178 /* It's long enough - do nothing.
4179 Specfically Perl_newCONSTSUB is relying on this. */
4182 /* Force a move to shake out bugs in callers. */
4183 char *new_ptr = (char*)safemalloc(allocate);
4184 Copy(ptr, new_ptr, len, char);
4185 PoisonFree(ptr,len,char);
4189 ptr = (char*) saferealloc (ptr, allocate);
4194 SvLEN_set(sv, allocate);
4195 if (!(flags & SV_HAS_TRAILING_NUL)) {
4198 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4200 if (flags & SV_SMAGIC)
4204 #ifdef PERL_OLD_COPY_ON_WRITE
4205 /* Need to do this *after* making the SV normal, as we need the buffer
4206 pointer to remain valid until after we've copied it. If we let go too early,
4207 another thread could invalidate it by unsharing last of the same hash key
4208 (which it can do by means other than releasing copy-on-write Svs)
4209 or by changing the other copy-on-write SVs in the loop. */
4211 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4213 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4215 { /* this SV was SvIsCOW_normal(sv) */
4216 /* we need to find the SV pointing to us. */
4217 SV *current = SV_COW_NEXT_SV(after);
4219 if (current == sv) {
4220 /* The SV we point to points back to us (there were only two of us
4222 Hence other SV is no longer copy on write either. */
4224 SvREADONLY_off(after);
4226 /* We need to follow the pointers around the loop. */
4228 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4231 /* don't loop forever if the structure is bust, and we have
4232 a pointer into a closed loop. */
4233 assert (current != after);
4234 assert (SvPVX_const(current) == pvx);
4236 /* Make the SV before us point to the SV after us. */
4237 SV_COW_NEXT_SV_SET(current, after);
4243 =for apidoc sv_force_normal_flags
4245 Undo various types of fakery on an SV: if the PV is a shared string, make
4246 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4247 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4248 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4249 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4250 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4251 set to some other value.) In addition, the C<flags> parameter gets passed to
4252 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4253 with flags set to 0.
4259 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4263 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4265 #ifdef PERL_OLD_COPY_ON_WRITE
4266 if (SvREADONLY(sv)) {
4267 /* At this point I believe I should acquire a global SV mutex. */
4269 const char * const pvx = SvPVX_const(sv);
4270 const STRLEN len = SvLEN(sv);
4271 const STRLEN cur = SvCUR(sv);
4272 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4273 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4274 we'll fail an assertion. */
4275 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4278 PerlIO_printf(Perl_debug_log,
4279 "Copy on write: Force normal %ld\n",
4285 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4288 if (flags & SV_COW_DROP_PV) {
4289 /* OK, so we don't need to copy our buffer. */
4292 SvGROW(sv, cur + 1);
4293 Move(pvx,SvPVX(sv),cur,char);
4298 sv_release_COW(sv, pvx, next);
4300 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4306 else if (IN_PERL_RUNTIME)
4307 Perl_croak(aTHX_ PL_no_modify);
4308 /* At this point I believe that I can drop the global SV mutex. */
4311 if (SvREADONLY(sv)) {
4313 const char * const pvx = SvPVX_const(sv);
4314 const STRLEN len = SvCUR(sv);
4319 SvGROW(sv, len + 1);
4320 Move(pvx,SvPVX(sv),len,char);
4322 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4324 else if (IN_PERL_RUNTIME)
4325 Perl_croak(aTHX_ PL_no_modify);
4329 sv_unref_flags(sv, flags);
4330 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4337 Efficient removal of characters from the beginning of the string buffer.
4338 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4339 the string buffer. The C<ptr> becomes the first character of the adjusted
4340 string. Uses the "OOK hack".
4341 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4342 refer to the same chunk of data.
4348 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4354 const U8 *real_start;
4357 PERL_ARGS_ASSERT_SV_CHOP;
4359 if (!ptr || !SvPOKp(sv))
4361 delta = ptr - SvPVX_const(sv);
4363 /* Nothing to do. */
4366 assert(ptr > SvPVX_const(sv));
4367 SV_CHECK_THINKFIRST(sv);
4370 if (!SvLEN(sv)) { /* make copy of shared string */
4371 const char *pvx = SvPVX_const(sv);
4372 const STRLEN len = SvCUR(sv);
4373 SvGROW(sv, len + 1);
4374 Move(pvx,SvPVX(sv),len,char);
4377 SvFLAGS(sv) |= SVf_OOK;
4380 SvOOK_offset(sv, old_delta);
4382 SvLEN_set(sv, SvLEN(sv) - delta);
4383 SvCUR_set(sv, SvCUR(sv) - delta);
4384 SvPV_set(sv, SvPVX(sv) + delta);
4386 p = (U8 *)SvPVX_const(sv);
4391 real_start = p - delta;
4395 if (delta < 0x100) {
4399 p -= sizeof(STRLEN);
4400 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4404 /* Fill the preceding buffer with sentinals to verify that no-one is
4406 while (p > real_start) {
4414 =for apidoc sv_catpvn
4416 Concatenates the string onto the end of the string which is in the SV. The
4417 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4418 status set, then the bytes appended should be valid UTF-8.
4419 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4421 =for apidoc sv_catpvn_flags
4423 Concatenates the string onto the end of the string which is in the SV. The
4424 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4425 status set, then the bytes appended should be valid UTF-8.
4426 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4427 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4428 in terms of this function.
4434 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4438 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4440 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4442 SvGROW(dsv, dlen + slen + 1);
4444 sstr = SvPVX_const(dsv);
4445 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4446 SvCUR_set(dsv, SvCUR(dsv) + slen);
4448 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4450 if (flags & SV_SMAGIC)
4455 =for apidoc sv_catsv
4457 Concatenates the string from SV C<ssv> onto the end of the string in
4458 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4459 not 'set' magic. See C<sv_catsv_mg>.
4461 =for apidoc sv_catsv_flags
4463 Concatenates the string from SV C<ssv> onto the end of the string in
4464 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4465 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4466 and C<sv_catsv_nomg> are implemented in terms of this function.
4471 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4475 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4479 const char *spv = SvPV_const(ssv, slen);
4481 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4482 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4483 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4484 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4485 dsv->sv_flags doesn't have that bit set.
4486 Andy Dougherty 12 Oct 2001
4488 const I32 sutf8 = DO_UTF8(ssv);
4491 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4493 dutf8 = DO_UTF8(dsv);
4495 if (dutf8 != sutf8) {
4497 /* Not modifying source SV, so taking a temporary copy. */
4498 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4500 sv_utf8_upgrade(csv);
4501 spv = SvPV_const(csv, slen);
4504 sv_utf8_upgrade_nomg(dsv);
4506 sv_catpvn_nomg(dsv, spv, slen);
4509 if (flags & SV_SMAGIC)
4514 =for apidoc sv_catpv
4516 Concatenates the string onto the end of the string which is in the SV.
4517 If the SV has the UTF-8 status set, then the bytes appended should be
4518 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4523 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4526 register STRLEN len;
4530 PERL_ARGS_ASSERT_SV_CATPV;
4534 junk = SvPV_force(sv, tlen);
4536 SvGROW(sv, tlen + len + 1);
4538 ptr = SvPVX_const(sv);
4539 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4540 SvCUR_set(sv, SvCUR(sv) + len);
4541 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4546 =for apidoc sv_catpv_mg
4548 Like C<sv_catpv>, but also handles 'set' magic.
4554 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4556 PERL_ARGS_ASSERT_SV_CATPV_MG;
4565 Creates a new SV. A non-zero C<len> parameter indicates the number of
4566 bytes of preallocated string space the SV should have. An extra byte for a
4567 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4568 space is allocated.) The reference count for the new SV is set to 1.
4570 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4571 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4572 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4573 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4574 modules supporting older perls.
4580 Perl_newSV(pTHX_ STRLEN len)
4587 sv_upgrade(sv, SVt_PV);
4588 SvGROW(sv, len + 1);
4593 =for apidoc sv_magicext
4595 Adds magic to an SV, upgrading it if necessary. Applies the
4596 supplied vtable and returns a pointer to the magic added.
4598 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4599 In particular, you can add magic to SvREADONLY SVs, and add more than
4600 one instance of the same 'how'.
4602 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4603 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4604 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4605 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4607 (This is now used as a subroutine by C<sv_magic>.)
4612 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4613 const char* name, I32 namlen)
4618 PERL_ARGS_ASSERT_SV_MAGICEXT;
4620 SvUPGRADE(sv, SVt_PVMG);
4621 Newxz(mg, 1, MAGIC);
4622 mg->mg_moremagic = SvMAGIC(sv);
4623 SvMAGIC_set(sv, mg);
4625 /* Sometimes a magic contains a reference loop, where the sv and
4626 object refer to each other. To prevent a reference loop that
4627 would prevent such objects being freed, we look for such loops
4628 and if we find one we avoid incrementing the object refcount.
4630 Note we cannot do this to avoid self-tie loops as intervening RV must
4631 have its REFCNT incremented to keep it in existence.
4634 if (!obj || obj == sv ||
4635 how == PERL_MAGIC_arylen ||
4636 how == PERL_MAGIC_symtab ||
4637 (SvTYPE(obj) == SVt_PVGV &&
4638 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4639 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4640 GvFORM(obj) == (CV*)sv)))
4645 mg->mg_obj = SvREFCNT_inc_simple(obj);
4646 mg->mg_flags |= MGf_REFCOUNTED;
4649 /* Normal self-ties simply pass a null object, and instead of
4650 using mg_obj directly, use the SvTIED_obj macro to produce a
4651 new RV as needed. For glob "self-ties", we are tieing the PVIO
4652 with an RV obj pointing to the glob containing the PVIO. In
4653 this case, to avoid a reference loop, we need to weaken the
4657 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4658 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4664 mg->mg_len = namlen;
4667 mg->mg_ptr = savepvn(name, namlen);
4668 else if (namlen == HEf_SVKEY)
4669 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4671 mg->mg_ptr = (char *) name;
4673 mg->mg_virtual = (MGVTBL *) vtable;
4677 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4682 =for apidoc sv_magic
4684 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4685 then adds a new magic item of type C<how> to the head of the magic list.
4687 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4688 handling of the C<name> and C<namlen> arguments.
4690 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4691 to add more than one instance of the same 'how'.
4697 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4700 const MGVTBL *vtable;
4703 PERL_ARGS_ASSERT_SV_MAGIC;
4705 #ifdef PERL_OLD_COPY_ON_WRITE
4707 sv_force_normal_flags(sv, 0);
4709 if (SvREADONLY(sv)) {
4711 /* its okay to attach magic to shared strings; the subsequent
4712 * upgrade to PVMG will unshare the string */
4713 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4716 && how != PERL_MAGIC_regex_global
4717 && how != PERL_MAGIC_bm
4718 && how != PERL_MAGIC_fm
4719 && how != PERL_MAGIC_sv
4720 && how != PERL_MAGIC_backref
4723 Perl_croak(aTHX_ PL_no_modify);
4726 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4727 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4728 /* sv_magic() refuses to add a magic of the same 'how' as an
4731 if (how == PERL_MAGIC_taint) {
4733 /* Any scalar which already had taint magic on which someone
4734 (erroneously?) did SvIOK_on() or similar will now be
4735 incorrectly sporting public "OK" flags. */
4736 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4744 vtable = &PL_vtbl_sv;
4746 case PERL_MAGIC_overload:
4747 vtable = &PL_vtbl_amagic;
4749 case PERL_MAGIC_overload_elem:
4750 vtable = &PL_vtbl_amagicelem;
4752 case PERL_MAGIC_overload_table:
4753 vtable = &PL_vtbl_ovrld;
4756 vtable = &PL_vtbl_bm;
4758 case PERL_MAGIC_regdata:
4759 vtable = &PL_vtbl_regdata;
4761 case PERL_MAGIC_regdatum:
4762 vtable = &PL_vtbl_regdatum;
4764 case PERL_MAGIC_env:
4765 vtable = &PL_vtbl_env;
4768 vtable = &PL_vtbl_fm;
4770 case PERL_MAGIC_envelem:
4771 vtable = &PL_vtbl_envelem;
4773 case PERL_MAGIC_regex_global:
4774 vtable = &PL_vtbl_mglob;
4776 case PERL_MAGIC_isa:
4777 vtable = &PL_vtbl_isa;
4779 case PERL_MAGIC_isaelem:
4780 vtable = &PL_vtbl_isaelem;
4782 case PERL_MAGIC_nkeys:
4783 vtable = &PL_vtbl_nkeys;
4785 case PERL_MAGIC_dbfile:
4788 case PERL_MAGIC_dbline:
4789 vtable = &PL_vtbl_dbline;
4791 #ifdef USE_LOCALE_COLLATE
4792 case PERL_MAGIC_collxfrm:
4793 vtable = &PL_vtbl_collxfrm;
4795 #endif /* USE_LOCALE_COLLATE */
4796 case PERL_MAGIC_tied:
4797 vtable = &PL_vtbl_pack;
4799 case PERL_MAGIC_tiedelem:
4800 case PERL_MAGIC_tiedscalar:
4801 vtable = &PL_vtbl_packelem;
4804 vtable = &PL_vtbl_regexp;
4806 case PERL_MAGIC_hints:
4807 /* As this vtable is all NULL, we can reuse it. */
4808 case PERL_MAGIC_sig:
4809 vtable = &PL_vtbl_sig;
4811 case PERL_MAGIC_sigelem:
4812 vtable = &PL_vtbl_sigelem;
4814 case PERL_MAGIC_taint:
4815 vtable = &PL_vtbl_taint;
4817 case PERL_MAGIC_uvar:
4818 vtable = &PL_vtbl_uvar;
4820 case PERL_MAGIC_vec:
4821 vtable = &PL_vtbl_vec;
4823 case PERL_MAGIC_arylen_p:
4824 case PERL_MAGIC_rhash:
4825 case PERL_MAGIC_symtab:
4826 case PERL_MAGIC_vstring:
4829 case PERL_MAGIC_utf8:
4830 vtable = &PL_vtbl_utf8;
4832 case PERL_MAGIC_substr:
4833 vtable = &PL_vtbl_substr;
4835 case PERL_MAGIC_defelem:
4836 vtable = &PL_vtbl_defelem;
4838 case PERL_MAGIC_arylen:
4839 vtable = &PL_vtbl_arylen;
4841 case PERL_MAGIC_pos:
4842 vtable = &PL_vtbl_pos;
4844 case PERL_MAGIC_backref:
4845 vtable = &PL_vtbl_backref;
4847 case PERL_MAGIC_hintselem:
4848 vtable = &PL_vtbl_hintselem;
4850 case PERL_MAGIC_ext:
4851 /* Reserved for use by extensions not perl internals. */
4852 /* Useful for attaching extension internal data to perl vars. */
4853 /* Note that multiple extensions may clash if magical scalars */
4854 /* etc holding private data from one are passed to another. */
4858 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4861 /* Rest of work is done else where */
4862 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4865 case PERL_MAGIC_taint:
4868 case PERL_MAGIC_ext:
4869 case PERL_MAGIC_dbfile:
4876 =for apidoc sv_unmagic
4878 Removes all magic of type C<type> from an SV.
4884 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4889 PERL_ARGS_ASSERT_SV_UNMAGIC;
4891 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4893 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4894 for (mg = *mgp; mg; mg = *mgp) {
4895 if (mg->mg_type == type) {
4896 const MGVTBL* const vtbl = mg->mg_virtual;
4897 *mgp = mg->mg_moremagic;
4898 if (vtbl && vtbl->svt_free)
4899 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4900 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4902 Safefree(mg->mg_ptr);
4903 else if (mg->mg_len == HEf_SVKEY)
4904 SvREFCNT_dec((SV*)mg->mg_ptr);
4905 else if (mg->mg_type == PERL_MAGIC_utf8)
4906 Safefree(mg->mg_ptr);
4908 if (mg->mg_flags & MGf_REFCOUNTED)
4909 SvREFCNT_dec(mg->mg_obj);
4913 mgp = &mg->mg_moremagic;
4917 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4918 SvMAGIC_set(sv, NULL);
4925 =for apidoc sv_rvweaken
4927 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4928 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4929 push a back-reference to this RV onto the array of backreferences
4930 associated with that magic. If the RV is magical, set magic will be
4931 called after the RV is cleared.
4937 Perl_sv_rvweaken(pTHX_ SV *sv)
4941 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4943 if (!SvOK(sv)) /* let undefs pass */
4946 Perl_croak(aTHX_ "Can't weaken a nonreference");
4947 else if (SvWEAKREF(sv)) {
4948 if (ckWARN(WARN_MISC))
4949 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4953 Perl_sv_add_backref(aTHX_ tsv, sv);
4959 /* Give tsv backref magic if it hasn't already got it, then push a
4960 * back-reference to sv onto the array associated with the backref magic.
4964 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4969 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4971 if (SvTYPE(tsv) == SVt_PVHV) {
4972 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4976 /* There is no AV in the offical place - try a fixup. */
4977 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4980 /* Aha. They've got it stowed in magic. Bring it back. */
4981 av = (AV*)mg->mg_obj;
4982 /* Stop mg_free decreasing the refernce count. */
4984 /* Stop mg_free even calling the destructor, given that
4985 there's no AV to free up. */
4987 sv_unmagic(tsv, PERL_MAGIC_backref);
4991 SvREFCNT_inc_simple_void(av);
4996 const MAGIC *const mg
4997 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4999 av = (AV*)mg->mg_obj;
5003 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5004 /* av now has a refcnt of 2, which avoids it getting freed
5005 * before us during global cleanup. The extra ref is removed
5006 * by magic_killbackrefs() when tsv is being freed */
5009 if (AvFILLp(av) >= AvMAX(av)) {
5010 av_extend(av, AvFILLp(av)+1);
5012 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5015 /* delete a back-reference to ourselves from the backref magic associated
5016 * with the SV we point to.
5020 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
5027 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5029 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5030 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5031 /* We mustn't attempt to "fix up" the hash here by moving the
5032 backreference array back to the hv_aux structure, as that is stored
5033 in the main HvARRAY(), and hfreentries assumes that no-one
5034 reallocates HvARRAY() while it is running. */
5037 const MAGIC *const mg
5038 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5040 av = (AV *)mg->mg_obj;
5043 if (PL_in_clean_all)
5045 Perl_croak(aTHX_ "panic: del_backref");
5052 /* We shouldn't be in here more than once, but for paranoia reasons lets
5054 for (i = AvFILLp(av); i >= 0; i--) {
5056 const SSize_t fill = AvFILLp(av);
5058 /* We weren't the last entry.
5059 An unordered list has this property that you can take the
5060 last element off the end to fill the hole, and it's still
5061 an unordered list :-)
5066 AvFILLp(av) = fill - 1;
5072 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
5074 SV **svp = AvARRAY(av);
5076 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5077 PERL_UNUSED_ARG(sv);
5079 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5080 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5081 if (svp && !SvIS_FREED(av)) {
5082 SV *const *const last = svp + AvFILLp(av);
5084 while (svp <= last) {
5086 SV *const referrer = *svp;
5087 if (SvWEAKREF(referrer)) {
5088 /* XXX Should we check that it hasn't changed? */
5089 SvRV_set(referrer, 0);
5091 SvWEAKREF_off(referrer);
5092 SvSETMAGIC(referrer);
5093 } else if (SvTYPE(referrer) == SVt_PVGV ||
5094 SvTYPE(referrer) == SVt_PVLV) {
5095 /* You lookin' at me? */
5096 assert(GvSTASH(referrer));
5097 assert(GvSTASH(referrer) == (HV*)sv);
5098 GvSTASH(referrer) = 0;
5101 "panic: magic_killbackrefs (flags=%"UVxf")",
5102 (UV)SvFLAGS(referrer));
5110 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5115 =for apidoc sv_insert
5117 Inserts a string at the specified offset/length within the SV. Similar to
5118 the Perl substr() function.
5124 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5129 register char *midend;
5130 register char *bigend;
5134 PERL_ARGS_ASSERT_SV_INSERT;
5137 Perl_croak(aTHX_ "Can't modify non-existent substring");
5138 SvPV_force(bigstr, curlen);
5139 (void)SvPOK_only_UTF8(bigstr);
5140 if (offset + len > curlen) {
5141 SvGROW(bigstr, offset+len+1);
5142 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5143 SvCUR_set(bigstr, offset+len);
5147 i = littlelen - len;
5148 if (i > 0) { /* string might grow */
5149 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5150 mid = big + offset + len;
5151 midend = bigend = big + SvCUR(bigstr);
5154 while (midend > mid) /* shove everything down */
5155 *--bigend = *--midend;
5156 Move(little,big+offset,littlelen,char);
5157 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5162 Move(little,SvPVX(bigstr)+offset,len,char);
5167 big = SvPVX(bigstr);
5170 bigend = big + SvCUR(bigstr);
5172 if (midend > bigend)
5173 Perl_croak(aTHX_ "panic: sv_insert");
5175 if (mid - big > bigend - midend) { /* faster to shorten from end */
5177 Move(little, mid, littlelen,char);
5180 i = bigend - midend;
5182 Move(midend, mid, i,char);
5186 SvCUR_set(bigstr, mid - big);
5188 else if ((i = mid - big)) { /* faster from front */
5189 midend -= littlelen;
5191 Move(big, midend - i, i, char);
5192 sv_chop(bigstr,midend-i);
5194 Move(little, mid, littlelen,char);
5196 else if (littlelen) {
5197 midend -= littlelen;
5198 sv_chop(bigstr,midend);
5199 Move(little,midend,littlelen,char);
5202 sv_chop(bigstr,midend);
5208 =for apidoc sv_replace
5210 Make the first argument a copy of the second, then delete the original.
5211 The target SV physically takes over ownership of the body of the source SV
5212 and inherits its flags; however, the target keeps any magic it owns,
5213 and any magic in the source is discarded.
5214 Note that this is a rather specialist SV copying operation; most of the
5215 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5221 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5224 const U32 refcnt = SvREFCNT(sv);
5226 PERL_ARGS_ASSERT_SV_REPLACE;
5228 SV_CHECK_THINKFIRST_COW_DROP(sv);
5229 if (SvREFCNT(nsv) != 1) {
5230 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5231 UVuf " != 1)", (UV) SvREFCNT(nsv));
5233 if (SvMAGICAL(sv)) {
5237 sv_upgrade(nsv, SVt_PVMG);
5238 SvMAGIC_set(nsv, SvMAGIC(sv));
5239 SvFLAGS(nsv) |= SvMAGICAL(sv);
5241 SvMAGIC_set(sv, NULL);
5245 assert(!SvREFCNT(sv));
5246 #ifdef DEBUG_LEAKING_SCALARS
5247 sv->sv_flags = nsv->sv_flags;
5248 sv->sv_any = nsv->sv_any;
5249 sv->sv_refcnt = nsv->sv_refcnt;
5250 sv->sv_u = nsv->sv_u;
5252 StructCopy(nsv,sv,SV);
5254 if(SvTYPE(sv) == SVt_IV) {
5256 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5260 #ifdef PERL_OLD_COPY_ON_WRITE
5261 if (SvIsCOW_normal(nsv)) {
5262 /* We need to follow the pointers around the loop to make the
5263 previous SV point to sv, rather than nsv. */
5266 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5269 assert(SvPVX_const(current) == SvPVX_const(nsv));
5271 /* Make the SV before us point to the SV after us. */
5273 PerlIO_printf(Perl_debug_log, "previous is\n");
5275 PerlIO_printf(Perl_debug_log,
5276 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5277 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5279 SV_COW_NEXT_SV_SET(current, sv);
5282 SvREFCNT(sv) = refcnt;
5283 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5289 =for apidoc sv_clear
5291 Clear an SV: call any destructors, free up any memory used by the body,
5292 and free the body itself. The SV's head is I<not> freed, although
5293 its type is set to all 1's so that it won't inadvertently be assumed
5294 to be live during global destruction etc.
5295 This function should only be called when REFCNT is zero. Most of the time
5296 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5303 Perl_sv_clear(pTHX_ register SV *sv)
5306 const U32 type = SvTYPE(sv);
5307 const struct body_details *const sv_type_details
5308 = bodies_by_type + type;
5311 PERL_ARGS_ASSERT_SV_CLEAR;
5312 assert(SvREFCNT(sv) == 0);
5313 assert(SvTYPE(sv) != SVTYPEMASK);
5315 if (type <= SVt_IV) {
5316 /* See the comment in sv.h about the collusion between this early
5317 return and the overloading of the NULL and IV slots in the size
5320 SV * const target = SvRV(sv);
5322 sv_del_backref(target, sv);
5324 SvREFCNT_dec(target);
5326 SvFLAGS(sv) &= SVf_BREAK;
5327 SvFLAGS(sv) |= SVTYPEMASK;
5332 if (PL_defstash && /* Still have a symbol table? */
5339 stash = SvSTASH(sv);
5340 destructor = StashHANDLER(stash,DESTROY);
5342 SV* const tmpref = newRV(sv);
5343 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5345 PUSHSTACKi(PERLSI_DESTROY);
5350 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5356 if(SvREFCNT(tmpref) < 2) {
5357 /* tmpref is not kept alive! */
5359 SvRV_set(tmpref, NULL);
5362 SvREFCNT_dec(tmpref);
5364 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5368 if (PL_in_clean_objs)
5369 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5371 /* DESTROY gave object new lease on life */
5377 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5378 SvOBJECT_off(sv); /* Curse the object. */
5379 if (type != SVt_PVIO)
5380 --PL_sv_objcount; /* XXX Might want something more general */
5383 if (type >= SVt_PVMG) {
5384 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5385 SvREFCNT_dec(SvOURSTASH(sv));
5386 } else if (SvMAGIC(sv))
5388 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5389 SvREFCNT_dec(SvSTASH(sv));
5392 /* case SVt_BIND: */
5395 IoIFP(sv) != PerlIO_stdin() &&
5396 IoIFP(sv) != PerlIO_stdout() &&
5397 IoIFP(sv) != PerlIO_stderr())
5399 io_close((IO*)sv, FALSE);
5401 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5402 PerlDir_close(IoDIRP(sv));
5403 IoDIRP(sv) = (DIR*)NULL;
5404 Safefree(IoTOP_NAME(sv));
5405 Safefree(IoFMT_NAME(sv));
5406 Safefree(IoBOTTOM_NAME(sv));
5409 /* FIXME for plugins */
5410 pregfree2((REGEXP*) sv);
5417 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5421 if (PL_comppad == (AV*)sv) {
5428 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5429 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5430 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5431 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5433 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5434 SvREFCNT_dec(LvTARG(sv));
5436 if (isGV_with_GP(sv)) {
5437 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5438 mro_method_changed_in(stash);
5441 unshare_hek(GvNAME_HEK(sv));
5442 /* If we're in a stash, we don't own a reference to it. However it does
5443 have a back reference to us, which needs to be cleared. */
5444 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5445 sv_del_backref((SV*)stash, sv);
5447 /* FIXME. There are probably more unreferenced pointers to SVs in the
5448 interpreter struct that we should check and tidy in a similar
5450 if ((GV*)sv == PL_last_in_gv)
5451 PL_last_in_gv = NULL;
5457 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5460 SvOOK_offset(sv, offset);
5461 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5462 /* Don't even bother with turning off the OOK flag. */
5465 SV * const target = SvRV(sv);
5467 sv_del_backref(target, sv);
5469 SvREFCNT_dec(target);
5471 #ifdef PERL_OLD_COPY_ON_WRITE
5472 else if (SvPVX_const(sv)) {
5474 /* I believe I need to grab the global SV mutex here and
5475 then recheck the COW status. */
5477 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5481 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5483 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5486 /* And drop it here. */
5488 } else if (SvLEN(sv)) {
5489 Safefree(SvPVX_const(sv));
5493 else if (SvPVX_const(sv) && SvLEN(sv))
5494 Safefree(SvPVX_mutable(sv));
5495 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5496 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5505 SvFLAGS(sv) &= SVf_BREAK;
5506 SvFLAGS(sv) |= SVTYPEMASK;
5508 if (sv_type_details->arena) {
5509 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5510 &PL_body_roots[type]);
5512 else if (sv_type_details->body_size) {
5513 my_safefree(SvANY(sv));
5518 =for apidoc sv_newref
5520 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5527 Perl_sv_newref(pTHX_ SV *sv)
5529 PERL_UNUSED_CONTEXT;
5538 Decrement an SV's reference count, and if it drops to zero, call
5539 C<sv_clear> to invoke destructors and free up any memory used by
5540 the body; finally, deallocate the SV's head itself.
5541 Normally called via a wrapper macro C<SvREFCNT_dec>.
5547 Perl_sv_free(pTHX_ SV *sv)
5552 if (SvREFCNT(sv) == 0) {
5553 if (SvFLAGS(sv) & SVf_BREAK)
5554 /* this SV's refcnt has been artificially decremented to
5555 * trigger cleanup */
5557 if (PL_in_clean_all) /* All is fair */
5559 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5560 /* make sure SvREFCNT(sv)==0 happens very seldom */
5561 SvREFCNT(sv) = (~(U32)0)/2;
5564 if (ckWARN_d(WARN_INTERNAL)) {
5565 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5566 Perl_dump_sv_child(aTHX_ sv);
5568 #ifdef DEBUG_LEAKING_SCALARS
5571 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5572 if (PL_warnhook == PERL_WARNHOOK_FATAL
5573 || ckDEAD(packWARN(WARN_INTERNAL))) {
5574 /* Don't let Perl_warner cause us to escape our fate: */
5578 /* This may not return: */
5579 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5580 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5581 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5584 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5589 if (--(SvREFCNT(sv)) > 0)
5591 Perl_sv_free2(aTHX_ sv);
5595 Perl_sv_free2(pTHX_ SV *sv)
5599 PERL_ARGS_ASSERT_SV_FREE2;
5603 if (ckWARN_d(WARN_DEBUGGING))
5604 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5605 "Attempt to free temp prematurely: SV 0x%"UVxf
5606 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5610 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5611 /* make sure SvREFCNT(sv)==0 happens very seldom */
5612 SvREFCNT(sv) = (~(U32)0)/2;
5623 Returns the length of the string in the SV. Handles magic and type
5624 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5630 Perl_sv_len(pTHX_ register SV *sv)
5638 len = mg_length(sv);
5640 (void)SvPV_const(sv, len);
5645 =for apidoc sv_len_utf8
5647 Returns the number of characters in the string in an SV, counting wide
5648 UTF-8 bytes as a single character. Handles magic and type coercion.
5654 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5655 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5656 * (Note that the mg_len is not the length of the mg_ptr field.
5657 * This allows the cache to store the character length of the string without
5658 * needing to malloc() extra storage to attach to the mg_ptr.)
5663 Perl_sv_len_utf8(pTHX_ register SV *sv)
5669 return mg_length(sv);
5673 const U8 *s = (U8*)SvPV_const(sv, len);
5677 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5679 if (mg && mg->mg_len != -1) {
5681 if (PL_utf8cache < 0) {
5682 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5684 /* Need to turn the assertions off otherwise we may
5685 recurse infinitely while printing error messages.
5687 SAVEI8(PL_utf8cache);
5689 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5690 " real %"UVuf" for %"SVf,
5691 (UV) ulen, (UV) real, SVfARG(sv));
5696 ulen = Perl_utf8_length(aTHX_ s, s + len);
5697 if (!SvREADONLY(sv)) {
5699 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5700 &PL_vtbl_utf8, 0, 0);
5708 return Perl_utf8_length(aTHX_ s, s + len);
5712 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5715 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5718 const U8 *s = start;
5720 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5722 while (s < send && uoffset--)
5725 /* This is the existing behaviour. Possibly it should be a croak, as
5726 it's actually a bounds error */
5732 /* Given the length of the string in both bytes and UTF-8 characters, decide
5733 whether to walk forwards or backwards to find the byte corresponding to
5734 the passed in UTF-8 offset. */
5736 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5737 STRLEN uoffset, STRLEN uend)
5739 STRLEN backw = uend - uoffset;
5741 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5743 if (uoffset < 2 * backw) {
5744 /* The assumption is that going forwards is twice the speed of going
5745 forward (that's where the 2 * backw comes from).
5746 (The real figure of course depends on the UTF-8 data.) */
5747 return sv_pos_u2b_forwards(start, send, uoffset);
5752 while (UTF8_IS_CONTINUATION(*send))
5755 return send - start;
5758 /* For the string representation of the given scalar, find the byte
5759 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5760 give another position in the string, *before* the sought offset, which
5761 (which is always true, as 0, 0 is a valid pair of positions), which should
5762 help reduce the amount of linear searching.
5763 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5764 will be used to reduce the amount of linear searching. The cache will be
5765 created if necessary, and the found value offered to it for update. */
5767 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5768 const U8 *const send, STRLEN uoffset,
5769 STRLEN uoffset0, STRLEN boffset0)
5771 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5774 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5776 assert (uoffset >= uoffset0);
5778 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5779 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5780 if ((*mgp)->mg_ptr) {
5781 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5782 if (cache[0] == uoffset) {
5783 /* An exact match. */
5786 if (cache[2] == uoffset) {
5787 /* An exact match. */
5791 if (cache[0] < uoffset) {
5792 /* The cache already knows part of the way. */
5793 if (cache[0] > uoffset0) {
5794 /* The cache knows more than the passed in pair */
5795 uoffset0 = cache[0];
5796 boffset0 = cache[1];
5798 if ((*mgp)->mg_len != -1) {
5799 /* And we know the end too. */
5801 + sv_pos_u2b_midway(start + boffset0, send,
5803 (*mgp)->mg_len - uoffset0);
5806 + sv_pos_u2b_forwards(start + boffset0,
5807 send, uoffset - uoffset0);
5810 else if (cache[2] < uoffset) {
5811 /* We're between the two cache entries. */
5812 if (cache[2] > uoffset0) {
5813 /* and the cache knows more than the passed in pair */
5814 uoffset0 = cache[2];
5815 boffset0 = cache[3];
5819 + sv_pos_u2b_midway(start + boffset0,
5822 cache[0] - uoffset0);
5825 + sv_pos_u2b_midway(start + boffset0,
5828 cache[2] - uoffset0);
5832 else if ((*mgp)->mg_len != -1) {
5833 /* If we can take advantage of a passed in offset, do so. */
5834 /* In fact, offset0 is either 0, or less than offset, so don't
5835 need to worry about the other possibility. */
5837 + sv_pos_u2b_midway(start + boffset0, send,
5839 (*mgp)->mg_len - uoffset0);
5844 if (!found || PL_utf8cache < 0) {
5845 const STRLEN real_boffset
5846 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5847 send, uoffset - uoffset0);
5849 if (found && PL_utf8cache < 0) {
5850 if (real_boffset != boffset) {
5851 /* Need to turn the assertions off otherwise we may recurse
5852 infinitely while printing error messages. */
5853 SAVEI8(PL_utf8cache);
5855 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5856 " real %"UVuf" for %"SVf,
5857 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5860 boffset = real_boffset;
5863 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5869 =for apidoc sv_pos_u2b
5871 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5872 the start of the string, to a count of the equivalent number of bytes; if
5873 lenp is non-zero, it does the same to lenp, but this time starting from
5874 the offset, rather than from the start of the string. Handles magic and
5881 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5882 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5883 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5888 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5893 PERL_ARGS_ASSERT_SV_POS_U2B;
5898 start = (U8*)SvPV_const(sv, len);
5900 STRLEN uoffset = (STRLEN) *offsetp;
5901 const U8 * const send = start + len;
5903 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5906 *offsetp = (I32) boffset;
5909 /* Convert the relative offset to absolute. */
5910 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5911 const STRLEN boffset2
5912 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5913 uoffset, boffset) - boffset;
5927 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5928 byte length pairing. The (byte) length of the total SV is passed in too,
5929 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5930 may not have updated SvCUR, so we can't rely on reading it directly.
5932 The proffered utf8/byte length pairing isn't used if the cache already has
5933 two pairs, and swapping either for the proffered pair would increase the
5934 RMS of the intervals between known byte offsets.
5936 The cache itself consists of 4 STRLEN values
5937 0: larger UTF-8 offset
5938 1: corresponding byte offset
5939 2: smaller UTF-8 offset
5940 3: corresponding byte offset
5942 Unused cache pairs have the value 0, 0.
5943 Keeping the cache "backwards" means that the invariant of
5944 cache[0] >= cache[2] is maintained even with empty slots, which means that
5945 the code that uses it doesn't need to worry if only 1 entry has actually
5946 been set to non-zero. It also makes the "position beyond the end of the
5947 cache" logic much simpler, as the first slot is always the one to start
5951 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5956 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5962 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5964 (*mgp)->mg_len = -1;
5968 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5969 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5970 (*mgp)->mg_ptr = (char *) cache;
5974 if (PL_utf8cache < 0) {
5975 const U8 *start = (const U8 *) SvPVX_const(sv);
5976 const STRLEN realutf8 = utf8_length(start, start + byte);
5978 if (realutf8 != utf8) {
5979 /* Need to turn the assertions off otherwise we may recurse
5980 infinitely while printing error messages. */
5981 SAVEI8(PL_utf8cache);
5983 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5984 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5988 /* Cache is held with the later position first, to simplify the code
5989 that deals with unbounded ends. */
5991 ASSERT_UTF8_CACHE(cache);
5992 if (cache[1] == 0) {
5993 /* Cache is totally empty */
5996 } else if (cache[3] == 0) {
5997 if (byte > cache[1]) {
5998 /* New one is larger, so goes first. */
5999 cache[2] = cache[0];
6000 cache[3] = cache[1];
6008 #define THREEWAY_SQUARE(a,b,c,d) \
6009 ((float)((d) - (c))) * ((float)((d) - (c))) \
6010 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6011 + ((float)((b) - (a))) * ((float)((b) - (a)))
6013 /* Cache has 2 slots in use, and we know three potential pairs.
6014 Keep the two that give the lowest RMS distance. Do the
6015 calcualation in bytes simply because we always know the byte
6016 length. squareroot has the same ordering as the positive value,
6017 so don't bother with the actual square root. */
6018 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6019 if (byte > cache[1]) {
6020 /* New position is after the existing pair of pairs. */
6021 const float keep_earlier
6022 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6023 const float keep_later
6024 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6026 if (keep_later < keep_earlier) {
6027 if (keep_later < existing) {
6028 cache[2] = cache[0];
6029 cache[3] = cache[1];
6035 if (keep_earlier < existing) {
6041 else if (byte > cache[3]) {
6042 /* New position is between the existing pair of pairs. */
6043 const float keep_earlier
6044 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6045 const float keep_later
6046 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6048 if (keep_later < keep_earlier) {
6049 if (keep_later < existing) {
6055 if (keep_earlier < existing) {
6062 /* New position is before the existing pair of pairs. */
6063 const float keep_earlier
6064 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6065 const float keep_later
6066 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6068 if (keep_later < keep_earlier) {
6069 if (keep_later < existing) {
6075 if (keep_earlier < existing) {
6076 cache[0] = cache[2];
6077 cache[1] = cache[3];
6084 ASSERT_UTF8_CACHE(cache);
6087 /* We already know all of the way, now we may be able to walk back. The same
6088 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6089 backward is half the speed of walking forward. */
6091 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
6094 const STRLEN forw = target - s;
6095 STRLEN backw = end - target;
6097 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6099 if (forw < 2 * backw) {
6100 return utf8_length(s, target);
6103 while (end > target) {
6105 while (UTF8_IS_CONTINUATION(*end)) {
6114 =for apidoc sv_pos_b2u
6116 Converts the value pointed to by offsetp from a count of bytes from the
6117 start of the string, to a count of the equivalent number of UTF-8 chars.
6118 Handles magic and type coercion.
6124 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6125 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6130 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6133 const STRLEN byte = *offsetp;
6134 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6140 PERL_ARGS_ASSERT_SV_POS_B2U;
6145 s = (const U8*)SvPV_const(sv, blen);
6148 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6152 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6153 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6155 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6156 if (cache[1] == byte) {
6157 /* An exact match. */
6158 *offsetp = cache[0];
6161 if (cache[3] == byte) {
6162 /* An exact match. */
6163 *offsetp = cache[2];
6167 if (cache[1] < byte) {
6168 /* We already know part of the way. */
6169 if (mg->mg_len != -1) {
6170 /* Actually, we know the end too. */
6172 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6173 s + blen, mg->mg_len - cache[0]);
6175 len = cache[0] + utf8_length(s + cache[1], send);
6178 else if (cache[3] < byte) {
6179 /* We're between the two cached pairs, so we do the calculation
6180 offset by the byte/utf-8 positions for the earlier pair,
6181 then add the utf-8 characters from the string start to
6183 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6184 s + cache[1], cache[0] - cache[2])
6188 else { /* cache[3] > byte */
6189 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6193 ASSERT_UTF8_CACHE(cache);
6195 } else if (mg->mg_len != -1) {
6196 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6200 if (!found || PL_utf8cache < 0) {
6201 const STRLEN real_len = utf8_length(s, send);
6203 if (found && PL_utf8cache < 0) {
6204 if (len != real_len) {
6205 /* Need to turn the assertions off otherwise we may recurse
6206 infinitely while printing error messages. */
6207 SAVEI8(PL_utf8cache);
6209 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6210 " real %"UVuf" for %"SVf,
6211 (UV) len, (UV) real_len, SVfARG(sv));
6218 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6224 Returns a boolean indicating whether the strings in the two SVs are
6225 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6226 coerce its args to strings if necessary.
6232 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6241 SV* svrecode = NULL;
6248 /* if pv1 and pv2 are the same, second SvPV_const call may
6249 * invalidate pv1, so we may need to make a copy */
6250 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6251 pv1 = SvPV_const(sv1, cur1);
6252 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6254 pv1 = SvPV_const(sv1, cur1);
6262 pv2 = SvPV_const(sv2, cur2);
6264 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6265 /* Differing utf8ness.
6266 * Do not UTF8size the comparands as a side-effect. */
6269 svrecode = newSVpvn(pv2, cur2);
6270 sv_recode_to_utf8(svrecode, PL_encoding);
6271 pv2 = SvPV_const(svrecode, cur2);
6274 svrecode = newSVpvn(pv1, cur1);
6275 sv_recode_to_utf8(svrecode, PL_encoding);
6276 pv1 = SvPV_const(svrecode, cur1);
6278 /* Now both are in UTF-8. */
6280 SvREFCNT_dec(svrecode);
6285 bool is_utf8 = TRUE;
6288 /* sv1 is the UTF-8 one,
6289 * if is equal it must be downgrade-able */
6290 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6296 /* sv2 is the UTF-8 one,
6297 * if is equal it must be downgrade-able */
6298 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6304 /* Downgrade not possible - cannot be eq */
6312 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6314 SvREFCNT_dec(svrecode);
6324 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6325 string in C<sv1> is less than, equal to, or greater than the string in
6326 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6327 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6333 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6337 const char *pv1, *pv2;
6340 SV *svrecode = NULL;
6347 pv1 = SvPV_const(sv1, cur1);
6354 pv2 = SvPV_const(sv2, cur2);
6356 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6357 /* Differing utf8ness.
6358 * Do not UTF8size the comparands as a side-effect. */
6361 svrecode = newSVpvn(pv2, cur2);
6362 sv_recode_to_utf8(svrecode, PL_encoding);
6363 pv2 = SvPV_const(svrecode, cur2);
6366 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6371 svrecode = newSVpvn(pv1, cur1);
6372 sv_recode_to_utf8(svrecode, PL_encoding);
6373 pv1 = SvPV_const(svrecode, cur1);
6376 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6382 cmp = cur2 ? -1 : 0;
6386 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6389 cmp = retval < 0 ? -1 : 1;
6390 } else if (cur1 == cur2) {
6393 cmp = cur1 < cur2 ? -1 : 1;
6397 SvREFCNT_dec(svrecode);
6405 =for apidoc sv_cmp_locale
6407 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6408 'use bytes' aware, handles get magic, and will coerce its args to strings
6409 if necessary. See also C<sv_cmp>.
6415 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6418 #ifdef USE_LOCALE_COLLATE
6424 if (PL_collation_standard)
6428 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6430 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6432 if (!pv1 || !len1) {
6443 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6446 return retval < 0 ? -1 : 1;
6449 * When the result of collation is equality, that doesn't mean
6450 * that there are no differences -- some locales exclude some
6451 * characters from consideration. So to avoid false equalities,
6452 * we use the raw string as a tiebreaker.
6458 #endif /* USE_LOCALE_COLLATE */
6460 return sv_cmp(sv1, sv2);
6464 #ifdef USE_LOCALE_COLLATE
6467 =for apidoc sv_collxfrm
6469 Add Collate Transform magic to an SV if it doesn't already have it.
6471 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6472 scalar data of the variable, but transformed to such a format that a normal
6473 memory comparison can be used to compare the data according to the locale
6480 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6485 PERL_ARGS_ASSERT_SV_COLLXFRM;
6487 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6488 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6494 Safefree(mg->mg_ptr);
6495 s = SvPV_const(sv, len);
6496 if ((xf = mem_collxfrm(s, len, &xlen))) {
6497 if (SvREADONLY(sv)) {
6500 return xf + sizeof(PL_collation_ix);
6503 #ifdef PERL_OLD_COPY_ON_WRITE
6505 sv_force_normal_flags(sv, 0);
6507 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6521 if (mg && mg->mg_ptr) {
6523 return mg->mg_ptr + sizeof(PL_collation_ix);
6531 #endif /* USE_LOCALE_COLLATE */
6536 Get a line from the filehandle and store it into the SV, optionally
6537 appending to the currently-stored string.
6543 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6548 register STDCHAR rslast;
6549 register STDCHAR *bp;
6554 PERL_ARGS_ASSERT_SV_GETS;
6556 if (SvTHINKFIRST(sv))
6557 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6558 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6560 However, perlbench says it's slower, because the existing swipe code
6561 is faster than copy on write.
6562 Swings and roundabouts. */
6563 SvUPGRADE(sv, SVt_PV);
6568 if (PerlIO_isutf8(fp)) {
6570 sv_utf8_upgrade_nomg(sv);
6571 sv_pos_u2b(sv,&append,0);
6573 } else if (SvUTF8(sv)) {
6574 SV * const tsv = newSV(0);
6575 sv_gets(tsv, fp, 0);
6576 sv_utf8_upgrade_nomg(tsv);
6577 SvCUR_set(sv,append);
6580 goto return_string_or_null;
6585 if (PerlIO_isutf8(fp))
6588 if (IN_PERL_COMPILETIME) {
6589 /* we always read code in line mode */
6593 else if (RsSNARF(PL_rs)) {
6594 /* If it is a regular disk file use size from stat() as estimate
6595 of amount we are going to read -- may result in mallocing
6596 more memory than we really need if the layers below reduce
6597 the size we read (e.g. CRLF or a gzip layer).
6600 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6601 const Off_t offset = PerlIO_tell(fp);
6602 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6603 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6609 else if (RsRECORD(PL_rs)) {
6614 /* Grab the size of the record we're getting */
6615 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6616 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6619 /* VMS wants read instead of fread, because fread doesn't respect */
6620 /* RMS record boundaries. This is not necessarily a good thing to be */
6621 /* doing, but we've got no other real choice - except avoid stdio
6622 as implementation - perhaps write a :vms layer ?
6624 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6626 bytesread = PerlIO_read(fp, buffer, recsize);
6630 SvCUR_set(sv, bytesread += append);
6631 buffer[bytesread] = '\0';
6632 goto return_string_or_null;
6634 else if (RsPARA(PL_rs)) {
6640 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6641 if (PerlIO_isutf8(fp)) {
6642 rsptr = SvPVutf8(PL_rs, rslen);
6645 if (SvUTF8(PL_rs)) {
6646 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6647 Perl_croak(aTHX_ "Wide character in $/");
6650 rsptr = SvPV_const(PL_rs, rslen);
6654 rslast = rslen ? rsptr[rslen - 1] : '\0';
6656 if (rspara) { /* have to do this both before and after */
6657 do { /* to make sure file boundaries work right */
6660 i = PerlIO_getc(fp);
6664 PerlIO_ungetc(fp,i);
6670 /* See if we know enough about I/O mechanism to cheat it ! */
6672 /* This used to be #ifdef test - it is made run-time test for ease
6673 of abstracting out stdio interface. One call should be cheap
6674 enough here - and may even be a macro allowing compile
6678 if (PerlIO_fast_gets(fp)) {
6681 * We're going to steal some values from the stdio struct
6682 * and put EVERYTHING in the innermost loop into registers.
6684 register STDCHAR *ptr;
6688 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6689 /* An ungetc()d char is handled separately from the regular
6690 * buffer, so we getc() it back out and stuff it in the buffer.
6692 i = PerlIO_getc(fp);
6693 if (i == EOF) return 0;
6694 *(--((*fp)->_ptr)) = (unsigned char) i;
6698 /* Here is some breathtakingly efficient cheating */
6700 cnt = PerlIO_get_cnt(fp); /* get count into register */
6701 /* make sure we have the room */
6702 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6703 /* Not room for all of it
6704 if we are looking for a separator and room for some
6706 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6707 /* just process what we have room for */
6708 shortbuffered = cnt - SvLEN(sv) + append + 1;
6709 cnt -= shortbuffered;
6713 /* remember that cnt can be negative */
6714 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6719 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6720 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6721 DEBUG_P(PerlIO_printf(Perl_debug_log,
6722 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6723 DEBUG_P(PerlIO_printf(Perl_debug_log,
6724 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6725 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6726 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6731 while (cnt > 0) { /* this | eat */
6733 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6734 goto thats_all_folks; /* screams | sed :-) */
6738 Copy(ptr, bp, cnt, char); /* this | eat */
6739 bp += cnt; /* screams | dust */
6740 ptr += cnt; /* louder | sed :-) */
6745 if (shortbuffered) { /* oh well, must extend */
6746 cnt = shortbuffered;
6748 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6750 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6751 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6755 DEBUG_P(PerlIO_printf(Perl_debug_log,
6756 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6757 PTR2UV(ptr),(long)cnt));
6758 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6760 DEBUG_P(PerlIO_printf(Perl_debug_log,
6761 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6762 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6763 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6765 /* This used to call 'filbuf' in stdio form, but as that behaves like
6766 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6767 another abstraction. */
6768 i = PerlIO_getc(fp); /* get more characters */
6770 DEBUG_P(PerlIO_printf(Perl_debug_log,
6771 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6772 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6773 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6775 cnt = PerlIO_get_cnt(fp);
6776 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6777 DEBUG_P(PerlIO_printf(Perl_debug_log,
6778 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6780 if (i == EOF) /* all done for ever? */
6781 goto thats_really_all_folks;
6783 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6785 SvGROW(sv, bpx + cnt + 2);
6786 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6788 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6790 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6791 goto thats_all_folks;
6795 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6796 memNE((char*)bp - rslen, rsptr, rslen))
6797 goto screamer; /* go back to the fray */
6798 thats_really_all_folks:
6800 cnt += shortbuffered;
6801 DEBUG_P(PerlIO_printf(Perl_debug_log,
6802 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6803 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6804 DEBUG_P(PerlIO_printf(Perl_debug_log,
6805 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6806 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6807 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6809 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6810 DEBUG_P(PerlIO_printf(Perl_debug_log,
6811 "Screamer: done, len=%ld, string=|%.*s|\n",
6812 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6816 /*The big, slow, and stupid way. */
6817 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6818 STDCHAR *buf = NULL;
6819 Newx(buf, 8192, STDCHAR);
6827 register const STDCHAR * const bpe = buf + sizeof(buf);
6829 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6830 ; /* keep reading */
6834 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6835 /* Accomodate broken VAXC compiler, which applies U8 cast to
6836 * both args of ?: operator, causing EOF to change into 255
6839 i = (U8)buf[cnt - 1];
6845 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6847 sv_catpvn(sv, (char *) buf, cnt);
6849 sv_setpvn(sv, (char *) buf, cnt);
6851 if (i != EOF && /* joy */
6853 SvCUR(sv) < rslen ||
6854 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6858 * If we're reading from a TTY and we get a short read,
6859 * indicating that the user hit his EOF character, we need
6860 * to notice it now, because if we try to read from the TTY
6861 * again, the EOF condition will disappear.
6863 * The comparison of cnt to sizeof(buf) is an optimization
6864 * that prevents unnecessary calls to feof().
6868 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6872 #ifdef USE_HEAP_INSTEAD_OF_STACK
6877 if (rspara) { /* have to do this both before and after */
6878 while (i != EOF) { /* to make sure file boundaries work right */
6879 i = PerlIO_getc(fp);
6881 PerlIO_ungetc(fp,i);
6887 return_string_or_null:
6888 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6894 Auto-increment of the value in the SV, doing string to numeric conversion
6895 if necessary. Handles 'get' magic.
6901 Perl_sv_inc(pTHX_ register SV *sv)
6910 if (SvTHINKFIRST(sv)) {
6912 sv_force_normal_flags(sv, 0);
6913 if (SvREADONLY(sv)) {
6914 if (IN_PERL_RUNTIME)
6915 Perl_croak(aTHX_ PL_no_modify);
6919 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6921 i = PTR2IV(SvRV(sv));
6926 flags = SvFLAGS(sv);
6927 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6928 /* It's (privately or publicly) a float, but not tested as an
6929 integer, so test it to see. */
6931 flags = SvFLAGS(sv);
6933 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6934 /* It's publicly an integer, or privately an integer-not-float */
6935 #ifdef PERL_PRESERVE_IVUV
6939 if (SvUVX(sv) == UV_MAX)
6940 sv_setnv(sv, UV_MAX_P1);
6942 (void)SvIOK_only_UV(sv);
6943 SvUV_set(sv, SvUVX(sv) + 1);
6945 if (SvIVX(sv) == IV_MAX)
6946 sv_setuv(sv, (UV)IV_MAX + 1);
6948 (void)SvIOK_only(sv);
6949 SvIV_set(sv, SvIVX(sv) + 1);
6954 if (flags & SVp_NOK) {
6955 const NV was = SvNVX(sv);
6956 if (NV_OVERFLOWS_INTEGERS_AT &&
6957 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6958 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6959 "Lost precision when incrementing %" NVff " by 1",
6962 (void)SvNOK_only(sv);
6963 SvNV_set(sv, was + 1.0);
6967 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6968 if ((flags & SVTYPEMASK) < SVt_PVIV)
6969 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6970 (void)SvIOK_only(sv);
6975 while (isALPHA(*d)) d++;
6976 while (isDIGIT(*d)) d++;
6978 #ifdef PERL_PRESERVE_IVUV
6979 /* Got to punt this as an integer if needs be, but we don't issue
6980 warnings. Probably ought to make the sv_iv_please() that does
6981 the conversion if possible, and silently. */
6982 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6983 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6984 /* Need to try really hard to see if it's an integer.
6985 9.22337203685478e+18 is an integer.
6986 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6987 so $a="9.22337203685478e+18"; $a+0; $a++
6988 needs to be the same as $a="9.22337203685478e+18"; $a++
6995 /* sv_2iv *should* have made this an NV */
6996 if (flags & SVp_NOK) {
6997 (void)SvNOK_only(sv);
6998 SvNV_set(sv, SvNVX(sv) + 1.0);
7001 /* I don't think we can get here. Maybe I should assert this
7002 And if we do get here I suspect that sv_setnv will croak. NWC
7004 #if defined(USE_LONG_DOUBLE)
7005 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",
7006 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7008 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7009 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7012 #endif /* PERL_PRESERVE_IVUV */
7013 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7017 while (d >= SvPVX_const(sv)) {
7025 /* MKS: The original code here died if letters weren't consecutive.
7026 * at least it didn't have to worry about non-C locales. The
7027 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7028 * arranged in order (although not consecutively) and that only
7029 * [A-Za-z] are accepted by isALPHA in the C locale.
7031 if (*d != 'z' && *d != 'Z') {
7032 do { ++*d; } while (!isALPHA(*d));
7035 *(d--) -= 'z' - 'a';
7040 *(d--) -= 'z' - 'a' + 1;
7044 /* oh,oh, the number grew */
7045 SvGROW(sv, SvCUR(sv) + 2);
7046 SvCUR_set(sv, SvCUR(sv) + 1);
7047 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7058 Auto-decrement of the value in the SV, doing string to numeric conversion
7059 if necessary. Handles 'get' magic.
7065 Perl_sv_dec(pTHX_ register SV *sv)
7073 if (SvTHINKFIRST(sv)) {
7075 sv_force_normal_flags(sv, 0);
7076 if (SvREADONLY(sv)) {
7077 if (IN_PERL_RUNTIME)
7078 Perl_croak(aTHX_ PL_no_modify);
7082 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7084 i = PTR2IV(SvRV(sv));
7089 /* Unlike sv_inc we don't have to worry about string-never-numbers
7090 and keeping them magic. But we mustn't warn on punting */
7091 flags = SvFLAGS(sv);
7092 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7093 /* It's publicly an integer, or privately an integer-not-float */
7094 #ifdef PERL_PRESERVE_IVUV
7098 if (SvUVX(sv) == 0) {
7099 (void)SvIOK_only(sv);
7103 (void)SvIOK_only_UV(sv);
7104 SvUV_set(sv, SvUVX(sv) - 1);
7107 if (SvIVX(sv) == IV_MIN) {
7108 sv_setnv(sv, (NV)IV_MIN);
7112 (void)SvIOK_only(sv);
7113 SvIV_set(sv, SvIVX(sv) - 1);
7118 if (flags & SVp_NOK) {
7121 const NV was = SvNVX(sv);
7122 if (NV_OVERFLOWS_INTEGERS_AT &&
7123 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7124 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7125 "Lost precision when decrementing %" NVff " by 1",
7128 (void)SvNOK_only(sv);
7129 SvNV_set(sv, was - 1.0);
7133 if (!(flags & SVp_POK)) {
7134 if ((flags & SVTYPEMASK) < SVt_PVIV)
7135 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7137 (void)SvIOK_only(sv);
7140 #ifdef PERL_PRESERVE_IVUV
7142 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7143 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7144 /* Need to try really hard to see if it's an integer.
7145 9.22337203685478e+18 is an integer.
7146 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7147 so $a="9.22337203685478e+18"; $a+0; $a--
7148 needs to be the same as $a="9.22337203685478e+18"; $a--
7155 /* sv_2iv *should* have made this an NV */
7156 if (flags & SVp_NOK) {
7157 (void)SvNOK_only(sv);
7158 SvNV_set(sv, SvNVX(sv) - 1.0);
7161 /* I don't think we can get here. Maybe I should assert this
7162 And if we do get here I suspect that sv_setnv will croak. NWC
7164 #if defined(USE_LONG_DOUBLE)
7165 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",
7166 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7168 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7169 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7173 #endif /* PERL_PRESERVE_IVUV */
7174 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7178 =for apidoc sv_mortalcopy
7180 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7181 The new SV is marked as mortal. It will be destroyed "soon", either by an
7182 explicit call to FREETMPS, or by an implicit call at places such as
7183 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7188 /* Make a string that will exist for the duration of the expression
7189 * evaluation. Actually, it may have to last longer than that, but
7190 * hopefully we won't free it until it has been assigned to a
7191 * permanent location. */
7194 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7200 sv_setsv(sv,oldstr);
7202 PL_tmps_stack[++PL_tmps_ix] = sv;
7208 =for apidoc sv_newmortal
7210 Creates a new null SV which is mortal. The reference count of the SV is
7211 set to 1. It will be destroyed "soon", either by an explicit call to
7212 FREETMPS, or by an implicit call at places such as statement boundaries.
7213 See also C<sv_mortalcopy> and C<sv_2mortal>.
7219 Perl_sv_newmortal(pTHX)
7225 SvFLAGS(sv) = SVs_TEMP;
7227 PL_tmps_stack[++PL_tmps_ix] = sv;
7233 =for apidoc newSVpvn_flags
7235 Creates a new SV and copies a string into it. The reference count for the
7236 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7237 string. You are responsible for ensuring that the source string is at least
7238 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7239 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7240 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7241 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7242 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7244 #define newSVpvn_utf8(s, len, u) \
7245 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7251 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7256 /* All the flags we don't support must be zero.
7257 And we're new code so I'm going to assert this from the start. */
7258 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7260 sv_setpvn(sv,s,len);
7261 SvFLAGS(sv) |= (flags & SVf_UTF8);
7262 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7266 =for apidoc sv_2mortal
7268 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7269 by an explicit call to FREETMPS, or by an implicit call at places such as
7270 statement boundaries. SvTEMP() is turned on which means that the SV's
7271 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7272 and C<sv_mortalcopy>.
7278 Perl_sv_2mortal(pTHX_ register SV *sv)
7283 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7286 PL_tmps_stack[++PL_tmps_ix] = sv;
7294 Creates a new SV and copies a string into it. The reference count for the
7295 SV is set to 1. If C<len> is zero, Perl will compute the length using
7296 strlen(). For efficiency, consider using C<newSVpvn> instead.
7302 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7308 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7313 =for apidoc newSVpvn
7315 Creates a new SV and copies a string into it. The reference count for the
7316 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7317 string. You are responsible for ensuring that the source string is at least
7318 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7324 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7330 sv_setpvn(sv,s,len);
7335 =for apidoc newSVhek
7337 Creates a new SV from the hash key structure. It will generate scalars that
7338 point to the shared string table where possible. Returns a new (undefined)
7339 SV if the hek is NULL.
7345 Perl_newSVhek(pTHX_ const HEK *hek)
7355 if (HEK_LEN(hek) == HEf_SVKEY) {
7356 return newSVsv(*(SV**)HEK_KEY(hek));
7358 const int flags = HEK_FLAGS(hek);
7359 if (flags & HVhek_WASUTF8) {
7361 Andreas would like keys he put in as utf8 to come back as utf8
7363 STRLEN utf8_len = HEK_LEN(hek);
7364 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7365 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7368 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7370 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7371 /* We don't have a pointer to the hv, so we have to replicate the
7372 flag into every HEK. This hv is using custom a hasing
7373 algorithm. Hence we can't return a shared string scalar, as
7374 that would contain the (wrong) hash value, and might get passed
7375 into an hv routine with a regular hash.
7376 Similarly, a hash that isn't using shared hash keys has to have
7377 the flag in every key so that we know not to try to call
7378 share_hek_kek on it. */
7380 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7385 /* This will be overwhelminly the most common case. */
7387 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7388 more efficient than sharepvn(). */
7392 sv_upgrade(sv, SVt_PV);
7393 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7394 SvCUR_set(sv, HEK_LEN(hek));
7407 =for apidoc newSVpvn_share
7409 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7410 table. If the string does not already exist in the table, it is created
7411 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7412 value is used; otherwise the hash is computed. The string's hash can be later
7413 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7414 that as the string table is used for shared hash keys these strings will have
7415 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7421 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7425 bool is_utf8 = FALSE;
7426 const char *const orig_src = src;
7429 STRLEN tmplen = -len;
7431 /* See the note in hv.c:hv_fetch() --jhi */
7432 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7436 PERL_HASH(hash, src, len);
7438 sv_upgrade(sv, SVt_PV);
7439 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7447 if (src != orig_src)
7453 #if defined(PERL_IMPLICIT_CONTEXT)
7455 /* pTHX_ magic can't cope with varargs, so this is a no-context
7456 * version of the main function, (which may itself be aliased to us).
7457 * Don't access this version directly.
7461 Perl_newSVpvf_nocontext(const char* pat, ...)
7467 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7469 va_start(args, pat);
7470 sv = vnewSVpvf(pat, &args);
7477 =for apidoc newSVpvf
7479 Creates a new SV and initializes it with the string formatted like
7486 Perl_newSVpvf(pTHX_ const char* pat, ...)
7491 PERL_ARGS_ASSERT_NEWSVPVF;
7493 va_start(args, pat);
7494 sv = vnewSVpvf(pat, &args);
7499 /* backend for newSVpvf() and newSVpvf_nocontext() */
7502 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7507 PERL_ARGS_ASSERT_VNEWSVPVF;
7510 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7517 Creates a new SV and copies a floating point value into it.
7518 The reference count for the SV is set to 1.
7524 Perl_newSVnv(pTHX_ NV n)
7537 Creates a new SV and copies an integer into it. The reference count for the
7544 Perl_newSViv(pTHX_ IV i)
7557 Creates a new SV and copies an unsigned integer into it.
7558 The reference count for the SV is set to 1.
7564 Perl_newSVuv(pTHX_ UV u)
7575 =for apidoc newSV_type
7577 Creates a new SV, of the type specified. The reference count for the new SV
7584 Perl_newSV_type(pTHX_ const svtype type)
7589 sv_upgrade(sv, type);
7594 =for apidoc newRV_noinc
7596 Creates an RV wrapper for an SV. The reference count for the original
7597 SV is B<not> incremented.
7603 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7606 register SV *sv = newSV_type(SVt_IV);
7608 PERL_ARGS_ASSERT_NEWRV_NOINC;
7611 SvRV_set(sv, tmpRef);
7616 /* newRV_inc is the official function name to use now.
7617 * newRV_inc is in fact #defined to newRV in sv.h
7621 Perl_newRV(pTHX_ SV *sv)
7625 PERL_ARGS_ASSERT_NEWRV;
7627 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7633 Creates a new SV which is an exact duplicate of the original SV.
7640 Perl_newSVsv(pTHX_ register SV *old)
7647 if (SvTYPE(old) == SVTYPEMASK) {
7648 if (ckWARN_d(WARN_INTERNAL))
7649 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7653 /* SV_GMAGIC is the default for sv_setv()
7654 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7655 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7656 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7661 =for apidoc sv_reset
7663 Underlying implementation for the C<reset> Perl function.
7664 Note that the perl-level function is vaguely deprecated.
7670 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7673 char todo[PERL_UCHAR_MAX+1];
7675 PERL_ARGS_ASSERT_SV_RESET;
7680 if (!*s) { /* reset ?? searches */
7681 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7683 const U32 count = mg->mg_len / sizeof(PMOP**);
7684 PMOP **pmp = (PMOP**) mg->mg_ptr;
7685 PMOP *const *const end = pmp + count;
7689 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7691 (*pmp)->op_pmflags &= ~PMf_USED;
7699 /* reset variables */
7701 if (!HvARRAY(stash))
7704 Zero(todo, 256, char);
7707 I32 i = (unsigned char)*s;
7711 max = (unsigned char)*s++;
7712 for ( ; i <= max; i++) {
7715 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7717 for (entry = HvARRAY(stash)[i];
7719 entry = HeNEXT(entry))
7724 if (!todo[(U8)*HeKEY(entry)])
7726 gv = (GV*)HeVAL(entry);
7729 if (SvTHINKFIRST(sv)) {
7730 if (!SvREADONLY(sv) && SvROK(sv))
7732 /* XXX Is this continue a bug? Why should THINKFIRST
7733 exempt us from resetting arrays and hashes? */
7737 if (SvTYPE(sv) >= SVt_PV) {
7739 if (SvPVX_const(sv) != NULL)
7747 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7749 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7752 # if defined(USE_ENVIRON_ARRAY)
7755 # endif /* USE_ENVIRON_ARRAY */
7766 Using various gambits, try to get an IO from an SV: the IO slot if its a
7767 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7768 named after the PV if we're a string.
7774 Perl_sv_2io(pTHX_ SV *sv)
7779 PERL_ARGS_ASSERT_SV_2IO;
7781 switch (SvTYPE(sv)) {
7789 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7793 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7795 return sv_2io(SvRV(sv));
7796 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7802 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7811 Using various gambits, try to get a CV from an SV; in addition, try if
7812 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7813 The flags in C<lref> are passed to sv_fetchsv.
7819 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7825 PERL_ARGS_ASSERT_SV_2CV;
7832 switch (SvTYPE(sv)) {
7851 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7852 tryAMAGICunDEREF(to_cv);
7855 if (SvTYPE(sv) == SVt_PVCV) {
7864 Perl_croak(aTHX_ "Not a subroutine reference");
7869 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7875 /* Some flags to gv_fetchsv mean don't really create the GV */
7876 if (SvTYPE(gv) != SVt_PVGV) {
7882 if (lref && !GvCVu(gv)) {
7886 gv_efullname3(tmpsv, gv, NULL);
7887 /* XXX this is probably not what they think they're getting.
7888 * It has the same effect as "sub name;", i.e. just a forward
7890 newSUB(start_subparse(FALSE, 0),
7891 newSVOP(OP_CONST, 0, tmpsv),
7895 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7905 Returns true if the SV has a true value by Perl's rules.
7906 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7907 instead use an in-line version.
7913 Perl_sv_true(pTHX_ register SV *sv)
7918 register const XPV* const tXpv = (XPV*)SvANY(sv);
7920 (tXpv->xpv_cur > 1 ||
7921 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7928 return SvIVX(sv) != 0;
7931 return SvNVX(sv) != 0.0;
7933 return sv_2bool(sv);
7939 =for apidoc sv_pvn_force
7941 Get a sensible string out of the SV somehow.
7942 A private implementation of the C<SvPV_force> macro for compilers which
7943 can't cope with complex macro expressions. Always use the macro instead.
7945 =for apidoc sv_pvn_force_flags
7947 Get a sensible string out of the SV somehow.
7948 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7949 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7950 implemented in terms of this function.
7951 You normally want to use the various wrapper macros instead: see
7952 C<SvPV_force> and C<SvPV_force_nomg>
7958 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7962 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7964 if (SvTHINKFIRST(sv) && !SvROK(sv))
7965 sv_force_normal_flags(sv, 0);
7975 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7976 const char * const ref = sv_reftype(sv,0);
7978 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7979 ref, OP_NAME(PL_op));
7981 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7983 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7984 || isGV_with_GP(sv))
7985 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7987 s = sv_2pv_flags(sv, &len, flags);
7991 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7994 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7995 SvGROW(sv, len + 1);
7996 Move(s,SvPVX(sv),len,char);
7998 SvPVX(sv)[len] = '\0';
8001 SvPOK_on(sv); /* validate pointer */
8003 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8004 PTR2UV(sv),SvPVX_const(sv)));
8007 return SvPVX_mutable(sv);
8011 =for apidoc sv_pvbyten_force
8013 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8019 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8021 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8023 sv_pvn_force(sv,lp);
8024 sv_utf8_downgrade(sv,0);
8030 =for apidoc sv_pvutf8n_force
8032 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8038 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8040 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8042 sv_pvn_force(sv,lp);
8043 sv_utf8_upgrade(sv);
8049 =for apidoc sv_reftype
8051 Returns a string describing what the SV is a reference to.
8057 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8059 PERL_ARGS_ASSERT_SV_REFTYPE;
8061 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8062 inside return suggests a const propagation bug in g++. */
8063 if (ob && SvOBJECT(sv)) {
8064 char * const name = HvNAME_get(SvSTASH(sv));
8065 return name ? name : (char *) "__ANON__";
8068 switch (SvTYPE(sv)) {
8083 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8084 /* tied lvalues should appear to be
8085 * scalars for backwards compatitbility */
8086 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8087 ? "SCALAR" : "LVALUE");
8088 case SVt_PVAV: return "ARRAY";
8089 case SVt_PVHV: return "HASH";
8090 case SVt_PVCV: return "CODE";
8091 case SVt_PVGV: return "GLOB";
8092 case SVt_PVFM: return "FORMAT";
8093 case SVt_PVIO: return "IO";
8094 case SVt_BIND: return "BIND";
8095 case SVt_REGEXP: return "REGEXP";
8096 default: return "UNKNOWN";
8102 =for apidoc sv_isobject
8104 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8105 object. If the SV is not an RV, or if the object is not blessed, then this
8112 Perl_sv_isobject(pTHX_ SV *sv)
8128 Returns a boolean indicating whether the SV is blessed into the specified
8129 class. This does not check for subtypes; use C<sv_derived_from> to verify
8130 an inheritance relationship.
8136 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8140 PERL_ARGS_ASSERT_SV_ISA;
8150 hvname = HvNAME_get(SvSTASH(sv));
8154 return strEQ(hvname, name);
8160 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8161 it will be upgraded to one. If C<classname> is non-null then the new SV will
8162 be blessed in the specified package. The new SV is returned and its
8163 reference count is 1.
8169 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8174 PERL_ARGS_ASSERT_NEWSVRV;
8178 SV_CHECK_THINKFIRST_COW_DROP(rv);
8179 (void)SvAMAGIC_off(rv);
8181 if (SvTYPE(rv) >= SVt_PVMG) {
8182 const U32 refcnt = SvREFCNT(rv);
8186 SvREFCNT(rv) = refcnt;
8188 sv_upgrade(rv, SVt_IV);
8189 } else if (SvROK(rv)) {
8190 SvREFCNT_dec(SvRV(rv));
8192 prepare_SV_for_RV(rv);
8200 HV* const stash = gv_stashpv(classname, GV_ADD);
8201 (void)sv_bless(rv, stash);
8207 =for apidoc sv_setref_pv
8209 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8210 argument will be upgraded to an RV. That RV will be modified to point to
8211 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8212 into the SV. The C<classname> argument indicates the package for the
8213 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8214 will have a reference count of 1, and the RV will be returned.
8216 Do not use with other Perl types such as HV, AV, SV, CV, because those
8217 objects will become corrupted by the pointer copy process.
8219 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8225 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8229 PERL_ARGS_ASSERT_SV_SETREF_PV;
8232 sv_setsv(rv, &PL_sv_undef);
8236 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8241 =for apidoc sv_setref_iv
8243 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8244 argument will be upgraded to an RV. That RV will be modified to point to
8245 the new SV. The C<classname> argument indicates the package for the
8246 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8247 will have a reference count of 1, and the RV will be returned.
8253 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8255 PERL_ARGS_ASSERT_SV_SETREF_IV;
8257 sv_setiv(newSVrv(rv,classname), iv);
8262 =for apidoc sv_setref_uv
8264 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8265 argument will be upgraded to an RV. That RV will be modified to point to
8266 the new SV. The C<classname> argument indicates the package for the
8267 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8268 will have a reference count of 1, and the RV will be returned.
8274 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8276 PERL_ARGS_ASSERT_SV_SETREF_UV;
8278 sv_setuv(newSVrv(rv,classname), uv);
8283 =for apidoc sv_setref_nv
8285 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8286 argument will be upgraded to an RV. That RV will be modified to point to
8287 the new SV. The C<classname> argument indicates the package for the
8288 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8289 will have a reference count of 1, and the RV will be returned.
8295 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8297 PERL_ARGS_ASSERT_SV_SETREF_NV;
8299 sv_setnv(newSVrv(rv,classname), nv);
8304 =for apidoc sv_setref_pvn
8306 Copies a string into a new SV, optionally blessing the SV. The length of the
8307 string must be specified with C<n>. The C<rv> argument will be upgraded to
8308 an RV. That RV will be modified to point to the new SV. The C<classname>
8309 argument indicates the package for the blessing. Set C<classname> to
8310 C<NULL> to avoid the blessing. The new SV will have a reference count
8311 of 1, and the RV will be returned.
8313 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8319 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8321 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8323 sv_setpvn(newSVrv(rv,classname), pv, n);
8328 =for apidoc sv_bless
8330 Blesses an SV into a specified package. The SV must be an RV. The package
8331 must be designated by its stash (see C<gv_stashpv()>). The reference count
8332 of the SV is unaffected.
8338 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8343 PERL_ARGS_ASSERT_SV_BLESS;
8346 Perl_croak(aTHX_ "Can't bless non-reference value");
8348 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8349 if (SvIsCOW(tmpRef))
8350 sv_force_normal_flags(tmpRef, 0);
8351 if (SvREADONLY(tmpRef))
8352 Perl_croak(aTHX_ PL_no_modify);
8353 if (SvOBJECT(tmpRef)) {
8354 if (SvTYPE(tmpRef) != SVt_PVIO)
8356 SvREFCNT_dec(SvSTASH(tmpRef));
8359 SvOBJECT_on(tmpRef);
8360 if (SvTYPE(tmpRef) != SVt_PVIO)
8362 SvUPGRADE(tmpRef, SVt_PVMG);
8363 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8368 (void)SvAMAGIC_off(sv);
8370 if(SvSMAGICAL(tmpRef))
8371 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8379 /* Downgrades a PVGV to a PVMG.
8383 S_sv_unglob(pTHX_ SV *sv)
8388 SV * const temp = sv_newmortal();
8390 PERL_ARGS_ASSERT_SV_UNGLOB;
8392 assert(SvTYPE(sv) == SVt_PVGV);
8394 gv_efullname3(temp, (GV *) sv, "*");
8397 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8398 mro_method_changed_in(stash);
8402 sv_del_backref((SV*)GvSTASH(sv), sv);
8406 if (GvNAME_HEK(sv)) {
8407 unshare_hek(GvNAME_HEK(sv));
8409 isGV_with_GP_off(sv);
8411 /* need to keep SvANY(sv) in the right arena */
8412 xpvmg = new_XPVMG();
8413 StructCopy(SvANY(sv), xpvmg, XPVMG);
8414 del_XPVGV(SvANY(sv));
8417 SvFLAGS(sv) &= ~SVTYPEMASK;
8418 SvFLAGS(sv) |= SVt_PVMG;
8420 /* Intentionally not calling any local SET magic, as this isn't so much a
8421 set operation as merely an internal storage change. */
8422 sv_setsv_flags(sv, temp, 0);
8426 =for apidoc sv_unref_flags
8428 Unsets the RV status of the SV, and decrements the reference count of
8429 whatever was being referenced by the RV. This can almost be thought of
8430 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8431 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8432 (otherwise the decrementing is conditional on the reference count being
8433 different from one or the reference being a readonly SV).
8440 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8442 SV* const target = SvRV(ref);
8444 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8446 if (SvWEAKREF(ref)) {
8447 sv_del_backref(target, ref);
8449 SvRV_set(ref, NULL);
8452 SvRV_set(ref, NULL);
8454 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8455 assigned to as BEGIN {$a = \"Foo"} will fail. */
8456 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8457 SvREFCNT_dec(target);
8458 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8459 sv_2mortal(target); /* Schedule for freeing later */
8463 =for apidoc sv_untaint
8465 Untaint an SV. Use C<SvTAINTED_off> instead.
8470 Perl_sv_untaint(pTHX_ SV *sv)
8472 PERL_ARGS_ASSERT_SV_UNTAINT;
8474 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8475 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8482 =for apidoc sv_tainted
8484 Test an SV for taintedness. Use C<SvTAINTED> instead.
8489 Perl_sv_tainted(pTHX_ SV *sv)
8491 PERL_ARGS_ASSERT_SV_TAINTED;
8493 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8494 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8495 if (mg && (mg->mg_len & 1) )
8502 =for apidoc sv_setpviv
8504 Copies an integer into the given SV, also updating its string value.
8505 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8511 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8513 char buf[TYPE_CHARS(UV)];
8515 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8517 PERL_ARGS_ASSERT_SV_SETPVIV;
8519 sv_setpvn(sv, ptr, ebuf - ptr);
8523 =for apidoc sv_setpviv_mg
8525 Like C<sv_setpviv>, but also handles 'set' magic.
8531 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8533 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8539 #if defined(PERL_IMPLICIT_CONTEXT)
8541 /* pTHX_ magic can't cope with varargs, so this is a no-context
8542 * version of the main function, (which may itself be aliased to us).
8543 * Don't access this version directly.
8547 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8552 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8554 va_start(args, pat);
8555 sv_vsetpvf(sv, pat, &args);
8559 /* pTHX_ magic can't cope with varargs, so this is a no-context
8560 * version of the main function, (which may itself be aliased to us).
8561 * Don't access this version directly.
8565 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8570 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8572 va_start(args, pat);
8573 sv_vsetpvf_mg(sv, pat, &args);
8579 =for apidoc sv_setpvf
8581 Works like C<sv_catpvf> but copies the text into the SV instead of
8582 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8588 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8592 PERL_ARGS_ASSERT_SV_SETPVF;
8594 va_start(args, pat);
8595 sv_vsetpvf(sv, pat, &args);
8600 =for apidoc sv_vsetpvf
8602 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8603 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8605 Usually used via its frontend C<sv_setpvf>.
8611 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8613 PERL_ARGS_ASSERT_SV_VSETPVF;
8615 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8619 =for apidoc sv_setpvf_mg
8621 Like C<sv_setpvf>, but also handles 'set' magic.
8627 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8631 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8633 va_start(args, pat);
8634 sv_vsetpvf_mg(sv, pat, &args);
8639 =for apidoc sv_vsetpvf_mg
8641 Like C<sv_vsetpvf>, but also handles 'set' magic.
8643 Usually used via its frontend C<sv_setpvf_mg>.
8649 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8651 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8653 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8657 #if defined(PERL_IMPLICIT_CONTEXT)
8659 /* pTHX_ magic can't cope with varargs, so this is a no-context
8660 * version of the main function, (which may itself be aliased to us).
8661 * Don't access this version directly.
8665 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8670 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8672 va_start(args, pat);
8673 sv_vcatpvf(sv, pat, &args);
8677 /* pTHX_ magic can't cope with varargs, so this is a no-context
8678 * version of the main function, (which may itself be aliased to us).
8679 * Don't access this version directly.
8683 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8688 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8690 va_start(args, pat);
8691 sv_vcatpvf_mg(sv, pat, &args);
8697 =for apidoc sv_catpvf
8699 Processes its arguments like C<sprintf> and appends the formatted
8700 output to an SV. If the appended data contains "wide" characters
8701 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8702 and characters >255 formatted with %c), the original SV might get
8703 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8704 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8705 valid UTF-8; if the original SV was bytes, the pattern should be too.
8710 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8714 PERL_ARGS_ASSERT_SV_CATPVF;
8716 va_start(args, pat);
8717 sv_vcatpvf(sv, pat, &args);
8722 =for apidoc sv_vcatpvf
8724 Processes its arguments like C<vsprintf> and appends the formatted output
8725 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8727 Usually used via its frontend C<sv_catpvf>.
8733 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8735 PERL_ARGS_ASSERT_SV_VCATPVF;
8737 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8741 =for apidoc sv_catpvf_mg
8743 Like C<sv_catpvf>, but also handles 'set' magic.
8749 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8753 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8755 va_start(args, pat);
8756 sv_vcatpvf_mg(sv, pat, &args);
8761 =for apidoc sv_vcatpvf_mg
8763 Like C<sv_vcatpvf>, but also handles 'set' magic.
8765 Usually used via its frontend C<sv_catpvf_mg>.
8771 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8773 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8775 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8780 =for apidoc sv_vsetpvfn
8782 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8785 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8791 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8793 PERL_ARGS_ASSERT_SV_VSETPVFN;
8795 sv_setpvn(sv, "", 0);
8796 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8800 S_expect_number(pTHX_ char** pattern)
8805 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8807 switch (**pattern) {
8808 case '1': case '2': case '3':
8809 case '4': case '5': case '6':
8810 case '7': case '8': case '9':
8811 var = *(*pattern)++ - '0';
8812 while (isDIGIT(**pattern)) {
8813 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8815 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8823 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8825 const int neg = nv < 0;
8828 PERL_ARGS_ASSERT_F0CONVERT;
8836 if (uv & 1 && uv == nv)
8837 uv--; /* Round to even */
8839 const unsigned dig = uv % 10;
8852 =for apidoc sv_vcatpvfn
8854 Processes its arguments like C<vsprintf> and appends the formatted output
8855 to an SV. Uses an array of SVs if the C style variable argument list is
8856 missing (NULL). When running with taint checks enabled, indicates via
8857 C<maybe_tainted> if results are untrustworthy (often due to the use of
8860 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8866 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8867 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8868 vec_utf8 = DO_UTF8(vecsv);
8870 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8873 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8881 static const char nullstr[] = "(null)";
8883 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8884 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8886 /* Times 4: a decimal digit takes more than 3 binary digits.
8887 * NV_DIG: mantissa takes than many decimal digits.
8888 * Plus 32: Playing safe. */
8889 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8890 /* large enough for "%#.#f" --chip */
8891 /* what about long double NVs? --jhi */
8893 PERL_ARGS_ASSERT_SV_VCATPVFN;
8894 PERL_UNUSED_ARG(maybe_tainted);
8896 /* no matter what, this is a string now */
8897 (void)SvPV_force(sv, origlen);
8899 /* special-case "", "%s", and "%-p" (SVf - see below) */
8902 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8904 const char * const s = va_arg(*args, char*);
8905 sv_catpv(sv, s ? s : nullstr);
8907 else if (svix < svmax) {
8908 sv_catsv(sv, *svargs);
8912 if (args && patlen == 3 && pat[0] == '%' &&
8913 pat[1] == '-' && pat[2] == 'p') {
8914 argsv = (SV*)va_arg(*args, void*);
8915 sv_catsv(sv, argsv);
8919 #ifndef USE_LONG_DOUBLE
8920 /* special-case "%.<number>[gf]" */
8921 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8922 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8923 unsigned digits = 0;
8927 while (*pp >= '0' && *pp <= '9')
8928 digits = 10 * digits + (*pp++ - '0');
8929 if (pp - pat == (int)patlen - 1) {
8937 /* Add check for digits != 0 because it seems that some
8938 gconverts are buggy in this case, and we don't yet have
8939 a Configure test for this. */
8940 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8941 /* 0, point, slack */
8942 Gconvert(nv, (int)digits, 0, ebuf);
8944 if (*ebuf) /* May return an empty string for digits==0 */
8947 } else if (!digits) {
8950 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8951 sv_catpvn(sv, p, l);
8957 #endif /* !USE_LONG_DOUBLE */
8959 if (!args && svix < svmax && DO_UTF8(*svargs))
8962 patend = (char*)pat + patlen;
8963 for (p = (char*)pat; p < patend; p = q) {
8966 bool vectorize = FALSE;
8967 bool vectorarg = FALSE;
8968 bool vec_utf8 = FALSE;
8974 bool has_precis = FALSE;
8976 const I32 osvix = svix;
8977 bool is_utf8 = FALSE; /* is this item utf8? */
8978 #ifdef HAS_LDBL_SPRINTF_BUG
8979 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8980 with sfio - Allen <allens@cpan.org> */
8981 bool fix_ldbl_sprintf_bug = FALSE;
8985 U8 utf8buf[UTF8_MAXBYTES+1];
8986 STRLEN esignlen = 0;
8988 const char *eptr = NULL;
8991 const U8 *vecstr = NULL;
8998 /* we need a long double target in case HAS_LONG_DOUBLE but
9001 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9009 const char *dotstr = ".";
9010 STRLEN dotstrlen = 1;
9011 I32 efix = 0; /* explicit format parameter index */
9012 I32 ewix = 0; /* explicit width index */
9013 I32 epix = 0; /* explicit precision index */
9014 I32 evix = 0; /* explicit vector index */
9015 bool asterisk = FALSE;
9017 /* echo everything up to the next format specification */
9018 for (q = p; q < patend && *q != '%'; ++q) ;
9020 if (has_utf8 && !pat_utf8)
9021 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9023 sv_catpvn(sv, p, q - p);
9030 We allow format specification elements in this order:
9031 \d+\$ explicit format parameter index
9033 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9034 0 flag (as above): repeated to allow "v02"
9035 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9036 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9038 [%bcdefginopsuxDFOUX] format (mandatory)
9043 As of perl5.9.3, printf format checking is on by default.
9044 Internally, perl uses %p formats to provide an escape to
9045 some extended formatting. This block deals with those
9046 extensions: if it does not match, (char*)q is reset and
9047 the normal format processing code is used.
9049 Currently defined extensions are:
9050 %p include pointer address (standard)
9051 %-p (SVf) include an SV (previously %_)
9052 %-<num>p include an SV with precision <num>
9053 %<num>p reserved for future extensions
9055 Robin Barker 2005-07-14
9057 %1p (VDf) removed. RMB 2007-10-19
9064 n = expect_number(&q);
9071 argsv = (SV*)va_arg(*args, void*);
9072 eptr = SvPV_const(argsv, elen);
9078 if (ckWARN_d(WARN_INTERNAL))
9079 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9080 "internal %%<num>p might conflict with future printf extensions");
9086 if ( (width = expect_number(&q)) ) {
9101 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9130 if ( (ewix = expect_number(&q)) )
9139 if ((vectorarg = asterisk)) {
9152 width = expect_number(&q);
9158 vecsv = va_arg(*args, SV*);
9160 vecsv = (evix > 0 && evix <= svmax)
9161 ? svargs[evix-1] : &PL_sv_undef;
9163 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9165 dotstr = SvPV_const(vecsv, dotstrlen);
9166 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9167 bad with tied or overloaded values that return UTF8. */
9170 else if (has_utf8) {
9171 vecsv = sv_mortalcopy(vecsv);
9172 sv_utf8_upgrade(vecsv);
9173 dotstr = SvPV_const(vecsv, dotstrlen);
9180 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9181 vecsv = svargs[efix ? efix-1 : svix++];
9182 vecstr = (U8*)SvPV_const(vecsv,veclen);
9183 vec_utf8 = DO_UTF8(vecsv);
9185 /* if this is a version object, we need to convert
9186 * back into v-string notation and then let the
9187 * vectorize happen normally
9189 if (sv_derived_from(vecsv, "version")) {
9190 char *version = savesvpv(vecsv);
9191 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9192 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9193 "vector argument not supported with alpha versions");
9196 vecsv = sv_newmortal();
9197 scan_vstring(version, version + veclen, vecsv);
9198 vecstr = (U8*)SvPV_const(vecsv, veclen);
9199 vec_utf8 = DO_UTF8(vecsv);
9211 i = va_arg(*args, int);
9213 i = (ewix ? ewix <= svmax : svix < svmax) ?
9214 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9216 width = (i < 0) ? -i : i;
9226 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9228 /* XXX: todo, support specified precision parameter */
9232 i = va_arg(*args, int);
9234 i = (ewix ? ewix <= svmax : svix < svmax)
9235 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9237 has_precis = !(i < 0);
9242 precis = precis * 10 + (*q++ - '0');
9251 case 'I': /* Ix, I32x, and I64x */
9253 if (q[1] == '6' && q[2] == '4') {
9259 if (q[1] == '3' && q[2] == '2') {
9269 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9280 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9281 if (*(q + 1) == 'l') { /* lld, llf */
9307 if (!vectorize && !args) {
9309 const I32 i = efix-1;
9310 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9312 argsv = (svix >= 0 && svix < svmax)
9313 ? svargs[svix++] : &PL_sv_undef;
9324 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9326 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9328 eptr = (char*)utf8buf;
9329 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9343 eptr = va_arg(*args, char*);
9345 #ifdef MACOS_TRADITIONAL
9346 /* On MacOS, %#s format is used for Pascal strings */
9351 elen = strlen(eptr);
9353 eptr = (char *)nullstr;
9354 elen = sizeof nullstr - 1;
9358 eptr = SvPV_const(argsv, elen);
9359 if (DO_UTF8(argsv)) {
9360 I32 old_precis = precis;
9361 if (has_precis && precis < elen) {
9363 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9366 if (width) { /* fudge width (can't fudge elen) */
9367 if (has_precis && precis < elen)
9368 width += precis - old_precis;
9370 width += elen - sv_len_utf8(argsv);
9377 if (has_precis && elen > precis)
9384 if (alt || vectorize)
9386 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9407 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9416 esignbuf[esignlen++] = plus;
9420 case 'h': iv = (short)va_arg(*args, int); break;
9421 case 'l': iv = va_arg(*args, long); break;
9422 case 'V': iv = va_arg(*args, IV); break;
9423 default: iv = va_arg(*args, int); break;
9425 case 'q': iv = va_arg(*args, Quad_t); break;
9430 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9432 case 'h': iv = (short)tiv; break;
9433 case 'l': iv = (long)tiv; break;
9435 default: iv = tiv; break;
9437 case 'q': iv = (Quad_t)tiv; break;
9441 if ( !vectorize ) /* we already set uv above */
9446 esignbuf[esignlen++] = plus;
9450 esignbuf[esignlen++] = '-';
9494 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9505 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9506 case 'l': uv = va_arg(*args, unsigned long); break;
9507 case 'V': uv = va_arg(*args, UV); break;
9508 default: uv = va_arg(*args, unsigned); break;
9510 case 'q': uv = va_arg(*args, Uquad_t); break;
9515 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9517 case 'h': uv = (unsigned short)tuv; break;
9518 case 'l': uv = (unsigned long)tuv; break;
9520 default: uv = tuv; break;
9522 case 'q': uv = (Uquad_t)tuv; break;
9529 char *ptr = ebuf + sizeof ebuf;
9530 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9536 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9542 esignbuf[esignlen++] = '0';
9543 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9551 if (alt && *ptr != '0')
9560 esignbuf[esignlen++] = '0';
9561 esignbuf[esignlen++] = c;
9564 default: /* it had better be ten or less */
9568 } while (uv /= base);
9571 elen = (ebuf + sizeof ebuf) - ptr;
9575 zeros = precis - elen;
9576 else if (precis == 0 && elen == 1 && *eptr == '0'
9577 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9580 /* a precision nullifies the 0 flag. */
9587 /* FLOATING POINT */
9590 c = 'f'; /* maybe %F isn't supported here */
9598 /* This is evil, but floating point is even more evil */
9600 /* for SV-style calling, we can only get NV
9601 for C-style calling, we assume %f is double;
9602 for simplicity we allow any of %Lf, %llf, %qf for long double
9606 #if defined(USE_LONG_DOUBLE)
9610 /* [perl #20339] - we should accept and ignore %lf rather than die */
9614 #if defined(USE_LONG_DOUBLE)
9615 intsize = args ? 0 : 'q';
9619 #if defined(HAS_LONG_DOUBLE)
9628 /* now we need (long double) if intsize == 'q', else (double) */
9630 #if LONG_DOUBLESIZE > DOUBLESIZE
9632 va_arg(*args, long double) :
9633 va_arg(*args, double)
9635 va_arg(*args, double)
9640 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9641 else. frexp() has some unspecified behaviour for those three */
9642 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9644 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9645 will cast our (long double) to (double) */
9646 (void)Perl_frexp(nv, &i);
9647 if (i == PERL_INT_MIN)
9648 Perl_die(aTHX_ "panic: frexp");
9650 need = BIT_DIGITS(i);
9652 need += has_precis ? precis : 6; /* known default */
9657 #ifdef HAS_LDBL_SPRINTF_BUG
9658 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9659 with sfio - Allen <allens@cpan.org> */
9662 # define MY_DBL_MAX DBL_MAX
9663 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9664 # if DOUBLESIZE >= 8
9665 # define MY_DBL_MAX 1.7976931348623157E+308L
9667 # define MY_DBL_MAX 3.40282347E+38L
9671 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9672 # define MY_DBL_MAX_BUG 1L
9674 # define MY_DBL_MAX_BUG MY_DBL_MAX
9678 # define MY_DBL_MIN DBL_MIN
9679 # else /* XXX guessing! -Allen */
9680 # if DOUBLESIZE >= 8
9681 # define MY_DBL_MIN 2.2250738585072014E-308L
9683 # define MY_DBL_MIN 1.17549435E-38L
9687 if ((intsize == 'q') && (c == 'f') &&
9688 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9690 /* it's going to be short enough that
9691 * long double precision is not needed */
9693 if ((nv <= 0L) && (nv >= -0L))
9694 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9696 /* would use Perl_fp_class as a double-check but not
9697 * functional on IRIX - see perl.h comments */
9699 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9700 /* It's within the range that a double can represent */
9701 #if defined(DBL_MAX) && !defined(DBL_MIN)
9702 if ((nv >= ((long double)1/DBL_MAX)) ||
9703 (nv <= (-(long double)1/DBL_MAX)))
9705 fix_ldbl_sprintf_bug = TRUE;
9708 if (fix_ldbl_sprintf_bug == TRUE) {
9718 # undef MY_DBL_MAX_BUG
9721 #endif /* HAS_LDBL_SPRINTF_BUG */
9723 need += 20; /* fudge factor */
9724 if (PL_efloatsize < need) {
9725 Safefree(PL_efloatbuf);
9726 PL_efloatsize = need + 20; /* more fudge */
9727 Newx(PL_efloatbuf, PL_efloatsize, char);
9728 PL_efloatbuf[0] = '\0';
9731 if ( !(width || left || plus || alt) && fill != '0'
9732 && has_precis && intsize != 'q' ) { /* Shortcuts */
9733 /* See earlier comment about buggy Gconvert when digits,
9735 if ( c == 'g' && precis) {
9736 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9737 /* May return an empty string for digits==0 */
9738 if (*PL_efloatbuf) {
9739 elen = strlen(PL_efloatbuf);
9740 goto float_converted;
9742 } else if ( c == 'f' && !precis) {
9743 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9748 char *ptr = ebuf + sizeof ebuf;
9751 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9752 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9753 if (intsize == 'q') {
9754 /* Copy the one or more characters in a long double
9755 * format before the 'base' ([efgEFG]) character to
9756 * the format string. */
9757 static char const prifldbl[] = PERL_PRIfldbl;
9758 char const *p = prifldbl + sizeof(prifldbl) - 3;
9759 while (p >= prifldbl) { *--ptr = *p--; }
9764 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9769 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9781 /* No taint. Otherwise we are in the strange situation
9782 * where printf() taints but print($float) doesn't.
9784 #if defined(HAS_LONG_DOUBLE)
9785 elen = ((intsize == 'q')
9786 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9787 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9789 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9793 eptr = PL_efloatbuf;
9801 i = SvCUR(sv) - origlen;
9804 case 'h': *(va_arg(*args, short*)) = i; break;
9805 default: *(va_arg(*args, int*)) = i; break;
9806 case 'l': *(va_arg(*args, long*)) = i; break;
9807 case 'V': *(va_arg(*args, IV*)) = i; break;
9809 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9814 sv_setuv_mg(argsv, (UV)i);
9815 continue; /* not "break" */
9822 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9823 && ckWARN(WARN_PRINTF))
9825 SV * const msg = sv_newmortal();
9826 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9827 (PL_op->op_type == OP_PRTF) ? "" : "s");
9830 Perl_sv_catpvf(aTHX_ msg,
9831 "\"%%%c\"", c & 0xFF);
9833 Perl_sv_catpvf(aTHX_ msg,
9834 "\"%%\\%03"UVof"\"",
9837 sv_catpvs(msg, "end of string");
9838 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9841 /* output mangled stuff ... */
9847 /* ... right here, because formatting flags should not apply */
9848 SvGROW(sv, SvCUR(sv) + elen + 1);
9850 Copy(eptr, p, elen, char);
9853 SvCUR_set(sv, p - SvPVX_const(sv));
9855 continue; /* not "break" */
9858 if (is_utf8 != has_utf8) {
9861 sv_utf8_upgrade(sv);
9864 const STRLEN old_elen = elen;
9865 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9866 sv_utf8_upgrade(nsv);
9867 eptr = SvPVX_const(nsv);
9870 if (width) { /* fudge width (can't fudge elen) */
9871 width += elen - old_elen;
9877 have = esignlen + zeros + elen;
9879 Perl_croak_nocontext(PL_memory_wrap);
9881 need = (have > width ? have : width);
9884 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9885 Perl_croak_nocontext(PL_memory_wrap);
9886 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9888 if (esignlen && fill == '0') {
9890 for (i = 0; i < (int)esignlen; i++)
9894 memset(p, fill, gap);
9897 if (esignlen && fill != '0') {
9899 for (i = 0; i < (int)esignlen; i++)
9904 for (i = zeros; i; i--)
9908 Copy(eptr, p, elen, char);
9912 memset(p, ' ', gap);
9917 Copy(dotstr, p, dotstrlen, char);
9921 vectorize = FALSE; /* done iterating over vecstr */
9928 SvCUR_set(sv, p - SvPVX_const(sv));
9936 /* =========================================================================
9938 =head1 Cloning an interpreter
9940 All the macros and functions in this section are for the private use of
9941 the main function, perl_clone().
9943 The foo_dup() functions make an exact copy of an existing foo thingy.
9944 During the course of a cloning, a hash table is used to map old addresses
9945 to new addresses. The table is created and manipulated with the
9946 ptr_table_* functions.
9950 ============================================================================*/
9953 #if defined(USE_ITHREADS)
9955 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9956 #ifndef GpREFCNT_inc
9957 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9961 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9962 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9963 If this changes, please unmerge ss_dup. */
9964 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9965 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9966 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9967 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9968 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9969 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9970 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9971 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9972 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9973 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9974 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9975 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9976 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9977 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9979 /* clone a parser */
9982 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9986 PERL_ARGS_ASSERT_PARSER_DUP;
9991 /* look for it in the table first */
9992 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9996 /* create anew and remember what it is */
9997 Newxz(parser, 1, yy_parser);
9998 ptr_table_store(PL_ptr_table, proto, parser);
10000 parser->yyerrstatus = 0;
10001 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10003 /* XXX these not yet duped */
10004 parser->old_parser = NULL;
10005 parser->stack = NULL;
10007 parser->stack_size = 0;
10008 /* XXX parser->stack->state = 0; */
10010 /* XXX eventually, just Copy() most of the parser struct ? */
10012 parser->lex_brackets = proto->lex_brackets;
10013 parser->lex_casemods = proto->lex_casemods;
10014 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10015 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10016 parser->lex_casestack = savepvn(proto->lex_casestack,
10017 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10018 parser->lex_defer = proto->lex_defer;
10019 parser->lex_dojoin = proto->lex_dojoin;
10020 parser->lex_expect = proto->lex_expect;
10021 parser->lex_formbrack = proto->lex_formbrack;
10022 parser->lex_inpat = proto->lex_inpat;
10023 parser->lex_inwhat = proto->lex_inwhat;
10024 parser->lex_op = proto->lex_op;
10025 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10026 parser->lex_starts = proto->lex_starts;
10027 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10028 parser->multi_close = proto->multi_close;
10029 parser->multi_open = proto->multi_open;
10030 parser->multi_start = proto->multi_start;
10031 parser->multi_end = proto->multi_end;
10032 parser->pending_ident = proto->pending_ident;
10033 parser->preambled = proto->preambled;
10034 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10035 parser->linestr = sv_dup_inc(proto->linestr, param);
10036 parser->expect = proto->expect;
10037 parser->copline = proto->copline;
10038 parser->last_lop_op = proto->last_lop_op;
10039 parser->lex_state = proto->lex_state;
10040 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10041 /* rsfp_filters entries have fake IoDIRP() */
10042 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10043 parser->in_my = proto->in_my;
10044 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10045 parser->error_count = proto->error_count;
10048 parser->linestr = sv_dup_inc(proto->linestr, param);
10051 char * const ols = SvPVX(proto->linestr);
10052 char * const ls = SvPVX(parser->linestr);
10054 parser->bufptr = ls + (proto->bufptr >= ols ?
10055 proto->bufptr - ols : 0);
10056 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10057 proto->oldbufptr - ols : 0);
10058 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10059 proto->oldoldbufptr - ols : 0);
10060 parser->linestart = ls + (proto->linestart >= ols ?
10061 proto->linestart - ols : 0);
10062 parser->last_uni = ls + (proto->last_uni >= ols ?
10063 proto->last_uni - ols : 0);
10064 parser->last_lop = ls + (proto->last_lop >= ols ?
10065 proto->last_lop - ols : 0);
10067 parser->bufend = ls + SvCUR(parser->linestr);
10070 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10074 parser->endwhite = proto->endwhite;
10075 parser->faketokens = proto->faketokens;
10076 parser->lasttoke = proto->lasttoke;
10077 parser->nextwhite = proto->nextwhite;
10078 parser->realtokenstart = proto->realtokenstart;
10079 parser->skipwhite = proto->skipwhite;
10080 parser->thisclose = proto->thisclose;
10081 parser->thismad = proto->thismad;
10082 parser->thisopen = proto->thisopen;
10083 parser->thisstuff = proto->thisstuff;
10084 parser->thistoken = proto->thistoken;
10085 parser->thiswhite = proto->thiswhite;
10087 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10088 parser->curforce = proto->curforce;
10090 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10091 Copy(proto->nexttype, parser->nexttype, 5, I32);
10092 parser->nexttoke = proto->nexttoke;
10098 /* duplicate a file handle */
10101 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10105 PERL_ARGS_ASSERT_FP_DUP;
10106 PERL_UNUSED_ARG(type);
10109 return (PerlIO*)NULL;
10111 /* look for it in the table first */
10112 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10116 /* create anew and remember what it is */
10117 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10118 ptr_table_store(PL_ptr_table, fp, ret);
10122 /* duplicate a directory handle */
10125 Perl_dirp_dup(pTHX_ DIR *dp)
10127 PERL_UNUSED_CONTEXT;
10134 /* duplicate a typeglob */
10137 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10141 PERL_ARGS_ASSERT_GP_DUP;
10145 /* look for it in the table first */
10146 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10150 /* create anew and remember what it is */
10152 ptr_table_store(PL_ptr_table, gp, ret);
10155 ret->gp_refcnt = 0; /* must be before any other dups! */
10156 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10157 ret->gp_io = io_dup_inc(gp->gp_io, param);
10158 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10159 ret->gp_av = av_dup_inc(gp->gp_av, param);
10160 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10161 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10162 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10163 ret->gp_cvgen = gp->gp_cvgen;
10164 ret->gp_line = gp->gp_line;
10165 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10169 /* duplicate a chain of magic */
10172 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10174 MAGIC *mgprev = (MAGIC*)NULL;
10177 PERL_ARGS_ASSERT_MG_DUP;
10180 return (MAGIC*)NULL;
10181 /* look for it in the table first */
10182 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10186 for (; mg; mg = mg->mg_moremagic) {
10188 Newxz(nmg, 1, MAGIC);
10190 mgprev->mg_moremagic = nmg;
10193 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10194 nmg->mg_private = mg->mg_private;
10195 nmg->mg_type = mg->mg_type;
10196 nmg->mg_flags = mg->mg_flags;
10197 /* FIXME for plugins
10198 if (mg->mg_type == PERL_MAGIC_qr) {
10199 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10203 if(mg->mg_type == PERL_MAGIC_backref) {
10204 /* The backref AV has its reference count deliberately bumped by
10206 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10209 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10210 ? sv_dup_inc(mg->mg_obj, param)
10211 : sv_dup(mg->mg_obj, param);
10213 nmg->mg_len = mg->mg_len;
10214 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10215 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10216 if (mg->mg_len > 0) {
10217 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10218 if (mg->mg_type == PERL_MAGIC_overload_table &&
10219 AMT_AMAGIC((AMT*)mg->mg_ptr))
10221 const AMT * const amtp = (AMT*)mg->mg_ptr;
10222 AMT * const namtp = (AMT*)nmg->mg_ptr;
10224 for (i = 1; i < NofAMmeth; i++) {
10225 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10229 else if (mg->mg_len == HEf_SVKEY)
10230 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10232 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10233 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10240 #endif /* USE_ITHREADS */
10242 /* create a new pointer-mapping table */
10245 Perl_ptr_table_new(pTHX)
10248 PERL_UNUSED_CONTEXT;
10250 Newxz(tbl, 1, PTR_TBL_t);
10251 tbl->tbl_max = 511;
10252 tbl->tbl_items = 0;
10253 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10257 #define PTR_TABLE_HASH(ptr) \
10258 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10261 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10262 following define) and at call to new_body_inline made below in
10263 Perl_ptr_table_store()
10266 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10268 /* map an existing pointer using a table */
10270 STATIC PTR_TBL_ENT_t *
10271 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv)
10273 PTR_TBL_ENT_t *tblent;
10274 const UV hash = PTR_TABLE_HASH(sv);
10276 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10278 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10279 for (; tblent; tblent = tblent->next) {
10280 if (tblent->oldval == sv)
10287 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10289 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10291 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10292 PERL_UNUSED_CONTEXT;
10294 return tblent ? tblent->newval : NULL;
10297 /* add a new entry to a pointer-mapping table */
10300 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10302 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10304 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10305 PERL_UNUSED_CONTEXT;
10308 tblent->newval = newsv;
10310 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10312 new_body_inline(tblent, PTE_SVSLOT);
10314 tblent->oldval = oldsv;
10315 tblent->newval = newsv;
10316 tblent->next = tbl->tbl_ary[entry];
10317 tbl->tbl_ary[entry] = tblent;
10319 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10320 ptr_table_split(tbl);
10324 /* double the hash bucket size of an existing ptr table */
10327 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10329 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10330 const UV oldsize = tbl->tbl_max + 1;
10331 UV newsize = oldsize * 2;
10334 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10335 PERL_UNUSED_CONTEXT;
10337 Renew(ary, newsize, PTR_TBL_ENT_t*);
10338 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10339 tbl->tbl_max = --newsize;
10340 tbl->tbl_ary = ary;
10341 for (i=0; i < oldsize; i++, ary++) {
10342 PTR_TBL_ENT_t **curentp, **entp, *ent;
10345 curentp = ary + oldsize;
10346 for (entp = ary, ent = *ary; ent; ent = *entp) {
10347 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10349 ent->next = *curentp;
10359 /* remove all the entries from a ptr table */
10362 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10364 if (tbl && tbl->tbl_items) {
10365 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10366 UV riter = tbl->tbl_max;
10369 PTR_TBL_ENT_t *entry = array[riter];
10372 PTR_TBL_ENT_t * const oentry = entry;
10373 entry = entry->next;
10378 tbl->tbl_items = 0;
10382 /* clear and free a ptr table */
10385 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10390 ptr_table_clear(tbl);
10391 Safefree(tbl->tbl_ary);
10395 #if defined(USE_ITHREADS)
10398 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10400 PERL_ARGS_ASSERT_RVPV_DUP;
10403 SvRV_set(dstr, SvWEAKREF(sstr)
10404 ? sv_dup(SvRV(sstr), param)
10405 : sv_dup_inc(SvRV(sstr), param));
10408 else if (SvPVX_const(sstr)) {
10409 /* Has something there */
10411 /* Normal PV - clone whole allocated space */
10412 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10413 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10414 /* Not that normal - actually sstr is copy on write.
10415 But we are a true, independant SV, so: */
10416 SvREADONLY_off(dstr);
10421 /* Special case - not normally malloced for some reason */
10422 if (isGV_with_GP(sstr)) {
10423 /* Don't need to do anything here. */
10425 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10426 /* A "shared" PV - clone it as "shared" PV */
10428 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10432 /* Some other special case - random pointer */
10433 SvPV_set(dstr, SvPVX(sstr));
10438 /* Copy the NULL */
10439 SvPV_set(dstr, NULL);
10443 /* duplicate an SV of any type (including AV, HV etc) */
10446 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10451 PERL_ARGS_ASSERT_SV_DUP;
10455 if (SvTYPE(sstr) == SVTYPEMASK) {
10456 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10461 /* look for it in the table first */
10462 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10466 if(param->flags & CLONEf_JOIN_IN) {
10467 /** We are joining here so we don't want do clone
10468 something that is bad **/
10469 if (SvTYPE(sstr) == SVt_PVHV) {
10470 const HEK * const hvname = HvNAME_HEK(sstr);
10472 /** don't clone stashes if they already exist **/
10473 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10477 /* create anew and remember what it is */
10480 #ifdef DEBUG_LEAKING_SCALARS
10481 dstr->sv_debug_optype = sstr->sv_debug_optype;
10482 dstr->sv_debug_line = sstr->sv_debug_line;
10483 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10484 dstr->sv_debug_cloned = 1;
10485 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10488 ptr_table_store(PL_ptr_table, sstr, dstr);
10491 SvFLAGS(dstr) = SvFLAGS(sstr);
10492 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10493 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10496 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10497 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10498 (void*)PL_watch_pvx, SvPVX_const(sstr));
10501 /* don't clone objects whose class has asked us not to */
10502 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10507 switch (SvTYPE(sstr)) {
10509 SvANY(dstr) = NULL;
10512 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10514 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10516 SvIV_set(dstr, SvIVX(sstr));
10520 SvANY(dstr) = new_XNV();
10521 SvNV_set(dstr, SvNVX(sstr));
10523 /* case SVt_BIND: */
10526 /* These are all the types that need complex bodies allocating. */
10528 const svtype sv_type = SvTYPE(sstr);
10529 const struct body_details *const sv_type_details
10530 = bodies_by_type + sv_type;
10534 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10538 if (GvUNIQUE((GV*)sstr)) {
10539 NOOP; /* Do sharing here, and fall through */
10552 assert(sv_type_details->body_size);
10553 if (sv_type_details->arena) {
10554 new_body_inline(new_body, sv_type);
10556 = (void*)((char*)new_body - sv_type_details->offset);
10558 new_body = new_NOARENA(sv_type_details);
10562 SvANY(dstr) = new_body;
10565 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10566 ((char*)SvANY(dstr)) + sv_type_details->offset,
10567 sv_type_details->copy, char);
10569 Copy(((char*)SvANY(sstr)),
10570 ((char*)SvANY(dstr)),
10571 sv_type_details->body_size + sv_type_details->offset, char);
10574 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10575 && !isGV_with_GP(dstr))
10576 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10578 /* The Copy above means that all the source (unduplicated) pointers
10579 are now in the destination. We can check the flags and the
10580 pointers in either, but it's possible that there's less cache
10581 missing by always going for the destination.
10582 FIXME - instrument and check that assumption */
10583 if (sv_type >= SVt_PVMG) {
10584 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10585 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10586 } else if (SvMAGIC(dstr))
10587 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10589 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10592 /* The cast silences a GCC warning about unhandled types. */
10593 switch ((int)sv_type) {
10603 /* FIXME for plugins */
10604 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10607 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10608 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10609 LvTARG(dstr) = dstr;
10610 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10611 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10613 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10615 if(isGV_with_GP(sstr)) {
10616 if (GvNAME_HEK(dstr))
10617 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10618 /* Don't call sv_add_backref here as it's going to be
10619 created as part of the magic cloning of the symbol
10621 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10622 at the point of this comment. */
10623 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10624 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10625 (void)GpREFCNT_inc(GvGP(dstr));
10627 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10630 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10631 if (IoOFP(dstr) == IoIFP(sstr))
10632 IoOFP(dstr) = IoIFP(dstr);
10634 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10635 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10636 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10637 /* I have no idea why fake dirp (rsfps)
10638 should be treated differently but otherwise
10639 we end up with leaks -- sky*/
10640 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10641 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10642 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10644 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10645 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10646 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10647 if (IoDIRP(dstr)) {
10648 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10651 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10654 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10655 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10656 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10659 if (AvARRAY((AV*)sstr)) {
10660 SV **dst_ary, **src_ary;
10661 SSize_t items = AvFILLp((AV*)sstr) + 1;
10663 src_ary = AvARRAY((AV*)sstr);
10664 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10665 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10666 AvARRAY((AV*)dstr) = dst_ary;
10667 AvALLOC((AV*)dstr) = dst_ary;
10668 if (AvREAL((AV*)sstr)) {
10669 while (items-- > 0)
10670 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10673 while (items-- > 0)
10674 *dst_ary++ = sv_dup(*src_ary++, param);
10676 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10677 while (items-- > 0) {
10678 *dst_ary++ = &PL_sv_undef;
10682 AvARRAY((AV*)dstr) = NULL;
10683 AvALLOC((AV*)dstr) = (SV**)NULL;
10687 if (HvARRAY((HV*)sstr)) {
10689 const bool sharekeys = !!HvSHAREKEYS(sstr);
10690 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10691 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10693 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10694 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10696 HvARRAY(dstr) = (HE**)darray;
10697 while (i <= sxhv->xhv_max) {
10698 const HE * const source = HvARRAY(sstr)[i];
10699 HvARRAY(dstr)[i] = source
10700 ? he_dup(source, sharekeys, param) : 0;
10705 const struct xpvhv_aux * const saux = HvAUX(sstr);
10706 struct xpvhv_aux * const daux = HvAUX(dstr);
10707 /* This flag isn't copied. */
10708 /* SvOOK_on(hv) attacks the IV flags. */
10709 SvFLAGS(dstr) |= SVf_OOK;
10711 hvname = saux->xhv_name;
10712 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10714 daux->xhv_riter = saux->xhv_riter;
10715 daux->xhv_eiter = saux->xhv_eiter
10716 ? he_dup(saux->xhv_eiter,
10717 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10718 daux->xhv_backreferences =
10719 saux->xhv_backreferences
10720 ? (AV*) SvREFCNT_inc(
10721 sv_dup((SV*)saux->xhv_backreferences, param))
10724 daux->xhv_mro_meta = saux->xhv_mro_meta
10725 ? mro_meta_dup(saux->xhv_mro_meta, param)
10728 /* Record stashes for possible cloning in Perl_clone(). */
10730 av_push(param->stashes, dstr);
10734 HvARRAY((HV*)dstr) = NULL;
10737 if (!(param->flags & CLONEf_COPY_STACKS)) {
10741 /* NOTE: not refcounted */
10742 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10744 if (!CvISXSUB(dstr))
10745 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10747 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10748 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10749 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10750 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10752 /* don't dup if copying back - CvGV isn't refcounted, so the
10753 * duped GV may never be freed. A bit of a hack! DAPM */
10754 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10755 NULL : gv_dup(CvGV(dstr), param) ;
10756 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10758 CvWEAKOUTSIDE(sstr)
10759 ? cv_dup( CvOUTSIDE(dstr), param)
10760 : cv_dup_inc(CvOUTSIDE(dstr), param);
10761 if (!CvISXSUB(dstr))
10762 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10768 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10774 /* duplicate a context */
10777 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10779 PERL_CONTEXT *ncxs;
10781 PERL_ARGS_ASSERT_CX_DUP;
10784 return (PERL_CONTEXT*)NULL;
10786 /* look for it in the table first */
10787 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10791 /* create anew and remember what it is */
10792 Newx(ncxs, max + 1, PERL_CONTEXT);
10793 ptr_table_store(PL_ptr_table, cxs, ncxs);
10794 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10797 PERL_CONTEXT * const ncx = &ncxs[ix];
10798 if (CxTYPE(ncx) == CXt_SUBST) {
10799 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10802 switch (CxTYPE(ncx)) {
10804 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10805 ? cv_dup_inc(ncx->blk_sub.cv, param)
10806 : cv_dup(ncx->blk_sub.cv,param));
10807 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10808 ? av_dup_inc(ncx->blk_sub.argarray,
10811 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10813 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10814 ncx->blk_sub.oldcomppad);
10817 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10819 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10821 case CXt_LOOP_LAZYSV:
10822 ncx->blk_loop.state_u.lazysv.end
10823 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10824 /* We are taking advantage of av_dup_inc and sv_dup_inc
10825 actually being the same function, and order equivalance of
10827 We can assert the later [but only at run time :-(] */
10828 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10829 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10831 ncx->blk_loop.state_u.ary.ary
10832 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10833 case CXt_LOOP_LAZYIV:
10834 case CXt_LOOP_PLAIN:
10835 if (CxPADLOOP(ncx)) {
10836 ncx->blk_loop.oldcomppad
10837 = (PAD*)ptr_table_fetch(PL_ptr_table,
10838 ncx->blk_loop.oldcomppad);
10840 ncx->blk_loop.oldcomppad
10841 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10845 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10846 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10847 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10860 /* duplicate a stack info structure */
10863 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10867 PERL_ARGS_ASSERT_SI_DUP;
10870 return (PERL_SI*)NULL;
10872 /* look for it in the table first */
10873 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10877 /* create anew and remember what it is */
10878 Newxz(nsi, 1, PERL_SI);
10879 ptr_table_store(PL_ptr_table, si, nsi);
10881 nsi->si_stack = av_dup_inc(si->si_stack, param);
10882 nsi->si_cxix = si->si_cxix;
10883 nsi->si_cxmax = si->si_cxmax;
10884 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10885 nsi->si_type = si->si_type;
10886 nsi->si_prev = si_dup(si->si_prev, param);
10887 nsi->si_next = si_dup(si->si_next, param);
10888 nsi->si_markoff = si->si_markoff;
10893 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10894 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10895 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10896 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10897 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10898 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10899 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10900 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10901 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10902 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10903 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10904 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10905 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10906 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10909 #define pv_dup_inc(p) SAVEPV(p)
10910 #define pv_dup(p) SAVEPV(p)
10911 #define svp_dup_inc(p,pp) any_dup(p,pp)
10913 /* map any object to the new equivent - either something in the
10914 * ptr table, or something in the interpreter structure
10918 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10922 PERL_ARGS_ASSERT_ANY_DUP;
10925 return (void*)NULL;
10927 /* look for it in the table first */
10928 ret = ptr_table_fetch(PL_ptr_table, v);
10932 /* see if it is part of the interpreter structure */
10933 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10934 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10942 /* duplicate the save stack */
10945 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10948 ANY * const ss = proto_perl->Isavestack;
10949 const I32 max = proto_perl->Isavestack_max;
10950 I32 ix = proto_perl->Isavestack_ix;
10963 void (*dptr) (void*);
10964 void (*dxptr) (pTHX_ void*);
10966 PERL_ARGS_ASSERT_SS_DUP;
10968 Newxz(nss, max, ANY);
10971 const I32 type = POPINT(ss,ix);
10972 TOPINT(nss,ix) = type;
10974 case SAVEt_HELEM: /* hash element */
10975 sv = (SV*)POPPTR(ss,ix);
10976 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10978 case SAVEt_ITEM: /* normal string */
10979 case SAVEt_SV: /* scalar reference */
10980 sv = (SV*)POPPTR(ss,ix);
10981 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10984 case SAVEt_MORTALIZESV:
10985 sv = (SV*)POPPTR(ss,ix);
10986 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10988 case SAVEt_SHARED_PVREF: /* char* in shared space */
10989 c = (char*)POPPTR(ss,ix);
10990 TOPPTR(nss,ix) = savesharedpv(c);
10991 ptr = POPPTR(ss,ix);
10992 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10994 case SAVEt_GENERIC_SVREF: /* generic sv */
10995 case SAVEt_SVREF: /* scalar reference */
10996 sv = (SV*)POPPTR(ss,ix);
10997 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10998 ptr = POPPTR(ss,ix);
10999 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11001 case SAVEt_HV: /* hash reference */
11002 case SAVEt_AV: /* array reference */
11003 sv = (SV*) POPPTR(ss,ix);
11004 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11006 case SAVEt_COMPPAD:
11008 sv = (SV*) POPPTR(ss,ix);
11009 TOPPTR(nss,ix) = sv_dup(sv, param);
11011 case SAVEt_INT: /* int reference */
11012 ptr = POPPTR(ss,ix);
11013 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11014 intval = (int)POPINT(ss,ix);
11015 TOPINT(nss,ix) = intval;
11017 case SAVEt_LONG: /* long reference */
11018 ptr = POPPTR(ss,ix);
11019 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11021 case SAVEt_CLEARSV:
11022 longval = (long)POPLONG(ss,ix);
11023 TOPLONG(nss,ix) = longval;
11025 case SAVEt_I32: /* I32 reference */
11026 case SAVEt_I16: /* I16 reference */
11027 case SAVEt_I8: /* I8 reference */
11028 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11029 ptr = POPPTR(ss,ix);
11030 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11032 TOPINT(nss,ix) = i;
11034 case SAVEt_IV: /* IV reference */
11035 ptr = POPPTR(ss,ix);
11036 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11038 TOPIV(nss,ix) = iv;
11040 case SAVEt_HPTR: /* HV* reference */
11041 case SAVEt_APTR: /* AV* reference */
11042 case SAVEt_SPTR: /* SV* reference */
11043 ptr = POPPTR(ss,ix);
11044 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11045 sv = (SV*)POPPTR(ss,ix);
11046 TOPPTR(nss,ix) = sv_dup(sv, param);
11048 case SAVEt_VPTR: /* random* reference */
11049 ptr = POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11051 ptr = POPPTR(ss,ix);
11052 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11054 case SAVEt_GENERIC_PVREF: /* generic char* */
11055 case SAVEt_PPTR: /* char* reference */
11056 ptr = POPPTR(ss,ix);
11057 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11058 c = (char*)POPPTR(ss,ix);
11059 TOPPTR(nss,ix) = pv_dup(c);
11061 case SAVEt_GP: /* scalar reference */
11062 gp = (GP*)POPPTR(ss,ix);
11063 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11064 (void)GpREFCNT_inc(gp);
11065 gv = (GV*)POPPTR(ss,ix);
11066 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11069 ptr = POPPTR(ss,ix);
11070 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11071 /* these are assumed to be refcounted properly */
11073 switch (((OP*)ptr)->op_type) {
11075 case OP_LEAVESUBLV:
11079 case OP_LEAVEWRITE:
11080 TOPPTR(nss,ix) = ptr;
11083 (void) OpREFCNT_inc(o);
11087 TOPPTR(nss,ix) = NULL;
11092 TOPPTR(nss,ix) = NULL;
11095 c = (char*)POPPTR(ss,ix);
11096 TOPPTR(nss,ix) = pv_dup_inc(c);
11099 hv = (HV*)POPPTR(ss,ix);
11100 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11101 c = (char*)POPPTR(ss,ix);
11102 TOPPTR(nss,ix) = pv_dup_inc(c);
11104 case SAVEt_STACK_POS: /* Position on Perl stack */
11106 TOPINT(nss,ix) = i;
11108 case SAVEt_DESTRUCTOR:
11109 ptr = POPPTR(ss,ix);
11110 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11111 dptr = POPDPTR(ss,ix);
11112 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11113 any_dup(FPTR2DPTR(void *, dptr),
11116 case SAVEt_DESTRUCTOR_X:
11117 ptr = POPPTR(ss,ix);
11118 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11119 dxptr = POPDXPTR(ss,ix);
11120 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11121 any_dup(FPTR2DPTR(void *, dxptr),
11124 case SAVEt_REGCONTEXT:
11127 TOPINT(nss,ix) = i;
11130 case SAVEt_AELEM: /* array element */
11131 sv = (SV*)POPPTR(ss,ix);
11132 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11134 TOPINT(nss,ix) = i;
11135 av = (AV*)POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = av_dup_inc(av, param);
11139 ptr = POPPTR(ss,ix);
11140 TOPPTR(nss,ix) = ptr;
11144 TOPINT(nss,ix) = i;
11145 ptr = POPPTR(ss,ix);
11148 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11149 HINTS_REFCNT_UNLOCK;
11151 TOPPTR(nss,ix) = ptr;
11152 if (i & HINT_LOCALIZE_HH) {
11153 hv = (HV*)POPPTR(ss,ix);
11154 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11157 case SAVEt_PADSV_AND_MORTALIZE:
11158 longval = (long)POPLONG(ss,ix);
11159 TOPLONG(nss,ix) = longval;
11160 ptr = POPPTR(ss,ix);
11161 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11162 sv = (SV*)POPPTR(ss,ix);
11163 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11166 ptr = POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11168 longval = (long)POPBOOL(ss,ix);
11169 TOPBOOL(nss,ix) = (bool)longval;
11171 case SAVEt_SET_SVFLAGS:
11173 TOPINT(nss,ix) = i;
11175 TOPINT(nss,ix) = i;
11176 sv = (SV*)POPPTR(ss,ix);
11177 TOPPTR(nss,ix) = sv_dup(sv, param);
11179 case SAVEt_RE_STATE:
11181 const struct re_save_state *const old_state
11182 = (struct re_save_state *)
11183 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11184 struct re_save_state *const new_state
11185 = (struct re_save_state *)
11186 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11188 Copy(old_state, new_state, 1, struct re_save_state);
11189 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11191 new_state->re_state_bostr
11192 = pv_dup(old_state->re_state_bostr);
11193 new_state->re_state_reginput
11194 = pv_dup(old_state->re_state_reginput);
11195 new_state->re_state_regeol
11196 = pv_dup(old_state->re_state_regeol);
11197 new_state->re_state_regoffs
11198 = (regexp_paren_pair*)
11199 any_dup(old_state->re_state_regoffs, proto_perl);
11200 new_state->re_state_reglastparen
11201 = (U32*) any_dup(old_state->re_state_reglastparen,
11203 new_state->re_state_reglastcloseparen
11204 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11206 /* XXX This just has to be broken. The old save_re_context
11207 code did SAVEGENERICPV(PL_reg_start_tmp);
11208 PL_reg_start_tmp is char **.
11209 Look above to what the dup code does for
11210 SAVEt_GENERIC_PVREF
11211 It can never have worked.
11212 So this is merely a faithful copy of the exiting bug: */
11213 new_state->re_state_reg_start_tmp
11214 = (char **) pv_dup((char *)
11215 old_state->re_state_reg_start_tmp);
11216 /* I assume that it only ever "worked" because no-one called
11217 (pseudo)fork while the regexp engine had re-entered itself.
11219 #ifdef PERL_OLD_COPY_ON_WRITE
11220 new_state->re_state_nrs
11221 = sv_dup(old_state->re_state_nrs, param);
11223 new_state->re_state_reg_magic
11224 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11226 new_state->re_state_reg_oldcurpm
11227 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11229 new_state->re_state_reg_curpm
11230 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11232 new_state->re_state_reg_oldsaved
11233 = pv_dup(old_state->re_state_reg_oldsaved);
11234 new_state->re_state_reg_poscache
11235 = pv_dup(old_state->re_state_reg_poscache);
11236 new_state->re_state_reg_starttry
11237 = pv_dup(old_state->re_state_reg_starttry);
11240 case SAVEt_COMPILE_WARNINGS:
11241 ptr = POPPTR(ss,ix);
11242 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11245 ptr = POPPTR(ss,ix);
11246 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11250 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11258 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11259 * flag to the result. This is done for each stash before cloning starts,
11260 * so we know which stashes want their objects cloned */
11263 do_mark_cloneable_stash(pTHX_ SV *sv)
11265 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11267 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11268 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11269 if (cloner && GvCV(cloner)) {
11276 mXPUSHs(newSVhek(hvname));
11278 call_sv((SV*)GvCV(cloner), G_SCALAR);
11285 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11293 =for apidoc perl_clone
11295 Create and return a new interpreter by cloning the current one.
11297 perl_clone takes these flags as parameters:
11299 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11300 without it we only clone the data and zero the stacks,
11301 with it we copy the stacks and the new perl interpreter is
11302 ready to run at the exact same point as the previous one.
11303 The pseudo-fork code uses COPY_STACKS while the
11304 threads->create doesn't.
11306 CLONEf_KEEP_PTR_TABLE
11307 perl_clone keeps a ptr_table with the pointer of the old
11308 variable as a key and the new variable as a value,
11309 this allows it to check if something has been cloned and not
11310 clone it again but rather just use the value and increase the
11311 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11312 the ptr_table using the function
11313 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11314 reason to keep it around is if you want to dup some of your own
11315 variable who are outside the graph perl scans, example of this
11316 code is in threads.xs create
11319 This is a win32 thing, it is ignored on unix, it tells perls
11320 win32host code (which is c++) to clone itself, this is needed on
11321 win32 if you want to run two threads at the same time,
11322 if you just want to do some stuff in a separate perl interpreter
11323 and then throw it away and return to the original one,
11324 you don't need to do anything.
11329 /* XXX the above needs expanding by someone who actually understands it ! */
11330 EXTERN_C PerlInterpreter *
11331 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11334 perl_clone(PerlInterpreter *proto_perl, UV flags)
11337 #ifdef PERL_IMPLICIT_SYS
11339 PERL_ARGS_ASSERT_PERL_CLONE;
11341 /* perlhost.h so we need to call into it
11342 to clone the host, CPerlHost should have a c interface, sky */
11344 if (flags & CLONEf_CLONE_HOST) {
11345 return perl_clone_host(proto_perl,flags);
11347 return perl_clone_using(proto_perl, flags,
11349 proto_perl->IMemShared,
11350 proto_perl->IMemParse,
11352 proto_perl->IStdIO,
11356 proto_perl->IProc);
11360 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11361 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11362 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11363 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11364 struct IPerlDir* ipD, struct IPerlSock* ipS,
11365 struct IPerlProc* ipP)
11367 /* XXX many of the string copies here can be optimized if they're
11368 * constants; they need to be allocated as common memory and just
11369 * their pointers copied. */
11372 CLONE_PARAMS clone_params;
11373 CLONE_PARAMS* const param = &clone_params;
11375 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11377 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11379 /* for each stash, determine whether its objects should be cloned */
11380 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11381 PERL_SET_THX(my_perl);
11384 PoisonNew(my_perl, 1, PerlInterpreter);
11390 PL_savestack_ix = 0;
11391 PL_savestack_max = -1;
11392 PL_sig_pending = 0;
11394 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11395 # else /* !DEBUGGING */
11396 Zero(my_perl, 1, PerlInterpreter);
11397 # endif /* DEBUGGING */
11399 /* host pointers */
11401 PL_MemShared = ipMS;
11402 PL_MemParse = ipMP;
11409 #else /* !PERL_IMPLICIT_SYS */
11411 CLONE_PARAMS clone_params;
11412 CLONE_PARAMS* param = &clone_params;
11413 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11415 PERL_ARGS_ASSERT_PERL_CLONE;
11417 /* for each stash, determine whether its objects should be cloned */
11418 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11419 PERL_SET_THX(my_perl);
11422 PoisonNew(my_perl, 1, PerlInterpreter);
11428 PL_savestack_ix = 0;
11429 PL_savestack_max = -1;
11430 PL_sig_pending = 0;
11432 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11433 # else /* !DEBUGGING */
11434 Zero(my_perl, 1, PerlInterpreter);
11435 # endif /* DEBUGGING */
11436 #endif /* PERL_IMPLICIT_SYS */
11437 param->flags = flags;
11438 param->proto_perl = proto_perl;
11440 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11442 PL_body_arenas = NULL;
11443 Zero(&PL_body_roots, 1, PL_body_roots);
11445 PL_nice_chunk = NULL;
11446 PL_nice_chunk_size = 0;
11448 PL_sv_objcount = 0;
11450 PL_sv_arenaroot = NULL;
11452 PL_debug = proto_perl->Idebug;
11454 PL_hash_seed = proto_perl->Ihash_seed;
11455 PL_rehash_seed = proto_perl->Irehash_seed;
11457 #ifdef USE_REENTRANT_API
11458 /* XXX: things like -Dm will segfault here in perlio, but doing
11459 * PERL_SET_CONTEXT(proto_perl);
11460 * breaks too many other things
11462 Perl_reentrant_init(aTHX);
11465 /* create SV map for pointer relocation */
11466 PL_ptr_table = ptr_table_new();
11468 /* initialize these special pointers as early as possible */
11469 SvANY(&PL_sv_undef) = NULL;
11470 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11471 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11472 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11474 SvANY(&PL_sv_no) = new_XPVNV();
11475 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11476 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11477 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11478 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11479 SvCUR_set(&PL_sv_no, 0);
11480 SvLEN_set(&PL_sv_no, 1);
11481 SvIV_set(&PL_sv_no, 0);
11482 SvNV_set(&PL_sv_no, 0);
11483 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11485 SvANY(&PL_sv_yes) = new_XPVNV();
11486 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11487 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11488 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11489 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11490 SvCUR_set(&PL_sv_yes, 1);
11491 SvLEN_set(&PL_sv_yes, 2);
11492 SvIV_set(&PL_sv_yes, 1);
11493 SvNV_set(&PL_sv_yes, 1);
11494 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11496 /* create (a non-shared!) shared string table */
11497 PL_strtab = newHV();
11498 HvSHAREKEYS_off(PL_strtab);
11499 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11500 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11502 PL_compiling = proto_perl->Icompiling;
11504 /* These two PVs will be free'd special way so must set them same way op.c does */
11505 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11506 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11508 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11509 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11511 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11512 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11513 if (PL_compiling.cop_hints_hash) {
11515 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11516 HINTS_REFCNT_UNLOCK;
11518 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11519 #ifdef PERL_DEBUG_READONLY_OPS
11524 /* pseudo environmental stuff */
11525 PL_origargc = proto_perl->Iorigargc;
11526 PL_origargv = proto_perl->Iorigargv;
11528 param->stashes = newAV(); /* Setup array of objects to call clone on */
11530 /* Set tainting stuff before PerlIO_debug can possibly get called */
11531 PL_tainting = proto_perl->Itainting;
11532 PL_taint_warn = proto_perl->Itaint_warn;
11534 #ifdef PERLIO_LAYERS
11535 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11536 PerlIO_clone(aTHX_ proto_perl, param);
11539 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11540 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11541 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11542 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11543 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11544 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11547 PL_minus_c = proto_perl->Iminus_c;
11548 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11549 PL_localpatches = proto_perl->Ilocalpatches;
11550 PL_splitstr = proto_perl->Isplitstr;
11551 PL_minus_n = proto_perl->Iminus_n;
11552 PL_minus_p = proto_perl->Iminus_p;
11553 PL_minus_l = proto_perl->Iminus_l;
11554 PL_minus_a = proto_perl->Iminus_a;
11555 PL_minus_E = proto_perl->Iminus_E;
11556 PL_minus_F = proto_perl->Iminus_F;
11557 PL_doswitches = proto_perl->Idoswitches;
11558 PL_dowarn = proto_perl->Idowarn;
11559 PL_doextract = proto_perl->Idoextract;
11560 PL_sawampersand = proto_perl->Isawampersand;
11561 PL_unsafe = proto_perl->Iunsafe;
11562 PL_inplace = SAVEPV(proto_perl->Iinplace);
11563 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11564 PL_perldb = proto_perl->Iperldb;
11565 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11566 PL_exit_flags = proto_perl->Iexit_flags;
11568 /* magical thingies */
11569 /* XXX time(&PL_basetime) when asked for? */
11570 PL_basetime = proto_perl->Ibasetime;
11571 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11573 PL_maxsysfd = proto_perl->Imaxsysfd;
11574 PL_statusvalue = proto_perl->Istatusvalue;
11576 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11578 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11580 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11582 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11583 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11584 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11587 /* RE engine related */
11588 Zero(&PL_reg_state, 1, struct re_save_state);
11589 PL_reginterp_cnt = 0;
11590 PL_regmatch_slab = NULL;
11592 /* Clone the regex array */
11593 /* ORANGE FIXME for plugins, probably in the SV dup code.
11594 newSViv(PTR2IV(CALLREGDUPE(
11595 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11597 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11598 PL_regex_pad = AvARRAY(PL_regex_padav);
11600 /* shortcuts to various I/O objects */
11601 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11602 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11603 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11604 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11605 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11606 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11608 /* shortcuts to regexp stuff */
11609 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11611 /* shortcuts to misc objects */
11612 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11614 /* shortcuts to debugging objects */
11615 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11616 PL_DBline = gv_dup(proto_perl->IDBline, param);
11617 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11618 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11619 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11620 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11621 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11623 /* symbol tables */
11624 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11625 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11626 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11627 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11628 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11630 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11631 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11632 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11633 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11634 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11635 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11636 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11637 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11639 PL_sub_generation = proto_perl->Isub_generation;
11640 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11642 /* funky return mechanisms */
11643 PL_forkprocess = proto_perl->Iforkprocess;
11645 /* subprocess state */
11646 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11648 /* internal state */
11649 PL_maxo = proto_perl->Imaxo;
11650 if (proto_perl->Iop_mask)
11651 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11654 /* PL_asserting = proto_perl->Iasserting; */
11656 /* current interpreter roots */
11657 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11659 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11661 PL_main_start = proto_perl->Imain_start;
11662 PL_eval_root = proto_perl->Ieval_root;
11663 PL_eval_start = proto_perl->Ieval_start;
11665 /* runtime control stuff */
11666 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11668 PL_filemode = proto_perl->Ifilemode;
11669 PL_lastfd = proto_perl->Ilastfd;
11670 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11673 PL_gensym = proto_perl->Igensym;
11674 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11675 PL_laststatval = proto_perl->Ilaststatval;
11676 PL_laststype = proto_perl->Ilaststype;
11679 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11681 /* interpreter atexit processing */
11682 PL_exitlistlen = proto_perl->Iexitlistlen;
11683 if (PL_exitlistlen) {
11684 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11685 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11688 PL_exitlist = (PerlExitListEntry*)NULL;
11690 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11691 if (PL_my_cxt_size) {
11692 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11693 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11694 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11695 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11696 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11700 PL_my_cxt_list = (void**)NULL;
11701 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11702 PL_my_cxt_keys = (const char**)NULL;
11705 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11706 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11707 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11709 PL_profiledata = NULL;
11711 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11713 PAD_CLONE_VARS(proto_perl, param);
11715 #ifdef HAVE_INTERP_INTERN
11716 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11719 /* more statics moved here */
11720 PL_generation = proto_perl->Igeneration;
11721 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11723 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11724 PL_in_clean_all = proto_perl->Iin_clean_all;
11726 PL_uid = proto_perl->Iuid;
11727 PL_euid = proto_perl->Ieuid;
11728 PL_gid = proto_perl->Igid;
11729 PL_egid = proto_perl->Iegid;
11730 PL_nomemok = proto_perl->Inomemok;
11731 PL_an = proto_perl->Ian;
11732 PL_evalseq = proto_perl->Ievalseq;
11733 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11734 PL_origalen = proto_perl->Iorigalen;
11735 #ifdef PERL_USES_PL_PIDSTATUS
11736 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11738 PL_osname = SAVEPV(proto_perl->Iosname);
11739 PL_sighandlerp = proto_perl->Isighandlerp;
11741 PL_runops = proto_perl->Irunops;
11743 PL_parser = parser_dup(proto_perl->Iparser, param);
11745 PL_subline = proto_perl->Isubline;
11746 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11749 PL_cryptseen = proto_perl->Icryptseen;
11752 PL_hints = proto_perl->Ihints;
11754 PL_amagic_generation = proto_perl->Iamagic_generation;
11756 #ifdef USE_LOCALE_COLLATE
11757 PL_collation_ix = proto_perl->Icollation_ix;
11758 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11759 PL_collation_standard = proto_perl->Icollation_standard;
11760 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11761 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11762 #endif /* USE_LOCALE_COLLATE */
11764 #ifdef USE_LOCALE_NUMERIC
11765 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11766 PL_numeric_standard = proto_perl->Inumeric_standard;
11767 PL_numeric_local = proto_perl->Inumeric_local;
11768 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11769 #endif /* !USE_LOCALE_NUMERIC */
11771 /* utf8 character classes */
11772 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11773 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11774 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11775 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11776 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11777 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11778 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11779 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11780 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11781 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11782 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11783 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11784 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11785 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11786 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11787 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11788 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11789 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11790 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11791 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11793 /* Did the locale setup indicate UTF-8? */
11794 PL_utf8locale = proto_perl->Iutf8locale;
11795 /* Unicode features (see perlrun/-C) */
11796 PL_unicode = proto_perl->Iunicode;
11798 /* Pre-5.8 signals control */
11799 PL_signals = proto_perl->Isignals;
11801 /* times() ticks per second */
11802 PL_clocktick = proto_perl->Iclocktick;
11804 /* Recursion stopper for PerlIO_find_layer */
11805 PL_in_load_module = proto_perl->Iin_load_module;
11807 /* sort() routine */
11808 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11810 /* Not really needed/useful since the reenrant_retint is "volatile",
11811 * but do it for consistency's sake. */
11812 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11814 /* Hooks to shared SVs and locks. */
11815 PL_sharehook = proto_perl->Isharehook;
11816 PL_lockhook = proto_perl->Ilockhook;
11817 PL_unlockhook = proto_perl->Iunlockhook;
11818 PL_threadhook = proto_perl->Ithreadhook;
11819 PL_destroyhook = proto_perl->Idestroyhook;
11821 #ifdef THREADS_HAVE_PIDS
11822 PL_ppid = proto_perl->Ippid;
11826 PL_last_swash_hv = NULL; /* reinits on demand */
11827 PL_last_swash_klen = 0;
11828 PL_last_swash_key[0]= '\0';
11829 PL_last_swash_tmps = (U8*)NULL;
11830 PL_last_swash_slen = 0;
11832 PL_glob_index = proto_perl->Iglob_index;
11833 PL_srand_called = proto_perl->Isrand_called;
11834 PL_bitcount = NULL; /* reinits on demand */
11836 if (proto_perl->Ipsig_pend) {
11837 Newxz(PL_psig_pend, SIG_SIZE, int);
11840 PL_psig_pend = (int*)NULL;
11843 if (proto_perl->Ipsig_ptr) {
11844 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11845 Newxz(PL_psig_name, SIG_SIZE, SV*);
11846 for (i = 1; i < SIG_SIZE; i++) {
11847 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11848 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11852 PL_psig_ptr = (SV**)NULL;
11853 PL_psig_name = (SV**)NULL;
11856 /* intrpvar.h stuff */
11858 if (flags & CLONEf_COPY_STACKS) {
11859 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11860 PL_tmps_ix = proto_perl->Itmps_ix;
11861 PL_tmps_max = proto_perl->Itmps_max;
11862 PL_tmps_floor = proto_perl->Itmps_floor;
11863 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11865 while (i <= PL_tmps_ix) {
11866 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11870 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11871 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11872 Newxz(PL_markstack, i, I32);
11873 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11874 - proto_perl->Imarkstack);
11875 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11876 - proto_perl->Imarkstack);
11877 Copy(proto_perl->Imarkstack, PL_markstack,
11878 PL_markstack_ptr - PL_markstack + 1, I32);
11880 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11881 * NOTE: unlike the others! */
11882 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11883 PL_scopestack_max = proto_perl->Iscopestack_max;
11884 Newxz(PL_scopestack, PL_scopestack_max, I32);
11885 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11887 /* NOTE: si_dup() looks at PL_markstack */
11888 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11890 /* PL_curstack = PL_curstackinfo->si_stack; */
11891 PL_curstack = av_dup(proto_perl->Icurstack, param);
11892 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11894 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11895 PL_stack_base = AvARRAY(PL_curstack);
11896 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11897 - proto_perl->Istack_base);
11898 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11900 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11901 * NOTE: unlike the others! */
11902 PL_savestack_ix = proto_perl->Isavestack_ix;
11903 PL_savestack_max = proto_perl->Isavestack_max;
11904 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11905 PL_savestack = ss_dup(proto_perl, param);
11909 ENTER; /* perl_destruct() wants to LEAVE; */
11911 /* although we're not duplicating the tmps stack, we should still
11912 * add entries for any SVs on the tmps stack that got cloned by a
11913 * non-refcount means (eg a temp in @_); otherwise they will be
11916 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11917 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11918 proto_perl->Itmps_stack[i]);
11919 if (nsv && !SvREFCNT(nsv)) {
11921 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11926 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11927 PL_top_env = &PL_start_env;
11929 PL_op = proto_perl->Iop;
11932 PL_Xpv = (XPV*)NULL;
11933 my_perl->Ina = proto_perl->Ina;
11935 PL_statbuf = proto_perl->Istatbuf;
11936 PL_statcache = proto_perl->Istatcache;
11937 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11938 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11940 PL_timesbuf = proto_perl->Itimesbuf;
11943 PL_tainted = proto_perl->Itainted;
11944 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11945 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11946 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11947 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11948 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11949 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11950 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11951 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11952 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11954 PL_restartop = proto_perl->Irestartop;
11955 PL_in_eval = proto_perl->Iin_eval;
11956 PL_delaymagic = proto_perl->Idelaymagic;
11957 PL_dirty = proto_perl->Idirty;
11958 PL_localizing = proto_perl->Ilocalizing;
11960 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11961 PL_hv_fetch_ent_mh = NULL;
11962 PL_modcount = proto_perl->Imodcount;
11963 PL_lastgotoprobe = NULL;
11964 PL_dumpindent = proto_perl->Idumpindent;
11966 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11967 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11968 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11969 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11970 PL_efloatbuf = NULL; /* reinits on demand */
11971 PL_efloatsize = 0; /* reinits on demand */
11975 PL_screamfirst = NULL;
11976 PL_screamnext = NULL;
11977 PL_maxscream = -1; /* reinits on demand */
11978 PL_lastscream = NULL;
11981 PL_regdummy = proto_perl->Iregdummy;
11982 PL_colorset = 0; /* reinits PL_colors[] */
11983 /*PL_colors[6] = {0,0,0,0,0,0};*/
11987 /* Pluggable optimizer */
11988 PL_peepp = proto_perl->Ipeepp;
11990 PL_stashcache = newHV();
11992 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11993 proto_perl->Iwatchaddr);
11994 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11995 if (PL_debug && PL_watchaddr) {
11996 PerlIO_printf(Perl_debug_log,
11997 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11998 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11999 PTR2UV(PL_watchok));
12002 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12003 ptr_table_free(PL_ptr_table);
12004 PL_ptr_table = NULL;
12007 /* Call the ->CLONE method, if it exists, for each of the stashes
12008 identified by sv_dup() above.
12010 while(av_len(param->stashes) != -1) {
12011 HV* const stash = (HV*) av_shift(param->stashes);
12012 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12013 if (cloner && GvCV(cloner)) {
12018 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12020 call_sv((SV*)GvCV(cloner), G_DISCARD);
12026 SvREFCNT_dec(param->stashes);
12028 /* orphaned? eg threads->new inside BEGIN or use */
12029 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12030 SvREFCNT_inc_simple_void(PL_compcv);
12031 SAVEFREESV(PL_compcv);
12037 #endif /* USE_ITHREADS */
12040 =head1 Unicode Support
12042 =for apidoc sv_recode_to_utf8
12044 The encoding is assumed to be an Encode object, on entry the PV
12045 of the sv is assumed to be octets in that encoding, and the sv
12046 will be converted into Unicode (and UTF-8).
12048 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12049 is not a reference, nothing is done to the sv. If the encoding is not
12050 an C<Encode::XS> Encoding object, bad things will happen.
12051 (See F<lib/encoding.pm> and L<Encode>).
12053 The PV of the sv is returned.
12058 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12062 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12064 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12078 Passing sv_yes is wrong - it needs to be or'ed set of constants
12079 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12080 remove converted chars from source.
12082 Both will default the value - let them.
12084 XPUSHs(&PL_sv_yes);
12087 call_method("decode", G_SCALAR);
12091 s = SvPV_const(uni, len);
12092 if (s != SvPVX_const(sv)) {
12093 SvGROW(sv, len + 1);
12094 Move(s, SvPVX(sv), len + 1, char);
12095 SvCUR_set(sv, len);
12102 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12106 =for apidoc sv_cat_decode
12108 The encoding is assumed to be an Encode object, the PV of the ssv is
12109 assumed to be octets in that encoding and decoding the input starts
12110 from the position which (PV + *offset) pointed to. The dsv will be
12111 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12112 when the string tstr appears in decoding output or the input ends on
12113 the PV of the ssv. The value which the offset points will be modified
12114 to the last input position on the ssv.
12116 Returns TRUE if the terminator was found, else returns FALSE.
12121 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12122 SV *ssv, int *offset, char *tstr, int tlen)
12127 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12129 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12140 offsv = newSViv(*offset);
12142 mXPUSHp(tstr, tlen);
12144 call_method("cat_decode", G_SCALAR);
12146 ret = SvTRUE(TOPs);
12147 *offset = SvIV(offsv);
12153 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12158 /* ---------------------------------------------------------------------
12160 * support functions for report_uninit()
12163 /* the maxiumum size of array or hash where we will scan looking
12164 * for the undefined element that triggered the warning */
12166 #define FUV_MAX_SEARCH_SIZE 1000
12168 /* Look for an entry in the hash whose value has the same SV as val;
12169 * If so, return a mortal copy of the key. */
12172 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12175 register HE **array;
12178 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12180 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12181 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12184 array = HvARRAY(hv);
12186 for (i=HvMAX(hv); i>0; i--) {
12187 register HE *entry;
12188 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12189 if (HeVAL(entry) != val)
12191 if ( HeVAL(entry) == &PL_sv_undef ||
12192 HeVAL(entry) == &PL_sv_placeholder)
12196 if (HeKLEN(entry) == HEf_SVKEY)
12197 return sv_mortalcopy(HeKEY_sv(entry));
12198 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12204 /* Look for an entry in the array whose value has the same SV as val;
12205 * If so, return the index, otherwise return -1. */
12208 S_find_array_subscript(pTHX_ AV *av, SV* val)
12212 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12214 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12215 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12218 if (val != &PL_sv_undef) {
12219 SV ** const svp = AvARRAY(av);
12222 for (i=AvFILLp(av); i>=0; i--)
12229 /* S_varname(): return the name of a variable, optionally with a subscript.
12230 * If gv is non-zero, use the name of that global, along with gvtype (one
12231 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12232 * targ. Depending on the value of the subscript_type flag, return:
12235 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12236 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12237 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12238 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12241 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12242 SV* keyname, I32 aindex, int subscript_type)
12245 SV * const name = sv_newmortal();
12248 buffer[0] = gvtype;
12251 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12253 gv_fullname4(name, gv, buffer, 0);
12255 if ((unsigned int)SvPVX(name)[1] <= 26) {
12257 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12259 /* Swap the 1 unprintable control character for the 2 byte pretty
12260 version - ie substr($name, 1, 1) = $buffer; */
12261 sv_insert(name, 1, 1, buffer, 2);
12265 CV * const cv = find_runcv(NULL);
12269 if (!cv || !CvPADLIST(cv))
12271 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12272 sv = *av_fetch(av, targ, FALSE);
12273 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12276 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12277 SV * const sv = newSV(0);
12278 *SvPVX(name) = '$';
12279 Perl_sv_catpvf(aTHX_ name, "{%s}",
12280 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12283 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12284 *SvPVX(name) = '$';
12285 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12287 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
12288 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
12295 =for apidoc find_uninit_var
12297 Find the name of the undefined variable (if any) that caused the operator o
12298 to issue a "Use of uninitialized value" warning.
12299 If match is true, only return a name if it's value matches uninit_sv.
12300 So roughly speaking, if a unary operator (such as OP_COS) generates a
12301 warning, then following the direct child of the op may yield an
12302 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12303 other hand, with OP_ADD there are two branches to follow, so we only print
12304 the variable name if we get an exact match.
12306 The name is returned as a mortal SV.
12308 Assumes that PL_op is the op that originally triggered the error, and that
12309 PL_comppad/PL_curpad points to the currently executing pad.
12315 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12323 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12324 uninit_sv == &PL_sv_placeholder)))
12327 switch (obase->op_type) {
12334 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12335 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12338 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12340 if (pad) { /* @lex, %lex */
12341 sv = PAD_SVl(obase->op_targ);
12345 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12346 /* @global, %global */
12347 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12350 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12352 else /* @{expr}, %{expr} */
12353 return find_uninit_var(cUNOPx(obase)->op_first,
12357 /* attempt to find a match within the aggregate */
12359 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12361 subscript_type = FUV_SUBSCRIPT_HASH;
12364 index = find_array_subscript((AV*)sv, uninit_sv);
12366 subscript_type = FUV_SUBSCRIPT_ARRAY;
12369 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12372 return varname(gv, hash ? '%' : '@', obase->op_targ,
12373 keysv, index, subscript_type);
12377 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12379 return varname(NULL, '$', obase->op_targ,
12380 NULL, 0, FUV_SUBSCRIPT_NONE);
12383 gv = cGVOPx_gv(obase);
12384 if (!gv || (match && GvSV(gv) != uninit_sv))
12386 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12389 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12392 av = (AV*)PAD_SV(obase->op_targ);
12393 if (!av || SvRMAGICAL(av))
12395 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12396 if (!svp || *svp != uninit_sv)
12399 return varname(NULL, '$', obase->op_targ,
12400 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12403 gv = cGVOPx_gv(obase);
12409 if (!av || SvRMAGICAL(av))
12411 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12412 if (!svp || *svp != uninit_sv)
12415 return varname(gv, '$', 0,
12416 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12421 o = cUNOPx(obase)->op_first;
12422 if (!o || o->op_type != OP_NULL ||
12423 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12425 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12429 if (PL_op == obase)
12430 /* $a[uninit_expr] or $h{uninit_expr} */
12431 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12434 o = cBINOPx(obase)->op_first;
12435 kid = cBINOPx(obase)->op_last;
12437 /* get the av or hv, and optionally the gv */
12439 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12440 sv = PAD_SV(o->op_targ);
12442 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12443 && cUNOPo->op_first->op_type == OP_GV)
12445 gv = cGVOPx_gv(cUNOPo->op_first);
12448 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12453 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12454 /* index is constant */
12458 if (obase->op_type == OP_HELEM) {
12459 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12460 if (!he || HeVAL(he) != uninit_sv)
12464 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12465 if (!svp || *svp != uninit_sv)
12469 if (obase->op_type == OP_HELEM)
12470 return varname(gv, '%', o->op_targ,
12471 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12473 return varname(gv, '@', o->op_targ, NULL,
12474 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12477 /* index is an expression;
12478 * attempt to find a match within the aggregate */
12479 if (obase->op_type == OP_HELEM) {
12480 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12482 return varname(gv, '%', o->op_targ,
12483 keysv, 0, FUV_SUBSCRIPT_HASH);
12486 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12488 return varname(gv, '@', o->op_targ,
12489 NULL, index, FUV_SUBSCRIPT_ARRAY);
12494 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12496 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12501 /* only examine RHS */
12502 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12505 o = cUNOPx(obase)->op_first;
12506 if (o->op_type == OP_PUSHMARK)
12509 if (!o->op_sibling) {
12510 /* one-arg version of open is highly magical */
12512 if (o->op_type == OP_GV) { /* open FOO; */
12514 if (match && GvSV(gv) != uninit_sv)
12516 return varname(gv, '$', 0,
12517 NULL, 0, FUV_SUBSCRIPT_NONE);
12519 /* other possibilities not handled are:
12520 * open $x; or open my $x; should return '${*$x}'
12521 * open expr; should return '$'.expr ideally
12527 /* ops where $_ may be an implicit arg */
12531 if ( !(obase->op_flags & OPf_STACKED)) {
12532 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12533 ? PAD_SVl(obase->op_targ)
12536 sv = sv_newmortal();
12537 sv_setpvn(sv, "$_", 2);
12546 /* skip filehandle as it can't produce 'undef' warning */
12547 o = cUNOPx(obase)->op_first;
12548 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12549 o = o->op_sibling->op_sibling;
12555 match = 1; /* XS or custom code could trigger random warnings */
12560 /* XXX tmp hack: these two may call an XS sub, and currently
12561 XS subs don't have a SUB entry on the context stack, so CV and
12562 pad determination goes wrong, and BAD things happen. So, just
12563 don't try to determine the value under those circumstances.
12564 Need a better fix at dome point. DAPM 11/2007 */
12568 /* def-ness of rval pos() is independent of the def-ness of its arg */
12569 if ( !(obase->op_flags & OPf_MOD))
12574 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12575 return newSVpvs_flags("${$/}", SVs_TEMP);
12580 if (!(obase->op_flags & OPf_KIDS))
12582 o = cUNOPx(obase)->op_first;
12588 /* if all except one arg are constant, or have no side-effects,
12589 * or are optimized away, then it's unambiguous */
12591 for (kid=o; kid; kid = kid->op_sibling) {
12593 const OPCODE type = kid->op_type;
12594 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12595 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12596 || (type == OP_PUSHMARK)
12600 if (o2) { /* more than one found */
12607 return find_uninit_var(o2, uninit_sv, match);
12609 /* scan all args */
12611 sv = find_uninit_var(o, uninit_sv, 1);
12623 =for apidoc report_uninit
12625 Print appropriate "Use of uninitialized variable" warning
12631 Perl_report_uninit(pTHX_ SV* uninit_sv)
12635 SV* varname = NULL;
12637 varname = find_uninit_var(PL_op, uninit_sv,0);
12639 sv_insert(varname, 0, 0, " ", 1);
12641 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12642 varname ? SvPV_nolen_const(varname) : "",
12643 " in ", OP_DESC(PL_op));
12646 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12652 * c-indentation-style: bsd
12653 * c-basic-offset: 4
12654 * indent-tabs-mode: t
12657 * ex: set ts=8 sts=4 sw=4 noet: