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 *const sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
437 /* called by sv_clean_objs() for each live SV */
440 do_clean_objs(pTHX_ SV *const ref)
445 SV * const target = SvRV(ref);
446 if (SvOBJECT(target)) {
447 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
448 if (SvWEAKREF(ref)) {
449 sv_del_backref(target, ref);
455 SvREFCNT_dec(target);
460 /* XXX Might want to check arrays, etc. */
463 /* called by sv_clean_objs() for each live SV */
465 #ifndef DISABLE_DESTRUCTOR_KLUDGE
467 do_clean_named_objs(pTHX_ SV *const sv)
470 assert(SvTYPE(sv) == SVt_PVGV);
471 assert(isGV_with_GP(sv));
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
481 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *const sv)
519 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
520 /* don't clean pid table and strtab */
523 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
524 SvFLAGS(sv) |= SVf_BREAK;
529 =for apidoc sv_clean_all
531 Decrement the refcnt of each remaining SV, possibly triggering a
532 cleanup. This function may have to be called multiple times to free
533 SVs which are in complex self-referential hierarchies.
539 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 ARENASETS: a meta-arena implementation which separates arena-info
551 into struct arena_set, which contains an array of struct
552 arena_descs, each holding info for a single arena. By separating
553 the meta-info from the arena, we recover the 1st slot, formerly
554 borrowed for list management. The arena_set is about the size of an
555 arena, avoiding the needless malloc overhead of a naive linked-list.
557 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
558 memory in the last arena-set (1/2 on average). In trade, we get
559 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
560 smaller types). The recovery of the wasted space allows use of
561 small arenas for large, rare body types, by changing array* fields
562 in body_details_by_type[] below.
565 char *arena; /* the raw storage, allocated aligned */
566 size_t size; /* its size ~4k typ */
567 U32 misc; /* type, and in future other things. */
572 /* Get the maximum number of elements in set[] such that struct arena_set
573 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
574 therefore likely to be 1 aligned memory page. */
576 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
577 - 2 * sizeof(int)) / sizeof (struct arena_desc))
580 struct arena_set* next;
581 unsigned int set_size; /* ie ARENAS_PER_SET */
582 unsigned int curr; /* index of next available arena-desc */
583 struct arena_desc set[ARENAS_PER_SET];
587 =for apidoc sv_free_arenas
589 Deallocate the memory used by all arenas. Note that all the individual SV
590 heads and bodies within the arenas must already have been freed.
595 Perl_sv_free_arenas(pTHX)
602 /* Free arenas here, but be careful about fake ones. (We assume
603 contiguity of the fake ones with the corresponding real ones.) */
605 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
606 svanext = (SV*) SvANY(sva);
607 while (svanext && SvFAKE(svanext))
608 svanext = (SV*) SvANY(svanext);
615 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
618 struct arena_set *current = aroot;
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 i = PERL_ARENA_ROOTS_SIZE;
632 PL_body_roots[i] = 0;
634 Safefree(PL_nice_chunk);
635 PL_nice_chunk = NULL;
636 PL_nice_chunk_size = 0;
642 Here are mid-level routines that manage the allocation of bodies out
643 of the various arenas. There are 5 kinds of arenas:
645 1. SV-head arenas, which are discussed and handled above
646 2. regular body arenas
647 3. arenas for reduced-size bodies
649 5. pte arenas (thread related)
651 Arena types 2 & 3 are chained by body-type off an array of
652 arena-root pointers, which is indexed by svtype. Some of the
653 larger/less used body types are malloced singly, since a large
654 unused block of them is wasteful. Also, several svtypes dont have
655 bodies; the data fits into the sv-head itself. The arena-root
656 pointer thus has a few unused root-pointers (which may be hijacked
657 later for arena types 4,5)
659 3 differs from 2 as an optimization; some body types have several
660 unused fields in the front of the structure (which are kept in-place
661 for consistency). These bodies can be allocated in smaller chunks,
662 because the leading fields arent accessed. Pointers to such bodies
663 are decremented to point at the unused 'ghost' memory, knowing that
664 the pointers are used with offsets to the real memory.
666 HE, HEK arenas are managed separately, with separate code, but may
667 be merge-able later..
669 PTE arenas are not sv-bodies, but they share these mid-level
670 mechanics, so are considered here. The new mid-level mechanics rely
671 on the sv_type of the body being allocated, so we just reserve one
672 of the unused body-slots for PTEs, then use it in those (2) PTE
673 contexts below (line ~10k)
676 /* get_arena(size): this creates custom-sized arenas
677 TBD: export properly for hv.c: S_more_he().
680 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
683 struct arena_desc* adesc;
684 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
687 /* shouldnt need this
688 if (!arena_size) arena_size = PERL_ARENA_SIZE;
691 /* may need new arena-set to hold new arena */
692 if (!aroot || aroot->curr >= aroot->set_size) {
693 struct arena_set *newroot;
694 Newxz(newroot, 1, struct arena_set);
695 newroot->set_size = ARENAS_PER_SET;
696 newroot->next = aroot;
698 PL_body_arenas = (void *) newroot;
699 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
702 /* ok, now have arena-set with at least 1 empty/available arena-desc */
703 curr = aroot->curr++;
704 adesc = &(aroot->set[curr]);
705 assert(!adesc->arena);
707 Newx(adesc->arena, arena_size, char);
708 adesc->size = arena_size;
710 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
711 curr, (void*)adesc->arena, (UV)arena_size));
717 /* return a thing to the free list */
719 #define del_body(thing, root) \
721 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 =head1 SV-Body Allocation
730 Allocation of SV-bodies is similar to SV-heads, differing as follows;
731 the allocation mechanism is used for many body types, so is somewhat
732 more complicated, it uses arena-sets, and has no need for still-live
735 At the outermost level, (new|del)_X*V macros return bodies of the
736 appropriate type. These macros call either (new|del)_body_type or
737 (new|del)_body_allocated macro pairs, depending on specifics of the
738 type. Most body types use the former pair, the latter pair is used to
739 allocate body types with "ghost fields".
741 "ghost fields" are fields that are unused in certain types, and
742 consequently dont need to actually exist. They are declared because
743 they're part of a "base type", which allows use of functions as
744 methods. The simplest examples are AVs and HVs, 2 aggregate types
745 which don't use the fields which support SCALAR semantics.
747 For these types, the arenas are carved up into *_allocated size
748 chunks, we thus avoid wasted memory for those unaccessed members.
749 When bodies are allocated, we adjust the pointer back in memory by the
750 size of the bit not allocated, so it's as if we allocated the full
751 structure. (But things will all go boom if you write to the part that
752 is "not there", because you'll be overwriting the last members of the
753 preceding structure in memory.)
755 We calculate the correction using the STRUCT_OFFSET macro. For
756 example, if xpv_allocated is the same structure as XPV then the two
757 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
758 structure is smaller (no initial NV actually allocated) then the net
759 effect is to subtract the size of the NV from the pointer, to return a
760 new pointer as if an initial NV were actually allocated.
762 This is the same trick as was used for NV and IV bodies. Ironically it
763 doesn't need to be used for NV bodies any more, because NV is now at
764 the start of the structure. IV bodies don't need it either, because
765 they are no longer allocated.
767 In turn, the new_body_* allocators call S_new_body(), which invokes
768 new_body_inline macro, which takes a lock, and takes a body off the
769 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
770 necessary to refresh an empty list. Then the lock is released, and
771 the body is returned.
773 S_more_bodies calls get_arena(), and carves it up into an array of N
774 bodies, which it strings into a linked list. It looks up arena-size
775 and body-size from the body_details table described below, thus
776 supporting the multiple body-types.
778 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
779 the (new|del)_X*V macros are mapped directly to malloc/free.
785 For each sv-type, struct body_details bodies_by_type[] carries
786 parameters which control these aspects of SV handling:
788 Arena_size determines whether arenas are used for this body type, and if
789 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
790 zero, forcing individual mallocs and frees.
792 Body_size determines how big a body is, and therefore how many fit into
793 each arena. Offset carries the body-pointer adjustment needed for
794 *_allocated body types, and is used in *_allocated macros.
796 But its main purpose is to parameterize info needed in
797 Perl_sv_upgrade(). The info here dramatically simplifies the function
798 vs the implementation in 5.8.7, making it table-driven. All fields
799 are used for this, except for arena_size.
801 For the sv-types that have no bodies, arenas are not used, so those
802 PL_body_roots[sv_type] are unused, and can be overloaded. In
803 something of a special case, SVt_NULL is borrowed for HE arenas;
804 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
805 bodies_by_type[SVt_NULL] slot is not used, as the table is not
808 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
809 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
810 just use the same allocation semantics. At first, PTEs were also
811 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
812 bugs, so was simplified by claiming a new slot. This choice has no
813 consequence at this time.
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* A macro to work out the offset needed to subtract from a pointer to (say)
867 to make its members accessible via a pointer to (say)
877 #define relative_STRUCT_OFFSET(longer, shorter, member) \
878 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
880 /* Calculate the length to copy. Specifically work out the length less any
881 final padding the compiler needed to add. See the comment in sv_upgrade
882 for why copying the padding proved to be a bug. */
884 #define copy_length(type, last_member) \
885 STRUCT_OFFSET(type, last_member) \
886 + sizeof (((type*)SvANY((SV*)0))->last_member)
888 static const struct body_details bodies_by_type[] = {
889 { sizeof(HE), 0, 0, SVt_NULL,
890 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
892 /* The bind placeholder pretends to be an RV for now.
893 Also it's marked as "can't upgrade" to stop anyone using it before it's
895 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
897 /* IVs are in the head, so the allocation size is 0.
898 However, the slot is overloaded for PTEs. */
899 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
900 sizeof(IV), /* This is used to copy out the IV body. */
901 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
902 NOARENA /* IVS don't need an arena */,
903 /* But PTEs need to know the size of their arena */
904 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
909 FIT_ARENA(0, sizeof(NV)) },
911 /* 8 bytes on most ILP32 with IEEE doubles */
912 { sizeof(xpv_allocated),
913 copy_length(XPV, xpv_len)
914 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
916 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
919 { sizeof(xpviv_allocated),
920 copy_length(XPVIV, xiv_u)
921 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
923 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
926 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
930 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
934 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
935 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
936 SVt_REGEXP, FALSE, NONV, HASARENA,
937 FIT_ARENA(0, sizeof(struct regexp_allocated))
941 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
945 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
946 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
948 { sizeof(xpvav_allocated),
949 copy_length(XPVAV, xmg_stash)
950 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
952 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
954 { sizeof(xpvhv_allocated),
955 copy_length(XPVHV, xmg_stash)
956 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
958 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
961 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
962 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
963 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
965 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
966 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
967 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
969 /* XPVIO is 84 bytes, fits 48x */
970 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
971 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
972 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
975 #define new_body_type(sv_type) \
976 (void *)((char *)S_new_body(aTHX_ sv_type))
978 #define del_body_type(p, sv_type) \
979 del_body(p, &PL_body_roots[sv_type])
982 #define new_body_allocated(sv_type) \
983 (void *)((char *)S_new_body(aTHX_ sv_type) \
984 - bodies_by_type[sv_type].offset)
986 #define del_body_allocated(p, sv_type) \
987 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
990 #define my_safemalloc(s) (void*)safemalloc(s)
991 #define my_safecalloc(s) (void*)safecalloc(s, 1)
992 #define my_safefree(p) safefree((char*)p)
996 #define new_XNV() my_safemalloc(sizeof(XPVNV))
997 #define del_XNV(p) my_safefree(p)
999 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1000 #define del_XPVNV(p) my_safefree(p)
1002 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1003 #define del_XPVAV(p) my_safefree(p)
1005 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1006 #define del_XPVHV(p) my_safefree(p)
1008 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1009 #define del_XPVMG(p) my_safefree(p)
1011 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1012 #define del_XPVGV(p) my_safefree(p)
1016 #define new_XNV() new_body_type(SVt_NV)
1017 #define del_XNV(p) del_body_type(p, SVt_NV)
1019 #define new_XPVNV() new_body_type(SVt_PVNV)
1020 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1022 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1023 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1025 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1026 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1028 #define new_XPVMG() new_body_type(SVt_PVMG)
1029 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1031 #define new_XPVGV() new_body_type(SVt_PVGV)
1032 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1036 /* no arena for you! */
1038 #define new_NOARENA(details) \
1039 my_safemalloc((details)->body_size + (details)->offset)
1040 #define new_NOARENAZ(details) \
1041 my_safecalloc((details)->body_size + (details)->offset)
1044 S_more_bodies (pTHX_ const svtype sv_type)
1047 void ** const root = &PL_body_roots[sv_type];
1048 const struct body_details * const bdp = &bodies_by_type[sv_type];
1049 const size_t body_size = bdp->body_size;
1052 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1053 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1054 static bool done_sanity_check;
1056 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1057 * variables like done_sanity_check. */
1058 if (!done_sanity_check) {
1059 unsigned int i = SVt_LAST;
1061 done_sanity_check = TRUE;
1064 assert (bodies_by_type[i].type == i);
1068 assert(bdp->arena_size);
1070 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1072 end = start + arena_size - 2 * body_size;
1074 /* computed count doesnt reflect the 1st slot reservation */
1075 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1076 DEBUG_m(PerlIO_printf(Perl_debug_log,
1077 "arena %p end %p arena-size %d (from %d) type %d "
1079 (void*)start, (void*)end, (int)arena_size,
1080 (int)bdp->arena_size, sv_type, (int)body_size,
1081 (int)arena_size / (int)body_size));
1083 DEBUG_m(PerlIO_printf(Perl_debug_log,
1084 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1085 (void*)start, (void*)end,
1086 (int)bdp->arena_size, sv_type, (int)body_size,
1087 (int)bdp->arena_size / (int)body_size));
1089 *root = (void *)start;
1091 while (start <= end) {
1092 char * const next = start + body_size;
1093 *(void**) start = (void *)next;
1096 *(void **)start = 0;
1101 /* grab a new thing from the free list, allocating more if necessary.
1102 The inline version is used for speed in hot routines, and the
1103 function using it serves the rest (unless PURIFY).
1105 #define new_body_inline(xpv, sv_type) \
1107 void ** const r3wt = &PL_body_roots[sv_type]; \
1108 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1109 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1110 *(r3wt) = *(void**)(xpv); \
1116 S_new_body(pTHX_ const svtype sv_type)
1120 new_body_inline(xpv, sv_type);
1126 static const struct body_details fake_rv =
1127 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1130 =for apidoc sv_upgrade
1132 Upgrade an SV to a more complex form. Generally adds a new body type to the
1133 SV, then copies across as much information as possible from the old body.
1134 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1140 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1145 const svtype old_type = SvTYPE(sv);
1146 const struct body_details *new_type_details;
1147 const struct body_details *old_type_details
1148 = bodies_by_type + old_type;
1149 SV *referant = NULL;
1151 PERL_ARGS_ASSERT_SV_UPGRADE;
1153 if (new_type != SVt_PV && SvIsCOW(sv)) {
1154 sv_force_normal_flags(sv, 0);
1157 if (old_type == new_type)
1160 old_body = SvANY(sv);
1162 /* Copying structures onto other structures that have been neatly zeroed
1163 has a subtle gotcha. Consider XPVMG
1165 +------+------+------+------+------+-------+-------+
1166 | NV | CUR | LEN | IV | MAGIC | STASH |
1167 +------+------+------+------+------+-------+-------+
1168 0 4 8 12 16 20 24 28
1170 where NVs are aligned to 8 bytes, so that sizeof that structure is
1171 actually 32 bytes long, with 4 bytes of padding at the end:
1173 +------+------+------+------+------+-------+-------+------+
1174 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1175 +------+------+------+------+------+-------+-------+------+
1176 0 4 8 12 16 20 24 28 32
1178 so what happens if you allocate memory for this structure:
1180 +------+------+------+------+------+-------+-------+------+------+...
1181 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1182 +------+------+------+------+------+-------+-------+------+------+...
1183 0 4 8 12 16 20 24 28 32 36
1185 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1186 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1187 started out as zero once, but it's quite possible that it isn't. So now,
1188 rather than a nicely zeroed GP, you have it pointing somewhere random.
1191 (In fact, GP ends up pointing at a previous GP structure, because the
1192 principle cause of the padding in XPVMG getting garbage is a copy of
1193 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1194 this happens to be moot because XPVGV has been re-ordered, with GP
1195 no longer after STASH)
1197 So we are careful and work out the size of used parts of all the
1205 referant = SvRV(sv);
1206 old_type_details = &fake_rv;
1207 if (new_type == SVt_NV)
1208 new_type = SVt_PVNV;
1210 if (new_type < SVt_PVIV) {
1211 new_type = (new_type == SVt_NV)
1212 ? SVt_PVNV : SVt_PVIV;
1217 if (new_type < SVt_PVNV) {
1218 new_type = SVt_PVNV;
1222 assert(new_type > SVt_PV);
1223 assert(SVt_IV < SVt_PV);
1224 assert(SVt_NV < SVt_PV);
1231 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1232 there's no way that it can be safely upgraded, because perl.c
1233 expects to Safefree(SvANY(PL_mess_sv)) */
1234 assert(sv != PL_mess_sv);
1235 /* This flag bit is used to mean other things in other scalar types.
1236 Given that it only has meaning inside the pad, it shouldn't be set
1237 on anything that can get upgraded. */
1238 assert(!SvPAD_TYPED(sv));
1241 if (old_type_details->cant_upgrade)
1242 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1243 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1246 if (old_type > new_type)
1247 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1248 (int)old_type, (int)new_type);
1250 new_type_details = bodies_by_type + new_type;
1252 SvFLAGS(sv) &= ~SVTYPEMASK;
1253 SvFLAGS(sv) |= new_type;
1255 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1256 the return statements above will have triggered. */
1257 assert (new_type != SVt_NULL);
1260 assert(old_type == SVt_NULL);
1261 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1265 assert(old_type == SVt_NULL);
1266 SvANY(sv) = new_XNV();
1271 assert(new_type_details->body_size);
1274 assert(new_type_details->arena);
1275 assert(new_type_details->arena_size);
1276 /* This points to the start of the allocated area. */
1277 new_body_inline(new_body, new_type);
1278 Zero(new_body, new_type_details->body_size, char);
1279 new_body = ((char *)new_body) - new_type_details->offset;
1281 /* We always allocated the full length item with PURIFY. To do this
1282 we fake things so that arena is false for all 16 types.. */
1283 new_body = new_NOARENAZ(new_type_details);
1285 SvANY(sv) = new_body;
1286 if (new_type == SVt_PVAV) {
1290 if (old_type_details->body_size) {
1293 /* It will have been zeroed when the new body was allocated.
1294 Lets not write to it, in case it confuses a write-back
1300 #ifndef NODEFAULT_SHAREKEYS
1301 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1303 HvMAX(sv) = 7; /* (start with 8 buckets) */
1304 if (old_type_details->body_size) {
1307 /* It will have been zeroed when the new body was allocated.
1308 Lets not write to it, in case it confuses a write-back
1313 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1314 The target created by newSVrv also is, and it can have magic.
1315 However, it never has SvPVX set.
1317 if (old_type == SVt_IV) {
1319 } else if (old_type >= SVt_PV) {
1320 assert(SvPVX_const(sv) == 0);
1323 if (old_type >= SVt_PVMG) {
1324 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1325 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1327 sv->sv_u.svu_array = NULL; /* or svu_hash */
1333 /* XXX Is this still needed? Was it ever needed? Surely as there is
1334 no route from NV to PVIV, NOK can never be true */
1335 assert(!SvNOKp(sv));
1347 assert(new_type_details->body_size);
1348 /* We always allocated the full length item with PURIFY. To do this
1349 we fake things so that arena is false for all 16 types.. */
1350 if(new_type_details->arena) {
1351 /* This points to the start of the allocated area. */
1352 new_body_inline(new_body, new_type);
1353 Zero(new_body, new_type_details->body_size, char);
1354 new_body = ((char *)new_body) - new_type_details->offset;
1356 new_body = new_NOARENAZ(new_type_details);
1358 SvANY(sv) = new_body;
1360 if (old_type_details->copy) {
1361 /* There is now the potential for an upgrade from something without
1362 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1363 int offset = old_type_details->offset;
1364 int length = old_type_details->copy;
1366 if (new_type_details->offset > old_type_details->offset) {
1367 const int difference
1368 = new_type_details->offset - old_type_details->offset;
1369 offset += difference;
1370 length -= difference;
1372 assert (length >= 0);
1374 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1378 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1379 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1380 * correct 0.0 for us. Otherwise, if the old body didn't have an
1381 * NV slot, but the new one does, then we need to initialise the
1382 * freshly created NV slot with whatever the correct bit pattern is
1384 if (old_type_details->zero_nv && !new_type_details->zero_nv
1385 && !isGV_with_GP(sv))
1389 if (new_type == SVt_PVIO)
1390 IoPAGE_LEN(sv) = 60;
1391 if (old_type < SVt_PV) {
1392 /* referant will be NULL unless the old type was SVt_IV emulating
1394 sv->sv_u.svu_rv = referant;
1398 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1399 (unsigned long)new_type);
1402 if (old_type_details->arena) {
1403 /* If there was an old body, then we need to free it.
1404 Note that there is an assumption that all bodies of types that
1405 can be upgraded came from arenas. Only the more complex non-
1406 upgradable types are allowed to be directly malloc()ed. */
1408 my_safefree(old_body);
1410 del_body((void*)((char*)old_body + old_type_details->offset),
1411 &PL_body_roots[old_type]);
1417 =for apidoc sv_backoff
1419 Remove any string offset. You should normally use the C<SvOOK_off> macro
1426 Perl_sv_backoff(pTHX_ register SV *const sv)
1429 const char * const s = SvPVX_const(sv);
1431 PERL_ARGS_ASSERT_SV_BACKOFF;
1432 PERL_UNUSED_CONTEXT;
1435 assert(SvTYPE(sv) != SVt_PVHV);
1436 assert(SvTYPE(sv) != SVt_PVAV);
1438 SvOOK_offset(sv, delta);
1440 SvLEN_set(sv, SvLEN(sv) + delta);
1441 SvPV_set(sv, SvPVX(sv) - delta);
1442 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1443 SvFLAGS(sv) &= ~SVf_OOK;
1450 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1451 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1452 Use the C<SvGROW> wrapper instead.
1458 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1462 PERL_ARGS_ASSERT_SV_GROW;
1464 if (PL_madskills && newlen >= 0x100000) {
1465 PerlIO_printf(Perl_debug_log,
1466 "Allocation too large: %"UVxf"\n", (UV)newlen);
1468 #ifdef HAS_64K_LIMIT
1469 if (newlen >= 0x10000) {
1470 PerlIO_printf(Perl_debug_log,
1471 "Allocation too large: %"UVxf"\n", (UV)newlen);
1474 #endif /* HAS_64K_LIMIT */
1477 if (SvTYPE(sv) < SVt_PV) {
1478 sv_upgrade(sv, SVt_PV);
1479 s = SvPVX_mutable(sv);
1481 else if (SvOOK(sv)) { /* pv is offset? */
1483 s = SvPVX_mutable(sv);
1484 if (newlen > SvLEN(sv))
1485 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1486 #ifdef HAS_64K_LIMIT
1487 if (newlen >= 0x10000)
1492 s = SvPVX_mutable(sv);
1494 if (newlen > SvLEN(sv)) { /* need more room? */
1495 #ifndef Perl_safesysmalloc_size
1496 newlen = PERL_STRLEN_ROUNDUP(newlen);
1498 if (SvLEN(sv) && s) {
1499 s = (char*)saferealloc(s, newlen);
1502 s = (char*)safemalloc(newlen);
1503 if (SvPVX_const(sv) && SvCUR(sv)) {
1504 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1508 #ifdef Perl_safesysmalloc_size
1509 /* Do this here, do it once, do it right, and then we will never get
1510 called back into sv_grow() unless there really is some growing
1512 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1514 SvLEN_set(sv, newlen);
1521 =for apidoc sv_setiv
1523 Copies an integer into the given SV, upgrading first if necessary.
1524 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1530 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1534 PERL_ARGS_ASSERT_SV_SETIV;
1536 SV_CHECK_THINKFIRST_COW_DROP(sv);
1537 switch (SvTYPE(sv)) {
1540 sv_upgrade(sv, SVt_IV);
1543 sv_upgrade(sv, SVt_PVIV);
1552 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1556 (void)SvIOK_only(sv); /* validate number */
1562 =for apidoc sv_setiv_mg
1564 Like C<sv_setiv>, but also handles 'set' magic.
1570 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1572 PERL_ARGS_ASSERT_SV_SETIV_MG;
1579 =for apidoc sv_setuv
1581 Copies an unsigned integer into the given SV, upgrading first if necessary.
1582 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1588 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1590 PERL_ARGS_ASSERT_SV_SETUV;
1592 /* With these two if statements:
1593 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1596 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1598 If you wish to remove them, please benchmark to see what the effect is
1600 if (u <= (UV)IV_MAX) {
1601 sv_setiv(sv, (IV)u);
1610 =for apidoc sv_setuv_mg
1612 Like C<sv_setuv>, but also handles 'set' magic.
1618 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1620 PERL_ARGS_ASSERT_SV_SETUV_MG;
1627 =for apidoc sv_setnv
1629 Copies a double into the given SV, upgrading first if necessary.
1630 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1636 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1640 PERL_ARGS_ASSERT_SV_SETNV;
1642 SV_CHECK_THINKFIRST_COW_DROP(sv);
1643 switch (SvTYPE(sv)) {
1646 sv_upgrade(sv, SVt_NV);
1650 sv_upgrade(sv, SVt_PVNV);
1659 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1664 (void)SvNOK_only(sv); /* validate number */
1669 =for apidoc sv_setnv_mg
1671 Like C<sv_setnv>, but also handles 'set' magic.
1677 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1679 PERL_ARGS_ASSERT_SV_SETNV_MG;
1685 /* Print an "isn't numeric" warning, using a cleaned-up,
1686 * printable version of the offending string
1690 S_not_a_number(pTHX_ SV *const sv)
1697 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1700 dsv = newSVpvs_flags("", SVs_TEMP);
1701 pv = sv_uni_display(dsv, sv, 10, 0);
1704 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1705 /* each *s can expand to 4 chars + "...\0",
1706 i.e. need room for 8 chars */
1708 const char *s = SvPVX_const(sv);
1709 const char * const end = s + SvCUR(sv);
1710 for ( ; s < end && d < limit; s++ ) {
1712 if (ch & 128 && !isPRINT_LC(ch)) {
1721 else if (ch == '\r') {
1725 else if (ch == '\f') {
1729 else if (ch == '\\') {
1733 else if (ch == '\0') {
1737 else if (isPRINT_LC(ch))
1754 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1755 "Argument \"%s\" isn't numeric in %s", pv,
1758 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1759 "Argument \"%s\" isn't numeric", pv);
1763 =for apidoc looks_like_number
1765 Test if the content of an SV looks like a number (or is a number).
1766 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1767 non-numeric warning), even if your atof() doesn't grok them.
1773 Perl_looks_like_number(pTHX_ SV *const sv)
1775 register const char *sbegin;
1778 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1781 sbegin = SvPVX_const(sv);
1784 else if (SvPOKp(sv))
1785 sbegin = SvPV_const(sv, len);
1787 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1788 return grok_number(sbegin, len, NULL);
1792 S_glob_2number(pTHX_ GV * const gv)
1794 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1795 SV *const buffer = sv_newmortal();
1797 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1799 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1802 gv_efullname3(buffer, gv, "*");
1803 SvFLAGS(gv) |= wasfake;
1805 /* We know that all GVs stringify to something that is not-a-number,
1806 so no need to test that. */
1807 if (ckWARN(WARN_NUMERIC))
1808 not_a_number(buffer);
1809 /* We just want something true to return, so that S_sv_2iuv_common
1810 can tail call us and return true. */
1815 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1817 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1818 SV *const buffer = sv_newmortal();
1820 PERL_ARGS_ASSERT_GLOB_2PV;
1822 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1825 gv_efullname3(buffer, gv, "*");
1826 SvFLAGS(gv) |= wasfake;
1828 assert(SvPOK(buffer));
1830 *len = SvCUR(buffer);
1832 return SvPVX(buffer);
1835 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1836 until proven guilty, assume that things are not that bad... */
1841 As 64 bit platforms often have an NV that doesn't preserve all bits of
1842 an IV (an assumption perl has been based on to date) it becomes necessary
1843 to remove the assumption that the NV always carries enough precision to
1844 recreate the IV whenever needed, and that the NV is the canonical form.
1845 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1846 precision as a side effect of conversion (which would lead to insanity
1847 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1848 1) to distinguish between IV/UV/NV slots that have cached a valid
1849 conversion where precision was lost and IV/UV/NV slots that have a
1850 valid conversion which has lost no precision
1851 2) to ensure that if a numeric conversion to one form is requested that
1852 would lose precision, the precise conversion (or differently
1853 imprecise conversion) is also performed and cached, to prevent
1854 requests for different numeric formats on the same SV causing
1855 lossy conversion chains. (lossless conversion chains are perfectly
1860 SvIOKp is true if the IV slot contains a valid value
1861 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1862 SvNOKp is true if the NV slot contains a valid value
1863 SvNOK is true only if the NV value is accurate
1866 while converting from PV to NV, check to see if converting that NV to an
1867 IV(or UV) would lose accuracy over a direct conversion from PV to
1868 IV(or UV). If it would, cache both conversions, return NV, but mark
1869 SV as IOK NOKp (ie not NOK).
1871 While converting from PV to IV, check to see if converting that IV to an
1872 NV would lose accuracy over a direct conversion from PV to NV. If it
1873 would, cache both conversions, flag similarly.
1875 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1876 correctly because if IV & NV were set NV *always* overruled.
1877 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1878 changes - now IV and NV together means that the two are interchangeable:
1879 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1881 The benefit of this is that operations such as pp_add know that if
1882 SvIOK is true for both left and right operands, then integer addition
1883 can be used instead of floating point (for cases where the result won't
1884 overflow). Before, floating point was always used, which could lead to
1885 loss of precision compared with integer addition.
1887 * making IV and NV equal status should make maths accurate on 64 bit
1889 * may speed up maths somewhat if pp_add and friends start to use
1890 integers when possible instead of fp. (Hopefully the overhead in
1891 looking for SvIOK and checking for overflow will not outweigh the
1892 fp to integer speedup)
1893 * will slow down integer operations (callers of SvIV) on "inaccurate"
1894 values, as the change from SvIOK to SvIOKp will cause a call into
1895 sv_2iv each time rather than a macro access direct to the IV slot
1896 * should speed up number->string conversion on integers as IV is
1897 favoured when IV and NV are equally accurate
1899 ####################################################################
1900 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1901 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1902 On the other hand, SvUOK is true iff UV.
1903 ####################################################################
1905 Your mileage will vary depending your CPU's relative fp to integer
1909 #ifndef NV_PRESERVES_UV
1910 # define IS_NUMBER_UNDERFLOW_IV 1
1911 # define IS_NUMBER_UNDERFLOW_UV 2
1912 # define IS_NUMBER_IV_AND_UV 2
1913 # define IS_NUMBER_OVERFLOW_IV 4
1914 # define IS_NUMBER_OVERFLOW_UV 5
1916 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1918 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1920 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1928 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1930 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));
1931 if (SvNVX(sv) < (NV)IV_MIN) {
1932 (void)SvIOKp_on(sv);
1934 SvIV_set(sv, IV_MIN);
1935 return IS_NUMBER_UNDERFLOW_IV;
1937 if (SvNVX(sv) > (NV)UV_MAX) {
1938 (void)SvIOKp_on(sv);
1941 SvUV_set(sv, UV_MAX);
1942 return IS_NUMBER_OVERFLOW_UV;
1944 (void)SvIOKp_on(sv);
1946 /* Can't use strtol etc to convert this string. (See truth table in
1948 if (SvNVX(sv) <= (UV)IV_MAX) {
1949 SvIV_set(sv, I_V(SvNVX(sv)));
1950 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1951 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1953 /* Integer is imprecise. NOK, IOKp */
1955 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1958 SvUV_set(sv, U_V(SvNVX(sv)));
1959 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1960 if (SvUVX(sv) == UV_MAX) {
1961 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1962 possibly be preserved by NV. Hence, it must be overflow.
1964 return IS_NUMBER_OVERFLOW_UV;
1966 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1968 /* Integer is imprecise. NOK, IOKp */
1970 return IS_NUMBER_OVERFLOW_IV;
1972 #endif /* !NV_PRESERVES_UV*/
1975 S_sv_2iuv_common(pTHX_ SV *const sv)
1979 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1993 certainly cast into the IV range at IV_MAX, whereas the correct
1994 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1996 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1997 if (Perl_isnan(SvNVX(sv))) {
2003 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2004 SvIV_set(sv, I_V(SvNVX(sv)));
2005 if (SvNVX(sv) == (NV) SvIVX(sv)
2006 #ifndef NV_PRESERVES_UV
2007 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2008 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2009 /* Don't flag it as "accurately an integer" if the number
2010 came from a (by definition imprecise) NV operation, and
2011 we're outside the range of NV integer precision */
2015 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2017 /* scalar has trailing garbage, eg "42a" */
2019 DEBUG_c(PerlIO_printf(Perl_debug_log,
2020 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2026 /* IV not precise. No need to convert from PV, as NV
2027 conversion would already have cached IV if it detected
2028 that PV->IV would be better than PV->NV->IV
2029 flags already correct - don't set public IOK. */
2030 DEBUG_c(PerlIO_printf(Perl_debug_log,
2031 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2036 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2037 but the cast (NV)IV_MIN rounds to a the value less (more
2038 negative) than IV_MIN which happens to be equal to SvNVX ??
2039 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2040 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2041 (NV)UVX == NVX are both true, but the values differ. :-(
2042 Hopefully for 2s complement IV_MIN is something like
2043 0x8000000000000000 which will be exact. NWC */
2046 SvUV_set(sv, U_V(SvNVX(sv)));
2048 (SvNVX(sv) == (NV) SvUVX(sv))
2049 #ifndef NV_PRESERVES_UV
2050 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2051 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2052 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2053 /* Don't flag it as "accurately an integer" if the number
2054 came from a (by definition imprecise) NV operation, and
2055 we're outside the range of NV integer precision */
2061 DEBUG_c(PerlIO_printf(Perl_debug_log,
2062 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2068 else if (SvPOKp(sv) && SvLEN(sv)) {
2070 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2071 /* We want to avoid a possible problem when we cache an IV/ a UV which
2072 may be later translated to an NV, and the resulting NV is not
2073 the same as the direct translation of the initial string
2074 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2075 be careful to ensure that the value with the .456 is around if the
2076 NV value is requested in the future).
2078 This means that if we cache such an IV/a UV, we need to cache the
2079 NV as well. Moreover, we trade speed for space, and do not
2080 cache the NV if we are sure it's not needed.
2083 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2084 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2085 == IS_NUMBER_IN_UV) {
2086 /* It's definitely an integer, only upgrade to PVIV */
2087 if (SvTYPE(sv) < SVt_PVIV)
2088 sv_upgrade(sv, SVt_PVIV);
2090 } else if (SvTYPE(sv) < SVt_PVNV)
2091 sv_upgrade(sv, SVt_PVNV);
2093 /* If NVs preserve UVs then we only use the UV value if we know that
2094 we aren't going to call atof() below. If NVs don't preserve UVs
2095 then the value returned may have more precision than atof() will
2096 return, even though value isn't perfectly accurate. */
2097 if ((numtype & (IS_NUMBER_IN_UV
2098 #ifdef NV_PRESERVES_UV
2101 )) == IS_NUMBER_IN_UV) {
2102 /* This won't turn off the public IOK flag if it was set above */
2103 (void)SvIOKp_on(sv);
2105 if (!(numtype & IS_NUMBER_NEG)) {
2107 if (value <= (UV)IV_MAX) {
2108 SvIV_set(sv, (IV)value);
2110 /* it didn't overflow, and it was positive. */
2111 SvUV_set(sv, value);
2115 /* 2s complement assumption */
2116 if (value <= (UV)IV_MIN) {
2117 SvIV_set(sv, -(IV)value);
2119 /* Too negative for an IV. This is a double upgrade, but
2120 I'm assuming it will be rare. */
2121 if (SvTYPE(sv) < SVt_PVNV)
2122 sv_upgrade(sv, SVt_PVNV);
2126 SvNV_set(sv, -(NV)value);
2127 SvIV_set(sv, IV_MIN);
2131 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2132 will be in the previous block to set the IV slot, and the next
2133 block to set the NV slot. So no else here. */
2135 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2136 != IS_NUMBER_IN_UV) {
2137 /* It wasn't an (integer that doesn't overflow the UV). */
2138 SvNV_set(sv, Atof(SvPVX_const(sv)));
2140 if (! numtype && ckWARN(WARN_NUMERIC))
2143 #if defined(USE_LONG_DOUBLE)
2144 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2145 PTR2UV(sv), SvNVX(sv)));
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2151 #ifdef NV_PRESERVES_UV
2152 (void)SvIOKp_on(sv);
2154 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2155 SvIV_set(sv, I_V(SvNVX(sv)));
2156 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2159 NOOP; /* Integer is imprecise. NOK, IOKp */
2161 /* UV will not work better than IV */
2163 if (SvNVX(sv) > (NV)UV_MAX) {
2165 /* Integer is inaccurate. NOK, IOKp, is UV */
2166 SvUV_set(sv, UV_MAX);
2168 SvUV_set(sv, U_V(SvNVX(sv)));
2169 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2170 NV preservse UV so can do correct comparison. */
2171 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2174 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2179 #else /* NV_PRESERVES_UV */
2180 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2181 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2182 /* The IV/UV slot will have been set from value returned by
2183 grok_number above. The NV slot has just been set using
2186 assert (SvIOKp(sv));
2188 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2189 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2190 /* Small enough to preserve all bits. */
2191 (void)SvIOKp_on(sv);
2193 SvIV_set(sv, I_V(SvNVX(sv)));
2194 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2196 /* Assumption: first non-preserved integer is < IV_MAX,
2197 this NV is in the preserved range, therefore: */
2198 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2200 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);
2204 0 0 already failed to read UV.
2205 0 1 already failed to read UV.
2206 1 0 you won't get here in this case. IV/UV
2207 slot set, public IOK, Atof() unneeded.
2208 1 1 already read UV.
2209 so there's no point in sv_2iuv_non_preserve() attempting
2210 to use atol, strtol, strtoul etc. */
2212 sv_2iuv_non_preserve (sv, numtype);
2214 sv_2iuv_non_preserve (sv);
2218 #endif /* NV_PRESERVES_UV */
2219 /* It might be more code efficient to go through the entire logic above
2220 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2221 gets complex and potentially buggy, so more programmer efficient
2222 to do it this way, by turning off the public flags: */
2224 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2228 if (isGV_with_GP(sv))
2229 return glob_2number((GV *)sv);
2231 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2232 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2235 if (SvTYPE(sv) < SVt_IV)
2236 /* Typically the caller expects that sv_any is not NULL now. */
2237 sv_upgrade(sv, SVt_IV);
2238 /* Return 0 from the caller. */
2245 =for apidoc sv_2iv_flags
2247 Return the integer value of an SV, doing any necessary string
2248 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2249 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2255 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2260 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2261 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2262 cache IVs just in case. In practice it seems that they never
2263 actually anywhere accessible by user Perl code, let alone get used
2264 in anything other than a string context. */
2265 if (flags & SV_GMAGIC)
2270 return I_V(SvNVX(sv));
2272 if (SvPOKp(sv) && SvLEN(sv)) {
2275 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2278 == IS_NUMBER_IN_UV) {
2279 /* It's definitely an integer */
2280 if (numtype & IS_NUMBER_NEG) {
2281 if (value < (UV)IV_MIN)
2284 if (value < (UV)IV_MAX)
2289 if (ckWARN(WARN_NUMERIC))
2292 return I_V(Atof(SvPVX_const(sv)));
2297 assert(SvTYPE(sv) >= SVt_PVMG);
2298 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2299 } else if (SvTHINKFIRST(sv)) {
2303 SV * const tmpstr=AMG_CALLun(sv,numer);
2304 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2305 return SvIV(tmpstr);
2308 return PTR2IV(SvRV(sv));
2311 sv_force_normal_flags(sv, 0);
2313 if (SvREADONLY(sv) && !SvOK(sv)) {
2314 if (ckWARN(WARN_UNINITIALIZED))
2320 if (S_sv_2iuv_common(aTHX_ sv))
2323 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2324 PTR2UV(sv),SvIVX(sv)));
2325 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2329 =for apidoc sv_2uv_flags
2331 Return the unsigned integer value of an SV, doing any necessary string
2332 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2333 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2339 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2344 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2345 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2346 cache IVs just in case. */
2347 if (flags & SV_GMAGIC)
2352 return U_V(SvNVX(sv));
2353 if (SvPOKp(sv) && SvLEN(sv)) {
2356 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2358 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2359 == IS_NUMBER_IN_UV) {
2360 /* It's definitely an integer */
2361 if (!(numtype & IS_NUMBER_NEG))
2365 if (ckWARN(WARN_NUMERIC))
2368 return U_V(Atof(SvPVX_const(sv)));
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2375 } else if (SvTHINKFIRST(sv)) {
2379 SV *const tmpstr = AMG_CALLun(sv,numer);
2380 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2381 return SvUV(tmpstr);
2384 return PTR2UV(SvRV(sv));
2387 sv_force_normal_flags(sv, 0);
2389 if (SvREADONLY(sv) && !SvOK(sv)) {
2390 if (ckWARN(WARN_UNINITIALIZED))
2396 if (S_sv_2iuv_common(aTHX_ sv))
2400 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2401 PTR2UV(sv),SvUVX(sv)));
2402 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2408 Return the num value of an SV, doing any necessary string or integer
2409 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2416 Perl_sv_2nv(pTHX_ register SV *const sv)
2421 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2422 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2423 cache IVs just in case. */
2427 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2428 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2429 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2431 return Atof(SvPVX_const(sv));
2435 return (NV)SvUVX(sv);
2437 return (NV)SvIVX(sv);
2442 assert(SvTYPE(sv) >= SVt_PVMG);
2443 /* This falls through to the report_uninit near the end of the
2445 } else if (SvTHINKFIRST(sv)) {
2449 SV *const tmpstr = AMG_CALLun(sv,numer);
2450 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 return SvNV(tmpstr);
2454 return PTR2NV(SvRV(sv));
2457 sv_force_normal_flags(sv, 0);
2459 if (SvREADONLY(sv) && !SvOK(sv)) {
2460 if (ckWARN(WARN_UNINITIALIZED))
2465 if (SvTYPE(sv) < SVt_NV) {
2466 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2467 sv_upgrade(sv, SVt_NV);
2468 #ifdef USE_LONG_DOUBLE
2470 STORE_NUMERIC_LOCAL_SET_STANDARD();
2471 PerlIO_printf(Perl_debug_log,
2472 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2473 PTR2UV(sv), SvNVX(sv));
2474 RESTORE_NUMERIC_LOCAL();
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2480 PTR2UV(sv), SvNVX(sv));
2481 RESTORE_NUMERIC_LOCAL();
2485 else if (SvTYPE(sv) < SVt_PVNV)
2486 sv_upgrade(sv, SVt_PVNV);
2491 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2492 #ifdef NV_PRESERVES_UV
2498 /* Only set the public NV OK flag if this NV preserves the IV */
2499 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2501 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2502 : (SvIVX(sv) == I_V(SvNVX(sv))))
2508 else if (SvPOKp(sv) && SvLEN(sv)) {
2510 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2511 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2513 #ifdef NV_PRESERVES_UV
2514 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2515 == IS_NUMBER_IN_UV) {
2516 /* It's definitely an integer */
2517 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2519 SvNV_set(sv, Atof(SvPVX_const(sv)));
2525 SvNV_set(sv, Atof(SvPVX_const(sv)));
2526 /* Only set the public NV OK flag if this NV preserves the value in
2527 the PV at least as well as an IV/UV would.
2528 Not sure how to do this 100% reliably. */
2529 /* if that shift count is out of range then Configure's test is
2530 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2532 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2533 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2534 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2535 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2536 /* Can't use strtol etc to convert this string, so don't try.
2537 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2540 /* value has been set. It may not be precise. */
2541 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2542 /* 2s complement assumption for (UV)IV_MIN */
2543 SvNOK_on(sv); /* Integer is too negative. */
2548 if (numtype & IS_NUMBER_NEG) {
2549 SvIV_set(sv, -(IV)value);
2550 } else if (value <= (UV)IV_MAX) {
2551 SvIV_set(sv, (IV)value);
2553 SvUV_set(sv, value);
2557 if (numtype & IS_NUMBER_NOT_INT) {
2558 /* I believe that even if the original PV had decimals,
2559 they are lost beyond the limit of the FP precision.
2560 However, neither is canonical, so both only get p
2561 flags. NWC, 2000/11/25 */
2562 /* Both already have p flags, so do nothing */
2564 const NV nv = SvNVX(sv);
2565 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2566 if (SvIVX(sv) == I_V(nv)) {
2569 /* It had no "." so it must be integer. */
2573 /* between IV_MAX and NV(UV_MAX).
2574 Could be slightly > UV_MAX */
2576 if (numtype & IS_NUMBER_NOT_INT) {
2577 /* UV and NV both imprecise. */
2579 const UV nv_as_uv = U_V(nv);
2581 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2590 /* It might be more code efficient to go through the entire logic above
2591 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2592 gets complex and potentially buggy, so more programmer efficient
2593 to do it this way, by turning off the public flags: */
2595 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2596 #endif /* NV_PRESERVES_UV */
2599 if (isGV_with_GP(sv)) {
2600 glob_2number((GV *)sv);
2604 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2606 assert (SvTYPE(sv) >= SVt_NV);
2607 /* Typically the caller expects that sv_any is not NULL now. */
2608 /* XXX Ilya implies that this is a bug in callers that assume this
2609 and ideally should be fixed. */
2612 #if defined(USE_LONG_DOUBLE)
2614 STORE_NUMERIC_LOCAL_SET_STANDARD();
2615 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2616 PTR2UV(sv), SvNVX(sv));
2617 RESTORE_NUMERIC_LOCAL();
2621 STORE_NUMERIC_LOCAL_SET_STANDARD();
2622 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2623 PTR2UV(sv), SvNVX(sv));
2624 RESTORE_NUMERIC_LOCAL();
2633 Return an SV with the numeric value of the source SV, doing any necessary
2634 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2635 access this function.
2641 Perl_sv_2num(pTHX_ register SV *const sv)
2643 PERL_ARGS_ASSERT_SV_2NUM;
2648 SV * const tmpsv = AMG_CALLun(sv,numer);
2649 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2650 return sv_2num(tmpsv);
2652 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2655 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2656 * UV as a string towards the end of buf, and return pointers to start and
2659 * We assume that buf is at least TYPE_CHARS(UV) long.
2663 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2665 char *ptr = buf + TYPE_CHARS(UV);
2666 char * const ebuf = ptr;
2669 PERL_ARGS_ASSERT_UIV_2BUF;
2681 *--ptr = '0' + (char)(uv % 10);
2690 =for apidoc sv_2pv_flags
2692 Returns a pointer to the string value of an SV, and sets *lp to its length.
2693 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2695 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2696 usually end up here too.
2702 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2712 if (SvGMAGICAL(sv)) {
2713 if (flags & SV_GMAGIC)
2718 if (flags & SV_MUTABLE_RETURN)
2719 return SvPVX_mutable(sv);
2720 if (flags & SV_CONST_RETURN)
2721 return (char *)SvPVX_const(sv);
2724 if (SvIOKp(sv) || SvNOKp(sv)) {
2725 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2730 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2731 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2733 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2740 #ifdef FIXNEGATIVEZERO
2741 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2747 SvUPGRADE(sv, SVt_PV);
2750 s = SvGROW_mutable(sv, len + 1);
2753 return (char*)memcpy(s, tbuf, len + 1);
2759 assert(SvTYPE(sv) >= SVt_PVMG);
2760 /* This falls through to the report_uninit near the end of the
2762 } else if (SvTHINKFIRST(sv)) {
2766 SV *const tmpstr = AMG_CALLun(sv,string);
2767 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2769 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2773 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2774 if (flags & SV_CONST_RETURN) {
2775 pv = (char *) SvPVX_const(tmpstr);
2777 pv = (flags & SV_MUTABLE_RETURN)
2778 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2781 *lp = SvCUR(tmpstr);
2783 pv = sv_2pv_flags(tmpstr, lp, flags);
2796 const SV *const referent = (SV*)SvRV(sv);
2800 retval = buffer = savepvn("NULLREF", len);
2801 } else if (SvTYPE(referent) == SVt_REGEXP) {
2802 const REGEXP * const re = (REGEXP *)referent;
2807 /* If the regex is UTF-8 we want the containing scalar to
2808 have an UTF-8 flag too */
2814 if ((seen_evals = RX_SEEN_EVALS(re)))
2815 PL_reginterp_cnt += seen_evals;
2818 *lp = RX_WRAPLEN(re);
2820 return RX_WRAPPED(re);
2822 const char *const typestr = sv_reftype(referent, 0);
2823 const STRLEN typelen = strlen(typestr);
2824 UV addr = PTR2UV(referent);
2825 const char *stashname = NULL;
2826 STRLEN stashnamelen = 0; /* hush, gcc */
2827 const char *buffer_end;
2829 if (SvOBJECT(referent)) {
2830 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2833 stashname = HEK_KEY(name);
2834 stashnamelen = HEK_LEN(name);
2836 if (HEK_UTF8(name)) {
2842 stashname = "__ANON__";
2845 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2846 + 2 * sizeof(UV) + 2 /* )\0 */;
2848 len = typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2852 Newx(buffer, len, char);
2853 buffer_end = retval = buffer + len;
2855 /* Working backwards */
2859 *--retval = PL_hexdigit[addr & 15];
2860 } while (addr >>= 4);
2866 memcpy(retval, typestr, typelen);
2870 retval -= stashnamelen;
2871 memcpy(retval, stashname, stashnamelen);
2873 /* retval may not neccesarily have reached the start of the
2875 assert (retval >= buffer);
2877 len = buffer_end - retval - 1; /* -1 for that \0 */
2885 if (SvREADONLY(sv) && !SvOK(sv)) {
2888 if (flags & SV_UNDEF_RETURNS_NULL)
2890 if (ckWARN(WARN_UNINITIALIZED))
2895 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2896 /* I'm assuming that if both IV and NV are equally valid then
2897 converting the IV is going to be more efficient */
2898 const U32 isUIOK = SvIsUV(sv);
2899 char buf[TYPE_CHARS(UV)];
2903 if (SvTYPE(sv) < SVt_PVIV)
2904 sv_upgrade(sv, SVt_PVIV);
2905 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2907 /* inlined from sv_setpvn */
2908 s = SvGROW_mutable(sv, len + 1);
2909 Move(ptr, s, len, char);
2913 else if (SvNOKp(sv)) {
2914 const int olderrno = errno;
2915 if (SvTYPE(sv) < SVt_PVNV)
2916 sv_upgrade(sv, SVt_PVNV);
2917 /* The +20 is pure guesswork. Configure test needed. --jhi */
2918 s = SvGROW_mutable(sv, NV_DIG + 20);
2919 /* some Xenix systems wipe out errno here */
2921 if (SvNVX(sv) == 0.0)
2922 my_strlcpy(s, "0", SvLEN(sv));
2926 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2929 #ifdef FIXNEGATIVEZERO
2930 if (*s == '-' && s[1] == '0' && !s[2]) {
2942 if (isGV_with_GP(sv))
2943 return glob_2pv((GV *)sv, lp);
2947 if (flags & SV_UNDEF_RETURNS_NULL)
2949 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2951 if (SvTYPE(sv) < SVt_PV)
2952 /* Typically the caller expects that sv_any is not NULL now. */
2953 sv_upgrade(sv, SVt_PV);
2957 const STRLEN len = s - SvPVX_const(sv);
2963 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2964 PTR2UV(sv),SvPVX_const(sv)));
2965 if (flags & SV_CONST_RETURN)
2966 return (char *)SvPVX_const(sv);
2967 if (flags & SV_MUTABLE_RETURN)
2968 return SvPVX_mutable(sv);
2973 =for apidoc sv_copypv
2975 Copies a stringified representation of the source SV into the
2976 destination SV. Automatically performs any necessary mg_get and
2977 coercion of numeric values into strings. Guaranteed to preserve
2978 UTF8 flag even from overloaded objects. Similar in nature to
2979 sv_2pv[_flags] but operates directly on an SV instead of just the
2980 string. Mostly uses sv_2pv_flags to do its work, except when that
2981 would lose the UTF-8'ness of the PV.
2987 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2990 const char * const s = SvPV_const(ssv,len);
2992 PERL_ARGS_ASSERT_SV_COPYPV;
2994 sv_setpvn(dsv,s,len);
3002 =for apidoc sv_2pvbyte
3004 Return a pointer to the byte-encoded representation of the SV, and set *lp
3005 to its length. May cause the SV to be downgraded from UTF-8 as a
3008 Usually accessed via the C<SvPVbyte> macro.
3014 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3016 PERL_ARGS_ASSERT_SV_2PVBYTE;
3018 sv_utf8_downgrade(sv,0);
3019 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3023 =for apidoc sv_2pvutf8
3025 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3026 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3028 Usually accessed via the C<SvPVutf8> macro.
3034 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3036 PERL_ARGS_ASSERT_SV_2PVUTF8;
3038 sv_utf8_upgrade(sv);
3039 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3044 =for apidoc sv_2bool
3046 This function is only called on magical items, and is only used by
3047 sv_true() or its macro equivalent.
3053 Perl_sv_2bool(pTHX_ register SV *const sv)
3057 PERL_ARGS_ASSERT_SV_2BOOL;
3065 SV * const tmpsv = AMG_CALLun(sv,bool_);
3066 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3067 return (bool)SvTRUE(tmpsv);
3069 return SvRV(sv) != 0;
3072 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3074 (*sv->sv_u.svu_pv > '0' ||
3075 Xpvtmp->xpv_cur > 1 ||
3076 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3083 return SvIVX(sv) != 0;
3086 return SvNVX(sv) != 0.0;
3088 if (isGV_with_GP(sv))
3098 =for apidoc sv_utf8_upgrade
3100 Converts the PV of an SV to its UTF-8-encoded form.
3101 Forces the SV to string form if it is not already.
3102 Always sets the SvUTF8 flag to avoid future validity checks even
3103 if all the bytes have hibit clear.
3105 This is not as a general purpose byte encoding to Unicode interface:
3106 use the Encode extension for that.
3108 =for apidoc sv_utf8_upgrade_flags
3110 Converts the PV of an SV to its UTF-8-encoded form.
3111 Forces the SV to string form if it is not already.
3112 Always sets the SvUTF8 flag to avoid future validity checks even
3113 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3114 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3115 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3117 This is not as a general purpose byte encoding to Unicode interface:
3118 use the Encode extension for that.
3124 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3128 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3130 if (sv == &PL_sv_undef)
3134 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3135 (void) sv_2pv_flags(sv,&len, flags);
3139 (void) SvPV_force(sv,len);
3148 sv_force_normal_flags(sv, 0);
3151 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3152 sv_recode_to_utf8(sv, PL_encoding);
3153 else { /* Assume Latin-1/EBCDIC */
3154 /* This function could be much more efficient if we
3155 * had a FLAG in SVs to signal if there are any hibit
3156 * chars in the PV. Given that there isn't such a flag
3157 * make the loop as fast as possible. */
3158 const U8 * const s = (U8 *) SvPVX_const(sv);
3159 const U8 * const e = (U8 *) SvEND(sv);
3164 /* Check for hi bit */
3165 if (!NATIVE_IS_INVARIANT(ch)) {
3166 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3167 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3169 SvPV_free(sv); /* No longer using what was there before. */
3170 SvPV_set(sv, (char*)recoded);
3171 SvCUR_set(sv, len - 1);
3172 SvLEN_set(sv, len); /* No longer know the real size. */
3176 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3183 =for apidoc sv_utf8_downgrade
3185 Attempts to convert the PV of an SV from characters to bytes.
3186 If the PV contains a character beyond byte, this conversion will fail;
3187 in this case, either returns false or, if C<fail_ok> is not
3190 This is not as a general purpose Unicode to byte encoding interface:
3191 use the Encode extension for that.
3197 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3201 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3203 if (SvPOKp(sv) && SvUTF8(sv)) {
3209 sv_force_normal_flags(sv, 0);
3211 s = (U8 *) SvPV(sv, len);
3212 if (!utf8_to_bytes(s, &len)) {
3217 Perl_croak(aTHX_ "Wide character in %s",
3220 Perl_croak(aTHX_ "Wide character");
3231 =for apidoc sv_utf8_encode
3233 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3234 flag off so that it looks like octets again.
3240 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3242 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3245 sv_force_normal_flags(sv, 0);
3247 if (SvREADONLY(sv)) {
3248 Perl_croak(aTHX_ PL_no_modify);
3250 (void) sv_utf8_upgrade(sv);
3255 =for apidoc sv_utf8_decode
3257 If the PV of the SV is an octet sequence in UTF-8
3258 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3259 so that it looks like a character. If the PV contains only single-byte
3260 characters, the C<SvUTF8> flag stays being off.
3261 Scans PV for validity and returns false if the PV is invalid UTF-8.
3267 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3269 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3275 /* The octets may have got themselves encoded - get them back as
3278 if (!sv_utf8_downgrade(sv, TRUE))
3281 /* it is actually just a matter of turning the utf8 flag on, but
3282 * we want to make sure everything inside is valid utf8 first.
3284 c = (const U8 *) SvPVX_const(sv);
3285 if (!is_utf8_string(c, SvCUR(sv)+1))
3287 e = (const U8 *) SvEND(sv);
3290 if (!UTF8_IS_INVARIANT(ch)) {
3300 =for apidoc sv_setsv
3302 Copies the contents of the source SV C<ssv> into the destination SV
3303 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3304 function if the source SV needs to be reused. Does not handle 'set' magic.
3305 Loosely speaking, it performs a copy-by-value, obliterating any previous
3306 content of the destination.
3308 You probably want to use one of the assortment of wrappers, such as
3309 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3310 C<SvSetMagicSV_nosteal>.
3312 =for apidoc sv_setsv_flags
3314 Copies the contents of the source SV C<ssv> into the destination SV
3315 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3316 function if the source SV needs to be reused. Does not handle 'set' magic.
3317 Loosely speaking, it performs a copy-by-value, obliterating any previous
3318 content of the destination.
3319 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3320 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3321 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3322 and C<sv_setsv_nomg> are implemented in terms of this function.
3324 You probably want to use one of the assortment of wrappers, such as
3325 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3326 C<SvSetMagicSV_nosteal>.
3328 This is the primary function for copying scalars, and most other
3329 copy-ish functions and macros use this underneath.
3335 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3337 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3339 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3341 if (dtype != SVt_PVGV) {
3342 const char * const name = GvNAME(sstr);
3343 const STRLEN len = GvNAMELEN(sstr);
3345 if (dtype >= SVt_PV) {
3351 SvUPGRADE(dstr, SVt_PVGV);
3352 (void)SvOK_off(dstr);
3353 /* FIXME - why are we doing this, then turning it off and on again
3355 isGV_with_GP_on(dstr);
3357 GvSTASH(dstr) = GvSTASH(sstr);
3359 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3360 gv_name_set((GV *)dstr, name, len, GV_ADD);
3361 SvFAKE_on(dstr); /* can coerce to non-glob */
3364 #ifdef GV_UNIQUE_CHECK
3365 if (GvUNIQUE((GV*)dstr)) {
3366 Perl_croak(aTHX_ PL_no_modify);
3370 if(GvGP((GV*)sstr)) {
3371 /* If source has method cache entry, clear it */
3373 SvREFCNT_dec(GvCV(sstr));
3377 /* If source has a real method, then a method is
3379 else if(GvCV((GV*)sstr)) {
3384 /* If dest already had a real method, that's a change as well */
3385 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3389 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3393 isGV_with_GP_off(dstr);
3394 (void)SvOK_off(dstr);
3395 isGV_with_GP_on(dstr);
3396 GvINTRO_off(dstr); /* one-shot flag */
3397 GvGP(dstr) = gp_ref(GvGP(sstr));
3398 if (SvTAINTED(sstr))
3400 if (GvIMPORTED(dstr) != GVf_IMPORTED
3401 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3403 GvIMPORTED_on(dstr);
3406 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3407 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3412 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3414 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3416 const int intro = GvINTRO(dstr);
3419 const U32 stype = SvTYPE(sref);
3421 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3423 #ifdef GV_UNIQUE_CHECK
3424 if (GvUNIQUE((GV*)dstr)) {
3425 Perl_croak(aTHX_ PL_no_modify);
3430 GvINTRO_off(dstr); /* one-shot flag */
3431 GvLINE(dstr) = CopLINE(PL_curcop);
3432 GvEGV(dstr) = (GV*)dstr;
3437 location = (SV **) &GvCV(dstr);
3438 import_flag = GVf_IMPORTED_CV;
3441 location = (SV **) &GvHV(dstr);
3442 import_flag = GVf_IMPORTED_HV;
3445 location = (SV **) &GvAV(dstr);
3446 import_flag = GVf_IMPORTED_AV;
3449 location = (SV **) &GvIOp(dstr);
3452 location = (SV **) &GvFORM(dstr);
3454 location = &GvSV(dstr);
3455 import_flag = GVf_IMPORTED_SV;
3458 if (stype == SVt_PVCV) {
3459 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3460 if (GvCVGEN(dstr)) {
3461 SvREFCNT_dec(GvCV(dstr));
3463 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3466 SAVEGENERICSV(*location);
3470 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3471 CV* const cv = (CV*)*location;
3473 if (!GvCVGEN((GV*)dstr) &&
3474 (CvROOT(cv) || CvXSUB(cv)))
3476 /* Redefining a sub - warning is mandatory if
3477 it was a const and its value changed. */
3478 if (CvCONST(cv) && CvCONST((CV*)sref)
3479 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3481 /* They are 2 constant subroutines generated from
3482 the same constant. This probably means that
3483 they are really the "same" proxy subroutine
3484 instantiated in 2 places. Most likely this is
3485 when a constant is exported twice. Don't warn.
3488 else if (ckWARN(WARN_REDEFINE)
3490 && (!CvCONST((CV*)sref)
3491 || sv_cmp(cv_const_sv(cv),
3492 cv_const_sv((CV*)sref))))) {
3493 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3496 ? "Constant subroutine %s::%s redefined"
3497 : "Subroutine %s::%s redefined"),
3498 HvNAME_get(GvSTASH((GV*)dstr)),
3499 GvENAME((GV*)dstr));
3503 cv_ckproto_len(cv, (GV*)dstr,
3504 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3505 SvPOK(sref) ? SvCUR(sref) : 0);
3507 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3508 GvASSUMECV_on(dstr);
3509 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3512 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3513 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3514 GvFLAGS(dstr) |= import_flag;
3519 if (SvTAINTED(sstr))
3525 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3528 register U32 sflags;
3530 register svtype stype;
3532 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3537 if (SvIS_FREED(dstr)) {
3538 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3539 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3541 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3543 sstr = &PL_sv_undef;
3544 if (SvIS_FREED(sstr)) {
3545 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3546 (void*)sstr, (void*)dstr);
3548 stype = SvTYPE(sstr);
3549 dtype = SvTYPE(dstr);
3551 (void)SvAMAGIC_off(dstr);
3554 /* need to nuke the magic */
3556 SvRMAGICAL_off(dstr);
3559 /* There's a lot of redundancy below but we're going for speed here */
3564 if (dtype != SVt_PVGV) {
3565 (void)SvOK_off(dstr);
3573 sv_upgrade(dstr, SVt_IV);
3577 sv_upgrade(dstr, SVt_PVIV);
3580 goto end_of_first_switch;
3582 (void)SvIOK_only(dstr);
3583 SvIV_set(dstr, SvIVX(sstr));
3586 /* SvTAINTED can only be true if the SV has taint magic, which in
3587 turn means that the SV type is PVMG (or greater). This is the
3588 case statement for SVt_IV, so this cannot be true (whatever gcov
3590 assert(!SvTAINTED(sstr));
3595 if (dtype < SVt_PV && dtype != SVt_IV)
3596 sv_upgrade(dstr, SVt_IV);
3604 sv_upgrade(dstr, SVt_NV);
3608 sv_upgrade(dstr, SVt_PVNV);
3611 goto end_of_first_switch;
3613 SvNV_set(dstr, SvNVX(sstr));
3614 (void)SvNOK_only(dstr);
3615 /* SvTAINTED can only be true if the SV has taint magic, which in
3616 turn means that the SV type is PVMG (or greater). This is the
3617 case statement for SVt_NV, so this cannot be true (whatever gcov
3619 assert(!SvTAINTED(sstr));
3625 #ifdef PERL_OLD_COPY_ON_WRITE
3626 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3627 if (dtype < SVt_PVIV)
3628 sv_upgrade(dstr, SVt_PVIV);
3636 sv_upgrade(dstr, SVt_PV);
3639 if (dtype < SVt_PVIV)
3640 sv_upgrade(dstr, SVt_PVIV);
3643 if (dtype < SVt_PVNV)
3644 sv_upgrade(dstr, SVt_PVNV);
3648 const char * const type = sv_reftype(sstr,0);
3650 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3652 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3656 /* case SVt_BIND: */
3659 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3660 glob_assign_glob(dstr, sstr, dtype);
3663 /* SvVALID means that this PVGV is playing at being an FBM. */
3667 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3669 if (SvTYPE(sstr) != stype) {
3670 stype = SvTYPE(sstr);
3671 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3672 glob_assign_glob(dstr, sstr, dtype);
3677 if (stype == SVt_PVLV)
3678 SvUPGRADE(dstr, SVt_PVNV);
3680 SvUPGRADE(dstr, (svtype)stype);
3682 end_of_first_switch:
3684 /* dstr may have been upgraded. */
3685 dtype = SvTYPE(dstr);
3686 sflags = SvFLAGS(sstr);
3688 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3689 /* Assigning to a subroutine sets the prototype. */
3692 const char *const ptr = SvPV_const(sstr, len);
3694 SvGROW(dstr, len + 1);
3695 Copy(ptr, SvPVX(dstr), len + 1, char);
3696 SvCUR_set(dstr, len);
3698 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3702 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3703 const char * const type = sv_reftype(dstr,0);
3705 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3707 Perl_croak(aTHX_ "Cannot copy to %s", type);
3708 } else if (sflags & SVf_ROK) {
3709 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3710 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3713 if (GvIMPORTED(dstr) != GVf_IMPORTED
3714 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3716 GvIMPORTED_on(dstr);
3721 if (isGV_with_GP(sstr)) {
3722 glob_assign_glob(dstr, sstr, dtype);
3727 if (dtype >= SVt_PV) {
3728 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3729 glob_assign_ref(dstr, sstr);
3732 if (SvPVX_const(dstr)) {
3738 (void)SvOK_off(dstr);
3739 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3740 SvFLAGS(dstr) |= sflags & SVf_ROK;
3741 assert(!(sflags & SVp_NOK));
3742 assert(!(sflags & SVp_IOK));
3743 assert(!(sflags & SVf_NOK));
3744 assert(!(sflags & SVf_IOK));
3746 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3747 if (!(sflags & SVf_OK)) {
3748 if (ckWARN(WARN_MISC))
3749 Perl_warner(aTHX_ packWARN(WARN_MISC),
3750 "Undefined value assigned to typeglob");
3753 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3754 if (dstr != (SV*)gv) {
3757 GvGP(dstr) = gp_ref(GvGP(gv));
3761 else if (sflags & SVp_POK) {
3765 * Check to see if we can just swipe the string. If so, it's a
3766 * possible small lose on short strings, but a big win on long ones.
3767 * It might even be a win on short strings if SvPVX_const(dstr)
3768 * has to be allocated and SvPVX_const(sstr) has to be freed.
3769 * Likewise if we can set up COW rather than doing an actual copy, we
3770 * drop to the else clause, as the swipe code and the COW setup code
3771 * have much in common.
3774 /* Whichever path we take through the next code, we want this true,
3775 and doing it now facilitates the COW check. */
3776 (void)SvPOK_only(dstr);
3779 /* If we're already COW then this clause is not true, and if COW
3780 is allowed then we drop down to the else and make dest COW
3781 with us. If caller hasn't said that we're allowed to COW
3782 shared hash keys then we don't do the COW setup, even if the
3783 source scalar is a shared hash key scalar. */
3784 (((flags & SV_COW_SHARED_HASH_KEYS)
3785 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3786 : 1 /* If making a COW copy is forbidden then the behaviour we
3787 desire is as if the source SV isn't actually already
3788 COW, even if it is. So we act as if the source flags
3789 are not COW, rather than actually testing them. */
3791 #ifndef PERL_OLD_COPY_ON_WRITE
3792 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3793 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3794 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3795 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3796 but in turn, it's somewhat dead code, never expected to go
3797 live, but more kept as a placeholder on how to do it better
3798 in a newer implementation. */
3799 /* If we are COW and dstr is a suitable target then we drop down
3800 into the else and make dest a COW of us. */
3801 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3806 (sflags & SVs_TEMP) && /* slated for free anyway? */
3807 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3808 (!(flags & SV_NOSTEAL)) &&
3809 /* and we're allowed to steal temps */
3810 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3811 SvLEN(sstr) && /* and really is a string */
3812 /* and won't be needed again, potentially */
3813 !(PL_op && PL_op->op_type == OP_AASSIGN))
3814 #ifdef PERL_OLD_COPY_ON_WRITE
3815 && ((flags & SV_COW_SHARED_HASH_KEYS)
3816 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3817 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3818 && SvTYPE(sstr) >= SVt_PVIV))
3822 /* Failed the swipe test, and it's not a shared hash key either.
3823 Have to copy the string. */
3824 STRLEN len = SvCUR(sstr);
3825 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3826 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3827 SvCUR_set(dstr, len);
3828 *SvEND(dstr) = '\0';
3830 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3832 /* Either it's a shared hash key, or it's suitable for
3833 copy-on-write or we can swipe the string. */
3835 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3839 #ifdef PERL_OLD_COPY_ON_WRITE
3841 /* I believe I should acquire a global SV mutex if
3842 it's a COW sv (not a shared hash key) to stop
3843 it going un copy-on-write.
3844 If the source SV has gone un copy on write between up there
3845 and down here, then (assert() that) it is of the correct
3846 form to make it copy on write again */
3847 if ((sflags & (SVf_FAKE | SVf_READONLY))
3848 != (SVf_FAKE | SVf_READONLY)) {
3849 SvREADONLY_on(sstr);
3851 /* Make the source SV into a loop of 1.
3852 (about to become 2) */
3853 SV_COW_NEXT_SV_SET(sstr, sstr);
3857 /* Initial code is common. */
3858 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3863 /* making another shared SV. */
3864 STRLEN cur = SvCUR(sstr);
3865 STRLEN len = SvLEN(sstr);
3866 #ifdef PERL_OLD_COPY_ON_WRITE
3868 assert (SvTYPE(dstr) >= SVt_PVIV);
3869 /* SvIsCOW_normal */
3870 /* splice us in between source and next-after-source. */
3871 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3872 SV_COW_NEXT_SV_SET(sstr, dstr);
3873 SvPV_set(dstr, SvPVX_mutable(sstr));
3877 /* SvIsCOW_shared_hash */
3878 DEBUG_C(PerlIO_printf(Perl_debug_log,
3879 "Copy on write: Sharing hash\n"));
3881 assert (SvTYPE(dstr) >= SVt_PV);
3883 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3885 SvLEN_set(dstr, len);
3886 SvCUR_set(dstr, cur);
3887 SvREADONLY_on(dstr);
3889 /* Relesase a global SV mutex. */
3892 { /* Passes the swipe test. */
3893 SvPV_set(dstr, SvPVX_mutable(sstr));
3894 SvLEN_set(dstr, SvLEN(sstr));
3895 SvCUR_set(dstr, SvCUR(sstr));
3898 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3899 SvPV_set(sstr, NULL);
3905 if (sflags & SVp_NOK) {
3906 SvNV_set(dstr, SvNVX(sstr));
3908 if (sflags & SVp_IOK) {
3909 SvIV_set(dstr, SvIVX(sstr));
3910 /* Must do this otherwise some other overloaded use of 0x80000000
3911 gets confused. I guess SVpbm_VALID */
3912 if (sflags & SVf_IVisUV)
3915 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3917 const MAGIC * const smg = SvVSTRING_mg(sstr);
3919 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3920 smg->mg_ptr, smg->mg_len);
3921 SvRMAGICAL_on(dstr);
3925 else if (sflags & (SVp_IOK|SVp_NOK)) {
3926 (void)SvOK_off(dstr);
3927 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3928 if (sflags & SVp_IOK) {
3929 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3930 SvIV_set(dstr, SvIVX(sstr));
3932 if (sflags & SVp_NOK) {
3933 SvNV_set(dstr, SvNVX(sstr));
3937 if (isGV_with_GP(sstr)) {
3938 /* This stringification rule for globs is spread in 3 places.
3939 This feels bad. FIXME. */
3940 const U32 wasfake = sflags & SVf_FAKE;
3942 /* FAKE globs can get coerced, so need to turn this off
3943 temporarily if it is on. */
3945 gv_efullname3(dstr, (GV *)sstr, "*");
3946 SvFLAGS(sstr) |= wasfake;
3949 (void)SvOK_off(dstr);
3951 if (SvTAINTED(sstr))
3956 =for apidoc sv_setsv_mg
3958 Like C<sv_setsv>, but also handles 'set' magic.
3964 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3966 PERL_ARGS_ASSERT_SV_SETSV_MG;
3968 sv_setsv(dstr,sstr);
3972 #ifdef PERL_OLD_COPY_ON_WRITE
3974 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3976 STRLEN cur = SvCUR(sstr);
3977 STRLEN len = SvLEN(sstr);
3978 register char *new_pv;
3980 PERL_ARGS_ASSERT_SV_SETSV_COW;
3983 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3984 (void*)sstr, (void*)dstr);
3991 if (SvTHINKFIRST(dstr))
3992 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3993 else if (SvPVX_const(dstr))
3994 Safefree(SvPVX_const(dstr));
3998 SvUPGRADE(dstr, SVt_PVIV);
4000 assert (SvPOK(sstr));
4001 assert (SvPOKp(sstr));
4002 assert (!SvIOK(sstr));
4003 assert (!SvIOKp(sstr));
4004 assert (!SvNOK(sstr));
4005 assert (!SvNOKp(sstr));
4007 if (SvIsCOW(sstr)) {
4009 if (SvLEN(sstr) == 0) {
4010 /* source is a COW shared hash key. */
4011 DEBUG_C(PerlIO_printf(Perl_debug_log,
4012 "Fast copy on write: Sharing hash\n"));
4013 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4016 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4018 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4019 SvUPGRADE(sstr, SVt_PVIV);
4020 SvREADONLY_on(sstr);
4022 DEBUG_C(PerlIO_printf(Perl_debug_log,
4023 "Fast copy on write: Converting sstr to COW\n"));
4024 SV_COW_NEXT_SV_SET(dstr, sstr);
4026 SV_COW_NEXT_SV_SET(sstr, dstr);
4027 new_pv = SvPVX_mutable(sstr);
4030 SvPV_set(dstr, new_pv);
4031 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4034 SvLEN_set(dstr, len);
4035 SvCUR_set(dstr, cur);
4044 =for apidoc sv_setpvn
4046 Copies a string into an SV. The C<len> parameter indicates the number of
4047 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4048 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4054 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4057 register char *dptr;
4059 PERL_ARGS_ASSERT_SV_SETPVN;
4061 SV_CHECK_THINKFIRST_COW_DROP(sv);
4067 /* len is STRLEN which is unsigned, need to copy to signed */
4070 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4072 SvUPGRADE(sv, SVt_PV);
4074 dptr = SvGROW(sv, len + 1);
4075 Move(ptr,dptr,len,char);
4078 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4083 =for apidoc sv_setpvn_mg
4085 Like C<sv_setpvn>, but also handles 'set' magic.
4091 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4093 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4095 sv_setpvn(sv,ptr,len);
4100 =for apidoc sv_setpv
4102 Copies a string into an SV. The string must be null-terminated. Does not
4103 handle 'set' magic. See C<sv_setpv_mg>.
4109 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4112 register STRLEN len;
4114 PERL_ARGS_ASSERT_SV_SETPV;
4116 SV_CHECK_THINKFIRST_COW_DROP(sv);
4122 SvUPGRADE(sv, SVt_PV);
4124 SvGROW(sv, len + 1);
4125 Move(ptr,SvPVX(sv),len+1,char);
4127 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4132 =for apidoc sv_setpv_mg
4134 Like C<sv_setpv>, but also handles 'set' magic.
4140 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4142 PERL_ARGS_ASSERT_SV_SETPV_MG;
4149 =for apidoc sv_usepvn_flags
4151 Tells an SV to use C<ptr> to find its string value. Normally the
4152 string is stored inside the SV but sv_usepvn allows the SV to use an
4153 outside string. The C<ptr> should point to memory that was allocated
4154 by C<malloc>. The string length, C<len>, must be supplied. By default
4155 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4156 so that pointer should not be freed or used by the programmer after
4157 giving it to sv_usepvn, and neither should any pointers from "behind"
4158 that pointer (e.g. ptr + 1) be used.
4160 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4161 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4162 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4163 C<len>, and already meets the requirements for storing in C<SvPVX>)
4169 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4174 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4176 SV_CHECK_THINKFIRST_COW_DROP(sv);
4177 SvUPGRADE(sv, SVt_PV);
4180 if (flags & SV_SMAGIC)
4184 if (SvPVX_const(sv))
4188 if (flags & SV_HAS_TRAILING_NUL)
4189 assert(ptr[len] == '\0');
4192 allocate = (flags & SV_HAS_TRAILING_NUL)
4194 #ifdef Perl_safesysmalloc_size
4197 PERL_STRLEN_ROUNDUP(len + 1);
4199 if (flags & SV_HAS_TRAILING_NUL) {
4200 /* It's long enough - do nothing.
4201 Specfically Perl_newCONSTSUB is relying on this. */
4204 /* Force a move to shake out bugs in callers. */
4205 char *new_ptr = (char*)safemalloc(allocate);
4206 Copy(ptr, new_ptr, len, char);
4207 PoisonFree(ptr,len,char);
4211 ptr = (char*) saferealloc (ptr, allocate);
4214 #ifdef Perl_safesysmalloc_size
4215 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4217 SvLEN_set(sv, allocate);
4221 if (!(flags & SV_HAS_TRAILING_NUL)) {
4224 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4226 if (flags & SV_SMAGIC)
4230 #ifdef PERL_OLD_COPY_ON_WRITE
4231 /* Need to do this *after* making the SV normal, as we need the buffer
4232 pointer to remain valid until after we've copied it. If we let go too early,
4233 another thread could invalidate it by unsharing last of the same hash key
4234 (which it can do by means other than releasing copy-on-write Svs)
4235 or by changing the other copy-on-write SVs in the loop. */
4237 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4239 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4241 { /* this SV was SvIsCOW_normal(sv) */
4242 /* we need to find the SV pointing to us. */
4243 SV *current = SV_COW_NEXT_SV(after);
4245 if (current == sv) {
4246 /* The SV we point to points back to us (there were only two of us
4248 Hence other SV is no longer copy on write either. */
4250 SvREADONLY_off(after);
4252 /* We need to follow the pointers around the loop. */
4254 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4257 /* don't loop forever if the structure is bust, and we have
4258 a pointer into a closed loop. */
4259 assert (current != after);
4260 assert (SvPVX_const(current) == pvx);
4262 /* Make the SV before us point to the SV after us. */
4263 SV_COW_NEXT_SV_SET(current, after);
4269 =for apidoc sv_force_normal_flags
4271 Undo various types of fakery on an SV: if the PV is a shared string, make
4272 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4273 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4274 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4275 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4276 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4277 set to some other value.) In addition, the C<flags> parameter gets passed to
4278 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4279 with flags set to 0.
4285 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4289 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4291 #ifdef PERL_OLD_COPY_ON_WRITE
4292 if (SvREADONLY(sv)) {
4293 /* At this point I believe I should acquire a global SV mutex. */
4295 const char * const pvx = SvPVX_const(sv);
4296 const STRLEN len = SvLEN(sv);
4297 const STRLEN cur = SvCUR(sv);
4298 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4299 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4300 we'll fail an assertion. */
4301 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4304 PerlIO_printf(Perl_debug_log,
4305 "Copy on write: Force normal %ld\n",
4311 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4314 if (flags & SV_COW_DROP_PV) {
4315 /* OK, so we don't need to copy our buffer. */
4318 SvGROW(sv, cur + 1);
4319 Move(pvx,SvPVX(sv),cur,char);
4324 sv_release_COW(sv, pvx, next);
4326 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4332 else if (IN_PERL_RUNTIME)
4333 Perl_croak(aTHX_ PL_no_modify);
4334 /* At this point I believe that I can drop the global SV mutex. */
4337 if (SvREADONLY(sv)) {
4339 const char * const pvx = SvPVX_const(sv);
4340 const STRLEN len = SvCUR(sv);
4345 SvGROW(sv, len + 1);
4346 Move(pvx,SvPVX(sv),len,char);
4348 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4350 else if (IN_PERL_RUNTIME)
4351 Perl_croak(aTHX_ PL_no_modify);
4355 sv_unref_flags(sv, flags);
4356 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4363 Efficient removal of characters from the beginning of the string buffer.
4364 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4365 the string buffer. The C<ptr> becomes the first character of the adjusted
4366 string. Uses the "OOK hack".
4367 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4368 refer to the same chunk of data.
4374 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4380 const U8 *real_start;
4383 PERL_ARGS_ASSERT_SV_CHOP;
4385 if (!ptr || !SvPOKp(sv))
4387 delta = ptr - SvPVX_const(sv);
4389 /* Nothing to do. */
4392 assert(ptr > SvPVX_const(sv));
4393 SV_CHECK_THINKFIRST(sv);
4396 if (!SvLEN(sv)) { /* make copy of shared string */
4397 const char *pvx = SvPVX_const(sv);
4398 const STRLEN len = SvCUR(sv);
4399 SvGROW(sv, len + 1);
4400 Move(pvx,SvPVX(sv),len,char);
4403 SvFLAGS(sv) |= SVf_OOK;
4406 SvOOK_offset(sv, old_delta);
4408 SvLEN_set(sv, SvLEN(sv) - delta);
4409 SvCUR_set(sv, SvCUR(sv) - delta);
4410 SvPV_set(sv, SvPVX(sv) + delta);
4412 p = (U8 *)SvPVX_const(sv);
4417 real_start = p - delta;
4421 if (delta < 0x100) {
4425 p -= sizeof(STRLEN);
4426 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4430 /* Fill the preceding buffer with sentinals to verify that no-one is
4432 while (p > real_start) {
4440 =for apidoc sv_catpvn
4442 Concatenates the string onto the end of the string which is in the SV. The
4443 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4444 status set, then the bytes appended should be valid UTF-8.
4445 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4447 =for apidoc sv_catpvn_flags
4449 Concatenates the string onto the end of the string which is in the SV. The
4450 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4451 status set, then the bytes appended should be valid UTF-8.
4452 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4453 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4454 in terms of this function.
4460 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4464 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4466 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4468 SvGROW(dsv, dlen + slen + 1);
4470 sstr = SvPVX_const(dsv);
4471 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4472 SvCUR_set(dsv, SvCUR(dsv) + slen);
4474 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4476 if (flags & SV_SMAGIC)
4481 =for apidoc sv_catsv
4483 Concatenates the string from SV C<ssv> onto the end of the string in
4484 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4485 not 'set' magic. See C<sv_catsv_mg>.
4487 =for apidoc sv_catsv_flags
4489 Concatenates the string from SV C<ssv> onto the end of the string in
4490 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4491 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4492 and C<sv_catsv_nomg> are implemented in terms of this function.
4497 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4501 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4505 const char *spv = SvPV_const(ssv, slen);
4507 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4508 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4509 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4510 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4511 dsv->sv_flags doesn't have that bit set.
4512 Andy Dougherty 12 Oct 2001
4514 const I32 sutf8 = DO_UTF8(ssv);
4517 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4519 dutf8 = DO_UTF8(dsv);
4521 if (dutf8 != sutf8) {
4523 /* Not modifying source SV, so taking a temporary copy. */
4524 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4526 sv_utf8_upgrade(csv);
4527 spv = SvPV_const(csv, slen);
4530 sv_utf8_upgrade_nomg(dsv);
4532 sv_catpvn_nomg(dsv, spv, slen);
4535 if (flags & SV_SMAGIC)
4540 =for apidoc sv_catpv
4542 Concatenates the string onto the end of the string which is in the SV.
4543 If the SV has the UTF-8 status set, then the bytes appended should be
4544 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4549 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4552 register STRLEN len;
4556 PERL_ARGS_ASSERT_SV_CATPV;
4560 junk = SvPV_force(sv, tlen);
4562 SvGROW(sv, tlen + len + 1);
4564 ptr = SvPVX_const(sv);
4565 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4566 SvCUR_set(sv, SvCUR(sv) + len);
4567 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4572 =for apidoc sv_catpv_mg
4574 Like C<sv_catpv>, but also handles 'set' magic.
4580 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4582 PERL_ARGS_ASSERT_SV_CATPV_MG;
4591 Creates a new SV. A non-zero C<len> parameter indicates the number of
4592 bytes of preallocated string space the SV should have. An extra byte for a
4593 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4594 space is allocated.) The reference count for the new SV is set to 1.
4596 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4597 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4598 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4599 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4600 modules supporting older perls.
4606 Perl_newSV(pTHX_ const STRLEN len)
4613 sv_upgrade(sv, SVt_PV);
4614 SvGROW(sv, len + 1);
4619 =for apidoc sv_magicext
4621 Adds magic to an SV, upgrading it if necessary. Applies the
4622 supplied vtable and returns a pointer to the magic added.
4624 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4625 In particular, you can add magic to SvREADONLY SVs, and add more than
4626 one instance of the same 'how'.
4628 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4629 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4630 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4631 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4633 (This is now used as a subroutine by C<sv_magic>.)
4638 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4639 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4644 PERL_ARGS_ASSERT_SV_MAGICEXT;
4646 SvUPGRADE(sv, SVt_PVMG);
4647 Newxz(mg, 1, MAGIC);
4648 mg->mg_moremagic = SvMAGIC(sv);
4649 SvMAGIC_set(sv, mg);
4651 /* Sometimes a magic contains a reference loop, where the sv and
4652 object refer to each other. To prevent a reference loop that
4653 would prevent such objects being freed, we look for such loops
4654 and if we find one we avoid incrementing the object refcount.
4656 Note we cannot do this to avoid self-tie loops as intervening RV must
4657 have its REFCNT incremented to keep it in existence.
4660 if (!obj || obj == sv ||
4661 how == PERL_MAGIC_arylen ||
4662 how == PERL_MAGIC_symtab ||
4663 (SvTYPE(obj) == SVt_PVGV &&
4664 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4665 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4666 GvFORM(obj) == (CV*)sv)))
4671 mg->mg_obj = SvREFCNT_inc_simple(obj);
4672 mg->mg_flags |= MGf_REFCOUNTED;
4675 /* Normal self-ties simply pass a null object, and instead of
4676 using mg_obj directly, use the SvTIED_obj macro to produce a
4677 new RV as needed. For glob "self-ties", we are tieing the PVIO
4678 with an RV obj pointing to the glob containing the PVIO. In
4679 this case, to avoid a reference loop, we need to weaken the
4683 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4684 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4690 mg->mg_len = namlen;
4693 mg->mg_ptr = savepvn(name, namlen);
4694 else if (namlen == HEf_SVKEY)
4695 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4697 mg->mg_ptr = (char *) name;
4699 mg->mg_virtual = (MGVTBL *) vtable;
4703 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4708 =for apidoc sv_magic
4710 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4711 then adds a new magic item of type C<how> to the head of the magic list.
4713 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4714 handling of the C<name> and C<namlen> arguments.
4716 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4717 to add more than one instance of the same 'how'.
4723 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4724 const char *const name, const I32 namlen)
4727 const MGVTBL *vtable;
4730 PERL_ARGS_ASSERT_SV_MAGIC;
4732 #ifdef PERL_OLD_COPY_ON_WRITE
4734 sv_force_normal_flags(sv, 0);
4736 if (SvREADONLY(sv)) {
4738 /* its okay to attach magic to shared strings; the subsequent
4739 * upgrade to PVMG will unshare the string */
4740 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4743 && how != PERL_MAGIC_regex_global
4744 && how != PERL_MAGIC_bm
4745 && how != PERL_MAGIC_fm
4746 && how != PERL_MAGIC_sv
4747 && how != PERL_MAGIC_backref
4750 Perl_croak(aTHX_ PL_no_modify);
4753 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4754 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4755 /* sv_magic() refuses to add a magic of the same 'how' as an
4758 if (how == PERL_MAGIC_taint) {
4760 /* Any scalar which already had taint magic on which someone
4761 (erroneously?) did SvIOK_on() or similar will now be
4762 incorrectly sporting public "OK" flags. */
4763 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4771 vtable = &PL_vtbl_sv;
4773 case PERL_MAGIC_overload:
4774 vtable = &PL_vtbl_amagic;
4776 case PERL_MAGIC_overload_elem:
4777 vtable = &PL_vtbl_amagicelem;
4779 case PERL_MAGIC_overload_table:
4780 vtable = &PL_vtbl_ovrld;
4783 vtable = &PL_vtbl_bm;
4785 case PERL_MAGIC_regdata:
4786 vtable = &PL_vtbl_regdata;
4788 case PERL_MAGIC_regdatum:
4789 vtable = &PL_vtbl_regdatum;
4791 case PERL_MAGIC_env:
4792 vtable = &PL_vtbl_env;
4795 vtable = &PL_vtbl_fm;
4797 case PERL_MAGIC_envelem:
4798 vtable = &PL_vtbl_envelem;
4800 case PERL_MAGIC_regex_global:
4801 vtable = &PL_vtbl_mglob;
4803 case PERL_MAGIC_isa:
4804 vtable = &PL_vtbl_isa;
4806 case PERL_MAGIC_isaelem:
4807 vtable = &PL_vtbl_isaelem;
4809 case PERL_MAGIC_nkeys:
4810 vtable = &PL_vtbl_nkeys;
4812 case PERL_MAGIC_dbfile:
4815 case PERL_MAGIC_dbline:
4816 vtable = &PL_vtbl_dbline;
4818 #ifdef USE_LOCALE_COLLATE
4819 case PERL_MAGIC_collxfrm:
4820 vtable = &PL_vtbl_collxfrm;
4822 #endif /* USE_LOCALE_COLLATE */
4823 case PERL_MAGIC_tied:
4824 vtable = &PL_vtbl_pack;
4826 case PERL_MAGIC_tiedelem:
4827 case PERL_MAGIC_tiedscalar:
4828 vtable = &PL_vtbl_packelem;
4831 vtable = &PL_vtbl_regexp;
4833 case PERL_MAGIC_hints:
4834 /* As this vtable is all NULL, we can reuse it. */
4835 case PERL_MAGIC_sig:
4836 vtable = &PL_vtbl_sig;
4838 case PERL_MAGIC_sigelem:
4839 vtable = &PL_vtbl_sigelem;
4841 case PERL_MAGIC_taint:
4842 vtable = &PL_vtbl_taint;
4844 case PERL_MAGIC_uvar:
4845 vtable = &PL_vtbl_uvar;
4847 case PERL_MAGIC_vec:
4848 vtable = &PL_vtbl_vec;
4850 case PERL_MAGIC_arylen_p:
4851 case PERL_MAGIC_rhash:
4852 case PERL_MAGIC_symtab:
4853 case PERL_MAGIC_vstring:
4856 case PERL_MAGIC_utf8:
4857 vtable = &PL_vtbl_utf8;
4859 case PERL_MAGIC_substr:
4860 vtable = &PL_vtbl_substr;
4862 case PERL_MAGIC_defelem:
4863 vtable = &PL_vtbl_defelem;
4865 case PERL_MAGIC_arylen:
4866 vtable = &PL_vtbl_arylen;
4868 case PERL_MAGIC_pos:
4869 vtable = &PL_vtbl_pos;
4871 case PERL_MAGIC_backref:
4872 vtable = &PL_vtbl_backref;
4874 case PERL_MAGIC_hintselem:
4875 vtable = &PL_vtbl_hintselem;
4877 case PERL_MAGIC_ext:
4878 /* Reserved for use by extensions not perl internals. */
4879 /* Useful for attaching extension internal data to perl vars. */
4880 /* Note that multiple extensions may clash if magical scalars */
4881 /* etc holding private data from one are passed to another. */
4885 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4888 /* Rest of work is done else where */
4889 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4892 case PERL_MAGIC_taint:
4895 case PERL_MAGIC_ext:
4896 case PERL_MAGIC_dbfile:
4903 =for apidoc sv_unmagic
4905 Removes all magic of type C<type> from an SV.
4911 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4916 PERL_ARGS_ASSERT_SV_UNMAGIC;
4918 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4920 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4921 for (mg = *mgp; mg; mg = *mgp) {
4922 if (mg->mg_type == type) {
4923 const MGVTBL* const vtbl = mg->mg_virtual;
4924 *mgp = mg->mg_moremagic;
4925 if (vtbl && vtbl->svt_free)
4926 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4927 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4929 Safefree(mg->mg_ptr);
4930 else if (mg->mg_len == HEf_SVKEY)
4931 SvREFCNT_dec((SV*)mg->mg_ptr);
4932 else if (mg->mg_type == PERL_MAGIC_utf8)
4933 Safefree(mg->mg_ptr);
4935 if (mg->mg_flags & MGf_REFCOUNTED)
4936 SvREFCNT_dec(mg->mg_obj);
4940 mgp = &mg->mg_moremagic;
4944 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4945 SvMAGIC_set(sv, NULL);
4952 =for apidoc sv_rvweaken
4954 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4955 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4956 push a back-reference to this RV onto the array of backreferences
4957 associated with that magic. If the RV is magical, set magic will be
4958 called after the RV is cleared.
4964 Perl_sv_rvweaken(pTHX_ SV *const sv)
4968 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4970 if (!SvOK(sv)) /* let undefs pass */
4973 Perl_croak(aTHX_ "Can't weaken a nonreference");
4974 else if (SvWEAKREF(sv)) {
4975 if (ckWARN(WARN_MISC))
4976 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4980 Perl_sv_add_backref(aTHX_ tsv, sv);
4986 /* Give tsv backref magic if it hasn't already got it, then push a
4987 * back-reference to sv onto the array associated with the backref magic.
4991 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4996 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4998 if (SvTYPE(tsv) == SVt_PVHV) {
4999 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5003 /* There is no AV in the offical place - try a fixup. */
5004 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5007 /* Aha. They've got it stowed in magic. Bring it back. */
5008 av = (AV*)mg->mg_obj;
5009 /* Stop mg_free decreasing the refernce count. */
5011 /* Stop mg_free even calling the destructor, given that
5012 there's no AV to free up. */
5014 sv_unmagic(tsv, PERL_MAGIC_backref);
5018 SvREFCNT_inc_simple_void(av);
5023 const MAGIC *const mg
5024 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5026 av = (AV*)mg->mg_obj;
5030 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5031 /* av now has a refcnt of 2, which avoids it getting freed
5032 * before us during global cleanup. The extra ref is removed
5033 * by magic_killbackrefs() when tsv is being freed */
5036 if (AvFILLp(av) >= AvMAX(av)) {
5037 av_extend(av, AvFILLp(av)+1);
5039 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5042 /* delete a back-reference to ourselves from the backref magic associated
5043 * with the SV we point to.
5047 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5054 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5056 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5057 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5058 /* We mustn't attempt to "fix up" the hash here by moving the
5059 backreference array back to the hv_aux structure, as that is stored
5060 in the main HvARRAY(), and hfreentries assumes that no-one
5061 reallocates HvARRAY() while it is running. */
5064 const MAGIC *const mg
5065 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5067 av = (AV *)mg->mg_obj;
5070 if (PL_in_clean_all)
5072 Perl_croak(aTHX_ "panic: del_backref");
5079 /* We shouldn't be in here more than once, but for paranoia reasons lets
5081 for (i = AvFILLp(av); i >= 0; i--) {
5083 const SSize_t fill = AvFILLp(av);
5085 /* We weren't the last entry.
5086 An unordered list has this property that you can take the
5087 last element off the end to fill the hole, and it's still
5088 an unordered list :-)
5093 AvFILLp(av) = fill - 1;
5099 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5101 SV **svp = AvARRAY(av);
5103 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5104 PERL_UNUSED_ARG(sv);
5106 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5107 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5108 if (svp && !SvIS_FREED(av)) {
5109 SV *const *const last = svp + AvFILLp(av);
5111 while (svp <= last) {
5113 SV *const referrer = *svp;
5114 if (SvWEAKREF(referrer)) {
5115 /* XXX Should we check that it hasn't changed? */
5116 SvRV_set(referrer, 0);
5118 SvWEAKREF_off(referrer);
5119 SvSETMAGIC(referrer);
5120 } else if (SvTYPE(referrer) == SVt_PVGV ||
5121 SvTYPE(referrer) == SVt_PVLV) {
5122 /* You lookin' at me? */
5123 assert(GvSTASH(referrer));
5124 assert(GvSTASH(referrer) == (HV*)sv);
5125 GvSTASH(referrer) = 0;
5128 "panic: magic_killbackrefs (flags=%"UVxf")",
5129 (UV)SvFLAGS(referrer));
5137 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5142 =for apidoc sv_insert
5144 Inserts a string at the specified offset/length within the SV. Similar to
5145 the Perl substr() function. Handles get magic.
5147 =for apidoc sv_insert_flags
5149 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5155 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5160 register char *midend;
5161 register char *bigend;
5165 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5168 Perl_croak(aTHX_ "Can't modify non-existent substring");
5169 SvPV_force_flags(bigstr, curlen, flags);
5170 (void)SvPOK_only_UTF8(bigstr);
5171 if (offset + len > curlen) {
5172 SvGROW(bigstr, offset+len+1);
5173 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5174 SvCUR_set(bigstr, offset+len);
5178 i = littlelen - len;
5179 if (i > 0) { /* string might grow */
5180 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5181 mid = big + offset + len;
5182 midend = bigend = big + SvCUR(bigstr);
5185 while (midend > mid) /* shove everything down */
5186 *--bigend = *--midend;
5187 Move(little,big+offset,littlelen,char);
5188 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5193 Move(little,SvPVX(bigstr)+offset,len,char);
5198 big = SvPVX(bigstr);
5201 bigend = big + SvCUR(bigstr);
5203 if (midend > bigend)
5204 Perl_croak(aTHX_ "panic: sv_insert");
5206 if (mid - big > bigend - midend) { /* faster to shorten from end */
5208 Move(little, mid, littlelen,char);
5211 i = bigend - midend;
5213 Move(midend, mid, i,char);
5217 SvCUR_set(bigstr, mid - big);
5219 else if ((i = mid - big)) { /* faster from front */
5220 midend -= littlelen;
5222 Move(big, midend - i, i, char);
5223 sv_chop(bigstr,midend-i);
5225 Move(little, mid, littlelen,char);
5227 else if (littlelen) {
5228 midend -= littlelen;
5229 sv_chop(bigstr,midend);
5230 Move(little,midend,littlelen,char);
5233 sv_chop(bigstr,midend);
5239 =for apidoc sv_replace
5241 Make the first argument a copy of the second, then delete the original.
5242 The target SV physically takes over ownership of the body of the source SV
5243 and inherits its flags; however, the target keeps any magic it owns,
5244 and any magic in the source is discarded.
5245 Note that this is a rather specialist SV copying operation; most of the
5246 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5252 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5255 const U32 refcnt = SvREFCNT(sv);
5257 PERL_ARGS_ASSERT_SV_REPLACE;
5259 SV_CHECK_THINKFIRST_COW_DROP(sv);
5260 if (SvREFCNT(nsv) != 1) {
5261 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5262 UVuf " != 1)", (UV) SvREFCNT(nsv));
5264 if (SvMAGICAL(sv)) {
5268 sv_upgrade(nsv, SVt_PVMG);
5269 SvMAGIC_set(nsv, SvMAGIC(sv));
5270 SvFLAGS(nsv) |= SvMAGICAL(sv);
5272 SvMAGIC_set(sv, NULL);
5276 assert(!SvREFCNT(sv));
5277 #ifdef DEBUG_LEAKING_SCALARS
5278 sv->sv_flags = nsv->sv_flags;
5279 sv->sv_any = nsv->sv_any;
5280 sv->sv_refcnt = nsv->sv_refcnt;
5281 sv->sv_u = nsv->sv_u;
5283 StructCopy(nsv,sv,SV);
5285 if(SvTYPE(sv) == SVt_IV) {
5287 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5291 #ifdef PERL_OLD_COPY_ON_WRITE
5292 if (SvIsCOW_normal(nsv)) {
5293 /* We need to follow the pointers around the loop to make the
5294 previous SV point to sv, rather than nsv. */
5297 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5300 assert(SvPVX_const(current) == SvPVX_const(nsv));
5302 /* Make the SV before us point to the SV after us. */
5304 PerlIO_printf(Perl_debug_log, "previous is\n");
5306 PerlIO_printf(Perl_debug_log,
5307 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5308 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5310 SV_COW_NEXT_SV_SET(current, sv);
5313 SvREFCNT(sv) = refcnt;
5314 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5320 =for apidoc sv_clear
5322 Clear an SV: call any destructors, free up any memory used by the body,
5323 and free the body itself. The SV's head is I<not> freed, although
5324 its type is set to all 1's so that it won't inadvertently be assumed
5325 to be live during global destruction etc.
5326 This function should only be called when REFCNT is zero. Most of the time
5327 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5334 Perl_sv_clear(pTHX_ register SV *const sv)
5337 const U32 type = SvTYPE(sv);
5338 const struct body_details *const sv_type_details
5339 = bodies_by_type + type;
5342 PERL_ARGS_ASSERT_SV_CLEAR;
5343 assert(SvREFCNT(sv) == 0);
5344 assert(SvTYPE(sv) != SVTYPEMASK);
5346 if (type <= SVt_IV) {
5347 /* See the comment in sv.h about the collusion between this early
5348 return and the overloading of the NULL and IV slots in the size
5351 SV * const target = SvRV(sv);
5353 sv_del_backref(target, sv);
5355 SvREFCNT_dec(target);
5357 SvFLAGS(sv) &= SVf_BREAK;
5358 SvFLAGS(sv) |= SVTYPEMASK;
5363 if (PL_defstash && /* Still have a symbol table? */
5370 stash = SvSTASH(sv);
5371 destructor = StashHANDLER(stash,DESTROY);
5373 SV* const tmpref = newRV(sv);
5374 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5376 PUSHSTACKi(PERLSI_DESTROY);
5381 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5387 if(SvREFCNT(tmpref) < 2) {
5388 /* tmpref is not kept alive! */
5390 SvRV_set(tmpref, NULL);
5393 SvREFCNT_dec(tmpref);
5395 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5399 if (PL_in_clean_objs)
5400 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5402 /* DESTROY gave object new lease on life */
5408 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5409 SvOBJECT_off(sv); /* Curse the object. */
5410 if (type != SVt_PVIO)
5411 --PL_sv_objcount; /* XXX Might want something more general */
5414 if (type >= SVt_PVMG) {
5415 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5416 SvREFCNT_dec(SvOURSTASH(sv));
5417 } else if (SvMAGIC(sv))
5419 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5420 SvREFCNT_dec(SvSTASH(sv));
5423 /* case SVt_BIND: */
5426 IoIFP(sv) != PerlIO_stdin() &&
5427 IoIFP(sv) != PerlIO_stdout() &&
5428 IoIFP(sv) != PerlIO_stderr())
5430 io_close((IO*)sv, FALSE);
5432 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5433 PerlDir_close(IoDIRP(sv));
5434 IoDIRP(sv) = (DIR*)NULL;
5435 Safefree(IoTOP_NAME(sv));
5436 Safefree(IoFMT_NAME(sv));
5437 Safefree(IoBOTTOM_NAME(sv));
5440 /* FIXME for plugins */
5441 pregfree2((REGEXP*) sv);
5448 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5452 if (PL_comppad == (AV*)sv) {
5459 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5460 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5461 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5462 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5464 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5465 SvREFCNT_dec(LvTARG(sv));
5467 if (isGV_with_GP(sv)) {
5468 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5469 mro_method_changed_in(stash);
5472 unshare_hek(GvNAME_HEK(sv));
5473 /* If we're in a stash, we don't own a reference to it. However it does
5474 have a back reference to us, which needs to be cleared. */
5475 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5476 sv_del_backref((SV*)stash, sv);
5478 /* FIXME. There are probably more unreferenced pointers to SVs in the
5479 interpreter struct that we should check and tidy in a similar
5481 if ((GV*)sv == PL_last_in_gv)
5482 PL_last_in_gv = NULL;
5488 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5491 SvOOK_offset(sv, offset);
5492 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5493 /* Don't even bother with turning off the OOK flag. */
5496 SV * const target = SvRV(sv);
5498 sv_del_backref(target, sv);
5500 SvREFCNT_dec(target);
5502 #ifdef PERL_OLD_COPY_ON_WRITE
5503 else if (SvPVX_const(sv)) {
5505 /* I believe I need to grab the global SV mutex here and
5506 then recheck the COW status. */
5508 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5512 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5514 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5517 /* And drop it here. */
5519 } else if (SvLEN(sv)) {
5520 Safefree(SvPVX_const(sv));
5524 else if (SvPVX_const(sv) && SvLEN(sv))
5525 Safefree(SvPVX_mutable(sv));
5526 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5527 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5536 SvFLAGS(sv) &= SVf_BREAK;
5537 SvFLAGS(sv) |= SVTYPEMASK;
5539 if (sv_type_details->arena) {
5540 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5541 &PL_body_roots[type]);
5543 else if (sv_type_details->body_size) {
5544 my_safefree(SvANY(sv));
5549 =for apidoc sv_newref
5551 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5558 Perl_sv_newref(pTHX_ SV *const sv)
5560 PERL_UNUSED_CONTEXT;
5569 Decrement an SV's reference count, and if it drops to zero, call
5570 C<sv_clear> to invoke destructors and free up any memory used by
5571 the body; finally, deallocate the SV's head itself.
5572 Normally called via a wrapper macro C<SvREFCNT_dec>.
5578 Perl_sv_free(pTHX_ SV *const sv)
5583 if (SvREFCNT(sv) == 0) {
5584 if (SvFLAGS(sv) & SVf_BREAK)
5585 /* this SV's refcnt has been artificially decremented to
5586 * trigger cleanup */
5588 if (PL_in_clean_all) /* All is fair */
5590 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5591 /* make sure SvREFCNT(sv)==0 happens very seldom */
5592 SvREFCNT(sv) = (~(U32)0)/2;
5595 if (ckWARN_d(WARN_INTERNAL)) {
5596 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5597 Perl_dump_sv_child(aTHX_ sv);
5599 #ifdef DEBUG_LEAKING_SCALARS
5602 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5603 if (PL_warnhook == PERL_WARNHOOK_FATAL
5604 || ckDEAD(packWARN(WARN_INTERNAL))) {
5605 /* Don't let Perl_warner cause us to escape our fate: */
5609 /* This may not return: */
5610 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5611 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5612 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5615 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5620 if (--(SvREFCNT(sv)) > 0)
5622 Perl_sv_free2(aTHX_ sv);
5626 Perl_sv_free2(pTHX_ SV *const sv)
5630 PERL_ARGS_ASSERT_SV_FREE2;
5634 if (ckWARN_d(WARN_DEBUGGING))
5635 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5636 "Attempt to free temp prematurely: SV 0x%"UVxf
5637 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5641 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5642 /* make sure SvREFCNT(sv)==0 happens very seldom */
5643 SvREFCNT(sv) = (~(U32)0)/2;
5654 Returns the length of the string in the SV. Handles magic and type
5655 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5661 Perl_sv_len(pTHX_ register SV *const sv)
5669 len = mg_length(sv);
5671 (void)SvPV_const(sv, len);
5676 =for apidoc sv_len_utf8
5678 Returns the number of characters in the string in an SV, counting wide
5679 UTF-8 bytes as a single character. Handles magic and type coercion.
5685 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5686 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5687 * (Note that the mg_len is not the length of the mg_ptr field.
5688 * This allows the cache to store the character length of the string without
5689 * needing to malloc() extra storage to attach to the mg_ptr.)
5694 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5700 return mg_length(sv);
5704 const U8 *s = (U8*)SvPV_const(sv, len);
5708 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5710 if (mg && mg->mg_len != -1) {
5712 if (PL_utf8cache < 0) {
5713 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5715 /* Need to turn the assertions off otherwise we may
5716 recurse infinitely while printing error messages.
5718 SAVEI8(PL_utf8cache);
5720 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5721 " real %"UVuf" for %"SVf,
5722 (UV) ulen, (UV) real, SVfARG(sv));
5727 ulen = Perl_utf8_length(aTHX_ s, s + len);
5728 if (!SvREADONLY(sv)) {
5730 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5731 &PL_vtbl_utf8, 0, 0);
5739 return Perl_utf8_length(aTHX_ s, s + len);
5743 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5746 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5749 const U8 *s = start;
5751 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5753 while (s < send && uoffset--)
5756 /* This is the existing behaviour. Possibly it should be a croak, as
5757 it's actually a bounds error */
5763 /* Given the length of the string in both bytes and UTF-8 characters, decide
5764 whether to walk forwards or backwards to find the byte corresponding to
5765 the passed in UTF-8 offset. */
5767 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5768 const STRLEN uoffset, const STRLEN uend)
5770 STRLEN backw = uend - uoffset;
5772 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5774 if (uoffset < 2 * backw) {
5775 /* The assumption is that going forwards is twice the speed of going
5776 forward (that's where the 2 * backw comes from).
5777 (The real figure of course depends on the UTF-8 data.) */
5778 return sv_pos_u2b_forwards(start, send, uoffset);
5783 while (UTF8_IS_CONTINUATION(*send))
5786 return send - start;
5789 /* For the string representation of the given scalar, find the byte
5790 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5791 give another position in the string, *before* the sought offset, which
5792 (which is always true, as 0, 0 is a valid pair of positions), which should
5793 help reduce the amount of linear searching.
5794 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5795 will be used to reduce the amount of linear searching. The cache will be
5796 created if necessary, and the found value offered to it for update. */
5798 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5799 const U8 *const send, const STRLEN uoffset,
5800 STRLEN uoffset0, STRLEN boffset0)
5802 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5805 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5807 assert (uoffset >= uoffset0);
5809 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5810 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5811 if ((*mgp)->mg_ptr) {
5812 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5813 if (cache[0] == uoffset) {
5814 /* An exact match. */
5817 if (cache[2] == uoffset) {
5818 /* An exact match. */
5822 if (cache[0] < uoffset) {
5823 /* The cache already knows part of the way. */
5824 if (cache[0] > uoffset0) {
5825 /* The cache knows more than the passed in pair */
5826 uoffset0 = cache[0];
5827 boffset0 = cache[1];
5829 if ((*mgp)->mg_len != -1) {
5830 /* And we know the end too. */
5832 + sv_pos_u2b_midway(start + boffset0, send,
5834 (*mgp)->mg_len - uoffset0);
5837 + sv_pos_u2b_forwards(start + boffset0,
5838 send, uoffset - uoffset0);
5841 else if (cache[2] < uoffset) {
5842 /* We're between the two cache entries. */
5843 if (cache[2] > uoffset0) {
5844 /* and the cache knows more than the passed in pair */
5845 uoffset0 = cache[2];
5846 boffset0 = cache[3];
5850 + sv_pos_u2b_midway(start + boffset0,
5853 cache[0] - uoffset0);
5856 + sv_pos_u2b_midway(start + boffset0,
5859 cache[2] - uoffset0);
5863 else if ((*mgp)->mg_len != -1) {
5864 /* If we can take advantage of a passed in offset, do so. */
5865 /* In fact, offset0 is either 0, or less than offset, so don't
5866 need to worry about the other possibility. */
5868 + sv_pos_u2b_midway(start + boffset0, send,
5870 (*mgp)->mg_len - uoffset0);
5875 if (!found || PL_utf8cache < 0) {
5876 const STRLEN real_boffset
5877 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5878 send, uoffset - uoffset0);
5880 if (found && PL_utf8cache < 0) {
5881 if (real_boffset != boffset) {
5882 /* Need to turn the assertions off otherwise we may recurse
5883 infinitely while printing error messages. */
5884 SAVEI8(PL_utf8cache);
5886 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5887 " real %"UVuf" for %"SVf,
5888 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5891 boffset = real_boffset;
5895 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5901 =for apidoc sv_pos_u2b
5903 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5904 the start of the string, to a count of the equivalent number of bytes; if
5905 lenp is non-zero, it does the same to lenp, but this time starting from
5906 the offset, rather than from the start of the string. Handles magic and
5913 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5914 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5915 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5920 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5925 PERL_ARGS_ASSERT_SV_POS_U2B;
5930 start = (U8*)SvPV_const(sv, len);
5932 STRLEN uoffset = (STRLEN) *offsetp;
5933 const U8 * const send = start + len;
5935 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5938 *offsetp = (I32) boffset;
5941 /* Convert the relative offset to absolute. */
5942 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5943 const STRLEN boffset2
5944 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5945 uoffset, boffset) - boffset;
5959 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5960 byte length pairing. The (byte) length of the total SV is passed in too,
5961 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5962 may not have updated SvCUR, so we can't rely on reading it directly.
5964 The proffered utf8/byte length pairing isn't used if the cache already has
5965 two pairs, and swapping either for the proffered pair would increase the
5966 RMS of the intervals between known byte offsets.
5968 The cache itself consists of 4 STRLEN values
5969 0: larger UTF-8 offset
5970 1: corresponding byte offset
5971 2: smaller UTF-8 offset
5972 3: corresponding byte offset
5974 Unused cache pairs have the value 0, 0.
5975 Keeping the cache "backwards" means that the invariant of
5976 cache[0] >= cache[2] is maintained even with empty slots, which means that
5977 the code that uses it doesn't need to worry if only 1 entry has actually
5978 been set to non-zero. It also makes the "position beyond the end of the
5979 cache" logic much simpler, as the first slot is always the one to start
5983 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5984 const STRLEN utf8, const STRLEN blen)
5988 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5994 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5996 (*mgp)->mg_len = -1;
6000 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6001 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6002 (*mgp)->mg_ptr = (char *) cache;
6006 if (PL_utf8cache < 0) {
6007 const U8 *start = (const U8 *) SvPVX_const(sv);
6008 const STRLEN realutf8 = utf8_length(start, start + byte);
6010 if (realutf8 != utf8) {
6011 /* Need to turn the assertions off otherwise we may recurse
6012 infinitely while printing error messages. */
6013 SAVEI8(PL_utf8cache);
6015 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6016 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6020 /* Cache is held with the later position first, to simplify the code
6021 that deals with unbounded ends. */
6023 ASSERT_UTF8_CACHE(cache);
6024 if (cache[1] == 0) {
6025 /* Cache is totally empty */
6028 } else if (cache[3] == 0) {
6029 if (byte > cache[1]) {
6030 /* New one is larger, so goes first. */
6031 cache[2] = cache[0];
6032 cache[3] = cache[1];
6040 #define THREEWAY_SQUARE(a,b,c,d) \
6041 ((float)((d) - (c))) * ((float)((d) - (c))) \
6042 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6043 + ((float)((b) - (a))) * ((float)((b) - (a)))
6045 /* Cache has 2 slots in use, and we know three potential pairs.
6046 Keep the two that give the lowest RMS distance. Do the
6047 calcualation in bytes simply because we always know the byte
6048 length. squareroot has the same ordering as the positive value,
6049 so don't bother with the actual square root. */
6050 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6051 if (byte > cache[1]) {
6052 /* New position is after the existing pair of pairs. */
6053 const float keep_earlier
6054 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6055 const float keep_later
6056 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6058 if (keep_later < keep_earlier) {
6059 if (keep_later < existing) {
6060 cache[2] = cache[0];
6061 cache[3] = cache[1];
6067 if (keep_earlier < existing) {
6073 else if (byte > cache[3]) {
6074 /* New position is between the existing pair of pairs. */
6075 const float keep_earlier
6076 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6077 const float keep_later
6078 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6080 if (keep_later < keep_earlier) {
6081 if (keep_later < existing) {
6087 if (keep_earlier < existing) {
6094 /* New position is before the existing pair of pairs. */
6095 const float keep_earlier
6096 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6097 const float keep_later
6098 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6100 if (keep_later < keep_earlier) {
6101 if (keep_later < existing) {
6107 if (keep_earlier < existing) {
6108 cache[0] = cache[2];
6109 cache[1] = cache[3];
6116 ASSERT_UTF8_CACHE(cache);
6119 /* We already know all of the way, now we may be able to walk back. The same
6120 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6121 backward is half the speed of walking forward. */
6123 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6124 const U8 *end, STRLEN endu)
6126 const STRLEN forw = target - s;
6127 STRLEN backw = end - target;
6129 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6131 if (forw < 2 * backw) {
6132 return utf8_length(s, target);
6135 while (end > target) {
6137 while (UTF8_IS_CONTINUATION(*end)) {
6146 =for apidoc sv_pos_b2u
6148 Converts the value pointed to by offsetp from a count of bytes from the
6149 start of the string, to a count of the equivalent number of UTF-8 chars.
6150 Handles magic and type coercion.
6156 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6157 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6162 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6165 const STRLEN byte = *offsetp;
6166 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6172 PERL_ARGS_ASSERT_SV_POS_B2U;
6177 s = (const U8*)SvPV_const(sv, blen);
6180 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6184 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6185 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6187 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6188 if (cache[1] == byte) {
6189 /* An exact match. */
6190 *offsetp = cache[0];
6193 if (cache[3] == byte) {
6194 /* An exact match. */
6195 *offsetp = cache[2];
6199 if (cache[1] < byte) {
6200 /* We already know part of the way. */
6201 if (mg->mg_len != -1) {
6202 /* Actually, we know the end too. */
6204 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6205 s + blen, mg->mg_len - cache[0]);
6207 len = cache[0] + utf8_length(s + cache[1], send);
6210 else if (cache[3] < byte) {
6211 /* We're between the two cached pairs, so we do the calculation
6212 offset by the byte/utf-8 positions for the earlier pair,
6213 then add the utf-8 characters from the string start to
6215 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6216 s + cache[1], cache[0] - cache[2])
6220 else { /* cache[3] > byte */
6221 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6225 ASSERT_UTF8_CACHE(cache);
6227 } else if (mg->mg_len != -1) {
6228 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6232 if (!found || PL_utf8cache < 0) {
6233 const STRLEN real_len = utf8_length(s, send);
6235 if (found && PL_utf8cache < 0) {
6236 if (len != real_len) {
6237 /* Need to turn the assertions off otherwise we may recurse
6238 infinitely while printing error messages. */
6239 SAVEI8(PL_utf8cache);
6241 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6242 " real %"UVuf" for %"SVf,
6243 (UV) len, (UV) real_len, SVfARG(sv));
6251 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6257 Returns a boolean indicating whether the strings in the two SVs are
6258 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6259 coerce its args to strings if necessary.
6265 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6274 SV* svrecode = NULL;
6281 /* if pv1 and pv2 are the same, second SvPV_const call may
6282 * invalidate pv1, so we may need to make a copy */
6283 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6284 pv1 = SvPV_const(sv1, cur1);
6285 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6287 pv1 = SvPV_const(sv1, cur1);
6295 pv2 = SvPV_const(sv2, cur2);
6297 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6298 /* Differing utf8ness.
6299 * Do not UTF8size the comparands as a side-effect. */
6302 svrecode = newSVpvn(pv2, cur2);
6303 sv_recode_to_utf8(svrecode, PL_encoding);
6304 pv2 = SvPV_const(svrecode, cur2);
6307 svrecode = newSVpvn(pv1, cur1);
6308 sv_recode_to_utf8(svrecode, PL_encoding);
6309 pv1 = SvPV_const(svrecode, cur1);
6311 /* Now both are in UTF-8. */
6313 SvREFCNT_dec(svrecode);
6318 bool is_utf8 = TRUE;
6321 /* sv1 is the UTF-8 one,
6322 * if is equal it must be downgrade-able */
6323 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6329 /* sv2 is the UTF-8 one,
6330 * if is equal it must be downgrade-able */
6331 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6337 /* Downgrade not possible - cannot be eq */
6345 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6347 SvREFCNT_dec(svrecode);
6357 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6358 string in C<sv1> is less than, equal to, or greater than the string in
6359 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6360 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6366 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6370 const char *pv1, *pv2;
6373 SV *svrecode = NULL;
6380 pv1 = SvPV_const(sv1, cur1);
6387 pv2 = SvPV_const(sv2, cur2);
6389 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6390 /* Differing utf8ness.
6391 * Do not UTF8size the comparands as a side-effect. */
6394 svrecode = newSVpvn(pv2, cur2);
6395 sv_recode_to_utf8(svrecode, PL_encoding);
6396 pv2 = SvPV_const(svrecode, cur2);
6399 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6404 svrecode = newSVpvn(pv1, cur1);
6405 sv_recode_to_utf8(svrecode, PL_encoding);
6406 pv1 = SvPV_const(svrecode, cur1);
6409 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6415 cmp = cur2 ? -1 : 0;
6419 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6422 cmp = retval < 0 ? -1 : 1;
6423 } else if (cur1 == cur2) {
6426 cmp = cur1 < cur2 ? -1 : 1;
6430 SvREFCNT_dec(svrecode);
6438 =for apidoc sv_cmp_locale
6440 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6441 'use bytes' aware, handles get magic, and will coerce its args to strings
6442 if necessary. See also C<sv_cmp>.
6448 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6451 #ifdef USE_LOCALE_COLLATE
6457 if (PL_collation_standard)
6461 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6463 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6465 if (!pv1 || !len1) {
6476 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6479 return retval < 0 ? -1 : 1;
6482 * When the result of collation is equality, that doesn't mean
6483 * that there are no differences -- some locales exclude some
6484 * characters from consideration. So to avoid false equalities,
6485 * we use the raw string as a tiebreaker.
6491 #endif /* USE_LOCALE_COLLATE */
6493 return sv_cmp(sv1, sv2);
6497 #ifdef USE_LOCALE_COLLATE
6500 =for apidoc sv_collxfrm
6502 Add Collate Transform magic to an SV if it doesn't already have it.
6504 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6505 scalar data of the variable, but transformed to such a format that a normal
6506 memory comparison can be used to compare the data according to the locale
6513 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6518 PERL_ARGS_ASSERT_SV_COLLXFRM;
6520 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6521 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6527 Safefree(mg->mg_ptr);
6528 s = SvPV_const(sv, len);
6529 if ((xf = mem_collxfrm(s, len, &xlen))) {
6531 #ifdef PERL_OLD_COPY_ON_WRITE
6533 sv_force_normal_flags(sv, 0);
6535 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6549 if (mg && mg->mg_ptr) {
6551 return mg->mg_ptr + sizeof(PL_collation_ix);
6559 #endif /* USE_LOCALE_COLLATE */
6564 Get a line from the filehandle and store it into the SV, optionally
6565 appending to the currently-stored string.
6571 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6576 register STDCHAR rslast;
6577 register STDCHAR *bp;
6582 PERL_ARGS_ASSERT_SV_GETS;
6584 if (SvTHINKFIRST(sv))
6585 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6586 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6588 However, perlbench says it's slower, because the existing swipe code
6589 is faster than copy on write.
6590 Swings and roundabouts. */
6591 SvUPGRADE(sv, SVt_PV);
6596 if (PerlIO_isutf8(fp)) {
6598 sv_utf8_upgrade_nomg(sv);
6599 sv_pos_u2b(sv,&append,0);
6601 } else if (SvUTF8(sv)) {
6602 SV * const tsv = newSV(0);
6603 sv_gets(tsv, fp, 0);
6604 sv_utf8_upgrade_nomg(tsv);
6605 SvCUR_set(sv,append);
6608 goto return_string_or_null;
6613 if (PerlIO_isutf8(fp))
6616 if (IN_PERL_COMPILETIME) {
6617 /* we always read code in line mode */
6621 else if (RsSNARF(PL_rs)) {
6622 /* If it is a regular disk file use size from stat() as estimate
6623 of amount we are going to read -- may result in mallocing
6624 more memory than we really need if the layers below reduce
6625 the size we read (e.g. CRLF or a gzip layer).
6628 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6629 const Off_t offset = PerlIO_tell(fp);
6630 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6631 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6637 else if (RsRECORD(PL_rs)) {
6645 /* Grab the size of the record we're getting */
6646 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6647 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6650 /* VMS wants read instead of fread, because fread doesn't respect */
6651 /* RMS record boundaries. This is not necessarily a good thing to be */
6652 /* doing, but we've got no other real choice - except avoid stdio
6653 as implementation - perhaps write a :vms layer ?
6655 fd = PerlIO_fileno(fp);
6656 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6657 bytesread = PerlIO_read(fp, buffer, recsize);
6660 bytesread = PerlLIO_read(fd, buffer, recsize);
6663 bytesread = PerlIO_read(fp, buffer, recsize);
6667 SvCUR_set(sv, bytesread += append);
6668 buffer[bytesread] = '\0';
6669 goto return_string_or_null;
6671 else if (RsPARA(PL_rs)) {
6677 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6678 if (PerlIO_isutf8(fp)) {
6679 rsptr = SvPVutf8(PL_rs, rslen);
6682 if (SvUTF8(PL_rs)) {
6683 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6684 Perl_croak(aTHX_ "Wide character in $/");
6687 rsptr = SvPV_const(PL_rs, rslen);
6691 rslast = rslen ? rsptr[rslen - 1] : '\0';
6693 if (rspara) { /* have to do this both before and after */
6694 do { /* to make sure file boundaries work right */
6697 i = PerlIO_getc(fp);
6701 PerlIO_ungetc(fp,i);
6707 /* See if we know enough about I/O mechanism to cheat it ! */
6709 /* This used to be #ifdef test - it is made run-time test for ease
6710 of abstracting out stdio interface. One call should be cheap
6711 enough here - and may even be a macro allowing compile
6715 if (PerlIO_fast_gets(fp)) {
6718 * We're going to steal some values from the stdio struct
6719 * and put EVERYTHING in the innermost loop into registers.
6721 register STDCHAR *ptr;
6725 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6726 /* An ungetc()d char is handled separately from the regular
6727 * buffer, so we getc() it back out and stuff it in the buffer.
6729 i = PerlIO_getc(fp);
6730 if (i == EOF) return 0;
6731 *(--((*fp)->_ptr)) = (unsigned char) i;
6735 /* Here is some breathtakingly efficient cheating */
6737 cnt = PerlIO_get_cnt(fp); /* get count into register */
6738 /* make sure we have the room */
6739 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6740 /* Not room for all of it
6741 if we are looking for a separator and room for some
6743 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6744 /* just process what we have room for */
6745 shortbuffered = cnt - SvLEN(sv) + append + 1;
6746 cnt -= shortbuffered;
6750 /* remember that cnt can be negative */
6751 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6756 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6757 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6758 DEBUG_P(PerlIO_printf(Perl_debug_log,
6759 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6760 DEBUG_P(PerlIO_printf(Perl_debug_log,
6761 "Screamer: entering: PerlIO * 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)));
6768 while (cnt > 0) { /* this | eat */
6770 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6771 goto thats_all_folks; /* screams | sed :-) */
6775 Copy(ptr, bp, cnt, char); /* this | eat */
6776 bp += cnt; /* screams | dust */
6777 ptr += cnt; /* louder | sed :-) */
6782 if (shortbuffered) { /* oh well, must extend */
6783 cnt = shortbuffered;
6785 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6787 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6788 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6792 DEBUG_P(PerlIO_printf(Perl_debug_log,
6793 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6794 PTR2UV(ptr),(long)cnt));
6795 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6797 DEBUG_P(PerlIO_printf(Perl_debug_log,
6798 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6799 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6800 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6802 /* This used to call 'filbuf' in stdio form, but as that behaves like
6803 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6804 another abstraction. */
6805 i = PerlIO_getc(fp); /* get more characters */
6807 DEBUG_P(PerlIO_printf(Perl_debug_log,
6808 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6809 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6810 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6812 cnt = PerlIO_get_cnt(fp);
6813 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6814 DEBUG_P(PerlIO_printf(Perl_debug_log,
6815 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6817 if (i == EOF) /* all done for ever? */
6818 goto thats_really_all_folks;
6820 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6822 SvGROW(sv, bpx + cnt + 2);
6823 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6825 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6827 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6828 goto thats_all_folks;
6832 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6833 memNE((char*)bp - rslen, rsptr, rslen))
6834 goto screamer; /* go back to the fray */
6835 thats_really_all_folks:
6837 cnt += shortbuffered;
6838 DEBUG_P(PerlIO_printf(Perl_debug_log,
6839 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6840 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6841 DEBUG_P(PerlIO_printf(Perl_debug_log,
6842 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6843 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6844 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6846 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6847 DEBUG_P(PerlIO_printf(Perl_debug_log,
6848 "Screamer: done, len=%ld, string=|%.*s|\n",
6849 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6853 /*The big, slow, and stupid way. */
6854 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6855 STDCHAR *buf = NULL;
6856 Newx(buf, 8192, STDCHAR);
6864 register const STDCHAR * const bpe = buf + sizeof(buf);
6866 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6867 ; /* keep reading */
6871 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6872 /* Accomodate broken VAXC compiler, which applies U8 cast to
6873 * both args of ?: operator, causing EOF to change into 255
6876 i = (U8)buf[cnt - 1];
6882 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6884 sv_catpvn(sv, (char *) buf, cnt);
6886 sv_setpvn(sv, (char *) buf, cnt);
6888 if (i != EOF && /* joy */
6890 SvCUR(sv) < rslen ||
6891 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6895 * If we're reading from a TTY and we get a short read,
6896 * indicating that the user hit his EOF character, we need
6897 * to notice it now, because if we try to read from the TTY
6898 * again, the EOF condition will disappear.
6900 * The comparison of cnt to sizeof(buf) is an optimization
6901 * that prevents unnecessary calls to feof().
6905 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6909 #ifdef USE_HEAP_INSTEAD_OF_STACK
6914 if (rspara) { /* have to do this both before and after */
6915 while (i != EOF) { /* to make sure file boundaries work right */
6916 i = PerlIO_getc(fp);
6918 PerlIO_ungetc(fp,i);
6924 return_string_or_null:
6925 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6931 Auto-increment of the value in the SV, doing string to numeric conversion
6932 if necessary. Handles 'get' magic.
6938 Perl_sv_inc(pTHX_ register SV *const sv)
6947 if (SvTHINKFIRST(sv)) {
6949 sv_force_normal_flags(sv, 0);
6950 if (SvREADONLY(sv)) {
6951 if (IN_PERL_RUNTIME)
6952 Perl_croak(aTHX_ PL_no_modify);
6956 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6958 i = PTR2IV(SvRV(sv));
6963 flags = SvFLAGS(sv);
6964 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6965 /* It's (privately or publicly) a float, but not tested as an
6966 integer, so test it to see. */
6968 flags = SvFLAGS(sv);
6970 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6971 /* It's publicly an integer, or privately an integer-not-float */
6972 #ifdef PERL_PRESERVE_IVUV
6976 if (SvUVX(sv) == UV_MAX)
6977 sv_setnv(sv, UV_MAX_P1);
6979 (void)SvIOK_only_UV(sv);
6980 SvUV_set(sv, SvUVX(sv) + 1);
6982 if (SvIVX(sv) == IV_MAX)
6983 sv_setuv(sv, (UV)IV_MAX + 1);
6985 (void)SvIOK_only(sv);
6986 SvIV_set(sv, SvIVX(sv) + 1);
6991 if (flags & SVp_NOK) {
6992 const NV was = SvNVX(sv);
6993 if (NV_OVERFLOWS_INTEGERS_AT &&
6994 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6995 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6996 "Lost precision when incrementing %" NVff " by 1",
6999 (void)SvNOK_only(sv);
7000 SvNV_set(sv, was + 1.0);
7004 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7005 if ((flags & SVTYPEMASK) < SVt_PVIV)
7006 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7007 (void)SvIOK_only(sv);
7012 while (isALPHA(*d)) d++;
7013 while (isDIGIT(*d)) d++;
7015 #ifdef PERL_PRESERVE_IVUV
7016 /* Got to punt this as an integer if needs be, but we don't issue
7017 warnings. Probably ought to make the sv_iv_please() that does
7018 the conversion if possible, and silently. */
7019 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7020 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7021 /* Need to try really hard to see if it's an integer.
7022 9.22337203685478e+18 is an integer.
7023 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7024 so $a="9.22337203685478e+18"; $a+0; $a++
7025 needs to be the same as $a="9.22337203685478e+18"; $a++
7032 /* sv_2iv *should* have made this an NV */
7033 if (flags & SVp_NOK) {
7034 (void)SvNOK_only(sv);
7035 SvNV_set(sv, SvNVX(sv) + 1.0);
7038 /* I don't think we can get here. Maybe I should assert this
7039 And if we do get here I suspect that sv_setnv will croak. NWC
7041 #if defined(USE_LONG_DOUBLE)
7042 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",
7043 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7045 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7046 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7049 #endif /* PERL_PRESERVE_IVUV */
7050 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7054 while (d >= SvPVX_const(sv)) {
7062 /* MKS: The original code here died if letters weren't consecutive.
7063 * at least it didn't have to worry about non-C locales. The
7064 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7065 * arranged in order (although not consecutively) and that only
7066 * [A-Za-z] are accepted by isALPHA in the C locale.
7068 if (*d != 'z' && *d != 'Z') {
7069 do { ++*d; } while (!isALPHA(*d));
7072 *(d--) -= 'z' - 'a';
7077 *(d--) -= 'z' - 'a' + 1;
7081 /* oh,oh, the number grew */
7082 SvGROW(sv, SvCUR(sv) + 2);
7083 SvCUR_set(sv, SvCUR(sv) + 1);
7084 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7095 Auto-decrement of the value in the SV, doing string to numeric conversion
7096 if necessary. Handles 'get' magic.
7102 Perl_sv_dec(pTHX_ register SV *const sv)
7110 if (SvTHINKFIRST(sv)) {
7112 sv_force_normal_flags(sv, 0);
7113 if (SvREADONLY(sv)) {
7114 if (IN_PERL_RUNTIME)
7115 Perl_croak(aTHX_ PL_no_modify);
7119 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7121 i = PTR2IV(SvRV(sv));
7126 /* Unlike sv_inc we don't have to worry about string-never-numbers
7127 and keeping them magic. But we mustn't warn on punting */
7128 flags = SvFLAGS(sv);
7129 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7130 /* It's publicly an integer, or privately an integer-not-float */
7131 #ifdef PERL_PRESERVE_IVUV
7135 if (SvUVX(sv) == 0) {
7136 (void)SvIOK_only(sv);
7140 (void)SvIOK_only_UV(sv);
7141 SvUV_set(sv, SvUVX(sv) - 1);
7144 if (SvIVX(sv) == IV_MIN) {
7145 sv_setnv(sv, (NV)IV_MIN);
7149 (void)SvIOK_only(sv);
7150 SvIV_set(sv, SvIVX(sv) - 1);
7155 if (flags & SVp_NOK) {
7158 const NV was = SvNVX(sv);
7159 if (NV_OVERFLOWS_INTEGERS_AT &&
7160 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7161 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7162 "Lost precision when decrementing %" NVff " by 1",
7165 (void)SvNOK_only(sv);
7166 SvNV_set(sv, was - 1.0);
7170 if (!(flags & SVp_POK)) {
7171 if ((flags & SVTYPEMASK) < SVt_PVIV)
7172 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7174 (void)SvIOK_only(sv);
7177 #ifdef PERL_PRESERVE_IVUV
7179 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7180 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7181 /* Need to try really hard to see if it's an integer.
7182 9.22337203685478e+18 is an integer.
7183 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7184 so $a="9.22337203685478e+18"; $a+0; $a--
7185 needs to be the same as $a="9.22337203685478e+18"; $a--
7192 /* sv_2iv *should* have made this an NV */
7193 if (flags & SVp_NOK) {
7194 (void)SvNOK_only(sv);
7195 SvNV_set(sv, SvNVX(sv) - 1.0);
7198 /* I don't think we can get here. Maybe I should assert this
7199 And if we do get here I suspect that sv_setnv will croak. NWC
7201 #if defined(USE_LONG_DOUBLE)
7202 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",
7203 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7205 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7206 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7210 #endif /* PERL_PRESERVE_IVUV */
7211 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7215 =for apidoc sv_mortalcopy
7217 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7218 The new SV is marked as mortal. It will be destroyed "soon", either by an
7219 explicit call to FREETMPS, or by an implicit call at places such as
7220 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7225 /* Make a string that will exist for the duration of the expression
7226 * evaluation. Actually, it may have to last longer than that, but
7227 * hopefully we won't free it until it has been assigned to a
7228 * permanent location. */
7231 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7237 sv_setsv(sv,oldstr);
7239 PL_tmps_stack[++PL_tmps_ix] = sv;
7245 =for apidoc sv_newmortal
7247 Creates a new null SV which is mortal. The reference count of the SV is
7248 set to 1. It will be destroyed "soon", either by an explicit call to
7249 FREETMPS, or by an implicit call at places such as statement boundaries.
7250 See also C<sv_mortalcopy> and C<sv_2mortal>.
7256 Perl_sv_newmortal(pTHX)
7262 SvFLAGS(sv) = SVs_TEMP;
7264 PL_tmps_stack[++PL_tmps_ix] = sv;
7270 =for apidoc newSVpvn_flags
7272 Creates a new SV and copies a string into it. The reference count for the
7273 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7274 string. You are responsible for ensuring that the source string is at least
7275 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7276 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7277 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7278 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7279 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7281 #define newSVpvn_utf8(s, len, u) \
7282 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7288 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7293 /* All the flags we don't support must be zero.
7294 And we're new code so I'm going to assert this from the start. */
7295 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7297 sv_setpvn(sv,s,len);
7298 SvFLAGS(sv) |= (flags & SVf_UTF8);
7299 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7303 =for apidoc sv_2mortal
7305 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7306 by an explicit call to FREETMPS, or by an implicit call at places such as
7307 statement boundaries. SvTEMP() is turned on which means that the SV's
7308 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7309 and C<sv_mortalcopy>.
7315 Perl_sv_2mortal(pTHX_ register SV *const sv)
7320 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7323 PL_tmps_stack[++PL_tmps_ix] = sv;
7331 Creates a new SV and copies a string into it. The reference count for the
7332 SV is set to 1. If C<len> is zero, Perl will compute the length using
7333 strlen(). For efficiency, consider using C<newSVpvn> instead.
7339 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7345 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7350 =for apidoc newSVpvn
7352 Creates a new SV and copies a string into it. The reference count for the
7353 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7354 string. You are responsible for ensuring that the source string is at least
7355 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7361 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7367 sv_setpvn(sv,s,len);
7372 =for apidoc newSVhek
7374 Creates a new SV from the hash key structure. It will generate scalars that
7375 point to the shared string table where possible. Returns a new (undefined)
7376 SV if the hek is NULL.
7382 Perl_newSVhek(pTHX_ const HEK *const hek)
7392 if (HEK_LEN(hek) == HEf_SVKEY) {
7393 return newSVsv(*(SV**)HEK_KEY(hek));
7395 const int flags = HEK_FLAGS(hek);
7396 if (flags & HVhek_WASUTF8) {
7398 Andreas would like keys he put in as utf8 to come back as utf8
7400 STRLEN utf8_len = HEK_LEN(hek);
7401 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7402 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7405 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7407 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7408 /* We don't have a pointer to the hv, so we have to replicate the
7409 flag into every HEK. This hv is using custom a hasing
7410 algorithm. Hence we can't return a shared string scalar, as
7411 that would contain the (wrong) hash value, and might get passed
7412 into an hv routine with a regular hash.
7413 Similarly, a hash that isn't using shared hash keys has to have
7414 the flag in every key so that we know not to try to call
7415 share_hek_kek on it. */
7417 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7422 /* This will be overwhelminly the most common case. */
7424 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7425 more efficient than sharepvn(). */
7429 sv_upgrade(sv, SVt_PV);
7430 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7431 SvCUR_set(sv, HEK_LEN(hek));
7444 =for apidoc newSVpvn_share
7446 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7447 table. If the string does not already exist in the table, it is created
7448 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7449 value is used; otherwise the hash is computed. The string's hash can be later
7450 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7451 that as the string table is used for shared hash keys these strings will have
7452 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7458 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7462 bool is_utf8 = FALSE;
7463 const char *const orig_src = src;
7466 STRLEN tmplen = -len;
7468 /* See the note in hv.c:hv_fetch() --jhi */
7469 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7473 PERL_HASH(hash, src, len);
7475 sv_upgrade(sv, SVt_PV);
7476 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7484 if (src != orig_src)
7490 #if defined(PERL_IMPLICIT_CONTEXT)
7492 /* pTHX_ magic can't cope with varargs, so this is a no-context
7493 * version of the main function, (which may itself be aliased to us).
7494 * Don't access this version directly.
7498 Perl_newSVpvf_nocontext(const char *const pat, ...)
7504 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7506 va_start(args, pat);
7507 sv = vnewSVpvf(pat, &args);
7514 =for apidoc newSVpvf
7516 Creates a new SV and initializes it with the string formatted like
7523 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7528 PERL_ARGS_ASSERT_NEWSVPVF;
7530 va_start(args, pat);
7531 sv = vnewSVpvf(pat, &args);
7536 /* backend for newSVpvf() and newSVpvf_nocontext() */
7539 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7544 PERL_ARGS_ASSERT_VNEWSVPVF;
7547 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7554 Creates a new SV and copies a floating point value into it.
7555 The reference count for the SV is set to 1.
7561 Perl_newSVnv(pTHX_ const NV n)
7574 Creates a new SV and copies an integer into it. The reference count for the
7581 Perl_newSViv(pTHX_ const IV i)
7594 Creates a new SV and copies an unsigned integer into it.
7595 The reference count for the SV is set to 1.
7601 Perl_newSVuv(pTHX_ const UV u)
7612 =for apidoc newSV_type
7614 Creates a new SV, of the type specified. The reference count for the new SV
7621 Perl_newSV_type(pTHX_ const svtype type)
7626 sv_upgrade(sv, type);
7631 =for apidoc newRV_noinc
7633 Creates an RV wrapper for an SV. The reference count for the original
7634 SV is B<not> incremented.
7640 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7643 register SV *sv = newSV_type(SVt_IV);
7645 PERL_ARGS_ASSERT_NEWRV_NOINC;
7648 SvRV_set(sv, tmpRef);
7653 /* newRV_inc is the official function name to use now.
7654 * newRV_inc is in fact #defined to newRV in sv.h
7658 Perl_newRV(pTHX_ SV *const sv)
7662 PERL_ARGS_ASSERT_NEWRV;
7664 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7670 Creates a new SV which is an exact duplicate of the original SV.
7677 Perl_newSVsv(pTHX_ register SV *const old)
7684 if (SvTYPE(old) == SVTYPEMASK) {
7685 if (ckWARN_d(WARN_INTERNAL))
7686 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7690 /* SV_GMAGIC is the default for sv_setv()
7691 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7692 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7693 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7698 =for apidoc sv_reset
7700 Underlying implementation for the C<reset> Perl function.
7701 Note that the perl-level function is vaguely deprecated.
7707 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7710 char todo[PERL_UCHAR_MAX+1];
7712 PERL_ARGS_ASSERT_SV_RESET;
7717 if (!*s) { /* reset ?? searches */
7718 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7720 const U32 count = mg->mg_len / sizeof(PMOP**);
7721 PMOP **pmp = (PMOP**) mg->mg_ptr;
7722 PMOP *const *const end = pmp + count;
7726 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7728 (*pmp)->op_pmflags &= ~PMf_USED;
7736 /* reset variables */
7738 if (!HvARRAY(stash))
7741 Zero(todo, 256, char);
7744 I32 i = (unsigned char)*s;
7748 max = (unsigned char)*s++;
7749 for ( ; i <= max; i++) {
7752 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7754 for (entry = HvARRAY(stash)[i];
7756 entry = HeNEXT(entry))
7761 if (!todo[(U8)*HeKEY(entry)])
7763 gv = (GV*)HeVAL(entry);
7766 if (SvTHINKFIRST(sv)) {
7767 if (!SvREADONLY(sv) && SvROK(sv))
7769 /* XXX Is this continue a bug? Why should THINKFIRST
7770 exempt us from resetting arrays and hashes? */
7774 if (SvTYPE(sv) >= SVt_PV) {
7776 if (SvPVX_const(sv) != NULL)
7784 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7786 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7789 # if defined(USE_ENVIRON_ARRAY)
7792 # endif /* USE_ENVIRON_ARRAY */
7803 Using various gambits, try to get an IO from an SV: the IO slot if its a
7804 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7805 named after the PV if we're a string.
7811 Perl_sv_2io(pTHX_ SV *const sv)
7816 PERL_ARGS_ASSERT_SV_2IO;
7818 switch (SvTYPE(sv)) {
7826 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7830 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7832 return sv_2io(SvRV(sv));
7833 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7839 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7848 Using various gambits, try to get a CV from an SV; in addition, try if
7849 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7850 The flags in C<lref> are passed to sv_fetchsv.
7856 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7862 PERL_ARGS_ASSERT_SV_2CV;
7869 switch (SvTYPE(sv)) {
7887 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7889 tryAMAGICunDEREF(to_cv);
7892 if (SvTYPE(sv) == SVt_PVCV) {
7901 Perl_croak(aTHX_ "Not a subroutine reference");
7903 else if (isGV(sv)) {
7908 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7914 /* Some flags to gv_fetchsv mean don't really create the GV */
7915 if (SvTYPE(gv) != SVt_PVGV) {
7921 if (lref && !GvCVu(gv)) {
7925 gv_efullname3(tmpsv, gv, NULL);
7926 /* XXX this is probably not what they think they're getting.
7927 * It has the same effect as "sub name;", i.e. just a forward
7929 newSUB(start_subparse(FALSE, 0),
7930 newSVOP(OP_CONST, 0, tmpsv),
7934 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7935 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7944 Returns true if the SV has a true value by Perl's rules.
7945 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7946 instead use an in-line version.
7952 Perl_sv_true(pTHX_ register SV *const sv)
7957 register const XPV* const tXpv = (XPV*)SvANY(sv);
7959 (tXpv->xpv_cur > 1 ||
7960 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7967 return SvIVX(sv) != 0;
7970 return SvNVX(sv) != 0.0;
7972 return sv_2bool(sv);
7978 =for apidoc sv_pvn_force
7980 Get a sensible string out of the SV somehow.
7981 A private implementation of the C<SvPV_force> macro for compilers which
7982 can't cope with complex macro expressions. Always use the macro instead.
7984 =for apidoc sv_pvn_force_flags
7986 Get a sensible string out of the SV somehow.
7987 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7988 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7989 implemented in terms of this function.
7990 You normally want to use the various wrapper macros instead: see
7991 C<SvPV_force> and C<SvPV_force_nomg>
7997 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8001 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8003 if (SvTHINKFIRST(sv) && !SvROK(sv))
8004 sv_force_normal_flags(sv, 0);
8014 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8015 const char * const ref = sv_reftype(sv,0);
8017 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8018 ref, OP_NAME(PL_op));
8020 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8022 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8023 || isGV_with_GP(sv))
8024 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8026 s = sv_2pv_flags(sv, &len, flags);
8030 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8033 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8034 SvGROW(sv, len + 1);
8035 Move(s,SvPVX(sv),len,char);
8037 SvPVX(sv)[len] = '\0';
8040 SvPOK_on(sv); /* validate pointer */
8042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8043 PTR2UV(sv),SvPVX_const(sv)));
8046 return SvPVX_mutable(sv);
8050 =for apidoc sv_pvbyten_force
8052 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8058 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8060 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8062 sv_pvn_force(sv,lp);
8063 sv_utf8_downgrade(sv,0);
8069 =for apidoc sv_pvutf8n_force
8071 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8077 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8079 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8081 sv_pvn_force(sv,lp);
8082 sv_utf8_upgrade(sv);
8088 =for apidoc sv_reftype
8090 Returns a string describing what the SV is a reference to.
8096 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8098 PERL_ARGS_ASSERT_SV_REFTYPE;
8100 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8101 inside return suggests a const propagation bug in g++. */
8102 if (ob && SvOBJECT(sv)) {
8103 char * const name = HvNAME_get(SvSTASH(sv));
8104 return name ? name : (char *) "__ANON__";
8107 switch (SvTYPE(sv)) {
8122 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8123 /* tied lvalues should appear to be
8124 * scalars for backwards compatitbility */
8125 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8126 ? "SCALAR" : "LVALUE");
8127 case SVt_PVAV: return "ARRAY";
8128 case SVt_PVHV: return "HASH";
8129 case SVt_PVCV: return "CODE";
8130 case SVt_PVGV: return "GLOB";
8131 case SVt_PVFM: return "FORMAT";
8132 case SVt_PVIO: return "IO";
8133 case SVt_BIND: return "BIND";
8134 case SVt_REGEXP: return "REGEXP";
8135 default: return "UNKNOWN";
8141 =for apidoc sv_isobject
8143 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8144 object. If the SV is not an RV, or if the object is not blessed, then this
8151 Perl_sv_isobject(pTHX_ SV *sv)
8167 Returns a boolean indicating whether the SV is blessed into the specified
8168 class. This does not check for subtypes; use C<sv_derived_from> to verify
8169 an inheritance relationship.
8175 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8179 PERL_ARGS_ASSERT_SV_ISA;
8189 hvname = HvNAME_get(SvSTASH(sv));
8193 return strEQ(hvname, name);
8199 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8200 it will be upgraded to one. If C<classname> is non-null then the new SV will
8201 be blessed in the specified package. The new SV is returned and its
8202 reference count is 1.
8208 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8213 PERL_ARGS_ASSERT_NEWSVRV;
8217 SV_CHECK_THINKFIRST_COW_DROP(rv);
8218 (void)SvAMAGIC_off(rv);
8220 if (SvTYPE(rv) >= SVt_PVMG) {
8221 const U32 refcnt = SvREFCNT(rv);
8225 SvREFCNT(rv) = refcnt;
8227 sv_upgrade(rv, SVt_IV);
8228 } else if (SvROK(rv)) {
8229 SvREFCNT_dec(SvRV(rv));
8231 prepare_SV_for_RV(rv);
8239 HV* const stash = gv_stashpv(classname, GV_ADD);
8240 (void)sv_bless(rv, stash);
8246 =for apidoc sv_setref_pv
8248 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8249 argument will be upgraded to an RV. That RV will be modified to point to
8250 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8251 into the SV. The C<classname> argument indicates the package for the
8252 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8253 will have a reference count of 1, and the RV will be returned.
8255 Do not use with other Perl types such as HV, AV, SV, CV, because those
8256 objects will become corrupted by the pointer copy process.
8258 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8264 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8268 PERL_ARGS_ASSERT_SV_SETREF_PV;
8271 sv_setsv(rv, &PL_sv_undef);
8275 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8280 =for apidoc sv_setref_iv
8282 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8283 argument will be upgraded to an RV. That RV will be modified to point to
8284 the new SV. The C<classname> argument indicates the package for the
8285 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8286 will have a reference count of 1, and the RV will be returned.
8292 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8294 PERL_ARGS_ASSERT_SV_SETREF_IV;
8296 sv_setiv(newSVrv(rv,classname), iv);
8301 =for apidoc sv_setref_uv
8303 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8304 argument will be upgraded to an RV. That RV will be modified to point to
8305 the new SV. The C<classname> argument indicates the package for the
8306 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8307 will have a reference count of 1, and the RV will be returned.
8313 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8315 PERL_ARGS_ASSERT_SV_SETREF_UV;
8317 sv_setuv(newSVrv(rv,classname), uv);
8322 =for apidoc sv_setref_nv
8324 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8325 argument will be upgraded to an RV. That RV will be modified to point to
8326 the new SV. The C<classname> argument indicates the package for the
8327 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8328 will have a reference count of 1, and the RV will be returned.
8334 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8336 PERL_ARGS_ASSERT_SV_SETREF_NV;
8338 sv_setnv(newSVrv(rv,classname), nv);
8343 =for apidoc sv_setref_pvn
8345 Copies a string into a new SV, optionally blessing the SV. The length of the
8346 string must be specified with C<n>. The C<rv> argument will be upgraded to
8347 an RV. That RV will be modified to point to the new SV. The C<classname>
8348 argument indicates the package for the blessing. Set C<classname> to
8349 C<NULL> to avoid the blessing. The new SV will have a reference count
8350 of 1, and the RV will be returned.
8352 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8358 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8359 const char *const pv, const STRLEN n)
8361 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8363 sv_setpvn(newSVrv(rv,classname), pv, n);
8368 =for apidoc sv_bless
8370 Blesses an SV into a specified package. The SV must be an RV. The package
8371 must be designated by its stash (see C<gv_stashpv()>). The reference count
8372 of the SV is unaffected.
8378 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8383 PERL_ARGS_ASSERT_SV_BLESS;
8386 Perl_croak(aTHX_ "Can't bless non-reference value");
8388 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8389 if (SvIsCOW(tmpRef))
8390 sv_force_normal_flags(tmpRef, 0);
8391 if (SvREADONLY(tmpRef))
8392 Perl_croak(aTHX_ PL_no_modify);
8393 if (SvOBJECT(tmpRef)) {
8394 if (SvTYPE(tmpRef) != SVt_PVIO)
8396 SvREFCNT_dec(SvSTASH(tmpRef));
8399 SvOBJECT_on(tmpRef);
8400 if (SvTYPE(tmpRef) != SVt_PVIO)
8402 SvUPGRADE(tmpRef, SVt_PVMG);
8403 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8408 (void)SvAMAGIC_off(sv);
8410 if(SvSMAGICAL(tmpRef))
8411 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8419 /* Downgrades a PVGV to a PVMG.
8423 S_sv_unglob(pTHX_ SV *const sv)
8428 SV * const temp = sv_newmortal();
8430 PERL_ARGS_ASSERT_SV_UNGLOB;
8432 assert(SvTYPE(sv) == SVt_PVGV);
8434 gv_efullname3(temp, (GV *) sv, "*");
8437 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8438 mro_method_changed_in(stash);
8442 sv_del_backref((SV*)GvSTASH(sv), sv);
8446 if (GvNAME_HEK(sv)) {
8447 unshare_hek(GvNAME_HEK(sv));
8449 isGV_with_GP_off(sv);
8451 /* need to keep SvANY(sv) in the right arena */
8452 xpvmg = new_XPVMG();
8453 StructCopy(SvANY(sv), xpvmg, XPVMG);
8454 del_XPVGV(SvANY(sv));
8457 SvFLAGS(sv) &= ~SVTYPEMASK;
8458 SvFLAGS(sv) |= SVt_PVMG;
8460 /* Intentionally not calling any local SET magic, as this isn't so much a
8461 set operation as merely an internal storage change. */
8462 sv_setsv_flags(sv, temp, 0);
8466 =for apidoc sv_unref_flags
8468 Unsets the RV status of the SV, and decrements the reference count of
8469 whatever was being referenced by the RV. This can almost be thought of
8470 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8471 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8472 (otherwise the decrementing is conditional on the reference count being
8473 different from one or the reference being a readonly SV).
8480 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8482 SV* const target = SvRV(ref);
8484 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8486 if (SvWEAKREF(ref)) {
8487 sv_del_backref(target, ref);
8489 SvRV_set(ref, NULL);
8492 SvRV_set(ref, NULL);
8494 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8495 assigned to as BEGIN {$a = \"Foo"} will fail. */
8496 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8497 SvREFCNT_dec(target);
8498 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8499 sv_2mortal(target); /* Schedule for freeing later */
8503 =for apidoc sv_untaint
8505 Untaint an SV. Use C<SvTAINTED_off> instead.
8510 Perl_sv_untaint(pTHX_ SV *const sv)
8512 PERL_ARGS_ASSERT_SV_UNTAINT;
8514 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8515 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8522 =for apidoc sv_tainted
8524 Test an SV for taintedness. Use C<SvTAINTED> instead.
8529 Perl_sv_tainted(pTHX_ SV *const sv)
8531 PERL_ARGS_ASSERT_SV_TAINTED;
8533 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8534 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8535 if (mg && (mg->mg_len & 1) )
8542 =for apidoc sv_setpviv
8544 Copies an integer into the given SV, also updating its string value.
8545 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8551 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8553 char buf[TYPE_CHARS(UV)];
8555 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8557 PERL_ARGS_ASSERT_SV_SETPVIV;
8559 sv_setpvn(sv, ptr, ebuf - ptr);
8563 =for apidoc sv_setpviv_mg
8565 Like C<sv_setpviv>, but also handles 'set' magic.
8571 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8573 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8579 #if defined(PERL_IMPLICIT_CONTEXT)
8581 /* pTHX_ magic can't cope with varargs, so this is a no-context
8582 * version of the main function, (which may itself be aliased to us).
8583 * Don't access this version directly.
8587 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8592 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8594 va_start(args, pat);
8595 sv_vsetpvf(sv, pat, &args);
8599 /* pTHX_ magic can't cope with varargs, so this is a no-context
8600 * version of the main function, (which may itself be aliased to us).
8601 * Don't access this version directly.
8605 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8610 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8612 va_start(args, pat);
8613 sv_vsetpvf_mg(sv, pat, &args);
8619 =for apidoc sv_setpvf
8621 Works like C<sv_catpvf> but copies the text into the SV instead of
8622 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8628 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8632 PERL_ARGS_ASSERT_SV_SETPVF;
8634 va_start(args, pat);
8635 sv_vsetpvf(sv, pat, &args);
8640 =for apidoc sv_vsetpvf
8642 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8643 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8645 Usually used via its frontend C<sv_setpvf>.
8651 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8653 PERL_ARGS_ASSERT_SV_VSETPVF;
8655 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8659 =for apidoc sv_setpvf_mg
8661 Like C<sv_setpvf>, but also handles 'set' magic.
8667 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8671 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8673 va_start(args, pat);
8674 sv_vsetpvf_mg(sv, pat, &args);
8679 =for apidoc sv_vsetpvf_mg
8681 Like C<sv_vsetpvf>, but also handles 'set' magic.
8683 Usually used via its frontend C<sv_setpvf_mg>.
8689 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8691 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8693 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8697 #if defined(PERL_IMPLICIT_CONTEXT)
8699 /* pTHX_ magic can't cope with varargs, so this is a no-context
8700 * version of the main function, (which may itself be aliased to us).
8701 * Don't access this version directly.
8705 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8710 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8712 va_start(args, pat);
8713 sv_vcatpvf(sv, pat, &args);
8717 /* pTHX_ magic can't cope with varargs, so this is a no-context
8718 * version of the main function, (which may itself be aliased to us).
8719 * Don't access this version directly.
8723 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8728 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8730 va_start(args, pat);
8731 sv_vcatpvf_mg(sv, pat, &args);
8737 =for apidoc sv_catpvf
8739 Processes its arguments like C<sprintf> and appends the formatted
8740 output to an SV. If the appended data contains "wide" characters
8741 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8742 and characters >255 formatted with %c), the original SV might get
8743 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8744 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8745 valid UTF-8; if the original SV was bytes, the pattern should be too.
8750 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8754 PERL_ARGS_ASSERT_SV_CATPVF;
8756 va_start(args, pat);
8757 sv_vcatpvf(sv, pat, &args);
8762 =for apidoc sv_vcatpvf
8764 Processes its arguments like C<vsprintf> and appends the formatted output
8765 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8767 Usually used via its frontend C<sv_catpvf>.
8773 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8775 PERL_ARGS_ASSERT_SV_VCATPVF;
8777 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8781 =for apidoc sv_catpvf_mg
8783 Like C<sv_catpvf>, but also handles 'set' magic.
8789 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8793 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8795 va_start(args, pat);
8796 sv_vcatpvf_mg(sv, pat, &args);
8801 =for apidoc sv_vcatpvf_mg
8803 Like C<sv_vcatpvf>, but also handles 'set' magic.
8805 Usually used via its frontend C<sv_catpvf_mg>.
8811 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8813 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8815 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8820 =for apidoc sv_vsetpvfn
8822 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8825 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8831 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8832 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8834 PERL_ARGS_ASSERT_SV_VSETPVFN;
8836 sv_setpvn(sv, "", 0);
8837 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8841 S_expect_number(pTHX_ char **const pattern)
8846 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8848 switch (**pattern) {
8849 case '1': case '2': case '3':
8850 case '4': case '5': case '6':
8851 case '7': case '8': case '9':
8852 var = *(*pattern)++ - '0';
8853 while (isDIGIT(**pattern)) {
8854 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8856 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8864 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8866 const int neg = nv < 0;
8869 PERL_ARGS_ASSERT_F0CONVERT;
8877 if (uv & 1 && uv == nv)
8878 uv--; /* Round to even */
8880 const unsigned dig = uv % 10;
8893 =for apidoc sv_vcatpvfn
8895 Processes its arguments like C<vsprintf> and appends the formatted output
8896 to an SV. Uses an array of SVs if the C style variable argument list is
8897 missing (NULL). When running with taint checks enabled, indicates via
8898 C<maybe_tainted> if results are untrustworthy (often due to the use of
8901 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8907 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8908 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8909 vec_utf8 = DO_UTF8(vecsv);
8911 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8914 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8915 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8923 static const char nullstr[] = "(null)";
8925 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8926 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8928 /* Times 4: a decimal digit takes more than 3 binary digits.
8929 * NV_DIG: mantissa takes than many decimal digits.
8930 * Plus 32: Playing safe. */
8931 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8932 /* large enough for "%#.#f" --chip */
8933 /* what about long double NVs? --jhi */
8935 PERL_ARGS_ASSERT_SV_VCATPVFN;
8936 PERL_UNUSED_ARG(maybe_tainted);
8938 /* no matter what, this is a string now */
8939 (void)SvPV_force(sv, origlen);
8941 /* special-case "", "%s", and "%-p" (SVf - see below) */
8944 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8946 const char * const s = va_arg(*args, char*);
8947 sv_catpv(sv, s ? s : nullstr);
8949 else if (svix < svmax) {
8950 sv_catsv(sv, *svargs);
8954 if (args && patlen == 3 && pat[0] == '%' &&
8955 pat[1] == '-' && pat[2] == 'p') {
8956 argsv = (SV*)va_arg(*args, void*);
8957 sv_catsv(sv, argsv);
8961 #ifndef USE_LONG_DOUBLE
8962 /* special-case "%.<number>[gf]" */
8963 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8964 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8965 unsigned digits = 0;
8969 while (*pp >= '0' && *pp <= '9')
8970 digits = 10 * digits + (*pp++ - '0');
8971 if (pp - pat == (int)patlen - 1) {
8979 /* Add check for digits != 0 because it seems that some
8980 gconverts are buggy in this case, and we don't yet have
8981 a Configure test for this. */
8982 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8983 /* 0, point, slack */
8984 Gconvert(nv, (int)digits, 0, ebuf);
8986 if (*ebuf) /* May return an empty string for digits==0 */
8989 } else if (!digits) {
8992 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8993 sv_catpvn(sv, p, l);
8999 #endif /* !USE_LONG_DOUBLE */
9001 if (!args && svix < svmax && DO_UTF8(*svargs))
9004 patend = (char*)pat + patlen;
9005 for (p = (char*)pat; p < patend; p = q) {
9008 bool vectorize = FALSE;
9009 bool vectorarg = FALSE;
9010 bool vec_utf8 = FALSE;
9016 bool has_precis = FALSE;
9018 const I32 osvix = svix;
9019 bool is_utf8 = FALSE; /* is this item utf8? */
9020 #ifdef HAS_LDBL_SPRINTF_BUG
9021 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9022 with sfio - Allen <allens@cpan.org> */
9023 bool fix_ldbl_sprintf_bug = FALSE;
9027 U8 utf8buf[UTF8_MAXBYTES+1];
9028 STRLEN esignlen = 0;
9030 const char *eptr = NULL;
9033 const U8 *vecstr = NULL;
9040 /* we need a long double target in case HAS_LONG_DOUBLE but
9043 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9051 const char *dotstr = ".";
9052 STRLEN dotstrlen = 1;
9053 I32 efix = 0; /* explicit format parameter index */
9054 I32 ewix = 0; /* explicit width index */
9055 I32 epix = 0; /* explicit precision index */
9056 I32 evix = 0; /* explicit vector index */
9057 bool asterisk = FALSE;
9059 /* echo everything up to the next format specification */
9060 for (q = p; q < patend && *q != '%'; ++q) ;
9062 if (has_utf8 && !pat_utf8)
9063 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9065 sv_catpvn(sv, p, q - p);
9072 We allow format specification elements in this order:
9073 \d+\$ explicit format parameter index
9075 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9076 0 flag (as above): repeated to allow "v02"
9077 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9078 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9080 [%bcdefginopsuxDFOUX] format (mandatory)
9085 As of perl5.9.3, printf format checking is on by default.
9086 Internally, perl uses %p formats to provide an escape to
9087 some extended formatting. This block deals with those
9088 extensions: if it does not match, (char*)q is reset and
9089 the normal format processing code is used.
9091 Currently defined extensions are:
9092 %p include pointer address (standard)
9093 %-p (SVf) include an SV (previously %_)
9094 %-<num>p include an SV with precision <num>
9095 %<num>p reserved for future extensions
9097 Robin Barker 2005-07-14
9099 %1p (VDf) removed. RMB 2007-10-19
9106 n = expect_number(&q);
9113 argsv = (SV*)va_arg(*args, void*);
9114 eptr = SvPV_const(argsv, elen);
9120 if (ckWARN_d(WARN_INTERNAL))
9121 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9122 "internal %%<num>p might conflict with future printf extensions");
9128 if ( (width = expect_number(&q)) ) {
9143 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9172 if ( (ewix = expect_number(&q)) )
9181 if ((vectorarg = asterisk)) {
9194 width = expect_number(&q);
9200 vecsv = va_arg(*args, SV*);
9202 vecsv = (evix > 0 && evix <= svmax)
9203 ? svargs[evix-1] : &PL_sv_undef;
9205 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9207 dotstr = SvPV_const(vecsv, dotstrlen);
9208 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9209 bad with tied or overloaded values that return UTF8. */
9212 else if (has_utf8) {
9213 vecsv = sv_mortalcopy(vecsv);
9214 sv_utf8_upgrade(vecsv);
9215 dotstr = SvPV_const(vecsv, dotstrlen);
9222 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9223 vecsv = svargs[efix ? efix-1 : svix++];
9224 vecstr = (U8*)SvPV_const(vecsv,veclen);
9225 vec_utf8 = DO_UTF8(vecsv);
9227 /* if this is a version object, we need to convert
9228 * back into v-string notation and then let the
9229 * vectorize happen normally
9231 if (sv_derived_from(vecsv, "version")) {
9232 char *version = savesvpv(vecsv);
9233 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9234 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9235 "vector argument not supported with alpha versions");
9238 vecsv = sv_newmortal();
9239 scan_vstring(version, version + veclen, vecsv);
9240 vecstr = (U8*)SvPV_const(vecsv, veclen);
9241 vec_utf8 = DO_UTF8(vecsv);
9253 i = va_arg(*args, int);
9255 i = (ewix ? ewix <= svmax : svix < svmax) ?
9256 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9258 width = (i < 0) ? -i : i;
9268 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9270 /* XXX: todo, support specified precision parameter */
9274 i = va_arg(*args, int);
9276 i = (ewix ? ewix <= svmax : svix < svmax)
9277 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9279 has_precis = !(i < 0);
9284 precis = precis * 10 + (*q++ - '0');
9293 case 'I': /* Ix, I32x, and I64x */
9295 if (q[1] == '6' && q[2] == '4') {
9301 if (q[1] == '3' && q[2] == '2') {
9311 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9322 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9323 if (*(q + 1) == 'l') { /* lld, llf */
9349 if (!vectorize && !args) {
9351 const I32 i = efix-1;
9352 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9354 argsv = (svix >= 0 && svix < svmax)
9355 ? svargs[svix++] : &PL_sv_undef;
9366 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9368 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9370 eptr = (char*)utf8buf;
9371 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9385 eptr = va_arg(*args, char*);
9387 #ifdef MACOS_TRADITIONAL
9388 /* On MacOS, %#s format is used for Pascal strings */
9393 elen = strlen(eptr);
9395 eptr = (char *)nullstr;
9396 elen = sizeof nullstr - 1;
9400 eptr = SvPV_const(argsv, elen);
9401 if (DO_UTF8(argsv)) {
9402 I32 old_precis = precis;
9403 if (has_precis && precis < elen) {
9405 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9408 if (width) { /* fudge width (can't fudge elen) */
9409 if (has_precis && precis < elen)
9410 width += precis - old_precis;
9412 width += elen - sv_len_utf8(argsv);
9419 if (has_precis && elen > precis)
9426 if (alt || vectorize)
9428 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9449 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9458 esignbuf[esignlen++] = plus;
9462 case 'h': iv = (short)va_arg(*args, int); break;
9463 case 'l': iv = va_arg(*args, long); break;
9464 case 'V': iv = va_arg(*args, IV); break;
9465 default: iv = va_arg(*args, int); break;
9467 case 'q': iv = va_arg(*args, Quad_t); break;
9472 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9474 case 'h': iv = (short)tiv; break;
9475 case 'l': iv = (long)tiv; break;
9477 default: iv = tiv; break;
9479 case 'q': iv = (Quad_t)tiv; break;
9483 if ( !vectorize ) /* we already set uv above */
9488 esignbuf[esignlen++] = plus;
9492 esignbuf[esignlen++] = '-';
9536 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9547 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9548 case 'l': uv = va_arg(*args, unsigned long); break;
9549 case 'V': uv = va_arg(*args, UV); break;
9550 default: uv = va_arg(*args, unsigned); break;
9552 case 'q': uv = va_arg(*args, Uquad_t); break;
9557 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9559 case 'h': uv = (unsigned short)tuv; break;
9560 case 'l': uv = (unsigned long)tuv; break;
9562 default: uv = tuv; break;
9564 case 'q': uv = (Uquad_t)tuv; break;
9571 char *ptr = ebuf + sizeof ebuf;
9572 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9578 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9584 esignbuf[esignlen++] = '0';
9585 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9593 if (alt && *ptr != '0')
9602 esignbuf[esignlen++] = '0';
9603 esignbuf[esignlen++] = c;
9606 default: /* it had better be ten or less */
9610 } while (uv /= base);
9613 elen = (ebuf + sizeof ebuf) - ptr;
9617 zeros = precis - elen;
9618 else if (precis == 0 && elen == 1 && *eptr == '0'
9619 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9622 /* a precision nullifies the 0 flag. */
9629 /* FLOATING POINT */
9632 c = 'f'; /* maybe %F isn't supported here */
9640 /* This is evil, but floating point is even more evil */
9642 /* for SV-style calling, we can only get NV
9643 for C-style calling, we assume %f is double;
9644 for simplicity we allow any of %Lf, %llf, %qf for long double
9648 #if defined(USE_LONG_DOUBLE)
9652 /* [perl #20339] - we should accept and ignore %lf rather than die */
9656 #if defined(USE_LONG_DOUBLE)
9657 intsize = args ? 0 : 'q';
9661 #if defined(HAS_LONG_DOUBLE)
9670 /* now we need (long double) if intsize == 'q', else (double) */
9672 #if LONG_DOUBLESIZE > DOUBLESIZE
9674 va_arg(*args, long double) :
9675 va_arg(*args, double)
9677 va_arg(*args, double)
9682 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9683 else. frexp() has some unspecified behaviour for those three */
9684 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9686 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9687 will cast our (long double) to (double) */
9688 (void)Perl_frexp(nv, &i);
9689 if (i == PERL_INT_MIN)
9690 Perl_die(aTHX_ "panic: frexp");
9692 need = BIT_DIGITS(i);
9694 need += has_precis ? precis : 6; /* known default */
9699 #ifdef HAS_LDBL_SPRINTF_BUG
9700 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9701 with sfio - Allen <allens@cpan.org> */
9704 # define MY_DBL_MAX DBL_MAX
9705 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9706 # if DOUBLESIZE >= 8
9707 # define MY_DBL_MAX 1.7976931348623157E+308L
9709 # define MY_DBL_MAX 3.40282347E+38L
9713 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9714 # define MY_DBL_MAX_BUG 1L
9716 # define MY_DBL_MAX_BUG MY_DBL_MAX
9720 # define MY_DBL_MIN DBL_MIN
9721 # else /* XXX guessing! -Allen */
9722 # if DOUBLESIZE >= 8
9723 # define MY_DBL_MIN 2.2250738585072014E-308L
9725 # define MY_DBL_MIN 1.17549435E-38L
9729 if ((intsize == 'q') && (c == 'f') &&
9730 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9732 /* it's going to be short enough that
9733 * long double precision is not needed */
9735 if ((nv <= 0L) && (nv >= -0L))
9736 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9738 /* would use Perl_fp_class as a double-check but not
9739 * functional on IRIX - see perl.h comments */
9741 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9742 /* It's within the range that a double can represent */
9743 #if defined(DBL_MAX) && !defined(DBL_MIN)
9744 if ((nv >= ((long double)1/DBL_MAX)) ||
9745 (nv <= (-(long double)1/DBL_MAX)))
9747 fix_ldbl_sprintf_bug = TRUE;
9750 if (fix_ldbl_sprintf_bug == TRUE) {
9760 # undef MY_DBL_MAX_BUG
9763 #endif /* HAS_LDBL_SPRINTF_BUG */
9765 need += 20; /* fudge factor */
9766 if (PL_efloatsize < need) {
9767 Safefree(PL_efloatbuf);
9768 PL_efloatsize = need + 20; /* more fudge */
9769 Newx(PL_efloatbuf, PL_efloatsize, char);
9770 PL_efloatbuf[0] = '\0';
9773 if ( !(width || left || plus || alt) && fill != '0'
9774 && has_precis && intsize != 'q' ) { /* Shortcuts */
9775 /* See earlier comment about buggy Gconvert when digits,
9777 if ( c == 'g' && precis) {
9778 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9779 /* May return an empty string for digits==0 */
9780 if (*PL_efloatbuf) {
9781 elen = strlen(PL_efloatbuf);
9782 goto float_converted;
9784 } else if ( c == 'f' && !precis) {
9785 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9790 char *ptr = ebuf + sizeof ebuf;
9793 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9794 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9795 if (intsize == 'q') {
9796 /* Copy the one or more characters in a long double
9797 * format before the 'base' ([efgEFG]) character to
9798 * the format string. */
9799 static char const prifldbl[] = PERL_PRIfldbl;
9800 char const *p = prifldbl + sizeof(prifldbl) - 3;
9801 while (p >= prifldbl) { *--ptr = *p--; }
9806 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9811 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9823 /* No taint. Otherwise we are in the strange situation
9824 * where printf() taints but print($float) doesn't.
9826 #if defined(HAS_LONG_DOUBLE)
9827 elen = ((intsize == 'q')
9828 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9829 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9831 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9835 eptr = PL_efloatbuf;
9843 i = SvCUR(sv) - origlen;
9846 case 'h': *(va_arg(*args, short*)) = i; break;
9847 default: *(va_arg(*args, int*)) = i; break;
9848 case 'l': *(va_arg(*args, long*)) = i; break;
9849 case 'V': *(va_arg(*args, IV*)) = i; break;
9851 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9856 sv_setuv_mg(argsv, (UV)i);
9857 continue; /* not "break" */
9864 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9865 && ckWARN(WARN_PRINTF))
9867 SV * const msg = sv_newmortal();
9868 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9869 (PL_op->op_type == OP_PRTF) ? "" : "s");
9872 Perl_sv_catpvf(aTHX_ msg,
9873 "\"%%%c\"", c & 0xFF);
9875 Perl_sv_catpvf(aTHX_ msg,
9876 "\"%%\\%03"UVof"\"",
9879 sv_catpvs(msg, "end of string");
9880 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9883 /* output mangled stuff ... */
9889 /* ... right here, because formatting flags should not apply */
9890 SvGROW(sv, SvCUR(sv) + elen + 1);
9892 Copy(eptr, p, elen, char);
9895 SvCUR_set(sv, p - SvPVX_const(sv));
9897 continue; /* not "break" */
9900 if (is_utf8 != has_utf8) {
9903 sv_utf8_upgrade(sv);
9906 const STRLEN old_elen = elen;
9907 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9908 sv_utf8_upgrade(nsv);
9909 eptr = SvPVX_const(nsv);
9912 if (width) { /* fudge width (can't fudge elen) */
9913 width += elen - old_elen;
9919 have = esignlen + zeros + elen;
9921 Perl_croak_nocontext(PL_memory_wrap);
9923 need = (have > width ? have : width);
9926 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9927 Perl_croak_nocontext(PL_memory_wrap);
9928 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9930 if (esignlen && fill == '0') {
9932 for (i = 0; i < (int)esignlen; i++)
9936 memset(p, fill, gap);
9939 if (esignlen && fill != '0') {
9941 for (i = 0; i < (int)esignlen; i++)
9946 for (i = zeros; i; i--)
9950 Copy(eptr, p, elen, char);
9954 memset(p, ' ', gap);
9959 Copy(dotstr, p, dotstrlen, char);
9963 vectorize = FALSE; /* done iterating over vecstr */
9970 SvCUR_set(sv, p - SvPVX_const(sv));
9978 /* =========================================================================
9980 =head1 Cloning an interpreter
9982 All the macros and functions in this section are for the private use of
9983 the main function, perl_clone().
9985 The foo_dup() functions make an exact copy of an existing foo thingy.
9986 During the course of a cloning, a hash table is used to map old addresses
9987 to new addresses. The table is created and manipulated with the
9988 ptr_table_* functions.
9992 ============================================================================*/
9995 #if defined(USE_ITHREADS)
9997 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9998 #ifndef GpREFCNT_inc
9999 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10003 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10004 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10005 If this changes, please unmerge ss_dup. */
10006 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10007 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10008 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10009 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10010 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10011 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10012 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10013 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10014 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10015 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10016 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10017 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10018 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10019 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10021 /* clone a parser */
10024 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10028 PERL_ARGS_ASSERT_PARSER_DUP;
10033 /* look for it in the table first */
10034 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10038 /* create anew and remember what it is */
10039 Newxz(parser, 1, yy_parser);
10040 ptr_table_store(PL_ptr_table, proto, parser);
10042 parser->yyerrstatus = 0;
10043 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10045 /* XXX these not yet duped */
10046 parser->old_parser = NULL;
10047 parser->stack = NULL;
10049 parser->stack_size = 0;
10050 /* XXX parser->stack->state = 0; */
10052 /* XXX eventually, just Copy() most of the parser struct ? */
10054 parser->lex_brackets = proto->lex_brackets;
10055 parser->lex_casemods = proto->lex_casemods;
10056 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10057 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10058 parser->lex_casestack = savepvn(proto->lex_casestack,
10059 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10060 parser->lex_defer = proto->lex_defer;
10061 parser->lex_dojoin = proto->lex_dojoin;
10062 parser->lex_expect = proto->lex_expect;
10063 parser->lex_formbrack = proto->lex_formbrack;
10064 parser->lex_inpat = proto->lex_inpat;
10065 parser->lex_inwhat = proto->lex_inwhat;
10066 parser->lex_op = proto->lex_op;
10067 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10068 parser->lex_starts = proto->lex_starts;
10069 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10070 parser->multi_close = proto->multi_close;
10071 parser->multi_open = proto->multi_open;
10072 parser->multi_start = proto->multi_start;
10073 parser->multi_end = proto->multi_end;
10074 parser->pending_ident = proto->pending_ident;
10075 parser->preambled = proto->preambled;
10076 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10077 parser->linestr = sv_dup_inc(proto->linestr, param);
10078 parser->expect = proto->expect;
10079 parser->copline = proto->copline;
10080 parser->last_lop_op = proto->last_lop_op;
10081 parser->lex_state = proto->lex_state;
10082 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10083 /* rsfp_filters entries have fake IoDIRP() */
10084 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10085 parser->in_my = proto->in_my;
10086 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10087 parser->error_count = proto->error_count;
10090 parser->linestr = sv_dup_inc(proto->linestr, param);
10093 char * const ols = SvPVX(proto->linestr);
10094 char * const ls = SvPVX(parser->linestr);
10096 parser->bufptr = ls + (proto->bufptr >= ols ?
10097 proto->bufptr - ols : 0);
10098 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10099 proto->oldbufptr - ols : 0);
10100 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10101 proto->oldoldbufptr - ols : 0);
10102 parser->linestart = ls + (proto->linestart >= ols ?
10103 proto->linestart - ols : 0);
10104 parser->last_uni = ls + (proto->last_uni >= ols ?
10105 proto->last_uni - ols : 0);
10106 parser->last_lop = ls + (proto->last_lop >= ols ?
10107 proto->last_lop - ols : 0);
10109 parser->bufend = ls + SvCUR(parser->linestr);
10112 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10116 parser->endwhite = proto->endwhite;
10117 parser->faketokens = proto->faketokens;
10118 parser->lasttoke = proto->lasttoke;
10119 parser->nextwhite = proto->nextwhite;
10120 parser->realtokenstart = proto->realtokenstart;
10121 parser->skipwhite = proto->skipwhite;
10122 parser->thisclose = proto->thisclose;
10123 parser->thismad = proto->thismad;
10124 parser->thisopen = proto->thisopen;
10125 parser->thisstuff = proto->thisstuff;
10126 parser->thistoken = proto->thistoken;
10127 parser->thiswhite = proto->thiswhite;
10129 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10130 parser->curforce = proto->curforce;
10132 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10133 Copy(proto->nexttype, parser->nexttype, 5, I32);
10134 parser->nexttoke = proto->nexttoke;
10140 /* duplicate a file handle */
10143 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10147 PERL_ARGS_ASSERT_FP_DUP;
10148 PERL_UNUSED_ARG(type);
10151 return (PerlIO*)NULL;
10153 /* look for it in the table first */
10154 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10158 /* create anew and remember what it is */
10159 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10160 ptr_table_store(PL_ptr_table, fp, ret);
10164 /* duplicate a directory handle */
10167 Perl_dirp_dup(pTHX_ DIR *const dp)
10169 PERL_UNUSED_CONTEXT;
10176 /* duplicate a typeglob */
10179 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10183 PERL_ARGS_ASSERT_GP_DUP;
10187 /* look for it in the table first */
10188 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10192 /* create anew and remember what it is */
10194 ptr_table_store(PL_ptr_table, gp, ret);
10197 ret->gp_refcnt = 0; /* must be before any other dups! */
10198 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10199 ret->gp_io = io_dup_inc(gp->gp_io, param);
10200 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10201 ret->gp_av = av_dup_inc(gp->gp_av, param);
10202 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10203 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10204 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10205 ret->gp_cvgen = gp->gp_cvgen;
10206 ret->gp_line = gp->gp_line;
10207 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10211 /* duplicate a chain of magic */
10214 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10216 MAGIC *mgprev = (MAGIC*)NULL;
10219 PERL_ARGS_ASSERT_MG_DUP;
10222 return (MAGIC*)NULL;
10223 /* look for it in the table first */
10224 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10228 for (; mg; mg = mg->mg_moremagic) {
10230 Newxz(nmg, 1, MAGIC);
10232 mgprev->mg_moremagic = nmg;
10235 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10236 nmg->mg_private = mg->mg_private;
10237 nmg->mg_type = mg->mg_type;
10238 nmg->mg_flags = mg->mg_flags;
10239 /* FIXME for plugins
10240 if (mg->mg_type == PERL_MAGIC_qr) {
10241 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10245 if(mg->mg_type == PERL_MAGIC_backref) {
10246 /* The backref AV has its reference count deliberately bumped by
10248 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10251 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10252 ? sv_dup_inc(mg->mg_obj, param)
10253 : sv_dup(mg->mg_obj, param);
10255 nmg->mg_len = mg->mg_len;
10256 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10257 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10258 if (mg->mg_len > 0) {
10259 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10260 if (mg->mg_type == PERL_MAGIC_overload_table &&
10261 AMT_AMAGIC((AMT*)mg->mg_ptr))
10263 const AMT * const amtp = (AMT*)mg->mg_ptr;
10264 AMT * const namtp = (AMT*)nmg->mg_ptr;
10266 for (i = 1; i < NofAMmeth; i++) {
10267 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10271 else if (mg->mg_len == HEf_SVKEY)
10272 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10274 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10275 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10282 #endif /* USE_ITHREADS */
10284 /* create a new pointer-mapping table */
10287 Perl_ptr_table_new(pTHX)
10290 PERL_UNUSED_CONTEXT;
10292 Newxz(tbl, 1, PTR_TBL_t);
10293 tbl->tbl_max = 511;
10294 tbl->tbl_items = 0;
10295 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10299 #define PTR_TABLE_HASH(ptr) \
10300 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10303 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10304 following define) and at call to new_body_inline made below in
10305 Perl_ptr_table_store()
10308 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10310 /* map an existing pointer using a table */
10312 STATIC PTR_TBL_ENT_t *
10313 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10315 PTR_TBL_ENT_t *tblent;
10316 const UV hash = PTR_TABLE_HASH(sv);
10318 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10320 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10321 for (; tblent; tblent = tblent->next) {
10322 if (tblent->oldval == sv)
10329 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10331 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10333 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10334 PERL_UNUSED_CONTEXT;
10336 return tblent ? tblent->newval : NULL;
10339 /* add a new entry to a pointer-mapping table */
10342 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10344 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10346 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10347 PERL_UNUSED_CONTEXT;
10350 tblent->newval = newsv;
10352 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10354 new_body_inline(tblent, PTE_SVSLOT);
10356 tblent->oldval = oldsv;
10357 tblent->newval = newsv;
10358 tblent->next = tbl->tbl_ary[entry];
10359 tbl->tbl_ary[entry] = tblent;
10361 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10362 ptr_table_split(tbl);
10366 /* double the hash bucket size of an existing ptr table */
10369 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10371 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10372 const UV oldsize = tbl->tbl_max + 1;
10373 UV newsize = oldsize * 2;
10376 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10377 PERL_UNUSED_CONTEXT;
10379 Renew(ary, newsize, PTR_TBL_ENT_t*);
10380 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10381 tbl->tbl_max = --newsize;
10382 tbl->tbl_ary = ary;
10383 for (i=0; i < oldsize; i++, ary++) {
10384 PTR_TBL_ENT_t **curentp, **entp, *ent;
10387 curentp = ary + oldsize;
10388 for (entp = ary, ent = *ary; ent; ent = *entp) {
10389 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10391 ent->next = *curentp;
10401 /* remove all the entries from a ptr table */
10404 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10406 if (tbl && tbl->tbl_items) {
10407 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10408 UV riter = tbl->tbl_max;
10411 PTR_TBL_ENT_t *entry = array[riter];
10414 PTR_TBL_ENT_t * const oentry = entry;
10415 entry = entry->next;
10420 tbl->tbl_items = 0;
10424 /* clear and free a ptr table */
10427 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10432 ptr_table_clear(tbl);
10433 Safefree(tbl->tbl_ary);
10437 #if defined(USE_ITHREADS)
10440 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10442 PERL_ARGS_ASSERT_RVPV_DUP;
10445 SvRV_set(dstr, SvWEAKREF(sstr)
10446 ? sv_dup(SvRV(sstr), param)
10447 : sv_dup_inc(SvRV(sstr), param));
10450 else if (SvPVX_const(sstr)) {
10451 /* Has something there */
10453 /* Normal PV - clone whole allocated space */
10454 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10455 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10456 /* Not that normal - actually sstr is copy on write.
10457 But we are a true, independant SV, so: */
10458 SvREADONLY_off(dstr);
10463 /* Special case - not normally malloced for some reason */
10464 if (isGV_with_GP(sstr)) {
10465 /* Don't need to do anything here. */
10467 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10468 /* A "shared" PV - clone it as "shared" PV */
10470 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10474 /* Some other special case - random pointer */
10475 SvPV_set(dstr, SvPVX(sstr));
10480 /* Copy the NULL */
10481 SvPV_set(dstr, NULL);
10485 /* duplicate an SV of any type (including AV, HV etc) */
10488 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10493 PERL_ARGS_ASSERT_SV_DUP;
10497 if (SvTYPE(sstr) == SVTYPEMASK) {
10498 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10503 /* look for it in the table first */
10504 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10508 if(param->flags & CLONEf_JOIN_IN) {
10509 /** We are joining here so we don't want do clone
10510 something that is bad **/
10511 if (SvTYPE(sstr) == SVt_PVHV) {
10512 const HEK * const hvname = HvNAME_HEK(sstr);
10514 /** don't clone stashes if they already exist **/
10515 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10519 /* create anew and remember what it is */
10522 #ifdef DEBUG_LEAKING_SCALARS
10523 dstr->sv_debug_optype = sstr->sv_debug_optype;
10524 dstr->sv_debug_line = sstr->sv_debug_line;
10525 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10526 dstr->sv_debug_cloned = 1;
10527 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10530 ptr_table_store(PL_ptr_table, sstr, dstr);
10533 SvFLAGS(dstr) = SvFLAGS(sstr);
10534 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10535 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10538 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10539 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10540 (void*)PL_watch_pvx, SvPVX_const(sstr));
10543 /* don't clone objects whose class has asked us not to */
10544 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10549 switch (SvTYPE(sstr)) {
10551 SvANY(dstr) = NULL;
10554 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10556 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10558 SvIV_set(dstr, SvIVX(sstr));
10562 SvANY(dstr) = new_XNV();
10563 SvNV_set(dstr, SvNVX(sstr));
10565 /* case SVt_BIND: */
10568 /* These are all the types that need complex bodies allocating. */
10570 const svtype sv_type = SvTYPE(sstr);
10571 const struct body_details *const sv_type_details
10572 = bodies_by_type + sv_type;
10576 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10580 if (GvUNIQUE((GV*)sstr)) {
10581 NOOP; /* Do sharing here, and fall through */
10594 assert(sv_type_details->body_size);
10595 if (sv_type_details->arena) {
10596 new_body_inline(new_body, sv_type);
10598 = (void*)((char*)new_body - sv_type_details->offset);
10600 new_body = new_NOARENA(sv_type_details);
10604 SvANY(dstr) = new_body;
10607 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10608 ((char*)SvANY(dstr)) + sv_type_details->offset,
10609 sv_type_details->copy, char);
10611 Copy(((char*)SvANY(sstr)),
10612 ((char*)SvANY(dstr)),
10613 sv_type_details->body_size + sv_type_details->offset, char);
10616 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10617 && !isGV_with_GP(dstr))
10618 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10620 /* The Copy above means that all the source (unduplicated) pointers
10621 are now in the destination. We can check the flags and the
10622 pointers in either, but it's possible that there's less cache
10623 missing by always going for the destination.
10624 FIXME - instrument and check that assumption */
10625 if (sv_type >= SVt_PVMG) {
10626 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10627 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10628 } else if (SvMAGIC(dstr))
10629 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10631 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10634 /* The cast silences a GCC warning about unhandled types. */
10635 switch ((int)sv_type) {
10645 /* FIXME for plugins */
10646 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10649 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10650 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10651 LvTARG(dstr) = dstr;
10652 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10653 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10655 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10657 if(isGV_with_GP(sstr)) {
10658 if (GvNAME_HEK(dstr))
10659 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10660 /* Don't call sv_add_backref here as it's going to be
10661 created as part of the magic cloning of the symbol
10663 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10664 at the point of this comment. */
10665 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10666 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10667 (void)GpREFCNT_inc(GvGP(dstr));
10669 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10672 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10673 if (IoOFP(dstr) == IoIFP(sstr))
10674 IoOFP(dstr) = IoIFP(dstr);
10676 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10677 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10678 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10679 /* I have no idea why fake dirp (rsfps)
10680 should be treated differently but otherwise
10681 we end up with leaks -- sky*/
10682 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10683 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10684 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10686 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10687 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10688 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10689 if (IoDIRP(dstr)) {
10690 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10693 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10696 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10697 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10698 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10701 if (AvARRAY((AV*)sstr)) {
10702 SV **dst_ary, **src_ary;
10703 SSize_t items = AvFILLp((AV*)sstr) + 1;
10705 src_ary = AvARRAY((AV*)sstr);
10706 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10707 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10708 AvARRAY((AV*)dstr) = dst_ary;
10709 AvALLOC((AV*)dstr) = dst_ary;
10710 if (AvREAL((AV*)sstr)) {
10711 while (items-- > 0)
10712 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10715 while (items-- > 0)
10716 *dst_ary++ = sv_dup(*src_ary++, param);
10718 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10719 while (items-- > 0) {
10720 *dst_ary++ = &PL_sv_undef;
10724 AvARRAY((AV*)dstr) = NULL;
10725 AvALLOC((AV*)dstr) = (SV**)NULL;
10729 if (HvARRAY((HV*)sstr)) {
10731 const bool sharekeys = !!HvSHAREKEYS(sstr);
10732 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10733 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10735 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10736 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10738 HvARRAY(dstr) = (HE**)darray;
10739 while (i <= sxhv->xhv_max) {
10740 const HE * const source = HvARRAY(sstr)[i];
10741 HvARRAY(dstr)[i] = source
10742 ? he_dup(source, sharekeys, param) : 0;
10747 const struct xpvhv_aux * const saux = HvAUX(sstr);
10748 struct xpvhv_aux * const daux = HvAUX(dstr);
10749 /* This flag isn't copied. */
10750 /* SvOOK_on(hv) attacks the IV flags. */
10751 SvFLAGS(dstr) |= SVf_OOK;
10753 hvname = saux->xhv_name;
10754 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10756 daux->xhv_riter = saux->xhv_riter;
10757 daux->xhv_eiter = saux->xhv_eiter
10758 ? he_dup(saux->xhv_eiter,
10759 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10760 daux->xhv_backreferences =
10761 saux->xhv_backreferences
10762 ? (AV*) SvREFCNT_inc(
10763 sv_dup((SV*)saux->xhv_backreferences, param))
10766 daux->xhv_mro_meta = saux->xhv_mro_meta
10767 ? mro_meta_dup(saux->xhv_mro_meta, param)
10770 /* Record stashes for possible cloning in Perl_clone(). */
10772 av_push(param->stashes, dstr);
10776 HvARRAY((HV*)dstr) = NULL;
10779 if (!(param->flags & CLONEf_COPY_STACKS)) {
10783 /* NOTE: not refcounted */
10784 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10786 if (!CvISXSUB(dstr))
10787 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10789 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10790 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10791 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10792 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10794 /* don't dup if copying back - CvGV isn't refcounted, so the
10795 * duped GV may never be freed. A bit of a hack! DAPM */
10796 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10797 NULL : gv_dup(CvGV(dstr), param) ;
10798 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10800 CvWEAKOUTSIDE(sstr)
10801 ? cv_dup( CvOUTSIDE(dstr), param)
10802 : cv_dup_inc(CvOUTSIDE(dstr), param);
10803 if (!CvISXSUB(dstr))
10804 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10810 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10816 /* duplicate a context */
10819 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10821 PERL_CONTEXT *ncxs;
10823 PERL_ARGS_ASSERT_CX_DUP;
10826 return (PERL_CONTEXT*)NULL;
10828 /* look for it in the table first */
10829 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10833 /* create anew and remember what it is */
10834 Newx(ncxs, max + 1, PERL_CONTEXT);
10835 ptr_table_store(PL_ptr_table, cxs, ncxs);
10836 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10839 PERL_CONTEXT * const ncx = &ncxs[ix];
10840 if (CxTYPE(ncx) == CXt_SUBST) {
10841 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10844 switch (CxTYPE(ncx)) {
10846 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10847 ? cv_dup_inc(ncx->blk_sub.cv, param)
10848 : cv_dup(ncx->blk_sub.cv,param));
10849 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10850 ? av_dup_inc(ncx->blk_sub.argarray,
10853 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10855 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10856 ncx->blk_sub.oldcomppad);
10859 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10861 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10863 case CXt_LOOP_LAZYSV:
10864 ncx->blk_loop.state_u.lazysv.end
10865 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10866 /* We are taking advantage of av_dup_inc and sv_dup_inc
10867 actually being the same function, and order equivalance of
10869 We can assert the later [but only at run time :-(] */
10870 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10871 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10873 ncx->blk_loop.state_u.ary.ary
10874 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10875 case CXt_LOOP_LAZYIV:
10876 case CXt_LOOP_PLAIN:
10877 if (CxPADLOOP(ncx)) {
10878 ncx->blk_loop.oldcomppad
10879 = (PAD*)ptr_table_fetch(PL_ptr_table,
10880 ncx->blk_loop.oldcomppad);
10882 ncx->blk_loop.oldcomppad
10883 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10887 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10888 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10889 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10902 /* duplicate a stack info structure */
10905 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10909 PERL_ARGS_ASSERT_SI_DUP;
10912 return (PERL_SI*)NULL;
10914 /* look for it in the table first */
10915 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10919 /* create anew and remember what it is */
10920 Newxz(nsi, 1, PERL_SI);
10921 ptr_table_store(PL_ptr_table, si, nsi);
10923 nsi->si_stack = av_dup_inc(si->si_stack, param);
10924 nsi->si_cxix = si->si_cxix;
10925 nsi->si_cxmax = si->si_cxmax;
10926 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10927 nsi->si_type = si->si_type;
10928 nsi->si_prev = si_dup(si->si_prev, param);
10929 nsi->si_next = si_dup(si->si_next, param);
10930 nsi->si_markoff = si->si_markoff;
10935 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10936 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10937 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10938 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10939 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10940 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10941 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10942 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10943 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10944 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10945 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10946 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10947 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10948 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10951 #define pv_dup_inc(p) SAVEPV(p)
10952 #define pv_dup(p) SAVEPV(p)
10953 #define svp_dup_inc(p,pp) any_dup(p,pp)
10955 /* map any object to the new equivent - either something in the
10956 * ptr table, or something in the interpreter structure
10960 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10964 PERL_ARGS_ASSERT_ANY_DUP;
10967 return (void*)NULL;
10969 /* look for it in the table first */
10970 ret = ptr_table_fetch(PL_ptr_table, v);
10974 /* see if it is part of the interpreter structure */
10975 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10976 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10984 /* duplicate the save stack */
10987 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10990 ANY * const ss = proto_perl->Isavestack;
10991 const I32 max = proto_perl->Isavestack_max;
10992 I32 ix = proto_perl->Isavestack_ix;
11005 void (*dptr) (void*);
11006 void (*dxptr) (pTHX_ void*);
11008 PERL_ARGS_ASSERT_SS_DUP;
11010 Newxz(nss, max, ANY);
11013 const I32 type = POPINT(ss,ix);
11014 TOPINT(nss,ix) = type;
11016 case SAVEt_HELEM: /* hash element */
11017 sv = (SV*)POPPTR(ss,ix);
11018 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11020 case SAVEt_ITEM: /* normal string */
11021 case SAVEt_SV: /* scalar reference */
11022 sv = (SV*)POPPTR(ss,ix);
11023 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11026 case SAVEt_MORTALIZESV:
11027 sv = (SV*)POPPTR(ss,ix);
11028 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11030 case SAVEt_SHARED_PVREF: /* char* in shared space */
11031 c = (char*)POPPTR(ss,ix);
11032 TOPPTR(nss,ix) = savesharedpv(c);
11033 ptr = POPPTR(ss,ix);
11034 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11036 case SAVEt_GENERIC_SVREF: /* generic sv */
11037 case SAVEt_SVREF: /* scalar reference */
11038 sv = (SV*)POPPTR(ss,ix);
11039 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11040 ptr = POPPTR(ss,ix);
11041 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11043 case SAVEt_HV: /* hash reference */
11044 case SAVEt_AV: /* array reference */
11045 sv = (SV*) POPPTR(ss,ix);
11046 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11048 case SAVEt_COMPPAD:
11050 sv = (SV*) POPPTR(ss,ix);
11051 TOPPTR(nss,ix) = sv_dup(sv, param);
11053 case SAVEt_INT: /* int reference */
11054 ptr = POPPTR(ss,ix);
11055 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11056 intval = (int)POPINT(ss,ix);
11057 TOPINT(nss,ix) = intval;
11059 case SAVEt_LONG: /* long reference */
11060 ptr = POPPTR(ss,ix);
11061 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11063 case SAVEt_CLEARSV:
11064 longval = (long)POPLONG(ss,ix);
11065 TOPLONG(nss,ix) = longval;
11067 case SAVEt_I32: /* I32 reference */
11068 case SAVEt_I16: /* I16 reference */
11069 case SAVEt_I8: /* I8 reference */
11070 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11071 ptr = POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11074 TOPINT(nss,ix) = i;
11076 case SAVEt_IV: /* IV reference */
11077 ptr = POPPTR(ss,ix);
11078 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11080 TOPIV(nss,ix) = iv;
11082 case SAVEt_HPTR: /* HV* reference */
11083 case SAVEt_APTR: /* AV* reference */
11084 case SAVEt_SPTR: /* SV* reference */
11085 ptr = POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11087 sv = (SV*)POPPTR(ss,ix);
11088 TOPPTR(nss,ix) = sv_dup(sv, param);
11090 case SAVEt_VPTR: /* random* reference */
11091 ptr = POPPTR(ss,ix);
11092 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11093 ptr = POPPTR(ss,ix);
11094 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11096 case SAVEt_GENERIC_PVREF: /* generic char* */
11097 case SAVEt_PPTR: /* char* reference */
11098 ptr = POPPTR(ss,ix);
11099 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11100 c = (char*)POPPTR(ss,ix);
11101 TOPPTR(nss,ix) = pv_dup(c);
11103 case SAVEt_GP: /* scalar reference */
11104 gp = (GP*)POPPTR(ss,ix);
11105 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11106 (void)GpREFCNT_inc(gp);
11107 gv = (GV*)POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11111 ptr = POPPTR(ss,ix);
11112 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11113 /* these are assumed to be refcounted properly */
11115 switch (((OP*)ptr)->op_type) {
11117 case OP_LEAVESUBLV:
11121 case OP_LEAVEWRITE:
11122 TOPPTR(nss,ix) = ptr;
11125 (void) OpREFCNT_inc(o);
11129 TOPPTR(nss,ix) = NULL;
11134 TOPPTR(nss,ix) = NULL;
11137 c = (char*)POPPTR(ss,ix);
11138 TOPPTR(nss,ix) = pv_dup_inc(c);
11141 hv = (HV*)POPPTR(ss,ix);
11142 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11143 c = (char*)POPPTR(ss,ix);
11144 TOPPTR(nss,ix) = pv_dup_inc(c);
11146 case SAVEt_STACK_POS: /* Position on Perl stack */
11148 TOPINT(nss,ix) = i;
11150 case SAVEt_DESTRUCTOR:
11151 ptr = POPPTR(ss,ix);
11152 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11153 dptr = POPDPTR(ss,ix);
11154 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11155 any_dup(FPTR2DPTR(void *, dptr),
11158 case SAVEt_DESTRUCTOR_X:
11159 ptr = POPPTR(ss,ix);
11160 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11161 dxptr = POPDXPTR(ss,ix);
11162 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11163 any_dup(FPTR2DPTR(void *, dxptr),
11166 case SAVEt_REGCONTEXT:
11169 TOPINT(nss,ix) = i;
11172 case SAVEt_AELEM: /* array element */
11173 sv = (SV*)POPPTR(ss,ix);
11174 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11176 TOPINT(nss,ix) = i;
11177 av = (AV*)POPPTR(ss,ix);
11178 TOPPTR(nss,ix) = av_dup_inc(av, param);
11181 ptr = POPPTR(ss,ix);
11182 TOPPTR(nss,ix) = ptr;
11186 TOPINT(nss,ix) = i;
11187 ptr = POPPTR(ss,ix);
11190 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11191 HINTS_REFCNT_UNLOCK;
11193 TOPPTR(nss,ix) = ptr;
11194 if (i & HINT_LOCALIZE_HH) {
11195 hv = (HV*)POPPTR(ss,ix);
11196 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11199 case SAVEt_PADSV_AND_MORTALIZE:
11200 longval = (long)POPLONG(ss,ix);
11201 TOPLONG(nss,ix) = longval;
11202 ptr = POPPTR(ss,ix);
11203 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11204 sv = (SV*)POPPTR(ss,ix);
11205 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11208 ptr = POPPTR(ss,ix);
11209 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11210 longval = (long)POPBOOL(ss,ix);
11211 TOPBOOL(nss,ix) = (bool)longval;
11213 case SAVEt_SET_SVFLAGS:
11215 TOPINT(nss,ix) = i;
11217 TOPINT(nss,ix) = i;
11218 sv = (SV*)POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = sv_dup(sv, param);
11221 case SAVEt_RE_STATE:
11223 const struct re_save_state *const old_state
11224 = (struct re_save_state *)
11225 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11226 struct re_save_state *const new_state
11227 = (struct re_save_state *)
11228 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11230 Copy(old_state, new_state, 1, struct re_save_state);
11231 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11233 new_state->re_state_bostr
11234 = pv_dup(old_state->re_state_bostr);
11235 new_state->re_state_reginput
11236 = pv_dup(old_state->re_state_reginput);
11237 new_state->re_state_regeol
11238 = pv_dup(old_state->re_state_regeol);
11239 new_state->re_state_regoffs
11240 = (regexp_paren_pair*)
11241 any_dup(old_state->re_state_regoffs, proto_perl);
11242 new_state->re_state_reglastparen
11243 = (U32*) any_dup(old_state->re_state_reglastparen,
11245 new_state->re_state_reglastcloseparen
11246 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11248 /* XXX This just has to be broken. The old save_re_context
11249 code did SAVEGENERICPV(PL_reg_start_tmp);
11250 PL_reg_start_tmp is char **.
11251 Look above to what the dup code does for
11252 SAVEt_GENERIC_PVREF
11253 It can never have worked.
11254 So this is merely a faithful copy of the exiting bug: */
11255 new_state->re_state_reg_start_tmp
11256 = (char **) pv_dup((char *)
11257 old_state->re_state_reg_start_tmp);
11258 /* I assume that it only ever "worked" because no-one called
11259 (pseudo)fork while the regexp engine had re-entered itself.
11261 #ifdef PERL_OLD_COPY_ON_WRITE
11262 new_state->re_state_nrs
11263 = sv_dup(old_state->re_state_nrs, param);
11265 new_state->re_state_reg_magic
11266 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11268 new_state->re_state_reg_oldcurpm
11269 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11271 new_state->re_state_reg_curpm
11272 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11274 new_state->re_state_reg_oldsaved
11275 = pv_dup(old_state->re_state_reg_oldsaved);
11276 new_state->re_state_reg_poscache
11277 = pv_dup(old_state->re_state_reg_poscache);
11278 new_state->re_state_reg_starttry
11279 = pv_dup(old_state->re_state_reg_starttry);
11282 case SAVEt_COMPILE_WARNINGS:
11283 ptr = POPPTR(ss,ix);
11284 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11287 ptr = POPPTR(ss,ix);
11288 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11292 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11300 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11301 * flag to the result. This is done for each stash before cloning starts,
11302 * so we know which stashes want their objects cloned */
11305 do_mark_cloneable_stash(pTHX_ SV *const sv)
11307 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11309 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11310 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11311 if (cloner && GvCV(cloner)) {
11318 mXPUSHs(newSVhek(hvname));
11320 call_sv((SV*)GvCV(cloner), G_SCALAR);
11327 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11335 =for apidoc perl_clone
11337 Create and return a new interpreter by cloning the current one.
11339 perl_clone takes these flags as parameters:
11341 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11342 without it we only clone the data and zero the stacks,
11343 with it we copy the stacks and the new perl interpreter is
11344 ready to run at the exact same point as the previous one.
11345 The pseudo-fork code uses COPY_STACKS while the
11346 threads->create doesn't.
11348 CLONEf_KEEP_PTR_TABLE
11349 perl_clone keeps a ptr_table with the pointer of the old
11350 variable as a key and the new variable as a value,
11351 this allows it to check if something has been cloned and not
11352 clone it again but rather just use the value and increase the
11353 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11354 the ptr_table using the function
11355 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11356 reason to keep it around is if you want to dup some of your own
11357 variable who are outside the graph perl scans, example of this
11358 code is in threads.xs create
11361 This is a win32 thing, it is ignored on unix, it tells perls
11362 win32host code (which is c++) to clone itself, this is needed on
11363 win32 if you want to run two threads at the same time,
11364 if you just want to do some stuff in a separate perl interpreter
11365 and then throw it away and return to the original one,
11366 you don't need to do anything.
11371 /* XXX the above needs expanding by someone who actually understands it ! */
11372 EXTERN_C PerlInterpreter *
11373 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11376 perl_clone(PerlInterpreter *proto_perl, UV flags)
11379 #ifdef PERL_IMPLICIT_SYS
11381 PERL_ARGS_ASSERT_PERL_CLONE;
11383 /* perlhost.h so we need to call into it
11384 to clone the host, CPerlHost should have a c interface, sky */
11386 if (flags & CLONEf_CLONE_HOST) {
11387 return perl_clone_host(proto_perl,flags);
11389 return perl_clone_using(proto_perl, flags,
11391 proto_perl->IMemShared,
11392 proto_perl->IMemParse,
11394 proto_perl->IStdIO,
11398 proto_perl->IProc);
11402 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11403 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11404 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11405 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11406 struct IPerlDir* ipD, struct IPerlSock* ipS,
11407 struct IPerlProc* ipP)
11409 /* XXX many of the string copies here can be optimized if they're
11410 * constants; they need to be allocated as common memory and just
11411 * their pointers copied. */
11414 CLONE_PARAMS clone_params;
11415 CLONE_PARAMS* const param = &clone_params;
11417 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11419 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11421 /* for each stash, determine whether its objects should be cloned */
11422 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11423 PERL_SET_THX(my_perl);
11426 PoisonNew(my_perl, 1, PerlInterpreter);
11432 PL_savestack_ix = 0;
11433 PL_savestack_max = -1;
11434 PL_sig_pending = 0;
11436 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11437 # else /* !DEBUGGING */
11438 Zero(my_perl, 1, PerlInterpreter);
11439 # endif /* DEBUGGING */
11441 /* host pointers */
11443 PL_MemShared = ipMS;
11444 PL_MemParse = ipMP;
11451 #else /* !PERL_IMPLICIT_SYS */
11453 CLONE_PARAMS clone_params;
11454 CLONE_PARAMS* param = &clone_params;
11455 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11457 PERL_ARGS_ASSERT_PERL_CLONE;
11459 /* for each stash, determine whether its objects should be cloned */
11460 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11461 PERL_SET_THX(my_perl);
11464 PoisonNew(my_perl, 1, PerlInterpreter);
11470 PL_savestack_ix = 0;
11471 PL_savestack_max = -1;
11472 PL_sig_pending = 0;
11474 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11475 # else /* !DEBUGGING */
11476 Zero(my_perl, 1, PerlInterpreter);
11477 # endif /* DEBUGGING */
11478 #endif /* PERL_IMPLICIT_SYS */
11479 param->flags = flags;
11480 param->proto_perl = proto_perl;
11482 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11484 PL_body_arenas = NULL;
11485 Zero(&PL_body_roots, 1, PL_body_roots);
11487 PL_nice_chunk = NULL;
11488 PL_nice_chunk_size = 0;
11490 PL_sv_objcount = 0;
11492 PL_sv_arenaroot = NULL;
11494 PL_debug = proto_perl->Idebug;
11496 PL_hash_seed = proto_perl->Ihash_seed;
11497 PL_rehash_seed = proto_perl->Irehash_seed;
11499 #ifdef USE_REENTRANT_API
11500 /* XXX: things like -Dm will segfault here in perlio, but doing
11501 * PERL_SET_CONTEXT(proto_perl);
11502 * breaks too many other things
11504 Perl_reentrant_init(aTHX);
11507 /* create SV map for pointer relocation */
11508 PL_ptr_table = ptr_table_new();
11510 /* initialize these special pointers as early as possible */
11511 SvANY(&PL_sv_undef) = NULL;
11512 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11513 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11514 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11516 SvANY(&PL_sv_no) = new_XPVNV();
11517 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11518 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11519 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11520 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11521 SvCUR_set(&PL_sv_no, 0);
11522 SvLEN_set(&PL_sv_no, 1);
11523 SvIV_set(&PL_sv_no, 0);
11524 SvNV_set(&PL_sv_no, 0);
11525 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11527 SvANY(&PL_sv_yes) = new_XPVNV();
11528 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11529 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11530 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11531 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11532 SvCUR_set(&PL_sv_yes, 1);
11533 SvLEN_set(&PL_sv_yes, 2);
11534 SvIV_set(&PL_sv_yes, 1);
11535 SvNV_set(&PL_sv_yes, 1);
11536 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11538 /* create (a non-shared!) shared string table */
11539 PL_strtab = newHV();
11540 HvSHAREKEYS_off(PL_strtab);
11541 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11542 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11544 PL_compiling = proto_perl->Icompiling;
11546 /* These two PVs will be free'd special way so must set them same way op.c does */
11547 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11548 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11550 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11551 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11553 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11554 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11555 if (PL_compiling.cop_hints_hash) {
11557 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11558 HINTS_REFCNT_UNLOCK;
11560 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11561 #ifdef PERL_DEBUG_READONLY_OPS
11566 /* pseudo environmental stuff */
11567 PL_origargc = proto_perl->Iorigargc;
11568 PL_origargv = proto_perl->Iorigargv;
11570 param->stashes = newAV(); /* Setup array of objects to call clone on */
11572 /* Set tainting stuff before PerlIO_debug can possibly get called */
11573 PL_tainting = proto_perl->Itainting;
11574 PL_taint_warn = proto_perl->Itaint_warn;
11576 #ifdef PERLIO_LAYERS
11577 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11578 PerlIO_clone(aTHX_ proto_perl, param);
11581 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11582 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11583 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11584 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11585 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11586 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11589 PL_minus_c = proto_perl->Iminus_c;
11590 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11591 PL_localpatches = proto_perl->Ilocalpatches;
11592 PL_splitstr = proto_perl->Isplitstr;
11593 PL_minus_n = proto_perl->Iminus_n;
11594 PL_minus_p = proto_perl->Iminus_p;
11595 PL_minus_l = proto_perl->Iminus_l;
11596 PL_minus_a = proto_perl->Iminus_a;
11597 PL_minus_E = proto_perl->Iminus_E;
11598 PL_minus_F = proto_perl->Iminus_F;
11599 PL_doswitches = proto_perl->Idoswitches;
11600 PL_dowarn = proto_perl->Idowarn;
11601 PL_doextract = proto_perl->Idoextract;
11602 PL_sawampersand = proto_perl->Isawampersand;
11603 PL_unsafe = proto_perl->Iunsafe;
11604 PL_inplace = SAVEPV(proto_perl->Iinplace);
11605 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11606 PL_perldb = proto_perl->Iperldb;
11607 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11608 PL_exit_flags = proto_perl->Iexit_flags;
11610 /* magical thingies */
11611 /* XXX time(&PL_basetime) when asked for? */
11612 PL_basetime = proto_perl->Ibasetime;
11613 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11615 PL_maxsysfd = proto_perl->Imaxsysfd;
11616 PL_statusvalue = proto_perl->Istatusvalue;
11618 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11620 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11622 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11624 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11625 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11626 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11629 /* RE engine related */
11630 Zero(&PL_reg_state, 1, struct re_save_state);
11631 PL_reginterp_cnt = 0;
11632 PL_regmatch_slab = NULL;
11634 /* Clone the regex array */
11635 /* ORANGE FIXME for plugins, probably in the SV dup code.
11636 newSViv(PTR2IV(CALLREGDUPE(
11637 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11639 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11640 PL_regex_pad = AvARRAY(PL_regex_padav);
11642 /* shortcuts to various I/O objects */
11643 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11644 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11645 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11646 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11647 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11648 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11650 /* shortcuts to regexp stuff */
11651 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11653 /* shortcuts to misc objects */
11654 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11656 /* shortcuts to debugging objects */
11657 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11658 PL_DBline = gv_dup(proto_perl->IDBline, param);
11659 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11660 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11661 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11662 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11663 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11665 /* symbol tables */
11666 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11667 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11668 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11669 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11670 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11672 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11673 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11674 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11675 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11676 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11677 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11678 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11679 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11681 PL_sub_generation = proto_perl->Isub_generation;
11682 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11684 /* funky return mechanisms */
11685 PL_forkprocess = proto_perl->Iforkprocess;
11687 /* subprocess state */
11688 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11690 /* internal state */
11691 PL_maxo = proto_perl->Imaxo;
11692 if (proto_perl->Iop_mask)
11693 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11696 /* PL_asserting = proto_perl->Iasserting; */
11698 /* current interpreter roots */
11699 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11701 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11703 PL_main_start = proto_perl->Imain_start;
11704 PL_eval_root = proto_perl->Ieval_root;
11705 PL_eval_start = proto_perl->Ieval_start;
11707 /* runtime control stuff */
11708 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11710 PL_filemode = proto_perl->Ifilemode;
11711 PL_lastfd = proto_perl->Ilastfd;
11712 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11715 PL_gensym = proto_perl->Igensym;
11716 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11717 PL_laststatval = proto_perl->Ilaststatval;
11718 PL_laststype = proto_perl->Ilaststype;
11721 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11723 /* interpreter atexit processing */
11724 PL_exitlistlen = proto_perl->Iexitlistlen;
11725 if (PL_exitlistlen) {
11726 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11727 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11730 PL_exitlist = (PerlExitListEntry*)NULL;
11732 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11733 if (PL_my_cxt_size) {
11734 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11735 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11736 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11737 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11738 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11742 PL_my_cxt_list = (void**)NULL;
11743 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11744 PL_my_cxt_keys = (const char**)NULL;
11747 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11748 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11749 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11751 PL_profiledata = NULL;
11753 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11755 PAD_CLONE_VARS(proto_perl, param);
11757 #ifdef HAVE_INTERP_INTERN
11758 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11761 /* more statics moved here */
11762 PL_generation = proto_perl->Igeneration;
11763 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11765 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11766 PL_in_clean_all = proto_perl->Iin_clean_all;
11768 PL_uid = proto_perl->Iuid;
11769 PL_euid = proto_perl->Ieuid;
11770 PL_gid = proto_perl->Igid;
11771 PL_egid = proto_perl->Iegid;
11772 PL_nomemok = proto_perl->Inomemok;
11773 PL_an = proto_perl->Ian;
11774 PL_evalseq = proto_perl->Ievalseq;
11775 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11776 PL_origalen = proto_perl->Iorigalen;
11777 #ifdef PERL_USES_PL_PIDSTATUS
11778 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11780 PL_osname = SAVEPV(proto_perl->Iosname);
11781 PL_sighandlerp = proto_perl->Isighandlerp;
11783 PL_runops = proto_perl->Irunops;
11785 PL_parser = parser_dup(proto_perl->Iparser, param);
11787 PL_subline = proto_perl->Isubline;
11788 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11791 PL_cryptseen = proto_perl->Icryptseen;
11794 PL_hints = proto_perl->Ihints;
11796 PL_amagic_generation = proto_perl->Iamagic_generation;
11798 #ifdef USE_LOCALE_COLLATE
11799 PL_collation_ix = proto_perl->Icollation_ix;
11800 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11801 PL_collation_standard = proto_perl->Icollation_standard;
11802 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11803 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11804 #endif /* USE_LOCALE_COLLATE */
11806 #ifdef USE_LOCALE_NUMERIC
11807 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11808 PL_numeric_standard = proto_perl->Inumeric_standard;
11809 PL_numeric_local = proto_perl->Inumeric_local;
11810 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11811 #endif /* !USE_LOCALE_NUMERIC */
11813 /* utf8 character classes */
11814 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11815 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11816 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11817 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11818 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11819 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11820 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11821 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11822 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11823 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11824 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11825 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11826 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11827 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11828 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11829 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11830 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11831 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11832 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11833 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11835 /* Did the locale setup indicate UTF-8? */
11836 PL_utf8locale = proto_perl->Iutf8locale;
11837 /* Unicode features (see perlrun/-C) */
11838 PL_unicode = proto_perl->Iunicode;
11840 /* Pre-5.8 signals control */
11841 PL_signals = proto_perl->Isignals;
11843 /* times() ticks per second */
11844 PL_clocktick = proto_perl->Iclocktick;
11846 /* Recursion stopper for PerlIO_find_layer */
11847 PL_in_load_module = proto_perl->Iin_load_module;
11849 /* sort() routine */
11850 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11852 /* Not really needed/useful since the reenrant_retint is "volatile",
11853 * but do it for consistency's sake. */
11854 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11856 /* Hooks to shared SVs and locks. */
11857 PL_sharehook = proto_perl->Isharehook;
11858 PL_lockhook = proto_perl->Ilockhook;
11859 PL_unlockhook = proto_perl->Iunlockhook;
11860 PL_threadhook = proto_perl->Ithreadhook;
11861 PL_destroyhook = proto_perl->Idestroyhook;
11863 #ifdef THREADS_HAVE_PIDS
11864 PL_ppid = proto_perl->Ippid;
11868 PL_last_swash_hv = NULL; /* reinits on demand */
11869 PL_last_swash_klen = 0;
11870 PL_last_swash_key[0]= '\0';
11871 PL_last_swash_tmps = (U8*)NULL;
11872 PL_last_swash_slen = 0;
11874 PL_glob_index = proto_perl->Iglob_index;
11875 PL_srand_called = proto_perl->Isrand_called;
11876 PL_bitcount = NULL; /* reinits on demand */
11878 if (proto_perl->Ipsig_pend) {
11879 Newxz(PL_psig_pend, SIG_SIZE, int);
11882 PL_psig_pend = (int*)NULL;
11885 if (proto_perl->Ipsig_ptr) {
11886 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11887 Newxz(PL_psig_name, SIG_SIZE, SV*);
11888 for (i = 1; i < SIG_SIZE; i++) {
11889 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11890 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11894 PL_psig_ptr = (SV**)NULL;
11895 PL_psig_name = (SV**)NULL;
11898 /* intrpvar.h stuff */
11900 if (flags & CLONEf_COPY_STACKS) {
11901 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11902 PL_tmps_ix = proto_perl->Itmps_ix;
11903 PL_tmps_max = proto_perl->Itmps_max;
11904 PL_tmps_floor = proto_perl->Itmps_floor;
11905 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11907 while (i <= PL_tmps_ix) {
11908 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11912 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11913 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11914 Newxz(PL_markstack, i, I32);
11915 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11916 - proto_perl->Imarkstack);
11917 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11918 - proto_perl->Imarkstack);
11919 Copy(proto_perl->Imarkstack, PL_markstack,
11920 PL_markstack_ptr - PL_markstack + 1, I32);
11922 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11923 * NOTE: unlike the others! */
11924 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11925 PL_scopestack_max = proto_perl->Iscopestack_max;
11926 Newxz(PL_scopestack, PL_scopestack_max, I32);
11927 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11929 /* NOTE: si_dup() looks at PL_markstack */
11930 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11932 /* PL_curstack = PL_curstackinfo->si_stack; */
11933 PL_curstack = av_dup(proto_perl->Icurstack, param);
11934 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11936 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11937 PL_stack_base = AvARRAY(PL_curstack);
11938 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11939 - proto_perl->Istack_base);
11940 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11942 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11943 * NOTE: unlike the others! */
11944 PL_savestack_ix = proto_perl->Isavestack_ix;
11945 PL_savestack_max = proto_perl->Isavestack_max;
11946 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11947 PL_savestack = ss_dup(proto_perl, param);
11951 ENTER; /* perl_destruct() wants to LEAVE; */
11953 /* although we're not duplicating the tmps stack, we should still
11954 * add entries for any SVs on the tmps stack that got cloned by a
11955 * non-refcount means (eg a temp in @_); otherwise they will be
11958 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11959 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11960 proto_perl->Itmps_stack[i]);
11961 if (nsv && !SvREFCNT(nsv)) {
11963 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11968 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11969 PL_top_env = &PL_start_env;
11971 PL_op = proto_perl->Iop;
11974 PL_Xpv = (XPV*)NULL;
11975 my_perl->Ina = proto_perl->Ina;
11977 PL_statbuf = proto_perl->Istatbuf;
11978 PL_statcache = proto_perl->Istatcache;
11979 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11980 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11982 PL_timesbuf = proto_perl->Itimesbuf;
11985 PL_tainted = proto_perl->Itainted;
11986 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11987 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11988 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11989 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11990 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11991 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11992 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11993 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11994 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11996 PL_restartop = proto_perl->Irestartop;
11997 PL_in_eval = proto_perl->Iin_eval;
11998 PL_delaymagic = proto_perl->Idelaymagic;
11999 PL_dirty = proto_perl->Idirty;
12000 PL_localizing = proto_perl->Ilocalizing;
12002 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12003 PL_hv_fetch_ent_mh = NULL;
12004 PL_modcount = proto_perl->Imodcount;
12005 PL_lastgotoprobe = NULL;
12006 PL_dumpindent = proto_perl->Idumpindent;
12008 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12009 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12010 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12011 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12012 PL_efloatbuf = NULL; /* reinits on demand */
12013 PL_efloatsize = 0; /* reinits on demand */
12017 PL_screamfirst = NULL;
12018 PL_screamnext = NULL;
12019 PL_maxscream = -1; /* reinits on demand */
12020 PL_lastscream = NULL;
12023 PL_regdummy = proto_perl->Iregdummy;
12024 PL_colorset = 0; /* reinits PL_colors[] */
12025 /*PL_colors[6] = {0,0,0,0,0,0};*/
12029 /* Pluggable optimizer */
12030 PL_peepp = proto_perl->Ipeepp;
12032 PL_stashcache = newHV();
12034 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12035 proto_perl->Iwatchaddr);
12036 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12037 if (PL_debug && PL_watchaddr) {
12038 PerlIO_printf(Perl_debug_log,
12039 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12040 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12041 PTR2UV(PL_watchok));
12044 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12045 ptr_table_free(PL_ptr_table);
12046 PL_ptr_table = NULL;
12049 /* Call the ->CLONE method, if it exists, for each of the stashes
12050 identified by sv_dup() above.
12052 while(av_len(param->stashes) != -1) {
12053 HV* const stash = (HV*) av_shift(param->stashes);
12054 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12055 if (cloner && GvCV(cloner)) {
12060 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12062 call_sv((SV*)GvCV(cloner), G_DISCARD);
12068 SvREFCNT_dec(param->stashes);
12070 /* orphaned? eg threads->new inside BEGIN or use */
12071 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12072 SvREFCNT_inc_simple_void(PL_compcv);
12073 SAVEFREESV(PL_compcv);
12079 #endif /* USE_ITHREADS */
12082 =head1 Unicode Support
12084 =for apidoc sv_recode_to_utf8
12086 The encoding is assumed to be an Encode object, on entry the PV
12087 of the sv is assumed to be octets in that encoding, and the sv
12088 will be converted into Unicode (and UTF-8).
12090 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12091 is not a reference, nothing is done to the sv. If the encoding is not
12092 an C<Encode::XS> Encoding object, bad things will happen.
12093 (See F<lib/encoding.pm> and L<Encode>).
12095 The PV of the sv is returned.
12100 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12104 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12106 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12120 Passing sv_yes is wrong - it needs to be or'ed set of constants
12121 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12122 remove converted chars from source.
12124 Both will default the value - let them.
12126 XPUSHs(&PL_sv_yes);
12129 call_method("decode", G_SCALAR);
12133 s = SvPV_const(uni, len);
12134 if (s != SvPVX_const(sv)) {
12135 SvGROW(sv, len + 1);
12136 Move(s, SvPVX(sv), len + 1, char);
12137 SvCUR_set(sv, len);
12144 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12148 =for apidoc sv_cat_decode
12150 The encoding is assumed to be an Encode object, the PV of the ssv is
12151 assumed to be octets in that encoding and decoding the input starts
12152 from the position which (PV + *offset) pointed to. The dsv will be
12153 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12154 when the string tstr appears in decoding output or the input ends on
12155 the PV of the ssv. The value which the offset points will be modified
12156 to the last input position on the ssv.
12158 Returns TRUE if the terminator was found, else returns FALSE.
12163 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12164 SV *ssv, int *offset, char *tstr, int tlen)
12169 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12171 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12182 offsv = newSViv(*offset);
12184 mXPUSHp(tstr, tlen);
12186 call_method("cat_decode", G_SCALAR);
12188 ret = SvTRUE(TOPs);
12189 *offset = SvIV(offsv);
12195 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12200 /* ---------------------------------------------------------------------
12202 * support functions for report_uninit()
12205 /* the maxiumum size of array or hash where we will scan looking
12206 * for the undefined element that triggered the warning */
12208 #define FUV_MAX_SEARCH_SIZE 1000
12210 /* Look for an entry in the hash whose value has the same SV as val;
12211 * If so, return a mortal copy of the key. */
12214 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12217 register HE **array;
12220 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12222 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12223 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12226 array = HvARRAY(hv);
12228 for (i=HvMAX(hv); i>0; i--) {
12229 register HE *entry;
12230 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12231 if (HeVAL(entry) != val)
12233 if ( HeVAL(entry) == &PL_sv_undef ||
12234 HeVAL(entry) == &PL_sv_placeholder)
12238 if (HeKLEN(entry) == HEf_SVKEY)
12239 return sv_mortalcopy(HeKEY_sv(entry));
12240 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12246 /* Look for an entry in the array whose value has the same SV as val;
12247 * If so, return the index, otherwise return -1. */
12250 S_find_array_subscript(pTHX_ AV *av, SV* val)
12254 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12256 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12257 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12260 if (val != &PL_sv_undef) {
12261 SV ** const svp = AvARRAY(av);
12264 for (i=AvFILLp(av); i>=0; i--)
12271 /* S_varname(): return the name of a variable, optionally with a subscript.
12272 * If gv is non-zero, use the name of that global, along with gvtype (one
12273 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12274 * targ. Depending on the value of the subscript_type flag, return:
12277 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12278 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12279 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12280 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12283 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12284 SV* keyname, I32 aindex, int subscript_type)
12287 SV * const name = sv_newmortal();
12290 buffer[0] = gvtype;
12293 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12295 gv_fullname4(name, gv, buffer, 0);
12297 if ((unsigned int)SvPVX(name)[1] <= 26) {
12299 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12301 /* Swap the 1 unprintable control character for the 2 byte pretty
12302 version - ie substr($name, 1, 1) = $buffer; */
12303 sv_insert(name, 1, 1, buffer, 2);
12307 CV * const cv = find_runcv(NULL);
12311 if (!cv || !CvPADLIST(cv))
12313 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12314 sv = *av_fetch(av, targ, FALSE);
12315 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12318 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12319 SV * const sv = newSV(0);
12320 *SvPVX(name) = '$';
12321 Perl_sv_catpvf(aTHX_ name, "{%s}",
12322 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12325 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12326 *SvPVX(name) = '$';
12327 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12329 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12330 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12331 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12339 =for apidoc find_uninit_var
12341 Find the name of the undefined variable (if any) that caused the operator o
12342 to issue a "Use of uninitialized value" warning.
12343 If match is true, only return a name if it's value matches uninit_sv.
12344 So roughly speaking, if a unary operator (such as OP_COS) generates a
12345 warning, then following the direct child of the op may yield an
12346 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12347 other hand, with OP_ADD there are two branches to follow, so we only print
12348 the variable name if we get an exact match.
12350 The name is returned as a mortal SV.
12352 Assumes that PL_op is the op that originally triggered the error, and that
12353 PL_comppad/PL_curpad points to the currently executing pad.
12359 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12367 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12368 uninit_sv == &PL_sv_placeholder)))
12371 switch (obase->op_type) {
12378 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12379 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12382 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12384 if (pad) { /* @lex, %lex */
12385 sv = PAD_SVl(obase->op_targ);
12389 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12390 /* @global, %global */
12391 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12394 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12396 else /* @{expr}, %{expr} */
12397 return find_uninit_var(cUNOPx(obase)->op_first,
12401 /* attempt to find a match within the aggregate */
12403 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12405 subscript_type = FUV_SUBSCRIPT_HASH;
12408 index = find_array_subscript((AV*)sv, uninit_sv);
12410 subscript_type = FUV_SUBSCRIPT_ARRAY;
12413 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12416 return varname(gv, hash ? '%' : '@', obase->op_targ,
12417 keysv, index, subscript_type);
12421 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12423 return varname(NULL, '$', obase->op_targ,
12424 NULL, 0, FUV_SUBSCRIPT_NONE);
12427 gv = cGVOPx_gv(obase);
12428 if (!gv || (match && GvSV(gv) != uninit_sv))
12430 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12433 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12436 av = (AV*)PAD_SV(obase->op_targ);
12437 if (!av || SvRMAGICAL(av))
12439 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12440 if (!svp || *svp != uninit_sv)
12443 return varname(NULL, '$', obase->op_targ,
12444 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12447 gv = cGVOPx_gv(obase);
12453 if (!av || SvRMAGICAL(av))
12455 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12456 if (!svp || *svp != uninit_sv)
12459 return varname(gv, '$', 0,
12460 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12465 o = cUNOPx(obase)->op_first;
12466 if (!o || o->op_type != OP_NULL ||
12467 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12469 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12473 if (PL_op == obase)
12474 /* $a[uninit_expr] or $h{uninit_expr} */
12475 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12478 o = cBINOPx(obase)->op_first;
12479 kid = cBINOPx(obase)->op_last;
12481 /* get the av or hv, and optionally the gv */
12483 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12484 sv = PAD_SV(o->op_targ);
12486 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12487 && cUNOPo->op_first->op_type == OP_GV)
12489 gv = cGVOPx_gv(cUNOPo->op_first);
12492 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12497 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12498 /* index is constant */
12502 if (obase->op_type == OP_HELEM) {
12503 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12504 if (!he || HeVAL(he) != uninit_sv)
12508 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12509 if (!svp || *svp != uninit_sv)
12513 if (obase->op_type == OP_HELEM)
12514 return varname(gv, '%', o->op_targ,
12515 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12517 return varname(gv, '@', o->op_targ, NULL,
12518 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12521 /* index is an expression;
12522 * attempt to find a match within the aggregate */
12523 if (obase->op_type == OP_HELEM) {
12524 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12526 return varname(gv, '%', o->op_targ,
12527 keysv, 0, FUV_SUBSCRIPT_HASH);
12530 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12532 return varname(gv, '@', o->op_targ,
12533 NULL, index, FUV_SUBSCRIPT_ARRAY);
12538 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12540 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12545 /* only examine RHS */
12546 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12549 o = cUNOPx(obase)->op_first;
12550 if (o->op_type == OP_PUSHMARK)
12553 if (!o->op_sibling) {
12554 /* one-arg version of open is highly magical */
12556 if (o->op_type == OP_GV) { /* open FOO; */
12558 if (match && GvSV(gv) != uninit_sv)
12560 return varname(gv, '$', 0,
12561 NULL, 0, FUV_SUBSCRIPT_NONE);
12563 /* other possibilities not handled are:
12564 * open $x; or open my $x; should return '${*$x}'
12565 * open expr; should return '$'.expr ideally
12571 /* ops where $_ may be an implicit arg */
12575 if ( !(obase->op_flags & OPf_STACKED)) {
12576 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12577 ? PAD_SVl(obase->op_targ)
12580 sv = sv_newmortal();
12581 sv_setpvn(sv, "$_", 2);
12590 /* skip filehandle as it can't produce 'undef' warning */
12591 o = cUNOPx(obase)->op_first;
12592 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12593 o = o->op_sibling->op_sibling;
12597 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12600 match = 1; /* XS or custom code could trigger random warnings */
12605 /* XXX tmp hack: these two may call an XS sub, and currently
12606 XS subs don't have a SUB entry on the context stack, so CV and
12607 pad determination goes wrong, and BAD things happen. So, just
12608 don't try to determine the value under those circumstances.
12609 Need a better fix at dome point. DAPM 11/2007 */
12613 /* def-ness of rval pos() is independent of the def-ness of its arg */
12614 if ( !(obase->op_flags & OPf_MOD))
12619 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12620 return newSVpvs_flags("${$/}", SVs_TEMP);
12625 if (!(obase->op_flags & OPf_KIDS))
12627 o = cUNOPx(obase)->op_first;
12633 /* if all except one arg are constant, or have no side-effects,
12634 * or are optimized away, then it's unambiguous */
12636 for (kid=o; kid; kid = kid->op_sibling) {
12638 const OPCODE type = kid->op_type;
12639 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12640 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12641 || (type == OP_PUSHMARK)
12645 if (o2) { /* more than one found */
12652 return find_uninit_var(o2, uninit_sv, match);
12654 /* scan all args */
12656 sv = find_uninit_var(o, uninit_sv, 1);
12668 =for apidoc report_uninit
12670 Print appropriate "Use of uninitialized variable" warning
12676 Perl_report_uninit(pTHX_ SV* uninit_sv)
12680 SV* varname = NULL;
12682 varname = find_uninit_var(PL_op, uninit_sv,0);
12684 sv_insert(varname, 0, 0, " ", 1);
12686 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12687 varname ? SvPV_nolen_const(varname) : "",
12688 " in ", OP_DESC(PL_op));
12691 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12697 * c-indentation-style: bsd
12698 * c-basic-offset: 4
12699 * indent-tabs-mode: t
12702 * ex: set ts=8 sts=4 sw=4 noet: