3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
176 #ifdef DEBUG_LEAKING_SCALARS
177 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
179 # define FREE_SV_DEBUG_FILE(sv)
183 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
184 /* Whilst I'd love to do this, it seems that things like to check on
186 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
188 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
189 PoisonNew(&SvREFCNT(sv), 1, U32)
191 # define SvARENA_CHAIN(sv) SvANY(sv)
192 # define POSION_SV_HEAD(sv)
195 #define plant_SV(p) \
197 FREE_SV_DEBUG_FILE(p); \
199 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 #define uproot_SV(p) \
208 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
213 /* make some more SVs by adding another arena */
222 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
223 PL_nice_chunk = NULL;
224 PL_nice_chunk_size = 0;
227 char *chunk; /* must use New here to match call to */
228 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
229 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
235 /* new_SV(): return a new, empty SV head */
237 #ifdef DEBUG_LEAKING_SCALARS
238 /* provide a real function for a debugger to play with */
247 sv = S_more_sv(aTHX);
251 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
252 sv->sv_debug_line = (U16) (PL_parser
253 ? PL_parser->copline == NOLINE
259 sv->sv_debug_inpad = 0;
260 sv->sv_debug_cloned = 0;
261 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
265 # define new_SV(p) (p)=S_new_SV(aTHX)
273 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
294 S_del_sv(pTHX_ SV *p)
298 PERL_ARGS_ASSERT_DEL_SV;
303 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
304 const SV * const sv = sva + 1;
305 const SV * const svend = &sva[SvREFCNT(sva)];
306 if (p >= sv && p < svend) {
312 if (ckWARN_d(WARN_INTERNAL))
313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
314 "Attempt to free non-arena SV: 0x%"UVxf
315 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
322 #else /* ! DEBUGGING */
324 #define del_SV(p) plant_SV(p)
326 #endif /* DEBUGGING */
330 =head1 SV Manipulation Functions
332 =for apidoc sv_add_arena
334 Given a chunk of memory, link it to the head of the list of arenas,
335 and split it into a list of free SVs.
341 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
344 SV* const sva = (SV*)ptr;
348 PERL_ARGS_ASSERT_SV_ADD_ARENA;
350 /* The first SV in an arena isn't an SV. */
351 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
352 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
353 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
355 PL_sv_arenaroot = sva;
356 PL_sv_root = sva + 1;
358 svend = &sva[SvREFCNT(sva) - 1];
361 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
365 /* Must always set typemask because it's always checked in on cleanup
366 when the arenas are walked looking for objects. */
367 SvFLAGS(sv) = SVTYPEMASK;
370 SvARENA_CHAIN(sv) = 0;
374 SvFLAGS(sv) = SVTYPEMASK;
377 /* visit(): call the named function for each non-free SV in the arenas
378 * whose flags field matches the flags/mask args. */
381 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
387 PERL_ARGS_ASSERT_VISIT;
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *const sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
437 /* called by sv_clean_objs() for each live SV */
440 do_clean_objs(pTHX_ SV *const ref)
445 SV * const target = SvRV(ref);
446 if (SvOBJECT(target)) {
447 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
448 if (SvWEAKREF(ref)) {
449 sv_del_backref(target, ref);
455 SvREFCNT_dec(target);
460 /* XXX Might want to check arrays, etc. */
463 /* called by sv_clean_objs() for each live SV */
465 #ifndef DISABLE_DESTRUCTOR_KLUDGE
467 do_clean_named_objs(pTHX_ SV *const sv)
470 assert(SvTYPE(sv) == SVt_PVGV);
471 assert(isGV_with_GP(sv));
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
481 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *const sv)
519 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
520 /* don't clean pid table and strtab */
523 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
524 SvFLAGS(sv) |= SVf_BREAK;
529 =for apidoc sv_clean_all
531 Decrement the refcnt of each remaining SV, possibly triggering a
532 cleanup. This function may have to be called multiple times to free
533 SVs which are in complex self-referential hierarchies.
539 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 ARENASETS: a meta-arena implementation which separates arena-info
551 into struct arena_set, which contains an array of struct
552 arena_descs, each holding info for a single arena. By separating
553 the meta-info from the arena, we recover the 1st slot, formerly
554 borrowed for list management. The arena_set is about the size of an
555 arena, avoiding the needless malloc overhead of a naive linked-list.
557 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
558 memory in the last arena-set (1/2 on average). In trade, we get
559 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
560 smaller types). The recovery of the wasted space allows use of
561 small arenas for large, rare body types, by changing array* fields
562 in body_details_by_type[] below.
565 char *arena; /* the raw storage, allocated aligned */
566 size_t size; /* its size ~4k typ */
567 U32 misc; /* type, and in future other things. */
572 /* Get the maximum number of elements in set[] such that struct arena_set
573 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
574 therefore likely to be 1 aligned memory page. */
576 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
577 - 2 * sizeof(int)) / sizeof (struct arena_desc))
580 struct arena_set* next;
581 unsigned int set_size; /* ie ARENAS_PER_SET */
582 unsigned int curr; /* index of next available arena-desc */
583 struct arena_desc set[ARENAS_PER_SET];
587 =for apidoc sv_free_arenas
589 Deallocate the memory used by all arenas. Note that all the individual SV
590 heads and bodies within the arenas must already have been freed.
595 Perl_sv_free_arenas(pTHX)
602 /* Free arenas here, but be careful about fake ones. (We assume
603 contiguity of the fake ones with the corresponding real ones.) */
605 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
606 svanext = (SV*) SvANY(sva);
607 while (svanext && SvFAKE(svanext))
608 svanext = (SV*) SvANY(svanext);
615 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
618 struct arena_set *current = aroot;
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 i = PERL_ARENA_ROOTS_SIZE;
632 PL_body_roots[i] = 0;
634 Safefree(PL_nice_chunk);
635 PL_nice_chunk = NULL;
636 PL_nice_chunk_size = 0;
642 Here are mid-level routines that manage the allocation of bodies out
643 of the various arenas. There are 5 kinds of arenas:
645 1. SV-head arenas, which are discussed and handled above
646 2. regular body arenas
647 3. arenas for reduced-size bodies
649 5. pte arenas (thread related)
651 Arena types 2 & 3 are chained by body-type off an array of
652 arena-root pointers, which is indexed by svtype. Some of the
653 larger/less used body types are malloced singly, since a large
654 unused block of them is wasteful. Also, several svtypes dont have
655 bodies; the data fits into the sv-head itself. The arena-root
656 pointer thus has a few unused root-pointers (which may be hijacked
657 later for arena types 4,5)
659 3 differs from 2 as an optimization; some body types have several
660 unused fields in the front of the structure (which are kept in-place
661 for consistency). These bodies can be allocated in smaller chunks,
662 because the leading fields arent accessed. Pointers to such bodies
663 are decremented to point at the unused 'ghost' memory, knowing that
664 the pointers are used with offsets to the real memory.
666 HE, HEK arenas are managed separately, with separate code, but may
667 be merge-able later..
669 PTE arenas are not sv-bodies, but they share these mid-level
670 mechanics, so are considered here. The new mid-level mechanics rely
671 on the sv_type of the body being allocated, so we just reserve one
672 of the unused body-slots for PTEs, then use it in those (2) PTE
673 contexts below (line ~10k)
676 /* get_arena(size): this creates custom-sized arenas
677 TBD: export properly for hv.c: S_more_he().
680 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
683 struct arena_desc* adesc;
684 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
687 /* shouldnt need this
688 if (!arena_size) arena_size = PERL_ARENA_SIZE;
691 /* may need new arena-set to hold new arena */
692 if (!aroot || aroot->curr >= aroot->set_size) {
693 struct arena_set *newroot;
694 Newxz(newroot, 1, struct arena_set);
695 newroot->set_size = ARENAS_PER_SET;
696 newroot->next = aroot;
698 PL_body_arenas = (void *) newroot;
699 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
702 /* ok, now have arena-set with at least 1 empty/available arena-desc */
703 curr = aroot->curr++;
704 adesc = &(aroot->set[curr]);
705 assert(!adesc->arena);
707 Newx(adesc->arena, arena_size, char);
708 adesc->size = arena_size;
710 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
711 curr, (void*)adesc->arena, (UV)arena_size));
717 /* return a thing to the free list */
719 #define del_body(thing, root) \
721 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 =head1 SV-Body Allocation
730 Allocation of SV-bodies is similar to SV-heads, differing as follows;
731 the allocation mechanism is used for many body types, so is somewhat
732 more complicated, it uses arena-sets, and has no need for still-live
735 At the outermost level, (new|del)_X*V macros return bodies of the
736 appropriate type. These macros call either (new|del)_body_type or
737 (new|del)_body_allocated macro pairs, depending on specifics of the
738 type. Most body types use the former pair, the latter pair is used to
739 allocate body types with "ghost fields".
741 "ghost fields" are fields that are unused in certain types, and
742 consequently dont need to actually exist. They are declared because
743 they're part of a "base type", which allows use of functions as
744 methods. The simplest examples are AVs and HVs, 2 aggregate types
745 which don't use the fields which support SCALAR semantics.
747 For these types, the arenas are carved up into *_allocated size
748 chunks, we thus avoid wasted memory for those unaccessed members.
749 When bodies are allocated, we adjust the pointer back in memory by the
750 size of the bit not allocated, so it's as if we allocated the full
751 structure. (But things will all go boom if you write to the part that
752 is "not there", because you'll be overwriting the last members of the
753 preceding structure in memory.)
755 We calculate the correction using the STRUCT_OFFSET macro. For
756 example, if xpv_allocated is the same structure as XPV then the two
757 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
758 structure is smaller (no initial NV actually allocated) then the net
759 effect is to subtract the size of the NV from the pointer, to return a
760 new pointer as if an initial NV were actually allocated.
762 This is the same trick as was used for NV and IV bodies. Ironically it
763 doesn't need to be used for NV bodies any more, because NV is now at
764 the start of the structure. IV bodies don't need it either, because
765 they are no longer allocated.
767 In turn, the new_body_* allocators call S_new_body(), which invokes
768 new_body_inline macro, which takes a lock, and takes a body off the
769 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
770 necessary to refresh an empty list. Then the lock is released, and
771 the body is returned.
773 S_more_bodies calls get_arena(), and carves it up into an array of N
774 bodies, which it strings into a linked list. It looks up arena-size
775 and body-size from the body_details table described below, thus
776 supporting the multiple body-types.
778 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
779 the (new|del)_X*V macros are mapped directly to malloc/free.
785 For each sv-type, struct body_details bodies_by_type[] carries
786 parameters which control these aspects of SV handling:
788 Arena_size determines whether arenas are used for this body type, and if
789 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
790 zero, forcing individual mallocs and frees.
792 Body_size determines how big a body is, and therefore how many fit into
793 each arena. Offset carries the body-pointer adjustment needed for
794 *_allocated body types, and is used in *_allocated macros.
796 But its main purpose is to parameterize info needed in
797 Perl_sv_upgrade(). The info here dramatically simplifies the function
798 vs the implementation in 5.8.7, making it table-driven. All fields
799 are used for this, except for arena_size.
801 For the sv-types that have no bodies, arenas are not used, so those
802 PL_body_roots[sv_type] are unused, and can be overloaded. In
803 something of a special case, SVt_NULL is borrowed for HE arenas;
804 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
805 bodies_by_type[SVt_NULL] slot is not used, as the table is not
808 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
809 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
810 just use the same allocation semantics. At first, PTEs were also
811 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
812 bugs, so was simplified by claiming a new slot. This choice has no
813 consequence at this time.
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* A macro to work out the offset needed to subtract from a pointer to (say)
867 to make its members accessible via a pointer to (say)
877 #define relative_STRUCT_OFFSET(longer, shorter, member) \
878 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
880 /* Calculate the length to copy. Specifically work out the length less any
881 final padding the compiler needed to add. See the comment in sv_upgrade
882 for why copying the padding proved to be a bug. */
884 #define copy_length(type, last_member) \
885 STRUCT_OFFSET(type, last_member) \
886 + sizeof (((type*)SvANY((SV*)0))->last_member)
888 static const struct body_details bodies_by_type[] = {
889 { sizeof(HE), 0, 0, SVt_NULL,
890 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
892 /* The bind placeholder pretends to be an RV for now.
893 Also it's marked as "can't upgrade" to stop anyone using it before it's
895 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
897 /* IVs are in the head, so the allocation size is 0.
898 However, the slot is overloaded for PTEs. */
899 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
900 sizeof(IV), /* This is used to copy out the IV body. */
901 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
902 NOARENA /* IVS don't need an arena */,
903 /* But PTEs need to know the size of their arena */
904 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
909 FIT_ARENA(0, sizeof(NV)) },
911 /* 8 bytes on most ILP32 with IEEE doubles */
912 { sizeof(xpv_allocated),
913 copy_length(XPV, xpv_len)
914 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
916 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
919 { sizeof(xpviv_allocated),
920 copy_length(XPVIV, xiv_u)
921 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
923 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
926 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
930 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
934 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
935 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
936 SVt_REGEXP, FALSE, NONV, HASARENA,
937 FIT_ARENA(0, sizeof(struct regexp_allocated))
941 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
945 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
946 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
948 { sizeof(xpvav_allocated),
949 copy_length(XPVAV, xmg_stash)
950 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
952 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
954 { sizeof(xpvhv_allocated),
955 copy_length(XPVHV, xmg_stash)
956 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
958 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
961 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
962 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
963 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
965 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
966 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
967 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
969 /* XPVIO is 84 bytes, fits 48x */
970 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
971 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
972 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
975 #define new_body_type(sv_type) \
976 (void *)((char *)S_new_body(aTHX_ sv_type))
978 #define del_body_type(p, sv_type) \
979 del_body(p, &PL_body_roots[sv_type])
982 #define new_body_allocated(sv_type) \
983 (void *)((char *)S_new_body(aTHX_ sv_type) \
984 - bodies_by_type[sv_type].offset)
986 #define del_body_allocated(p, sv_type) \
987 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
990 #define my_safemalloc(s) (void*)safemalloc(s)
991 #define my_safecalloc(s) (void*)safecalloc(s, 1)
992 #define my_safefree(p) safefree((char*)p)
996 #define new_XNV() my_safemalloc(sizeof(XPVNV))
997 #define del_XNV(p) my_safefree(p)
999 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1000 #define del_XPVNV(p) my_safefree(p)
1002 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1003 #define del_XPVAV(p) my_safefree(p)
1005 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1006 #define del_XPVHV(p) my_safefree(p)
1008 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1009 #define del_XPVMG(p) my_safefree(p)
1011 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1012 #define del_XPVGV(p) my_safefree(p)
1016 #define new_XNV() new_body_type(SVt_NV)
1017 #define del_XNV(p) del_body_type(p, SVt_NV)
1019 #define new_XPVNV() new_body_type(SVt_PVNV)
1020 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1022 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1023 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1025 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1026 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1028 #define new_XPVMG() new_body_type(SVt_PVMG)
1029 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1031 #define new_XPVGV() new_body_type(SVt_PVGV)
1032 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1036 /* no arena for you! */
1038 #define new_NOARENA(details) \
1039 my_safemalloc((details)->body_size + (details)->offset)
1040 #define new_NOARENAZ(details) \
1041 my_safecalloc((details)->body_size + (details)->offset)
1044 S_more_bodies (pTHX_ const svtype sv_type)
1047 void ** const root = &PL_body_roots[sv_type];
1048 const struct body_details * const bdp = &bodies_by_type[sv_type];
1049 const size_t body_size = bdp->body_size;
1052 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1053 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1054 static bool done_sanity_check;
1056 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1057 * variables like done_sanity_check. */
1058 if (!done_sanity_check) {
1059 unsigned int i = SVt_LAST;
1061 done_sanity_check = TRUE;
1064 assert (bodies_by_type[i].type == i);
1068 assert(bdp->arena_size);
1070 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1072 end = start + arena_size - 2 * body_size;
1074 /* computed count doesnt reflect the 1st slot reservation */
1075 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1076 DEBUG_m(PerlIO_printf(Perl_debug_log,
1077 "arena %p end %p arena-size %d (from %d) type %d "
1079 (void*)start, (void*)end, (int)arena_size,
1080 (int)bdp->arena_size, sv_type, (int)body_size,
1081 (int)arena_size / (int)body_size));
1083 DEBUG_m(PerlIO_printf(Perl_debug_log,
1084 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1085 (void*)start, (void*)end,
1086 (int)bdp->arena_size, sv_type, (int)body_size,
1087 (int)bdp->arena_size / (int)body_size));
1089 *root = (void *)start;
1091 while (start <= end) {
1092 char * const next = start + body_size;
1093 *(void**) start = (void *)next;
1096 *(void **)start = 0;
1101 /* grab a new thing from the free list, allocating more if necessary.
1102 The inline version is used for speed in hot routines, and the
1103 function using it serves the rest (unless PURIFY).
1105 #define new_body_inline(xpv, sv_type) \
1107 void ** const r3wt = &PL_body_roots[sv_type]; \
1108 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1109 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1110 *(r3wt) = *(void**)(xpv); \
1116 S_new_body(pTHX_ const svtype sv_type)
1120 new_body_inline(xpv, sv_type);
1126 static const struct body_details fake_rv =
1127 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1130 =for apidoc sv_upgrade
1132 Upgrade an SV to a more complex form. Generally adds a new body type to the
1133 SV, then copies across as much information as possible from the old body.
1134 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1140 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1145 const svtype old_type = SvTYPE(sv);
1146 const struct body_details *new_type_details;
1147 const struct body_details *old_type_details
1148 = bodies_by_type + old_type;
1149 SV *referant = NULL;
1151 PERL_ARGS_ASSERT_SV_UPGRADE;
1153 if (new_type != SVt_PV && SvIsCOW(sv)) {
1154 sv_force_normal_flags(sv, 0);
1157 if (old_type == new_type)
1160 old_body = SvANY(sv);
1162 /* Copying structures onto other structures that have been neatly zeroed
1163 has a subtle gotcha. Consider XPVMG
1165 +------+------+------+------+------+-------+-------+
1166 | NV | CUR | LEN | IV | MAGIC | STASH |
1167 +------+------+------+------+------+-------+-------+
1168 0 4 8 12 16 20 24 28
1170 where NVs are aligned to 8 bytes, so that sizeof that structure is
1171 actually 32 bytes long, with 4 bytes of padding at the end:
1173 +------+------+------+------+------+-------+-------+------+
1174 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1175 +------+------+------+------+------+-------+-------+------+
1176 0 4 8 12 16 20 24 28 32
1178 so what happens if you allocate memory for this structure:
1180 +------+------+------+------+------+-------+-------+------+------+...
1181 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1182 +------+------+------+------+------+-------+-------+------+------+...
1183 0 4 8 12 16 20 24 28 32 36
1185 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1186 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1187 started out as zero once, but it's quite possible that it isn't. So now,
1188 rather than a nicely zeroed GP, you have it pointing somewhere random.
1191 (In fact, GP ends up pointing at a previous GP structure, because the
1192 principle cause of the padding in XPVMG getting garbage is a copy of
1193 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1194 this happens to be moot because XPVGV has been re-ordered, with GP
1195 no longer after STASH)
1197 So we are careful and work out the size of used parts of all the
1205 referant = SvRV(sv);
1206 old_type_details = &fake_rv;
1207 if (new_type == SVt_NV)
1208 new_type = SVt_PVNV;
1210 if (new_type < SVt_PVIV) {
1211 new_type = (new_type == SVt_NV)
1212 ? SVt_PVNV : SVt_PVIV;
1217 if (new_type < SVt_PVNV) {
1218 new_type = SVt_PVNV;
1222 assert(new_type > SVt_PV);
1223 assert(SVt_IV < SVt_PV);
1224 assert(SVt_NV < SVt_PV);
1231 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1232 there's no way that it can be safely upgraded, because perl.c
1233 expects to Safefree(SvANY(PL_mess_sv)) */
1234 assert(sv != PL_mess_sv);
1235 /* This flag bit is used to mean other things in other scalar types.
1236 Given that it only has meaning inside the pad, it shouldn't be set
1237 on anything that can get upgraded. */
1238 assert(!SvPAD_TYPED(sv));
1241 if (old_type_details->cant_upgrade)
1242 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1243 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1246 if (old_type > new_type)
1247 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1248 (int)old_type, (int)new_type);
1250 new_type_details = bodies_by_type + new_type;
1252 SvFLAGS(sv) &= ~SVTYPEMASK;
1253 SvFLAGS(sv) |= new_type;
1255 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1256 the return statements above will have triggered. */
1257 assert (new_type != SVt_NULL);
1260 assert(old_type == SVt_NULL);
1261 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1265 assert(old_type == SVt_NULL);
1266 SvANY(sv) = new_XNV();
1271 assert(new_type_details->body_size);
1274 assert(new_type_details->arena);
1275 assert(new_type_details->arena_size);
1276 /* This points to the start of the allocated area. */
1277 new_body_inline(new_body, new_type);
1278 Zero(new_body, new_type_details->body_size, char);
1279 new_body = ((char *)new_body) - new_type_details->offset;
1281 /* We always allocated the full length item with PURIFY. To do this
1282 we fake things so that arena is false for all 16 types.. */
1283 new_body = new_NOARENAZ(new_type_details);
1285 SvANY(sv) = new_body;
1286 if (new_type == SVt_PVAV) {
1290 if (old_type_details->body_size) {
1293 /* It will have been zeroed when the new body was allocated.
1294 Lets not write to it, in case it confuses a write-back
1300 #ifndef NODEFAULT_SHAREKEYS
1301 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1303 HvMAX(sv) = 7; /* (start with 8 buckets) */
1304 if (old_type_details->body_size) {
1307 /* It will have been zeroed when the new body was allocated.
1308 Lets not write to it, in case it confuses a write-back
1313 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1314 The target created by newSVrv also is, and it can have magic.
1315 However, it never has SvPVX set.
1317 if (old_type == SVt_IV) {
1319 } else if (old_type >= SVt_PV) {
1320 assert(SvPVX_const(sv) == 0);
1323 if (old_type >= SVt_PVMG) {
1324 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1325 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1327 sv->sv_u.svu_array = NULL; /* or svu_hash */
1333 /* XXX Is this still needed? Was it ever needed? Surely as there is
1334 no route from NV to PVIV, NOK can never be true */
1335 assert(!SvNOKp(sv));
1347 assert(new_type_details->body_size);
1348 /* We always allocated the full length item with PURIFY. To do this
1349 we fake things so that arena is false for all 16 types.. */
1350 if(new_type_details->arena) {
1351 /* This points to the start of the allocated area. */
1352 new_body_inline(new_body, new_type);
1353 Zero(new_body, new_type_details->body_size, char);
1354 new_body = ((char *)new_body) - new_type_details->offset;
1356 new_body = new_NOARENAZ(new_type_details);
1358 SvANY(sv) = new_body;
1360 if (old_type_details->copy) {
1361 /* There is now the potential for an upgrade from something without
1362 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1363 int offset = old_type_details->offset;
1364 int length = old_type_details->copy;
1366 if (new_type_details->offset > old_type_details->offset) {
1367 const int difference
1368 = new_type_details->offset - old_type_details->offset;
1369 offset += difference;
1370 length -= difference;
1372 assert (length >= 0);
1374 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1378 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1379 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1380 * correct 0.0 for us. Otherwise, if the old body didn't have an
1381 * NV slot, but the new one does, then we need to initialise the
1382 * freshly created NV slot with whatever the correct bit pattern is
1384 if (old_type_details->zero_nv && !new_type_details->zero_nv
1385 && !isGV_with_GP(sv))
1389 if (new_type == SVt_PVIO)
1390 IoPAGE_LEN(sv) = 60;
1391 if (old_type < SVt_PV) {
1392 /* referant will be NULL unless the old type was SVt_IV emulating
1394 sv->sv_u.svu_rv = referant;
1398 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1399 (unsigned long)new_type);
1402 if (old_type_details->arena) {
1403 /* If there was an old body, then we need to free it.
1404 Note that there is an assumption that all bodies of types that
1405 can be upgraded came from arenas. Only the more complex non-
1406 upgradable types are allowed to be directly malloc()ed. */
1408 my_safefree(old_body);
1410 del_body((void*)((char*)old_body + old_type_details->offset),
1411 &PL_body_roots[old_type]);
1417 =for apidoc sv_backoff
1419 Remove any string offset. You should normally use the C<SvOOK_off> macro
1426 Perl_sv_backoff(pTHX_ register SV *const sv)
1429 const char * const s = SvPVX_const(sv);
1431 PERL_ARGS_ASSERT_SV_BACKOFF;
1432 PERL_UNUSED_CONTEXT;
1435 assert(SvTYPE(sv) != SVt_PVHV);
1436 assert(SvTYPE(sv) != SVt_PVAV);
1438 SvOOK_offset(sv, delta);
1440 SvLEN_set(sv, SvLEN(sv) + delta);
1441 SvPV_set(sv, SvPVX(sv) - delta);
1442 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1443 SvFLAGS(sv) &= ~SVf_OOK;
1450 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1451 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1452 Use the C<SvGROW> wrapper instead.
1458 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1462 PERL_ARGS_ASSERT_SV_GROW;
1464 if (PL_madskills && newlen >= 0x100000) {
1465 PerlIO_printf(Perl_debug_log,
1466 "Allocation too large: %"UVxf"\n", (UV)newlen);
1468 #ifdef HAS_64K_LIMIT
1469 if (newlen >= 0x10000) {
1470 PerlIO_printf(Perl_debug_log,
1471 "Allocation too large: %"UVxf"\n", (UV)newlen);
1474 #endif /* HAS_64K_LIMIT */
1477 if (SvTYPE(sv) < SVt_PV) {
1478 sv_upgrade(sv, SVt_PV);
1479 s = SvPVX_mutable(sv);
1481 else if (SvOOK(sv)) { /* pv is offset? */
1483 s = SvPVX_mutable(sv);
1484 if (newlen > SvLEN(sv))
1485 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1486 #ifdef HAS_64K_LIMIT
1487 if (newlen >= 0x10000)
1492 s = SvPVX_mutable(sv);
1494 if (newlen > SvLEN(sv)) { /* need more room? */
1495 #ifndef Perl_safesysmalloc_size
1496 newlen = PERL_STRLEN_ROUNDUP(newlen);
1498 if (SvLEN(sv) && s) {
1499 s = (char*)saferealloc(s, newlen);
1502 s = (char*)safemalloc(newlen);
1503 if (SvPVX_const(sv) && SvCUR(sv)) {
1504 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1508 #ifdef Perl_safesysmalloc_size
1509 /* Do this here, do it once, do it right, and then we will never get
1510 called back into sv_grow() unless there really is some growing
1512 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1514 SvLEN_set(sv, newlen);
1521 =for apidoc sv_setiv
1523 Copies an integer into the given SV, upgrading first if necessary.
1524 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1530 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1534 PERL_ARGS_ASSERT_SV_SETIV;
1536 SV_CHECK_THINKFIRST_COW_DROP(sv);
1537 switch (SvTYPE(sv)) {
1540 sv_upgrade(sv, SVt_IV);
1543 sv_upgrade(sv, SVt_PVIV);
1552 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1556 (void)SvIOK_only(sv); /* validate number */
1562 =for apidoc sv_setiv_mg
1564 Like C<sv_setiv>, but also handles 'set' magic.
1570 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1572 PERL_ARGS_ASSERT_SV_SETIV_MG;
1579 =for apidoc sv_setuv
1581 Copies an unsigned integer into the given SV, upgrading first if necessary.
1582 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1588 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1590 PERL_ARGS_ASSERT_SV_SETUV;
1592 /* With these two if statements:
1593 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1596 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1598 If you wish to remove them, please benchmark to see what the effect is
1600 if (u <= (UV)IV_MAX) {
1601 sv_setiv(sv, (IV)u);
1610 =for apidoc sv_setuv_mg
1612 Like C<sv_setuv>, but also handles 'set' magic.
1618 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1620 PERL_ARGS_ASSERT_SV_SETUV_MG;
1627 =for apidoc sv_setnv
1629 Copies a double into the given SV, upgrading first if necessary.
1630 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1636 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1640 PERL_ARGS_ASSERT_SV_SETNV;
1642 SV_CHECK_THINKFIRST_COW_DROP(sv);
1643 switch (SvTYPE(sv)) {
1646 sv_upgrade(sv, SVt_NV);
1650 sv_upgrade(sv, SVt_PVNV);
1659 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1664 (void)SvNOK_only(sv); /* validate number */
1669 =for apidoc sv_setnv_mg
1671 Like C<sv_setnv>, but also handles 'set' magic.
1677 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1679 PERL_ARGS_ASSERT_SV_SETNV_MG;
1685 /* Print an "isn't numeric" warning, using a cleaned-up,
1686 * printable version of the offending string
1690 S_not_a_number(pTHX_ SV *const sv)
1697 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1700 dsv = newSVpvs_flags("", SVs_TEMP);
1701 pv = sv_uni_display(dsv, sv, 10, 0);
1704 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1705 /* each *s can expand to 4 chars + "...\0",
1706 i.e. need room for 8 chars */
1708 const char *s = SvPVX_const(sv);
1709 const char * const end = s + SvCUR(sv);
1710 for ( ; s < end && d < limit; s++ ) {
1712 if (ch & 128 && !isPRINT_LC(ch)) {
1721 else if (ch == '\r') {
1725 else if (ch == '\f') {
1729 else if (ch == '\\') {
1733 else if (ch == '\0') {
1737 else if (isPRINT_LC(ch))
1754 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1755 "Argument \"%s\" isn't numeric in %s", pv,
1758 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1759 "Argument \"%s\" isn't numeric", pv);
1763 =for apidoc looks_like_number
1765 Test if the content of an SV looks like a number (or is a number).
1766 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1767 non-numeric warning), even if your atof() doesn't grok them.
1773 Perl_looks_like_number(pTHX_ SV *const sv)
1775 register const char *sbegin;
1778 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1781 sbegin = SvPVX_const(sv);
1784 else if (SvPOKp(sv))
1785 sbegin = SvPV_const(sv, len);
1787 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1788 return grok_number(sbegin, len, NULL);
1792 S_glob_2number(pTHX_ GV * const gv)
1794 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1795 SV *const buffer = sv_newmortal();
1797 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1799 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1802 gv_efullname3(buffer, gv, "*");
1803 SvFLAGS(gv) |= wasfake;
1805 /* We know that all GVs stringify to something that is not-a-number,
1806 so no need to test that. */
1807 if (ckWARN(WARN_NUMERIC))
1808 not_a_number(buffer);
1809 /* We just want something true to return, so that S_sv_2iuv_common
1810 can tail call us and return true. */
1815 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1817 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1818 SV *const buffer = sv_newmortal();
1820 PERL_ARGS_ASSERT_GLOB_2PV;
1822 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1825 gv_efullname3(buffer, gv, "*");
1826 SvFLAGS(gv) |= wasfake;
1828 assert(SvPOK(buffer));
1830 *len = SvCUR(buffer);
1832 return SvPVX(buffer);
1835 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1836 until proven guilty, assume that things are not that bad... */
1841 As 64 bit platforms often have an NV that doesn't preserve all bits of
1842 an IV (an assumption perl has been based on to date) it becomes necessary
1843 to remove the assumption that the NV always carries enough precision to
1844 recreate the IV whenever needed, and that the NV is the canonical form.
1845 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1846 precision as a side effect of conversion (which would lead to insanity
1847 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1848 1) to distinguish between IV/UV/NV slots that have cached a valid
1849 conversion where precision was lost and IV/UV/NV slots that have a
1850 valid conversion which has lost no precision
1851 2) to ensure that if a numeric conversion to one form is requested that
1852 would lose precision, the precise conversion (or differently
1853 imprecise conversion) is also performed and cached, to prevent
1854 requests for different numeric formats on the same SV causing
1855 lossy conversion chains. (lossless conversion chains are perfectly
1860 SvIOKp is true if the IV slot contains a valid value
1861 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1862 SvNOKp is true if the NV slot contains a valid value
1863 SvNOK is true only if the NV value is accurate
1866 while converting from PV to NV, check to see if converting that NV to an
1867 IV(or UV) would lose accuracy over a direct conversion from PV to
1868 IV(or UV). If it would, cache both conversions, return NV, but mark
1869 SV as IOK NOKp (ie not NOK).
1871 While converting from PV to IV, check to see if converting that IV to an
1872 NV would lose accuracy over a direct conversion from PV to NV. If it
1873 would, cache both conversions, flag similarly.
1875 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1876 correctly because if IV & NV were set NV *always* overruled.
1877 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1878 changes - now IV and NV together means that the two are interchangeable:
1879 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1881 The benefit of this is that operations such as pp_add know that if
1882 SvIOK is true for both left and right operands, then integer addition
1883 can be used instead of floating point (for cases where the result won't
1884 overflow). Before, floating point was always used, which could lead to
1885 loss of precision compared with integer addition.
1887 * making IV and NV equal status should make maths accurate on 64 bit
1889 * may speed up maths somewhat if pp_add and friends start to use
1890 integers when possible instead of fp. (Hopefully the overhead in
1891 looking for SvIOK and checking for overflow will not outweigh the
1892 fp to integer speedup)
1893 * will slow down integer operations (callers of SvIV) on "inaccurate"
1894 values, as the change from SvIOK to SvIOKp will cause a call into
1895 sv_2iv each time rather than a macro access direct to the IV slot
1896 * should speed up number->string conversion on integers as IV is
1897 favoured when IV and NV are equally accurate
1899 ####################################################################
1900 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1901 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1902 On the other hand, SvUOK is true iff UV.
1903 ####################################################################
1905 Your mileage will vary depending your CPU's relative fp to integer
1909 #ifndef NV_PRESERVES_UV
1910 # define IS_NUMBER_UNDERFLOW_IV 1
1911 # define IS_NUMBER_UNDERFLOW_UV 2
1912 # define IS_NUMBER_IV_AND_UV 2
1913 # define IS_NUMBER_OVERFLOW_IV 4
1914 # define IS_NUMBER_OVERFLOW_UV 5
1916 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1918 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1920 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1928 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1930 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1931 if (SvNVX(sv) < (NV)IV_MIN) {
1932 (void)SvIOKp_on(sv);
1934 SvIV_set(sv, IV_MIN);
1935 return IS_NUMBER_UNDERFLOW_IV;
1937 if (SvNVX(sv) > (NV)UV_MAX) {
1938 (void)SvIOKp_on(sv);
1941 SvUV_set(sv, UV_MAX);
1942 return IS_NUMBER_OVERFLOW_UV;
1944 (void)SvIOKp_on(sv);
1946 /* Can't use strtol etc to convert this string. (See truth table in
1948 if (SvNVX(sv) <= (UV)IV_MAX) {
1949 SvIV_set(sv, I_V(SvNVX(sv)));
1950 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1951 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1953 /* Integer is imprecise. NOK, IOKp */
1955 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1958 SvUV_set(sv, U_V(SvNVX(sv)));
1959 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1960 if (SvUVX(sv) == UV_MAX) {
1961 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1962 possibly be preserved by NV. Hence, it must be overflow.
1964 return IS_NUMBER_OVERFLOW_UV;
1966 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1968 /* Integer is imprecise. NOK, IOKp */
1970 return IS_NUMBER_OVERFLOW_IV;
1972 #endif /* !NV_PRESERVES_UV*/
1975 S_sv_2iuv_common(pTHX_ SV *const sv)
1979 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1993 certainly cast into the IV range at IV_MAX, whereas the correct
1994 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1996 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1997 if (Perl_isnan(SvNVX(sv))) {
2003 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2004 SvIV_set(sv, I_V(SvNVX(sv)));
2005 if (SvNVX(sv) == (NV) SvIVX(sv)
2006 #ifndef NV_PRESERVES_UV
2007 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2008 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2009 /* Don't flag it as "accurately an integer" if the number
2010 came from a (by definition imprecise) NV operation, and
2011 we're outside the range of NV integer precision */
2015 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2017 /* scalar has trailing garbage, eg "42a" */
2019 DEBUG_c(PerlIO_printf(Perl_debug_log,
2020 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2026 /* IV not precise. No need to convert from PV, as NV
2027 conversion would already have cached IV if it detected
2028 that PV->IV would be better than PV->NV->IV
2029 flags already correct - don't set public IOK. */
2030 DEBUG_c(PerlIO_printf(Perl_debug_log,
2031 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2036 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2037 but the cast (NV)IV_MIN rounds to a the value less (more
2038 negative) than IV_MIN which happens to be equal to SvNVX ??
2039 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2040 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2041 (NV)UVX == NVX are both true, but the values differ. :-(
2042 Hopefully for 2s complement IV_MIN is something like
2043 0x8000000000000000 which will be exact. NWC */
2046 SvUV_set(sv, U_V(SvNVX(sv)));
2048 (SvNVX(sv) == (NV) SvUVX(sv))
2049 #ifndef NV_PRESERVES_UV
2050 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2051 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2052 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2053 /* Don't flag it as "accurately an integer" if the number
2054 came from a (by definition imprecise) NV operation, and
2055 we're outside the range of NV integer precision */
2061 DEBUG_c(PerlIO_printf(Perl_debug_log,
2062 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2068 else if (SvPOKp(sv) && SvLEN(sv)) {
2070 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2071 /* We want to avoid a possible problem when we cache an IV/ a UV which
2072 may be later translated to an NV, and the resulting NV is not
2073 the same as the direct translation of the initial string
2074 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2075 be careful to ensure that the value with the .456 is around if the
2076 NV value is requested in the future).
2078 This means that if we cache such an IV/a UV, we need to cache the
2079 NV as well. Moreover, we trade speed for space, and do not
2080 cache the NV if we are sure it's not needed.
2083 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2084 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2085 == IS_NUMBER_IN_UV) {
2086 /* It's definitely an integer, only upgrade to PVIV */
2087 if (SvTYPE(sv) < SVt_PVIV)
2088 sv_upgrade(sv, SVt_PVIV);
2090 } else if (SvTYPE(sv) < SVt_PVNV)
2091 sv_upgrade(sv, SVt_PVNV);
2093 /* If NVs preserve UVs then we only use the UV value if we know that
2094 we aren't going to call atof() below. If NVs don't preserve UVs
2095 then the value returned may have more precision than atof() will
2096 return, even though value isn't perfectly accurate. */
2097 if ((numtype & (IS_NUMBER_IN_UV
2098 #ifdef NV_PRESERVES_UV
2101 )) == IS_NUMBER_IN_UV) {
2102 /* This won't turn off the public IOK flag if it was set above */
2103 (void)SvIOKp_on(sv);
2105 if (!(numtype & IS_NUMBER_NEG)) {
2107 if (value <= (UV)IV_MAX) {
2108 SvIV_set(sv, (IV)value);
2110 /* it didn't overflow, and it was positive. */
2111 SvUV_set(sv, value);
2115 /* 2s complement assumption */
2116 if (value <= (UV)IV_MIN) {
2117 SvIV_set(sv, -(IV)value);
2119 /* Too negative for an IV. This is a double upgrade, but
2120 I'm assuming it will be rare. */
2121 if (SvTYPE(sv) < SVt_PVNV)
2122 sv_upgrade(sv, SVt_PVNV);
2126 SvNV_set(sv, -(NV)value);
2127 SvIV_set(sv, IV_MIN);
2131 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2132 will be in the previous block to set the IV slot, and the next
2133 block to set the NV slot. So no else here. */
2135 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2136 != IS_NUMBER_IN_UV) {
2137 /* It wasn't an (integer that doesn't overflow the UV). */
2138 SvNV_set(sv, Atof(SvPVX_const(sv)));
2140 if (! numtype && ckWARN(WARN_NUMERIC))
2143 #if defined(USE_LONG_DOUBLE)
2144 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2145 PTR2UV(sv), SvNVX(sv)));
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2151 #ifdef NV_PRESERVES_UV
2152 (void)SvIOKp_on(sv);
2154 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2155 SvIV_set(sv, I_V(SvNVX(sv)));
2156 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2159 NOOP; /* Integer is imprecise. NOK, IOKp */
2161 /* UV will not work better than IV */
2163 if (SvNVX(sv) > (NV)UV_MAX) {
2165 /* Integer is inaccurate. NOK, IOKp, is UV */
2166 SvUV_set(sv, UV_MAX);
2168 SvUV_set(sv, U_V(SvNVX(sv)));
2169 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2170 NV preservse UV so can do correct comparison. */
2171 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2174 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2179 #else /* NV_PRESERVES_UV */
2180 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2181 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2182 /* The IV/UV slot will have been set from value returned by
2183 grok_number above. The NV slot has just been set using
2186 assert (SvIOKp(sv));
2188 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2189 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2190 /* Small enough to preserve all bits. */
2191 (void)SvIOKp_on(sv);
2193 SvIV_set(sv, I_V(SvNVX(sv)));
2194 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2196 /* Assumption: first non-preserved integer is < IV_MAX,
2197 this NV is in the preserved range, therefore: */
2198 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2200 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2204 0 0 already failed to read UV.
2205 0 1 already failed to read UV.
2206 1 0 you won't get here in this case. IV/UV
2207 slot set, public IOK, Atof() unneeded.
2208 1 1 already read UV.
2209 so there's no point in sv_2iuv_non_preserve() attempting
2210 to use atol, strtol, strtoul etc. */
2212 sv_2iuv_non_preserve (sv, numtype);
2214 sv_2iuv_non_preserve (sv);
2218 #endif /* NV_PRESERVES_UV */
2219 /* It might be more code efficient to go through the entire logic above
2220 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2221 gets complex and potentially buggy, so more programmer efficient
2222 to do it this way, by turning off the public flags: */
2224 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2228 if (isGV_with_GP(sv))
2229 return glob_2number((GV *)sv);
2231 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2232 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2235 if (SvTYPE(sv) < SVt_IV)
2236 /* Typically the caller expects that sv_any is not NULL now. */
2237 sv_upgrade(sv, SVt_IV);
2238 /* Return 0 from the caller. */
2245 =for apidoc sv_2iv_flags
2247 Return the integer value of an SV, doing any necessary string
2248 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2249 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2255 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2260 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2261 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2262 cache IVs just in case. In practice it seems that they never
2263 actually anywhere accessible by user Perl code, let alone get used
2264 in anything other than a string context. */
2265 if (flags & SV_GMAGIC)
2270 return I_V(SvNVX(sv));
2272 if (SvPOKp(sv) && SvLEN(sv)) {
2275 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2278 == IS_NUMBER_IN_UV) {
2279 /* It's definitely an integer */
2280 if (numtype & IS_NUMBER_NEG) {
2281 if (value < (UV)IV_MIN)
2284 if (value < (UV)IV_MAX)
2289 if (ckWARN(WARN_NUMERIC))
2292 return I_V(Atof(SvPVX_const(sv)));
2297 assert(SvTYPE(sv) >= SVt_PVMG);
2298 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2299 } else if (SvTHINKFIRST(sv)) {
2303 SV * const tmpstr=AMG_CALLun(sv,numer);
2304 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2305 return SvIV(tmpstr);
2308 return PTR2IV(SvRV(sv));
2311 sv_force_normal_flags(sv, 0);
2313 if (SvREADONLY(sv) && !SvOK(sv)) {
2314 if (ckWARN(WARN_UNINITIALIZED))
2320 if (S_sv_2iuv_common(aTHX_ sv))
2323 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2324 PTR2UV(sv),SvIVX(sv)));
2325 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2329 =for apidoc sv_2uv_flags
2331 Return the unsigned integer value of an SV, doing any necessary string
2332 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2333 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2339 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2344 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2345 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2346 cache IVs just in case. */
2347 if (flags & SV_GMAGIC)
2352 return U_V(SvNVX(sv));
2353 if (SvPOKp(sv) && SvLEN(sv)) {
2356 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2358 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2359 == IS_NUMBER_IN_UV) {
2360 /* It's definitely an integer */
2361 if (!(numtype & IS_NUMBER_NEG))
2365 if (ckWARN(WARN_NUMERIC))
2368 return U_V(Atof(SvPVX_const(sv)));
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2375 } else if (SvTHINKFIRST(sv)) {
2379 SV *const tmpstr = AMG_CALLun(sv,numer);
2380 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2381 return SvUV(tmpstr);
2384 return PTR2UV(SvRV(sv));
2387 sv_force_normal_flags(sv, 0);
2389 if (SvREADONLY(sv) && !SvOK(sv)) {
2390 if (ckWARN(WARN_UNINITIALIZED))
2396 if (S_sv_2iuv_common(aTHX_ sv))
2400 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2401 PTR2UV(sv),SvUVX(sv)));
2402 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2408 Return the num value of an SV, doing any necessary string or integer
2409 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2416 Perl_sv_2nv(pTHX_ register SV *const sv)
2421 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2422 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2423 cache IVs just in case. */
2427 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2428 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2429 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2431 return Atof(SvPVX_const(sv));
2435 return (NV)SvUVX(sv);
2437 return (NV)SvIVX(sv);
2442 assert(SvTYPE(sv) >= SVt_PVMG);
2443 /* This falls through to the report_uninit near the end of the
2445 } else if (SvTHINKFIRST(sv)) {
2449 SV *const tmpstr = AMG_CALLun(sv,numer);
2450 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 return SvNV(tmpstr);
2454 return PTR2NV(SvRV(sv));
2457 sv_force_normal_flags(sv, 0);
2459 if (SvREADONLY(sv) && !SvOK(sv)) {
2460 if (ckWARN(WARN_UNINITIALIZED))
2465 if (SvTYPE(sv) < SVt_NV) {
2466 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2467 sv_upgrade(sv, SVt_NV);
2468 #ifdef USE_LONG_DOUBLE
2470 STORE_NUMERIC_LOCAL_SET_STANDARD();
2471 PerlIO_printf(Perl_debug_log,
2472 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2473 PTR2UV(sv), SvNVX(sv));
2474 RESTORE_NUMERIC_LOCAL();
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2480 PTR2UV(sv), SvNVX(sv));
2481 RESTORE_NUMERIC_LOCAL();
2485 else if (SvTYPE(sv) < SVt_PVNV)
2486 sv_upgrade(sv, SVt_PVNV);
2491 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2492 #ifdef NV_PRESERVES_UV
2498 /* Only set the public NV OK flag if this NV preserves the IV */
2499 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2501 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2502 : (SvIVX(sv) == I_V(SvNVX(sv))))
2508 else if (SvPOKp(sv) && SvLEN(sv)) {
2510 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2511 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2513 #ifdef NV_PRESERVES_UV
2514 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2515 == IS_NUMBER_IN_UV) {
2516 /* It's definitely an integer */
2517 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2519 SvNV_set(sv, Atof(SvPVX_const(sv)));
2525 SvNV_set(sv, Atof(SvPVX_const(sv)));
2526 /* Only set the public NV OK flag if this NV preserves the value in
2527 the PV at least as well as an IV/UV would.
2528 Not sure how to do this 100% reliably. */
2529 /* if that shift count is out of range then Configure's test is
2530 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2532 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2533 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2534 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2535 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2536 /* Can't use strtol etc to convert this string, so don't try.
2537 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2540 /* value has been set. It may not be precise. */
2541 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2542 /* 2s complement assumption for (UV)IV_MIN */
2543 SvNOK_on(sv); /* Integer is too negative. */
2548 if (numtype & IS_NUMBER_NEG) {
2549 SvIV_set(sv, -(IV)value);
2550 } else if (value <= (UV)IV_MAX) {
2551 SvIV_set(sv, (IV)value);
2553 SvUV_set(sv, value);
2557 if (numtype & IS_NUMBER_NOT_INT) {
2558 /* I believe that even if the original PV had decimals,
2559 they are lost beyond the limit of the FP precision.
2560 However, neither is canonical, so both only get p
2561 flags. NWC, 2000/11/25 */
2562 /* Both already have p flags, so do nothing */
2564 const NV nv = SvNVX(sv);
2565 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2566 if (SvIVX(sv) == I_V(nv)) {
2569 /* It had no "." so it must be integer. */
2573 /* between IV_MAX and NV(UV_MAX).
2574 Could be slightly > UV_MAX */
2576 if (numtype & IS_NUMBER_NOT_INT) {
2577 /* UV and NV both imprecise. */
2579 const UV nv_as_uv = U_V(nv);
2581 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2590 /* It might be more code efficient to go through the entire logic above
2591 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2592 gets complex and potentially buggy, so more programmer efficient
2593 to do it this way, by turning off the public flags: */
2595 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2596 #endif /* NV_PRESERVES_UV */
2599 if (isGV_with_GP(sv)) {
2600 glob_2number((GV *)sv);
2604 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2606 assert (SvTYPE(sv) >= SVt_NV);
2607 /* Typically the caller expects that sv_any is not NULL now. */
2608 /* XXX Ilya implies that this is a bug in callers that assume this
2609 and ideally should be fixed. */
2612 #if defined(USE_LONG_DOUBLE)
2614 STORE_NUMERIC_LOCAL_SET_STANDARD();
2615 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2616 PTR2UV(sv), SvNVX(sv));
2617 RESTORE_NUMERIC_LOCAL();
2621 STORE_NUMERIC_LOCAL_SET_STANDARD();
2622 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2623 PTR2UV(sv), SvNVX(sv));
2624 RESTORE_NUMERIC_LOCAL();
2633 Return an SV with the numeric value of the source SV, doing any necessary
2634 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2635 access this function.
2641 Perl_sv_2num(pTHX_ register SV *const sv)
2643 PERL_ARGS_ASSERT_SV_2NUM;
2648 SV * const tmpsv = AMG_CALLun(sv,numer);
2649 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2650 return sv_2num(tmpsv);
2652 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2655 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2656 * UV as a string towards the end of buf, and return pointers to start and
2659 * We assume that buf is at least TYPE_CHARS(UV) long.
2663 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2665 char *ptr = buf + TYPE_CHARS(UV);
2666 char * const ebuf = ptr;
2669 PERL_ARGS_ASSERT_UIV_2BUF;
2681 *--ptr = '0' + (char)(uv % 10);
2690 =for apidoc sv_2pv_flags
2692 Returns a pointer to the string value of an SV, and sets *lp to its length.
2693 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2695 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2696 usually end up here too.
2702 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2712 if (SvGMAGICAL(sv)) {
2713 if (flags & SV_GMAGIC)
2718 if (flags & SV_MUTABLE_RETURN)
2719 return SvPVX_mutable(sv);
2720 if (flags & SV_CONST_RETURN)
2721 return (char *)SvPVX_const(sv);
2724 if (SvIOKp(sv) || SvNOKp(sv)) {
2725 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2730 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2731 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2733 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2740 #ifdef FIXNEGATIVEZERO
2741 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2747 SvUPGRADE(sv, SVt_PV);
2750 s = SvGROW_mutable(sv, len + 1);
2753 return (char*)memcpy(s, tbuf, len + 1);
2759 assert(SvTYPE(sv) >= SVt_PVMG);
2760 /* This falls through to the report_uninit near the end of the
2762 } else if (SvTHINKFIRST(sv)) {
2766 SV *const tmpstr = AMG_CALLun(sv,string);
2767 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2769 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2773 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2774 if (flags & SV_CONST_RETURN) {
2775 pv = (char *) SvPVX_const(tmpstr);
2777 pv = (flags & SV_MUTABLE_RETURN)
2778 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2781 *lp = SvCUR(tmpstr);
2783 pv = sv_2pv_flags(tmpstr, lp, flags);
2796 const SV *const referent = (SV*)SvRV(sv);
2800 retval = buffer = savepvn("NULLREF", len);
2801 } else if (SvTYPE(referent) == SVt_REGEXP) {
2802 const REGEXP * const re = (REGEXP *)referent;
2807 /* If the regex is UTF-8 we want the containing scalar to
2808 have an UTF-8 flag too */
2814 if ((seen_evals = RX_SEEN_EVALS(re)))
2815 PL_reginterp_cnt += seen_evals;
2818 *lp = RX_WRAPLEN(re);
2820 return RX_WRAPPED(re);
2822 const char *const typestr = sv_reftype(referent, 0);
2823 const STRLEN typelen = strlen(typestr);
2824 UV addr = PTR2UV(referent);
2825 const char *stashname = NULL;
2826 STRLEN stashnamelen = 0; /* hush, gcc */
2827 const char *buffer_end;
2829 if (SvOBJECT(referent)) {
2830 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2833 stashname = HEK_KEY(name);
2834 stashnamelen = HEK_LEN(name);
2836 if (HEK_UTF8(name)) {
2842 stashname = "__ANON__";
2845 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2846 + 2 * sizeof(UV) + 2 /* )\0 */;
2848 len = typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2852 Newx(buffer, len, char);
2853 buffer_end = retval = buffer + len;
2855 /* Working backwards */
2859 *--retval = PL_hexdigit[addr & 15];
2860 } while (addr >>= 4);
2866 memcpy(retval, typestr, typelen);
2870 retval -= stashnamelen;
2871 memcpy(retval, stashname, stashnamelen);
2873 /* retval may not neccesarily have reached the start of the
2875 assert (retval >= buffer);
2877 len = buffer_end - retval - 1; /* -1 for that \0 */
2885 if (SvREADONLY(sv) && !SvOK(sv)) {
2888 if (flags & SV_UNDEF_RETURNS_NULL)
2890 if (ckWARN(WARN_UNINITIALIZED))
2895 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2896 /* I'm assuming that if both IV and NV are equally valid then
2897 converting the IV is going to be more efficient */
2898 const U32 isUIOK = SvIsUV(sv);
2899 char buf[TYPE_CHARS(UV)];
2903 if (SvTYPE(sv) < SVt_PVIV)
2904 sv_upgrade(sv, SVt_PVIV);
2905 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2907 /* inlined from sv_setpvn */
2908 s = SvGROW_mutable(sv, len + 1);
2909 Move(ptr, s, len, char);
2913 else if (SvNOKp(sv)) {
2914 const int olderrno = errno;
2915 if (SvTYPE(sv) < SVt_PVNV)
2916 sv_upgrade(sv, SVt_PVNV);
2917 /* The +20 is pure guesswork. Configure test needed. --jhi */
2918 s = SvGROW_mutable(sv, NV_DIG + 20);
2919 /* some Xenix systems wipe out errno here */
2921 if (SvNVX(sv) == 0.0)
2922 my_strlcpy(s, "0", SvLEN(sv));
2926 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2929 #ifdef FIXNEGATIVEZERO
2930 if (*s == '-' && s[1] == '0' && !s[2]) {
2942 if (isGV_with_GP(sv))
2943 return glob_2pv((GV *)sv, lp);
2947 if (flags & SV_UNDEF_RETURNS_NULL)
2949 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2951 if (SvTYPE(sv) < SVt_PV)
2952 /* Typically the caller expects that sv_any is not NULL now. */
2953 sv_upgrade(sv, SVt_PV);
2957 const STRLEN len = s - SvPVX_const(sv);
2963 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2964 PTR2UV(sv),SvPVX_const(sv)));
2965 if (flags & SV_CONST_RETURN)
2966 return (char *)SvPVX_const(sv);
2967 if (flags & SV_MUTABLE_RETURN)
2968 return SvPVX_mutable(sv);
2973 =for apidoc sv_copypv
2975 Copies a stringified representation of the source SV into the
2976 destination SV. Automatically performs any necessary mg_get and
2977 coercion of numeric values into strings. Guaranteed to preserve
2978 UTF8 flag even from overloaded objects. Similar in nature to
2979 sv_2pv[_flags] but operates directly on an SV instead of just the
2980 string. Mostly uses sv_2pv_flags to do its work, except when that
2981 would lose the UTF-8'ness of the PV.
2987 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2990 const char * const s = SvPV_const(ssv,len);
2992 PERL_ARGS_ASSERT_SV_COPYPV;
2994 sv_setpvn(dsv,s,len);
3002 =for apidoc sv_2pvbyte
3004 Return a pointer to the byte-encoded representation of the SV, and set *lp
3005 to its length. May cause the SV to be downgraded from UTF-8 as a
3008 Usually accessed via the C<SvPVbyte> macro.
3014 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3016 PERL_ARGS_ASSERT_SV_2PVBYTE;
3018 sv_utf8_downgrade(sv,0);
3019 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3023 =for apidoc sv_2pvutf8
3025 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3026 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3028 Usually accessed via the C<SvPVutf8> macro.
3034 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3036 PERL_ARGS_ASSERT_SV_2PVUTF8;
3038 sv_utf8_upgrade(sv);
3039 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3044 =for apidoc sv_2bool
3046 This function is only called on magical items, and is only used by
3047 sv_true() or its macro equivalent.
3053 Perl_sv_2bool(pTHX_ register SV *const sv)
3057 PERL_ARGS_ASSERT_SV_2BOOL;
3065 SV * const tmpsv = AMG_CALLun(sv,bool_);
3066 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3067 return (bool)SvTRUE(tmpsv);
3069 return SvRV(sv) != 0;
3072 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3074 (*sv->sv_u.svu_pv > '0' ||
3075 Xpvtmp->xpv_cur > 1 ||
3076 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3083 return SvIVX(sv) != 0;
3086 return SvNVX(sv) != 0.0;
3088 if (isGV_with_GP(sv))
3098 =for apidoc sv_utf8_upgrade
3100 Converts the PV of an SV to its UTF-8-encoded form.
3101 Forces the SV to string form if it is not already.
3102 Always sets the SvUTF8 flag to avoid future validity checks even
3103 if all the bytes have hibit clear.
3105 This is not as a general purpose byte encoding to Unicode interface:
3106 use the Encode extension for that.
3108 =for apidoc sv_utf8_upgrade_flags
3110 Converts the PV of an SV to its UTF-8-encoded form.
3111 Forces the SV to string form if it is not already.
3112 Always sets the SvUTF8 flag to avoid future validity checks even
3113 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3114 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3115 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3117 This is not as a general purpose byte encoding to Unicode interface:
3118 use the Encode extension for that.
3124 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3128 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3130 if (sv == &PL_sv_undef)
3134 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3135 (void) sv_2pv_flags(sv,&len, flags);
3139 (void) SvPV_force(sv,len);
3148 sv_force_normal_flags(sv, 0);
3151 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3152 sv_recode_to_utf8(sv, PL_encoding);
3153 else { /* Assume Latin-1/EBCDIC */
3154 /* This function could be much more efficient if we
3155 * had a FLAG in SVs to signal if there are any hibit
3156 * chars in the PV. Given that there isn't such a flag
3157 * make the loop as fast as possible. */
3158 const U8 * const s = (U8 *) SvPVX_const(sv);
3159 const U8 * const e = (U8 *) SvEND(sv);
3164 /* Check for hi bit */
3165 if (!NATIVE_IS_INVARIANT(ch)) {
3166 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3167 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3169 SvPV_free(sv); /* No longer using what was there before. */
3170 SvPV_set(sv, (char*)recoded);
3171 SvCUR_set(sv, len - 1);
3172 SvLEN_set(sv, len); /* No longer know the real size. */
3176 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3183 =for apidoc sv_utf8_downgrade
3185 Attempts to convert the PV of an SV from characters to bytes.
3186 If the PV contains a character beyond byte, this conversion will fail;
3187 in this case, either returns false or, if C<fail_ok> is not
3190 This is not as a general purpose Unicode to byte encoding interface:
3191 use the Encode extension for that.
3197 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3201 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3203 if (SvPOKp(sv) && SvUTF8(sv)) {
3209 sv_force_normal_flags(sv, 0);
3211 s = (U8 *) SvPV(sv, len);
3212 if (!utf8_to_bytes(s, &len)) {
3217 Perl_croak(aTHX_ "Wide character in %s",
3220 Perl_croak(aTHX_ "Wide character");
3231 =for apidoc sv_utf8_encode
3233 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3234 flag off so that it looks like octets again.
3240 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3242 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3245 sv_force_normal_flags(sv, 0);
3247 if (SvREADONLY(sv)) {
3248 Perl_croak(aTHX_ PL_no_modify);
3250 (void) sv_utf8_upgrade(sv);
3255 =for apidoc sv_utf8_decode
3257 If the PV of the SV is an octet sequence in UTF-8
3258 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3259 so that it looks like a character. If the PV contains only single-byte
3260 characters, the C<SvUTF8> flag stays being off.
3261 Scans PV for validity and returns false if the PV is invalid UTF-8.
3267 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3269 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3275 /* The octets may have got themselves encoded - get them back as
3278 if (!sv_utf8_downgrade(sv, TRUE))
3281 /* it is actually just a matter of turning the utf8 flag on, but
3282 * we want to make sure everything inside is valid utf8 first.
3284 c = (const U8 *) SvPVX_const(sv);
3285 if (!is_utf8_string(c, SvCUR(sv)+1))
3287 e = (const U8 *) SvEND(sv);
3290 if (!UTF8_IS_INVARIANT(ch)) {
3300 =for apidoc sv_setsv
3302 Copies the contents of the source SV C<ssv> into the destination SV
3303 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3304 function if the source SV needs to be reused. Does not handle 'set' magic.
3305 Loosely speaking, it performs a copy-by-value, obliterating any previous
3306 content of the destination.
3308 You probably want to use one of the assortment of wrappers, such as
3309 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3310 C<SvSetMagicSV_nosteal>.
3312 =for apidoc sv_setsv_flags
3314 Copies the contents of the source SV C<ssv> into the destination SV
3315 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3316 function if the source SV needs to be reused. Does not handle 'set' magic.
3317 Loosely speaking, it performs a copy-by-value, obliterating any previous
3318 content of the destination.
3319 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3320 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3321 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3322 and C<sv_setsv_nomg> are implemented in terms of this function.
3324 You probably want to use one of the assortment of wrappers, such as
3325 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3326 C<SvSetMagicSV_nosteal>.
3328 This is the primary function for copying scalars, and most other
3329 copy-ish functions and macros use this underneath.
3335 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3337 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3339 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3341 if (dtype != SVt_PVGV) {
3342 const char * const name = GvNAME(sstr);
3343 const STRLEN len = GvNAMELEN(sstr);
3345 if (dtype >= SVt_PV) {
3351 SvUPGRADE(dstr, SVt_PVGV);
3352 (void)SvOK_off(dstr);
3353 /* FIXME - why are we doing this, then turning it off and on again
3355 isGV_with_GP_on(dstr);
3357 GvSTASH(dstr) = GvSTASH(sstr);
3359 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3360 gv_name_set((GV *)dstr, name, len, GV_ADD);
3361 SvFAKE_on(dstr); /* can coerce to non-glob */
3364 #ifdef GV_UNIQUE_CHECK
3365 if (GvUNIQUE((GV*)dstr)) {
3366 Perl_croak(aTHX_ PL_no_modify);
3370 if(GvGP((GV*)sstr)) {
3371 /* If source has method cache entry, clear it */
3373 SvREFCNT_dec(GvCV(sstr));
3377 /* If source has a real method, then a method is
3379 else if(GvCV((GV*)sstr)) {
3384 /* If dest already had a real method, that's a change as well */
3385 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3389 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3393 isGV_with_GP_off(dstr);
3394 (void)SvOK_off(dstr);
3395 isGV_with_GP_on(dstr);
3396 GvINTRO_off(dstr); /* one-shot flag */
3397 GvGP(dstr) = gp_ref(GvGP(sstr));
3398 if (SvTAINTED(sstr))
3400 if (GvIMPORTED(dstr) != GVf_IMPORTED
3401 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3403 GvIMPORTED_on(dstr);
3406 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3407 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3412 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3414 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3416 const int intro = GvINTRO(dstr);
3419 const U32 stype = SvTYPE(sref);
3421 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3423 #ifdef GV_UNIQUE_CHECK
3424 if (GvUNIQUE((GV*)dstr)) {
3425 Perl_croak(aTHX_ PL_no_modify);
3430 GvINTRO_off(dstr); /* one-shot flag */
3431 GvLINE(dstr) = CopLINE(PL_curcop);
3432 GvEGV(dstr) = (GV*)dstr;
3437 location = (SV **) &GvCV(dstr);
3438 import_flag = GVf_IMPORTED_CV;
3441 location = (SV **) &GvHV(dstr);
3442 import_flag = GVf_IMPORTED_HV;
3445 location = (SV **) &GvAV(dstr);
3446 import_flag = GVf_IMPORTED_AV;
3449 location = (SV **) &GvIOp(dstr);
3452 location = (SV **) &GvFORM(dstr);
3454 location = &GvSV(dstr);
3455 import_flag = GVf_IMPORTED_SV;
3458 if (stype == SVt_PVCV) {
3459 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3460 if (GvCVGEN(dstr)) {
3461 SvREFCNT_dec(GvCV(dstr));
3463 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3466 SAVEGENERICSV(*location);
3470 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3471 CV* const cv = (CV*)*location;
3473 if (!GvCVGEN((GV*)dstr) &&
3474 (CvROOT(cv) || CvXSUB(cv)))
3476 /* Redefining a sub - warning is mandatory if
3477 it was a const and its value changed. */
3478 if (CvCONST(cv) && CvCONST((CV*)sref)
3479 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3481 /* They are 2 constant subroutines generated from
3482 the same constant. This probably means that
3483 they are really the "same" proxy subroutine
3484 instantiated in 2 places. Most likely this is
3485 when a constant is exported twice. Don't warn.
3488 else if (ckWARN(WARN_REDEFINE)
3490 && (!CvCONST((CV*)sref)
3491 || sv_cmp(cv_const_sv(cv),
3492 cv_const_sv((CV*)sref))))) {
3493 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3496 ? "Constant subroutine %s::%s redefined"
3497 : "Subroutine %s::%s redefined"),
3498 HvNAME_get(GvSTASH((GV*)dstr)),
3499 GvENAME((GV*)dstr));
3503 cv_ckproto_len(cv, (GV*)dstr,
3504 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3505 SvPOK(sref) ? SvCUR(sref) : 0);
3507 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3508 GvASSUMECV_on(dstr);
3509 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3512 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3513 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3514 GvFLAGS(dstr) |= import_flag;
3519 if (SvTAINTED(sstr))
3525 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3528 register U32 sflags;
3530 register svtype stype;
3532 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3537 if (SvIS_FREED(dstr)) {
3538 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3539 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3541 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3543 sstr = &PL_sv_undef;
3544 if (SvIS_FREED(sstr)) {
3545 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3546 (void*)sstr, (void*)dstr);
3548 stype = SvTYPE(sstr);
3549 dtype = SvTYPE(dstr);
3551 (void)SvAMAGIC_off(dstr);
3554 /* need to nuke the magic */
3556 SvRMAGICAL_off(dstr);
3559 /* There's a lot of redundancy below but we're going for speed here */
3564 if (dtype != SVt_PVGV) {
3565 (void)SvOK_off(dstr);
3573 sv_upgrade(dstr, SVt_IV);
3577 sv_upgrade(dstr, SVt_PVIV);
3580 goto end_of_first_switch;
3582 (void)SvIOK_only(dstr);
3583 SvIV_set(dstr, SvIVX(sstr));
3586 /* SvTAINTED can only be true if the SV has taint magic, which in
3587 turn means that the SV type is PVMG (or greater). This is the
3588 case statement for SVt_IV, so this cannot be true (whatever gcov
3590 assert(!SvTAINTED(sstr));
3595 if (dtype < SVt_PV && dtype != SVt_IV)
3596 sv_upgrade(dstr, SVt_IV);
3604 sv_upgrade(dstr, SVt_NV);
3608 sv_upgrade(dstr, SVt_PVNV);
3611 goto end_of_first_switch;
3613 SvNV_set(dstr, SvNVX(sstr));
3614 (void)SvNOK_only(dstr);
3615 /* SvTAINTED can only be true if the SV has taint magic, which in
3616 turn means that the SV type is PVMG (or greater). This is the
3617 case statement for SVt_NV, so this cannot be true (whatever gcov
3619 assert(!SvTAINTED(sstr));
3625 #ifdef PERL_OLD_COPY_ON_WRITE
3626 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3627 if (dtype < SVt_PVIV)
3628 sv_upgrade(dstr, SVt_PVIV);
3636 sv_upgrade(dstr, SVt_PV);
3639 if (dtype < SVt_PVIV)
3640 sv_upgrade(dstr, SVt_PVIV);
3643 if (dtype < SVt_PVNV)
3644 sv_upgrade(dstr, SVt_PVNV);
3648 const char * const type = sv_reftype(sstr,0);
3650 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3652 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3656 /* case SVt_BIND: */
3659 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3660 glob_assign_glob(dstr, sstr, dtype);
3663 /* SvVALID means that this PVGV is playing at being an FBM. */
3667 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3669 if (SvTYPE(sstr) != stype) {
3670 stype = SvTYPE(sstr);
3671 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3672 glob_assign_glob(dstr, sstr, dtype);
3677 if (stype == SVt_PVLV)
3678 SvUPGRADE(dstr, SVt_PVNV);
3680 SvUPGRADE(dstr, (svtype)stype);
3682 end_of_first_switch:
3684 /* dstr may have been upgraded. */
3685 dtype = SvTYPE(dstr);
3686 sflags = SvFLAGS(sstr);
3688 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3689 /* Assigning to a subroutine sets the prototype. */
3692 const char *const ptr = SvPV_const(sstr, len);
3694 SvGROW(dstr, len + 1);
3695 Copy(ptr, SvPVX(dstr), len + 1, char);
3696 SvCUR_set(dstr, len);
3698 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3702 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3703 const char * const type = sv_reftype(dstr,0);
3705 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3707 Perl_croak(aTHX_ "Cannot copy to %s", type);
3708 } else if (sflags & SVf_ROK) {
3709 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3710 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3713 if (GvIMPORTED(dstr) != GVf_IMPORTED
3714 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3716 GvIMPORTED_on(dstr);
3721 glob_assign_glob(dstr, sstr, dtype);
3725 if (dtype >= SVt_PV) {
3726 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3727 glob_assign_ref(dstr, sstr);
3730 if (SvPVX_const(dstr)) {
3736 (void)SvOK_off(dstr);
3737 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3738 SvFLAGS(dstr) |= sflags & SVf_ROK;
3739 assert(!(sflags & SVp_NOK));
3740 assert(!(sflags & SVp_IOK));
3741 assert(!(sflags & SVf_NOK));
3742 assert(!(sflags & SVf_IOK));
3744 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3745 if (!(sflags & SVf_OK)) {
3746 if (ckWARN(WARN_MISC))
3747 Perl_warner(aTHX_ packWARN(WARN_MISC),
3748 "Undefined value assigned to typeglob");
3751 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3752 if (dstr != (SV*)gv) {
3755 GvGP(dstr) = gp_ref(GvGP(gv));
3759 else if (sflags & SVp_POK) {
3763 * Check to see if we can just swipe the string. If so, it's a
3764 * possible small lose on short strings, but a big win on long ones.
3765 * It might even be a win on short strings if SvPVX_const(dstr)
3766 * has to be allocated and SvPVX_const(sstr) has to be freed.
3767 * Likewise if we can set up COW rather than doing an actual copy, we
3768 * drop to the else clause, as the swipe code and the COW setup code
3769 * have much in common.
3772 /* Whichever path we take through the next code, we want this true,
3773 and doing it now facilitates the COW check. */
3774 (void)SvPOK_only(dstr);
3777 /* If we're already COW then this clause is not true, and if COW
3778 is allowed then we drop down to the else and make dest COW
3779 with us. If caller hasn't said that we're allowed to COW
3780 shared hash keys then we don't do the COW setup, even if the
3781 source scalar is a shared hash key scalar. */
3782 (((flags & SV_COW_SHARED_HASH_KEYS)
3783 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3784 : 1 /* If making a COW copy is forbidden then the behaviour we
3785 desire is as if the source SV isn't actually already
3786 COW, even if it is. So we act as if the source flags
3787 are not COW, rather than actually testing them. */
3789 #ifndef PERL_OLD_COPY_ON_WRITE
3790 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3791 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3792 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3793 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3794 but in turn, it's somewhat dead code, never expected to go
3795 live, but more kept as a placeholder on how to do it better
3796 in a newer implementation. */
3797 /* If we are COW and dstr is a suitable target then we drop down
3798 into the else and make dest a COW of us. */
3799 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3804 (sflags & SVs_TEMP) && /* slated for free anyway? */
3805 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3806 (!(flags & SV_NOSTEAL)) &&
3807 /* and we're allowed to steal temps */
3808 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3809 SvLEN(sstr) && /* and really is a string */
3810 /* and won't be needed again, potentially */
3811 !(PL_op && PL_op->op_type == OP_AASSIGN))
3812 #ifdef PERL_OLD_COPY_ON_WRITE
3813 && ((flags & SV_COW_SHARED_HASH_KEYS)
3814 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3815 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3816 && SvTYPE(sstr) >= SVt_PVIV))
3820 /* Failed the swipe test, and it's not a shared hash key either.
3821 Have to copy the string. */
3822 STRLEN len = SvCUR(sstr);
3823 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3824 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3825 SvCUR_set(dstr, len);
3826 *SvEND(dstr) = '\0';
3828 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3830 /* Either it's a shared hash key, or it's suitable for
3831 copy-on-write or we can swipe the string. */
3833 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3837 #ifdef PERL_OLD_COPY_ON_WRITE
3839 /* I believe I should acquire a global SV mutex if
3840 it's a COW sv (not a shared hash key) to stop
3841 it going un copy-on-write.
3842 If the source SV has gone un copy on write between up there
3843 and down here, then (assert() that) it is of the correct
3844 form to make it copy on write again */
3845 if ((sflags & (SVf_FAKE | SVf_READONLY))
3846 != (SVf_FAKE | SVf_READONLY)) {
3847 SvREADONLY_on(sstr);
3849 /* Make the source SV into a loop of 1.
3850 (about to become 2) */
3851 SV_COW_NEXT_SV_SET(sstr, sstr);
3855 /* Initial code is common. */
3856 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3861 /* making another shared SV. */
3862 STRLEN cur = SvCUR(sstr);
3863 STRLEN len = SvLEN(sstr);
3864 #ifdef PERL_OLD_COPY_ON_WRITE
3866 assert (SvTYPE(dstr) >= SVt_PVIV);
3867 /* SvIsCOW_normal */
3868 /* splice us in between source and next-after-source. */
3869 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3870 SV_COW_NEXT_SV_SET(sstr, dstr);
3871 SvPV_set(dstr, SvPVX_mutable(sstr));
3875 /* SvIsCOW_shared_hash */
3876 DEBUG_C(PerlIO_printf(Perl_debug_log,
3877 "Copy on write: Sharing hash\n"));
3879 assert (SvTYPE(dstr) >= SVt_PV);
3881 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3883 SvLEN_set(dstr, len);
3884 SvCUR_set(dstr, cur);
3885 SvREADONLY_on(dstr);
3887 /* Relesase a global SV mutex. */
3890 { /* Passes the swipe test. */
3891 SvPV_set(dstr, SvPVX_mutable(sstr));
3892 SvLEN_set(dstr, SvLEN(sstr));
3893 SvCUR_set(dstr, SvCUR(sstr));
3896 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3897 SvPV_set(sstr, NULL);
3903 if (sflags & SVp_NOK) {
3904 SvNV_set(dstr, SvNVX(sstr));
3906 if (sflags & SVp_IOK) {
3907 SvIV_set(dstr, SvIVX(sstr));
3908 /* Must do this otherwise some other overloaded use of 0x80000000
3909 gets confused. I guess SVpbm_VALID */
3910 if (sflags & SVf_IVisUV)
3913 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3915 const MAGIC * const smg = SvVSTRING_mg(sstr);
3917 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3918 smg->mg_ptr, smg->mg_len);
3919 SvRMAGICAL_on(dstr);
3923 else if (sflags & (SVp_IOK|SVp_NOK)) {
3924 (void)SvOK_off(dstr);
3925 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3926 if (sflags & SVp_IOK) {
3927 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3928 SvIV_set(dstr, SvIVX(sstr));
3930 if (sflags & SVp_NOK) {
3931 SvNV_set(dstr, SvNVX(sstr));
3935 if (isGV_with_GP(sstr)) {
3936 /* This stringification rule for globs is spread in 3 places.
3937 This feels bad. FIXME. */
3938 const U32 wasfake = sflags & SVf_FAKE;
3940 /* FAKE globs can get coerced, so need to turn this off
3941 temporarily if it is on. */
3943 gv_efullname3(dstr, (GV *)sstr, "*");
3944 SvFLAGS(sstr) |= wasfake;
3947 (void)SvOK_off(dstr);
3949 if (SvTAINTED(sstr))
3954 =for apidoc sv_setsv_mg
3956 Like C<sv_setsv>, but also handles 'set' magic.
3962 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3964 PERL_ARGS_ASSERT_SV_SETSV_MG;
3966 sv_setsv(dstr,sstr);
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3972 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3974 STRLEN cur = SvCUR(sstr);
3975 STRLEN len = SvLEN(sstr);
3976 register char *new_pv;
3978 PERL_ARGS_ASSERT_SV_SETSV_COW;
3981 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3982 (void*)sstr, (void*)dstr);
3989 if (SvTHINKFIRST(dstr))
3990 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3991 else if (SvPVX_const(dstr))
3992 Safefree(SvPVX_const(dstr));
3996 SvUPGRADE(dstr, SVt_PVIV);
3998 assert (SvPOK(sstr));
3999 assert (SvPOKp(sstr));
4000 assert (!SvIOK(sstr));
4001 assert (!SvIOKp(sstr));
4002 assert (!SvNOK(sstr));
4003 assert (!SvNOKp(sstr));
4005 if (SvIsCOW(sstr)) {
4007 if (SvLEN(sstr) == 0) {
4008 /* source is a COW shared hash key. */
4009 DEBUG_C(PerlIO_printf(Perl_debug_log,
4010 "Fast copy on write: Sharing hash\n"));
4011 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4014 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4016 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4017 SvUPGRADE(sstr, SVt_PVIV);
4018 SvREADONLY_on(sstr);
4020 DEBUG_C(PerlIO_printf(Perl_debug_log,
4021 "Fast copy on write: Converting sstr to COW\n"));
4022 SV_COW_NEXT_SV_SET(dstr, sstr);
4024 SV_COW_NEXT_SV_SET(sstr, dstr);
4025 new_pv = SvPVX_mutable(sstr);
4028 SvPV_set(dstr, new_pv);
4029 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4032 SvLEN_set(dstr, len);
4033 SvCUR_set(dstr, cur);
4042 =for apidoc sv_setpvn
4044 Copies a string into an SV. The C<len> parameter indicates the number of
4045 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4046 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4052 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4055 register char *dptr;
4057 PERL_ARGS_ASSERT_SV_SETPVN;
4059 SV_CHECK_THINKFIRST_COW_DROP(sv);
4065 /* len is STRLEN which is unsigned, need to copy to signed */
4068 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4070 SvUPGRADE(sv, SVt_PV);
4072 dptr = SvGROW(sv, len + 1);
4073 Move(ptr,dptr,len,char);
4076 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4081 =for apidoc sv_setpvn_mg
4083 Like C<sv_setpvn>, but also handles 'set' magic.
4089 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4091 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4093 sv_setpvn(sv,ptr,len);
4098 =for apidoc sv_setpv
4100 Copies a string into an SV. The string must be null-terminated. Does not
4101 handle 'set' magic. See C<sv_setpv_mg>.
4107 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4110 register STRLEN len;
4112 PERL_ARGS_ASSERT_SV_SETPV;
4114 SV_CHECK_THINKFIRST_COW_DROP(sv);
4120 SvUPGRADE(sv, SVt_PV);
4122 SvGROW(sv, len + 1);
4123 Move(ptr,SvPVX(sv),len+1,char);
4125 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4130 =for apidoc sv_setpv_mg
4132 Like C<sv_setpv>, but also handles 'set' magic.
4138 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4140 PERL_ARGS_ASSERT_SV_SETPV_MG;
4147 =for apidoc sv_usepvn_flags
4149 Tells an SV to use C<ptr> to find its string value. Normally the
4150 string is stored inside the SV but sv_usepvn allows the SV to use an
4151 outside string. The C<ptr> should point to memory that was allocated
4152 by C<malloc>. The string length, C<len>, must be supplied. By default
4153 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4154 so that pointer should not be freed or used by the programmer after
4155 giving it to sv_usepvn, and neither should any pointers from "behind"
4156 that pointer (e.g. ptr + 1) be used.
4158 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4159 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4160 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4161 C<len>, and already meets the requirements for storing in C<SvPVX>)
4167 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4172 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4174 SV_CHECK_THINKFIRST_COW_DROP(sv);
4175 SvUPGRADE(sv, SVt_PV);
4178 if (flags & SV_SMAGIC)
4182 if (SvPVX_const(sv))
4186 if (flags & SV_HAS_TRAILING_NUL)
4187 assert(ptr[len] == '\0');
4190 allocate = (flags & SV_HAS_TRAILING_NUL)
4192 #ifdef Perl_safesysmalloc_size
4195 PERL_STRLEN_ROUNDUP(len + 1);
4197 if (flags & SV_HAS_TRAILING_NUL) {
4198 /* It's long enough - do nothing.
4199 Specfically Perl_newCONSTSUB is relying on this. */
4202 /* Force a move to shake out bugs in callers. */
4203 char *new_ptr = (char*)safemalloc(allocate);
4204 Copy(ptr, new_ptr, len, char);
4205 PoisonFree(ptr,len,char);
4209 ptr = (char*) saferealloc (ptr, allocate);
4212 #ifdef Perl_safesysmalloc_size
4213 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4215 SvLEN_set(sv, allocate);
4219 if (!(flags & SV_HAS_TRAILING_NUL)) {
4222 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4224 if (flags & SV_SMAGIC)
4228 #ifdef PERL_OLD_COPY_ON_WRITE
4229 /* Need to do this *after* making the SV normal, as we need the buffer
4230 pointer to remain valid until after we've copied it. If we let go too early,
4231 another thread could invalidate it by unsharing last of the same hash key
4232 (which it can do by means other than releasing copy-on-write Svs)
4233 or by changing the other copy-on-write SVs in the loop. */
4235 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4237 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4239 { /* this SV was SvIsCOW_normal(sv) */
4240 /* we need to find the SV pointing to us. */
4241 SV *current = SV_COW_NEXT_SV(after);
4243 if (current == sv) {
4244 /* The SV we point to points back to us (there were only two of us
4246 Hence other SV is no longer copy on write either. */
4248 SvREADONLY_off(after);
4250 /* We need to follow the pointers around the loop. */
4252 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4255 /* don't loop forever if the structure is bust, and we have
4256 a pointer into a closed loop. */
4257 assert (current != after);
4258 assert (SvPVX_const(current) == pvx);
4260 /* Make the SV before us point to the SV after us. */
4261 SV_COW_NEXT_SV_SET(current, after);
4267 =for apidoc sv_force_normal_flags
4269 Undo various types of fakery on an SV: if the PV is a shared string, make
4270 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4271 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4272 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4273 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4274 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4275 set to some other value.) In addition, the C<flags> parameter gets passed to
4276 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4277 with flags set to 0.
4283 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4287 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4289 #ifdef PERL_OLD_COPY_ON_WRITE
4290 if (SvREADONLY(sv)) {
4291 /* At this point I believe I should acquire a global SV mutex. */
4293 const char * const pvx = SvPVX_const(sv);
4294 const STRLEN len = SvLEN(sv);
4295 const STRLEN cur = SvCUR(sv);
4296 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4297 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4298 we'll fail an assertion. */
4299 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4302 PerlIO_printf(Perl_debug_log,
4303 "Copy on write: Force normal %ld\n",
4309 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4312 if (flags & SV_COW_DROP_PV) {
4313 /* OK, so we don't need to copy our buffer. */
4316 SvGROW(sv, cur + 1);
4317 Move(pvx,SvPVX(sv),cur,char);
4322 sv_release_COW(sv, pvx, next);
4324 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4330 else if (IN_PERL_RUNTIME)
4331 Perl_croak(aTHX_ PL_no_modify);
4332 /* At this point I believe that I can drop the global SV mutex. */
4335 if (SvREADONLY(sv)) {
4337 const char * const pvx = SvPVX_const(sv);
4338 const STRLEN len = SvCUR(sv);
4343 SvGROW(sv, len + 1);
4344 Move(pvx,SvPVX(sv),len,char);
4346 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4348 else if (IN_PERL_RUNTIME)
4349 Perl_croak(aTHX_ PL_no_modify);
4353 sv_unref_flags(sv, flags);
4354 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4361 Efficient removal of characters from the beginning of the string buffer.
4362 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4363 the string buffer. The C<ptr> becomes the first character of the adjusted
4364 string. Uses the "OOK hack".
4365 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4366 refer to the same chunk of data.
4372 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4378 const U8 *real_start;
4381 PERL_ARGS_ASSERT_SV_CHOP;
4383 if (!ptr || !SvPOKp(sv))
4385 delta = ptr - SvPVX_const(sv);
4387 /* Nothing to do. */
4390 assert(ptr > SvPVX_const(sv));
4391 SV_CHECK_THINKFIRST(sv);
4394 if (!SvLEN(sv)) { /* make copy of shared string */
4395 const char *pvx = SvPVX_const(sv);
4396 const STRLEN len = SvCUR(sv);
4397 SvGROW(sv, len + 1);
4398 Move(pvx,SvPVX(sv),len,char);
4401 SvFLAGS(sv) |= SVf_OOK;
4404 SvOOK_offset(sv, old_delta);
4406 SvLEN_set(sv, SvLEN(sv) - delta);
4407 SvCUR_set(sv, SvCUR(sv) - delta);
4408 SvPV_set(sv, SvPVX(sv) + delta);
4410 p = (U8 *)SvPVX_const(sv);
4415 real_start = p - delta;
4419 if (delta < 0x100) {
4423 p -= sizeof(STRLEN);
4424 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4428 /* Fill the preceding buffer with sentinals to verify that no-one is
4430 while (p > real_start) {
4438 =for apidoc sv_catpvn
4440 Concatenates the string onto the end of the string which is in the SV. The
4441 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4442 status set, then the bytes appended should be valid UTF-8.
4443 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4445 =for apidoc sv_catpvn_flags
4447 Concatenates the string onto the end of the string which is in the SV. The
4448 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4449 status set, then the bytes appended should be valid UTF-8.
4450 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4451 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4452 in terms of this function.
4458 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4462 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4464 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4466 SvGROW(dsv, dlen + slen + 1);
4468 sstr = SvPVX_const(dsv);
4469 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4470 SvCUR_set(dsv, SvCUR(dsv) + slen);
4472 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4474 if (flags & SV_SMAGIC)
4479 =for apidoc sv_catsv
4481 Concatenates the string from SV C<ssv> onto the end of the string in
4482 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4483 not 'set' magic. See C<sv_catsv_mg>.
4485 =for apidoc sv_catsv_flags
4487 Concatenates the string from SV C<ssv> onto the end of the string in
4488 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4489 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4490 and C<sv_catsv_nomg> are implemented in terms of this function.
4495 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4499 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4503 const char *spv = SvPV_const(ssv, slen);
4505 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4506 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4507 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4508 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4509 dsv->sv_flags doesn't have that bit set.
4510 Andy Dougherty 12 Oct 2001
4512 const I32 sutf8 = DO_UTF8(ssv);
4515 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4517 dutf8 = DO_UTF8(dsv);
4519 if (dutf8 != sutf8) {
4521 /* Not modifying source SV, so taking a temporary copy. */
4522 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4524 sv_utf8_upgrade(csv);
4525 spv = SvPV_const(csv, slen);
4528 sv_utf8_upgrade_nomg(dsv);
4530 sv_catpvn_nomg(dsv, spv, slen);
4533 if (flags & SV_SMAGIC)
4538 =for apidoc sv_catpv
4540 Concatenates the string onto the end of the string which is in the SV.
4541 If the SV has the UTF-8 status set, then the bytes appended should be
4542 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4547 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4550 register STRLEN len;
4554 PERL_ARGS_ASSERT_SV_CATPV;
4558 junk = SvPV_force(sv, tlen);
4560 SvGROW(sv, tlen + len + 1);
4562 ptr = SvPVX_const(sv);
4563 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4564 SvCUR_set(sv, SvCUR(sv) + len);
4565 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4570 =for apidoc sv_catpv_mg
4572 Like C<sv_catpv>, but also handles 'set' magic.
4578 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4580 PERL_ARGS_ASSERT_SV_CATPV_MG;
4589 Creates a new SV. A non-zero C<len> parameter indicates the number of
4590 bytes of preallocated string space the SV should have. An extra byte for a
4591 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4592 space is allocated.) The reference count for the new SV is set to 1.
4594 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4595 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4596 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4597 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4598 modules supporting older perls.
4604 Perl_newSV(pTHX_ const STRLEN len)
4611 sv_upgrade(sv, SVt_PV);
4612 SvGROW(sv, len + 1);
4617 =for apidoc sv_magicext
4619 Adds magic to an SV, upgrading it if necessary. Applies the
4620 supplied vtable and returns a pointer to the magic added.
4622 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4623 In particular, you can add magic to SvREADONLY SVs, and add more than
4624 one instance of the same 'how'.
4626 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4627 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4628 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4629 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4631 (This is now used as a subroutine by C<sv_magic>.)
4636 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4637 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4642 PERL_ARGS_ASSERT_SV_MAGICEXT;
4644 SvUPGRADE(sv, SVt_PVMG);
4645 Newxz(mg, 1, MAGIC);
4646 mg->mg_moremagic = SvMAGIC(sv);
4647 SvMAGIC_set(sv, mg);
4649 /* Sometimes a magic contains a reference loop, where the sv and
4650 object refer to each other. To prevent a reference loop that
4651 would prevent such objects being freed, we look for such loops
4652 and if we find one we avoid incrementing the object refcount.
4654 Note we cannot do this to avoid self-tie loops as intervening RV must
4655 have its REFCNT incremented to keep it in existence.
4658 if (!obj || obj == sv ||
4659 how == PERL_MAGIC_arylen ||
4660 how == PERL_MAGIC_symtab ||
4661 (SvTYPE(obj) == SVt_PVGV &&
4662 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4663 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4664 GvFORM(obj) == (CV*)sv)))
4669 mg->mg_obj = SvREFCNT_inc_simple(obj);
4670 mg->mg_flags |= MGf_REFCOUNTED;
4673 /* Normal self-ties simply pass a null object, and instead of
4674 using mg_obj directly, use the SvTIED_obj macro to produce a
4675 new RV as needed. For glob "self-ties", we are tieing the PVIO
4676 with an RV obj pointing to the glob containing the PVIO. In
4677 this case, to avoid a reference loop, we need to weaken the
4681 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4682 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4688 mg->mg_len = namlen;
4691 mg->mg_ptr = savepvn(name, namlen);
4692 else if (namlen == HEf_SVKEY)
4693 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4695 mg->mg_ptr = (char *) name;
4697 mg->mg_virtual = (MGVTBL *) vtable;
4701 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4706 =for apidoc sv_magic
4708 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4709 then adds a new magic item of type C<how> to the head of the magic list.
4711 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4712 handling of the C<name> and C<namlen> arguments.
4714 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4715 to add more than one instance of the same 'how'.
4721 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4722 const char *const name, const I32 namlen)
4725 const MGVTBL *vtable;
4728 PERL_ARGS_ASSERT_SV_MAGIC;
4730 #ifdef PERL_OLD_COPY_ON_WRITE
4732 sv_force_normal_flags(sv, 0);
4734 if (SvREADONLY(sv)) {
4736 /* its okay to attach magic to shared strings; the subsequent
4737 * upgrade to PVMG will unshare the string */
4738 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4741 && how != PERL_MAGIC_regex_global
4742 && how != PERL_MAGIC_bm
4743 && how != PERL_MAGIC_fm
4744 && how != PERL_MAGIC_sv
4745 && how != PERL_MAGIC_backref
4748 Perl_croak(aTHX_ PL_no_modify);
4751 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4752 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4753 /* sv_magic() refuses to add a magic of the same 'how' as an
4756 if (how == PERL_MAGIC_taint) {
4758 /* Any scalar which already had taint magic on which someone
4759 (erroneously?) did SvIOK_on() or similar will now be
4760 incorrectly sporting public "OK" flags. */
4761 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4769 vtable = &PL_vtbl_sv;
4771 case PERL_MAGIC_overload:
4772 vtable = &PL_vtbl_amagic;
4774 case PERL_MAGIC_overload_elem:
4775 vtable = &PL_vtbl_amagicelem;
4777 case PERL_MAGIC_overload_table:
4778 vtable = &PL_vtbl_ovrld;
4781 vtable = &PL_vtbl_bm;
4783 case PERL_MAGIC_regdata:
4784 vtable = &PL_vtbl_regdata;
4786 case PERL_MAGIC_regdatum:
4787 vtable = &PL_vtbl_regdatum;
4789 case PERL_MAGIC_env:
4790 vtable = &PL_vtbl_env;
4793 vtable = &PL_vtbl_fm;
4795 case PERL_MAGIC_envelem:
4796 vtable = &PL_vtbl_envelem;
4798 case PERL_MAGIC_regex_global:
4799 vtable = &PL_vtbl_mglob;
4801 case PERL_MAGIC_isa:
4802 vtable = &PL_vtbl_isa;
4804 case PERL_MAGIC_isaelem:
4805 vtable = &PL_vtbl_isaelem;
4807 case PERL_MAGIC_nkeys:
4808 vtable = &PL_vtbl_nkeys;
4810 case PERL_MAGIC_dbfile:
4813 case PERL_MAGIC_dbline:
4814 vtable = &PL_vtbl_dbline;
4816 #ifdef USE_LOCALE_COLLATE
4817 case PERL_MAGIC_collxfrm:
4818 vtable = &PL_vtbl_collxfrm;
4820 #endif /* USE_LOCALE_COLLATE */
4821 case PERL_MAGIC_tied:
4822 vtable = &PL_vtbl_pack;
4824 case PERL_MAGIC_tiedelem:
4825 case PERL_MAGIC_tiedscalar:
4826 vtable = &PL_vtbl_packelem;
4829 vtable = &PL_vtbl_regexp;
4831 case PERL_MAGIC_hints:
4832 /* As this vtable is all NULL, we can reuse it. */
4833 case PERL_MAGIC_sig:
4834 vtable = &PL_vtbl_sig;
4836 case PERL_MAGIC_sigelem:
4837 vtable = &PL_vtbl_sigelem;
4839 case PERL_MAGIC_taint:
4840 vtable = &PL_vtbl_taint;
4842 case PERL_MAGIC_uvar:
4843 vtable = &PL_vtbl_uvar;
4845 case PERL_MAGIC_vec:
4846 vtable = &PL_vtbl_vec;
4848 case PERL_MAGIC_arylen_p:
4849 case PERL_MAGIC_rhash:
4850 case PERL_MAGIC_symtab:
4851 case PERL_MAGIC_vstring:
4854 case PERL_MAGIC_utf8:
4855 vtable = &PL_vtbl_utf8;
4857 case PERL_MAGIC_substr:
4858 vtable = &PL_vtbl_substr;
4860 case PERL_MAGIC_defelem:
4861 vtable = &PL_vtbl_defelem;
4863 case PERL_MAGIC_arylen:
4864 vtable = &PL_vtbl_arylen;
4866 case PERL_MAGIC_pos:
4867 vtable = &PL_vtbl_pos;
4869 case PERL_MAGIC_backref:
4870 vtable = &PL_vtbl_backref;
4872 case PERL_MAGIC_hintselem:
4873 vtable = &PL_vtbl_hintselem;
4875 case PERL_MAGIC_ext:
4876 /* Reserved for use by extensions not perl internals. */
4877 /* Useful for attaching extension internal data to perl vars. */
4878 /* Note that multiple extensions may clash if magical scalars */
4879 /* etc holding private data from one are passed to another. */
4883 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4886 /* Rest of work is done else where */
4887 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4890 case PERL_MAGIC_taint:
4893 case PERL_MAGIC_ext:
4894 case PERL_MAGIC_dbfile:
4901 =for apidoc sv_unmagic
4903 Removes all magic of type C<type> from an SV.
4909 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4914 PERL_ARGS_ASSERT_SV_UNMAGIC;
4916 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4918 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4919 for (mg = *mgp; mg; mg = *mgp) {
4920 if (mg->mg_type == type) {
4921 const MGVTBL* const vtbl = mg->mg_virtual;
4922 *mgp = mg->mg_moremagic;
4923 if (vtbl && vtbl->svt_free)
4924 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4925 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4927 Safefree(mg->mg_ptr);
4928 else if (mg->mg_len == HEf_SVKEY)
4929 SvREFCNT_dec((SV*)mg->mg_ptr);
4930 else if (mg->mg_type == PERL_MAGIC_utf8)
4931 Safefree(mg->mg_ptr);
4933 if (mg->mg_flags & MGf_REFCOUNTED)
4934 SvREFCNT_dec(mg->mg_obj);
4938 mgp = &mg->mg_moremagic;
4942 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4943 SvMAGIC_set(sv, NULL);
4950 =for apidoc sv_rvweaken
4952 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4953 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4954 push a back-reference to this RV onto the array of backreferences
4955 associated with that magic. If the RV is magical, set magic will be
4956 called after the RV is cleared.
4962 Perl_sv_rvweaken(pTHX_ SV *const sv)
4966 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4968 if (!SvOK(sv)) /* let undefs pass */
4971 Perl_croak(aTHX_ "Can't weaken a nonreference");
4972 else if (SvWEAKREF(sv)) {
4973 if (ckWARN(WARN_MISC))
4974 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4978 Perl_sv_add_backref(aTHX_ tsv, sv);
4984 /* Give tsv backref magic if it hasn't already got it, then push a
4985 * back-reference to sv onto the array associated with the backref magic.
4989 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4994 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4996 if (SvTYPE(tsv) == SVt_PVHV) {
4997 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5001 /* There is no AV in the offical place - try a fixup. */
5002 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5005 /* Aha. They've got it stowed in magic. Bring it back. */
5006 av = (AV*)mg->mg_obj;
5007 /* Stop mg_free decreasing the refernce count. */
5009 /* Stop mg_free even calling the destructor, given that
5010 there's no AV to free up. */
5012 sv_unmagic(tsv, PERL_MAGIC_backref);
5016 SvREFCNT_inc_simple_void(av);
5021 const MAGIC *const mg
5022 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5024 av = (AV*)mg->mg_obj;
5028 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5029 /* av now has a refcnt of 2, which avoids it getting freed
5030 * before us during global cleanup. The extra ref is removed
5031 * by magic_killbackrefs() when tsv is being freed */
5034 if (AvFILLp(av) >= AvMAX(av)) {
5035 av_extend(av, AvFILLp(av)+1);
5037 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5040 /* delete a back-reference to ourselves from the backref magic associated
5041 * with the SV we point to.
5045 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5052 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5054 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5055 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5056 /* We mustn't attempt to "fix up" the hash here by moving the
5057 backreference array back to the hv_aux structure, as that is stored
5058 in the main HvARRAY(), and hfreentries assumes that no-one
5059 reallocates HvARRAY() while it is running. */
5062 const MAGIC *const mg
5063 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5065 av = (AV *)mg->mg_obj;
5068 if (PL_in_clean_all)
5070 Perl_croak(aTHX_ "panic: del_backref");
5077 /* We shouldn't be in here more than once, but for paranoia reasons lets
5079 for (i = AvFILLp(av); i >= 0; i--) {
5081 const SSize_t fill = AvFILLp(av);
5083 /* We weren't the last entry.
5084 An unordered list has this property that you can take the
5085 last element off the end to fill the hole, and it's still
5086 an unordered list :-)
5091 AvFILLp(av) = fill - 1;
5097 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5099 SV **svp = AvARRAY(av);
5101 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5102 PERL_UNUSED_ARG(sv);
5104 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5105 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5106 if (svp && !SvIS_FREED(av)) {
5107 SV *const *const last = svp + AvFILLp(av);
5109 while (svp <= last) {
5111 SV *const referrer = *svp;
5112 if (SvWEAKREF(referrer)) {
5113 /* XXX Should we check that it hasn't changed? */
5114 SvRV_set(referrer, 0);
5116 SvWEAKREF_off(referrer);
5117 SvSETMAGIC(referrer);
5118 } else if (SvTYPE(referrer) == SVt_PVGV ||
5119 SvTYPE(referrer) == SVt_PVLV) {
5120 /* You lookin' at me? */
5121 assert(GvSTASH(referrer));
5122 assert(GvSTASH(referrer) == (HV*)sv);
5123 GvSTASH(referrer) = 0;
5126 "panic: magic_killbackrefs (flags=%"UVxf")",
5127 (UV)SvFLAGS(referrer));
5135 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5140 =for apidoc sv_insert
5142 Inserts a string at the specified offset/length within the SV. Similar to
5143 the Perl substr() function. Handles get magic.
5145 =for apidoc sv_insert_flags
5147 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5153 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5158 register char *midend;
5159 register char *bigend;
5163 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5166 Perl_croak(aTHX_ "Can't modify non-existent substring");
5167 SvPV_force_flags(bigstr, curlen, flags);
5168 (void)SvPOK_only_UTF8(bigstr);
5169 if (offset + len > curlen) {
5170 SvGROW(bigstr, offset+len+1);
5171 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5172 SvCUR_set(bigstr, offset+len);
5176 i = littlelen - len;
5177 if (i > 0) { /* string might grow */
5178 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5179 mid = big + offset + len;
5180 midend = bigend = big + SvCUR(bigstr);
5183 while (midend > mid) /* shove everything down */
5184 *--bigend = *--midend;
5185 Move(little,big+offset,littlelen,char);
5186 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5191 Move(little,SvPVX(bigstr)+offset,len,char);
5196 big = SvPVX(bigstr);
5199 bigend = big + SvCUR(bigstr);
5201 if (midend > bigend)
5202 Perl_croak(aTHX_ "panic: sv_insert");
5204 if (mid - big > bigend - midend) { /* faster to shorten from end */
5206 Move(little, mid, littlelen,char);
5209 i = bigend - midend;
5211 Move(midend, mid, i,char);
5215 SvCUR_set(bigstr, mid - big);
5217 else if ((i = mid - big)) { /* faster from front */
5218 midend -= littlelen;
5220 Move(big, midend - i, i, char);
5221 sv_chop(bigstr,midend-i);
5223 Move(little, mid, littlelen,char);
5225 else if (littlelen) {
5226 midend -= littlelen;
5227 sv_chop(bigstr,midend);
5228 Move(little,midend,littlelen,char);
5231 sv_chop(bigstr,midend);
5237 =for apidoc sv_replace
5239 Make the first argument a copy of the second, then delete the original.
5240 The target SV physically takes over ownership of the body of the source SV
5241 and inherits its flags; however, the target keeps any magic it owns,
5242 and any magic in the source is discarded.
5243 Note that this is a rather specialist SV copying operation; most of the
5244 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5250 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5253 const U32 refcnt = SvREFCNT(sv);
5255 PERL_ARGS_ASSERT_SV_REPLACE;
5257 SV_CHECK_THINKFIRST_COW_DROP(sv);
5258 if (SvREFCNT(nsv) != 1) {
5259 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5260 UVuf " != 1)", (UV) SvREFCNT(nsv));
5262 if (SvMAGICAL(sv)) {
5266 sv_upgrade(nsv, SVt_PVMG);
5267 SvMAGIC_set(nsv, SvMAGIC(sv));
5268 SvFLAGS(nsv) |= SvMAGICAL(sv);
5270 SvMAGIC_set(sv, NULL);
5274 assert(!SvREFCNT(sv));
5275 #ifdef DEBUG_LEAKING_SCALARS
5276 sv->sv_flags = nsv->sv_flags;
5277 sv->sv_any = nsv->sv_any;
5278 sv->sv_refcnt = nsv->sv_refcnt;
5279 sv->sv_u = nsv->sv_u;
5281 StructCopy(nsv,sv,SV);
5283 if(SvTYPE(sv) == SVt_IV) {
5285 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5289 #ifdef PERL_OLD_COPY_ON_WRITE
5290 if (SvIsCOW_normal(nsv)) {
5291 /* We need to follow the pointers around the loop to make the
5292 previous SV point to sv, rather than nsv. */
5295 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5298 assert(SvPVX_const(current) == SvPVX_const(nsv));
5300 /* Make the SV before us point to the SV after us. */
5302 PerlIO_printf(Perl_debug_log, "previous is\n");
5304 PerlIO_printf(Perl_debug_log,
5305 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5306 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5308 SV_COW_NEXT_SV_SET(current, sv);
5311 SvREFCNT(sv) = refcnt;
5312 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5318 =for apidoc sv_clear
5320 Clear an SV: call any destructors, free up any memory used by the body,
5321 and free the body itself. The SV's head is I<not> freed, although
5322 its type is set to all 1's so that it won't inadvertently be assumed
5323 to be live during global destruction etc.
5324 This function should only be called when REFCNT is zero. Most of the time
5325 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5332 Perl_sv_clear(pTHX_ register SV *const sv)
5335 const U32 type = SvTYPE(sv);
5336 const struct body_details *const sv_type_details
5337 = bodies_by_type + type;
5340 PERL_ARGS_ASSERT_SV_CLEAR;
5341 assert(SvREFCNT(sv) == 0);
5342 assert(SvTYPE(sv) != SVTYPEMASK);
5344 if (type <= SVt_IV) {
5345 /* See the comment in sv.h about the collusion between this early
5346 return and the overloading of the NULL and IV slots in the size
5349 SV * const target = SvRV(sv);
5351 sv_del_backref(target, sv);
5353 SvREFCNT_dec(target);
5355 SvFLAGS(sv) &= SVf_BREAK;
5356 SvFLAGS(sv) |= SVTYPEMASK;
5361 if (PL_defstash && /* Still have a symbol table? */
5368 stash = SvSTASH(sv);
5369 destructor = StashHANDLER(stash,DESTROY);
5371 SV* const tmpref = newRV(sv);
5372 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5374 PUSHSTACKi(PERLSI_DESTROY);
5379 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5385 if(SvREFCNT(tmpref) < 2) {
5386 /* tmpref is not kept alive! */
5388 SvRV_set(tmpref, NULL);
5391 SvREFCNT_dec(tmpref);
5393 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5397 if (PL_in_clean_objs)
5398 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5400 /* DESTROY gave object new lease on life */
5406 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5407 SvOBJECT_off(sv); /* Curse the object. */
5408 if (type != SVt_PVIO)
5409 --PL_sv_objcount; /* XXX Might want something more general */
5412 if (type >= SVt_PVMG) {
5413 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5414 SvREFCNT_dec(SvOURSTASH(sv));
5415 } else if (SvMAGIC(sv))
5417 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5418 SvREFCNT_dec(SvSTASH(sv));
5421 /* case SVt_BIND: */
5424 IoIFP(sv) != PerlIO_stdin() &&
5425 IoIFP(sv) != PerlIO_stdout() &&
5426 IoIFP(sv) != PerlIO_stderr())
5428 io_close((IO*)sv, FALSE);
5430 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5431 PerlDir_close(IoDIRP(sv));
5432 IoDIRP(sv) = (DIR*)NULL;
5433 Safefree(IoTOP_NAME(sv));
5434 Safefree(IoFMT_NAME(sv));
5435 Safefree(IoBOTTOM_NAME(sv));
5438 /* FIXME for plugins */
5439 pregfree2((REGEXP*) sv);
5446 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5450 if (PL_comppad == (AV*)sv) {
5457 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5458 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5459 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5460 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5462 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5463 SvREFCNT_dec(LvTARG(sv));
5465 if (isGV_with_GP(sv)) {
5466 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5467 mro_method_changed_in(stash);
5470 unshare_hek(GvNAME_HEK(sv));
5471 /* If we're in a stash, we don't own a reference to it. However it does
5472 have a back reference to us, which needs to be cleared. */
5473 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5474 sv_del_backref((SV*)stash, sv);
5476 /* FIXME. There are probably more unreferenced pointers to SVs in the
5477 interpreter struct that we should check and tidy in a similar
5479 if ((GV*)sv == PL_last_in_gv)
5480 PL_last_in_gv = NULL;
5486 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5489 SvOOK_offset(sv, offset);
5490 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5491 /* Don't even bother with turning off the OOK flag. */
5494 SV * const target = SvRV(sv);
5496 sv_del_backref(target, sv);
5498 SvREFCNT_dec(target);
5500 #ifdef PERL_OLD_COPY_ON_WRITE
5501 else if (SvPVX_const(sv)) {
5503 /* I believe I need to grab the global SV mutex here and
5504 then recheck the COW status. */
5506 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5510 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5512 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5515 /* And drop it here. */
5517 } else if (SvLEN(sv)) {
5518 Safefree(SvPVX_const(sv));
5522 else if (SvPVX_const(sv) && SvLEN(sv))
5523 Safefree(SvPVX_mutable(sv));
5524 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5525 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5534 SvFLAGS(sv) &= SVf_BREAK;
5535 SvFLAGS(sv) |= SVTYPEMASK;
5537 if (sv_type_details->arena) {
5538 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5539 &PL_body_roots[type]);
5541 else if (sv_type_details->body_size) {
5542 my_safefree(SvANY(sv));
5547 =for apidoc sv_newref
5549 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5556 Perl_sv_newref(pTHX_ SV *const sv)
5558 PERL_UNUSED_CONTEXT;
5567 Decrement an SV's reference count, and if it drops to zero, call
5568 C<sv_clear> to invoke destructors and free up any memory used by
5569 the body; finally, deallocate the SV's head itself.
5570 Normally called via a wrapper macro C<SvREFCNT_dec>.
5576 Perl_sv_free(pTHX_ SV *const sv)
5581 if (SvREFCNT(sv) == 0) {
5582 if (SvFLAGS(sv) & SVf_BREAK)
5583 /* this SV's refcnt has been artificially decremented to
5584 * trigger cleanup */
5586 if (PL_in_clean_all) /* All is fair */
5588 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5589 /* make sure SvREFCNT(sv)==0 happens very seldom */
5590 SvREFCNT(sv) = (~(U32)0)/2;
5593 if (ckWARN_d(WARN_INTERNAL)) {
5594 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5595 Perl_dump_sv_child(aTHX_ sv);
5597 #ifdef DEBUG_LEAKING_SCALARS
5600 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5601 if (PL_warnhook == PERL_WARNHOOK_FATAL
5602 || ckDEAD(packWARN(WARN_INTERNAL))) {
5603 /* Don't let Perl_warner cause us to escape our fate: */
5607 /* This may not return: */
5608 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5609 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5610 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5613 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5618 if (--(SvREFCNT(sv)) > 0)
5620 Perl_sv_free2(aTHX_ sv);
5624 Perl_sv_free2(pTHX_ SV *const sv)
5628 PERL_ARGS_ASSERT_SV_FREE2;
5632 if (ckWARN_d(WARN_DEBUGGING))
5633 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5634 "Attempt to free temp prematurely: SV 0x%"UVxf
5635 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5639 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5640 /* make sure SvREFCNT(sv)==0 happens very seldom */
5641 SvREFCNT(sv) = (~(U32)0)/2;
5652 Returns the length of the string in the SV. Handles magic and type
5653 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5659 Perl_sv_len(pTHX_ register SV *const sv)
5667 len = mg_length(sv);
5669 (void)SvPV_const(sv, len);
5674 =for apidoc sv_len_utf8
5676 Returns the number of characters in the string in an SV, counting wide
5677 UTF-8 bytes as a single character. Handles magic and type coercion.
5683 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5684 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5685 * (Note that the mg_len is not the length of the mg_ptr field.
5686 * This allows the cache to store the character length of the string without
5687 * needing to malloc() extra storage to attach to the mg_ptr.)
5692 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5698 return mg_length(sv);
5702 const U8 *s = (U8*)SvPV_const(sv, len);
5706 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5708 if (mg && mg->mg_len != -1) {
5710 if (PL_utf8cache < 0) {
5711 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5713 /* Need to turn the assertions off otherwise we may
5714 recurse infinitely while printing error messages.
5716 SAVEI8(PL_utf8cache);
5718 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5719 " real %"UVuf" for %"SVf,
5720 (UV) ulen, (UV) real, SVfARG(sv));
5725 ulen = Perl_utf8_length(aTHX_ s, s + len);
5726 if (!SvREADONLY(sv)) {
5728 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5729 &PL_vtbl_utf8, 0, 0);
5737 return Perl_utf8_length(aTHX_ s, s + len);
5741 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5744 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5747 const U8 *s = start;
5749 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5751 while (s < send && uoffset--)
5754 /* This is the existing behaviour. Possibly it should be a croak, as
5755 it's actually a bounds error */
5761 /* Given the length of the string in both bytes and UTF-8 characters, decide
5762 whether to walk forwards or backwards to find the byte corresponding to
5763 the passed in UTF-8 offset. */
5765 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5766 const STRLEN uoffset, const STRLEN uend)
5768 STRLEN backw = uend - uoffset;
5770 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5772 if (uoffset < 2 * backw) {
5773 /* The assumption is that going forwards is twice the speed of going
5774 forward (that's where the 2 * backw comes from).
5775 (The real figure of course depends on the UTF-8 data.) */
5776 return sv_pos_u2b_forwards(start, send, uoffset);
5781 while (UTF8_IS_CONTINUATION(*send))
5784 return send - start;
5787 /* For the string representation of the given scalar, find the byte
5788 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5789 give another position in the string, *before* the sought offset, which
5790 (which is always true, as 0, 0 is a valid pair of positions), which should
5791 help reduce the amount of linear searching.
5792 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5793 will be used to reduce the amount of linear searching. The cache will be
5794 created if necessary, and the found value offered to it for update. */
5796 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5797 const U8 *const send, const STRLEN uoffset,
5798 STRLEN uoffset0, STRLEN boffset0)
5800 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5803 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5805 assert (uoffset >= uoffset0);
5807 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5808 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5809 if ((*mgp)->mg_ptr) {
5810 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5811 if (cache[0] == uoffset) {
5812 /* An exact match. */
5815 if (cache[2] == uoffset) {
5816 /* An exact match. */
5820 if (cache[0] < uoffset) {
5821 /* The cache already knows part of the way. */
5822 if (cache[0] > uoffset0) {
5823 /* The cache knows more than the passed in pair */
5824 uoffset0 = cache[0];
5825 boffset0 = cache[1];
5827 if ((*mgp)->mg_len != -1) {
5828 /* And we know the end too. */
5830 + sv_pos_u2b_midway(start + boffset0, send,
5832 (*mgp)->mg_len - uoffset0);
5835 + sv_pos_u2b_forwards(start + boffset0,
5836 send, uoffset - uoffset0);
5839 else if (cache[2] < uoffset) {
5840 /* We're between the two cache entries. */
5841 if (cache[2] > uoffset0) {
5842 /* and the cache knows more than the passed in pair */
5843 uoffset0 = cache[2];
5844 boffset0 = cache[3];
5848 + sv_pos_u2b_midway(start + boffset0,
5851 cache[0] - uoffset0);
5854 + sv_pos_u2b_midway(start + boffset0,
5857 cache[2] - uoffset0);
5861 else if ((*mgp)->mg_len != -1) {
5862 /* If we can take advantage of a passed in offset, do so. */
5863 /* In fact, offset0 is either 0, or less than offset, so don't
5864 need to worry about the other possibility. */
5866 + sv_pos_u2b_midway(start + boffset0, send,
5868 (*mgp)->mg_len - uoffset0);
5873 if (!found || PL_utf8cache < 0) {
5874 const STRLEN real_boffset
5875 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5876 send, uoffset - uoffset0);
5878 if (found && PL_utf8cache < 0) {
5879 if (real_boffset != boffset) {
5880 /* Need to turn the assertions off otherwise we may recurse
5881 infinitely while printing error messages. */
5882 SAVEI8(PL_utf8cache);
5884 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5885 " real %"UVuf" for %"SVf,
5886 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5889 boffset = real_boffset;
5893 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5899 =for apidoc sv_pos_u2b
5901 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5902 the start of the string, to a count of the equivalent number of bytes; if
5903 lenp is non-zero, it does the same to lenp, but this time starting from
5904 the offset, rather than from the start of the string. Handles magic and
5911 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5912 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5913 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5918 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5923 PERL_ARGS_ASSERT_SV_POS_U2B;
5928 start = (U8*)SvPV_const(sv, len);
5930 STRLEN uoffset = (STRLEN) *offsetp;
5931 const U8 * const send = start + len;
5933 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5936 *offsetp = (I32) boffset;
5939 /* Convert the relative offset to absolute. */
5940 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5941 const STRLEN boffset2
5942 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5943 uoffset, boffset) - boffset;
5957 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5958 byte length pairing. The (byte) length of the total SV is passed in too,
5959 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5960 may not have updated SvCUR, so we can't rely on reading it directly.
5962 The proffered utf8/byte length pairing isn't used if the cache already has
5963 two pairs, and swapping either for the proffered pair would increase the
5964 RMS of the intervals between known byte offsets.
5966 The cache itself consists of 4 STRLEN values
5967 0: larger UTF-8 offset
5968 1: corresponding byte offset
5969 2: smaller UTF-8 offset
5970 3: corresponding byte offset
5972 Unused cache pairs have the value 0, 0.
5973 Keeping the cache "backwards" means that the invariant of
5974 cache[0] >= cache[2] is maintained even with empty slots, which means that
5975 the code that uses it doesn't need to worry if only 1 entry has actually
5976 been set to non-zero. It also makes the "position beyond the end of the
5977 cache" logic much simpler, as the first slot is always the one to start
5981 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5982 const STRLEN utf8, const STRLEN blen)
5986 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5992 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5994 (*mgp)->mg_len = -1;
5998 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5999 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6000 (*mgp)->mg_ptr = (char *) cache;
6004 if (PL_utf8cache < 0) {
6005 const U8 *start = (const U8 *) SvPVX_const(sv);
6006 const STRLEN realutf8 = utf8_length(start, start + byte);
6008 if (realutf8 != utf8) {
6009 /* Need to turn the assertions off otherwise we may recurse
6010 infinitely while printing error messages. */
6011 SAVEI8(PL_utf8cache);
6013 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6014 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6018 /* Cache is held with the later position first, to simplify the code
6019 that deals with unbounded ends. */
6021 ASSERT_UTF8_CACHE(cache);
6022 if (cache[1] == 0) {
6023 /* Cache is totally empty */
6026 } else if (cache[3] == 0) {
6027 if (byte > cache[1]) {
6028 /* New one is larger, so goes first. */
6029 cache[2] = cache[0];
6030 cache[3] = cache[1];
6038 #define THREEWAY_SQUARE(a,b,c,d) \
6039 ((float)((d) - (c))) * ((float)((d) - (c))) \
6040 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6041 + ((float)((b) - (a))) * ((float)((b) - (a)))
6043 /* Cache has 2 slots in use, and we know three potential pairs.
6044 Keep the two that give the lowest RMS distance. Do the
6045 calcualation in bytes simply because we always know the byte
6046 length. squareroot has the same ordering as the positive value,
6047 so don't bother with the actual square root. */
6048 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6049 if (byte > cache[1]) {
6050 /* New position is after the existing pair of pairs. */
6051 const float keep_earlier
6052 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6053 const float keep_later
6054 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6056 if (keep_later < keep_earlier) {
6057 if (keep_later < existing) {
6058 cache[2] = cache[0];
6059 cache[3] = cache[1];
6065 if (keep_earlier < existing) {
6071 else if (byte > cache[3]) {
6072 /* New position is between the existing pair of pairs. */
6073 const float keep_earlier
6074 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6075 const float keep_later
6076 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6078 if (keep_later < keep_earlier) {
6079 if (keep_later < existing) {
6085 if (keep_earlier < existing) {
6092 /* New position is before the existing pair of pairs. */
6093 const float keep_earlier
6094 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6095 const float keep_later
6096 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6098 if (keep_later < keep_earlier) {
6099 if (keep_later < existing) {
6105 if (keep_earlier < existing) {
6106 cache[0] = cache[2];
6107 cache[1] = cache[3];
6114 ASSERT_UTF8_CACHE(cache);
6117 /* We already know all of the way, now we may be able to walk back. The same
6118 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6119 backward is half the speed of walking forward. */
6121 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6122 const U8 *end, STRLEN endu)
6124 const STRLEN forw = target - s;
6125 STRLEN backw = end - target;
6127 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6129 if (forw < 2 * backw) {
6130 return utf8_length(s, target);
6133 while (end > target) {
6135 while (UTF8_IS_CONTINUATION(*end)) {
6144 =for apidoc sv_pos_b2u
6146 Converts the value pointed to by offsetp from a count of bytes from the
6147 start of the string, to a count of the equivalent number of UTF-8 chars.
6148 Handles magic and type coercion.
6154 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6155 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6160 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6163 const STRLEN byte = *offsetp;
6164 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6170 PERL_ARGS_ASSERT_SV_POS_B2U;
6175 s = (const U8*)SvPV_const(sv, blen);
6178 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6182 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6183 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6185 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6186 if (cache[1] == byte) {
6187 /* An exact match. */
6188 *offsetp = cache[0];
6191 if (cache[3] == byte) {
6192 /* An exact match. */
6193 *offsetp = cache[2];
6197 if (cache[1] < byte) {
6198 /* We already know part of the way. */
6199 if (mg->mg_len != -1) {
6200 /* Actually, we know the end too. */
6202 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6203 s + blen, mg->mg_len - cache[0]);
6205 len = cache[0] + utf8_length(s + cache[1], send);
6208 else if (cache[3] < byte) {
6209 /* We're between the two cached pairs, so we do the calculation
6210 offset by the byte/utf-8 positions for the earlier pair,
6211 then add the utf-8 characters from the string start to
6213 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6214 s + cache[1], cache[0] - cache[2])
6218 else { /* cache[3] > byte */
6219 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6223 ASSERT_UTF8_CACHE(cache);
6225 } else if (mg->mg_len != -1) {
6226 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6230 if (!found || PL_utf8cache < 0) {
6231 const STRLEN real_len = utf8_length(s, send);
6233 if (found && PL_utf8cache < 0) {
6234 if (len != real_len) {
6235 /* Need to turn the assertions off otherwise we may recurse
6236 infinitely while printing error messages. */
6237 SAVEI8(PL_utf8cache);
6239 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6240 " real %"UVuf" for %"SVf,
6241 (UV) len, (UV) real_len, SVfARG(sv));
6249 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6255 Returns a boolean indicating whether the strings in the two SVs are
6256 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6257 coerce its args to strings if necessary.
6263 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6272 SV* svrecode = NULL;
6279 /* if pv1 and pv2 are the same, second SvPV_const call may
6280 * invalidate pv1, so we may need to make a copy */
6281 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6282 pv1 = SvPV_const(sv1, cur1);
6283 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6285 pv1 = SvPV_const(sv1, cur1);
6293 pv2 = SvPV_const(sv2, cur2);
6295 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6296 /* Differing utf8ness.
6297 * Do not UTF8size the comparands as a side-effect. */
6300 svrecode = newSVpvn(pv2, cur2);
6301 sv_recode_to_utf8(svrecode, PL_encoding);
6302 pv2 = SvPV_const(svrecode, cur2);
6305 svrecode = newSVpvn(pv1, cur1);
6306 sv_recode_to_utf8(svrecode, PL_encoding);
6307 pv1 = SvPV_const(svrecode, cur1);
6309 /* Now both are in UTF-8. */
6311 SvREFCNT_dec(svrecode);
6316 bool is_utf8 = TRUE;
6319 /* sv1 is the UTF-8 one,
6320 * if is equal it must be downgrade-able */
6321 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6327 /* sv2 is the UTF-8 one,
6328 * if is equal it must be downgrade-able */
6329 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6335 /* Downgrade not possible - cannot be eq */
6343 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6345 SvREFCNT_dec(svrecode);
6355 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6356 string in C<sv1> is less than, equal to, or greater than the string in
6357 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6358 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6364 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6368 const char *pv1, *pv2;
6371 SV *svrecode = NULL;
6378 pv1 = SvPV_const(sv1, cur1);
6385 pv2 = SvPV_const(sv2, cur2);
6387 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6388 /* Differing utf8ness.
6389 * Do not UTF8size the comparands as a side-effect. */
6392 svrecode = newSVpvn(pv2, cur2);
6393 sv_recode_to_utf8(svrecode, PL_encoding);
6394 pv2 = SvPV_const(svrecode, cur2);
6397 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6402 svrecode = newSVpvn(pv1, cur1);
6403 sv_recode_to_utf8(svrecode, PL_encoding);
6404 pv1 = SvPV_const(svrecode, cur1);
6407 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6413 cmp = cur2 ? -1 : 0;
6417 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6420 cmp = retval < 0 ? -1 : 1;
6421 } else if (cur1 == cur2) {
6424 cmp = cur1 < cur2 ? -1 : 1;
6428 SvREFCNT_dec(svrecode);
6436 =for apidoc sv_cmp_locale
6438 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6439 'use bytes' aware, handles get magic, and will coerce its args to strings
6440 if necessary. See also C<sv_cmp>.
6446 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6449 #ifdef USE_LOCALE_COLLATE
6455 if (PL_collation_standard)
6459 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6461 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6463 if (!pv1 || !len1) {
6474 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6477 return retval < 0 ? -1 : 1;
6480 * When the result of collation is equality, that doesn't mean
6481 * that there are no differences -- some locales exclude some
6482 * characters from consideration. So to avoid false equalities,
6483 * we use the raw string as a tiebreaker.
6489 #endif /* USE_LOCALE_COLLATE */
6491 return sv_cmp(sv1, sv2);
6495 #ifdef USE_LOCALE_COLLATE
6498 =for apidoc sv_collxfrm
6500 Add Collate Transform magic to an SV if it doesn't already have it.
6502 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6503 scalar data of the variable, but transformed to such a format that a normal
6504 memory comparison can be used to compare the data according to the locale
6511 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6516 PERL_ARGS_ASSERT_SV_COLLXFRM;
6518 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6519 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6525 Safefree(mg->mg_ptr);
6526 s = SvPV_const(sv, len);
6527 if ((xf = mem_collxfrm(s, len, &xlen))) {
6529 #ifdef PERL_OLD_COPY_ON_WRITE
6531 sv_force_normal_flags(sv, 0);
6533 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6547 if (mg && mg->mg_ptr) {
6549 return mg->mg_ptr + sizeof(PL_collation_ix);
6557 #endif /* USE_LOCALE_COLLATE */
6562 Get a line from the filehandle and store it into the SV, optionally
6563 appending to the currently-stored string.
6569 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6574 register STDCHAR rslast;
6575 register STDCHAR *bp;
6580 PERL_ARGS_ASSERT_SV_GETS;
6582 if (SvTHINKFIRST(sv))
6583 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6584 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6586 However, perlbench says it's slower, because the existing swipe code
6587 is faster than copy on write.
6588 Swings and roundabouts. */
6589 SvUPGRADE(sv, SVt_PV);
6594 if (PerlIO_isutf8(fp)) {
6596 sv_utf8_upgrade_nomg(sv);
6597 sv_pos_u2b(sv,&append,0);
6599 } else if (SvUTF8(sv)) {
6600 SV * const tsv = newSV(0);
6601 sv_gets(tsv, fp, 0);
6602 sv_utf8_upgrade_nomg(tsv);
6603 SvCUR_set(sv,append);
6606 goto return_string_or_null;
6611 if (PerlIO_isutf8(fp))
6614 if (IN_PERL_COMPILETIME) {
6615 /* we always read code in line mode */
6619 else if (RsSNARF(PL_rs)) {
6620 /* If it is a regular disk file use size from stat() as estimate
6621 of amount we are going to read -- may result in mallocing
6622 more memory than we really need if the layers below reduce
6623 the size we read (e.g. CRLF or a gzip layer).
6626 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6627 const Off_t offset = PerlIO_tell(fp);
6628 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6629 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6635 else if (RsRECORD(PL_rs)) {
6640 /* Grab the size of the record we're getting */
6641 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6642 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6645 /* VMS wants read instead of fread, because fread doesn't respect */
6646 /* RMS record boundaries. This is not necessarily a good thing to be */
6647 /* doing, but we've got no other real choice - except avoid stdio
6648 as implementation - perhaps write a :vms layer ?
6650 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6652 bytesread = PerlIO_read(fp, buffer, recsize);
6656 SvCUR_set(sv, bytesread += append);
6657 buffer[bytesread] = '\0';
6658 goto return_string_or_null;
6660 else if (RsPARA(PL_rs)) {
6666 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6667 if (PerlIO_isutf8(fp)) {
6668 rsptr = SvPVutf8(PL_rs, rslen);
6671 if (SvUTF8(PL_rs)) {
6672 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6673 Perl_croak(aTHX_ "Wide character in $/");
6676 rsptr = SvPV_const(PL_rs, rslen);
6680 rslast = rslen ? rsptr[rslen - 1] : '\0';
6682 if (rspara) { /* have to do this both before and after */
6683 do { /* to make sure file boundaries work right */
6686 i = PerlIO_getc(fp);
6690 PerlIO_ungetc(fp,i);
6696 /* See if we know enough about I/O mechanism to cheat it ! */
6698 /* This used to be #ifdef test - it is made run-time test for ease
6699 of abstracting out stdio interface. One call should be cheap
6700 enough here - and may even be a macro allowing compile
6704 if (PerlIO_fast_gets(fp)) {
6707 * We're going to steal some values from the stdio struct
6708 * and put EVERYTHING in the innermost loop into registers.
6710 register STDCHAR *ptr;
6714 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6715 /* An ungetc()d char is handled separately from the regular
6716 * buffer, so we getc() it back out and stuff it in the buffer.
6718 i = PerlIO_getc(fp);
6719 if (i == EOF) return 0;
6720 *(--((*fp)->_ptr)) = (unsigned char) i;
6724 /* Here is some breathtakingly efficient cheating */
6726 cnt = PerlIO_get_cnt(fp); /* get count into register */
6727 /* make sure we have the room */
6728 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6729 /* Not room for all of it
6730 if we are looking for a separator and room for some
6732 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6733 /* just process what we have room for */
6734 shortbuffered = cnt - SvLEN(sv) + append + 1;
6735 cnt -= shortbuffered;
6739 /* remember that cnt can be negative */
6740 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6745 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6746 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6747 DEBUG_P(PerlIO_printf(Perl_debug_log,
6748 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6749 DEBUG_P(PerlIO_printf(Perl_debug_log,
6750 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6751 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6752 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6757 while (cnt > 0) { /* this | eat */
6759 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6760 goto thats_all_folks; /* screams | sed :-) */
6764 Copy(ptr, bp, cnt, char); /* this | eat */
6765 bp += cnt; /* screams | dust */
6766 ptr += cnt; /* louder | sed :-) */
6771 if (shortbuffered) { /* oh well, must extend */
6772 cnt = shortbuffered;
6774 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6776 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6777 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6781 DEBUG_P(PerlIO_printf(Perl_debug_log,
6782 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6783 PTR2UV(ptr),(long)cnt));
6784 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6786 DEBUG_P(PerlIO_printf(Perl_debug_log,
6787 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6788 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6789 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6791 /* This used to call 'filbuf' in stdio form, but as that behaves like
6792 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6793 another abstraction. */
6794 i = PerlIO_getc(fp); /* get more characters */
6796 DEBUG_P(PerlIO_printf(Perl_debug_log,
6797 "Screamer: post: 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 cnt = PerlIO_get_cnt(fp);
6802 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6803 DEBUG_P(PerlIO_printf(Perl_debug_log,
6804 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6806 if (i == EOF) /* all done for ever? */
6807 goto thats_really_all_folks;
6809 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6811 SvGROW(sv, bpx + cnt + 2);
6812 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6814 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6816 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6817 goto thats_all_folks;
6821 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6822 memNE((char*)bp - rslen, rsptr, rslen))
6823 goto screamer; /* go back to the fray */
6824 thats_really_all_folks:
6826 cnt += shortbuffered;
6827 DEBUG_P(PerlIO_printf(Perl_debug_log,
6828 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6829 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6830 DEBUG_P(PerlIO_printf(Perl_debug_log,
6831 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6832 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6833 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6835 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6836 DEBUG_P(PerlIO_printf(Perl_debug_log,
6837 "Screamer: done, len=%ld, string=|%.*s|\n",
6838 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6842 /*The big, slow, and stupid way. */
6843 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6844 STDCHAR *buf = NULL;
6845 Newx(buf, 8192, STDCHAR);
6853 register const STDCHAR * const bpe = buf + sizeof(buf);
6855 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6856 ; /* keep reading */
6860 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6861 /* Accomodate broken VAXC compiler, which applies U8 cast to
6862 * both args of ?: operator, causing EOF to change into 255
6865 i = (U8)buf[cnt - 1];
6871 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6873 sv_catpvn(sv, (char *) buf, cnt);
6875 sv_setpvn(sv, (char *) buf, cnt);
6877 if (i != EOF && /* joy */
6879 SvCUR(sv) < rslen ||
6880 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6884 * If we're reading from a TTY and we get a short read,
6885 * indicating that the user hit his EOF character, we need
6886 * to notice it now, because if we try to read from the TTY
6887 * again, the EOF condition will disappear.
6889 * The comparison of cnt to sizeof(buf) is an optimization
6890 * that prevents unnecessary calls to feof().
6894 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6898 #ifdef USE_HEAP_INSTEAD_OF_STACK
6903 if (rspara) { /* have to do this both before and after */
6904 while (i != EOF) { /* to make sure file boundaries work right */
6905 i = PerlIO_getc(fp);
6907 PerlIO_ungetc(fp,i);
6913 return_string_or_null:
6914 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6920 Auto-increment of the value in the SV, doing string to numeric conversion
6921 if necessary. Handles 'get' magic.
6927 Perl_sv_inc(pTHX_ register SV *const sv)
6936 if (SvTHINKFIRST(sv)) {
6938 sv_force_normal_flags(sv, 0);
6939 if (SvREADONLY(sv)) {
6940 if (IN_PERL_RUNTIME)
6941 Perl_croak(aTHX_ PL_no_modify);
6945 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6947 i = PTR2IV(SvRV(sv));
6952 flags = SvFLAGS(sv);
6953 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6954 /* It's (privately or publicly) a float, but not tested as an
6955 integer, so test it to see. */
6957 flags = SvFLAGS(sv);
6959 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6960 /* It's publicly an integer, or privately an integer-not-float */
6961 #ifdef PERL_PRESERVE_IVUV
6965 if (SvUVX(sv) == UV_MAX)
6966 sv_setnv(sv, UV_MAX_P1);
6968 (void)SvIOK_only_UV(sv);
6969 SvUV_set(sv, SvUVX(sv) + 1);
6971 if (SvIVX(sv) == IV_MAX)
6972 sv_setuv(sv, (UV)IV_MAX + 1);
6974 (void)SvIOK_only(sv);
6975 SvIV_set(sv, SvIVX(sv) + 1);
6980 if (flags & SVp_NOK) {
6981 const NV was = SvNVX(sv);
6982 if (NV_OVERFLOWS_INTEGERS_AT &&
6983 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6984 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6985 "Lost precision when incrementing %" NVff " by 1",
6988 (void)SvNOK_only(sv);
6989 SvNV_set(sv, was + 1.0);
6993 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6994 if ((flags & SVTYPEMASK) < SVt_PVIV)
6995 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6996 (void)SvIOK_only(sv);
7001 while (isALPHA(*d)) d++;
7002 while (isDIGIT(*d)) d++;
7004 #ifdef PERL_PRESERVE_IVUV
7005 /* Got to punt this as an integer if needs be, but we don't issue
7006 warnings. Probably ought to make the sv_iv_please() that does
7007 the conversion if possible, and silently. */
7008 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7009 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7010 /* Need to try really hard to see if it's an integer.
7011 9.22337203685478e+18 is an integer.
7012 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7013 so $a="9.22337203685478e+18"; $a+0; $a++
7014 needs to be the same as $a="9.22337203685478e+18"; $a++
7021 /* sv_2iv *should* have made this an NV */
7022 if (flags & SVp_NOK) {
7023 (void)SvNOK_only(sv);
7024 SvNV_set(sv, SvNVX(sv) + 1.0);
7027 /* I don't think we can get here. Maybe I should assert this
7028 And if we do get here I suspect that sv_setnv will croak. NWC
7030 #if defined(USE_LONG_DOUBLE)
7031 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",
7032 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7034 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7035 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7038 #endif /* PERL_PRESERVE_IVUV */
7039 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7043 while (d >= SvPVX_const(sv)) {
7051 /* MKS: The original code here died if letters weren't consecutive.
7052 * at least it didn't have to worry about non-C locales. The
7053 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7054 * arranged in order (although not consecutively) and that only
7055 * [A-Za-z] are accepted by isALPHA in the C locale.
7057 if (*d != 'z' && *d != 'Z') {
7058 do { ++*d; } while (!isALPHA(*d));
7061 *(d--) -= 'z' - 'a';
7066 *(d--) -= 'z' - 'a' + 1;
7070 /* oh,oh, the number grew */
7071 SvGROW(sv, SvCUR(sv) + 2);
7072 SvCUR_set(sv, SvCUR(sv) + 1);
7073 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7084 Auto-decrement of the value in the SV, doing string to numeric conversion
7085 if necessary. Handles 'get' magic.
7091 Perl_sv_dec(pTHX_ register SV *const sv)
7099 if (SvTHINKFIRST(sv)) {
7101 sv_force_normal_flags(sv, 0);
7102 if (SvREADONLY(sv)) {
7103 if (IN_PERL_RUNTIME)
7104 Perl_croak(aTHX_ PL_no_modify);
7108 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7110 i = PTR2IV(SvRV(sv));
7115 /* Unlike sv_inc we don't have to worry about string-never-numbers
7116 and keeping them magic. But we mustn't warn on punting */
7117 flags = SvFLAGS(sv);
7118 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7119 /* It's publicly an integer, or privately an integer-not-float */
7120 #ifdef PERL_PRESERVE_IVUV
7124 if (SvUVX(sv) == 0) {
7125 (void)SvIOK_only(sv);
7129 (void)SvIOK_only_UV(sv);
7130 SvUV_set(sv, SvUVX(sv) - 1);
7133 if (SvIVX(sv) == IV_MIN) {
7134 sv_setnv(sv, (NV)IV_MIN);
7138 (void)SvIOK_only(sv);
7139 SvIV_set(sv, SvIVX(sv) - 1);
7144 if (flags & SVp_NOK) {
7147 const NV was = SvNVX(sv);
7148 if (NV_OVERFLOWS_INTEGERS_AT &&
7149 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7150 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7151 "Lost precision when decrementing %" NVff " by 1",
7154 (void)SvNOK_only(sv);
7155 SvNV_set(sv, was - 1.0);
7159 if (!(flags & SVp_POK)) {
7160 if ((flags & SVTYPEMASK) < SVt_PVIV)
7161 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7163 (void)SvIOK_only(sv);
7166 #ifdef PERL_PRESERVE_IVUV
7168 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7169 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7170 /* Need to try really hard to see if it's an integer.
7171 9.22337203685478e+18 is an integer.
7172 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7173 so $a="9.22337203685478e+18"; $a+0; $a--
7174 needs to be the same as $a="9.22337203685478e+18"; $a--
7181 /* sv_2iv *should* have made this an NV */
7182 if (flags & SVp_NOK) {
7183 (void)SvNOK_only(sv);
7184 SvNV_set(sv, SvNVX(sv) - 1.0);
7187 /* I don't think we can get here. Maybe I should assert this
7188 And if we do get here I suspect that sv_setnv will croak. NWC
7190 #if defined(USE_LONG_DOUBLE)
7191 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",
7192 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7194 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7195 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7199 #endif /* PERL_PRESERVE_IVUV */
7200 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7204 =for apidoc sv_mortalcopy
7206 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7207 The new SV is marked as mortal. It will be destroyed "soon", either by an
7208 explicit call to FREETMPS, or by an implicit call at places such as
7209 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7214 /* Make a string that will exist for the duration of the expression
7215 * evaluation. Actually, it may have to last longer than that, but
7216 * hopefully we won't free it until it has been assigned to a
7217 * permanent location. */
7220 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7226 sv_setsv(sv,oldstr);
7228 PL_tmps_stack[++PL_tmps_ix] = sv;
7234 =for apidoc sv_newmortal
7236 Creates a new null SV which is mortal. The reference count of the SV is
7237 set to 1. It will be destroyed "soon", either by an explicit call to
7238 FREETMPS, or by an implicit call at places such as statement boundaries.
7239 See also C<sv_mortalcopy> and C<sv_2mortal>.
7245 Perl_sv_newmortal(pTHX)
7251 SvFLAGS(sv) = SVs_TEMP;
7253 PL_tmps_stack[++PL_tmps_ix] = sv;
7259 =for apidoc newSVpvn_flags
7261 Creates a new SV and copies a string into it. The reference count for the
7262 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7263 string. You are responsible for ensuring that the source string is at least
7264 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7265 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7266 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7267 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7268 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7270 #define newSVpvn_utf8(s, len, u) \
7271 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7277 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7282 /* All the flags we don't support must be zero.
7283 And we're new code so I'm going to assert this from the start. */
7284 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7286 sv_setpvn(sv,s,len);
7287 SvFLAGS(sv) |= (flags & SVf_UTF8);
7288 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7292 =for apidoc sv_2mortal
7294 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7295 by an explicit call to FREETMPS, or by an implicit call at places such as
7296 statement boundaries. SvTEMP() is turned on which means that the SV's
7297 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7298 and C<sv_mortalcopy>.
7304 Perl_sv_2mortal(pTHX_ register SV *const sv)
7309 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7312 PL_tmps_stack[++PL_tmps_ix] = sv;
7320 Creates a new SV and copies a string into it. The reference count for the
7321 SV is set to 1. If C<len> is zero, Perl will compute the length using
7322 strlen(). For efficiency, consider using C<newSVpvn> instead.
7328 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7334 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7339 =for apidoc newSVpvn
7341 Creates a new SV and copies a string into it. The reference count for the
7342 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7343 string. You are responsible for ensuring that the source string is at least
7344 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7350 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7356 sv_setpvn(sv,s,len);
7361 =for apidoc newSVhek
7363 Creates a new SV from the hash key structure. It will generate scalars that
7364 point to the shared string table where possible. Returns a new (undefined)
7365 SV if the hek is NULL.
7371 Perl_newSVhek(pTHX_ const HEK *const hek)
7381 if (HEK_LEN(hek) == HEf_SVKEY) {
7382 return newSVsv(*(SV**)HEK_KEY(hek));
7384 const int flags = HEK_FLAGS(hek);
7385 if (flags & HVhek_WASUTF8) {
7387 Andreas would like keys he put in as utf8 to come back as utf8
7389 STRLEN utf8_len = HEK_LEN(hek);
7390 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7391 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7394 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7396 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7397 /* We don't have a pointer to the hv, so we have to replicate the
7398 flag into every HEK. This hv is using custom a hasing
7399 algorithm. Hence we can't return a shared string scalar, as
7400 that would contain the (wrong) hash value, and might get passed
7401 into an hv routine with a regular hash.
7402 Similarly, a hash that isn't using shared hash keys has to have
7403 the flag in every key so that we know not to try to call
7404 share_hek_kek on it. */
7406 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7411 /* This will be overwhelminly the most common case. */
7413 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7414 more efficient than sharepvn(). */
7418 sv_upgrade(sv, SVt_PV);
7419 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7420 SvCUR_set(sv, HEK_LEN(hek));
7433 =for apidoc newSVpvn_share
7435 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7436 table. If the string does not already exist in the table, it is created
7437 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7438 value is used; otherwise the hash is computed. The string's hash can be later
7439 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7440 that as the string table is used for shared hash keys these strings will have
7441 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7447 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7451 bool is_utf8 = FALSE;
7452 const char *const orig_src = src;
7455 STRLEN tmplen = -len;
7457 /* See the note in hv.c:hv_fetch() --jhi */
7458 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7462 PERL_HASH(hash, src, len);
7464 sv_upgrade(sv, SVt_PV);
7465 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7473 if (src != orig_src)
7479 #if defined(PERL_IMPLICIT_CONTEXT)
7481 /* pTHX_ magic can't cope with varargs, so this is a no-context
7482 * version of the main function, (which may itself be aliased to us).
7483 * Don't access this version directly.
7487 Perl_newSVpvf_nocontext(const char *const pat, ...)
7493 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7495 va_start(args, pat);
7496 sv = vnewSVpvf(pat, &args);
7503 =for apidoc newSVpvf
7505 Creates a new SV and initializes it with the string formatted like
7512 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7517 PERL_ARGS_ASSERT_NEWSVPVF;
7519 va_start(args, pat);
7520 sv = vnewSVpvf(pat, &args);
7525 /* backend for newSVpvf() and newSVpvf_nocontext() */
7528 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7533 PERL_ARGS_ASSERT_VNEWSVPVF;
7536 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7543 Creates a new SV and copies a floating point value into it.
7544 The reference count for the SV is set to 1.
7550 Perl_newSVnv(pTHX_ const NV n)
7563 Creates a new SV and copies an integer into it. The reference count for the
7570 Perl_newSViv(pTHX_ const IV i)
7583 Creates a new SV and copies an unsigned integer into it.
7584 The reference count for the SV is set to 1.
7590 Perl_newSVuv(pTHX_ const UV u)
7601 =for apidoc newSV_type
7603 Creates a new SV, of the type specified. The reference count for the new SV
7610 Perl_newSV_type(pTHX_ const svtype type)
7615 sv_upgrade(sv, type);
7620 =for apidoc newRV_noinc
7622 Creates an RV wrapper for an SV. The reference count for the original
7623 SV is B<not> incremented.
7629 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7632 register SV *sv = newSV_type(SVt_IV);
7634 PERL_ARGS_ASSERT_NEWRV_NOINC;
7637 SvRV_set(sv, tmpRef);
7642 /* newRV_inc is the official function name to use now.
7643 * newRV_inc is in fact #defined to newRV in sv.h
7647 Perl_newRV(pTHX_ SV *const sv)
7651 PERL_ARGS_ASSERT_NEWRV;
7653 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7659 Creates a new SV which is an exact duplicate of the original SV.
7666 Perl_newSVsv(pTHX_ register SV *const old)
7673 if (SvTYPE(old) == SVTYPEMASK) {
7674 if (ckWARN_d(WARN_INTERNAL))
7675 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7679 /* SV_GMAGIC is the default for sv_setv()
7680 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7681 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7682 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7687 =for apidoc sv_reset
7689 Underlying implementation for the C<reset> Perl function.
7690 Note that the perl-level function is vaguely deprecated.
7696 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7699 char todo[PERL_UCHAR_MAX+1];
7701 PERL_ARGS_ASSERT_SV_RESET;
7706 if (!*s) { /* reset ?? searches */
7707 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7709 const U32 count = mg->mg_len / sizeof(PMOP**);
7710 PMOP **pmp = (PMOP**) mg->mg_ptr;
7711 PMOP *const *const end = pmp + count;
7715 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7717 (*pmp)->op_pmflags &= ~PMf_USED;
7725 /* reset variables */
7727 if (!HvARRAY(stash))
7730 Zero(todo, 256, char);
7733 I32 i = (unsigned char)*s;
7737 max = (unsigned char)*s++;
7738 for ( ; i <= max; i++) {
7741 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7743 for (entry = HvARRAY(stash)[i];
7745 entry = HeNEXT(entry))
7750 if (!todo[(U8)*HeKEY(entry)])
7752 gv = (GV*)HeVAL(entry);
7755 if (SvTHINKFIRST(sv)) {
7756 if (!SvREADONLY(sv) && SvROK(sv))
7758 /* XXX Is this continue a bug? Why should THINKFIRST
7759 exempt us from resetting arrays and hashes? */
7763 if (SvTYPE(sv) >= SVt_PV) {
7765 if (SvPVX_const(sv) != NULL)
7773 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7775 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7778 # if defined(USE_ENVIRON_ARRAY)
7781 # endif /* USE_ENVIRON_ARRAY */
7792 Using various gambits, try to get an IO from an SV: the IO slot if its a
7793 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7794 named after the PV if we're a string.
7800 Perl_sv_2io(pTHX_ SV *const sv)
7805 PERL_ARGS_ASSERT_SV_2IO;
7807 switch (SvTYPE(sv)) {
7815 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7819 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7821 return sv_2io(SvRV(sv));
7822 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7828 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7837 Using various gambits, try to get a CV from an SV; in addition, try if
7838 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7839 The flags in C<lref> are passed to sv_fetchsv.
7845 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7851 PERL_ARGS_ASSERT_SV_2CV;
7858 switch (SvTYPE(sv)) {
7876 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7878 tryAMAGICunDEREF(to_cv);
7881 if (SvTYPE(sv) == SVt_PVCV) {
7890 Perl_croak(aTHX_ "Not a subroutine reference");
7892 else if (isGV(sv)) {
7897 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7903 /* Some flags to gv_fetchsv mean don't really create the GV */
7904 if (SvTYPE(gv) != SVt_PVGV) {
7910 if (lref && !GvCVu(gv)) {
7914 gv_efullname3(tmpsv, gv, NULL);
7915 /* XXX this is probably not what they think they're getting.
7916 * It has the same effect as "sub name;", i.e. just a forward
7918 newSUB(start_subparse(FALSE, 0),
7919 newSVOP(OP_CONST, 0, tmpsv),
7923 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7924 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7933 Returns true if the SV has a true value by Perl's rules.
7934 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7935 instead use an in-line version.
7941 Perl_sv_true(pTHX_ register SV *const sv)
7946 register const XPV* const tXpv = (XPV*)SvANY(sv);
7948 (tXpv->xpv_cur > 1 ||
7949 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7956 return SvIVX(sv) != 0;
7959 return SvNVX(sv) != 0.0;
7961 return sv_2bool(sv);
7967 =for apidoc sv_pvn_force
7969 Get a sensible string out of the SV somehow.
7970 A private implementation of the C<SvPV_force> macro for compilers which
7971 can't cope with complex macro expressions. Always use the macro instead.
7973 =for apidoc sv_pvn_force_flags
7975 Get a sensible string out of the SV somehow.
7976 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7977 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7978 implemented in terms of this function.
7979 You normally want to use the various wrapper macros instead: see
7980 C<SvPV_force> and C<SvPV_force_nomg>
7986 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
7990 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7992 if (SvTHINKFIRST(sv) && !SvROK(sv))
7993 sv_force_normal_flags(sv, 0);
8003 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8004 const char * const ref = sv_reftype(sv,0);
8006 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8007 ref, OP_NAME(PL_op));
8009 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8011 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8012 || isGV_with_GP(sv))
8013 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8015 s = sv_2pv_flags(sv, &len, flags);
8019 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8022 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8023 SvGROW(sv, len + 1);
8024 Move(s,SvPVX(sv),len,char);
8026 SvPVX(sv)[len] = '\0';
8029 SvPOK_on(sv); /* validate pointer */
8031 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8032 PTR2UV(sv),SvPVX_const(sv)));
8035 return SvPVX_mutable(sv);
8039 =for apidoc sv_pvbyten_force
8041 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8047 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8049 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8051 sv_pvn_force(sv,lp);
8052 sv_utf8_downgrade(sv,0);
8058 =for apidoc sv_pvutf8n_force
8060 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8066 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8068 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8070 sv_pvn_force(sv,lp);
8071 sv_utf8_upgrade(sv);
8077 =for apidoc sv_reftype
8079 Returns a string describing what the SV is a reference to.
8085 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8087 PERL_ARGS_ASSERT_SV_REFTYPE;
8089 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8090 inside return suggests a const propagation bug in g++. */
8091 if (ob && SvOBJECT(sv)) {
8092 char * const name = HvNAME_get(SvSTASH(sv));
8093 return name ? name : (char *) "__ANON__";
8096 switch (SvTYPE(sv)) {
8111 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8112 /* tied lvalues should appear to be
8113 * scalars for backwards compatitbility */
8114 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8115 ? "SCALAR" : "LVALUE");
8116 case SVt_PVAV: return "ARRAY";
8117 case SVt_PVHV: return "HASH";
8118 case SVt_PVCV: return "CODE";
8119 case SVt_PVGV: return "GLOB";
8120 case SVt_PVFM: return "FORMAT";
8121 case SVt_PVIO: return "IO";
8122 case SVt_BIND: return "BIND";
8123 case SVt_REGEXP: return "REGEXP";
8124 default: return "UNKNOWN";
8130 =for apidoc sv_isobject
8132 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8133 object. If the SV is not an RV, or if the object is not blessed, then this
8140 Perl_sv_isobject(pTHX_ SV *sv)
8156 Returns a boolean indicating whether the SV is blessed into the specified
8157 class. This does not check for subtypes; use C<sv_derived_from> to verify
8158 an inheritance relationship.
8164 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8168 PERL_ARGS_ASSERT_SV_ISA;
8178 hvname = HvNAME_get(SvSTASH(sv));
8182 return strEQ(hvname, name);
8188 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8189 it will be upgraded to one. If C<classname> is non-null then the new SV will
8190 be blessed in the specified package. The new SV is returned and its
8191 reference count is 1.
8197 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8202 PERL_ARGS_ASSERT_NEWSVRV;
8206 SV_CHECK_THINKFIRST_COW_DROP(rv);
8207 (void)SvAMAGIC_off(rv);
8209 if (SvTYPE(rv) >= SVt_PVMG) {
8210 const U32 refcnt = SvREFCNT(rv);
8214 SvREFCNT(rv) = refcnt;
8216 sv_upgrade(rv, SVt_IV);
8217 } else if (SvROK(rv)) {
8218 SvREFCNT_dec(SvRV(rv));
8220 prepare_SV_for_RV(rv);
8228 HV* const stash = gv_stashpv(classname, GV_ADD);
8229 (void)sv_bless(rv, stash);
8235 =for apidoc sv_setref_pv
8237 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8238 argument will be upgraded to an RV. That RV will be modified to point to
8239 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8240 into the SV. The C<classname> argument indicates the package for the
8241 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8242 will have a reference count of 1, and the RV will be returned.
8244 Do not use with other Perl types such as HV, AV, SV, CV, because those
8245 objects will become corrupted by the pointer copy process.
8247 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8253 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8257 PERL_ARGS_ASSERT_SV_SETREF_PV;
8260 sv_setsv(rv, &PL_sv_undef);
8264 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8269 =for apidoc sv_setref_iv
8271 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8272 argument will be upgraded to an RV. That RV will be modified to point to
8273 the new SV. The C<classname> argument indicates the package for the
8274 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8275 will have a reference count of 1, and the RV will be returned.
8281 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8283 PERL_ARGS_ASSERT_SV_SETREF_IV;
8285 sv_setiv(newSVrv(rv,classname), iv);
8290 =for apidoc sv_setref_uv
8292 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8293 argument will be upgraded to an RV. That RV will be modified to point to
8294 the new SV. The C<classname> argument indicates the package for the
8295 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8296 will have a reference count of 1, and the RV will be returned.
8302 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8304 PERL_ARGS_ASSERT_SV_SETREF_UV;
8306 sv_setuv(newSVrv(rv,classname), uv);
8311 =for apidoc sv_setref_nv
8313 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8314 argument will be upgraded to an RV. That RV will be modified to point to
8315 the new SV. The C<classname> argument indicates the package for the
8316 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8317 will have a reference count of 1, and the RV will be returned.
8323 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8325 PERL_ARGS_ASSERT_SV_SETREF_NV;
8327 sv_setnv(newSVrv(rv,classname), nv);
8332 =for apidoc sv_setref_pvn
8334 Copies a string into a new SV, optionally blessing the SV. The length of the
8335 string must be specified with C<n>. The C<rv> argument will be upgraded to
8336 an RV. That RV will be modified to point to the new SV. The C<classname>
8337 argument indicates the package for the blessing. Set C<classname> to
8338 C<NULL> to avoid the blessing. The new SV will have a reference count
8339 of 1, and the RV will be returned.
8341 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8347 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8348 const char *const pv, const STRLEN n)
8350 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8352 sv_setpvn(newSVrv(rv,classname), pv, n);
8357 =for apidoc sv_bless
8359 Blesses an SV into a specified package. The SV must be an RV. The package
8360 must be designated by its stash (see C<gv_stashpv()>). The reference count
8361 of the SV is unaffected.
8367 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8372 PERL_ARGS_ASSERT_SV_BLESS;
8375 Perl_croak(aTHX_ "Can't bless non-reference value");
8377 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8378 if (SvIsCOW(tmpRef))
8379 sv_force_normal_flags(tmpRef, 0);
8380 if (SvREADONLY(tmpRef))
8381 Perl_croak(aTHX_ PL_no_modify);
8382 if (SvOBJECT(tmpRef)) {
8383 if (SvTYPE(tmpRef) != SVt_PVIO)
8385 SvREFCNT_dec(SvSTASH(tmpRef));
8388 SvOBJECT_on(tmpRef);
8389 if (SvTYPE(tmpRef) != SVt_PVIO)
8391 SvUPGRADE(tmpRef, SVt_PVMG);
8392 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8397 (void)SvAMAGIC_off(sv);
8399 if(SvSMAGICAL(tmpRef))
8400 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8408 /* Downgrades a PVGV to a PVMG.
8412 S_sv_unglob(pTHX_ SV *const sv)
8417 SV * const temp = sv_newmortal();
8419 PERL_ARGS_ASSERT_SV_UNGLOB;
8421 assert(SvTYPE(sv) == SVt_PVGV);
8423 gv_efullname3(temp, (GV *) sv, "*");
8426 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8427 mro_method_changed_in(stash);
8431 sv_del_backref((SV*)GvSTASH(sv), sv);
8435 if (GvNAME_HEK(sv)) {
8436 unshare_hek(GvNAME_HEK(sv));
8438 isGV_with_GP_off(sv);
8440 /* need to keep SvANY(sv) in the right arena */
8441 xpvmg = new_XPVMG();
8442 StructCopy(SvANY(sv), xpvmg, XPVMG);
8443 del_XPVGV(SvANY(sv));
8446 SvFLAGS(sv) &= ~SVTYPEMASK;
8447 SvFLAGS(sv) |= SVt_PVMG;
8449 /* Intentionally not calling any local SET magic, as this isn't so much a
8450 set operation as merely an internal storage change. */
8451 sv_setsv_flags(sv, temp, 0);
8455 =for apidoc sv_unref_flags
8457 Unsets the RV status of the SV, and decrements the reference count of
8458 whatever was being referenced by the RV. This can almost be thought of
8459 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8460 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8461 (otherwise the decrementing is conditional on the reference count being
8462 different from one or the reference being a readonly SV).
8469 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8471 SV* const target = SvRV(ref);
8473 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8475 if (SvWEAKREF(ref)) {
8476 sv_del_backref(target, ref);
8478 SvRV_set(ref, NULL);
8481 SvRV_set(ref, NULL);
8483 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8484 assigned to as BEGIN {$a = \"Foo"} will fail. */
8485 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8486 SvREFCNT_dec(target);
8487 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8488 sv_2mortal(target); /* Schedule for freeing later */
8492 =for apidoc sv_untaint
8494 Untaint an SV. Use C<SvTAINTED_off> instead.
8499 Perl_sv_untaint(pTHX_ SV *const sv)
8501 PERL_ARGS_ASSERT_SV_UNTAINT;
8503 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8504 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8511 =for apidoc sv_tainted
8513 Test an SV for taintedness. Use C<SvTAINTED> instead.
8518 Perl_sv_tainted(pTHX_ SV *const sv)
8520 PERL_ARGS_ASSERT_SV_TAINTED;
8522 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8523 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8524 if (mg && (mg->mg_len & 1) )
8531 =for apidoc sv_setpviv
8533 Copies an integer into the given SV, also updating its string value.
8534 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8540 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8542 char buf[TYPE_CHARS(UV)];
8544 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8546 PERL_ARGS_ASSERT_SV_SETPVIV;
8548 sv_setpvn(sv, ptr, ebuf - ptr);
8552 =for apidoc sv_setpviv_mg
8554 Like C<sv_setpviv>, but also handles 'set' magic.
8560 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8562 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8568 #if defined(PERL_IMPLICIT_CONTEXT)
8570 /* pTHX_ magic can't cope with varargs, so this is a no-context
8571 * version of the main function, (which may itself be aliased to us).
8572 * Don't access this version directly.
8576 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8581 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8583 va_start(args, pat);
8584 sv_vsetpvf(sv, pat, &args);
8588 /* pTHX_ magic can't cope with varargs, so this is a no-context
8589 * version of the main function, (which may itself be aliased to us).
8590 * Don't access this version directly.
8594 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8599 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8601 va_start(args, pat);
8602 sv_vsetpvf_mg(sv, pat, &args);
8608 =for apidoc sv_setpvf
8610 Works like C<sv_catpvf> but copies the text into the SV instead of
8611 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8617 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8621 PERL_ARGS_ASSERT_SV_SETPVF;
8623 va_start(args, pat);
8624 sv_vsetpvf(sv, pat, &args);
8629 =for apidoc sv_vsetpvf
8631 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8632 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8634 Usually used via its frontend C<sv_setpvf>.
8640 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8642 PERL_ARGS_ASSERT_SV_VSETPVF;
8644 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8648 =for apidoc sv_setpvf_mg
8650 Like C<sv_setpvf>, but also handles 'set' magic.
8656 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8660 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8662 va_start(args, pat);
8663 sv_vsetpvf_mg(sv, pat, &args);
8668 =for apidoc sv_vsetpvf_mg
8670 Like C<sv_vsetpvf>, but also handles 'set' magic.
8672 Usually used via its frontend C<sv_setpvf_mg>.
8678 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8680 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8682 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8686 #if defined(PERL_IMPLICIT_CONTEXT)
8688 /* pTHX_ magic can't cope with varargs, so this is a no-context
8689 * version of the main function, (which may itself be aliased to us).
8690 * Don't access this version directly.
8694 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8699 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8701 va_start(args, pat);
8702 sv_vcatpvf(sv, pat, &args);
8706 /* pTHX_ magic can't cope with varargs, so this is a no-context
8707 * version of the main function, (which may itself be aliased to us).
8708 * Don't access this version directly.
8712 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8717 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8719 va_start(args, pat);
8720 sv_vcatpvf_mg(sv, pat, &args);
8726 =for apidoc sv_catpvf
8728 Processes its arguments like C<sprintf> and appends the formatted
8729 output to an SV. If the appended data contains "wide" characters
8730 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8731 and characters >255 formatted with %c), the original SV might get
8732 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8733 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8734 valid UTF-8; if the original SV was bytes, the pattern should be too.
8739 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8743 PERL_ARGS_ASSERT_SV_CATPVF;
8745 va_start(args, pat);
8746 sv_vcatpvf(sv, pat, &args);
8751 =for apidoc sv_vcatpvf
8753 Processes its arguments like C<vsprintf> and appends the formatted output
8754 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8756 Usually used via its frontend C<sv_catpvf>.
8762 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8764 PERL_ARGS_ASSERT_SV_VCATPVF;
8766 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8770 =for apidoc sv_catpvf_mg
8772 Like C<sv_catpvf>, but also handles 'set' magic.
8778 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8782 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8784 va_start(args, pat);
8785 sv_vcatpvf_mg(sv, pat, &args);
8790 =for apidoc sv_vcatpvf_mg
8792 Like C<sv_vcatpvf>, but also handles 'set' magic.
8794 Usually used via its frontend C<sv_catpvf_mg>.
8800 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8802 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8804 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8809 =for apidoc sv_vsetpvfn
8811 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8814 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8820 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8821 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8823 PERL_ARGS_ASSERT_SV_VSETPVFN;
8825 sv_setpvn(sv, "", 0);
8826 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8830 S_expect_number(pTHX_ char **const pattern)
8835 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8837 switch (**pattern) {
8838 case '1': case '2': case '3':
8839 case '4': case '5': case '6':
8840 case '7': case '8': case '9':
8841 var = *(*pattern)++ - '0';
8842 while (isDIGIT(**pattern)) {
8843 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8845 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8853 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8855 const int neg = nv < 0;
8858 PERL_ARGS_ASSERT_F0CONVERT;
8866 if (uv & 1 && uv == nv)
8867 uv--; /* Round to even */
8869 const unsigned dig = uv % 10;
8882 =for apidoc sv_vcatpvfn
8884 Processes its arguments like C<vsprintf> and appends the formatted output
8885 to an SV. Uses an array of SVs if the C style variable argument list is
8886 missing (NULL). When running with taint checks enabled, indicates via
8887 C<maybe_tainted> if results are untrustworthy (often due to the use of
8890 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8896 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8897 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8898 vec_utf8 = DO_UTF8(vecsv);
8900 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8903 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8904 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8912 static const char nullstr[] = "(null)";
8914 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8915 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8917 /* Times 4: a decimal digit takes more than 3 binary digits.
8918 * NV_DIG: mantissa takes than many decimal digits.
8919 * Plus 32: Playing safe. */
8920 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8921 /* large enough for "%#.#f" --chip */
8922 /* what about long double NVs? --jhi */
8924 PERL_ARGS_ASSERT_SV_VCATPVFN;
8925 PERL_UNUSED_ARG(maybe_tainted);
8927 /* no matter what, this is a string now */
8928 (void)SvPV_force(sv, origlen);
8930 /* special-case "", "%s", and "%-p" (SVf - see below) */
8933 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8935 const char * const s = va_arg(*args, char*);
8936 sv_catpv(sv, s ? s : nullstr);
8938 else if (svix < svmax) {
8939 sv_catsv(sv, *svargs);
8943 if (args && patlen == 3 && pat[0] == '%' &&
8944 pat[1] == '-' && pat[2] == 'p') {
8945 argsv = (SV*)va_arg(*args, void*);
8946 sv_catsv(sv, argsv);
8950 #ifndef USE_LONG_DOUBLE
8951 /* special-case "%.<number>[gf]" */
8952 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8953 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8954 unsigned digits = 0;
8958 while (*pp >= '0' && *pp <= '9')
8959 digits = 10 * digits + (*pp++ - '0');
8960 if (pp - pat == (int)patlen - 1) {
8968 /* Add check for digits != 0 because it seems that some
8969 gconverts are buggy in this case, and we don't yet have
8970 a Configure test for this. */
8971 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8972 /* 0, point, slack */
8973 Gconvert(nv, (int)digits, 0, ebuf);
8975 if (*ebuf) /* May return an empty string for digits==0 */
8978 } else if (!digits) {
8981 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8982 sv_catpvn(sv, p, l);
8988 #endif /* !USE_LONG_DOUBLE */
8990 if (!args && svix < svmax && DO_UTF8(*svargs))
8993 patend = (char*)pat + patlen;
8994 for (p = (char*)pat; p < patend; p = q) {
8997 bool vectorize = FALSE;
8998 bool vectorarg = FALSE;
8999 bool vec_utf8 = FALSE;
9005 bool has_precis = FALSE;
9007 const I32 osvix = svix;
9008 bool is_utf8 = FALSE; /* is this item utf8? */
9009 #ifdef HAS_LDBL_SPRINTF_BUG
9010 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9011 with sfio - Allen <allens@cpan.org> */
9012 bool fix_ldbl_sprintf_bug = FALSE;
9016 U8 utf8buf[UTF8_MAXBYTES+1];
9017 STRLEN esignlen = 0;
9019 const char *eptr = NULL;
9022 const U8 *vecstr = NULL;
9029 /* we need a long double target in case HAS_LONG_DOUBLE but
9032 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9040 const char *dotstr = ".";
9041 STRLEN dotstrlen = 1;
9042 I32 efix = 0; /* explicit format parameter index */
9043 I32 ewix = 0; /* explicit width index */
9044 I32 epix = 0; /* explicit precision index */
9045 I32 evix = 0; /* explicit vector index */
9046 bool asterisk = FALSE;
9048 /* echo everything up to the next format specification */
9049 for (q = p; q < patend && *q != '%'; ++q) ;
9051 if (has_utf8 && !pat_utf8)
9052 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9054 sv_catpvn(sv, p, q - p);
9061 We allow format specification elements in this order:
9062 \d+\$ explicit format parameter index
9064 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9065 0 flag (as above): repeated to allow "v02"
9066 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9067 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9069 [%bcdefginopsuxDFOUX] format (mandatory)
9074 As of perl5.9.3, printf format checking is on by default.
9075 Internally, perl uses %p formats to provide an escape to
9076 some extended formatting. This block deals with those
9077 extensions: if it does not match, (char*)q is reset and
9078 the normal format processing code is used.
9080 Currently defined extensions are:
9081 %p include pointer address (standard)
9082 %-p (SVf) include an SV (previously %_)
9083 %-<num>p include an SV with precision <num>
9084 %<num>p reserved for future extensions
9086 Robin Barker 2005-07-14
9088 %1p (VDf) removed. RMB 2007-10-19
9095 n = expect_number(&q);
9102 argsv = (SV*)va_arg(*args, void*);
9103 eptr = SvPV_const(argsv, elen);
9109 if (ckWARN_d(WARN_INTERNAL))
9110 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9111 "internal %%<num>p might conflict with future printf extensions");
9117 if ( (width = expect_number(&q)) ) {
9132 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9161 if ( (ewix = expect_number(&q)) )
9170 if ((vectorarg = asterisk)) {
9183 width = expect_number(&q);
9189 vecsv = va_arg(*args, SV*);
9191 vecsv = (evix > 0 && evix <= svmax)
9192 ? svargs[evix-1] : &PL_sv_undef;
9194 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9196 dotstr = SvPV_const(vecsv, dotstrlen);
9197 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9198 bad with tied or overloaded values that return UTF8. */
9201 else if (has_utf8) {
9202 vecsv = sv_mortalcopy(vecsv);
9203 sv_utf8_upgrade(vecsv);
9204 dotstr = SvPV_const(vecsv, dotstrlen);
9211 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9212 vecsv = svargs[efix ? efix-1 : svix++];
9213 vecstr = (U8*)SvPV_const(vecsv,veclen);
9214 vec_utf8 = DO_UTF8(vecsv);
9216 /* if this is a version object, we need to convert
9217 * back into v-string notation and then let the
9218 * vectorize happen normally
9220 if (sv_derived_from(vecsv, "version")) {
9221 char *version = savesvpv(vecsv);
9222 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9223 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9224 "vector argument not supported with alpha versions");
9227 vecsv = sv_newmortal();
9228 scan_vstring(version, version + veclen, vecsv);
9229 vecstr = (U8*)SvPV_const(vecsv, veclen);
9230 vec_utf8 = DO_UTF8(vecsv);
9242 i = va_arg(*args, int);
9244 i = (ewix ? ewix <= svmax : svix < svmax) ?
9245 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9247 width = (i < 0) ? -i : i;
9257 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9259 /* XXX: todo, support specified precision parameter */
9263 i = va_arg(*args, int);
9265 i = (ewix ? ewix <= svmax : svix < svmax)
9266 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9268 has_precis = !(i < 0);
9273 precis = precis * 10 + (*q++ - '0');
9282 case 'I': /* Ix, I32x, and I64x */
9284 if (q[1] == '6' && q[2] == '4') {
9290 if (q[1] == '3' && q[2] == '2') {
9300 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9311 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9312 if (*(q + 1) == 'l') { /* lld, llf */
9338 if (!vectorize && !args) {
9340 const I32 i = efix-1;
9341 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9343 argsv = (svix >= 0 && svix < svmax)
9344 ? svargs[svix++] : &PL_sv_undef;
9355 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9357 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9359 eptr = (char*)utf8buf;
9360 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9374 eptr = va_arg(*args, char*);
9376 #ifdef MACOS_TRADITIONAL
9377 /* On MacOS, %#s format is used for Pascal strings */
9382 elen = strlen(eptr);
9384 eptr = (char *)nullstr;
9385 elen = sizeof nullstr - 1;
9389 eptr = SvPV_const(argsv, elen);
9390 if (DO_UTF8(argsv)) {
9391 I32 old_precis = precis;
9392 if (has_precis && precis < elen) {
9394 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9397 if (width) { /* fudge width (can't fudge elen) */
9398 if (has_precis && precis < elen)
9399 width += precis - old_precis;
9401 width += elen - sv_len_utf8(argsv);
9408 if (has_precis && elen > precis)
9415 if (alt || vectorize)
9417 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9438 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9447 esignbuf[esignlen++] = plus;
9451 case 'h': iv = (short)va_arg(*args, int); break;
9452 case 'l': iv = va_arg(*args, long); break;
9453 case 'V': iv = va_arg(*args, IV); break;
9454 default: iv = va_arg(*args, int); break;
9456 case 'q': iv = va_arg(*args, Quad_t); break;
9461 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9463 case 'h': iv = (short)tiv; break;
9464 case 'l': iv = (long)tiv; break;
9466 default: iv = tiv; break;
9468 case 'q': iv = (Quad_t)tiv; break;
9472 if ( !vectorize ) /* we already set uv above */
9477 esignbuf[esignlen++] = plus;
9481 esignbuf[esignlen++] = '-';
9525 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9536 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9537 case 'l': uv = va_arg(*args, unsigned long); break;
9538 case 'V': uv = va_arg(*args, UV); break;
9539 default: uv = va_arg(*args, unsigned); break;
9541 case 'q': uv = va_arg(*args, Uquad_t); break;
9546 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9548 case 'h': uv = (unsigned short)tuv; break;
9549 case 'l': uv = (unsigned long)tuv; break;
9551 default: uv = tuv; break;
9553 case 'q': uv = (Uquad_t)tuv; break;
9560 char *ptr = ebuf + sizeof ebuf;
9561 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9567 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9573 esignbuf[esignlen++] = '0';
9574 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9582 if (alt && *ptr != '0')
9591 esignbuf[esignlen++] = '0';
9592 esignbuf[esignlen++] = c;
9595 default: /* it had better be ten or less */
9599 } while (uv /= base);
9602 elen = (ebuf + sizeof ebuf) - ptr;
9606 zeros = precis - elen;
9607 else if (precis == 0 && elen == 1 && *eptr == '0'
9608 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9611 /* a precision nullifies the 0 flag. */
9618 /* FLOATING POINT */
9621 c = 'f'; /* maybe %F isn't supported here */
9629 /* This is evil, but floating point is even more evil */
9631 /* for SV-style calling, we can only get NV
9632 for C-style calling, we assume %f is double;
9633 for simplicity we allow any of %Lf, %llf, %qf for long double
9637 #if defined(USE_LONG_DOUBLE)
9641 /* [perl #20339] - we should accept and ignore %lf rather than die */
9645 #if defined(USE_LONG_DOUBLE)
9646 intsize = args ? 0 : 'q';
9650 #if defined(HAS_LONG_DOUBLE)
9659 /* now we need (long double) if intsize == 'q', else (double) */
9661 #if LONG_DOUBLESIZE > DOUBLESIZE
9663 va_arg(*args, long double) :
9664 va_arg(*args, double)
9666 va_arg(*args, double)
9671 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9672 else. frexp() has some unspecified behaviour for those three */
9673 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9675 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9676 will cast our (long double) to (double) */
9677 (void)Perl_frexp(nv, &i);
9678 if (i == PERL_INT_MIN)
9679 Perl_die(aTHX_ "panic: frexp");
9681 need = BIT_DIGITS(i);
9683 need += has_precis ? precis : 6; /* known default */
9688 #ifdef HAS_LDBL_SPRINTF_BUG
9689 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9690 with sfio - Allen <allens@cpan.org> */
9693 # define MY_DBL_MAX DBL_MAX
9694 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9695 # if DOUBLESIZE >= 8
9696 # define MY_DBL_MAX 1.7976931348623157E+308L
9698 # define MY_DBL_MAX 3.40282347E+38L
9702 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9703 # define MY_DBL_MAX_BUG 1L
9705 # define MY_DBL_MAX_BUG MY_DBL_MAX
9709 # define MY_DBL_MIN DBL_MIN
9710 # else /* XXX guessing! -Allen */
9711 # if DOUBLESIZE >= 8
9712 # define MY_DBL_MIN 2.2250738585072014E-308L
9714 # define MY_DBL_MIN 1.17549435E-38L
9718 if ((intsize == 'q') && (c == 'f') &&
9719 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9721 /* it's going to be short enough that
9722 * long double precision is not needed */
9724 if ((nv <= 0L) && (nv >= -0L))
9725 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9727 /* would use Perl_fp_class as a double-check but not
9728 * functional on IRIX - see perl.h comments */
9730 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9731 /* It's within the range that a double can represent */
9732 #if defined(DBL_MAX) && !defined(DBL_MIN)
9733 if ((nv >= ((long double)1/DBL_MAX)) ||
9734 (nv <= (-(long double)1/DBL_MAX)))
9736 fix_ldbl_sprintf_bug = TRUE;
9739 if (fix_ldbl_sprintf_bug == TRUE) {
9749 # undef MY_DBL_MAX_BUG
9752 #endif /* HAS_LDBL_SPRINTF_BUG */
9754 need += 20; /* fudge factor */
9755 if (PL_efloatsize < need) {
9756 Safefree(PL_efloatbuf);
9757 PL_efloatsize = need + 20; /* more fudge */
9758 Newx(PL_efloatbuf, PL_efloatsize, char);
9759 PL_efloatbuf[0] = '\0';
9762 if ( !(width || left || plus || alt) && fill != '0'
9763 && has_precis && intsize != 'q' ) { /* Shortcuts */
9764 /* See earlier comment about buggy Gconvert when digits,
9766 if ( c == 'g' && precis) {
9767 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9768 /* May return an empty string for digits==0 */
9769 if (*PL_efloatbuf) {
9770 elen = strlen(PL_efloatbuf);
9771 goto float_converted;
9773 } else if ( c == 'f' && !precis) {
9774 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9779 char *ptr = ebuf + sizeof ebuf;
9782 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9783 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9784 if (intsize == 'q') {
9785 /* Copy the one or more characters in a long double
9786 * format before the 'base' ([efgEFG]) character to
9787 * the format string. */
9788 static char const prifldbl[] = PERL_PRIfldbl;
9789 char const *p = prifldbl + sizeof(prifldbl) - 3;
9790 while (p >= prifldbl) { *--ptr = *p--; }
9795 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9800 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9812 /* No taint. Otherwise we are in the strange situation
9813 * where printf() taints but print($float) doesn't.
9815 #if defined(HAS_LONG_DOUBLE)
9816 elen = ((intsize == 'q')
9817 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9818 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9820 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9824 eptr = PL_efloatbuf;
9832 i = SvCUR(sv) - origlen;
9835 case 'h': *(va_arg(*args, short*)) = i; break;
9836 default: *(va_arg(*args, int*)) = i; break;
9837 case 'l': *(va_arg(*args, long*)) = i; break;
9838 case 'V': *(va_arg(*args, IV*)) = i; break;
9840 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9845 sv_setuv_mg(argsv, (UV)i);
9846 continue; /* not "break" */
9853 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9854 && ckWARN(WARN_PRINTF))
9856 SV * const msg = sv_newmortal();
9857 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9858 (PL_op->op_type == OP_PRTF) ? "" : "s");
9861 Perl_sv_catpvf(aTHX_ msg,
9862 "\"%%%c\"", c & 0xFF);
9864 Perl_sv_catpvf(aTHX_ msg,
9865 "\"%%\\%03"UVof"\"",
9868 sv_catpvs(msg, "end of string");
9869 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9872 /* output mangled stuff ... */
9878 /* ... right here, because formatting flags should not apply */
9879 SvGROW(sv, SvCUR(sv) + elen + 1);
9881 Copy(eptr, p, elen, char);
9884 SvCUR_set(sv, p - SvPVX_const(sv));
9886 continue; /* not "break" */
9889 if (is_utf8 != has_utf8) {
9892 sv_utf8_upgrade(sv);
9895 const STRLEN old_elen = elen;
9896 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9897 sv_utf8_upgrade(nsv);
9898 eptr = SvPVX_const(nsv);
9901 if (width) { /* fudge width (can't fudge elen) */
9902 width += elen - old_elen;
9908 have = esignlen + zeros + elen;
9910 Perl_croak_nocontext(PL_memory_wrap);
9912 need = (have > width ? have : width);
9915 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9916 Perl_croak_nocontext(PL_memory_wrap);
9917 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9919 if (esignlen && fill == '0') {
9921 for (i = 0; i < (int)esignlen; i++)
9925 memset(p, fill, gap);
9928 if (esignlen && fill != '0') {
9930 for (i = 0; i < (int)esignlen; i++)
9935 for (i = zeros; i; i--)
9939 Copy(eptr, p, elen, char);
9943 memset(p, ' ', gap);
9948 Copy(dotstr, p, dotstrlen, char);
9952 vectorize = FALSE; /* done iterating over vecstr */
9959 SvCUR_set(sv, p - SvPVX_const(sv));
9967 /* =========================================================================
9969 =head1 Cloning an interpreter
9971 All the macros and functions in this section are for the private use of
9972 the main function, perl_clone().
9974 The foo_dup() functions make an exact copy of an existing foo thingy.
9975 During the course of a cloning, a hash table is used to map old addresses
9976 to new addresses. The table is created and manipulated with the
9977 ptr_table_* functions.
9981 ============================================================================*/
9984 #if defined(USE_ITHREADS)
9986 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9987 #ifndef GpREFCNT_inc
9988 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9992 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9993 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9994 If this changes, please unmerge ss_dup. */
9995 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9996 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9997 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9998 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9999 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10000 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10001 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10002 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10003 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10004 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10005 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10006 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10007 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10008 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10010 /* clone a parser */
10013 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10017 PERL_ARGS_ASSERT_PARSER_DUP;
10022 /* look for it in the table first */
10023 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10027 /* create anew and remember what it is */
10028 Newxz(parser, 1, yy_parser);
10029 ptr_table_store(PL_ptr_table, proto, parser);
10031 parser->yyerrstatus = 0;
10032 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10034 /* XXX these not yet duped */
10035 parser->old_parser = NULL;
10036 parser->stack = NULL;
10038 parser->stack_size = 0;
10039 /* XXX parser->stack->state = 0; */
10041 /* XXX eventually, just Copy() most of the parser struct ? */
10043 parser->lex_brackets = proto->lex_brackets;
10044 parser->lex_casemods = proto->lex_casemods;
10045 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10046 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10047 parser->lex_casestack = savepvn(proto->lex_casestack,
10048 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10049 parser->lex_defer = proto->lex_defer;
10050 parser->lex_dojoin = proto->lex_dojoin;
10051 parser->lex_expect = proto->lex_expect;
10052 parser->lex_formbrack = proto->lex_formbrack;
10053 parser->lex_inpat = proto->lex_inpat;
10054 parser->lex_inwhat = proto->lex_inwhat;
10055 parser->lex_op = proto->lex_op;
10056 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10057 parser->lex_starts = proto->lex_starts;
10058 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10059 parser->multi_close = proto->multi_close;
10060 parser->multi_open = proto->multi_open;
10061 parser->multi_start = proto->multi_start;
10062 parser->multi_end = proto->multi_end;
10063 parser->pending_ident = proto->pending_ident;
10064 parser->preambled = proto->preambled;
10065 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10066 parser->linestr = sv_dup_inc(proto->linestr, param);
10067 parser->expect = proto->expect;
10068 parser->copline = proto->copline;
10069 parser->last_lop_op = proto->last_lop_op;
10070 parser->lex_state = proto->lex_state;
10071 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10072 /* rsfp_filters entries have fake IoDIRP() */
10073 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10074 parser->in_my = proto->in_my;
10075 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10076 parser->error_count = proto->error_count;
10079 parser->linestr = sv_dup_inc(proto->linestr, param);
10082 char * const ols = SvPVX(proto->linestr);
10083 char * const ls = SvPVX(parser->linestr);
10085 parser->bufptr = ls + (proto->bufptr >= ols ?
10086 proto->bufptr - ols : 0);
10087 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10088 proto->oldbufptr - ols : 0);
10089 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10090 proto->oldoldbufptr - ols : 0);
10091 parser->linestart = ls + (proto->linestart >= ols ?
10092 proto->linestart - ols : 0);
10093 parser->last_uni = ls + (proto->last_uni >= ols ?
10094 proto->last_uni - ols : 0);
10095 parser->last_lop = ls + (proto->last_lop >= ols ?
10096 proto->last_lop - ols : 0);
10098 parser->bufend = ls + SvCUR(parser->linestr);
10101 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10105 parser->endwhite = proto->endwhite;
10106 parser->faketokens = proto->faketokens;
10107 parser->lasttoke = proto->lasttoke;
10108 parser->nextwhite = proto->nextwhite;
10109 parser->realtokenstart = proto->realtokenstart;
10110 parser->skipwhite = proto->skipwhite;
10111 parser->thisclose = proto->thisclose;
10112 parser->thismad = proto->thismad;
10113 parser->thisopen = proto->thisopen;
10114 parser->thisstuff = proto->thisstuff;
10115 parser->thistoken = proto->thistoken;
10116 parser->thiswhite = proto->thiswhite;
10118 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10119 parser->curforce = proto->curforce;
10121 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10122 Copy(proto->nexttype, parser->nexttype, 5, I32);
10123 parser->nexttoke = proto->nexttoke;
10129 /* duplicate a file handle */
10132 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10136 PERL_ARGS_ASSERT_FP_DUP;
10137 PERL_UNUSED_ARG(type);
10140 return (PerlIO*)NULL;
10142 /* look for it in the table first */
10143 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10147 /* create anew and remember what it is */
10148 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10149 ptr_table_store(PL_ptr_table, fp, ret);
10153 /* duplicate a directory handle */
10156 Perl_dirp_dup(pTHX_ DIR *const dp)
10158 PERL_UNUSED_CONTEXT;
10165 /* duplicate a typeglob */
10168 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10172 PERL_ARGS_ASSERT_GP_DUP;
10176 /* look for it in the table first */
10177 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10181 /* create anew and remember what it is */
10183 ptr_table_store(PL_ptr_table, gp, ret);
10186 ret->gp_refcnt = 0; /* must be before any other dups! */
10187 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10188 ret->gp_io = io_dup_inc(gp->gp_io, param);
10189 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10190 ret->gp_av = av_dup_inc(gp->gp_av, param);
10191 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10192 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10193 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10194 ret->gp_cvgen = gp->gp_cvgen;
10195 ret->gp_line = gp->gp_line;
10196 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10200 /* duplicate a chain of magic */
10203 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10205 MAGIC *mgprev = (MAGIC*)NULL;
10208 PERL_ARGS_ASSERT_MG_DUP;
10211 return (MAGIC*)NULL;
10212 /* look for it in the table first */
10213 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10217 for (; mg; mg = mg->mg_moremagic) {
10219 Newxz(nmg, 1, MAGIC);
10221 mgprev->mg_moremagic = nmg;
10224 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10225 nmg->mg_private = mg->mg_private;
10226 nmg->mg_type = mg->mg_type;
10227 nmg->mg_flags = mg->mg_flags;
10228 /* FIXME for plugins
10229 if (mg->mg_type == PERL_MAGIC_qr) {
10230 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10234 if(mg->mg_type == PERL_MAGIC_backref) {
10235 /* The backref AV has its reference count deliberately bumped by
10237 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10240 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10241 ? sv_dup_inc(mg->mg_obj, param)
10242 : sv_dup(mg->mg_obj, param);
10244 nmg->mg_len = mg->mg_len;
10245 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10246 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10247 if (mg->mg_len > 0) {
10248 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10249 if (mg->mg_type == PERL_MAGIC_overload_table &&
10250 AMT_AMAGIC((AMT*)mg->mg_ptr))
10252 const AMT * const amtp = (AMT*)mg->mg_ptr;
10253 AMT * const namtp = (AMT*)nmg->mg_ptr;
10255 for (i = 1; i < NofAMmeth; i++) {
10256 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10260 else if (mg->mg_len == HEf_SVKEY)
10261 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10263 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10264 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10271 #endif /* USE_ITHREADS */
10273 /* create a new pointer-mapping table */
10276 Perl_ptr_table_new(pTHX)
10279 PERL_UNUSED_CONTEXT;
10281 Newxz(tbl, 1, PTR_TBL_t);
10282 tbl->tbl_max = 511;
10283 tbl->tbl_items = 0;
10284 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10288 #define PTR_TABLE_HASH(ptr) \
10289 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10292 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10293 following define) and at call to new_body_inline made below in
10294 Perl_ptr_table_store()
10297 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10299 /* map an existing pointer using a table */
10301 STATIC PTR_TBL_ENT_t *
10302 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10304 PTR_TBL_ENT_t *tblent;
10305 const UV hash = PTR_TABLE_HASH(sv);
10307 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10309 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10310 for (; tblent; tblent = tblent->next) {
10311 if (tblent->oldval == sv)
10318 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10320 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10322 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10323 PERL_UNUSED_CONTEXT;
10325 return tblent ? tblent->newval : NULL;
10328 /* add a new entry to a pointer-mapping table */
10331 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10333 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10335 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10336 PERL_UNUSED_CONTEXT;
10339 tblent->newval = newsv;
10341 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10343 new_body_inline(tblent, PTE_SVSLOT);
10345 tblent->oldval = oldsv;
10346 tblent->newval = newsv;
10347 tblent->next = tbl->tbl_ary[entry];
10348 tbl->tbl_ary[entry] = tblent;
10350 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10351 ptr_table_split(tbl);
10355 /* double the hash bucket size of an existing ptr table */
10358 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10360 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10361 const UV oldsize = tbl->tbl_max + 1;
10362 UV newsize = oldsize * 2;
10365 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10366 PERL_UNUSED_CONTEXT;
10368 Renew(ary, newsize, PTR_TBL_ENT_t*);
10369 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10370 tbl->tbl_max = --newsize;
10371 tbl->tbl_ary = ary;
10372 for (i=0; i < oldsize; i++, ary++) {
10373 PTR_TBL_ENT_t **curentp, **entp, *ent;
10376 curentp = ary + oldsize;
10377 for (entp = ary, ent = *ary; ent; ent = *entp) {
10378 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10380 ent->next = *curentp;
10390 /* remove all the entries from a ptr table */
10393 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10395 if (tbl && tbl->tbl_items) {
10396 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10397 UV riter = tbl->tbl_max;
10400 PTR_TBL_ENT_t *entry = array[riter];
10403 PTR_TBL_ENT_t * const oentry = entry;
10404 entry = entry->next;
10409 tbl->tbl_items = 0;
10413 /* clear and free a ptr table */
10416 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10421 ptr_table_clear(tbl);
10422 Safefree(tbl->tbl_ary);
10426 #if defined(USE_ITHREADS)
10429 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10431 PERL_ARGS_ASSERT_RVPV_DUP;
10434 SvRV_set(dstr, SvWEAKREF(sstr)
10435 ? sv_dup(SvRV(sstr), param)
10436 : sv_dup_inc(SvRV(sstr), param));
10439 else if (SvPVX_const(sstr)) {
10440 /* Has something there */
10442 /* Normal PV - clone whole allocated space */
10443 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10444 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10445 /* Not that normal - actually sstr is copy on write.
10446 But we are a true, independant SV, so: */
10447 SvREADONLY_off(dstr);
10452 /* Special case - not normally malloced for some reason */
10453 if (isGV_with_GP(sstr)) {
10454 /* Don't need to do anything here. */
10456 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10457 /* A "shared" PV - clone it as "shared" PV */
10459 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10463 /* Some other special case - random pointer */
10464 SvPV_set(dstr, SvPVX(sstr));
10469 /* Copy the NULL */
10470 SvPV_set(dstr, NULL);
10474 /* duplicate an SV of any type (including AV, HV etc) */
10477 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10482 PERL_ARGS_ASSERT_SV_DUP;
10486 if (SvTYPE(sstr) == SVTYPEMASK) {
10487 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10492 /* look for it in the table first */
10493 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10497 if(param->flags & CLONEf_JOIN_IN) {
10498 /** We are joining here so we don't want do clone
10499 something that is bad **/
10500 if (SvTYPE(sstr) == SVt_PVHV) {
10501 const HEK * const hvname = HvNAME_HEK(sstr);
10503 /** don't clone stashes if they already exist **/
10504 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10508 /* create anew and remember what it is */
10511 #ifdef DEBUG_LEAKING_SCALARS
10512 dstr->sv_debug_optype = sstr->sv_debug_optype;
10513 dstr->sv_debug_line = sstr->sv_debug_line;
10514 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10515 dstr->sv_debug_cloned = 1;
10516 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10519 ptr_table_store(PL_ptr_table, sstr, dstr);
10522 SvFLAGS(dstr) = SvFLAGS(sstr);
10523 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10524 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10527 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10528 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10529 (void*)PL_watch_pvx, SvPVX_const(sstr));
10532 /* don't clone objects whose class has asked us not to */
10533 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10538 switch (SvTYPE(sstr)) {
10540 SvANY(dstr) = NULL;
10543 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10545 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10547 SvIV_set(dstr, SvIVX(sstr));
10551 SvANY(dstr) = new_XNV();
10552 SvNV_set(dstr, SvNVX(sstr));
10554 /* case SVt_BIND: */
10557 /* These are all the types that need complex bodies allocating. */
10559 const svtype sv_type = SvTYPE(sstr);
10560 const struct body_details *const sv_type_details
10561 = bodies_by_type + sv_type;
10565 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10569 if (GvUNIQUE((GV*)sstr)) {
10570 NOOP; /* Do sharing here, and fall through */
10583 assert(sv_type_details->body_size);
10584 if (sv_type_details->arena) {
10585 new_body_inline(new_body, sv_type);
10587 = (void*)((char*)new_body - sv_type_details->offset);
10589 new_body = new_NOARENA(sv_type_details);
10593 SvANY(dstr) = new_body;
10596 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10597 ((char*)SvANY(dstr)) + sv_type_details->offset,
10598 sv_type_details->copy, char);
10600 Copy(((char*)SvANY(sstr)),
10601 ((char*)SvANY(dstr)),
10602 sv_type_details->body_size + sv_type_details->offset, char);
10605 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10606 && !isGV_with_GP(dstr))
10607 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10609 /* The Copy above means that all the source (unduplicated) pointers
10610 are now in the destination. We can check the flags and the
10611 pointers in either, but it's possible that there's less cache
10612 missing by always going for the destination.
10613 FIXME - instrument and check that assumption */
10614 if (sv_type >= SVt_PVMG) {
10615 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10616 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10617 } else if (SvMAGIC(dstr))
10618 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10620 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10623 /* The cast silences a GCC warning about unhandled types. */
10624 switch ((int)sv_type) {
10634 /* FIXME for plugins */
10635 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10638 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10639 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10640 LvTARG(dstr) = dstr;
10641 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10642 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10644 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10646 if(isGV_with_GP(sstr)) {
10647 if (GvNAME_HEK(dstr))
10648 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10649 /* Don't call sv_add_backref here as it's going to be
10650 created as part of the magic cloning of the symbol
10652 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10653 at the point of this comment. */
10654 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10655 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10656 (void)GpREFCNT_inc(GvGP(dstr));
10658 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10661 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10662 if (IoOFP(dstr) == IoIFP(sstr))
10663 IoOFP(dstr) = IoIFP(dstr);
10665 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10666 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10667 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10668 /* I have no idea why fake dirp (rsfps)
10669 should be treated differently but otherwise
10670 we end up with leaks -- sky*/
10671 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10672 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10673 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10675 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10676 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10677 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10678 if (IoDIRP(dstr)) {
10679 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10682 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10685 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10686 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10687 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10690 if (AvARRAY((AV*)sstr)) {
10691 SV **dst_ary, **src_ary;
10692 SSize_t items = AvFILLp((AV*)sstr) + 1;
10694 src_ary = AvARRAY((AV*)sstr);
10695 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10696 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10697 AvARRAY((AV*)dstr) = dst_ary;
10698 AvALLOC((AV*)dstr) = dst_ary;
10699 if (AvREAL((AV*)sstr)) {
10700 while (items-- > 0)
10701 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10704 while (items-- > 0)
10705 *dst_ary++ = sv_dup(*src_ary++, param);
10707 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10708 while (items-- > 0) {
10709 *dst_ary++ = &PL_sv_undef;
10713 AvARRAY((AV*)dstr) = NULL;
10714 AvALLOC((AV*)dstr) = (SV**)NULL;
10718 if (HvARRAY((HV*)sstr)) {
10720 const bool sharekeys = !!HvSHAREKEYS(sstr);
10721 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10722 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10724 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10725 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10727 HvARRAY(dstr) = (HE**)darray;
10728 while (i <= sxhv->xhv_max) {
10729 const HE * const source = HvARRAY(sstr)[i];
10730 HvARRAY(dstr)[i] = source
10731 ? he_dup(source, sharekeys, param) : 0;
10736 const struct xpvhv_aux * const saux = HvAUX(sstr);
10737 struct xpvhv_aux * const daux = HvAUX(dstr);
10738 /* This flag isn't copied. */
10739 /* SvOOK_on(hv) attacks the IV flags. */
10740 SvFLAGS(dstr) |= SVf_OOK;
10742 hvname = saux->xhv_name;
10743 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10745 daux->xhv_riter = saux->xhv_riter;
10746 daux->xhv_eiter = saux->xhv_eiter
10747 ? he_dup(saux->xhv_eiter,
10748 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10749 daux->xhv_backreferences =
10750 saux->xhv_backreferences
10751 ? (AV*) SvREFCNT_inc(
10752 sv_dup((SV*)saux->xhv_backreferences, param))
10755 daux->xhv_mro_meta = saux->xhv_mro_meta
10756 ? mro_meta_dup(saux->xhv_mro_meta, param)
10759 /* Record stashes for possible cloning in Perl_clone(). */
10761 av_push(param->stashes, dstr);
10765 HvARRAY((HV*)dstr) = NULL;
10768 if (!(param->flags & CLONEf_COPY_STACKS)) {
10772 /* NOTE: not refcounted */
10773 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10775 if (!CvISXSUB(dstr))
10776 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10778 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10779 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10780 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10781 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10783 /* don't dup if copying back - CvGV isn't refcounted, so the
10784 * duped GV may never be freed. A bit of a hack! DAPM */
10785 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10786 NULL : gv_dup(CvGV(dstr), param) ;
10787 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10789 CvWEAKOUTSIDE(sstr)
10790 ? cv_dup( CvOUTSIDE(dstr), param)
10791 : cv_dup_inc(CvOUTSIDE(dstr), param);
10792 if (!CvISXSUB(dstr))
10793 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10799 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10805 /* duplicate a context */
10808 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10810 PERL_CONTEXT *ncxs;
10812 PERL_ARGS_ASSERT_CX_DUP;
10815 return (PERL_CONTEXT*)NULL;
10817 /* look for it in the table first */
10818 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10822 /* create anew and remember what it is */
10823 Newx(ncxs, max + 1, PERL_CONTEXT);
10824 ptr_table_store(PL_ptr_table, cxs, ncxs);
10825 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10828 PERL_CONTEXT * const ncx = &ncxs[ix];
10829 if (CxTYPE(ncx) == CXt_SUBST) {
10830 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10833 switch (CxTYPE(ncx)) {
10835 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10836 ? cv_dup_inc(ncx->blk_sub.cv, param)
10837 : cv_dup(ncx->blk_sub.cv,param));
10838 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10839 ? av_dup_inc(ncx->blk_sub.argarray,
10842 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10844 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10845 ncx->blk_sub.oldcomppad);
10848 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10850 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10852 case CXt_LOOP_LAZYSV:
10853 ncx->blk_loop.state_u.lazysv.end
10854 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10855 /* We are taking advantage of av_dup_inc and sv_dup_inc
10856 actually being the same function, and order equivalance of
10858 We can assert the later [but only at run time :-(] */
10859 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10860 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10862 ncx->blk_loop.state_u.ary.ary
10863 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10864 case CXt_LOOP_LAZYIV:
10865 case CXt_LOOP_PLAIN:
10866 if (CxPADLOOP(ncx)) {
10867 ncx->blk_loop.oldcomppad
10868 = (PAD*)ptr_table_fetch(PL_ptr_table,
10869 ncx->blk_loop.oldcomppad);
10871 ncx->blk_loop.oldcomppad
10872 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10876 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10877 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10878 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10891 /* duplicate a stack info structure */
10894 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10898 PERL_ARGS_ASSERT_SI_DUP;
10901 return (PERL_SI*)NULL;
10903 /* look for it in the table first */
10904 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10908 /* create anew and remember what it is */
10909 Newxz(nsi, 1, PERL_SI);
10910 ptr_table_store(PL_ptr_table, si, nsi);
10912 nsi->si_stack = av_dup_inc(si->si_stack, param);
10913 nsi->si_cxix = si->si_cxix;
10914 nsi->si_cxmax = si->si_cxmax;
10915 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10916 nsi->si_type = si->si_type;
10917 nsi->si_prev = si_dup(si->si_prev, param);
10918 nsi->si_next = si_dup(si->si_next, param);
10919 nsi->si_markoff = si->si_markoff;
10924 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10925 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10926 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10927 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10928 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10929 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10930 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10931 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10932 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10933 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10934 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10935 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10936 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10937 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10940 #define pv_dup_inc(p) SAVEPV(p)
10941 #define pv_dup(p) SAVEPV(p)
10942 #define svp_dup_inc(p,pp) any_dup(p,pp)
10944 /* map any object to the new equivent - either something in the
10945 * ptr table, or something in the interpreter structure
10949 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10953 PERL_ARGS_ASSERT_ANY_DUP;
10956 return (void*)NULL;
10958 /* look for it in the table first */
10959 ret = ptr_table_fetch(PL_ptr_table, v);
10963 /* see if it is part of the interpreter structure */
10964 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10965 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10973 /* duplicate the save stack */
10976 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10979 ANY * const ss = proto_perl->Isavestack;
10980 const I32 max = proto_perl->Isavestack_max;
10981 I32 ix = proto_perl->Isavestack_ix;
10994 void (*dptr) (void*);
10995 void (*dxptr) (pTHX_ void*);
10997 PERL_ARGS_ASSERT_SS_DUP;
10999 Newxz(nss, max, ANY);
11002 const I32 type = POPINT(ss,ix);
11003 TOPINT(nss,ix) = type;
11005 case SAVEt_HELEM: /* hash element */
11006 sv = (SV*)POPPTR(ss,ix);
11007 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11009 case SAVEt_ITEM: /* normal string */
11010 case SAVEt_SV: /* scalar reference */
11011 sv = (SV*)POPPTR(ss,ix);
11012 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11015 case SAVEt_MORTALIZESV:
11016 sv = (SV*)POPPTR(ss,ix);
11017 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11019 case SAVEt_SHARED_PVREF: /* char* in shared space */
11020 c = (char*)POPPTR(ss,ix);
11021 TOPPTR(nss,ix) = savesharedpv(c);
11022 ptr = POPPTR(ss,ix);
11023 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11025 case SAVEt_GENERIC_SVREF: /* generic sv */
11026 case SAVEt_SVREF: /* scalar reference */
11027 sv = (SV*)POPPTR(ss,ix);
11028 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11029 ptr = POPPTR(ss,ix);
11030 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11032 case SAVEt_HV: /* hash reference */
11033 case SAVEt_AV: /* array reference */
11034 sv = (SV*) POPPTR(ss,ix);
11035 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11037 case SAVEt_COMPPAD:
11039 sv = (SV*) POPPTR(ss,ix);
11040 TOPPTR(nss,ix) = sv_dup(sv, param);
11042 case SAVEt_INT: /* int reference */
11043 ptr = POPPTR(ss,ix);
11044 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11045 intval = (int)POPINT(ss,ix);
11046 TOPINT(nss,ix) = intval;
11048 case SAVEt_LONG: /* long reference */
11049 ptr = POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11052 case SAVEt_CLEARSV:
11053 longval = (long)POPLONG(ss,ix);
11054 TOPLONG(nss,ix) = longval;
11056 case SAVEt_I32: /* I32 reference */
11057 case SAVEt_I16: /* I16 reference */
11058 case SAVEt_I8: /* I8 reference */
11059 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11060 ptr = POPPTR(ss,ix);
11061 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11063 TOPINT(nss,ix) = i;
11065 case SAVEt_IV: /* IV reference */
11066 ptr = POPPTR(ss,ix);
11067 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11069 TOPIV(nss,ix) = iv;
11071 case SAVEt_HPTR: /* HV* reference */
11072 case SAVEt_APTR: /* AV* reference */
11073 case SAVEt_SPTR: /* SV* reference */
11074 ptr = POPPTR(ss,ix);
11075 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11076 sv = (SV*)POPPTR(ss,ix);
11077 TOPPTR(nss,ix) = sv_dup(sv, param);
11079 case SAVEt_VPTR: /* random* reference */
11080 ptr = POPPTR(ss,ix);
11081 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11082 ptr = POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11085 case SAVEt_GENERIC_PVREF: /* generic char* */
11086 case SAVEt_PPTR: /* char* reference */
11087 ptr = POPPTR(ss,ix);
11088 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11089 c = (char*)POPPTR(ss,ix);
11090 TOPPTR(nss,ix) = pv_dup(c);
11092 case SAVEt_GP: /* scalar reference */
11093 gp = (GP*)POPPTR(ss,ix);
11094 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11095 (void)GpREFCNT_inc(gp);
11096 gv = (GV*)POPPTR(ss,ix);
11097 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11100 ptr = POPPTR(ss,ix);
11101 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11102 /* these are assumed to be refcounted properly */
11104 switch (((OP*)ptr)->op_type) {
11106 case OP_LEAVESUBLV:
11110 case OP_LEAVEWRITE:
11111 TOPPTR(nss,ix) = ptr;
11114 (void) OpREFCNT_inc(o);
11118 TOPPTR(nss,ix) = NULL;
11123 TOPPTR(nss,ix) = NULL;
11126 c = (char*)POPPTR(ss,ix);
11127 TOPPTR(nss,ix) = pv_dup_inc(c);
11130 hv = (HV*)POPPTR(ss,ix);
11131 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11132 c = (char*)POPPTR(ss,ix);
11133 TOPPTR(nss,ix) = pv_dup_inc(c);
11135 case SAVEt_STACK_POS: /* Position on Perl stack */
11137 TOPINT(nss,ix) = i;
11139 case SAVEt_DESTRUCTOR:
11140 ptr = POPPTR(ss,ix);
11141 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11142 dptr = POPDPTR(ss,ix);
11143 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11144 any_dup(FPTR2DPTR(void *, dptr),
11147 case SAVEt_DESTRUCTOR_X:
11148 ptr = POPPTR(ss,ix);
11149 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11150 dxptr = POPDXPTR(ss,ix);
11151 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11152 any_dup(FPTR2DPTR(void *, dxptr),
11155 case SAVEt_REGCONTEXT:
11158 TOPINT(nss,ix) = i;
11161 case SAVEt_AELEM: /* array element */
11162 sv = (SV*)POPPTR(ss,ix);
11163 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11165 TOPINT(nss,ix) = i;
11166 av = (AV*)POPPTR(ss,ix);
11167 TOPPTR(nss,ix) = av_dup_inc(av, param);
11170 ptr = POPPTR(ss,ix);
11171 TOPPTR(nss,ix) = ptr;
11175 TOPINT(nss,ix) = i;
11176 ptr = POPPTR(ss,ix);
11179 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11180 HINTS_REFCNT_UNLOCK;
11182 TOPPTR(nss,ix) = ptr;
11183 if (i & HINT_LOCALIZE_HH) {
11184 hv = (HV*)POPPTR(ss,ix);
11185 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11188 case SAVEt_PADSV_AND_MORTALIZE:
11189 longval = (long)POPLONG(ss,ix);
11190 TOPLONG(nss,ix) = longval;
11191 ptr = POPPTR(ss,ix);
11192 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11193 sv = (SV*)POPPTR(ss,ix);
11194 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11197 ptr = POPPTR(ss,ix);
11198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11199 longval = (long)POPBOOL(ss,ix);
11200 TOPBOOL(nss,ix) = (bool)longval;
11202 case SAVEt_SET_SVFLAGS:
11204 TOPINT(nss,ix) = i;
11206 TOPINT(nss,ix) = i;
11207 sv = (SV*)POPPTR(ss,ix);
11208 TOPPTR(nss,ix) = sv_dup(sv, param);
11210 case SAVEt_RE_STATE:
11212 const struct re_save_state *const old_state
11213 = (struct re_save_state *)
11214 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11215 struct re_save_state *const new_state
11216 = (struct re_save_state *)
11217 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11219 Copy(old_state, new_state, 1, struct re_save_state);
11220 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11222 new_state->re_state_bostr
11223 = pv_dup(old_state->re_state_bostr);
11224 new_state->re_state_reginput
11225 = pv_dup(old_state->re_state_reginput);
11226 new_state->re_state_regeol
11227 = pv_dup(old_state->re_state_regeol);
11228 new_state->re_state_regoffs
11229 = (regexp_paren_pair*)
11230 any_dup(old_state->re_state_regoffs, proto_perl);
11231 new_state->re_state_reglastparen
11232 = (U32*) any_dup(old_state->re_state_reglastparen,
11234 new_state->re_state_reglastcloseparen
11235 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11237 /* XXX This just has to be broken. The old save_re_context
11238 code did SAVEGENERICPV(PL_reg_start_tmp);
11239 PL_reg_start_tmp is char **.
11240 Look above to what the dup code does for
11241 SAVEt_GENERIC_PVREF
11242 It can never have worked.
11243 So this is merely a faithful copy of the exiting bug: */
11244 new_state->re_state_reg_start_tmp
11245 = (char **) pv_dup((char *)
11246 old_state->re_state_reg_start_tmp);
11247 /* I assume that it only ever "worked" because no-one called
11248 (pseudo)fork while the regexp engine had re-entered itself.
11250 #ifdef PERL_OLD_COPY_ON_WRITE
11251 new_state->re_state_nrs
11252 = sv_dup(old_state->re_state_nrs, param);
11254 new_state->re_state_reg_magic
11255 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11257 new_state->re_state_reg_oldcurpm
11258 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11260 new_state->re_state_reg_curpm
11261 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11263 new_state->re_state_reg_oldsaved
11264 = pv_dup(old_state->re_state_reg_oldsaved);
11265 new_state->re_state_reg_poscache
11266 = pv_dup(old_state->re_state_reg_poscache);
11267 new_state->re_state_reg_starttry
11268 = pv_dup(old_state->re_state_reg_starttry);
11271 case SAVEt_COMPILE_WARNINGS:
11272 ptr = POPPTR(ss,ix);
11273 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11276 ptr = POPPTR(ss,ix);
11277 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11281 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11289 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11290 * flag to the result. This is done for each stash before cloning starts,
11291 * so we know which stashes want their objects cloned */
11294 do_mark_cloneable_stash(pTHX_ SV *const sv)
11296 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11298 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11299 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11300 if (cloner && GvCV(cloner)) {
11307 mXPUSHs(newSVhek(hvname));
11309 call_sv((SV*)GvCV(cloner), G_SCALAR);
11316 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11324 =for apidoc perl_clone
11326 Create and return a new interpreter by cloning the current one.
11328 perl_clone takes these flags as parameters:
11330 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11331 without it we only clone the data and zero the stacks,
11332 with it we copy the stacks and the new perl interpreter is
11333 ready to run at the exact same point as the previous one.
11334 The pseudo-fork code uses COPY_STACKS while the
11335 threads->create doesn't.
11337 CLONEf_KEEP_PTR_TABLE
11338 perl_clone keeps a ptr_table with the pointer of the old
11339 variable as a key and the new variable as a value,
11340 this allows it to check if something has been cloned and not
11341 clone it again but rather just use the value and increase the
11342 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11343 the ptr_table using the function
11344 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11345 reason to keep it around is if you want to dup some of your own
11346 variable who are outside the graph perl scans, example of this
11347 code is in threads.xs create
11350 This is a win32 thing, it is ignored on unix, it tells perls
11351 win32host code (which is c++) to clone itself, this is needed on
11352 win32 if you want to run two threads at the same time,
11353 if you just want to do some stuff in a separate perl interpreter
11354 and then throw it away and return to the original one,
11355 you don't need to do anything.
11360 /* XXX the above needs expanding by someone who actually understands it ! */
11361 EXTERN_C PerlInterpreter *
11362 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11365 perl_clone(PerlInterpreter *proto_perl, UV flags)
11368 #ifdef PERL_IMPLICIT_SYS
11370 PERL_ARGS_ASSERT_PERL_CLONE;
11372 /* perlhost.h so we need to call into it
11373 to clone the host, CPerlHost should have a c interface, sky */
11375 if (flags & CLONEf_CLONE_HOST) {
11376 return perl_clone_host(proto_perl,flags);
11378 return perl_clone_using(proto_perl, flags,
11380 proto_perl->IMemShared,
11381 proto_perl->IMemParse,
11383 proto_perl->IStdIO,
11387 proto_perl->IProc);
11391 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11392 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11393 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11394 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11395 struct IPerlDir* ipD, struct IPerlSock* ipS,
11396 struct IPerlProc* ipP)
11398 /* XXX many of the string copies here can be optimized if they're
11399 * constants; they need to be allocated as common memory and just
11400 * their pointers copied. */
11403 CLONE_PARAMS clone_params;
11404 CLONE_PARAMS* const param = &clone_params;
11406 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11408 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11410 /* for each stash, determine whether its objects should be cloned */
11411 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11412 PERL_SET_THX(my_perl);
11415 PoisonNew(my_perl, 1, PerlInterpreter);
11421 PL_savestack_ix = 0;
11422 PL_savestack_max = -1;
11423 PL_sig_pending = 0;
11425 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11426 # else /* !DEBUGGING */
11427 Zero(my_perl, 1, PerlInterpreter);
11428 # endif /* DEBUGGING */
11430 /* host pointers */
11432 PL_MemShared = ipMS;
11433 PL_MemParse = ipMP;
11440 #else /* !PERL_IMPLICIT_SYS */
11442 CLONE_PARAMS clone_params;
11443 CLONE_PARAMS* param = &clone_params;
11444 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11446 PERL_ARGS_ASSERT_PERL_CLONE;
11448 /* for each stash, determine whether its objects should be cloned */
11449 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11450 PERL_SET_THX(my_perl);
11453 PoisonNew(my_perl, 1, PerlInterpreter);
11459 PL_savestack_ix = 0;
11460 PL_savestack_max = -1;
11461 PL_sig_pending = 0;
11463 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11464 # else /* !DEBUGGING */
11465 Zero(my_perl, 1, PerlInterpreter);
11466 # endif /* DEBUGGING */
11467 #endif /* PERL_IMPLICIT_SYS */
11468 param->flags = flags;
11469 param->proto_perl = proto_perl;
11471 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11473 PL_body_arenas = NULL;
11474 Zero(&PL_body_roots, 1, PL_body_roots);
11476 PL_nice_chunk = NULL;
11477 PL_nice_chunk_size = 0;
11479 PL_sv_objcount = 0;
11481 PL_sv_arenaroot = NULL;
11483 PL_debug = proto_perl->Idebug;
11485 PL_hash_seed = proto_perl->Ihash_seed;
11486 PL_rehash_seed = proto_perl->Irehash_seed;
11488 #ifdef USE_REENTRANT_API
11489 /* XXX: things like -Dm will segfault here in perlio, but doing
11490 * PERL_SET_CONTEXT(proto_perl);
11491 * breaks too many other things
11493 Perl_reentrant_init(aTHX);
11496 /* create SV map for pointer relocation */
11497 PL_ptr_table = ptr_table_new();
11499 /* initialize these special pointers as early as possible */
11500 SvANY(&PL_sv_undef) = NULL;
11501 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11502 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11503 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11505 SvANY(&PL_sv_no) = new_XPVNV();
11506 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11507 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11508 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11509 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11510 SvCUR_set(&PL_sv_no, 0);
11511 SvLEN_set(&PL_sv_no, 1);
11512 SvIV_set(&PL_sv_no, 0);
11513 SvNV_set(&PL_sv_no, 0);
11514 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11516 SvANY(&PL_sv_yes) = new_XPVNV();
11517 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11518 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11519 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11520 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11521 SvCUR_set(&PL_sv_yes, 1);
11522 SvLEN_set(&PL_sv_yes, 2);
11523 SvIV_set(&PL_sv_yes, 1);
11524 SvNV_set(&PL_sv_yes, 1);
11525 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11527 /* create (a non-shared!) shared string table */
11528 PL_strtab = newHV();
11529 HvSHAREKEYS_off(PL_strtab);
11530 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11531 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11533 PL_compiling = proto_perl->Icompiling;
11535 /* These two PVs will be free'd special way so must set them same way op.c does */
11536 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11537 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11539 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11540 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11542 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11543 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11544 if (PL_compiling.cop_hints_hash) {
11546 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11547 HINTS_REFCNT_UNLOCK;
11549 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11550 #ifdef PERL_DEBUG_READONLY_OPS
11555 /* pseudo environmental stuff */
11556 PL_origargc = proto_perl->Iorigargc;
11557 PL_origargv = proto_perl->Iorigargv;
11559 param->stashes = newAV(); /* Setup array of objects to call clone on */
11561 /* Set tainting stuff before PerlIO_debug can possibly get called */
11562 PL_tainting = proto_perl->Itainting;
11563 PL_taint_warn = proto_perl->Itaint_warn;
11565 #ifdef PERLIO_LAYERS
11566 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11567 PerlIO_clone(aTHX_ proto_perl, param);
11570 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11571 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11572 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11573 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11574 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11575 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11578 PL_minus_c = proto_perl->Iminus_c;
11579 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11580 PL_localpatches = proto_perl->Ilocalpatches;
11581 PL_splitstr = proto_perl->Isplitstr;
11582 PL_minus_n = proto_perl->Iminus_n;
11583 PL_minus_p = proto_perl->Iminus_p;
11584 PL_minus_l = proto_perl->Iminus_l;
11585 PL_minus_a = proto_perl->Iminus_a;
11586 PL_minus_E = proto_perl->Iminus_E;
11587 PL_minus_F = proto_perl->Iminus_F;
11588 PL_doswitches = proto_perl->Idoswitches;
11589 PL_dowarn = proto_perl->Idowarn;
11590 PL_doextract = proto_perl->Idoextract;
11591 PL_sawampersand = proto_perl->Isawampersand;
11592 PL_unsafe = proto_perl->Iunsafe;
11593 PL_inplace = SAVEPV(proto_perl->Iinplace);
11594 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11595 PL_perldb = proto_perl->Iperldb;
11596 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11597 PL_exit_flags = proto_perl->Iexit_flags;
11599 /* magical thingies */
11600 /* XXX time(&PL_basetime) when asked for? */
11601 PL_basetime = proto_perl->Ibasetime;
11602 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11604 PL_maxsysfd = proto_perl->Imaxsysfd;
11605 PL_statusvalue = proto_perl->Istatusvalue;
11607 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11609 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11611 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11613 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11614 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11615 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11618 /* RE engine related */
11619 Zero(&PL_reg_state, 1, struct re_save_state);
11620 PL_reginterp_cnt = 0;
11621 PL_regmatch_slab = NULL;
11623 /* Clone the regex array */
11624 /* ORANGE FIXME for plugins, probably in the SV dup code.
11625 newSViv(PTR2IV(CALLREGDUPE(
11626 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11628 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11629 PL_regex_pad = AvARRAY(PL_regex_padav);
11631 /* shortcuts to various I/O objects */
11632 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11633 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11634 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11635 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11636 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11637 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11639 /* shortcuts to regexp stuff */
11640 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11642 /* shortcuts to misc objects */
11643 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11645 /* shortcuts to debugging objects */
11646 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11647 PL_DBline = gv_dup(proto_perl->IDBline, param);
11648 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11649 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11650 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11651 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11652 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11654 /* symbol tables */
11655 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11656 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11657 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11658 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11659 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11661 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11662 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11663 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11664 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11665 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11666 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11667 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11668 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11670 PL_sub_generation = proto_perl->Isub_generation;
11671 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11673 /* funky return mechanisms */
11674 PL_forkprocess = proto_perl->Iforkprocess;
11676 /* subprocess state */
11677 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11679 /* internal state */
11680 PL_maxo = proto_perl->Imaxo;
11681 if (proto_perl->Iop_mask)
11682 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11685 /* PL_asserting = proto_perl->Iasserting; */
11687 /* current interpreter roots */
11688 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11690 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11692 PL_main_start = proto_perl->Imain_start;
11693 PL_eval_root = proto_perl->Ieval_root;
11694 PL_eval_start = proto_perl->Ieval_start;
11696 /* runtime control stuff */
11697 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11699 PL_filemode = proto_perl->Ifilemode;
11700 PL_lastfd = proto_perl->Ilastfd;
11701 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11704 PL_gensym = proto_perl->Igensym;
11705 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11706 PL_laststatval = proto_perl->Ilaststatval;
11707 PL_laststype = proto_perl->Ilaststype;
11710 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11712 /* interpreter atexit processing */
11713 PL_exitlistlen = proto_perl->Iexitlistlen;
11714 if (PL_exitlistlen) {
11715 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11716 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11719 PL_exitlist = (PerlExitListEntry*)NULL;
11721 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11722 if (PL_my_cxt_size) {
11723 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11724 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11725 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11726 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11727 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11731 PL_my_cxt_list = (void**)NULL;
11732 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11733 PL_my_cxt_keys = (const char**)NULL;
11736 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11737 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11738 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11740 PL_profiledata = NULL;
11742 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11744 PAD_CLONE_VARS(proto_perl, param);
11746 #ifdef HAVE_INTERP_INTERN
11747 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11750 /* more statics moved here */
11751 PL_generation = proto_perl->Igeneration;
11752 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11754 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11755 PL_in_clean_all = proto_perl->Iin_clean_all;
11757 PL_uid = proto_perl->Iuid;
11758 PL_euid = proto_perl->Ieuid;
11759 PL_gid = proto_perl->Igid;
11760 PL_egid = proto_perl->Iegid;
11761 PL_nomemok = proto_perl->Inomemok;
11762 PL_an = proto_perl->Ian;
11763 PL_evalseq = proto_perl->Ievalseq;
11764 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11765 PL_origalen = proto_perl->Iorigalen;
11766 #ifdef PERL_USES_PL_PIDSTATUS
11767 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11769 PL_osname = SAVEPV(proto_perl->Iosname);
11770 PL_sighandlerp = proto_perl->Isighandlerp;
11772 PL_runops = proto_perl->Irunops;
11774 PL_parser = parser_dup(proto_perl->Iparser, param);
11776 PL_subline = proto_perl->Isubline;
11777 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11780 PL_cryptseen = proto_perl->Icryptseen;
11783 PL_hints = proto_perl->Ihints;
11785 PL_amagic_generation = proto_perl->Iamagic_generation;
11787 #ifdef USE_LOCALE_COLLATE
11788 PL_collation_ix = proto_perl->Icollation_ix;
11789 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11790 PL_collation_standard = proto_perl->Icollation_standard;
11791 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11792 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11793 #endif /* USE_LOCALE_COLLATE */
11795 #ifdef USE_LOCALE_NUMERIC
11796 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11797 PL_numeric_standard = proto_perl->Inumeric_standard;
11798 PL_numeric_local = proto_perl->Inumeric_local;
11799 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11800 #endif /* !USE_LOCALE_NUMERIC */
11802 /* utf8 character classes */
11803 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11804 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11805 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11806 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11807 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11808 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11809 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11810 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11811 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11812 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11813 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11814 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11815 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11816 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11817 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11818 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11819 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11820 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11821 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11822 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11824 /* Did the locale setup indicate UTF-8? */
11825 PL_utf8locale = proto_perl->Iutf8locale;
11826 /* Unicode features (see perlrun/-C) */
11827 PL_unicode = proto_perl->Iunicode;
11829 /* Pre-5.8 signals control */
11830 PL_signals = proto_perl->Isignals;
11832 /* times() ticks per second */
11833 PL_clocktick = proto_perl->Iclocktick;
11835 /* Recursion stopper for PerlIO_find_layer */
11836 PL_in_load_module = proto_perl->Iin_load_module;
11838 /* sort() routine */
11839 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11841 /* Not really needed/useful since the reenrant_retint is "volatile",
11842 * but do it for consistency's sake. */
11843 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11845 /* Hooks to shared SVs and locks. */
11846 PL_sharehook = proto_perl->Isharehook;
11847 PL_lockhook = proto_perl->Ilockhook;
11848 PL_unlockhook = proto_perl->Iunlockhook;
11849 PL_threadhook = proto_perl->Ithreadhook;
11850 PL_destroyhook = proto_perl->Idestroyhook;
11852 #ifdef THREADS_HAVE_PIDS
11853 PL_ppid = proto_perl->Ippid;
11857 PL_last_swash_hv = NULL; /* reinits on demand */
11858 PL_last_swash_klen = 0;
11859 PL_last_swash_key[0]= '\0';
11860 PL_last_swash_tmps = (U8*)NULL;
11861 PL_last_swash_slen = 0;
11863 PL_glob_index = proto_perl->Iglob_index;
11864 PL_srand_called = proto_perl->Isrand_called;
11865 PL_bitcount = NULL; /* reinits on demand */
11867 if (proto_perl->Ipsig_pend) {
11868 Newxz(PL_psig_pend, SIG_SIZE, int);
11871 PL_psig_pend = (int*)NULL;
11874 if (proto_perl->Ipsig_ptr) {
11875 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11876 Newxz(PL_psig_name, SIG_SIZE, SV*);
11877 for (i = 1; i < SIG_SIZE; i++) {
11878 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11879 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11883 PL_psig_ptr = (SV**)NULL;
11884 PL_psig_name = (SV**)NULL;
11887 /* intrpvar.h stuff */
11889 if (flags & CLONEf_COPY_STACKS) {
11890 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11891 PL_tmps_ix = proto_perl->Itmps_ix;
11892 PL_tmps_max = proto_perl->Itmps_max;
11893 PL_tmps_floor = proto_perl->Itmps_floor;
11894 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11896 while (i <= PL_tmps_ix) {
11897 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11901 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11902 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11903 Newxz(PL_markstack, i, I32);
11904 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11905 - proto_perl->Imarkstack);
11906 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11907 - proto_perl->Imarkstack);
11908 Copy(proto_perl->Imarkstack, PL_markstack,
11909 PL_markstack_ptr - PL_markstack + 1, I32);
11911 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11912 * NOTE: unlike the others! */
11913 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11914 PL_scopestack_max = proto_perl->Iscopestack_max;
11915 Newxz(PL_scopestack, PL_scopestack_max, I32);
11916 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11918 /* NOTE: si_dup() looks at PL_markstack */
11919 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11921 /* PL_curstack = PL_curstackinfo->si_stack; */
11922 PL_curstack = av_dup(proto_perl->Icurstack, param);
11923 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11925 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11926 PL_stack_base = AvARRAY(PL_curstack);
11927 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11928 - proto_perl->Istack_base);
11929 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11931 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11932 * NOTE: unlike the others! */
11933 PL_savestack_ix = proto_perl->Isavestack_ix;
11934 PL_savestack_max = proto_perl->Isavestack_max;
11935 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11936 PL_savestack = ss_dup(proto_perl, param);
11940 ENTER; /* perl_destruct() wants to LEAVE; */
11942 /* although we're not duplicating the tmps stack, we should still
11943 * add entries for any SVs on the tmps stack that got cloned by a
11944 * non-refcount means (eg a temp in @_); otherwise they will be
11947 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11948 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11949 proto_perl->Itmps_stack[i]);
11950 if (nsv && !SvREFCNT(nsv)) {
11952 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11957 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11958 PL_top_env = &PL_start_env;
11960 PL_op = proto_perl->Iop;
11963 PL_Xpv = (XPV*)NULL;
11964 my_perl->Ina = proto_perl->Ina;
11966 PL_statbuf = proto_perl->Istatbuf;
11967 PL_statcache = proto_perl->Istatcache;
11968 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11969 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11971 PL_timesbuf = proto_perl->Itimesbuf;
11974 PL_tainted = proto_perl->Itainted;
11975 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11976 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11977 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11978 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11979 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11980 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11981 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11982 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11983 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11985 PL_restartop = proto_perl->Irestartop;
11986 PL_in_eval = proto_perl->Iin_eval;
11987 PL_delaymagic = proto_perl->Idelaymagic;
11988 PL_dirty = proto_perl->Idirty;
11989 PL_localizing = proto_perl->Ilocalizing;
11991 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11992 PL_hv_fetch_ent_mh = NULL;
11993 PL_modcount = proto_perl->Imodcount;
11994 PL_lastgotoprobe = NULL;
11995 PL_dumpindent = proto_perl->Idumpindent;
11997 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11998 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11999 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12000 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12001 PL_efloatbuf = NULL; /* reinits on demand */
12002 PL_efloatsize = 0; /* reinits on demand */
12006 PL_screamfirst = NULL;
12007 PL_screamnext = NULL;
12008 PL_maxscream = -1; /* reinits on demand */
12009 PL_lastscream = NULL;
12012 PL_regdummy = proto_perl->Iregdummy;
12013 PL_colorset = 0; /* reinits PL_colors[] */
12014 /*PL_colors[6] = {0,0,0,0,0,0};*/
12018 /* Pluggable optimizer */
12019 PL_peepp = proto_perl->Ipeepp;
12021 PL_stashcache = newHV();
12023 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12024 proto_perl->Iwatchaddr);
12025 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12026 if (PL_debug && PL_watchaddr) {
12027 PerlIO_printf(Perl_debug_log,
12028 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12029 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12030 PTR2UV(PL_watchok));
12033 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12034 ptr_table_free(PL_ptr_table);
12035 PL_ptr_table = NULL;
12038 /* Call the ->CLONE method, if it exists, for each of the stashes
12039 identified by sv_dup() above.
12041 while(av_len(param->stashes) != -1) {
12042 HV* const stash = (HV*) av_shift(param->stashes);
12043 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12044 if (cloner && GvCV(cloner)) {
12049 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12051 call_sv((SV*)GvCV(cloner), G_DISCARD);
12057 SvREFCNT_dec(param->stashes);
12059 /* orphaned? eg threads->new inside BEGIN or use */
12060 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12061 SvREFCNT_inc_simple_void(PL_compcv);
12062 SAVEFREESV(PL_compcv);
12068 #endif /* USE_ITHREADS */
12071 =head1 Unicode Support
12073 =for apidoc sv_recode_to_utf8
12075 The encoding is assumed to be an Encode object, on entry the PV
12076 of the sv is assumed to be octets in that encoding, and the sv
12077 will be converted into Unicode (and UTF-8).
12079 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12080 is not a reference, nothing is done to the sv. If the encoding is not
12081 an C<Encode::XS> Encoding object, bad things will happen.
12082 (See F<lib/encoding.pm> and L<Encode>).
12084 The PV of the sv is returned.
12089 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12093 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12095 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12109 Passing sv_yes is wrong - it needs to be or'ed set of constants
12110 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12111 remove converted chars from source.
12113 Both will default the value - let them.
12115 XPUSHs(&PL_sv_yes);
12118 call_method("decode", G_SCALAR);
12122 s = SvPV_const(uni, len);
12123 if (s != SvPVX_const(sv)) {
12124 SvGROW(sv, len + 1);
12125 Move(s, SvPVX(sv), len + 1, char);
12126 SvCUR_set(sv, len);
12133 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12137 =for apidoc sv_cat_decode
12139 The encoding is assumed to be an Encode object, the PV of the ssv is
12140 assumed to be octets in that encoding and decoding the input starts
12141 from the position which (PV + *offset) pointed to. The dsv will be
12142 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12143 when the string tstr appears in decoding output or the input ends on
12144 the PV of the ssv. The value which the offset points will be modified
12145 to the last input position on the ssv.
12147 Returns TRUE if the terminator was found, else returns FALSE.
12152 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12153 SV *ssv, int *offset, char *tstr, int tlen)
12158 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12160 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12171 offsv = newSViv(*offset);
12173 mXPUSHp(tstr, tlen);
12175 call_method("cat_decode", G_SCALAR);
12177 ret = SvTRUE(TOPs);
12178 *offset = SvIV(offsv);
12184 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12189 /* ---------------------------------------------------------------------
12191 * support functions for report_uninit()
12194 /* the maxiumum size of array or hash where we will scan looking
12195 * for the undefined element that triggered the warning */
12197 #define FUV_MAX_SEARCH_SIZE 1000
12199 /* Look for an entry in the hash whose value has the same SV as val;
12200 * If so, return a mortal copy of the key. */
12203 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12206 register HE **array;
12209 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12211 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12212 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12215 array = HvARRAY(hv);
12217 for (i=HvMAX(hv); i>0; i--) {
12218 register HE *entry;
12219 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12220 if (HeVAL(entry) != val)
12222 if ( HeVAL(entry) == &PL_sv_undef ||
12223 HeVAL(entry) == &PL_sv_placeholder)
12227 if (HeKLEN(entry) == HEf_SVKEY)
12228 return sv_mortalcopy(HeKEY_sv(entry));
12229 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12235 /* Look for an entry in the array whose value has the same SV as val;
12236 * If so, return the index, otherwise return -1. */
12239 S_find_array_subscript(pTHX_ AV *av, SV* val)
12243 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12245 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12246 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12249 if (val != &PL_sv_undef) {
12250 SV ** const svp = AvARRAY(av);
12253 for (i=AvFILLp(av); i>=0; i--)
12260 /* S_varname(): return the name of a variable, optionally with a subscript.
12261 * If gv is non-zero, use the name of that global, along with gvtype (one
12262 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12263 * targ. Depending on the value of the subscript_type flag, return:
12266 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12267 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12268 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12269 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12272 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12273 SV* keyname, I32 aindex, int subscript_type)
12276 SV * const name = sv_newmortal();
12279 buffer[0] = gvtype;
12282 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12284 gv_fullname4(name, gv, buffer, 0);
12286 if ((unsigned int)SvPVX(name)[1] <= 26) {
12288 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12290 /* Swap the 1 unprintable control character for the 2 byte pretty
12291 version - ie substr($name, 1, 1) = $buffer; */
12292 sv_insert(name, 1, 1, buffer, 2);
12296 CV * const cv = find_runcv(NULL);
12300 if (!cv || !CvPADLIST(cv))
12302 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12303 sv = *av_fetch(av, targ, FALSE);
12304 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12307 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12308 SV * const sv = newSV(0);
12309 *SvPVX(name) = '$';
12310 Perl_sv_catpvf(aTHX_ name, "{%s}",
12311 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12314 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12315 *SvPVX(name) = '$';
12316 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12318 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12319 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12320 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12328 =for apidoc find_uninit_var
12330 Find the name of the undefined variable (if any) that caused the operator o
12331 to issue a "Use of uninitialized value" warning.
12332 If match is true, only return a name if it's value matches uninit_sv.
12333 So roughly speaking, if a unary operator (such as OP_COS) generates a
12334 warning, then following the direct child of the op may yield an
12335 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12336 other hand, with OP_ADD there are two branches to follow, so we only print
12337 the variable name if we get an exact match.
12339 The name is returned as a mortal SV.
12341 Assumes that PL_op is the op that originally triggered the error, and that
12342 PL_comppad/PL_curpad points to the currently executing pad.
12348 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12356 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12357 uninit_sv == &PL_sv_placeholder)))
12360 switch (obase->op_type) {
12367 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12368 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12371 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12373 if (pad) { /* @lex, %lex */
12374 sv = PAD_SVl(obase->op_targ);
12378 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12379 /* @global, %global */
12380 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12383 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12385 else /* @{expr}, %{expr} */
12386 return find_uninit_var(cUNOPx(obase)->op_first,
12390 /* attempt to find a match within the aggregate */
12392 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12394 subscript_type = FUV_SUBSCRIPT_HASH;
12397 index = find_array_subscript((AV*)sv, uninit_sv);
12399 subscript_type = FUV_SUBSCRIPT_ARRAY;
12402 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12405 return varname(gv, hash ? '%' : '@', obase->op_targ,
12406 keysv, index, subscript_type);
12410 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12412 return varname(NULL, '$', obase->op_targ,
12413 NULL, 0, FUV_SUBSCRIPT_NONE);
12416 gv = cGVOPx_gv(obase);
12417 if (!gv || (match && GvSV(gv) != uninit_sv))
12419 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12422 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12425 av = (AV*)PAD_SV(obase->op_targ);
12426 if (!av || SvRMAGICAL(av))
12428 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12429 if (!svp || *svp != uninit_sv)
12432 return varname(NULL, '$', obase->op_targ,
12433 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12436 gv = cGVOPx_gv(obase);
12442 if (!av || SvRMAGICAL(av))
12444 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12445 if (!svp || *svp != uninit_sv)
12448 return varname(gv, '$', 0,
12449 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12454 o = cUNOPx(obase)->op_first;
12455 if (!o || o->op_type != OP_NULL ||
12456 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12458 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12462 if (PL_op == obase)
12463 /* $a[uninit_expr] or $h{uninit_expr} */
12464 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12467 o = cBINOPx(obase)->op_first;
12468 kid = cBINOPx(obase)->op_last;
12470 /* get the av or hv, and optionally the gv */
12472 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12473 sv = PAD_SV(o->op_targ);
12475 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12476 && cUNOPo->op_first->op_type == OP_GV)
12478 gv = cGVOPx_gv(cUNOPo->op_first);
12481 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12486 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12487 /* index is constant */
12491 if (obase->op_type == OP_HELEM) {
12492 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12493 if (!he || HeVAL(he) != uninit_sv)
12497 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12498 if (!svp || *svp != uninit_sv)
12502 if (obase->op_type == OP_HELEM)
12503 return varname(gv, '%', o->op_targ,
12504 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12506 return varname(gv, '@', o->op_targ, NULL,
12507 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12510 /* index is an expression;
12511 * attempt to find a match within the aggregate */
12512 if (obase->op_type == OP_HELEM) {
12513 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12515 return varname(gv, '%', o->op_targ,
12516 keysv, 0, FUV_SUBSCRIPT_HASH);
12519 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12521 return varname(gv, '@', o->op_targ,
12522 NULL, index, FUV_SUBSCRIPT_ARRAY);
12527 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12529 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12534 /* only examine RHS */
12535 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12538 o = cUNOPx(obase)->op_first;
12539 if (o->op_type == OP_PUSHMARK)
12542 if (!o->op_sibling) {
12543 /* one-arg version of open is highly magical */
12545 if (o->op_type == OP_GV) { /* open FOO; */
12547 if (match && GvSV(gv) != uninit_sv)
12549 return varname(gv, '$', 0,
12550 NULL, 0, FUV_SUBSCRIPT_NONE);
12552 /* other possibilities not handled are:
12553 * open $x; or open my $x; should return '${*$x}'
12554 * open expr; should return '$'.expr ideally
12560 /* ops where $_ may be an implicit arg */
12564 if ( !(obase->op_flags & OPf_STACKED)) {
12565 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12566 ? PAD_SVl(obase->op_targ)
12569 sv = sv_newmortal();
12570 sv_setpvn(sv, "$_", 2);
12579 /* skip filehandle as it can't produce 'undef' warning */
12580 o = cUNOPx(obase)->op_first;
12581 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12582 o = o->op_sibling->op_sibling;
12586 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12589 match = 1; /* XS or custom code could trigger random warnings */
12594 /* XXX tmp hack: these two may call an XS sub, and currently
12595 XS subs don't have a SUB entry on the context stack, so CV and
12596 pad determination goes wrong, and BAD things happen. So, just
12597 don't try to determine the value under those circumstances.
12598 Need a better fix at dome point. DAPM 11/2007 */
12602 /* def-ness of rval pos() is independent of the def-ness of its arg */
12603 if ( !(obase->op_flags & OPf_MOD))
12608 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12609 return newSVpvs_flags("${$/}", SVs_TEMP);
12614 if (!(obase->op_flags & OPf_KIDS))
12616 o = cUNOPx(obase)->op_first;
12622 /* if all except one arg are constant, or have no side-effects,
12623 * or are optimized away, then it's unambiguous */
12625 for (kid=o; kid; kid = kid->op_sibling) {
12627 const OPCODE type = kid->op_type;
12628 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12629 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12630 || (type == OP_PUSHMARK)
12634 if (o2) { /* more than one found */
12641 return find_uninit_var(o2, uninit_sv, match);
12643 /* scan all args */
12645 sv = find_uninit_var(o, uninit_sv, 1);
12657 =for apidoc report_uninit
12659 Print appropriate "Use of uninitialized variable" warning
12665 Perl_report_uninit(pTHX_ SV* uninit_sv)
12669 SV* varname = NULL;
12671 varname = find_uninit_var(PL_op, uninit_sv,0);
12673 sv_insert(varname, 0, 0, " ", 1);
12675 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12676 varname ? SvPV_nolen_const(varname) : "",
12677 " in ", OP_DESC(PL_op));
12680 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12686 * c-indentation-style: bsd
12687 * c-basic-offset: 4
12688 * indent-tabs-mode: t
12691 * ex: set ts=8 sts=4 sw=4 noet: