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 */
3558 /* There's a lot of redundancy below but we're going for speed here */
3563 if (dtype != SVt_PVGV) {
3564 (void)SvOK_off(dstr);
3572 sv_upgrade(dstr, SVt_IV);
3576 sv_upgrade(dstr, SVt_PVIV);
3579 goto end_of_first_switch;
3581 (void)SvIOK_only(dstr);
3582 SvIV_set(dstr, SvIVX(sstr));
3585 /* SvTAINTED can only be true if the SV has taint magic, which in
3586 turn means that the SV type is PVMG (or greater). This is the
3587 case statement for SVt_IV, so this cannot be true (whatever gcov
3589 assert(!SvTAINTED(sstr));
3594 if (dtype < SVt_PV && dtype != SVt_IV)
3595 sv_upgrade(dstr, SVt_IV);
3603 sv_upgrade(dstr, SVt_NV);
3607 sv_upgrade(dstr, SVt_PVNV);
3610 goto end_of_first_switch;
3612 SvNV_set(dstr, SvNVX(sstr));
3613 (void)SvNOK_only(dstr);
3614 /* SvTAINTED can only be true if the SV has taint magic, which in
3615 turn means that the SV type is PVMG (or greater). This is the
3616 case statement for SVt_NV, so this cannot be true (whatever gcov
3618 assert(!SvTAINTED(sstr));
3624 #ifdef PERL_OLD_COPY_ON_WRITE
3625 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3626 if (dtype < SVt_PVIV)
3627 sv_upgrade(dstr, SVt_PVIV);
3635 sv_upgrade(dstr, SVt_PV);
3638 if (dtype < SVt_PVIV)
3639 sv_upgrade(dstr, SVt_PVIV);
3642 if (dtype < SVt_PVNV)
3643 sv_upgrade(dstr, SVt_PVNV);
3647 const char * const type = sv_reftype(sstr,0);
3649 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3651 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3655 /* case SVt_BIND: */
3658 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3659 glob_assign_glob(dstr, sstr, dtype);
3662 /* SvVALID means that this PVGV is playing at being an FBM. */
3666 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3668 if (SvTYPE(sstr) != stype) {
3669 stype = SvTYPE(sstr);
3670 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3671 glob_assign_glob(dstr, sstr, dtype);
3676 if (stype == SVt_PVLV)
3677 SvUPGRADE(dstr, SVt_PVNV);
3679 SvUPGRADE(dstr, (svtype)stype);
3681 end_of_first_switch:
3683 /* dstr may have been upgraded. */
3684 dtype = SvTYPE(dstr);
3685 sflags = SvFLAGS(sstr);
3687 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3688 /* Assigning to a subroutine sets the prototype. */
3691 const char *const ptr = SvPV_const(sstr, len);
3693 SvGROW(dstr, len + 1);
3694 Copy(ptr, SvPVX(dstr), len + 1, char);
3695 SvCUR_set(dstr, len);
3697 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3701 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3702 const char * const type = sv_reftype(dstr,0);
3704 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3706 Perl_croak(aTHX_ "Cannot copy to %s", type);
3707 } else if (sflags & SVf_ROK) {
3708 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3709 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3712 if (GvIMPORTED(dstr) != GVf_IMPORTED
3713 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3715 GvIMPORTED_on(dstr);
3720 if (isGV_with_GP(sstr)) {
3721 glob_assign_glob(dstr, sstr, dtype);
3726 if (dtype >= SVt_PV) {
3727 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3728 glob_assign_ref(dstr, sstr);
3731 if (SvPVX_const(dstr)) {
3737 (void)SvOK_off(dstr);
3738 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3739 SvFLAGS(dstr) |= sflags & SVf_ROK;
3740 assert(!(sflags & SVp_NOK));
3741 assert(!(sflags & SVp_IOK));
3742 assert(!(sflags & SVf_NOK));
3743 assert(!(sflags & SVf_IOK));
3745 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3746 if (!(sflags & SVf_OK)) {
3747 if (ckWARN(WARN_MISC))
3748 Perl_warner(aTHX_ packWARN(WARN_MISC),
3749 "Undefined value assigned to typeglob");
3752 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3753 if (dstr != (SV*)gv) {
3756 GvGP(dstr) = gp_ref(GvGP(gv));
3760 else if (sflags & SVp_POK) {
3764 * Check to see if we can just swipe the string. If so, it's a
3765 * possible small lose on short strings, but a big win on long ones.
3766 * It might even be a win on short strings if SvPVX_const(dstr)
3767 * has to be allocated and SvPVX_const(sstr) has to be freed.
3768 * Likewise if we can set up COW rather than doing an actual copy, we
3769 * drop to the else clause, as the swipe code and the COW setup code
3770 * have much in common.
3773 /* Whichever path we take through the next code, we want this true,
3774 and doing it now facilitates the COW check. */
3775 (void)SvPOK_only(dstr);
3778 /* If we're already COW then this clause is not true, and if COW
3779 is allowed then we drop down to the else and make dest COW
3780 with us. If caller hasn't said that we're allowed to COW
3781 shared hash keys then we don't do the COW setup, even if the
3782 source scalar is a shared hash key scalar. */
3783 (((flags & SV_COW_SHARED_HASH_KEYS)
3784 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3785 : 1 /* If making a COW copy is forbidden then the behaviour we
3786 desire is as if the source SV isn't actually already
3787 COW, even if it is. So we act as if the source flags
3788 are not COW, rather than actually testing them. */
3790 #ifndef PERL_OLD_COPY_ON_WRITE
3791 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3792 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3793 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3794 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3795 but in turn, it's somewhat dead code, never expected to go
3796 live, but more kept as a placeholder on how to do it better
3797 in a newer implementation. */
3798 /* If we are COW and dstr is a suitable target then we drop down
3799 into the else and make dest a COW of us. */
3800 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3805 (sflags & SVs_TEMP) && /* slated for free anyway? */
3806 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3807 (!(flags & SV_NOSTEAL)) &&
3808 /* and we're allowed to steal temps */
3809 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3810 SvLEN(sstr) && /* and really is a string */
3811 /* and won't be needed again, potentially */
3812 !(PL_op && PL_op->op_type == OP_AASSIGN))
3813 #ifdef PERL_OLD_COPY_ON_WRITE
3814 && ((flags & SV_COW_SHARED_HASH_KEYS)
3815 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3816 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3817 && SvTYPE(sstr) >= SVt_PVIV))
3821 /* Failed the swipe test, and it's not a shared hash key either.
3822 Have to copy the string. */
3823 STRLEN len = SvCUR(sstr);
3824 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3825 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3826 SvCUR_set(dstr, len);
3827 *SvEND(dstr) = '\0';
3829 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3831 /* Either it's a shared hash key, or it's suitable for
3832 copy-on-write or we can swipe the string. */
3834 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3838 #ifdef PERL_OLD_COPY_ON_WRITE
3840 /* I believe I should acquire a global SV mutex if
3841 it's a COW sv (not a shared hash key) to stop
3842 it going un copy-on-write.
3843 If the source SV has gone un copy on write between up there
3844 and down here, then (assert() that) it is of the correct
3845 form to make it copy on write again */
3846 if ((sflags & (SVf_FAKE | SVf_READONLY))
3847 != (SVf_FAKE | SVf_READONLY)) {
3848 SvREADONLY_on(sstr);
3850 /* Make the source SV into a loop of 1.
3851 (about to become 2) */
3852 SV_COW_NEXT_SV_SET(sstr, sstr);
3856 /* Initial code is common. */
3857 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3862 /* making another shared SV. */
3863 STRLEN cur = SvCUR(sstr);
3864 STRLEN len = SvLEN(sstr);
3865 #ifdef PERL_OLD_COPY_ON_WRITE
3867 assert (SvTYPE(dstr) >= SVt_PVIV);
3868 /* SvIsCOW_normal */
3869 /* splice us in between source and next-after-source. */
3870 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3871 SV_COW_NEXT_SV_SET(sstr, dstr);
3872 SvPV_set(dstr, SvPVX_mutable(sstr));
3876 /* SvIsCOW_shared_hash */
3877 DEBUG_C(PerlIO_printf(Perl_debug_log,
3878 "Copy on write: Sharing hash\n"));
3880 assert (SvTYPE(dstr) >= SVt_PV);
3882 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3884 SvLEN_set(dstr, len);
3885 SvCUR_set(dstr, cur);
3886 SvREADONLY_on(dstr);
3888 /* Relesase a global SV mutex. */
3891 { /* Passes the swipe test. */
3892 SvPV_set(dstr, SvPVX_mutable(sstr));
3893 SvLEN_set(dstr, SvLEN(sstr));
3894 SvCUR_set(dstr, SvCUR(sstr));
3897 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3898 SvPV_set(sstr, NULL);
3904 if (sflags & SVp_NOK) {
3905 SvNV_set(dstr, SvNVX(sstr));
3907 if (sflags & SVp_IOK) {
3908 SvIV_set(dstr, SvIVX(sstr));
3909 /* Must do this otherwise some other overloaded use of 0x80000000
3910 gets confused. I guess SVpbm_VALID */
3911 if (sflags & SVf_IVisUV)
3914 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3916 const MAGIC * const smg = SvVSTRING_mg(sstr);
3918 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3919 smg->mg_ptr, smg->mg_len);
3920 SvRMAGICAL_on(dstr);
3924 else if (sflags & (SVp_IOK|SVp_NOK)) {
3925 (void)SvOK_off(dstr);
3926 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3927 if (sflags & SVp_IOK) {
3928 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3929 SvIV_set(dstr, SvIVX(sstr));
3931 if (sflags & SVp_NOK) {
3932 SvNV_set(dstr, SvNVX(sstr));
3936 if (isGV_with_GP(sstr)) {
3937 /* This stringification rule for globs is spread in 3 places.
3938 This feels bad. FIXME. */
3939 const U32 wasfake = sflags & SVf_FAKE;
3941 /* FAKE globs can get coerced, so need to turn this off
3942 temporarily if it is on. */
3944 gv_efullname3(dstr, (GV *)sstr, "*");
3945 SvFLAGS(sstr) |= wasfake;
3948 (void)SvOK_off(dstr);
3950 if (SvTAINTED(sstr))
3955 =for apidoc sv_setsv_mg
3957 Like C<sv_setsv>, but also handles 'set' magic.
3963 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3965 PERL_ARGS_ASSERT_SV_SETSV_MG;
3967 sv_setsv(dstr,sstr);
3971 #ifdef PERL_OLD_COPY_ON_WRITE
3973 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3975 STRLEN cur = SvCUR(sstr);
3976 STRLEN len = SvLEN(sstr);
3977 register char *new_pv;
3979 PERL_ARGS_ASSERT_SV_SETSV_COW;
3982 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3983 (void*)sstr, (void*)dstr);
3990 if (SvTHINKFIRST(dstr))
3991 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3992 else if (SvPVX_const(dstr))
3993 Safefree(SvPVX_const(dstr));
3997 SvUPGRADE(dstr, SVt_PVIV);
3999 assert (SvPOK(sstr));
4000 assert (SvPOKp(sstr));
4001 assert (!SvIOK(sstr));
4002 assert (!SvIOKp(sstr));
4003 assert (!SvNOK(sstr));
4004 assert (!SvNOKp(sstr));
4006 if (SvIsCOW(sstr)) {
4008 if (SvLEN(sstr) == 0) {
4009 /* source is a COW shared hash key. */
4010 DEBUG_C(PerlIO_printf(Perl_debug_log,
4011 "Fast copy on write: Sharing hash\n"));
4012 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4015 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4017 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4018 SvUPGRADE(sstr, SVt_PVIV);
4019 SvREADONLY_on(sstr);
4021 DEBUG_C(PerlIO_printf(Perl_debug_log,
4022 "Fast copy on write: Converting sstr to COW\n"));
4023 SV_COW_NEXT_SV_SET(dstr, sstr);
4025 SV_COW_NEXT_SV_SET(sstr, dstr);
4026 new_pv = SvPVX_mutable(sstr);
4029 SvPV_set(dstr, new_pv);
4030 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4033 SvLEN_set(dstr, len);
4034 SvCUR_set(dstr, cur);
4043 =for apidoc sv_setpvn
4045 Copies a string into an SV. The C<len> parameter indicates the number of
4046 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4047 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4053 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4056 register char *dptr;
4058 PERL_ARGS_ASSERT_SV_SETPVN;
4060 SV_CHECK_THINKFIRST_COW_DROP(sv);
4066 /* len is STRLEN which is unsigned, need to copy to signed */
4069 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4071 SvUPGRADE(sv, SVt_PV);
4073 dptr = SvGROW(sv, len + 1);
4074 Move(ptr,dptr,len,char);
4077 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4082 =for apidoc sv_setpvn_mg
4084 Like C<sv_setpvn>, but also handles 'set' magic.
4090 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4092 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4094 sv_setpvn(sv,ptr,len);
4099 =for apidoc sv_setpv
4101 Copies a string into an SV. The string must be null-terminated. Does not
4102 handle 'set' magic. See C<sv_setpv_mg>.
4108 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4111 register STRLEN len;
4113 PERL_ARGS_ASSERT_SV_SETPV;
4115 SV_CHECK_THINKFIRST_COW_DROP(sv);
4121 SvUPGRADE(sv, SVt_PV);
4123 SvGROW(sv, len + 1);
4124 Move(ptr,SvPVX(sv),len+1,char);
4126 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4131 =for apidoc sv_setpv_mg
4133 Like C<sv_setpv>, but also handles 'set' magic.
4139 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4141 PERL_ARGS_ASSERT_SV_SETPV_MG;
4148 =for apidoc sv_usepvn_flags
4150 Tells an SV to use C<ptr> to find its string value. Normally the
4151 string is stored inside the SV but sv_usepvn allows the SV to use an
4152 outside string. The C<ptr> should point to memory that was allocated
4153 by C<malloc>. The string length, C<len>, must be supplied. By default
4154 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4155 so that pointer should not be freed or used by the programmer after
4156 giving it to sv_usepvn, and neither should any pointers from "behind"
4157 that pointer (e.g. ptr + 1) be used.
4159 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4160 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4161 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4162 C<len>, and already meets the requirements for storing in C<SvPVX>)
4168 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4173 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4175 SV_CHECK_THINKFIRST_COW_DROP(sv);
4176 SvUPGRADE(sv, SVt_PV);
4179 if (flags & SV_SMAGIC)
4183 if (SvPVX_const(sv))
4187 if (flags & SV_HAS_TRAILING_NUL)
4188 assert(ptr[len] == '\0');
4191 allocate = (flags & SV_HAS_TRAILING_NUL)
4193 #ifdef Perl_safesysmalloc_size
4196 PERL_STRLEN_ROUNDUP(len + 1);
4198 if (flags & SV_HAS_TRAILING_NUL) {
4199 /* It's long enough - do nothing.
4200 Specfically Perl_newCONSTSUB is relying on this. */
4203 /* Force a move to shake out bugs in callers. */
4204 char *new_ptr = (char*)safemalloc(allocate);
4205 Copy(ptr, new_ptr, len, char);
4206 PoisonFree(ptr,len,char);
4210 ptr = (char*) saferealloc (ptr, allocate);
4213 #ifdef Perl_safesysmalloc_size
4214 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4216 SvLEN_set(sv, allocate);
4220 if (!(flags & SV_HAS_TRAILING_NUL)) {
4223 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4225 if (flags & SV_SMAGIC)
4229 #ifdef PERL_OLD_COPY_ON_WRITE
4230 /* Need to do this *after* making the SV normal, as we need the buffer
4231 pointer to remain valid until after we've copied it. If we let go too early,
4232 another thread could invalidate it by unsharing last of the same hash key
4233 (which it can do by means other than releasing copy-on-write Svs)
4234 or by changing the other copy-on-write SVs in the loop. */
4236 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4238 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4240 { /* this SV was SvIsCOW_normal(sv) */
4241 /* we need to find the SV pointing to us. */
4242 SV *current = SV_COW_NEXT_SV(after);
4244 if (current == sv) {
4245 /* The SV we point to points back to us (there were only two of us
4247 Hence other SV is no longer copy on write either. */
4249 SvREADONLY_off(after);
4251 /* We need to follow the pointers around the loop. */
4253 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4256 /* don't loop forever if the structure is bust, and we have
4257 a pointer into a closed loop. */
4258 assert (current != after);
4259 assert (SvPVX_const(current) == pvx);
4261 /* Make the SV before us point to the SV after us. */
4262 SV_COW_NEXT_SV_SET(current, after);
4268 =for apidoc sv_force_normal_flags
4270 Undo various types of fakery on an SV: if the PV is a shared string, make
4271 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4272 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4273 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4274 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4275 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4276 set to some other value.) In addition, the C<flags> parameter gets passed to
4277 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4278 with flags set to 0.
4284 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4288 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4290 #ifdef PERL_OLD_COPY_ON_WRITE
4291 if (SvREADONLY(sv)) {
4292 /* At this point I believe I should acquire a global SV mutex. */
4294 const char * const pvx = SvPVX_const(sv);
4295 const STRLEN len = SvLEN(sv);
4296 const STRLEN cur = SvCUR(sv);
4297 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4298 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4299 we'll fail an assertion. */
4300 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4303 PerlIO_printf(Perl_debug_log,
4304 "Copy on write: Force normal %ld\n",
4310 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4313 if (flags & SV_COW_DROP_PV) {
4314 /* OK, so we don't need to copy our buffer. */
4317 SvGROW(sv, cur + 1);
4318 Move(pvx,SvPVX(sv),cur,char);
4323 sv_release_COW(sv, pvx, next);
4325 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4331 else if (IN_PERL_RUNTIME)
4332 Perl_croak(aTHX_ PL_no_modify);
4333 /* At this point I believe that I can drop the global SV mutex. */
4336 if (SvREADONLY(sv)) {
4338 const char * const pvx = SvPVX_const(sv);
4339 const STRLEN len = SvCUR(sv);
4344 SvGROW(sv, len + 1);
4345 Move(pvx,SvPVX(sv),len,char);
4347 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4349 else if (IN_PERL_RUNTIME)
4350 Perl_croak(aTHX_ PL_no_modify);
4354 sv_unref_flags(sv, flags);
4355 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4362 Efficient removal of characters from the beginning of the string buffer.
4363 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4364 the string buffer. The C<ptr> becomes the first character of the adjusted
4365 string. Uses the "OOK hack".
4366 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4367 refer to the same chunk of data.
4373 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4379 const U8 *real_start;
4382 PERL_ARGS_ASSERT_SV_CHOP;
4384 if (!ptr || !SvPOKp(sv))
4386 delta = ptr - SvPVX_const(sv);
4388 /* Nothing to do. */
4391 assert(ptr > SvPVX_const(sv));
4392 SV_CHECK_THINKFIRST(sv);
4395 if (!SvLEN(sv)) { /* make copy of shared string */
4396 const char *pvx = SvPVX_const(sv);
4397 const STRLEN len = SvCUR(sv);
4398 SvGROW(sv, len + 1);
4399 Move(pvx,SvPVX(sv),len,char);
4402 SvFLAGS(sv) |= SVf_OOK;
4405 SvOOK_offset(sv, old_delta);
4407 SvLEN_set(sv, SvLEN(sv) - delta);
4408 SvCUR_set(sv, SvCUR(sv) - delta);
4409 SvPV_set(sv, SvPVX(sv) + delta);
4411 p = (U8 *)SvPVX_const(sv);
4416 real_start = p - delta;
4420 if (delta < 0x100) {
4424 p -= sizeof(STRLEN);
4425 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4429 /* Fill the preceding buffer with sentinals to verify that no-one is
4431 while (p > real_start) {
4439 =for apidoc sv_catpvn
4441 Concatenates the string onto the end of the string which is in the SV. The
4442 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4443 status set, then the bytes appended should be valid UTF-8.
4444 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4446 =for apidoc sv_catpvn_flags
4448 Concatenates the string onto the end of the string which is in the SV. The
4449 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4450 status set, then the bytes appended should be valid UTF-8.
4451 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4452 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4453 in terms of this function.
4459 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4463 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4465 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4467 SvGROW(dsv, dlen + slen + 1);
4469 sstr = SvPVX_const(dsv);
4470 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4471 SvCUR_set(dsv, SvCUR(dsv) + slen);
4473 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4475 if (flags & SV_SMAGIC)
4480 =for apidoc sv_catsv
4482 Concatenates the string from SV C<ssv> onto the end of the string in
4483 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4484 not 'set' magic. See C<sv_catsv_mg>.
4486 =for apidoc sv_catsv_flags
4488 Concatenates the string from SV C<ssv> onto the end of the string in
4489 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4490 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4491 and C<sv_catsv_nomg> are implemented in terms of this function.
4496 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4500 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4504 const char *spv = SvPV_const(ssv, slen);
4506 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4507 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4508 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4509 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4510 dsv->sv_flags doesn't have that bit set.
4511 Andy Dougherty 12 Oct 2001
4513 const I32 sutf8 = DO_UTF8(ssv);
4516 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4518 dutf8 = DO_UTF8(dsv);
4520 if (dutf8 != sutf8) {
4522 /* Not modifying source SV, so taking a temporary copy. */
4523 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4525 sv_utf8_upgrade(csv);
4526 spv = SvPV_const(csv, slen);
4529 sv_utf8_upgrade_nomg(dsv);
4531 sv_catpvn_nomg(dsv, spv, slen);
4534 if (flags & SV_SMAGIC)
4539 =for apidoc sv_catpv
4541 Concatenates the string onto the end of the string which is in the SV.
4542 If the SV has the UTF-8 status set, then the bytes appended should be
4543 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4548 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4551 register STRLEN len;
4555 PERL_ARGS_ASSERT_SV_CATPV;
4559 junk = SvPV_force(sv, tlen);
4561 SvGROW(sv, tlen + len + 1);
4563 ptr = SvPVX_const(sv);
4564 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4565 SvCUR_set(sv, SvCUR(sv) + len);
4566 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4571 =for apidoc sv_catpv_mg
4573 Like C<sv_catpv>, but also handles 'set' magic.
4579 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4581 PERL_ARGS_ASSERT_SV_CATPV_MG;
4590 Creates a new SV. A non-zero C<len> parameter indicates the number of
4591 bytes of preallocated string space the SV should have. An extra byte for a
4592 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4593 space is allocated.) The reference count for the new SV is set to 1.
4595 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4596 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4597 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4598 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4599 modules supporting older perls.
4605 Perl_newSV(pTHX_ const STRLEN len)
4612 sv_upgrade(sv, SVt_PV);
4613 SvGROW(sv, len + 1);
4618 =for apidoc sv_magicext
4620 Adds magic to an SV, upgrading it if necessary. Applies the
4621 supplied vtable and returns a pointer to the magic added.
4623 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4624 In particular, you can add magic to SvREADONLY SVs, and add more than
4625 one instance of the same 'how'.
4627 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4628 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4629 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4630 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4632 (This is now used as a subroutine by C<sv_magic>.)
4637 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4638 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4643 PERL_ARGS_ASSERT_SV_MAGICEXT;
4645 SvUPGRADE(sv, SVt_PVMG);
4646 Newxz(mg, 1, MAGIC);
4647 mg->mg_moremagic = SvMAGIC(sv);
4648 SvMAGIC_set(sv, mg);
4650 /* Sometimes a magic contains a reference loop, where the sv and
4651 object refer to each other. To prevent a reference loop that
4652 would prevent such objects being freed, we look for such loops
4653 and if we find one we avoid incrementing the object refcount.
4655 Note we cannot do this to avoid self-tie loops as intervening RV must
4656 have its REFCNT incremented to keep it in existence.
4659 if (!obj || obj == sv ||
4660 how == PERL_MAGIC_arylen ||
4661 how == PERL_MAGIC_symtab ||
4662 (SvTYPE(obj) == SVt_PVGV &&
4663 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4664 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4665 GvFORM(obj) == (CV*)sv)))
4670 mg->mg_obj = SvREFCNT_inc_simple(obj);
4671 mg->mg_flags |= MGf_REFCOUNTED;
4674 /* Normal self-ties simply pass a null object, and instead of
4675 using mg_obj directly, use the SvTIED_obj macro to produce a
4676 new RV as needed. For glob "self-ties", we are tieing the PVIO
4677 with an RV obj pointing to the glob containing the PVIO. In
4678 this case, to avoid a reference loop, we need to weaken the
4682 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4683 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4689 mg->mg_len = namlen;
4692 mg->mg_ptr = savepvn(name, namlen);
4693 else if (namlen == HEf_SVKEY)
4694 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4696 mg->mg_ptr = (char *) name;
4698 mg->mg_virtual = (MGVTBL *) vtable;
4702 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4707 =for apidoc sv_magic
4709 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4710 then adds a new magic item of type C<how> to the head of the magic list.
4712 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4713 handling of the C<name> and C<namlen> arguments.
4715 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4716 to add more than one instance of the same 'how'.
4722 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4723 const char *const name, const I32 namlen)
4726 const MGVTBL *vtable;
4729 PERL_ARGS_ASSERT_SV_MAGIC;
4731 #ifdef PERL_OLD_COPY_ON_WRITE
4733 sv_force_normal_flags(sv, 0);
4735 if (SvREADONLY(sv)) {
4737 /* its okay to attach magic to shared strings; the subsequent
4738 * upgrade to PVMG will unshare the string */
4739 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4742 && how != PERL_MAGIC_regex_global
4743 && how != PERL_MAGIC_bm
4744 && how != PERL_MAGIC_fm
4745 && how != PERL_MAGIC_sv
4746 && how != PERL_MAGIC_backref
4749 Perl_croak(aTHX_ PL_no_modify);
4752 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4753 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4754 /* sv_magic() refuses to add a magic of the same 'how' as an
4757 if (how == PERL_MAGIC_taint) {
4759 /* Any scalar which already had taint magic on which someone
4760 (erroneously?) did SvIOK_on() or similar will now be
4761 incorrectly sporting public "OK" flags. */
4762 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4770 vtable = &PL_vtbl_sv;
4772 case PERL_MAGIC_overload:
4773 vtable = &PL_vtbl_amagic;
4775 case PERL_MAGIC_overload_elem:
4776 vtable = &PL_vtbl_amagicelem;
4778 case PERL_MAGIC_overload_table:
4779 vtable = &PL_vtbl_ovrld;
4782 vtable = &PL_vtbl_bm;
4784 case PERL_MAGIC_regdata:
4785 vtable = &PL_vtbl_regdata;
4787 case PERL_MAGIC_regdatum:
4788 vtable = &PL_vtbl_regdatum;
4790 case PERL_MAGIC_env:
4791 vtable = &PL_vtbl_env;
4794 vtable = &PL_vtbl_fm;
4796 case PERL_MAGIC_envelem:
4797 vtable = &PL_vtbl_envelem;
4799 case PERL_MAGIC_regex_global:
4800 vtable = &PL_vtbl_mglob;
4802 case PERL_MAGIC_isa:
4803 vtable = &PL_vtbl_isa;
4805 case PERL_MAGIC_isaelem:
4806 vtable = &PL_vtbl_isaelem;
4808 case PERL_MAGIC_nkeys:
4809 vtable = &PL_vtbl_nkeys;
4811 case PERL_MAGIC_dbfile:
4814 case PERL_MAGIC_dbline:
4815 vtable = &PL_vtbl_dbline;
4817 #ifdef USE_LOCALE_COLLATE
4818 case PERL_MAGIC_collxfrm:
4819 vtable = &PL_vtbl_collxfrm;
4821 #endif /* USE_LOCALE_COLLATE */
4822 case PERL_MAGIC_tied:
4823 vtable = &PL_vtbl_pack;
4825 case PERL_MAGIC_tiedelem:
4826 case PERL_MAGIC_tiedscalar:
4827 vtable = &PL_vtbl_packelem;
4830 vtable = &PL_vtbl_regexp;
4832 case PERL_MAGIC_hints:
4833 /* As this vtable is all NULL, we can reuse it. */
4834 case PERL_MAGIC_sig:
4835 vtable = &PL_vtbl_sig;
4837 case PERL_MAGIC_sigelem:
4838 vtable = &PL_vtbl_sigelem;
4840 case PERL_MAGIC_taint:
4841 vtable = &PL_vtbl_taint;
4843 case PERL_MAGIC_uvar:
4844 vtable = &PL_vtbl_uvar;
4846 case PERL_MAGIC_vec:
4847 vtable = &PL_vtbl_vec;
4849 case PERL_MAGIC_arylen_p:
4850 case PERL_MAGIC_rhash:
4851 case PERL_MAGIC_symtab:
4852 case PERL_MAGIC_vstring:
4855 case PERL_MAGIC_utf8:
4856 vtable = &PL_vtbl_utf8;
4858 case PERL_MAGIC_substr:
4859 vtable = &PL_vtbl_substr;
4861 case PERL_MAGIC_defelem:
4862 vtable = &PL_vtbl_defelem;
4864 case PERL_MAGIC_arylen:
4865 vtable = &PL_vtbl_arylen;
4867 case PERL_MAGIC_pos:
4868 vtable = &PL_vtbl_pos;
4870 case PERL_MAGIC_backref:
4871 vtable = &PL_vtbl_backref;
4873 case PERL_MAGIC_hintselem:
4874 vtable = &PL_vtbl_hintselem;
4876 case PERL_MAGIC_ext:
4877 /* Reserved for use by extensions not perl internals. */
4878 /* Useful for attaching extension internal data to perl vars. */
4879 /* Note that multiple extensions may clash if magical scalars */
4880 /* etc holding private data from one are passed to another. */
4884 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4887 /* Rest of work is done else where */
4888 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4891 case PERL_MAGIC_taint:
4894 case PERL_MAGIC_ext:
4895 case PERL_MAGIC_dbfile:
4902 =for apidoc sv_unmagic
4904 Removes all magic of type C<type> from an SV.
4910 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4915 PERL_ARGS_ASSERT_SV_UNMAGIC;
4917 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4919 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4920 for (mg = *mgp; mg; mg = *mgp) {
4921 if (mg->mg_type == type) {
4922 const MGVTBL* const vtbl = mg->mg_virtual;
4923 *mgp = mg->mg_moremagic;
4924 if (vtbl && vtbl->svt_free)
4925 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4926 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4928 Safefree(mg->mg_ptr);
4929 else if (mg->mg_len == HEf_SVKEY)
4930 SvREFCNT_dec((SV*)mg->mg_ptr);
4931 else if (mg->mg_type == PERL_MAGIC_utf8)
4932 Safefree(mg->mg_ptr);
4934 if (mg->mg_flags & MGf_REFCOUNTED)
4935 SvREFCNT_dec(mg->mg_obj);
4939 mgp = &mg->mg_moremagic;
4943 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4944 SvMAGIC_set(sv, NULL);
4951 =for apidoc sv_rvweaken
4953 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4954 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4955 push a back-reference to this RV onto the array of backreferences
4956 associated with that magic. If the RV is magical, set magic will be
4957 called after the RV is cleared.
4963 Perl_sv_rvweaken(pTHX_ SV *const sv)
4967 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4969 if (!SvOK(sv)) /* let undefs pass */
4972 Perl_croak(aTHX_ "Can't weaken a nonreference");
4973 else if (SvWEAKREF(sv)) {
4974 if (ckWARN(WARN_MISC))
4975 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4979 Perl_sv_add_backref(aTHX_ tsv, sv);
4985 /* Give tsv backref magic if it hasn't already got it, then push a
4986 * back-reference to sv onto the array associated with the backref magic.
4990 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4995 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4997 if (SvTYPE(tsv) == SVt_PVHV) {
4998 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5002 /* There is no AV in the offical place - try a fixup. */
5003 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5006 /* Aha. They've got it stowed in magic. Bring it back. */
5007 av = (AV*)mg->mg_obj;
5008 /* Stop mg_free decreasing the refernce count. */
5010 /* Stop mg_free even calling the destructor, given that
5011 there's no AV to free up. */
5013 sv_unmagic(tsv, PERL_MAGIC_backref);
5017 SvREFCNT_inc_simple_void(av);
5022 const MAGIC *const mg
5023 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5025 av = (AV*)mg->mg_obj;
5029 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5030 /* av now has a refcnt of 2, which avoids it getting freed
5031 * before us during global cleanup. The extra ref is removed
5032 * by magic_killbackrefs() when tsv is being freed */
5035 if (AvFILLp(av) >= AvMAX(av)) {
5036 av_extend(av, AvFILLp(av)+1);
5038 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5041 /* delete a back-reference to ourselves from the backref magic associated
5042 * with the SV we point to.
5046 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5053 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5055 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5056 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5057 /* We mustn't attempt to "fix up" the hash here by moving the
5058 backreference array back to the hv_aux structure, as that is stored
5059 in the main HvARRAY(), and hfreentries assumes that no-one
5060 reallocates HvARRAY() while it is running. */
5063 const MAGIC *const mg
5064 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5066 av = (AV *)mg->mg_obj;
5069 if (PL_in_clean_all)
5071 Perl_croak(aTHX_ "panic: del_backref");
5078 /* We shouldn't be in here more than once, but for paranoia reasons lets
5080 for (i = AvFILLp(av); i >= 0; i--) {
5082 const SSize_t fill = AvFILLp(av);
5084 /* We weren't the last entry.
5085 An unordered list has this property that you can take the
5086 last element off the end to fill the hole, and it's still
5087 an unordered list :-)
5092 AvFILLp(av) = fill - 1;
5098 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5100 SV **svp = AvARRAY(av);
5102 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5103 PERL_UNUSED_ARG(sv);
5105 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5106 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5107 if (svp && !SvIS_FREED(av)) {
5108 SV *const *const last = svp + AvFILLp(av);
5110 while (svp <= last) {
5112 SV *const referrer = *svp;
5113 if (SvWEAKREF(referrer)) {
5114 /* XXX Should we check that it hasn't changed? */
5115 SvRV_set(referrer, 0);
5117 SvWEAKREF_off(referrer);
5118 SvSETMAGIC(referrer);
5119 } else if (SvTYPE(referrer) == SVt_PVGV ||
5120 SvTYPE(referrer) == SVt_PVLV) {
5121 /* You lookin' at me? */
5122 assert(GvSTASH(referrer));
5123 assert(GvSTASH(referrer) == (HV*)sv);
5124 GvSTASH(referrer) = 0;
5127 "panic: magic_killbackrefs (flags=%"UVxf")",
5128 (UV)SvFLAGS(referrer));
5136 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5141 =for apidoc sv_insert
5143 Inserts a string at the specified offset/length within the SV. Similar to
5144 the Perl substr() function. Handles get magic.
5146 =for apidoc sv_insert_flags
5148 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5154 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5159 register char *midend;
5160 register char *bigend;
5164 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5167 Perl_croak(aTHX_ "Can't modify non-existent substring");
5168 SvPV_force_flags(bigstr, curlen, flags);
5169 (void)SvPOK_only_UTF8(bigstr);
5170 if (offset + len > curlen) {
5171 SvGROW(bigstr, offset+len+1);
5172 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5173 SvCUR_set(bigstr, offset+len);
5177 i = littlelen - len;
5178 if (i > 0) { /* string might grow */
5179 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5180 mid = big + offset + len;
5181 midend = bigend = big + SvCUR(bigstr);
5184 while (midend > mid) /* shove everything down */
5185 *--bigend = *--midend;
5186 Move(little,big+offset,littlelen,char);
5187 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5192 Move(little,SvPVX(bigstr)+offset,len,char);
5197 big = SvPVX(bigstr);
5200 bigend = big + SvCUR(bigstr);
5202 if (midend > bigend)
5203 Perl_croak(aTHX_ "panic: sv_insert");
5205 if (mid - big > bigend - midend) { /* faster to shorten from end */
5207 Move(little, mid, littlelen,char);
5210 i = bigend - midend;
5212 Move(midend, mid, i,char);
5216 SvCUR_set(bigstr, mid - big);
5218 else if ((i = mid - big)) { /* faster from front */
5219 midend -= littlelen;
5221 Move(big, midend - i, i, char);
5222 sv_chop(bigstr,midend-i);
5224 Move(little, mid, littlelen,char);
5226 else if (littlelen) {
5227 midend -= littlelen;
5228 sv_chop(bigstr,midend);
5229 Move(little,midend,littlelen,char);
5232 sv_chop(bigstr,midend);
5238 =for apidoc sv_replace
5240 Make the first argument a copy of the second, then delete the original.
5241 The target SV physically takes over ownership of the body of the source SV
5242 and inherits its flags; however, the target keeps any magic it owns,
5243 and any magic in the source is discarded.
5244 Note that this is a rather specialist SV copying operation; most of the
5245 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5251 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5254 const U32 refcnt = SvREFCNT(sv);
5256 PERL_ARGS_ASSERT_SV_REPLACE;
5258 SV_CHECK_THINKFIRST_COW_DROP(sv);
5259 if (SvREFCNT(nsv) != 1) {
5260 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5261 UVuf " != 1)", (UV) SvREFCNT(nsv));
5263 if (SvMAGICAL(sv)) {
5267 sv_upgrade(nsv, SVt_PVMG);
5268 SvMAGIC_set(nsv, SvMAGIC(sv));
5269 SvFLAGS(nsv) |= SvMAGICAL(sv);
5271 SvMAGIC_set(sv, NULL);
5275 assert(!SvREFCNT(sv));
5276 #ifdef DEBUG_LEAKING_SCALARS
5277 sv->sv_flags = nsv->sv_flags;
5278 sv->sv_any = nsv->sv_any;
5279 sv->sv_refcnt = nsv->sv_refcnt;
5280 sv->sv_u = nsv->sv_u;
5282 StructCopy(nsv,sv,SV);
5284 if(SvTYPE(sv) == SVt_IV) {
5286 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5290 #ifdef PERL_OLD_COPY_ON_WRITE
5291 if (SvIsCOW_normal(nsv)) {
5292 /* We need to follow the pointers around the loop to make the
5293 previous SV point to sv, rather than nsv. */
5296 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5299 assert(SvPVX_const(current) == SvPVX_const(nsv));
5301 /* Make the SV before us point to the SV after us. */
5303 PerlIO_printf(Perl_debug_log, "previous is\n");
5305 PerlIO_printf(Perl_debug_log,
5306 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5307 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5309 SV_COW_NEXT_SV_SET(current, sv);
5312 SvREFCNT(sv) = refcnt;
5313 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5319 =for apidoc sv_clear
5321 Clear an SV: call any destructors, free up any memory used by the body,
5322 and free the body itself. The SV's head is I<not> freed, although
5323 its type is set to all 1's so that it won't inadvertently be assumed
5324 to be live during global destruction etc.
5325 This function should only be called when REFCNT is zero. Most of the time
5326 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5333 Perl_sv_clear(pTHX_ register SV *const sv)
5336 const U32 type = SvTYPE(sv);
5337 const struct body_details *const sv_type_details
5338 = bodies_by_type + type;
5341 PERL_ARGS_ASSERT_SV_CLEAR;
5342 assert(SvREFCNT(sv) == 0);
5343 assert(SvTYPE(sv) != SVTYPEMASK);
5345 if (type <= SVt_IV) {
5346 /* See the comment in sv.h about the collusion between this early
5347 return and the overloading of the NULL and IV slots in the size
5350 SV * const target = SvRV(sv);
5352 sv_del_backref(target, sv);
5354 SvREFCNT_dec(target);
5356 SvFLAGS(sv) &= SVf_BREAK;
5357 SvFLAGS(sv) |= SVTYPEMASK;
5362 if (PL_defstash && /* Still have a symbol table? */
5369 stash = SvSTASH(sv);
5370 destructor = StashHANDLER(stash,DESTROY);
5372 SV* const tmpref = newRV(sv);
5373 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5375 PUSHSTACKi(PERLSI_DESTROY);
5380 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5386 if(SvREFCNT(tmpref) < 2) {
5387 /* tmpref is not kept alive! */
5389 SvRV_set(tmpref, NULL);
5392 SvREFCNT_dec(tmpref);
5394 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5398 if (PL_in_clean_objs)
5399 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5401 /* DESTROY gave object new lease on life */
5407 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5408 SvOBJECT_off(sv); /* Curse the object. */
5409 if (type != SVt_PVIO)
5410 --PL_sv_objcount; /* XXX Might want something more general */
5413 if (type >= SVt_PVMG) {
5414 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5415 SvREFCNT_dec(SvOURSTASH(sv));
5416 } else if (SvMAGIC(sv))
5418 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5419 SvREFCNT_dec(SvSTASH(sv));
5422 /* case SVt_BIND: */
5425 IoIFP(sv) != PerlIO_stdin() &&
5426 IoIFP(sv) != PerlIO_stdout() &&
5427 IoIFP(sv) != PerlIO_stderr())
5429 io_close((IO*)sv, FALSE);
5431 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5432 PerlDir_close(IoDIRP(sv));
5433 IoDIRP(sv) = (DIR*)NULL;
5434 Safefree(IoTOP_NAME(sv));
5435 Safefree(IoFMT_NAME(sv));
5436 Safefree(IoBOTTOM_NAME(sv));
5439 /* FIXME for plugins */
5440 pregfree2((REGEXP*) sv);
5447 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5451 if (PL_comppad == (AV*)sv) {
5458 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5459 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5460 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5461 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5463 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5464 SvREFCNT_dec(LvTARG(sv));
5466 if (isGV_with_GP(sv)) {
5467 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5468 mro_method_changed_in(stash);
5471 unshare_hek(GvNAME_HEK(sv));
5472 /* If we're in a stash, we don't own a reference to it. However it does
5473 have a back reference to us, which needs to be cleared. */
5474 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5475 sv_del_backref((SV*)stash, sv);
5477 /* FIXME. There are probably more unreferenced pointers to SVs in the
5478 interpreter struct that we should check and tidy in a similar
5480 if ((GV*)sv == PL_last_in_gv)
5481 PL_last_in_gv = NULL;
5487 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5490 SvOOK_offset(sv, offset);
5491 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5492 /* Don't even bother with turning off the OOK flag. */
5495 SV * const target = SvRV(sv);
5497 sv_del_backref(target, sv);
5499 SvREFCNT_dec(target);
5501 #ifdef PERL_OLD_COPY_ON_WRITE
5502 else if (SvPVX_const(sv)) {
5504 /* I believe I need to grab the global SV mutex here and
5505 then recheck the COW status. */
5507 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5511 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5513 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5516 /* And drop it here. */
5518 } else if (SvLEN(sv)) {
5519 Safefree(SvPVX_const(sv));
5523 else if (SvPVX_const(sv) && SvLEN(sv))
5524 Safefree(SvPVX_mutable(sv));
5525 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5526 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5535 SvFLAGS(sv) &= SVf_BREAK;
5536 SvFLAGS(sv) |= SVTYPEMASK;
5538 if (sv_type_details->arena) {
5539 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5540 &PL_body_roots[type]);
5542 else if (sv_type_details->body_size) {
5543 my_safefree(SvANY(sv));
5548 =for apidoc sv_newref
5550 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5557 Perl_sv_newref(pTHX_ SV *const sv)
5559 PERL_UNUSED_CONTEXT;
5568 Decrement an SV's reference count, and if it drops to zero, call
5569 C<sv_clear> to invoke destructors and free up any memory used by
5570 the body; finally, deallocate the SV's head itself.
5571 Normally called via a wrapper macro C<SvREFCNT_dec>.
5577 Perl_sv_free(pTHX_ SV *const sv)
5582 if (SvREFCNT(sv) == 0) {
5583 if (SvFLAGS(sv) & SVf_BREAK)
5584 /* this SV's refcnt has been artificially decremented to
5585 * trigger cleanup */
5587 if (PL_in_clean_all) /* All is fair */
5589 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5590 /* make sure SvREFCNT(sv)==0 happens very seldom */
5591 SvREFCNT(sv) = (~(U32)0)/2;
5594 if (ckWARN_d(WARN_INTERNAL)) {
5595 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5596 Perl_dump_sv_child(aTHX_ sv);
5598 #ifdef DEBUG_LEAKING_SCALARS
5601 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5602 if (PL_warnhook == PERL_WARNHOOK_FATAL
5603 || ckDEAD(packWARN(WARN_INTERNAL))) {
5604 /* Don't let Perl_warner cause us to escape our fate: */
5608 /* This may not return: */
5609 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5610 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5611 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5614 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5619 if (--(SvREFCNT(sv)) > 0)
5621 Perl_sv_free2(aTHX_ sv);
5625 Perl_sv_free2(pTHX_ SV *const sv)
5629 PERL_ARGS_ASSERT_SV_FREE2;
5633 if (ckWARN_d(WARN_DEBUGGING))
5634 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5635 "Attempt to free temp prematurely: SV 0x%"UVxf
5636 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5640 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5641 /* make sure SvREFCNT(sv)==0 happens very seldom */
5642 SvREFCNT(sv) = (~(U32)0)/2;
5653 Returns the length of the string in the SV. Handles magic and type
5654 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5660 Perl_sv_len(pTHX_ register SV *const sv)
5668 len = mg_length(sv);
5670 (void)SvPV_const(sv, len);
5675 =for apidoc sv_len_utf8
5677 Returns the number of characters in the string in an SV, counting wide
5678 UTF-8 bytes as a single character. Handles magic and type coercion.
5684 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5685 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5686 * (Note that the mg_len is not the length of the mg_ptr field.
5687 * This allows the cache to store the character length of the string without
5688 * needing to malloc() extra storage to attach to the mg_ptr.)
5693 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5699 return mg_length(sv);
5703 const U8 *s = (U8*)SvPV_const(sv, len);
5707 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5709 if (mg && mg->mg_len != -1) {
5711 if (PL_utf8cache < 0) {
5712 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5714 /* Need to turn the assertions off otherwise we may
5715 recurse infinitely while printing error messages.
5717 SAVEI8(PL_utf8cache);
5719 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5720 " real %"UVuf" for %"SVf,
5721 (UV) ulen, (UV) real, SVfARG(sv));
5726 ulen = Perl_utf8_length(aTHX_ s, s + len);
5727 if (!SvREADONLY(sv)) {
5729 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5730 &PL_vtbl_utf8, 0, 0);
5738 return Perl_utf8_length(aTHX_ s, s + len);
5742 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5745 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5748 const U8 *s = start;
5750 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5752 while (s < send && uoffset--)
5755 /* This is the existing behaviour. Possibly it should be a croak, as
5756 it's actually a bounds error */
5762 /* Given the length of the string in both bytes and UTF-8 characters, decide
5763 whether to walk forwards or backwards to find the byte corresponding to
5764 the passed in UTF-8 offset. */
5766 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5767 const STRLEN uoffset, const STRLEN uend)
5769 STRLEN backw = uend - uoffset;
5771 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5773 if (uoffset < 2 * backw) {
5774 /* The assumption is that going forwards is twice the speed of going
5775 forward (that's where the 2 * backw comes from).
5776 (The real figure of course depends on the UTF-8 data.) */
5777 return sv_pos_u2b_forwards(start, send, uoffset);
5782 while (UTF8_IS_CONTINUATION(*send))
5785 return send - start;
5788 /* For the string representation of the given scalar, find the byte
5789 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5790 give another position in the string, *before* the sought offset, which
5791 (which is always true, as 0, 0 is a valid pair of positions), which should
5792 help reduce the amount of linear searching.
5793 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5794 will be used to reduce the amount of linear searching. The cache will be
5795 created if necessary, and the found value offered to it for update. */
5797 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5798 const U8 *const send, const STRLEN uoffset,
5799 STRLEN uoffset0, STRLEN boffset0)
5801 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5804 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5806 assert (uoffset >= uoffset0);
5808 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5809 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5810 if ((*mgp)->mg_ptr) {
5811 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5812 if (cache[0] == uoffset) {
5813 /* An exact match. */
5816 if (cache[2] == uoffset) {
5817 /* An exact match. */
5821 if (cache[0] < uoffset) {
5822 /* The cache already knows part of the way. */
5823 if (cache[0] > uoffset0) {
5824 /* The cache knows more than the passed in pair */
5825 uoffset0 = cache[0];
5826 boffset0 = cache[1];
5828 if ((*mgp)->mg_len != -1) {
5829 /* And we know the end too. */
5831 + sv_pos_u2b_midway(start + boffset0, send,
5833 (*mgp)->mg_len - uoffset0);
5836 + sv_pos_u2b_forwards(start + boffset0,
5837 send, uoffset - uoffset0);
5840 else if (cache[2] < uoffset) {
5841 /* We're between the two cache entries. */
5842 if (cache[2] > uoffset0) {
5843 /* and the cache knows more than the passed in pair */
5844 uoffset0 = cache[2];
5845 boffset0 = cache[3];
5849 + sv_pos_u2b_midway(start + boffset0,
5852 cache[0] - uoffset0);
5855 + sv_pos_u2b_midway(start + boffset0,
5858 cache[2] - uoffset0);
5862 else if ((*mgp)->mg_len != -1) {
5863 /* If we can take advantage of a passed in offset, do so. */
5864 /* In fact, offset0 is either 0, or less than offset, so don't
5865 need to worry about the other possibility. */
5867 + sv_pos_u2b_midway(start + boffset0, send,
5869 (*mgp)->mg_len - uoffset0);
5874 if (!found || PL_utf8cache < 0) {
5875 const STRLEN real_boffset
5876 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5877 send, uoffset - uoffset0);
5879 if (found && PL_utf8cache < 0) {
5880 if (real_boffset != boffset) {
5881 /* Need to turn the assertions off otherwise we may recurse
5882 infinitely while printing error messages. */
5883 SAVEI8(PL_utf8cache);
5885 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5886 " real %"UVuf" for %"SVf,
5887 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5890 boffset = real_boffset;
5894 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5900 =for apidoc sv_pos_u2b
5902 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5903 the start of the string, to a count of the equivalent number of bytes; if
5904 lenp is non-zero, it does the same to lenp, but this time starting from
5905 the offset, rather than from the start of the string. Handles magic and
5912 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5913 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5914 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5919 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5924 PERL_ARGS_ASSERT_SV_POS_U2B;
5929 start = (U8*)SvPV_const(sv, len);
5931 STRLEN uoffset = (STRLEN) *offsetp;
5932 const U8 * const send = start + len;
5934 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5937 *offsetp = (I32) boffset;
5940 /* Convert the relative offset to absolute. */
5941 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5942 const STRLEN boffset2
5943 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5944 uoffset, boffset) - boffset;
5958 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5959 byte length pairing. The (byte) length of the total SV is passed in too,
5960 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5961 may not have updated SvCUR, so we can't rely on reading it directly.
5963 The proffered utf8/byte length pairing isn't used if the cache already has
5964 two pairs, and swapping either for the proffered pair would increase the
5965 RMS of the intervals between known byte offsets.
5967 The cache itself consists of 4 STRLEN values
5968 0: larger UTF-8 offset
5969 1: corresponding byte offset
5970 2: smaller UTF-8 offset
5971 3: corresponding byte offset
5973 Unused cache pairs have the value 0, 0.
5974 Keeping the cache "backwards" means that the invariant of
5975 cache[0] >= cache[2] is maintained even with empty slots, which means that
5976 the code that uses it doesn't need to worry if only 1 entry has actually
5977 been set to non-zero. It also makes the "position beyond the end of the
5978 cache" logic much simpler, as the first slot is always the one to start
5982 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5983 const STRLEN utf8, const STRLEN blen)
5987 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5993 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5995 (*mgp)->mg_len = -1;
5999 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6000 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6001 (*mgp)->mg_ptr = (char *) cache;
6005 if (PL_utf8cache < 0) {
6006 const U8 *start = (const U8 *) SvPVX_const(sv);
6007 const STRLEN realutf8 = utf8_length(start, start + byte);
6009 if (realutf8 != utf8) {
6010 /* Need to turn the assertions off otherwise we may recurse
6011 infinitely while printing error messages. */
6012 SAVEI8(PL_utf8cache);
6014 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6015 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6019 /* Cache is held with the later position first, to simplify the code
6020 that deals with unbounded ends. */
6022 ASSERT_UTF8_CACHE(cache);
6023 if (cache[1] == 0) {
6024 /* Cache is totally empty */
6027 } else if (cache[3] == 0) {
6028 if (byte > cache[1]) {
6029 /* New one is larger, so goes first. */
6030 cache[2] = cache[0];
6031 cache[3] = cache[1];
6039 #define THREEWAY_SQUARE(a,b,c,d) \
6040 ((float)((d) - (c))) * ((float)((d) - (c))) \
6041 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6042 + ((float)((b) - (a))) * ((float)((b) - (a)))
6044 /* Cache has 2 slots in use, and we know three potential pairs.
6045 Keep the two that give the lowest RMS distance. Do the
6046 calcualation in bytes simply because we always know the byte
6047 length. squareroot has the same ordering as the positive value,
6048 so don't bother with the actual square root. */
6049 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6050 if (byte > cache[1]) {
6051 /* New position is after the existing pair of pairs. */
6052 const float keep_earlier
6053 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6054 const float keep_later
6055 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6057 if (keep_later < keep_earlier) {
6058 if (keep_later < existing) {
6059 cache[2] = cache[0];
6060 cache[3] = cache[1];
6066 if (keep_earlier < existing) {
6072 else if (byte > cache[3]) {
6073 /* New position is between the existing pair of pairs. */
6074 const float keep_earlier
6075 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6076 const float keep_later
6077 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6079 if (keep_later < keep_earlier) {
6080 if (keep_later < existing) {
6086 if (keep_earlier < existing) {
6093 /* New position is before the existing pair of pairs. */
6094 const float keep_earlier
6095 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6096 const float keep_later
6097 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6099 if (keep_later < keep_earlier) {
6100 if (keep_later < existing) {
6106 if (keep_earlier < existing) {
6107 cache[0] = cache[2];
6108 cache[1] = cache[3];
6115 ASSERT_UTF8_CACHE(cache);
6118 /* We already know all of the way, now we may be able to walk back. The same
6119 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6120 backward is half the speed of walking forward. */
6122 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6123 const U8 *end, STRLEN endu)
6125 const STRLEN forw = target - s;
6126 STRLEN backw = end - target;
6128 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6130 if (forw < 2 * backw) {
6131 return utf8_length(s, target);
6134 while (end > target) {
6136 while (UTF8_IS_CONTINUATION(*end)) {
6145 =for apidoc sv_pos_b2u
6147 Converts the value pointed to by offsetp from a count of bytes from the
6148 start of the string, to a count of the equivalent number of UTF-8 chars.
6149 Handles magic and type coercion.
6155 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6156 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6161 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6164 const STRLEN byte = *offsetp;
6165 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6171 PERL_ARGS_ASSERT_SV_POS_B2U;
6176 s = (const U8*)SvPV_const(sv, blen);
6179 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6183 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6184 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6186 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6187 if (cache[1] == byte) {
6188 /* An exact match. */
6189 *offsetp = cache[0];
6192 if (cache[3] == byte) {
6193 /* An exact match. */
6194 *offsetp = cache[2];
6198 if (cache[1] < byte) {
6199 /* We already know part of the way. */
6200 if (mg->mg_len != -1) {
6201 /* Actually, we know the end too. */
6203 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6204 s + blen, mg->mg_len - cache[0]);
6206 len = cache[0] + utf8_length(s + cache[1], send);
6209 else if (cache[3] < byte) {
6210 /* We're between the two cached pairs, so we do the calculation
6211 offset by the byte/utf-8 positions for the earlier pair,
6212 then add the utf-8 characters from the string start to
6214 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6215 s + cache[1], cache[0] - cache[2])
6219 else { /* cache[3] > byte */
6220 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6224 ASSERT_UTF8_CACHE(cache);
6226 } else if (mg->mg_len != -1) {
6227 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6231 if (!found || PL_utf8cache < 0) {
6232 const STRLEN real_len = utf8_length(s, send);
6234 if (found && PL_utf8cache < 0) {
6235 if (len != real_len) {
6236 /* Need to turn the assertions off otherwise we may recurse
6237 infinitely while printing error messages. */
6238 SAVEI8(PL_utf8cache);
6240 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6241 " real %"UVuf" for %"SVf,
6242 (UV) len, (UV) real_len, SVfARG(sv));
6250 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6256 Returns a boolean indicating whether the strings in the two SVs are
6257 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6258 coerce its args to strings if necessary.
6264 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6273 SV* svrecode = NULL;
6280 /* if pv1 and pv2 are the same, second SvPV_const call may
6281 * invalidate pv1, so we may need to make a copy */
6282 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6283 pv1 = SvPV_const(sv1, cur1);
6284 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6286 pv1 = SvPV_const(sv1, cur1);
6294 pv2 = SvPV_const(sv2, cur2);
6296 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6297 /* Differing utf8ness.
6298 * Do not UTF8size the comparands as a side-effect. */
6301 svrecode = newSVpvn(pv2, cur2);
6302 sv_recode_to_utf8(svrecode, PL_encoding);
6303 pv2 = SvPV_const(svrecode, cur2);
6306 svrecode = newSVpvn(pv1, cur1);
6307 sv_recode_to_utf8(svrecode, PL_encoding);
6308 pv1 = SvPV_const(svrecode, cur1);
6310 /* Now both are in UTF-8. */
6312 SvREFCNT_dec(svrecode);
6317 bool is_utf8 = TRUE;
6320 /* sv1 is the UTF-8 one,
6321 * if is equal it must be downgrade-able */
6322 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6328 /* sv2 is the UTF-8 one,
6329 * if is equal it must be downgrade-able */
6330 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6336 /* Downgrade not possible - cannot be eq */
6344 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6346 SvREFCNT_dec(svrecode);
6356 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6357 string in C<sv1> is less than, equal to, or greater than the string in
6358 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6359 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6365 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6369 const char *pv1, *pv2;
6372 SV *svrecode = NULL;
6379 pv1 = SvPV_const(sv1, cur1);
6386 pv2 = SvPV_const(sv2, cur2);
6388 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6389 /* Differing utf8ness.
6390 * Do not UTF8size the comparands as a side-effect. */
6393 svrecode = newSVpvn(pv2, cur2);
6394 sv_recode_to_utf8(svrecode, PL_encoding);
6395 pv2 = SvPV_const(svrecode, cur2);
6398 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6403 svrecode = newSVpvn(pv1, cur1);
6404 sv_recode_to_utf8(svrecode, PL_encoding);
6405 pv1 = SvPV_const(svrecode, cur1);
6408 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6414 cmp = cur2 ? -1 : 0;
6418 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6421 cmp = retval < 0 ? -1 : 1;
6422 } else if (cur1 == cur2) {
6425 cmp = cur1 < cur2 ? -1 : 1;
6429 SvREFCNT_dec(svrecode);
6437 =for apidoc sv_cmp_locale
6439 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6440 'use bytes' aware, handles get magic, and will coerce its args to strings
6441 if necessary. See also C<sv_cmp>.
6447 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6450 #ifdef USE_LOCALE_COLLATE
6456 if (PL_collation_standard)
6460 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6462 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6464 if (!pv1 || !len1) {
6475 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6478 return retval < 0 ? -1 : 1;
6481 * When the result of collation is equality, that doesn't mean
6482 * that there are no differences -- some locales exclude some
6483 * characters from consideration. So to avoid false equalities,
6484 * we use the raw string as a tiebreaker.
6490 #endif /* USE_LOCALE_COLLATE */
6492 return sv_cmp(sv1, sv2);
6496 #ifdef USE_LOCALE_COLLATE
6499 =for apidoc sv_collxfrm
6501 Add Collate Transform magic to an SV if it doesn't already have it.
6503 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6504 scalar data of the variable, but transformed to such a format that a normal
6505 memory comparison can be used to compare the data according to the locale
6512 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6517 PERL_ARGS_ASSERT_SV_COLLXFRM;
6519 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6520 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6526 Safefree(mg->mg_ptr);
6527 s = SvPV_const(sv, len);
6528 if ((xf = mem_collxfrm(s, len, &xlen))) {
6530 #ifdef PERL_OLD_COPY_ON_WRITE
6532 sv_force_normal_flags(sv, 0);
6534 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6548 if (mg && mg->mg_ptr) {
6550 return mg->mg_ptr + sizeof(PL_collation_ix);
6558 #endif /* USE_LOCALE_COLLATE */
6563 Get a line from the filehandle and store it into the SV, optionally
6564 appending to the currently-stored string.
6570 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6575 register STDCHAR rslast;
6576 register STDCHAR *bp;
6581 PERL_ARGS_ASSERT_SV_GETS;
6583 if (SvTHINKFIRST(sv))
6584 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6585 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6587 However, perlbench says it's slower, because the existing swipe code
6588 is faster than copy on write.
6589 Swings and roundabouts. */
6590 SvUPGRADE(sv, SVt_PV);
6595 if (PerlIO_isutf8(fp)) {
6597 sv_utf8_upgrade_nomg(sv);
6598 sv_pos_u2b(sv,&append,0);
6600 } else if (SvUTF8(sv)) {
6601 SV * const tsv = newSV(0);
6602 sv_gets(tsv, fp, 0);
6603 sv_utf8_upgrade_nomg(tsv);
6604 SvCUR_set(sv,append);
6607 goto return_string_or_null;
6612 if (PerlIO_isutf8(fp))
6615 if (IN_PERL_COMPILETIME) {
6616 /* we always read code in line mode */
6620 else if (RsSNARF(PL_rs)) {
6621 /* If it is a regular disk file use size from stat() as estimate
6622 of amount we are going to read -- may result in mallocing
6623 more memory than we really need if the layers below reduce
6624 the size we read (e.g. CRLF or a gzip layer).
6627 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6628 const Off_t offset = PerlIO_tell(fp);
6629 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6630 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6636 else if (RsRECORD(PL_rs)) {
6644 /* Grab the size of the record we're getting */
6645 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6646 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6649 /* VMS wants read instead of fread, because fread doesn't respect */
6650 /* RMS record boundaries. This is not necessarily a good thing to be */
6651 /* doing, but we've got no other real choice - except avoid stdio
6652 as implementation - perhaps write a :vms layer ?
6654 fd = PerlIO_fileno(fp);
6655 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6656 bytesread = PerlIO_read(fp, buffer, recsize);
6659 bytesread = PerlLIO_read(fd, buffer, recsize);
6662 bytesread = PerlIO_read(fp, buffer, recsize);
6666 SvCUR_set(sv, bytesread += append);
6667 buffer[bytesread] = '\0';
6668 goto return_string_or_null;
6670 else if (RsPARA(PL_rs)) {
6676 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6677 if (PerlIO_isutf8(fp)) {
6678 rsptr = SvPVutf8(PL_rs, rslen);
6681 if (SvUTF8(PL_rs)) {
6682 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6683 Perl_croak(aTHX_ "Wide character in $/");
6686 rsptr = SvPV_const(PL_rs, rslen);
6690 rslast = rslen ? rsptr[rslen - 1] : '\0';
6692 if (rspara) { /* have to do this both before and after */
6693 do { /* to make sure file boundaries work right */
6696 i = PerlIO_getc(fp);
6700 PerlIO_ungetc(fp,i);
6706 /* See if we know enough about I/O mechanism to cheat it ! */
6708 /* This used to be #ifdef test - it is made run-time test for ease
6709 of abstracting out stdio interface. One call should be cheap
6710 enough here - and may even be a macro allowing compile
6714 if (PerlIO_fast_gets(fp)) {
6717 * We're going to steal some values from the stdio struct
6718 * and put EVERYTHING in the innermost loop into registers.
6720 register STDCHAR *ptr;
6724 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6725 /* An ungetc()d char is handled separately from the regular
6726 * buffer, so we getc() it back out and stuff it in the buffer.
6728 i = PerlIO_getc(fp);
6729 if (i == EOF) return 0;
6730 *(--((*fp)->_ptr)) = (unsigned char) i;
6734 /* Here is some breathtakingly efficient cheating */
6736 cnt = PerlIO_get_cnt(fp); /* get count into register */
6737 /* make sure we have the room */
6738 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6739 /* Not room for all of it
6740 if we are looking for a separator and room for some
6742 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6743 /* just process what we have room for */
6744 shortbuffered = cnt - SvLEN(sv) + append + 1;
6745 cnt -= shortbuffered;
6749 /* remember that cnt can be negative */
6750 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6755 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6756 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6757 DEBUG_P(PerlIO_printf(Perl_debug_log,
6758 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6759 DEBUG_P(PerlIO_printf(Perl_debug_log,
6760 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6761 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6762 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6767 while (cnt > 0) { /* this | eat */
6769 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6770 goto thats_all_folks; /* screams | sed :-) */
6774 Copy(ptr, bp, cnt, char); /* this | eat */
6775 bp += cnt; /* screams | dust */
6776 ptr += cnt; /* louder | sed :-) */
6781 if (shortbuffered) { /* oh well, must extend */
6782 cnt = shortbuffered;
6784 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6786 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6787 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6791 DEBUG_P(PerlIO_printf(Perl_debug_log,
6792 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6793 PTR2UV(ptr),(long)cnt));
6794 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6796 DEBUG_P(PerlIO_printf(Perl_debug_log,
6797 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6798 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6799 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6801 /* This used to call 'filbuf' in stdio form, but as that behaves like
6802 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6803 another abstraction. */
6804 i = PerlIO_getc(fp); /* get more characters */
6806 DEBUG_P(PerlIO_printf(Perl_debug_log,
6807 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6808 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6809 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6811 cnt = PerlIO_get_cnt(fp);
6812 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6813 DEBUG_P(PerlIO_printf(Perl_debug_log,
6814 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6816 if (i == EOF) /* all done for ever? */
6817 goto thats_really_all_folks;
6819 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6821 SvGROW(sv, bpx + cnt + 2);
6822 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6824 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6826 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6827 goto thats_all_folks;
6831 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6832 memNE((char*)bp - rslen, rsptr, rslen))
6833 goto screamer; /* go back to the fray */
6834 thats_really_all_folks:
6836 cnt += shortbuffered;
6837 DEBUG_P(PerlIO_printf(Perl_debug_log,
6838 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6839 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6840 DEBUG_P(PerlIO_printf(Perl_debug_log,
6841 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6842 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6843 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6845 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6846 DEBUG_P(PerlIO_printf(Perl_debug_log,
6847 "Screamer: done, len=%ld, string=|%.*s|\n",
6848 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6852 /*The big, slow, and stupid way. */
6853 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6854 STDCHAR *buf = NULL;
6855 Newx(buf, 8192, STDCHAR);
6863 register const STDCHAR * const bpe = buf + sizeof(buf);
6865 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6866 ; /* keep reading */
6870 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6871 /* Accomodate broken VAXC compiler, which applies U8 cast to
6872 * both args of ?: operator, causing EOF to change into 255
6875 i = (U8)buf[cnt - 1];
6881 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6883 sv_catpvn(sv, (char *) buf, cnt);
6885 sv_setpvn(sv, (char *) buf, cnt);
6887 if (i != EOF && /* joy */
6889 SvCUR(sv) < rslen ||
6890 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6894 * If we're reading from a TTY and we get a short read,
6895 * indicating that the user hit his EOF character, we need
6896 * to notice it now, because if we try to read from the TTY
6897 * again, the EOF condition will disappear.
6899 * The comparison of cnt to sizeof(buf) is an optimization
6900 * that prevents unnecessary calls to feof().
6904 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6908 #ifdef USE_HEAP_INSTEAD_OF_STACK
6913 if (rspara) { /* have to do this both before and after */
6914 while (i != EOF) { /* to make sure file boundaries work right */
6915 i = PerlIO_getc(fp);
6917 PerlIO_ungetc(fp,i);
6923 return_string_or_null:
6924 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6930 Auto-increment of the value in the SV, doing string to numeric conversion
6931 if necessary. Handles 'get' magic.
6937 Perl_sv_inc(pTHX_ register SV *const sv)
6946 if (SvTHINKFIRST(sv)) {
6948 sv_force_normal_flags(sv, 0);
6949 if (SvREADONLY(sv)) {
6950 if (IN_PERL_RUNTIME)
6951 Perl_croak(aTHX_ PL_no_modify);
6955 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6957 i = PTR2IV(SvRV(sv));
6962 flags = SvFLAGS(sv);
6963 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6964 /* It's (privately or publicly) a float, but not tested as an
6965 integer, so test it to see. */
6967 flags = SvFLAGS(sv);
6969 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6970 /* It's publicly an integer, or privately an integer-not-float */
6971 #ifdef PERL_PRESERVE_IVUV
6975 if (SvUVX(sv) == UV_MAX)
6976 sv_setnv(sv, UV_MAX_P1);
6978 (void)SvIOK_only_UV(sv);
6979 SvUV_set(sv, SvUVX(sv) + 1);
6981 if (SvIVX(sv) == IV_MAX)
6982 sv_setuv(sv, (UV)IV_MAX + 1);
6984 (void)SvIOK_only(sv);
6985 SvIV_set(sv, SvIVX(sv) + 1);
6990 if (flags & SVp_NOK) {
6991 const NV was = SvNVX(sv);
6992 if (NV_OVERFLOWS_INTEGERS_AT &&
6993 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6994 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6995 "Lost precision when incrementing %" NVff " by 1",
6998 (void)SvNOK_only(sv);
6999 SvNV_set(sv, was + 1.0);
7003 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7004 if ((flags & SVTYPEMASK) < SVt_PVIV)
7005 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7006 (void)SvIOK_only(sv);
7011 while (isALPHA(*d)) d++;
7012 while (isDIGIT(*d)) d++;
7014 #ifdef PERL_PRESERVE_IVUV
7015 /* Got to punt this as an integer if needs be, but we don't issue
7016 warnings. Probably ought to make the sv_iv_please() that does
7017 the conversion if possible, and silently. */
7018 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7019 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7020 /* Need to try really hard to see if it's an integer.
7021 9.22337203685478e+18 is an integer.
7022 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7023 so $a="9.22337203685478e+18"; $a+0; $a++
7024 needs to be the same as $a="9.22337203685478e+18"; $a++
7031 /* sv_2iv *should* have made this an NV */
7032 if (flags & SVp_NOK) {
7033 (void)SvNOK_only(sv);
7034 SvNV_set(sv, SvNVX(sv) + 1.0);
7037 /* I don't think we can get here. Maybe I should assert this
7038 And if we do get here I suspect that sv_setnv will croak. NWC
7040 #if defined(USE_LONG_DOUBLE)
7041 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",
7042 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7044 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7045 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7048 #endif /* PERL_PRESERVE_IVUV */
7049 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7053 while (d >= SvPVX_const(sv)) {
7061 /* MKS: The original code here died if letters weren't consecutive.
7062 * at least it didn't have to worry about non-C locales. The
7063 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7064 * arranged in order (although not consecutively) and that only
7065 * [A-Za-z] are accepted by isALPHA in the C locale.
7067 if (*d != 'z' && *d != 'Z') {
7068 do { ++*d; } while (!isALPHA(*d));
7071 *(d--) -= 'z' - 'a';
7076 *(d--) -= 'z' - 'a' + 1;
7080 /* oh,oh, the number grew */
7081 SvGROW(sv, SvCUR(sv) + 2);
7082 SvCUR_set(sv, SvCUR(sv) + 1);
7083 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7094 Auto-decrement of the value in the SV, doing string to numeric conversion
7095 if necessary. Handles 'get' magic.
7101 Perl_sv_dec(pTHX_ register SV *const sv)
7109 if (SvTHINKFIRST(sv)) {
7111 sv_force_normal_flags(sv, 0);
7112 if (SvREADONLY(sv)) {
7113 if (IN_PERL_RUNTIME)
7114 Perl_croak(aTHX_ PL_no_modify);
7118 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7120 i = PTR2IV(SvRV(sv));
7125 /* Unlike sv_inc we don't have to worry about string-never-numbers
7126 and keeping them magic. But we mustn't warn on punting */
7127 flags = SvFLAGS(sv);
7128 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7129 /* It's publicly an integer, or privately an integer-not-float */
7130 #ifdef PERL_PRESERVE_IVUV
7134 if (SvUVX(sv) == 0) {
7135 (void)SvIOK_only(sv);
7139 (void)SvIOK_only_UV(sv);
7140 SvUV_set(sv, SvUVX(sv) - 1);
7143 if (SvIVX(sv) == IV_MIN) {
7144 sv_setnv(sv, (NV)IV_MIN);
7148 (void)SvIOK_only(sv);
7149 SvIV_set(sv, SvIVX(sv) - 1);
7154 if (flags & SVp_NOK) {
7157 const NV was = SvNVX(sv);
7158 if (NV_OVERFLOWS_INTEGERS_AT &&
7159 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7160 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7161 "Lost precision when decrementing %" NVff " by 1",
7164 (void)SvNOK_only(sv);
7165 SvNV_set(sv, was - 1.0);
7169 if (!(flags & SVp_POK)) {
7170 if ((flags & SVTYPEMASK) < SVt_PVIV)
7171 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7173 (void)SvIOK_only(sv);
7176 #ifdef PERL_PRESERVE_IVUV
7178 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7179 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7180 /* Need to try really hard to see if it's an integer.
7181 9.22337203685478e+18 is an integer.
7182 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7183 so $a="9.22337203685478e+18"; $a+0; $a--
7184 needs to be the same as $a="9.22337203685478e+18"; $a--
7191 /* sv_2iv *should* have made this an NV */
7192 if (flags & SVp_NOK) {
7193 (void)SvNOK_only(sv);
7194 SvNV_set(sv, SvNVX(sv) - 1.0);
7197 /* I don't think we can get here. Maybe I should assert this
7198 And if we do get here I suspect that sv_setnv will croak. NWC
7200 #if defined(USE_LONG_DOUBLE)
7201 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",
7202 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7204 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7205 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7209 #endif /* PERL_PRESERVE_IVUV */
7210 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7214 =for apidoc sv_mortalcopy
7216 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7217 The new SV is marked as mortal. It will be destroyed "soon", either by an
7218 explicit call to FREETMPS, or by an implicit call at places such as
7219 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7224 /* Make a string that will exist for the duration of the expression
7225 * evaluation. Actually, it may have to last longer than that, but
7226 * hopefully we won't free it until it has been assigned to a
7227 * permanent location. */
7230 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7236 sv_setsv(sv,oldstr);
7238 PL_tmps_stack[++PL_tmps_ix] = sv;
7244 =for apidoc sv_newmortal
7246 Creates a new null SV which is mortal. The reference count of the SV is
7247 set to 1. It will be destroyed "soon", either by an explicit call to
7248 FREETMPS, or by an implicit call at places such as statement boundaries.
7249 See also C<sv_mortalcopy> and C<sv_2mortal>.
7255 Perl_sv_newmortal(pTHX)
7261 SvFLAGS(sv) = SVs_TEMP;
7263 PL_tmps_stack[++PL_tmps_ix] = sv;
7269 =for apidoc newSVpvn_flags
7271 Creates a new SV and copies a string into it. The reference count for the
7272 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7273 string. You are responsible for ensuring that the source string is at least
7274 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7275 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7276 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7277 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7278 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7280 #define newSVpvn_utf8(s, len, u) \
7281 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7287 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7292 /* All the flags we don't support must be zero.
7293 And we're new code so I'm going to assert this from the start. */
7294 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7296 sv_setpvn(sv,s,len);
7297 SvFLAGS(sv) |= (flags & SVf_UTF8);
7298 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7302 =for apidoc sv_2mortal
7304 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7305 by an explicit call to FREETMPS, or by an implicit call at places such as
7306 statement boundaries. SvTEMP() is turned on which means that the SV's
7307 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7308 and C<sv_mortalcopy>.
7314 Perl_sv_2mortal(pTHX_ register SV *const sv)
7319 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7322 PL_tmps_stack[++PL_tmps_ix] = sv;
7330 Creates a new SV and copies a string into it. The reference count for the
7331 SV is set to 1. If C<len> is zero, Perl will compute the length using
7332 strlen(). For efficiency, consider using C<newSVpvn> instead.
7338 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7344 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7349 =for apidoc newSVpvn
7351 Creates a new SV and copies a string into it. The reference count for the
7352 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7353 string. You are responsible for ensuring that the source string is at least
7354 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7360 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7366 sv_setpvn(sv,s,len);
7371 =for apidoc newSVhek
7373 Creates a new SV from the hash key structure. It will generate scalars that
7374 point to the shared string table where possible. Returns a new (undefined)
7375 SV if the hek is NULL.
7381 Perl_newSVhek(pTHX_ const HEK *const hek)
7391 if (HEK_LEN(hek) == HEf_SVKEY) {
7392 return newSVsv(*(SV**)HEK_KEY(hek));
7394 const int flags = HEK_FLAGS(hek);
7395 if (flags & HVhek_WASUTF8) {
7397 Andreas would like keys he put in as utf8 to come back as utf8
7399 STRLEN utf8_len = HEK_LEN(hek);
7400 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7401 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7404 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7406 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7407 /* We don't have a pointer to the hv, so we have to replicate the
7408 flag into every HEK. This hv is using custom a hasing
7409 algorithm. Hence we can't return a shared string scalar, as
7410 that would contain the (wrong) hash value, and might get passed
7411 into an hv routine with a regular hash.
7412 Similarly, a hash that isn't using shared hash keys has to have
7413 the flag in every key so that we know not to try to call
7414 share_hek_kek on it. */
7416 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7421 /* This will be overwhelminly the most common case. */
7423 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7424 more efficient than sharepvn(). */
7428 sv_upgrade(sv, SVt_PV);
7429 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7430 SvCUR_set(sv, HEK_LEN(hek));
7443 =for apidoc newSVpvn_share
7445 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7446 table. If the string does not already exist in the table, it is created
7447 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7448 value is used; otherwise the hash is computed. The string's hash can be later
7449 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7450 that as the string table is used for shared hash keys these strings will have
7451 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7457 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7461 bool is_utf8 = FALSE;
7462 const char *const orig_src = src;
7465 STRLEN tmplen = -len;
7467 /* See the note in hv.c:hv_fetch() --jhi */
7468 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7472 PERL_HASH(hash, src, len);
7474 sv_upgrade(sv, SVt_PV);
7475 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7483 if (src != orig_src)
7489 #if defined(PERL_IMPLICIT_CONTEXT)
7491 /* pTHX_ magic can't cope with varargs, so this is a no-context
7492 * version of the main function, (which may itself be aliased to us).
7493 * Don't access this version directly.
7497 Perl_newSVpvf_nocontext(const char *const pat, ...)
7503 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7505 va_start(args, pat);
7506 sv = vnewSVpvf(pat, &args);
7513 =for apidoc newSVpvf
7515 Creates a new SV and initializes it with the string formatted like
7522 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7527 PERL_ARGS_ASSERT_NEWSVPVF;
7529 va_start(args, pat);
7530 sv = vnewSVpvf(pat, &args);
7535 /* backend for newSVpvf() and newSVpvf_nocontext() */
7538 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7543 PERL_ARGS_ASSERT_VNEWSVPVF;
7546 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7553 Creates a new SV and copies a floating point value into it.
7554 The reference count for the SV is set to 1.
7560 Perl_newSVnv(pTHX_ const NV n)
7573 Creates a new SV and copies an integer into it. The reference count for the
7580 Perl_newSViv(pTHX_ const IV i)
7593 Creates a new SV and copies an unsigned integer into it.
7594 The reference count for the SV is set to 1.
7600 Perl_newSVuv(pTHX_ const UV u)
7611 =for apidoc newSV_type
7613 Creates a new SV, of the type specified. The reference count for the new SV
7620 Perl_newSV_type(pTHX_ const svtype type)
7625 sv_upgrade(sv, type);
7630 =for apidoc newRV_noinc
7632 Creates an RV wrapper for an SV. The reference count for the original
7633 SV is B<not> incremented.
7639 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7642 register SV *sv = newSV_type(SVt_IV);
7644 PERL_ARGS_ASSERT_NEWRV_NOINC;
7647 SvRV_set(sv, tmpRef);
7652 /* newRV_inc is the official function name to use now.
7653 * newRV_inc is in fact #defined to newRV in sv.h
7657 Perl_newRV(pTHX_ SV *const sv)
7661 PERL_ARGS_ASSERT_NEWRV;
7663 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7669 Creates a new SV which is an exact duplicate of the original SV.
7676 Perl_newSVsv(pTHX_ register SV *const old)
7683 if (SvTYPE(old) == SVTYPEMASK) {
7684 if (ckWARN_d(WARN_INTERNAL))
7685 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7689 /* SV_GMAGIC is the default for sv_setv()
7690 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7691 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7692 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7697 =for apidoc sv_reset
7699 Underlying implementation for the C<reset> Perl function.
7700 Note that the perl-level function is vaguely deprecated.
7706 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7709 char todo[PERL_UCHAR_MAX+1];
7711 PERL_ARGS_ASSERT_SV_RESET;
7716 if (!*s) { /* reset ?? searches */
7717 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7719 const U32 count = mg->mg_len / sizeof(PMOP**);
7720 PMOP **pmp = (PMOP**) mg->mg_ptr;
7721 PMOP *const *const end = pmp + count;
7725 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7727 (*pmp)->op_pmflags &= ~PMf_USED;
7735 /* reset variables */
7737 if (!HvARRAY(stash))
7740 Zero(todo, 256, char);
7743 I32 i = (unsigned char)*s;
7747 max = (unsigned char)*s++;
7748 for ( ; i <= max; i++) {
7751 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7753 for (entry = HvARRAY(stash)[i];
7755 entry = HeNEXT(entry))
7760 if (!todo[(U8)*HeKEY(entry)])
7762 gv = (GV*)HeVAL(entry);
7765 if (SvTHINKFIRST(sv)) {
7766 if (!SvREADONLY(sv) && SvROK(sv))
7768 /* XXX Is this continue a bug? Why should THINKFIRST
7769 exempt us from resetting arrays and hashes? */
7773 if (SvTYPE(sv) >= SVt_PV) {
7775 if (SvPVX_const(sv) != NULL)
7783 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7785 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7788 # if defined(USE_ENVIRON_ARRAY)
7791 # endif /* USE_ENVIRON_ARRAY */
7802 Using various gambits, try to get an IO from an SV: the IO slot if its a
7803 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7804 named after the PV if we're a string.
7810 Perl_sv_2io(pTHX_ SV *const sv)
7815 PERL_ARGS_ASSERT_SV_2IO;
7817 switch (SvTYPE(sv)) {
7825 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7829 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7831 return sv_2io(SvRV(sv));
7832 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7838 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7847 Using various gambits, try to get a CV from an SV; in addition, try if
7848 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7849 The flags in C<lref> are passed to sv_fetchsv.
7855 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7861 PERL_ARGS_ASSERT_SV_2CV;
7868 switch (SvTYPE(sv)) {
7886 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7888 tryAMAGICunDEREF(to_cv);
7891 if (SvTYPE(sv) == SVt_PVCV) {
7900 Perl_croak(aTHX_ "Not a subroutine reference");
7902 else if (isGV(sv)) {
7907 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7913 /* Some flags to gv_fetchsv mean don't really create the GV */
7914 if (SvTYPE(gv) != SVt_PVGV) {
7920 if (lref && !GvCVu(gv)) {
7924 gv_efullname3(tmpsv, gv, NULL);
7925 /* XXX this is probably not what they think they're getting.
7926 * It has the same effect as "sub name;", i.e. just a forward
7928 newSUB(start_subparse(FALSE, 0),
7929 newSVOP(OP_CONST, 0, tmpsv),
7933 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7934 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7943 Returns true if the SV has a true value by Perl's rules.
7944 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7945 instead use an in-line version.
7951 Perl_sv_true(pTHX_ register SV *const sv)
7956 register const XPV* const tXpv = (XPV*)SvANY(sv);
7958 (tXpv->xpv_cur > 1 ||
7959 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7966 return SvIVX(sv) != 0;
7969 return SvNVX(sv) != 0.0;
7971 return sv_2bool(sv);
7977 =for apidoc sv_pvn_force
7979 Get a sensible string out of the SV somehow.
7980 A private implementation of the C<SvPV_force> macro for compilers which
7981 can't cope with complex macro expressions. Always use the macro instead.
7983 =for apidoc sv_pvn_force_flags
7985 Get a sensible string out of the SV somehow.
7986 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7987 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7988 implemented in terms of this function.
7989 You normally want to use the various wrapper macros instead: see
7990 C<SvPV_force> and C<SvPV_force_nomg>
7996 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8000 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8002 if (SvTHINKFIRST(sv) && !SvROK(sv))
8003 sv_force_normal_flags(sv, 0);
8013 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8014 const char * const ref = sv_reftype(sv,0);
8016 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8017 ref, OP_NAME(PL_op));
8019 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8021 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8022 || isGV_with_GP(sv))
8023 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8025 s = sv_2pv_flags(sv, &len, flags);
8029 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8032 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8033 SvGROW(sv, len + 1);
8034 Move(s,SvPVX(sv),len,char);
8036 SvPVX(sv)[len] = '\0';
8039 SvPOK_on(sv); /* validate pointer */
8041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8042 PTR2UV(sv),SvPVX_const(sv)));
8045 return SvPVX_mutable(sv);
8049 =for apidoc sv_pvbyten_force
8051 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8057 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8059 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8061 sv_pvn_force(sv,lp);
8062 sv_utf8_downgrade(sv,0);
8068 =for apidoc sv_pvutf8n_force
8070 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8076 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8078 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8080 sv_pvn_force(sv,lp);
8081 sv_utf8_upgrade(sv);
8087 =for apidoc sv_reftype
8089 Returns a string describing what the SV is a reference to.
8095 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8097 PERL_ARGS_ASSERT_SV_REFTYPE;
8099 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8100 inside return suggests a const propagation bug in g++. */
8101 if (ob && SvOBJECT(sv)) {
8102 char * const name = HvNAME_get(SvSTASH(sv));
8103 return name ? name : (char *) "__ANON__";
8106 switch (SvTYPE(sv)) {
8121 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8122 /* tied lvalues should appear to be
8123 * scalars for backwards compatitbility */
8124 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8125 ? "SCALAR" : "LVALUE");
8126 case SVt_PVAV: return "ARRAY";
8127 case SVt_PVHV: return "HASH";
8128 case SVt_PVCV: return "CODE";
8129 case SVt_PVGV: return "GLOB";
8130 case SVt_PVFM: return "FORMAT";
8131 case SVt_PVIO: return "IO";
8132 case SVt_BIND: return "BIND";
8133 case SVt_REGEXP: return "REGEXP";
8134 default: return "UNKNOWN";
8140 =for apidoc sv_isobject
8142 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8143 object. If the SV is not an RV, or if the object is not blessed, then this
8150 Perl_sv_isobject(pTHX_ SV *sv)
8166 Returns a boolean indicating whether the SV is blessed into the specified
8167 class. This does not check for subtypes; use C<sv_derived_from> to verify
8168 an inheritance relationship.
8174 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8178 PERL_ARGS_ASSERT_SV_ISA;
8188 hvname = HvNAME_get(SvSTASH(sv));
8192 return strEQ(hvname, name);
8198 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8199 it will be upgraded to one. If C<classname> is non-null then the new SV will
8200 be blessed in the specified package. The new SV is returned and its
8201 reference count is 1.
8207 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8212 PERL_ARGS_ASSERT_NEWSVRV;
8216 SV_CHECK_THINKFIRST_COW_DROP(rv);
8217 (void)SvAMAGIC_off(rv);
8219 if (SvTYPE(rv) >= SVt_PVMG) {
8220 const U32 refcnt = SvREFCNT(rv);
8224 SvREFCNT(rv) = refcnt;
8226 sv_upgrade(rv, SVt_IV);
8227 } else if (SvROK(rv)) {
8228 SvREFCNT_dec(SvRV(rv));
8230 prepare_SV_for_RV(rv);
8238 HV* const stash = gv_stashpv(classname, GV_ADD);
8239 (void)sv_bless(rv, stash);
8245 =for apidoc sv_setref_pv
8247 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8248 argument will be upgraded to an RV. That RV will be modified to point to
8249 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8250 into the SV. The C<classname> argument indicates the package for the
8251 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8252 will have a reference count of 1, and the RV will be returned.
8254 Do not use with other Perl types such as HV, AV, SV, CV, because those
8255 objects will become corrupted by the pointer copy process.
8257 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8263 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8267 PERL_ARGS_ASSERT_SV_SETREF_PV;
8270 sv_setsv(rv, &PL_sv_undef);
8274 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8279 =for apidoc sv_setref_iv
8281 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8282 argument will be upgraded to an RV. That RV will be modified to point to
8283 the new SV. The C<classname> argument indicates the package for the
8284 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8285 will have a reference count of 1, and the RV will be returned.
8291 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8293 PERL_ARGS_ASSERT_SV_SETREF_IV;
8295 sv_setiv(newSVrv(rv,classname), iv);
8300 =for apidoc sv_setref_uv
8302 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8303 argument will be upgraded to an RV. That RV will be modified to point to
8304 the new SV. The C<classname> argument indicates the package for the
8305 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8306 will have a reference count of 1, and the RV will be returned.
8312 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8314 PERL_ARGS_ASSERT_SV_SETREF_UV;
8316 sv_setuv(newSVrv(rv,classname), uv);
8321 =for apidoc sv_setref_nv
8323 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8324 argument will be upgraded to an RV. That RV will be modified to point to
8325 the new SV. The C<classname> argument indicates the package for the
8326 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8327 will have a reference count of 1, and the RV will be returned.
8333 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8335 PERL_ARGS_ASSERT_SV_SETREF_NV;
8337 sv_setnv(newSVrv(rv,classname), nv);
8342 =for apidoc sv_setref_pvn
8344 Copies a string into a new SV, optionally blessing the SV. The length of the
8345 string must be specified with C<n>. The C<rv> argument will be upgraded to
8346 an RV. That RV will be modified to point to the new SV. The C<classname>
8347 argument indicates the package for the blessing. Set C<classname> to
8348 C<NULL> to avoid the blessing. The new SV will have a reference count
8349 of 1, and the RV will be returned.
8351 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8357 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8358 const char *const pv, const STRLEN n)
8360 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8362 sv_setpvn(newSVrv(rv,classname), pv, n);
8367 =for apidoc sv_bless
8369 Blesses an SV into a specified package. The SV must be an RV. The package
8370 must be designated by its stash (see C<gv_stashpv()>). The reference count
8371 of the SV is unaffected.
8377 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8382 PERL_ARGS_ASSERT_SV_BLESS;
8385 Perl_croak(aTHX_ "Can't bless non-reference value");
8387 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8388 if (SvIsCOW(tmpRef))
8389 sv_force_normal_flags(tmpRef, 0);
8390 if (SvREADONLY(tmpRef))
8391 Perl_croak(aTHX_ PL_no_modify);
8392 if (SvOBJECT(tmpRef)) {
8393 if (SvTYPE(tmpRef) != SVt_PVIO)
8395 SvREFCNT_dec(SvSTASH(tmpRef));
8398 SvOBJECT_on(tmpRef);
8399 if (SvTYPE(tmpRef) != SVt_PVIO)
8401 SvUPGRADE(tmpRef, SVt_PVMG);
8402 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8407 (void)SvAMAGIC_off(sv);
8409 if(SvSMAGICAL(tmpRef))
8410 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8418 /* Downgrades a PVGV to a PVMG.
8422 S_sv_unglob(pTHX_ SV *const sv)
8427 SV * const temp = sv_newmortal();
8429 PERL_ARGS_ASSERT_SV_UNGLOB;
8431 assert(SvTYPE(sv) == SVt_PVGV);
8433 gv_efullname3(temp, (GV *) sv, "*");
8436 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8437 mro_method_changed_in(stash);
8441 sv_del_backref((SV*)GvSTASH(sv), sv);
8445 if (GvNAME_HEK(sv)) {
8446 unshare_hek(GvNAME_HEK(sv));
8448 isGV_with_GP_off(sv);
8450 /* need to keep SvANY(sv) in the right arena */
8451 xpvmg = new_XPVMG();
8452 StructCopy(SvANY(sv), xpvmg, XPVMG);
8453 del_XPVGV(SvANY(sv));
8456 SvFLAGS(sv) &= ~SVTYPEMASK;
8457 SvFLAGS(sv) |= SVt_PVMG;
8459 /* Intentionally not calling any local SET magic, as this isn't so much a
8460 set operation as merely an internal storage change. */
8461 sv_setsv_flags(sv, temp, 0);
8465 =for apidoc sv_unref_flags
8467 Unsets the RV status of the SV, and decrements the reference count of
8468 whatever was being referenced by the RV. This can almost be thought of
8469 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8470 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8471 (otherwise the decrementing is conditional on the reference count being
8472 different from one or the reference being a readonly SV).
8479 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8481 SV* const target = SvRV(ref);
8483 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8485 if (SvWEAKREF(ref)) {
8486 sv_del_backref(target, ref);
8488 SvRV_set(ref, NULL);
8491 SvRV_set(ref, NULL);
8493 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8494 assigned to as BEGIN {$a = \"Foo"} will fail. */
8495 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8496 SvREFCNT_dec(target);
8497 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8498 sv_2mortal(target); /* Schedule for freeing later */
8502 =for apidoc sv_untaint
8504 Untaint an SV. Use C<SvTAINTED_off> instead.
8509 Perl_sv_untaint(pTHX_ SV *const sv)
8511 PERL_ARGS_ASSERT_SV_UNTAINT;
8513 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8514 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8521 =for apidoc sv_tainted
8523 Test an SV for taintedness. Use C<SvTAINTED> instead.
8528 Perl_sv_tainted(pTHX_ SV *const sv)
8530 PERL_ARGS_ASSERT_SV_TAINTED;
8532 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8533 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8534 if (mg && (mg->mg_len & 1) )
8541 =for apidoc sv_setpviv
8543 Copies an integer into the given SV, also updating its string value.
8544 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8550 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8552 char buf[TYPE_CHARS(UV)];
8554 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8556 PERL_ARGS_ASSERT_SV_SETPVIV;
8558 sv_setpvn(sv, ptr, ebuf - ptr);
8562 =for apidoc sv_setpviv_mg
8564 Like C<sv_setpviv>, but also handles 'set' magic.
8570 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8572 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8578 #if defined(PERL_IMPLICIT_CONTEXT)
8580 /* pTHX_ magic can't cope with varargs, so this is a no-context
8581 * version of the main function, (which may itself be aliased to us).
8582 * Don't access this version directly.
8586 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8591 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8593 va_start(args, pat);
8594 sv_vsetpvf(sv, pat, &args);
8598 /* pTHX_ magic can't cope with varargs, so this is a no-context
8599 * version of the main function, (which may itself be aliased to us).
8600 * Don't access this version directly.
8604 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8609 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8611 va_start(args, pat);
8612 sv_vsetpvf_mg(sv, pat, &args);
8618 =for apidoc sv_setpvf
8620 Works like C<sv_catpvf> but copies the text into the SV instead of
8621 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8627 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8631 PERL_ARGS_ASSERT_SV_SETPVF;
8633 va_start(args, pat);
8634 sv_vsetpvf(sv, pat, &args);
8639 =for apidoc sv_vsetpvf
8641 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8642 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8644 Usually used via its frontend C<sv_setpvf>.
8650 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8652 PERL_ARGS_ASSERT_SV_VSETPVF;
8654 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8658 =for apidoc sv_setpvf_mg
8660 Like C<sv_setpvf>, but also handles 'set' magic.
8666 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8670 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8672 va_start(args, pat);
8673 sv_vsetpvf_mg(sv, pat, &args);
8678 =for apidoc sv_vsetpvf_mg
8680 Like C<sv_vsetpvf>, but also handles 'set' magic.
8682 Usually used via its frontend C<sv_setpvf_mg>.
8688 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8690 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8692 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8696 #if defined(PERL_IMPLICIT_CONTEXT)
8698 /* pTHX_ magic can't cope with varargs, so this is a no-context
8699 * version of the main function, (which may itself be aliased to us).
8700 * Don't access this version directly.
8704 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8709 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8711 va_start(args, pat);
8712 sv_vcatpvf(sv, pat, &args);
8716 /* pTHX_ magic can't cope with varargs, so this is a no-context
8717 * version of the main function, (which may itself be aliased to us).
8718 * Don't access this version directly.
8722 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8727 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8729 va_start(args, pat);
8730 sv_vcatpvf_mg(sv, pat, &args);
8736 =for apidoc sv_catpvf
8738 Processes its arguments like C<sprintf> and appends the formatted
8739 output to an SV. If the appended data contains "wide" characters
8740 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8741 and characters >255 formatted with %c), the original SV might get
8742 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8743 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8744 valid UTF-8; if the original SV was bytes, the pattern should be too.
8749 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8753 PERL_ARGS_ASSERT_SV_CATPVF;
8755 va_start(args, pat);
8756 sv_vcatpvf(sv, pat, &args);
8761 =for apidoc sv_vcatpvf
8763 Processes its arguments like C<vsprintf> and appends the formatted output
8764 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8766 Usually used via its frontend C<sv_catpvf>.
8772 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8774 PERL_ARGS_ASSERT_SV_VCATPVF;
8776 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8780 =for apidoc sv_catpvf_mg
8782 Like C<sv_catpvf>, but also handles 'set' magic.
8788 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8792 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8794 va_start(args, pat);
8795 sv_vcatpvf_mg(sv, pat, &args);
8800 =for apidoc sv_vcatpvf_mg
8802 Like C<sv_vcatpvf>, but also handles 'set' magic.
8804 Usually used via its frontend C<sv_catpvf_mg>.
8810 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8812 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8814 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8819 =for apidoc sv_vsetpvfn
8821 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8824 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8830 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8831 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8833 PERL_ARGS_ASSERT_SV_VSETPVFN;
8835 sv_setpvn(sv, "", 0);
8836 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8840 S_expect_number(pTHX_ char **const pattern)
8845 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8847 switch (**pattern) {
8848 case '1': case '2': case '3':
8849 case '4': case '5': case '6':
8850 case '7': case '8': case '9':
8851 var = *(*pattern)++ - '0';
8852 while (isDIGIT(**pattern)) {
8853 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8855 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8863 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8865 const int neg = nv < 0;
8868 PERL_ARGS_ASSERT_F0CONVERT;
8876 if (uv & 1 && uv == nv)
8877 uv--; /* Round to even */
8879 const unsigned dig = uv % 10;
8892 =for apidoc sv_vcatpvfn
8894 Processes its arguments like C<vsprintf> and appends the formatted output
8895 to an SV. Uses an array of SVs if the C style variable argument list is
8896 missing (NULL). When running with taint checks enabled, indicates via
8897 C<maybe_tainted> if results are untrustworthy (often due to the use of
8900 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8906 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8907 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8908 vec_utf8 = DO_UTF8(vecsv);
8910 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8913 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8914 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8922 static const char nullstr[] = "(null)";
8924 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8925 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8927 /* Times 4: a decimal digit takes more than 3 binary digits.
8928 * NV_DIG: mantissa takes than many decimal digits.
8929 * Plus 32: Playing safe. */
8930 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8931 /* large enough for "%#.#f" --chip */
8932 /* what about long double NVs? --jhi */
8934 PERL_ARGS_ASSERT_SV_VCATPVFN;
8935 PERL_UNUSED_ARG(maybe_tainted);
8937 /* no matter what, this is a string now */
8938 (void)SvPV_force(sv, origlen);
8940 /* special-case "", "%s", and "%-p" (SVf - see below) */
8943 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8945 const char * const s = va_arg(*args, char*);
8946 sv_catpv(sv, s ? s : nullstr);
8948 else if (svix < svmax) {
8949 sv_catsv(sv, *svargs);
8953 if (args && patlen == 3 && pat[0] == '%' &&
8954 pat[1] == '-' && pat[2] == 'p') {
8955 argsv = (SV*)va_arg(*args, void*);
8956 sv_catsv(sv, argsv);
8960 #ifndef USE_LONG_DOUBLE
8961 /* special-case "%.<number>[gf]" */
8962 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8963 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8964 unsigned digits = 0;
8968 while (*pp >= '0' && *pp <= '9')
8969 digits = 10 * digits + (*pp++ - '0');
8970 if (pp - pat == (int)patlen - 1) {
8978 /* Add check for digits != 0 because it seems that some
8979 gconverts are buggy in this case, and we don't yet have
8980 a Configure test for this. */
8981 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8982 /* 0, point, slack */
8983 Gconvert(nv, (int)digits, 0, ebuf);
8985 if (*ebuf) /* May return an empty string for digits==0 */
8988 } else if (!digits) {
8991 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8992 sv_catpvn(sv, p, l);
8998 #endif /* !USE_LONG_DOUBLE */
9000 if (!args && svix < svmax && DO_UTF8(*svargs))
9003 patend = (char*)pat + patlen;
9004 for (p = (char*)pat; p < patend; p = q) {
9007 bool vectorize = FALSE;
9008 bool vectorarg = FALSE;
9009 bool vec_utf8 = FALSE;
9015 bool has_precis = FALSE;
9017 const I32 osvix = svix;
9018 bool is_utf8 = FALSE; /* is this item utf8? */
9019 #ifdef HAS_LDBL_SPRINTF_BUG
9020 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9021 with sfio - Allen <allens@cpan.org> */
9022 bool fix_ldbl_sprintf_bug = FALSE;
9026 U8 utf8buf[UTF8_MAXBYTES+1];
9027 STRLEN esignlen = 0;
9029 const char *eptr = NULL;
9032 const U8 *vecstr = NULL;
9039 /* we need a long double target in case HAS_LONG_DOUBLE but
9042 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9050 const char *dotstr = ".";
9051 STRLEN dotstrlen = 1;
9052 I32 efix = 0; /* explicit format parameter index */
9053 I32 ewix = 0; /* explicit width index */
9054 I32 epix = 0; /* explicit precision index */
9055 I32 evix = 0; /* explicit vector index */
9056 bool asterisk = FALSE;
9058 /* echo everything up to the next format specification */
9059 for (q = p; q < patend && *q != '%'; ++q) ;
9061 if (has_utf8 && !pat_utf8)
9062 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9064 sv_catpvn(sv, p, q - p);
9071 We allow format specification elements in this order:
9072 \d+\$ explicit format parameter index
9074 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9075 0 flag (as above): repeated to allow "v02"
9076 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9077 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9079 [%bcdefginopsuxDFOUX] format (mandatory)
9084 As of perl5.9.3, printf format checking is on by default.
9085 Internally, perl uses %p formats to provide an escape to
9086 some extended formatting. This block deals with those
9087 extensions: if it does not match, (char*)q is reset and
9088 the normal format processing code is used.
9090 Currently defined extensions are:
9091 %p include pointer address (standard)
9092 %-p (SVf) include an SV (previously %_)
9093 %-<num>p include an SV with precision <num>
9094 %<num>p reserved for future extensions
9096 Robin Barker 2005-07-14
9098 %1p (VDf) removed. RMB 2007-10-19
9105 n = expect_number(&q);
9112 argsv = (SV*)va_arg(*args, void*);
9113 eptr = SvPV_const(argsv, elen);
9119 if (ckWARN_d(WARN_INTERNAL))
9120 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9121 "internal %%<num>p might conflict with future printf extensions");
9127 if ( (width = expect_number(&q)) ) {
9142 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9171 if ( (ewix = expect_number(&q)) )
9180 if ((vectorarg = asterisk)) {
9193 width = expect_number(&q);
9199 vecsv = va_arg(*args, SV*);
9201 vecsv = (evix > 0 && evix <= svmax)
9202 ? svargs[evix-1] : &PL_sv_undef;
9204 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9206 dotstr = SvPV_const(vecsv, dotstrlen);
9207 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9208 bad with tied or overloaded values that return UTF8. */
9211 else if (has_utf8) {
9212 vecsv = sv_mortalcopy(vecsv);
9213 sv_utf8_upgrade(vecsv);
9214 dotstr = SvPV_const(vecsv, dotstrlen);
9221 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9222 vecsv = svargs[efix ? efix-1 : svix++];
9223 vecstr = (U8*)SvPV_const(vecsv,veclen);
9224 vec_utf8 = DO_UTF8(vecsv);
9226 /* if this is a version object, we need to convert
9227 * back into v-string notation and then let the
9228 * vectorize happen normally
9230 if (sv_derived_from(vecsv, "version")) {
9231 char *version = savesvpv(vecsv);
9232 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9233 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9234 "vector argument not supported with alpha versions");
9237 vecsv = sv_newmortal();
9238 scan_vstring(version, version + veclen, vecsv);
9239 vecstr = (U8*)SvPV_const(vecsv, veclen);
9240 vec_utf8 = DO_UTF8(vecsv);
9252 i = va_arg(*args, int);
9254 i = (ewix ? ewix <= svmax : svix < svmax) ?
9255 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9257 width = (i < 0) ? -i : i;
9267 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9269 /* XXX: todo, support specified precision parameter */
9273 i = va_arg(*args, int);
9275 i = (ewix ? ewix <= svmax : svix < svmax)
9276 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9278 has_precis = !(i < 0);
9283 precis = precis * 10 + (*q++ - '0');
9292 case 'I': /* Ix, I32x, and I64x */
9294 if (q[1] == '6' && q[2] == '4') {
9300 if (q[1] == '3' && q[2] == '2') {
9310 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9321 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9322 if (*(q + 1) == 'l') { /* lld, llf */
9348 if (!vectorize && !args) {
9350 const I32 i = efix-1;
9351 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9353 argsv = (svix >= 0 && svix < svmax)
9354 ? svargs[svix++] : &PL_sv_undef;
9365 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9367 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9369 eptr = (char*)utf8buf;
9370 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9384 eptr = va_arg(*args, char*);
9386 #ifdef MACOS_TRADITIONAL
9387 /* On MacOS, %#s format is used for Pascal strings */
9392 elen = strlen(eptr);
9394 eptr = (char *)nullstr;
9395 elen = sizeof nullstr - 1;
9399 eptr = SvPV_const(argsv, elen);
9400 if (DO_UTF8(argsv)) {
9401 I32 old_precis = precis;
9402 if (has_precis && precis < elen) {
9404 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9407 if (width) { /* fudge width (can't fudge elen) */
9408 if (has_precis && precis < elen)
9409 width += precis - old_precis;
9411 width += elen - sv_len_utf8(argsv);
9418 if (has_precis && elen > precis)
9425 if (alt || vectorize)
9427 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9448 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9457 esignbuf[esignlen++] = plus;
9461 case 'h': iv = (short)va_arg(*args, int); break;
9462 case 'l': iv = va_arg(*args, long); break;
9463 case 'V': iv = va_arg(*args, IV); break;
9464 default: iv = va_arg(*args, int); break;
9466 case 'q': iv = va_arg(*args, Quad_t); break;
9471 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9473 case 'h': iv = (short)tiv; break;
9474 case 'l': iv = (long)tiv; break;
9476 default: iv = tiv; break;
9478 case 'q': iv = (Quad_t)tiv; break;
9482 if ( !vectorize ) /* we already set uv above */
9487 esignbuf[esignlen++] = plus;
9491 esignbuf[esignlen++] = '-';
9535 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9546 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9547 case 'l': uv = va_arg(*args, unsigned long); break;
9548 case 'V': uv = va_arg(*args, UV); break;
9549 default: uv = va_arg(*args, unsigned); break;
9551 case 'q': uv = va_arg(*args, Uquad_t); break;
9556 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9558 case 'h': uv = (unsigned short)tuv; break;
9559 case 'l': uv = (unsigned long)tuv; break;
9561 default: uv = tuv; break;
9563 case 'q': uv = (Uquad_t)tuv; break;
9570 char *ptr = ebuf + sizeof ebuf;
9571 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9577 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9583 esignbuf[esignlen++] = '0';
9584 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9592 if (alt && *ptr != '0')
9601 esignbuf[esignlen++] = '0';
9602 esignbuf[esignlen++] = c;
9605 default: /* it had better be ten or less */
9609 } while (uv /= base);
9612 elen = (ebuf + sizeof ebuf) - ptr;
9616 zeros = precis - elen;
9617 else if (precis == 0 && elen == 1 && *eptr == '0'
9618 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9621 /* a precision nullifies the 0 flag. */
9628 /* FLOATING POINT */
9631 c = 'f'; /* maybe %F isn't supported here */
9639 /* This is evil, but floating point is even more evil */
9641 /* for SV-style calling, we can only get NV
9642 for C-style calling, we assume %f is double;
9643 for simplicity we allow any of %Lf, %llf, %qf for long double
9647 #if defined(USE_LONG_DOUBLE)
9651 /* [perl #20339] - we should accept and ignore %lf rather than die */
9655 #if defined(USE_LONG_DOUBLE)
9656 intsize = args ? 0 : 'q';
9660 #if defined(HAS_LONG_DOUBLE)
9669 /* now we need (long double) if intsize == 'q', else (double) */
9671 #if LONG_DOUBLESIZE > DOUBLESIZE
9673 va_arg(*args, long double) :
9674 va_arg(*args, double)
9676 va_arg(*args, double)
9681 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9682 else. frexp() has some unspecified behaviour for those three */
9683 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9685 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9686 will cast our (long double) to (double) */
9687 (void)Perl_frexp(nv, &i);
9688 if (i == PERL_INT_MIN)
9689 Perl_die(aTHX_ "panic: frexp");
9691 need = BIT_DIGITS(i);
9693 need += has_precis ? precis : 6; /* known default */
9698 #ifdef HAS_LDBL_SPRINTF_BUG
9699 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9700 with sfio - Allen <allens@cpan.org> */
9703 # define MY_DBL_MAX DBL_MAX
9704 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9705 # if DOUBLESIZE >= 8
9706 # define MY_DBL_MAX 1.7976931348623157E+308L
9708 # define MY_DBL_MAX 3.40282347E+38L
9712 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9713 # define MY_DBL_MAX_BUG 1L
9715 # define MY_DBL_MAX_BUG MY_DBL_MAX
9719 # define MY_DBL_MIN DBL_MIN
9720 # else /* XXX guessing! -Allen */
9721 # if DOUBLESIZE >= 8
9722 # define MY_DBL_MIN 2.2250738585072014E-308L
9724 # define MY_DBL_MIN 1.17549435E-38L
9728 if ((intsize == 'q') && (c == 'f') &&
9729 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9731 /* it's going to be short enough that
9732 * long double precision is not needed */
9734 if ((nv <= 0L) && (nv >= -0L))
9735 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9737 /* would use Perl_fp_class as a double-check but not
9738 * functional on IRIX - see perl.h comments */
9740 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9741 /* It's within the range that a double can represent */
9742 #if defined(DBL_MAX) && !defined(DBL_MIN)
9743 if ((nv >= ((long double)1/DBL_MAX)) ||
9744 (nv <= (-(long double)1/DBL_MAX)))
9746 fix_ldbl_sprintf_bug = TRUE;
9749 if (fix_ldbl_sprintf_bug == TRUE) {
9759 # undef MY_DBL_MAX_BUG
9762 #endif /* HAS_LDBL_SPRINTF_BUG */
9764 need += 20; /* fudge factor */
9765 if (PL_efloatsize < need) {
9766 Safefree(PL_efloatbuf);
9767 PL_efloatsize = need + 20; /* more fudge */
9768 Newx(PL_efloatbuf, PL_efloatsize, char);
9769 PL_efloatbuf[0] = '\0';
9772 if ( !(width || left || plus || alt) && fill != '0'
9773 && has_precis && intsize != 'q' ) { /* Shortcuts */
9774 /* See earlier comment about buggy Gconvert when digits,
9776 if ( c == 'g' && precis) {
9777 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9778 /* May return an empty string for digits==0 */
9779 if (*PL_efloatbuf) {
9780 elen = strlen(PL_efloatbuf);
9781 goto float_converted;
9783 } else if ( c == 'f' && !precis) {
9784 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9789 char *ptr = ebuf + sizeof ebuf;
9792 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9793 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9794 if (intsize == 'q') {
9795 /* Copy the one or more characters in a long double
9796 * format before the 'base' ([efgEFG]) character to
9797 * the format string. */
9798 static char const prifldbl[] = PERL_PRIfldbl;
9799 char const *p = prifldbl + sizeof(prifldbl) - 3;
9800 while (p >= prifldbl) { *--ptr = *p--; }
9805 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9810 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9822 /* No taint. Otherwise we are in the strange situation
9823 * where printf() taints but print($float) doesn't.
9825 #if defined(HAS_LONG_DOUBLE)
9826 elen = ((intsize == 'q')
9827 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9828 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9830 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9834 eptr = PL_efloatbuf;
9842 i = SvCUR(sv) - origlen;
9845 case 'h': *(va_arg(*args, short*)) = i; break;
9846 default: *(va_arg(*args, int*)) = i; break;
9847 case 'l': *(va_arg(*args, long*)) = i; break;
9848 case 'V': *(va_arg(*args, IV*)) = i; break;
9850 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9855 sv_setuv_mg(argsv, (UV)i);
9856 continue; /* not "break" */
9863 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9864 && ckWARN(WARN_PRINTF))
9866 SV * const msg = sv_newmortal();
9867 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9868 (PL_op->op_type == OP_PRTF) ? "" : "s");
9871 Perl_sv_catpvf(aTHX_ msg,
9872 "\"%%%c\"", c & 0xFF);
9874 Perl_sv_catpvf(aTHX_ msg,
9875 "\"%%\\%03"UVof"\"",
9878 sv_catpvs(msg, "end of string");
9879 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9882 /* output mangled stuff ... */
9888 /* ... right here, because formatting flags should not apply */
9889 SvGROW(sv, SvCUR(sv) + elen + 1);
9891 Copy(eptr, p, elen, char);
9894 SvCUR_set(sv, p - SvPVX_const(sv));
9896 continue; /* not "break" */
9899 if (is_utf8 != has_utf8) {
9902 sv_utf8_upgrade(sv);
9905 const STRLEN old_elen = elen;
9906 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9907 sv_utf8_upgrade(nsv);
9908 eptr = SvPVX_const(nsv);
9911 if (width) { /* fudge width (can't fudge elen) */
9912 width += elen - old_elen;
9918 have = esignlen + zeros + elen;
9920 Perl_croak_nocontext(PL_memory_wrap);
9922 need = (have > width ? have : width);
9925 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9926 Perl_croak_nocontext(PL_memory_wrap);
9927 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9929 if (esignlen && fill == '0') {
9931 for (i = 0; i < (int)esignlen; i++)
9935 memset(p, fill, gap);
9938 if (esignlen && fill != '0') {
9940 for (i = 0; i < (int)esignlen; i++)
9945 for (i = zeros; i; i--)
9949 Copy(eptr, p, elen, char);
9953 memset(p, ' ', gap);
9958 Copy(dotstr, p, dotstrlen, char);
9962 vectorize = FALSE; /* done iterating over vecstr */
9969 SvCUR_set(sv, p - SvPVX_const(sv));
9977 /* =========================================================================
9979 =head1 Cloning an interpreter
9981 All the macros and functions in this section are for the private use of
9982 the main function, perl_clone().
9984 The foo_dup() functions make an exact copy of an existing foo thingy.
9985 During the course of a cloning, a hash table is used to map old addresses
9986 to new addresses. The table is created and manipulated with the
9987 ptr_table_* functions.
9991 ============================================================================*/
9994 #if defined(USE_ITHREADS)
9996 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9997 #ifndef GpREFCNT_inc
9998 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10002 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10003 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10004 If this changes, please unmerge ss_dup. */
10005 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10006 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10007 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10008 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10009 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10010 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10011 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10012 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10013 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10014 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10015 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10016 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10017 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10018 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10020 /* clone a parser */
10023 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10027 PERL_ARGS_ASSERT_PARSER_DUP;
10032 /* look for it in the table first */
10033 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10037 /* create anew and remember what it is */
10038 Newxz(parser, 1, yy_parser);
10039 ptr_table_store(PL_ptr_table, proto, parser);
10041 parser->yyerrstatus = 0;
10042 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10044 /* XXX these not yet duped */
10045 parser->old_parser = NULL;
10046 parser->stack = NULL;
10048 parser->stack_size = 0;
10049 /* XXX parser->stack->state = 0; */
10051 /* XXX eventually, just Copy() most of the parser struct ? */
10053 parser->lex_brackets = proto->lex_brackets;
10054 parser->lex_casemods = proto->lex_casemods;
10055 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10056 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10057 parser->lex_casestack = savepvn(proto->lex_casestack,
10058 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10059 parser->lex_defer = proto->lex_defer;
10060 parser->lex_dojoin = proto->lex_dojoin;
10061 parser->lex_expect = proto->lex_expect;
10062 parser->lex_formbrack = proto->lex_formbrack;
10063 parser->lex_inpat = proto->lex_inpat;
10064 parser->lex_inwhat = proto->lex_inwhat;
10065 parser->lex_op = proto->lex_op;
10066 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10067 parser->lex_starts = proto->lex_starts;
10068 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10069 parser->multi_close = proto->multi_close;
10070 parser->multi_open = proto->multi_open;
10071 parser->multi_start = proto->multi_start;
10072 parser->multi_end = proto->multi_end;
10073 parser->pending_ident = proto->pending_ident;
10074 parser->preambled = proto->preambled;
10075 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10076 parser->linestr = sv_dup_inc(proto->linestr, param);
10077 parser->expect = proto->expect;
10078 parser->copline = proto->copline;
10079 parser->last_lop_op = proto->last_lop_op;
10080 parser->lex_state = proto->lex_state;
10081 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10082 /* rsfp_filters entries have fake IoDIRP() */
10083 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10084 parser->in_my = proto->in_my;
10085 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10086 parser->error_count = proto->error_count;
10089 parser->linestr = sv_dup_inc(proto->linestr, param);
10092 char * const ols = SvPVX(proto->linestr);
10093 char * const ls = SvPVX(parser->linestr);
10095 parser->bufptr = ls + (proto->bufptr >= ols ?
10096 proto->bufptr - ols : 0);
10097 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10098 proto->oldbufptr - ols : 0);
10099 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10100 proto->oldoldbufptr - ols : 0);
10101 parser->linestart = ls + (proto->linestart >= ols ?
10102 proto->linestart - ols : 0);
10103 parser->last_uni = ls + (proto->last_uni >= ols ?
10104 proto->last_uni - ols : 0);
10105 parser->last_lop = ls + (proto->last_lop >= ols ?
10106 proto->last_lop - ols : 0);
10108 parser->bufend = ls + SvCUR(parser->linestr);
10111 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10115 parser->endwhite = proto->endwhite;
10116 parser->faketokens = proto->faketokens;
10117 parser->lasttoke = proto->lasttoke;
10118 parser->nextwhite = proto->nextwhite;
10119 parser->realtokenstart = proto->realtokenstart;
10120 parser->skipwhite = proto->skipwhite;
10121 parser->thisclose = proto->thisclose;
10122 parser->thismad = proto->thismad;
10123 parser->thisopen = proto->thisopen;
10124 parser->thisstuff = proto->thisstuff;
10125 parser->thistoken = proto->thistoken;
10126 parser->thiswhite = proto->thiswhite;
10128 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10129 parser->curforce = proto->curforce;
10131 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10132 Copy(proto->nexttype, parser->nexttype, 5, I32);
10133 parser->nexttoke = proto->nexttoke;
10139 /* duplicate a file handle */
10142 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10146 PERL_ARGS_ASSERT_FP_DUP;
10147 PERL_UNUSED_ARG(type);
10150 return (PerlIO*)NULL;
10152 /* look for it in the table first */
10153 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10157 /* create anew and remember what it is */
10158 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10159 ptr_table_store(PL_ptr_table, fp, ret);
10163 /* duplicate a directory handle */
10166 Perl_dirp_dup(pTHX_ DIR *const dp)
10168 PERL_UNUSED_CONTEXT;
10175 /* duplicate a typeglob */
10178 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10182 PERL_ARGS_ASSERT_GP_DUP;
10186 /* look for it in the table first */
10187 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10191 /* create anew and remember what it is */
10193 ptr_table_store(PL_ptr_table, gp, ret);
10196 ret->gp_refcnt = 0; /* must be before any other dups! */
10197 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10198 ret->gp_io = io_dup_inc(gp->gp_io, param);
10199 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10200 ret->gp_av = av_dup_inc(gp->gp_av, param);
10201 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10202 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10203 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10204 ret->gp_cvgen = gp->gp_cvgen;
10205 ret->gp_line = gp->gp_line;
10206 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10210 /* duplicate a chain of magic */
10213 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10215 MAGIC *mgprev = (MAGIC*)NULL;
10218 PERL_ARGS_ASSERT_MG_DUP;
10221 return (MAGIC*)NULL;
10222 /* look for it in the table first */
10223 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10227 for (; mg; mg = mg->mg_moremagic) {
10229 Newxz(nmg, 1, MAGIC);
10231 mgprev->mg_moremagic = nmg;
10234 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10235 nmg->mg_private = mg->mg_private;
10236 nmg->mg_type = mg->mg_type;
10237 nmg->mg_flags = mg->mg_flags;
10238 /* FIXME for plugins
10239 if (mg->mg_type == PERL_MAGIC_qr) {
10240 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10244 if(mg->mg_type == PERL_MAGIC_backref) {
10245 /* The backref AV has its reference count deliberately bumped by
10247 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10250 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10251 ? sv_dup_inc(mg->mg_obj, param)
10252 : sv_dup(mg->mg_obj, param);
10254 nmg->mg_len = mg->mg_len;
10255 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10256 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10257 if (mg->mg_len > 0) {
10258 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10259 if (mg->mg_type == PERL_MAGIC_overload_table &&
10260 AMT_AMAGIC((AMT*)mg->mg_ptr))
10262 const AMT * const amtp = (AMT*)mg->mg_ptr;
10263 AMT * const namtp = (AMT*)nmg->mg_ptr;
10265 for (i = 1; i < NofAMmeth; i++) {
10266 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10270 else if (mg->mg_len == HEf_SVKEY)
10271 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10273 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10274 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10281 #endif /* USE_ITHREADS */
10283 /* create a new pointer-mapping table */
10286 Perl_ptr_table_new(pTHX)
10289 PERL_UNUSED_CONTEXT;
10291 Newxz(tbl, 1, PTR_TBL_t);
10292 tbl->tbl_max = 511;
10293 tbl->tbl_items = 0;
10294 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10298 #define PTR_TABLE_HASH(ptr) \
10299 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10302 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10303 following define) and at call to new_body_inline made below in
10304 Perl_ptr_table_store()
10307 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10309 /* map an existing pointer using a table */
10311 STATIC PTR_TBL_ENT_t *
10312 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10314 PTR_TBL_ENT_t *tblent;
10315 const UV hash = PTR_TABLE_HASH(sv);
10317 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10319 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10320 for (; tblent; tblent = tblent->next) {
10321 if (tblent->oldval == sv)
10328 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10330 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10332 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10333 PERL_UNUSED_CONTEXT;
10335 return tblent ? tblent->newval : NULL;
10338 /* add a new entry to a pointer-mapping table */
10341 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10343 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10345 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10346 PERL_UNUSED_CONTEXT;
10349 tblent->newval = newsv;
10351 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10353 new_body_inline(tblent, PTE_SVSLOT);
10355 tblent->oldval = oldsv;
10356 tblent->newval = newsv;
10357 tblent->next = tbl->tbl_ary[entry];
10358 tbl->tbl_ary[entry] = tblent;
10360 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10361 ptr_table_split(tbl);
10365 /* double the hash bucket size of an existing ptr table */
10368 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10370 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10371 const UV oldsize = tbl->tbl_max + 1;
10372 UV newsize = oldsize * 2;
10375 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10376 PERL_UNUSED_CONTEXT;
10378 Renew(ary, newsize, PTR_TBL_ENT_t*);
10379 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10380 tbl->tbl_max = --newsize;
10381 tbl->tbl_ary = ary;
10382 for (i=0; i < oldsize; i++, ary++) {
10383 PTR_TBL_ENT_t **curentp, **entp, *ent;
10386 curentp = ary + oldsize;
10387 for (entp = ary, ent = *ary; ent; ent = *entp) {
10388 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10390 ent->next = *curentp;
10400 /* remove all the entries from a ptr table */
10403 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10405 if (tbl && tbl->tbl_items) {
10406 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10407 UV riter = tbl->tbl_max;
10410 PTR_TBL_ENT_t *entry = array[riter];
10413 PTR_TBL_ENT_t * const oentry = entry;
10414 entry = entry->next;
10419 tbl->tbl_items = 0;
10423 /* clear and free a ptr table */
10426 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10431 ptr_table_clear(tbl);
10432 Safefree(tbl->tbl_ary);
10436 #if defined(USE_ITHREADS)
10439 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10441 PERL_ARGS_ASSERT_RVPV_DUP;
10444 SvRV_set(dstr, SvWEAKREF(sstr)
10445 ? sv_dup(SvRV(sstr), param)
10446 : sv_dup_inc(SvRV(sstr), param));
10449 else if (SvPVX_const(sstr)) {
10450 /* Has something there */
10452 /* Normal PV - clone whole allocated space */
10453 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10454 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10455 /* Not that normal - actually sstr is copy on write.
10456 But we are a true, independant SV, so: */
10457 SvREADONLY_off(dstr);
10462 /* Special case - not normally malloced for some reason */
10463 if (isGV_with_GP(sstr)) {
10464 /* Don't need to do anything here. */
10466 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10467 /* A "shared" PV - clone it as "shared" PV */
10469 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10473 /* Some other special case - random pointer */
10474 SvPV_set(dstr, SvPVX(sstr));
10479 /* Copy the NULL */
10480 SvPV_set(dstr, NULL);
10484 /* duplicate an SV of any type (including AV, HV etc) */
10487 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10492 PERL_ARGS_ASSERT_SV_DUP;
10496 if (SvTYPE(sstr) == SVTYPEMASK) {
10497 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10502 /* look for it in the table first */
10503 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10507 if(param->flags & CLONEf_JOIN_IN) {
10508 /** We are joining here so we don't want do clone
10509 something that is bad **/
10510 if (SvTYPE(sstr) == SVt_PVHV) {
10511 const HEK * const hvname = HvNAME_HEK(sstr);
10513 /** don't clone stashes if they already exist **/
10514 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10518 /* create anew and remember what it is */
10521 #ifdef DEBUG_LEAKING_SCALARS
10522 dstr->sv_debug_optype = sstr->sv_debug_optype;
10523 dstr->sv_debug_line = sstr->sv_debug_line;
10524 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10525 dstr->sv_debug_cloned = 1;
10526 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10529 ptr_table_store(PL_ptr_table, sstr, dstr);
10532 SvFLAGS(dstr) = SvFLAGS(sstr);
10533 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10534 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10537 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10538 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10539 (void*)PL_watch_pvx, SvPVX_const(sstr));
10542 /* don't clone objects whose class has asked us not to */
10543 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10548 switch (SvTYPE(sstr)) {
10550 SvANY(dstr) = NULL;
10553 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10555 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10557 SvIV_set(dstr, SvIVX(sstr));
10561 SvANY(dstr) = new_XNV();
10562 SvNV_set(dstr, SvNVX(sstr));
10564 /* case SVt_BIND: */
10567 /* These are all the types that need complex bodies allocating. */
10569 const svtype sv_type = SvTYPE(sstr);
10570 const struct body_details *const sv_type_details
10571 = bodies_by_type + sv_type;
10575 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10579 if (GvUNIQUE((GV*)sstr)) {
10580 NOOP; /* Do sharing here, and fall through */
10593 assert(sv_type_details->body_size);
10594 if (sv_type_details->arena) {
10595 new_body_inline(new_body, sv_type);
10597 = (void*)((char*)new_body - sv_type_details->offset);
10599 new_body = new_NOARENA(sv_type_details);
10603 SvANY(dstr) = new_body;
10606 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10607 ((char*)SvANY(dstr)) + sv_type_details->offset,
10608 sv_type_details->copy, char);
10610 Copy(((char*)SvANY(sstr)),
10611 ((char*)SvANY(dstr)),
10612 sv_type_details->body_size + sv_type_details->offset, char);
10615 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10616 && !isGV_with_GP(dstr))
10617 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10619 /* The Copy above means that all the source (unduplicated) pointers
10620 are now in the destination. We can check the flags and the
10621 pointers in either, but it's possible that there's less cache
10622 missing by always going for the destination.
10623 FIXME - instrument and check that assumption */
10624 if (sv_type >= SVt_PVMG) {
10625 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10626 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10627 } else if (SvMAGIC(dstr))
10628 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10630 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10633 /* The cast silences a GCC warning about unhandled types. */
10634 switch ((int)sv_type) {
10644 /* FIXME for plugins */
10645 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10648 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10649 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10650 LvTARG(dstr) = dstr;
10651 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10652 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10654 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10656 if(isGV_with_GP(sstr)) {
10657 if (GvNAME_HEK(dstr))
10658 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10659 /* Don't call sv_add_backref here as it's going to be
10660 created as part of the magic cloning of the symbol
10662 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10663 at the point of this comment. */
10664 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10665 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10666 (void)GpREFCNT_inc(GvGP(dstr));
10668 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10671 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10672 if (IoOFP(dstr) == IoIFP(sstr))
10673 IoOFP(dstr) = IoIFP(dstr);
10675 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10676 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10677 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10678 /* I have no idea why fake dirp (rsfps)
10679 should be treated differently but otherwise
10680 we end up with leaks -- sky*/
10681 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10682 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10683 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10685 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10686 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10687 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10688 if (IoDIRP(dstr)) {
10689 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10692 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10695 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10696 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10697 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10700 if (AvARRAY((AV*)sstr)) {
10701 SV **dst_ary, **src_ary;
10702 SSize_t items = AvFILLp((AV*)sstr) + 1;
10704 src_ary = AvARRAY((AV*)sstr);
10705 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10706 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10707 AvARRAY((AV*)dstr) = dst_ary;
10708 AvALLOC((AV*)dstr) = dst_ary;
10709 if (AvREAL((AV*)sstr)) {
10710 while (items-- > 0)
10711 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10714 while (items-- > 0)
10715 *dst_ary++ = sv_dup(*src_ary++, param);
10717 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10718 while (items-- > 0) {
10719 *dst_ary++ = &PL_sv_undef;
10723 AvARRAY((AV*)dstr) = NULL;
10724 AvALLOC((AV*)dstr) = (SV**)NULL;
10728 if (HvARRAY((HV*)sstr)) {
10730 const bool sharekeys = !!HvSHAREKEYS(sstr);
10731 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10732 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10734 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10735 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10737 HvARRAY(dstr) = (HE**)darray;
10738 while (i <= sxhv->xhv_max) {
10739 const HE * const source = HvARRAY(sstr)[i];
10740 HvARRAY(dstr)[i] = source
10741 ? he_dup(source, sharekeys, param) : 0;
10746 const struct xpvhv_aux * const saux = HvAUX(sstr);
10747 struct xpvhv_aux * const daux = HvAUX(dstr);
10748 /* This flag isn't copied. */
10749 /* SvOOK_on(hv) attacks the IV flags. */
10750 SvFLAGS(dstr) |= SVf_OOK;
10752 hvname = saux->xhv_name;
10753 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10755 daux->xhv_riter = saux->xhv_riter;
10756 daux->xhv_eiter = saux->xhv_eiter
10757 ? he_dup(saux->xhv_eiter,
10758 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10759 daux->xhv_backreferences =
10760 saux->xhv_backreferences
10761 ? (AV*) SvREFCNT_inc(
10762 sv_dup((SV*)saux->xhv_backreferences, param))
10765 daux->xhv_mro_meta = saux->xhv_mro_meta
10766 ? mro_meta_dup(saux->xhv_mro_meta, param)
10769 /* Record stashes for possible cloning in Perl_clone(). */
10771 av_push(param->stashes, dstr);
10775 HvARRAY((HV*)dstr) = NULL;
10778 if (!(param->flags & CLONEf_COPY_STACKS)) {
10782 /* NOTE: not refcounted */
10783 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10785 if (!CvISXSUB(dstr))
10786 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10788 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10789 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10790 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10791 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10793 /* don't dup if copying back - CvGV isn't refcounted, so the
10794 * duped GV may never be freed. A bit of a hack! DAPM */
10795 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10796 NULL : gv_dup(CvGV(dstr), param) ;
10797 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10799 CvWEAKOUTSIDE(sstr)
10800 ? cv_dup( CvOUTSIDE(dstr), param)
10801 : cv_dup_inc(CvOUTSIDE(dstr), param);
10802 if (!CvISXSUB(dstr))
10803 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10809 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10815 /* duplicate a context */
10818 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10820 PERL_CONTEXT *ncxs;
10822 PERL_ARGS_ASSERT_CX_DUP;
10825 return (PERL_CONTEXT*)NULL;
10827 /* look for it in the table first */
10828 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10832 /* create anew and remember what it is */
10833 Newx(ncxs, max + 1, PERL_CONTEXT);
10834 ptr_table_store(PL_ptr_table, cxs, ncxs);
10835 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10838 PERL_CONTEXT * const ncx = &ncxs[ix];
10839 if (CxTYPE(ncx) == CXt_SUBST) {
10840 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10843 switch (CxTYPE(ncx)) {
10845 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10846 ? cv_dup_inc(ncx->blk_sub.cv, param)
10847 : cv_dup(ncx->blk_sub.cv,param));
10848 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10849 ? av_dup_inc(ncx->blk_sub.argarray,
10852 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10854 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10855 ncx->blk_sub.oldcomppad);
10858 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10860 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10862 case CXt_LOOP_LAZYSV:
10863 ncx->blk_loop.state_u.lazysv.end
10864 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10865 /* We are taking advantage of av_dup_inc and sv_dup_inc
10866 actually being the same function, and order equivalance of
10868 We can assert the later [but only at run time :-(] */
10869 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10870 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10872 ncx->blk_loop.state_u.ary.ary
10873 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10874 case CXt_LOOP_LAZYIV:
10875 case CXt_LOOP_PLAIN:
10876 if (CxPADLOOP(ncx)) {
10877 ncx->blk_loop.oldcomppad
10878 = (PAD*)ptr_table_fetch(PL_ptr_table,
10879 ncx->blk_loop.oldcomppad);
10881 ncx->blk_loop.oldcomppad
10882 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10886 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10887 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10888 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10901 /* duplicate a stack info structure */
10904 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10908 PERL_ARGS_ASSERT_SI_DUP;
10911 return (PERL_SI*)NULL;
10913 /* look for it in the table first */
10914 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10918 /* create anew and remember what it is */
10919 Newxz(nsi, 1, PERL_SI);
10920 ptr_table_store(PL_ptr_table, si, nsi);
10922 nsi->si_stack = av_dup_inc(si->si_stack, param);
10923 nsi->si_cxix = si->si_cxix;
10924 nsi->si_cxmax = si->si_cxmax;
10925 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10926 nsi->si_type = si->si_type;
10927 nsi->si_prev = si_dup(si->si_prev, param);
10928 nsi->si_next = si_dup(si->si_next, param);
10929 nsi->si_markoff = si->si_markoff;
10934 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10935 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10936 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10937 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10938 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10939 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10940 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10941 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10942 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10943 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10944 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10945 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10946 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10947 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10950 #define pv_dup_inc(p) SAVEPV(p)
10951 #define pv_dup(p) SAVEPV(p)
10952 #define svp_dup_inc(p,pp) any_dup(p,pp)
10954 /* map any object to the new equivent - either something in the
10955 * ptr table, or something in the interpreter structure
10959 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10963 PERL_ARGS_ASSERT_ANY_DUP;
10966 return (void*)NULL;
10968 /* look for it in the table first */
10969 ret = ptr_table_fetch(PL_ptr_table, v);
10973 /* see if it is part of the interpreter structure */
10974 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10975 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10983 /* duplicate the save stack */
10986 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10989 ANY * const ss = proto_perl->Isavestack;
10990 const I32 max = proto_perl->Isavestack_max;
10991 I32 ix = proto_perl->Isavestack_ix;
11004 void (*dptr) (void*);
11005 void (*dxptr) (pTHX_ void*);
11007 PERL_ARGS_ASSERT_SS_DUP;
11009 Newxz(nss, max, ANY);
11012 const I32 type = POPINT(ss,ix);
11013 TOPINT(nss,ix) = type;
11015 case SAVEt_HELEM: /* hash element */
11016 sv = (SV*)POPPTR(ss,ix);
11017 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11019 case SAVEt_ITEM: /* normal string */
11020 case SAVEt_SV: /* scalar reference */
11021 sv = (SV*)POPPTR(ss,ix);
11022 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11025 case SAVEt_MORTALIZESV:
11026 sv = (SV*)POPPTR(ss,ix);
11027 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11029 case SAVEt_SHARED_PVREF: /* char* in shared space */
11030 c = (char*)POPPTR(ss,ix);
11031 TOPPTR(nss,ix) = savesharedpv(c);
11032 ptr = POPPTR(ss,ix);
11033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11035 case SAVEt_GENERIC_SVREF: /* generic sv */
11036 case SAVEt_SVREF: /* scalar reference */
11037 sv = (SV*)POPPTR(ss,ix);
11038 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11039 ptr = POPPTR(ss,ix);
11040 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11042 case SAVEt_HV: /* hash reference */
11043 case SAVEt_AV: /* array reference */
11044 sv = (SV*) POPPTR(ss,ix);
11045 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11047 case SAVEt_COMPPAD:
11049 sv = (SV*) POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = sv_dup(sv, param);
11052 case SAVEt_INT: /* int reference */
11053 ptr = POPPTR(ss,ix);
11054 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11055 intval = (int)POPINT(ss,ix);
11056 TOPINT(nss,ix) = intval;
11058 case SAVEt_LONG: /* long reference */
11059 ptr = POPPTR(ss,ix);
11060 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11062 case SAVEt_CLEARSV:
11063 longval = (long)POPLONG(ss,ix);
11064 TOPLONG(nss,ix) = longval;
11066 case SAVEt_I32: /* I32 reference */
11067 case SAVEt_I16: /* I16 reference */
11068 case SAVEt_I8: /* I8 reference */
11069 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11070 ptr = POPPTR(ss,ix);
11071 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11073 TOPINT(nss,ix) = i;
11075 case SAVEt_IV: /* IV reference */
11076 ptr = POPPTR(ss,ix);
11077 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11079 TOPIV(nss,ix) = iv;
11081 case SAVEt_HPTR: /* HV* reference */
11082 case SAVEt_APTR: /* AV* reference */
11083 case SAVEt_SPTR: /* SV* reference */
11084 ptr = POPPTR(ss,ix);
11085 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11086 sv = (SV*)POPPTR(ss,ix);
11087 TOPPTR(nss,ix) = sv_dup(sv, param);
11089 case SAVEt_VPTR: /* random* reference */
11090 ptr = POPPTR(ss,ix);
11091 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11092 ptr = POPPTR(ss,ix);
11093 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11095 case SAVEt_GENERIC_PVREF: /* generic char* */
11096 case SAVEt_PPTR: /* char* reference */
11097 ptr = POPPTR(ss,ix);
11098 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11099 c = (char*)POPPTR(ss,ix);
11100 TOPPTR(nss,ix) = pv_dup(c);
11102 case SAVEt_GP: /* scalar reference */
11103 gp = (GP*)POPPTR(ss,ix);
11104 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11105 (void)GpREFCNT_inc(gp);
11106 gv = (GV*)POPPTR(ss,ix);
11107 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11110 ptr = POPPTR(ss,ix);
11111 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11112 /* these are assumed to be refcounted properly */
11114 switch (((OP*)ptr)->op_type) {
11116 case OP_LEAVESUBLV:
11120 case OP_LEAVEWRITE:
11121 TOPPTR(nss,ix) = ptr;
11124 (void) OpREFCNT_inc(o);
11128 TOPPTR(nss,ix) = NULL;
11133 TOPPTR(nss,ix) = NULL;
11136 c = (char*)POPPTR(ss,ix);
11137 TOPPTR(nss,ix) = pv_dup_inc(c);
11140 hv = (HV*)POPPTR(ss,ix);
11141 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11142 c = (char*)POPPTR(ss,ix);
11143 TOPPTR(nss,ix) = pv_dup_inc(c);
11145 case SAVEt_STACK_POS: /* Position on Perl stack */
11147 TOPINT(nss,ix) = i;
11149 case SAVEt_DESTRUCTOR:
11150 ptr = POPPTR(ss,ix);
11151 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11152 dptr = POPDPTR(ss,ix);
11153 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11154 any_dup(FPTR2DPTR(void *, dptr),
11157 case SAVEt_DESTRUCTOR_X:
11158 ptr = POPPTR(ss,ix);
11159 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11160 dxptr = POPDXPTR(ss,ix);
11161 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11162 any_dup(FPTR2DPTR(void *, dxptr),
11165 case SAVEt_REGCONTEXT:
11168 TOPINT(nss,ix) = i;
11171 case SAVEt_AELEM: /* array element */
11172 sv = (SV*)POPPTR(ss,ix);
11173 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11175 TOPINT(nss,ix) = i;
11176 av = (AV*)POPPTR(ss,ix);
11177 TOPPTR(nss,ix) = av_dup_inc(av, param);
11180 ptr = POPPTR(ss,ix);
11181 TOPPTR(nss,ix) = ptr;
11185 TOPINT(nss,ix) = i;
11186 ptr = POPPTR(ss,ix);
11189 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11190 HINTS_REFCNT_UNLOCK;
11192 TOPPTR(nss,ix) = ptr;
11193 if (i & HINT_LOCALIZE_HH) {
11194 hv = (HV*)POPPTR(ss,ix);
11195 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11198 case SAVEt_PADSV_AND_MORTALIZE:
11199 longval = (long)POPLONG(ss,ix);
11200 TOPLONG(nss,ix) = longval;
11201 ptr = POPPTR(ss,ix);
11202 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11203 sv = (SV*)POPPTR(ss,ix);
11204 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11207 ptr = POPPTR(ss,ix);
11208 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11209 longval = (long)POPBOOL(ss,ix);
11210 TOPBOOL(nss,ix) = (bool)longval;
11212 case SAVEt_SET_SVFLAGS:
11214 TOPINT(nss,ix) = i;
11216 TOPINT(nss,ix) = i;
11217 sv = (SV*)POPPTR(ss,ix);
11218 TOPPTR(nss,ix) = sv_dup(sv, param);
11220 case SAVEt_RE_STATE:
11222 const struct re_save_state *const old_state
11223 = (struct re_save_state *)
11224 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11225 struct re_save_state *const new_state
11226 = (struct re_save_state *)
11227 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11229 Copy(old_state, new_state, 1, struct re_save_state);
11230 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11232 new_state->re_state_bostr
11233 = pv_dup(old_state->re_state_bostr);
11234 new_state->re_state_reginput
11235 = pv_dup(old_state->re_state_reginput);
11236 new_state->re_state_regeol
11237 = pv_dup(old_state->re_state_regeol);
11238 new_state->re_state_regoffs
11239 = (regexp_paren_pair*)
11240 any_dup(old_state->re_state_regoffs, proto_perl);
11241 new_state->re_state_reglastparen
11242 = (U32*) any_dup(old_state->re_state_reglastparen,
11244 new_state->re_state_reglastcloseparen
11245 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11247 /* XXX This just has to be broken. The old save_re_context
11248 code did SAVEGENERICPV(PL_reg_start_tmp);
11249 PL_reg_start_tmp is char **.
11250 Look above to what the dup code does for
11251 SAVEt_GENERIC_PVREF
11252 It can never have worked.
11253 So this is merely a faithful copy of the exiting bug: */
11254 new_state->re_state_reg_start_tmp
11255 = (char **) pv_dup((char *)
11256 old_state->re_state_reg_start_tmp);
11257 /* I assume that it only ever "worked" because no-one called
11258 (pseudo)fork while the regexp engine had re-entered itself.
11260 #ifdef PERL_OLD_COPY_ON_WRITE
11261 new_state->re_state_nrs
11262 = sv_dup(old_state->re_state_nrs, param);
11264 new_state->re_state_reg_magic
11265 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11267 new_state->re_state_reg_oldcurpm
11268 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11270 new_state->re_state_reg_curpm
11271 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11273 new_state->re_state_reg_oldsaved
11274 = pv_dup(old_state->re_state_reg_oldsaved);
11275 new_state->re_state_reg_poscache
11276 = pv_dup(old_state->re_state_reg_poscache);
11277 new_state->re_state_reg_starttry
11278 = pv_dup(old_state->re_state_reg_starttry);
11281 case SAVEt_COMPILE_WARNINGS:
11282 ptr = POPPTR(ss,ix);
11283 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11286 ptr = POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11291 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11299 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11300 * flag to the result. This is done for each stash before cloning starts,
11301 * so we know which stashes want their objects cloned */
11304 do_mark_cloneable_stash(pTHX_ SV *const sv)
11306 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11308 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11309 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11310 if (cloner && GvCV(cloner)) {
11317 mXPUSHs(newSVhek(hvname));
11319 call_sv((SV*)GvCV(cloner), G_SCALAR);
11326 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11334 =for apidoc perl_clone
11336 Create and return a new interpreter by cloning the current one.
11338 perl_clone takes these flags as parameters:
11340 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11341 without it we only clone the data and zero the stacks,
11342 with it we copy the stacks and the new perl interpreter is
11343 ready to run at the exact same point as the previous one.
11344 The pseudo-fork code uses COPY_STACKS while the
11345 threads->create doesn't.
11347 CLONEf_KEEP_PTR_TABLE
11348 perl_clone keeps a ptr_table with the pointer of the old
11349 variable as a key and the new variable as a value,
11350 this allows it to check if something has been cloned and not
11351 clone it again but rather just use the value and increase the
11352 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11353 the ptr_table using the function
11354 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11355 reason to keep it around is if you want to dup some of your own
11356 variable who are outside the graph perl scans, example of this
11357 code is in threads.xs create
11360 This is a win32 thing, it is ignored on unix, it tells perls
11361 win32host code (which is c++) to clone itself, this is needed on
11362 win32 if you want to run two threads at the same time,
11363 if you just want to do some stuff in a separate perl interpreter
11364 and then throw it away and return to the original one,
11365 you don't need to do anything.
11370 /* XXX the above needs expanding by someone who actually understands it ! */
11371 EXTERN_C PerlInterpreter *
11372 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11375 perl_clone(PerlInterpreter *proto_perl, UV flags)
11378 #ifdef PERL_IMPLICIT_SYS
11380 PERL_ARGS_ASSERT_PERL_CLONE;
11382 /* perlhost.h so we need to call into it
11383 to clone the host, CPerlHost should have a c interface, sky */
11385 if (flags & CLONEf_CLONE_HOST) {
11386 return perl_clone_host(proto_perl,flags);
11388 return perl_clone_using(proto_perl, flags,
11390 proto_perl->IMemShared,
11391 proto_perl->IMemParse,
11393 proto_perl->IStdIO,
11397 proto_perl->IProc);
11401 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11402 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11403 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11404 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11405 struct IPerlDir* ipD, struct IPerlSock* ipS,
11406 struct IPerlProc* ipP)
11408 /* XXX many of the string copies here can be optimized if they're
11409 * constants; they need to be allocated as common memory and just
11410 * their pointers copied. */
11413 CLONE_PARAMS clone_params;
11414 CLONE_PARAMS* const param = &clone_params;
11416 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11418 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11420 /* for each stash, determine whether its objects should be cloned */
11421 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11422 PERL_SET_THX(my_perl);
11425 PoisonNew(my_perl, 1, PerlInterpreter);
11431 PL_savestack_ix = 0;
11432 PL_savestack_max = -1;
11433 PL_sig_pending = 0;
11435 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11436 # else /* !DEBUGGING */
11437 Zero(my_perl, 1, PerlInterpreter);
11438 # endif /* DEBUGGING */
11440 /* host pointers */
11442 PL_MemShared = ipMS;
11443 PL_MemParse = ipMP;
11450 #else /* !PERL_IMPLICIT_SYS */
11452 CLONE_PARAMS clone_params;
11453 CLONE_PARAMS* param = &clone_params;
11454 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11456 PERL_ARGS_ASSERT_PERL_CLONE;
11458 /* for each stash, determine whether its objects should be cloned */
11459 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11460 PERL_SET_THX(my_perl);
11463 PoisonNew(my_perl, 1, PerlInterpreter);
11469 PL_savestack_ix = 0;
11470 PL_savestack_max = -1;
11471 PL_sig_pending = 0;
11473 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11474 # else /* !DEBUGGING */
11475 Zero(my_perl, 1, PerlInterpreter);
11476 # endif /* DEBUGGING */
11477 #endif /* PERL_IMPLICIT_SYS */
11478 param->flags = flags;
11479 param->proto_perl = proto_perl;
11481 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11483 PL_body_arenas = NULL;
11484 Zero(&PL_body_roots, 1, PL_body_roots);
11486 PL_nice_chunk = NULL;
11487 PL_nice_chunk_size = 0;
11489 PL_sv_objcount = 0;
11491 PL_sv_arenaroot = NULL;
11493 PL_debug = proto_perl->Idebug;
11495 PL_hash_seed = proto_perl->Ihash_seed;
11496 PL_rehash_seed = proto_perl->Irehash_seed;
11498 #ifdef USE_REENTRANT_API
11499 /* XXX: things like -Dm will segfault here in perlio, but doing
11500 * PERL_SET_CONTEXT(proto_perl);
11501 * breaks too many other things
11503 Perl_reentrant_init(aTHX);
11506 /* create SV map for pointer relocation */
11507 PL_ptr_table = ptr_table_new();
11509 /* initialize these special pointers as early as possible */
11510 SvANY(&PL_sv_undef) = NULL;
11511 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11512 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11513 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11515 SvANY(&PL_sv_no) = new_XPVNV();
11516 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11517 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11518 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11519 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11520 SvCUR_set(&PL_sv_no, 0);
11521 SvLEN_set(&PL_sv_no, 1);
11522 SvIV_set(&PL_sv_no, 0);
11523 SvNV_set(&PL_sv_no, 0);
11524 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11526 SvANY(&PL_sv_yes) = new_XPVNV();
11527 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11528 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11529 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11530 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11531 SvCUR_set(&PL_sv_yes, 1);
11532 SvLEN_set(&PL_sv_yes, 2);
11533 SvIV_set(&PL_sv_yes, 1);
11534 SvNV_set(&PL_sv_yes, 1);
11535 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11537 /* create (a non-shared!) shared string table */
11538 PL_strtab = newHV();
11539 HvSHAREKEYS_off(PL_strtab);
11540 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11541 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11543 PL_compiling = proto_perl->Icompiling;
11545 /* These two PVs will be free'd special way so must set them same way op.c does */
11546 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11547 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11549 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11550 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11552 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11553 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11554 if (PL_compiling.cop_hints_hash) {
11556 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11557 HINTS_REFCNT_UNLOCK;
11559 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11560 #ifdef PERL_DEBUG_READONLY_OPS
11565 /* pseudo environmental stuff */
11566 PL_origargc = proto_perl->Iorigargc;
11567 PL_origargv = proto_perl->Iorigargv;
11569 param->stashes = newAV(); /* Setup array of objects to call clone on */
11571 /* Set tainting stuff before PerlIO_debug can possibly get called */
11572 PL_tainting = proto_perl->Itainting;
11573 PL_taint_warn = proto_perl->Itaint_warn;
11575 #ifdef PERLIO_LAYERS
11576 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11577 PerlIO_clone(aTHX_ proto_perl, param);
11580 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11581 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11582 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11583 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11584 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11585 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11588 PL_minus_c = proto_perl->Iminus_c;
11589 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11590 PL_localpatches = proto_perl->Ilocalpatches;
11591 PL_splitstr = proto_perl->Isplitstr;
11592 PL_minus_n = proto_perl->Iminus_n;
11593 PL_minus_p = proto_perl->Iminus_p;
11594 PL_minus_l = proto_perl->Iminus_l;
11595 PL_minus_a = proto_perl->Iminus_a;
11596 PL_minus_E = proto_perl->Iminus_E;
11597 PL_minus_F = proto_perl->Iminus_F;
11598 PL_doswitches = proto_perl->Idoswitches;
11599 PL_dowarn = proto_perl->Idowarn;
11600 PL_doextract = proto_perl->Idoextract;
11601 PL_sawampersand = proto_perl->Isawampersand;
11602 PL_unsafe = proto_perl->Iunsafe;
11603 PL_inplace = SAVEPV(proto_perl->Iinplace);
11604 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11605 PL_perldb = proto_perl->Iperldb;
11606 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11607 PL_exit_flags = proto_perl->Iexit_flags;
11609 /* magical thingies */
11610 /* XXX time(&PL_basetime) when asked for? */
11611 PL_basetime = proto_perl->Ibasetime;
11612 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11614 PL_maxsysfd = proto_perl->Imaxsysfd;
11615 PL_statusvalue = proto_perl->Istatusvalue;
11617 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11619 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11621 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11623 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11624 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11625 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11628 /* RE engine related */
11629 Zero(&PL_reg_state, 1, struct re_save_state);
11630 PL_reginterp_cnt = 0;
11631 PL_regmatch_slab = NULL;
11633 /* Clone the regex array */
11634 /* ORANGE FIXME for plugins, probably in the SV dup code.
11635 newSViv(PTR2IV(CALLREGDUPE(
11636 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11638 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11639 PL_regex_pad = AvARRAY(PL_regex_padav);
11641 /* shortcuts to various I/O objects */
11642 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11643 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11644 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11645 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11646 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11647 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11649 /* shortcuts to regexp stuff */
11650 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11652 /* shortcuts to misc objects */
11653 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11655 /* shortcuts to debugging objects */
11656 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11657 PL_DBline = gv_dup(proto_perl->IDBline, param);
11658 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11659 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11660 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11661 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11662 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11664 /* symbol tables */
11665 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11666 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11667 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11668 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11669 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11671 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11672 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11673 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11674 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11675 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11676 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11677 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11678 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11680 PL_sub_generation = proto_perl->Isub_generation;
11681 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11683 /* funky return mechanisms */
11684 PL_forkprocess = proto_perl->Iforkprocess;
11686 /* subprocess state */
11687 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11689 /* internal state */
11690 PL_maxo = proto_perl->Imaxo;
11691 if (proto_perl->Iop_mask)
11692 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11695 /* PL_asserting = proto_perl->Iasserting; */
11697 /* current interpreter roots */
11698 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11700 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11702 PL_main_start = proto_perl->Imain_start;
11703 PL_eval_root = proto_perl->Ieval_root;
11704 PL_eval_start = proto_perl->Ieval_start;
11706 /* runtime control stuff */
11707 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11709 PL_filemode = proto_perl->Ifilemode;
11710 PL_lastfd = proto_perl->Ilastfd;
11711 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11714 PL_gensym = proto_perl->Igensym;
11715 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11716 PL_laststatval = proto_perl->Ilaststatval;
11717 PL_laststype = proto_perl->Ilaststype;
11720 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11722 /* interpreter atexit processing */
11723 PL_exitlistlen = proto_perl->Iexitlistlen;
11724 if (PL_exitlistlen) {
11725 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11726 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11729 PL_exitlist = (PerlExitListEntry*)NULL;
11731 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11732 if (PL_my_cxt_size) {
11733 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11734 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11735 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11736 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11737 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11741 PL_my_cxt_list = (void**)NULL;
11742 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11743 PL_my_cxt_keys = (const char**)NULL;
11746 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11747 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11748 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11750 PL_profiledata = NULL;
11752 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11754 PAD_CLONE_VARS(proto_perl, param);
11756 #ifdef HAVE_INTERP_INTERN
11757 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11760 /* more statics moved here */
11761 PL_generation = proto_perl->Igeneration;
11762 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11764 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11765 PL_in_clean_all = proto_perl->Iin_clean_all;
11767 PL_uid = proto_perl->Iuid;
11768 PL_euid = proto_perl->Ieuid;
11769 PL_gid = proto_perl->Igid;
11770 PL_egid = proto_perl->Iegid;
11771 PL_nomemok = proto_perl->Inomemok;
11772 PL_an = proto_perl->Ian;
11773 PL_evalseq = proto_perl->Ievalseq;
11774 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11775 PL_origalen = proto_perl->Iorigalen;
11776 #ifdef PERL_USES_PL_PIDSTATUS
11777 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11779 PL_osname = SAVEPV(proto_perl->Iosname);
11780 PL_sighandlerp = proto_perl->Isighandlerp;
11782 PL_runops = proto_perl->Irunops;
11784 PL_parser = parser_dup(proto_perl->Iparser, param);
11786 PL_subline = proto_perl->Isubline;
11787 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11790 PL_cryptseen = proto_perl->Icryptseen;
11793 PL_hints = proto_perl->Ihints;
11795 PL_amagic_generation = proto_perl->Iamagic_generation;
11797 #ifdef USE_LOCALE_COLLATE
11798 PL_collation_ix = proto_perl->Icollation_ix;
11799 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11800 PL_collation_standard = proto_perl->Icollation_standard;
11801 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11802 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11803 #endif /* USE_LOCALE_COLLATE */
11805 #ifdef USE_LOCALE_NUMERIC
11806 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11807 PL_numeric_standard = proto_perl->Inumeric_standard;
11808 PL_numeric_local = proto_perl->Inumeric_local;
11809 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11810 #endif /* !USE_LOCALE_NUMERIC */
11812 /* utf8 character classes */
11813 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11814 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11815 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11816 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11817 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11818 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11819 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11820 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11821 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11822 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11823 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11824 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11825 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11826 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11827 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11828 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11829 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11830 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11831 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11832 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11834 /* Did the locale setup indicate UTF-8? */
11835 PL_utf8locale = proto_perl->Iutf8locale;
11836 /* Unicode features (see perlrun/-C) */
11837 PL_unicode = proto_perl->Iunicode;
11839 /* Pre-5.8 signals control */
11840 PL_signals = proto_perl->Isignals;
11842 /* times() ticks per second */
11843 PL_clocktick = proto_perl->Iclocktick;
11845 /* Recursion stopper for PerlIO_find_layer */
11846 PL_in_load_module = proto_perl->Iin_load_module;
11848 /* sort() routine */
11849 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11851 /* Not really needed/useful since the reenrant_retint is "volatile",
11852 * but do it for consistency's sake. */
11853 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11855 /* Hooks to shared SVs and locks. */
11856 PL_sharehook = proto_perl->Isharehook;
11857 PL_lockhook = proto_perl->Ilockhook;
11858 PL_unlockhook = proto_perl->Iunlockhook;
11859 PL_threadhook = proto_perl->Ithreadhook;
11860 PL_destroyhook = proto_perl->Idestroyhook;
11862 #ifdef THREADS_HAVE_PIDS
11863 PL_ppid = proto_perl->Ippid;
11867 PL_last_swash_hv = NULL; /* reinits on demand */
11868 PL_last_swash_klen = 0;
11869 PL_last_swash_key[0]= '\0';
11870 PL_last_swash_tmps = (U8*)NULL;
11871 PL_last_swash_slen = 0;
11873 PL_glob_index = proto_perl->Iglob_index;
11874 PL_srand_called = proto_perl->Isrand_called;
11875 PL_bitcount = NULL; /* reinits on demand */
11877 if (proto_perl->Ipsig_pend) {
11878 Newxz(PL_psig_pend, SIG_SIZE, int);
11881 PL_psig_pend = (int*)NULL;
11884 if (proto_perl->Ipsig_ptr) {
11885 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11886 Newxz(PL_psig_name, SIG_SIZE, SV*);
11887 for (i = 1; i < SIG_SIZE; i++) {
11888 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11889 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11893 PL_psig_ptr = (SV**)NULL;
11894 PL_psig_name = (SV**)NULL;
11897 /* intrpvar.h stuff */
11899 if (flags & CLONEf_COPY_STACKS) {
11900 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11901 PL_tmps_ix = proto_perl->Itmps_ix;
11902 PL_tmps_max = proto_perl->Itmps_max;
11903 PL_tmps_floor = proto_perl->Itmps_floor;
11904 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11906 while (i <= PL_tmps_ix) {
11907 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11911 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11912 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11913 Newxz(PL_markstack, i, I32);
11914 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11915 - proto_perl->Imarkstack);
11916 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11917 - proto_perl->Imarkstack);
11918 Copy(proto_perl->Imarkstack, PL_markstack,
11919 PL_markstack_ptr - PL_markstack + 1, I32);
11921 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11922 * NOTE: unlike the others! */
11923 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11924 PL_scopestack_max = proto_perl->Iscopestack_max;
11925 Newxz(PL_scopestack, PL_scopestack_max, I32);
11926 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11928 /* NOTE: si_dup() looks at PL_markstack */
11929 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11931 /* PL_curstack = PL_curstackinfo->si_stack; */
11932 PL_curstack = av_dup(proto_perl->Icurstack, param);
11933 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11935 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11936 PL_stack_base = AvARRAY(PL_curstack);
11937 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11938 - proto_perl->Istack_base);
11939 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11941 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11942 * NOTE: unlike the others! */
11943 PL_savestack_ix = proto_perl->Isavestack_ix;
11944 PL_savestack_max = proto_perl->Isavestack_max;
11945 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11946 PL_savestack = ss_dup(proto_perl, param);
11950 ENTER; /* perl_destruct() wants to LEAVE; */
11952 /* although we're not duplicating the tmps stack, we should still
11953 * add entries for any SVs on the tmps stack that got cloned by a
11954 * non-refcount means (eg a temp in @_); otherwise they will be
11957 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11958 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11959 proto_perl->Itmps_stack[i]);
11960 if (nsv && !SvREFCNT(nsv)) {
11962 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11967 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11968 PL_top_env = &PL_start_env;
11970 PL_op = proto_perl->Iop;
11973 PL_Xpv = (XPV*)NULL;
11974 my_perl->Ina = proto_perl->Ina;
11976 PL_statbuf = proto_perl->Istatbuf;
11977 PL_statcache = proto_perl->Istatcache;
11978 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11979 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11981 PL_timesbuf = proto_perl->Itimesbuf;
11984 PL_tainted = proto_perl->Itainted;
11985 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11986 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11987 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11988 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11989 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11990 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11991 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11992 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11993 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11995 PL_restartop = proto_perl->Irestartop;
11996 PL_in_eval = proto_perl->Iin_eval;
11997 PL_delaymagic = proto_perl->Idelaymagic;
11998 PL_dirty = proto_perl->Idirty;
11999 PL_localizing = proto_perl->Ilocalizing;
12001 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12002 PL_hv_fetch_ent_mh = NULL;
12003 PL_modcount = proto_perl->Imodcount;
12004 PL_lastgotoprobe = NULL;
12005 PL_dumpindent = proto_perl->Idumpindent;
12007 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12008 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12009 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12010 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12011 PL_efloatbuf = NULL; /* reinits on demand */
12012 PL_efloatsize = 0; /* reinits on demand */
12016 PL_screamfirst = NULL;
12017 PL_screamnext = NULL;
12018 PL_maxscream = -1; /* reinits on demand */
12019 PL_lastscream = NULL;
12022 PL_regdummy = proto_perl->Iregdummy;
12023 PL_colorset = 0; /* reinits PL_colors[] */
12024 /*PL_colors[6] = {0,0,0,0,0,0};*/
12028 /* Pluggable optimizer */
12029 PL_peepp = proto_perl->Ipeepp;
12031 PL_stashcache = newHV();
12033 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12034 proto_perl->Iwatchaddr);
12035 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12036 if (PL_debug && PL_watchaddr) {
12037 PerlIO_printf(Perl_debug_log,
12038 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12039 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12040 PTR2UV(PL_watchok));
12043 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12044 ptr_table_free(PL_ptr_table);
12045 PL_ptr_table = NULL;
12048 /* Call the ->CLONE method, if it exists, for each of the stashes
12049 identified by sv_dup() above.
12051 while(av_len(param->stashes) != -1) {
12052 HV* const stash = (HV*) av_shift(param->stashes);
12053 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12054 if (cloner && GvCV(cloner)) {
12059 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12061 call_sv((SV*)GvCV(cloner), G_DISCARD);
12067 SvREFCNT_dec(param->stashes);
12069 /* orphaned? eg threads->new inside BEGIN or use */
12070 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12071 SvREFCNT_inc_simple_void(PL_compcv);
12072 SAVEFREESV(PL_compcv);
12078 #endif /* USE_ITHREADS */
12081 =head1 Unicode Support
12083 =for apidoc sv_recode_to_utf8
12085 The encoding is assumed to be an Encode object, on entry the PV
12086 of the sv is assumed to be octets in that encoding, and the sv
12087 will be converted into Unicode (and UTF-8).
12089 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12090 is not a reference, nothing is done to the sv. If the encoding is not
12091 an C<Encode::XS> Encoding object, bad things will happen.
12092 (See F<lib/encoding.pm> and L<Encode>).
12094 The PV of the sv is returned.
12099 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12103 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12105 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12119 Passing sv_yes is wrong - it needs to be or'ed set of constants
12120 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12121 remove converted chars from source.
12123 Both will default the value - let them.
12125 XPUSHs(&PL_sv_yes);
12128 call_method("decode", G_SCALAR);
12132 s = SvPV_const(uni, len);
12133 if (s != SvPVX_const(sv)) {
12134 SvGROW(sv, len + 1);
12135 Move(s, SvPVX(sv), len + 1, char);
12136 SvCUR_set(sv, len);
12143 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12147 =for apidoc sv_cat_decode
12149 The encoding is assumed to be an Encode object, the PV of the ssv is
12150 assumed to be octets in that encoding and decoding the input starts
12151 from the position which (PV + *offset) pointed to. The dsv will be
12152 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12153 when the string tstr appears in decoding output or the input ends on
12154 the PV of the ssv. The value which the offset points will be modified
12155 to the last input position on the ssv.
12157 Returns TRUE if the terminator was found, else returns FALSE.
12162 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12163 SV *ssv, int *offset, char *tstr, int tlen)
12168 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12170 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12181 offsv = newSViv(*offset);
12183 mXPUSHp(tstr, tlen);
12185 call_method("cat_decode", G_SCALAR);
12187 ret = SvTRUE(TOPs);
12188 *offset = SvIV(offsv);
12194 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12199 /* ---------------------------------------------------------------------
12201 * support functions for report_uninit()
12204 /* the maxiumum size of array or hash where we will scan looking
12205 * for the undefined element that triggered the warning */
12207 #define FUV_MAX_SEARCH_SIZE 1000
12209 /* Look for an entry in the hash whose value has the same SV as val;
12210 * If so, return a mortal copy of the key. */
12213 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12216 register HE **array;
12219 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12221 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12222 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12225 array = HvARRAY(hv);
12227 for (i=HvMAX(hv); i>0; i--) {
12228 register HE *entry;
12229 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12230 if (HeVAL(entry) != val)
12232 if ( HeVAL(entry) == &PL_sv_undef ||
12233 HeVAL(entry) == &PL_sv_placeholder)
12237 if (HeKLEN(entry) == HEf_SVKEY)
12238 return sv_mortalcopy(HeKEY_sv(entry));
12239 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12245 /* Look for an entry in the array whose value has the same SV as val;
12246 * If so, return the index, otherwise return -1. */
12249 S_find_array_subscript(pTHX_ AV *av, SV* val)
12253 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12255 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12256 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12259 if (val != &PL_sv_undef) {
12260 SV ** const svp = AvARRAY(av);
12263 for (i=AvFILLp(av); i>=0; i--)
12270 /* S_varname(): return the name of a variable, optionally with a subscript.
12271 * If gv is non-zero, use the name of that global, along with gvtype (one
12272 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12273 * targ. Depending on the value of the subscript_type flag, return:
12276 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12277 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12278 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12279 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12282 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12283 SV* keyname, I32 aindex, int subscript_type)
12286 SV * const name = sv_newmortal();
12289 buffer[0] = gvtype;
12292 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12294 gv_fullname4(name, gv, buffer, 0);
12296 if ((unsigned int)SvPVX(name)[1] <= 26) {
12298 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12300 /* Swap the 1 unprintable control character for the 2 byte pretty
12301 version - ie substr($name, 1, 1) = $buffer; */
12302 sv_insert(name, 1, 1, buffer, 2);
12306 CV * const cv = find_runcv(NULL);
12310 if (!cv || !CvPADLIST(cv))
12312 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12313 sv = *av_fetch(av, targ, FALSE);
12314 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12317 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12318 SV * const sv = newSV(0);
12319 *SvPVX(name) = '$';
12320 Perl_sv_catpvf(aTHX_ name, "{%s}",
12321 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12324 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12325 *SvPVX(name) = '$';
12326 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12328 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12329 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12330 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12338 =for apidoc find_uninit_var
12340 Find the name of the undefined variable (if any) that caused the operator o
12341 to issue a "Use of uninitialized value" warning.
12342 If match is true, only return a name if it's value matches uninit_sv.
12343 So roughly speaking, if a unary operator (such as OP_COS) generates a
12344 warning, then following the direct child of the op may yield an
12345 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12346 other hand, with OP_ADD there are two branches to follow, so we only print
12347 the variable name if we get an exact match.
12349 The name is returned as a mortal SV.
12351 Assumes that PL_op is the op that originally triggered the error, and that
12352 PL_comppad/PL_curpad points to the currently executing pad.
12358 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12366 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12367 uninit_sv == &PL_sv_placeholder)))
12370 switch (obase->op_type) {
12377 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12378 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12381 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12383 if (pad) { /* @lex, %lex */
12384 sv = PAD_SVl(obase->op_targ);
12388 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12389 /* @global, %global */
12390 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12393 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12395 else /* @{expr}, %{expr} */
12396 return find_uninit_var(cUNOPx(obase)->op_first,
12400 /* attempt to find a match within the aggregate */
12402 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12404 subscript_type = FUV_SUBSCRIPT_HASH;
12407 index = find_array_subscript((AV*)sv, uninit_sv);
12409 subscript_type = FUV_SUBSCRIPT_ARRAY;
12412 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12415 return varname(gv, hash ? '%' : '@', obase->op_targ,
12416 keysv, index, subscript_type);
12420 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12422 return varname(NULL, '$', obase->op_targ,
12423 NULL, 0, FUV_SUBSCRIPT_NONE);
12426 gv = cGVOPx_gv(obase);
12427 if (!gv || (match && GvSV(gv) != uninit_sv))
12429 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12432 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12435 av = (AV*)PAD_SV(obase->op_targ);
12436 if (!av || SvRMAGICAL(av))
12438 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12439 if (!svp || *svp != uninit_sv)
12442 return varname(NULL, '$', obase->op_targ,
12443 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12446 gv = cGVOPx_gv(obase);
12452 if (!av || SvRMAGICAL(av))
12454 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12455 if (!svp || *svp != uninit_sv)
12458 return varname(gv, '$', 0,
12459 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12464 o = cUNOPx(obase)->op_first;
12465 if (!o || o->op_type != OP_NULL ||
12466 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12468 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12472 if (PL_op == obase)
12473 /* $a[uninit_expr] or $h{uninit_expr} */
12474 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12477 o = cBINOPx(obase)->op_first;
12478 kid = cBINOPx(obase)->op_last;
12480 /* get the av or hv, and optionally the gv */
12482 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12483 sv = PAD_SV(o->op_targ);
12485 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12486 && cUNOPo->op_first->op_type == OP_GV)
12488 gv = cGVOPx_gv(cUNOPo->op_first);
12491 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12496 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12497 /* index is constant */
12501 if (obase->op_type == OP_HELEM) {
12502 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12503 if (!he || HeVAL(he) != uninit_sv)
12507 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12508 if (!svp || *svp != uninit_sv)
12512 if (obase->op_type == OP_HELEM)
12513 return varname(gv, '%', o->op_targ,
12514 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12516 return varname(gv, '@', o->op_targ, NULL,
12517 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12520 /* index is an expression;
12521 * attempt to find a match within the aggregate */
12522 if (obase->op_type == OP_HELEM) {
12523 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12525 return varname(gv, '%', o->op_targ,
12526 keysv, 0, FUV_SUBSCRIPT_HASH);
12529 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12531 return varname(gv, '@', o->op_targ,
12532 NULL, index, FUV_SUBSCRIPT_ARRAY);
12537 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12539 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12544 /* only examine RHS */
12545 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12548 o = cUNOPx(obase)->op_first;
12549 if (o->op_type == OP_PUSHMARK)
12552 if (!o->op_sibling) {
12553 /* one-arg version of open is highly magical */
12555 if (o->op_type == OP_GV) { /* open FOO; */
12557 if (match && GvSV(gv) != uninit_sv)
12559 return varname(gv, '$', 0,
12560 NULL, 0, FUV_SUBSCRIPT_NONE);
12562 /* other possibilities not handled are:
12563 * open $x; or open my $x; should return '${*$x}'
12564 * open expr; should return '$'.expr ideally
12570 /* ops where $_ may be an implicit arg */
12574 if ( !(obase->op_flags & OPf_STACKED)) {
12575 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12576 ? PAD_SVl(obase->op_targ)
12579 sv = sv_newmortal();
12580 sv_setpvn(sv, "$_", 2);
12589 /* skip filehandle as it can't produce 'undef' warning */
12590 o = cUNOPx(obase)->op_first;
12591 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12592 o = o->op_sibling->op_sibling;
12596 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12599 match = 1; /* XS or custom code could trigger random warnings */
12604 /* XXX tmp hack: these two may call an XS sub, and currently
12605 XS subs don't have a SUB entry on the context stack, so CV and
12606 pad determination goes wrong, and BAD things happen. So, just
12607 don't try to determine the value under those circumstances.
12608 Need a better fix at dome point. DAPM 11/2007 */
12612 /* def-ness of rval pos() is independent of the def-ness of its arg */
12613 if ( !(obase->op_flags & OPf_MOD))
12618 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12619 return newSVpvs_flags("${$/}", SVs_TEMP);
12624 if (!(obase->op_flags & OPf_KIDS))
12626 o = cUNOPx(obase)->op_first;
12632 /* if all except one arg are constant, or have no side-effects,
12633 * or are optimized away, then it's unambiguous */
12635 for (kid=o; kid; kid = kid->op_sibling) {
12637 const OPCODE type = kid->op_type;
12638 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12639 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12640 || (type == OP_PUSHMARK)
12644 if (o2) { /* more than one found */
12651 return find_uninit_var(o2, uninit_sv, match);
12653 /* scan all args */
12655 sv = find_uninit_var(o, uninit_sv, 1);
12667 =for apidoc report_uninit
12669 Print appropriate "Use of uninitialized variable" warning
12675 Perl_report_uninit(pTHX_ SV* uninit_sv)
12679 SV* varname = NULL;
12681 varname = find_uninit_var(PL_op, uninit_sv,0);
12683 sv_insert(varname, 0, 0, " ", 1);
12685 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12686 varname ? SvPV_nolen_const(varname) : "",
12687 " in ", OP_DESC(PL_op));
12690 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12696 * c-indentation-style: bsd
12697 * c-basic-offset: 4
12698 * indent-tabs-mode: t
12701 * ex: set ts=8 sts=4 sw=4 noet: