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 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
520 SvFLAGS(sv) |= SVf_BREAK;
525 =for apidoc sv_clean_all
527 Decrement the refcnt of each remaining SV, possibly triggering a
528 cleanup. This function may have to be called multiple times to free
529 SVs which are in complex self-referential hierarchies.
535 Perl_sv_clean_all(pTHX)
539 PL_in_clean_all = TRUE;
540 cleaned = visit(do_clean_all, 0,0);
541 PL_in_clean_all = FALSE;
546 ARENASETS: a meta-arena implementation which separates arena-info
547 into struct arena_set, which contains an array of struct
548 arena_descs, each holding info for a single arena. By separating
549 the meta-info from the arena, we recover the 1st slot, formerly
550 borrowed for list management. The arena_set is about the size of an
551 arena, avoiding the needless malloc overhead of a naive linked-list.
553 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
554 memory in the last arena-set (1/2 on average). In trade, we get
555 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
556 smaller types). The recovery of the wasted space allows use of
557 small arenas for large, rare body types, by changing array* fields
558 in body_details_by_type[] below.
561 char *arena; /* the raw storage, allocated aligned */
562 size_t size; /* its size ~4k typ */
563 U32 misc; /* type, and in future other things. */
568 /* Get the maximum number of elements in set[] such that struct arena_set
569 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
570 therefore likely to be 1 aligned memory page. */
572 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
573 - 2 * sizeof(int)) / sizeof (struct arena_desc))
576 struct arena_set* next;
577 unsigned int set_size; /* ie ARENAS_PER_SET */
578 unsigned int curr; /* index of next available arena-desc */
579 struct arena_desc set[ARENAS_PER_SET];
583 =for apidoc sv_free_arenas
585 Deallocate the memory used by all arenas. Note that all the individual SV
586 heads and bodies within the arenas must already have been freed.
591 Perl_sv_free_arenas(pTHX)
598 /* Free arenas here, but be careful about fake ones. (We assume
599 contiguity of the fake ones with the corresponding real ones.) */
601 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
602 svanext = (SV*) SvANY(sva);
603 while (svanext && SvFAKE(svanext))
604 svanext = (SV*) SvANY(svanext);
611 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
614 struct arena_set *current = aroot;
617 assert(aroot->set[i].arena);
618 Safefree(aroot->set[i].arena);
626 i = PERL_ARENA_ROOTS_SIZE;
628 PL_body_roots[i] = 0;
630 Safefree(PL_nice_chunk);
631 PL_nice_chunk = NULL;
632 PL_nice_chunk_size = 0;
638 Here are mid-level routines that manage the allocation of bodies out
639 of the various arenas. There are 5 kinds of arenas:
641 1. SV-head arenas, which are discussed and handled above
642 2. regular body arenas
643 3. arenas for reduced-size bodies
645 5. pte arenas (thread related)
647 Arena types 2 & 3 are chained by body-type off an array of
648 arena-root pointers, which is indexed by svtype. Some of the
649 larger/less used body types are malloced singly, since a large
650 unused block of them is wasteful. Also, several svtypes dont have
651 bodies; the data fits into the sv-head itself. The arena-root
652 pointer thus has a few unused root-pointers (which may be hijacked
653 later for arena types 4,5)
655 3 differs from 2 as an optimization; some body types have several
656 unused fields in the front of the structure (which are kept in-place
657 for consistency). These bodies can be allocated in smaller chunks,
658 because the leading fields arent accessed. Pointers to such bodies
659 are decremented to point at the unused 'ghost' memory, knowing that
660 the pointers are used with offsets to the real memory.
662 HE, HEK arenas are managed separately, with separate code, but may
663 be merge-able later..
665 PTE arenas are not sv-bodies, but they share these mid-level
666 mechanics, so are considered here. The new mid-level mechanics rely
667 on the sv_type of the body being allocated, so we just reserve one
668 of the unused body-slots for PTEs, then use it in those (2) PTE
669 contexts below (line ~10k)
672 /* get_arena(size): this creates custom-sized arenas
673 TBD: export properly for hv.c: S_more_he().
676 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
679 struct arena_desc* adesc;
680 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
683 /* shouldnt need this
684 if (!arena_size) arena_size = PERL_ARENA_SIZE;
687 /* may need new arena-set to hold new arena */
688 if (!aroot || aroot->curr >= aroot->set_size) {
689 struct arena_set *newroot;
690 Newxz(newroot, 1, struct arena_set);
691 newroot->set_size = ARENAS_PER_SET;
692 newroot->next = aroot;
694 PL_body_arenas = (void *) newroot;
695 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
698 /* ok, now have arena-set with at least 1 empty/available arena-desc */
699 curr = aroot->curr++;
700 adesc = &(aroot->set[curr]);
701 assert(!adesc->arena);
703 Newx(adesc->arena, arena_size, char);
704 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
707 curr, (void*)adesc->arena, (UV)arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
718 *thing_copy = *root; \
719 *root = (void*)thing_copy; \
724 =head1 SV-Body Allocation
726 Allocation of SV-bodies is similar to SV-heads, differing as follows;
727 the allocation mechanism is used for many body types, so is somewhat
728 more complicated, it uses arena-sets, and has no need for still-live
731 At the outermost level, (new|del)_X*V macros return bodies of the
732 appropriate type. These macros call either (new|del)_body_type or
733 (new|del)_body_allocated macro pairs, depending on specifics of the
734 type. Most body types use the former pair, the latter pair is used to
735 allocate body types with "ghost fields".
737 "ghost fields" are fields that are unused in certain types, and
738 consequently dont need to actually exist. They are declared because
739 they're part of a "base type", which allows use of functions as
740 methods. The simplest examples are AVs and HVs, 2 aggregate types
741 which don't use the fields which support SCALAR semantics.
743 For these types, the arenas are carved up into *_allocated size
744 chunks, we thus avoid wasted memory for those unaccessed members.
745 When bodies are allocated, we adjust the pointer back in memory by the
746 size of the bit not allocated, so it's as if we allocated the full
747 structure. (But things will all go boom if you write to the part that
748 is "not there", because you'll be overwriting the last members of the
749 preceding structure in memory.)
751 We calculate the correction using the STRUCT_OFFSET macro. For
752 example, if xpv_allocated is the same structure as XPV then the two
753 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
754 structure is smaller (no initial NV actually allocated) then the net
755 effect is to subtract the size of the NV from the pointer, to return a
756 new pointer as if an initial NV were actually allocated.
758 This is the same trick as was used for NV and IV bodies. Ironically it
759 doesn't need to be used for NV bodies any more, because NV is now at
760 the start of the structure. IV bodies don't need it either, because
761 they are no longer allocated.
763 In turn, the new_body_* allocators call S_new_body(), which invokes
764 new_body_inline macro, which takes a lock, and takes a body off the
765 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
766 necessary to refresh an empty list. Then the lock is released, and
767 the body is returned.
769 S_more_bodies calls get_arena(), and carves it up into an array of N
770 bodies, which it strings into a linked list. It looks up arena-size
771 and body-size from the body_details table described below, thus
772 supporting the multiple body-types.
774 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
775 the (new|del)_X*V macros are mapped directly to malloc/free.
781 For each sv-type, struct body_details bodies_by_type[] carries
782 parameters which control these aspects of SV handling:
784 Arena_size determines whether arenas are used for this body type, and if
785 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
786 zero, forcing individual mallocs and frees.
788 Body_size determines how big a body is, and therefore how many fit into
789 each arena. Offset carries the body-pointer adjustment needed for
790 *_allocated body types, and is used in *_allocated macros.
792 But its main purpose is to parameterize info needed in
793 Perl_sv_upgrade(). The info here dramatically simplifies the function
794 vs the implementation in 5.8.7, making it table-driven. All fields
795 are used for this, except for arena_size.
797 For the sv-types that have no bodies, arenas are not used, so those
798 PL_body_roots[sv_type] are unused, and can be overloaded. In
799 something of a special case, SVt_NULL is borrowed for HE arenas;
800 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
801 bodies_by_type[SVt_NULL] slot is not used, as the table is not
804 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
805 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
806 just use the same allocation semantics. At first, PTEs were also
807 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
808 bugs, so was simplified by claiming a new slot. This choice has no
809 consequence at this time.
813 struct body_details {
814 U8 body_size; /* Size to allocate */
815 U8 copy; /* Size of structure to copy (may be shorter) */
817 unsigned int type : 4; /* We have space for a sanity check. */
818 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
819 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
820 unsigned int arena : 1; /* Allocated from an arena */
821 size_t arena_size; /* Size of arena to allocate */
829 /* With -DPURFIY we allocate everything directly, and don't use arenas.
830 This seems a rather elegant way to simplify some of the code below. */
831 #define HASARENA FALSE
833 #define HASARENA TRUE
835 #define NOARENA FALSE
837 /* Size the arenas to exactly fit a given number of bodies. A count
838 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
839 simplifying the default. If count > 0, the arena is sized to fit
840 only that many bodies, allowing arenas to be used for large, rare
841 bodies (XPVFM, XPVIO) without undue waste. The arena size is
842 limited by PERL_ARENA_SIZE, so we can safely oversize the
845 #define FIT_ARENA0(body_size) \
846 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
847 #define FIT_ARENAn(count,body_size) \
848 ( count * body_size <= PERL_ARENA_SIZE) \
849 ? count * body_size \
850 : FIT_ARENA0 (body_size)
851 #define FIT_ARENA(count,body_size) \
853 ? FIT_ARENAn (count, body_size) \
854 : FIT_ARENA0 (body_size)
856 /* A macro to work out the offset needed to subtract from a pointer to (say)
863 to make its members accessible via a pointer to (say)
873 #define relative_STRUCT_OFFSET(longer, shorter, member) \
874 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
876 /* Calculate the length to copy. Specifically work out the length less any
877 final padding the compiler needed to add. See the comment in sv_upgrade
878 for why copying the padding proved to be a bug. */
880 #define copy_length(type, last_member) \
881 STRUCT_OFFSET(type, last_member) \
882 + sizeof (((type*)SvANY((SV*)0))->last_member)
884 static const struct body_details bodies_by_type[] = {
885 { sizeof(HE), 0, 0, SVt_NULL,
886 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
888 /* The bind placeholder pretends to be an RV for now.
889 Also it's marked as "can't upgrade" to stop anyone using it before it's
891 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
893 /* IVs are in the head, so the allocation size is 0.
894 However, the slot is overloaded for PTEs. */
895 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
896 sizeof(IV), /* This is used to copy out the IV body. */
897 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
898 NOARENA /* IVS don't need an arena */,
899 /* But PTEs need to know the size of their arena */
900 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
903 /* 8 bytes on most ILP32 with IEEE doubles */
904 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
905 FIT_ARENA(0, sizeof(NV)) },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
931 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
932 SVt_REGEXP, FALSE, NONV, HASARENA,
933 FIT_ARENA(0, sizeof(struct regexp_allocated))
937 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
938 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
941 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
944 { sizeof(xpvav_allocated),
945 copy_length(XPVAV, xmg_stash)
946 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
947 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
948 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
950 { sizeof(xpvhv_allocated),
951 copy_length(XPVHV, xmg_stash)
952 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
953 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
954 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
957 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
958 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
959 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
961 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
962 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
963 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
965 /* XPVIO is 84 bytes, fits 48x */
966 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
967 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
968 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
971 #define new_body_type(sv_type) \
972 (void *)((char *)S_new_body(aTHX_ sv_type))
974 #define del_body_type(p, sv_type) \
975 del_body(p, &PL_body_roots[sv_type])
978 #define new_body_allocated(sv_type) \
979 (void *)((char *)S_new_body(aTHX_ sv_type) \
980 - bodies_by_type[sv_type].offset)
982 #define del_body_allocated(p, sv_type) \
983 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
986 #define my_safemalloc(s) (void*)safemalloc(s)
987 #define my_safecalloc(s) (void*)safecalloc(s, 1)
988 #define my_safefree(p) safefree((char*)p)
992 #define new_XNV() my_safemalloc(sizeof(XPVNV))
993 #define del_XNV(p) my_safefree(p)
995 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XPVNV(p) my_safefree(p)
998 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
999 #define del_XPVAV(p) my_safefree(p)
1001 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1002 #define del_XPVHV(p) my_safefree(p)
1004 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1005 #define del_XPVMG(p) my_safefree(p)
1007 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1008 #define del_XPVGV(p) my_safefree(p)
1012 #define new_XNV() new_body_type(SVt_NV)
1013 #define del_XNV(p) del_body_type(p, SVt_NV)
1015 #define new_XPVNV() new_body_type(SVt_PVNV)
1016 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1018 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1019 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1021 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1022 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1024 #define new_XPVMG() new_body_type(SVt_PVMG)
1025 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1027 #define new_XPVGV() new_body_type(SVt_PVGV)
1028 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1032 /* no arena for you! */
1034 #define new_NOARENA(details) \
1035 my_safemalloc((details)->body_size + (details)->offset)
1036 #define new_NOARENAZ(details) \
1037 my_safecalloc((details)->body_size + (details)->offset)
1040 S_more_bodies (pTHX_ const svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1048 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1049 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1050 static bool done_sanity_check;
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 assert(bdp->arena_size);
1066 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1068 end = start + arena_size - 2 * body_size;
1070 /* computed count doesnt reflect the 1st slot reservation */
1071 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1072 DEBUG_m(PerlIO_printf(Perl_debug_log,
1073 "arena %p end %p arena-size %d (from %d) type %d "
1075 (void*)start, (void*)end, (int)arena_size,
1076 (int)bdp->arena_size, sv_type, (int)body_size,
1077 (int)arena_size / (int)body_size));
1079 DEBUG_m(PerlIO_printf(Perl_debug_log,
1080 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1081 (void*)start, (void*)end,
1082 (int)bdp->arena_size, sv_type, (int)body_size,
1083 (int)bdp->arena_size / (int)body_size));
1085 *root = (void *)start;
1087 while (start <= end) {
1088 char * const next = start + body_size;
1089 *(void**) start = (void *)next;
1092 *(void **)start = 0;
1097 /* grab a new thing from the free list, allocating more if necessary.
1098 The inline version is used for speed in hot routines, and the
1099 function using it serves the rest (unless PURIFY).
1101 #define new_body_inline(xpv, sv_type) \
1103 void ** const r3wt = &PL_body_roots[sv_type]; \
1104 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1105 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1106 *(r3wt) = *(void**)(xpv); \
1112 S_new_body(pTHX_ const svtype sv_type)
1116 new_body_inline(xpv, sv_type);
1122 static const struct body_details fake_rv =
1123 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1126 =for apidoc sv_upgrade
1128 Upgrade an SV to a more complex form. Generally adds a new body type to the
1129 SV, then copies across as much information as possible from the old body.
1130 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1136 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1141 const svtype old_type = SvTYPE(sv);
1142 const struct body_details *new_type_details;
1143 const struct body_details *old_type_details
1144 = bodies_by_type + old_type;
1145 SV *referant = NULL;
1147 PERL_ARGS_ASSERT_SV_UPGRADE;
1149 if (new_type != SVt_PV && SvIsCOW(sv)) {
1150 sv_force_normal_flags(sv, 0);
1153 if (old_type == new_type)
1156 old_body = SvANY(sv);
1158 /* Copying structures onto other structures that have been neatly zeroed
1159 has a subtle gotcha. Consider XPVMG
1161 +------+------+------+------+------+-------+-------+
1162 | NV | CUR | LEN | IV | MAGIC | STASH |
1163 +------+------+------+------+------+-------+-------+
1164 0 4 8 12 16 20 24 28
1166 where NVs are aligned to 8 bytes, so that sizeof that structure is
1167 actually 32 bytes long, with 4 bytes of padding at the end:
1169 +------+------+------+------+------+-------+-------+------+
1170 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1171 +------+------+------+------+------+-------+-------+------+
1172 0 4 8 12 16 20 24 28 32
1174 so what happens if you allocate memory for this structure:
1176 +------+------+------+------+------+-------+-------+------+------+...
1177 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1178 +------+------+------+------+------+-------+-------+------+------+...
1179 0 4 8 12 16 20 24 28 32 36
1181 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1182 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1183 started out as zero once, but it's quite possible that it isn't. So now,
1184 rather than a nicely zeroed GP, you have it pointing somewhere random.
1187 (In fact, GP ends up pointing at a previous GP structure, because the
1188 principle cause of the padding in XPVMG getting garbage is a copy of
1189 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1190 this happens to be moot because XPVGV has been re-ordered, with GP
1191 no longer after STASH)
1193 So we are careful and work out the size of used parts of all the
1201 referant = SvRV(sv);
1202 old_type_details = &fake_rv;
1203 if (new_type == SVt_NV)
1204 new_type = SVt_PVNV;
1206 if (new_type < SVt_PVIV) {
1207 new_type = (new_type == SVt_NV)
1208 ? SVt_PVNV : SVt_PVIV;
1213 if (new_type < SVt_PVNV) {
1214 new_type = SVt_PVNV;
1218 assert(new_type > SVt_PV);
1219 assert(SVt_IV < SVt_PV);
1220 assert(SVt_NV < SVt_PV);
1227 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1228 there's no way that it can be safely upgraded, because perl.c
1229 expects to Safefree(SvANY(PL_mess_sv)) */
1230 assert(sv != PL_mess_sv);
1231 /* This flag bit is used to mean other things in other scalar types.
1232 Given that it only has meaning inside the pad, it shouldn't be set
1233 on anything that can get upgraded. */
1234 assert(!SvPAD_TYPED(sv));
1237 if (old_type_details->cant_upgrade)
1238 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1239 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1242 if (old_type > new_type)
1243 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1244 (int)old_type, (int)new_type);
1246 new_type_details = bodies_by_type + new_type;
1248 SvFLAGS(sv) &= ~SVTYPEMASK;
1249 SvFLAGS(sv) |= new_type;
1251 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1252 the return statements above will have triggered. */
1253 assert (new_type != SVt_NULL);
1256 assert(old_type == SVt_NULL);
1257 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1261 assert(old_type == SVt_NULL);
1262 SvANY(sv) = new_XNV();
1267 assert(new_type_details->body_size);
1270 assert(new_type_details->arena);
1271 assert(new_type_details->arena_size);
1272 /* This points to the start of the allocated area. */
1273 new_body_inline(new_body, new_type);
1274 Zero(new_body, new_type_details->body_size, char);
1275 new_body = ((char *)new_body) - new_type_details->offset;
1277 /* We always allocated the full length item with PURIFY. To do this
1278 we fake things so that arena is false for all 16 types.. */
1279 new_body = new_NOARENAZ(new_type_details);
1281 SvANY(sv) = new_body;
1282 if (new_type == SVt_PVAV) {
1286 if (old_type_details->body_size) {
1289 /* It will have been zeroed when the new body was allocated.
1290 Lets not write to it, in case it confuses a write-back
1296 #ifndef NODEFAULT_SHAREKEYS
1297 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1299 HvMAX(sv) = 7; /* (start with 8 buckets) */
1300 if (old_type_details->body_size) {
1303 /* It will have been zeroed when the new body was allocated.
1304 Lets not write to it, in case it confuses a write-back
1309 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1310 The target created by newSVrv also is, and it can have magic.
1311 However, it never has SvPVX set.
1313 if (old_type == SVt_IV) {
1315 } else if (old_type >= SVt_PV) {
1316 assert(SvPVX_const(sv) == 0);
1319 if (old_type >= SVt_PVMG) {
1320 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1321 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1323 sv->sv_u.svu_array = NULL; /* or svu_hash */
1329 /* XXX Is this still needed? Was it ever needed? Surely as there is
1330 no route from NV to PVIV, NOK can never be true */
1331 assert(!SvNOKp(sv));
1343 assert(new_type_details->body_size);
1344 /* We always allocated the full length item with PURIFY. To do this
1345 we fake things so that arena is false for all 16 types.. */
1346 if(new_type_details->arena) {
1347 /* This points to the start of the allocated area. */
1348 new_body_inline(new_body, new_type);
1349 Zero(new_body, new_type_details->body_size, char);
1350 new_body = ((char *)new_body) - new_type_details->offset;
1352 new_body = new_NOARENAZ(new_type_details);
1354 SvANY(sv) = new_body;
1356 if (old_type_details->copy) {
1357 /* There is now the potential for an upgrade from something without
1358 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1359 int offset = old_type_details->offset;
1360 int length = old_type_details->copy;
1362 if (new_type_details->offset > old_type_details->offset) {
1363 const int difference
1364 = new_type_details->offset - old_type_details->offset;
1365 offset += difference;
1366 length -= difference;
1368 assert (length >= 0);
1370 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1374 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1375 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1376 * correct 0.0 for us. Otherwise, if the old body didn't have an
1377 * NV slot, but the new one does, then we need to initialise the
1378 * freshly created NV slot with whatever the correct bit pattern is
1380 if (old_type_details->zero_nv && !new_type_details->zero_nv
1381 && !isGV_with_GP(sv))
1385 if (new_type == SVt_PVIO)
1386 IoPAGE_LEN(sv) = 60;
1387 if (old_type < SVt_PV) {
1388 /* referant will be NULL unless the old type was SVt_IV emulating
1390 sv->sv_u.svu_rv = referant;
1394 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1395 (unsigned long)new_type);
1398 if (old_type_details->arena) {
1399 /* If there was an old body, then we need to free it.
1400 Note that there is an assumption that all bodies of types that
1401 can be upgraded came from arenas. Only the more complex non-
1402 upgradable types are allowed to be directly malloc()ed. */
1404 my_safefree(old_body);
1406 del_body((void*)((char*)old_body + old_type_details->offset),
1407 &PL_body_roots[old_type]);
1413 =for apidoc sv_backoff
1415 Remove any string offset. You should normally use the C<SvOOK_off> macro
1422 Perl_sv_backoff(pTHX_ register SV *const sv)
1425 const char * const s = SvPVX_const(sv);
1427 PERL_ARGS_ASSERT_SV_BACKOFF;
1428 PERL_UNUSED_CONTEXT;
1431 assert(SvTYPE(sv) != SVt_PVHV);
1432 assert(SvTYPE(sv) != SVt_PVAV);
1434 SvOOK_offset(sv, delta);
1436 SvLEN_set(sv, SvLEN(sv) + delta);
1437 SvPV_set(sv, SvPVX(sv) - delta);
1438 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1439 SvFLAGS(sv) &= ~SVf_OOK;
1446 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1447 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1448 Use the C<SvGROW> wrapper instead.
1454 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1458 PERL_ARGS_ASSERT_SV_GROW;
1460 if (PL_madskills && newlen >= 0x100000) {
1461 PerlIO_printf(Perl_debug_log,
1462 "Allocation too large: %"UVxf"\n", (UV)newlen);
1464 #ifdef HAS_64K_LIMIT
1465 if (newlen >= 0x10000) {
1466 PerlIO_printf(Perl_debug_log,
1467 "Allocation too large: %"UVxf"\n", (UV)newlen);
1470 #endif /* HAS_64K_LIMIT */
1473 if (SvTYPE(sv) < SVt_PV) {
1474 sv_upgrade(sv, SVt_PV);
1475 s = SvPVX_mutable(sv);
1477 else if (SvOOK(sv)) { /* pv is offset? */
1479 s = SvPVX_mutable(sv);
1480 if (newlen > SvLEN(sv))
1481 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1482 #ifdef HAS_64K_LIMIT
1483 if (newlen >= 0x10000)
1488 s = SvPVX_mutable(sv);
1490 if (newlen > SvLEN(sv)) { /* need more room? */
1492 newlen = PERL_STRLEN_ROUNDUP(newlen);
1494 if (SvLEN(sv) && s) {
1495 s = (char*)saferealloc(s, newlen);
1498 s = (char*)safemalloc(newlen);
1499 if (SvPVX_const(sv) && SvCUR(sv)) {
1500 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1504 #ifdef Perl_safesysmalloc_size
1505 /* Do this here, do it once, do it right, and then we will never get
1506 called back into sv_grow() unless there really is some growing
1508 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1510 SvLEN_set(sv, newlen);
1517 =for apidoc sv_setiv
1519 Copies an integer into the given SV, upgrading first if necessary.
1520 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1526 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1530 PERL_ARGS_ASSERT_SV_SETIV;
1532 SV_CHECK_THINKFIRST_COW_DROP(sv);
1533 switch (SvTYPE(sv)) {
1536 sv_upgrade(sv, SVt_IV);
1539 sv_upgrade(sv, SVt_PVIV);
1548 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1552 (void)SvIOK_only(sv); /* validate number */
1558 =for apidoc sv_setiv_mg
1560 Like C<sv_setiv>, but also handles 'set' magic.
1566 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1568 PERL_ARGS_ASSERT_SV_SETIV_MG;
1575 =for apidoc sv_setuv
1577 Copies an unsigned integer into the given SV, upgrading first if necessary.
1578 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1584 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1586 PERL_ARGS_ASSERT_SV_SETUV;
1588 /* With these two if statements:
1589 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1592 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1594 If you wish to remove them, please benchmark to see what the effect is
1596 if (u <= (UV)IV_MAX) {
1597 sv_setiv(sv, (IV)u);
1606 =for apidoc sv_setuv_mg
1608 Like C<sv_setuv>, but also handles 'set' magic.
1614 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1616 PERL_ARGS_ASSERT_SV_SETUV_MG;
1623 =for apidoc sv_setnv
1625 Copies a double into the given SV, upgrading first if necessary.
1626 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1632 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1636 PERL_ARGS_ASSERT_SV_SETNV;
1638 SV_CHECK_THINKFIRST_COW_DROP(sv);
1639 switch (SvTYPE(sv)) {
1642 sv_upgrade(sv, SVt_NV);
1646 sv_upgrade(sv, SVt_PVNV);
1655 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1660 (void)SvNOK_only(sv); /* validate number */
1665 =for apidoc sv_setnv_mg
1667 Like C<sv_setnv>, but also handles 'set' magic.
1673 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1675 PERL_ARGS_ASSERT_SV_SETNV_MG;
1681 /* Print an "isn't numeric" warning, using a cleaned-up,
1682 * printable version of the offending string
1686 S_not_a_number(pTHX_ SV *const sv)
1693 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1696 dsv = newSVpvs_flags("", SVs_TEMP);
1697 pv = sv_uni_display(dsv, sv, 10, 0);
1700 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1701 /* each *s can expand to 4 chars + "...\0",
1702 i.e. need room for 8 chars */
1704 const char *s = SvPVX_const(sv);
1705 const char * const end = s + SvCUR(sv);
1706 for ( ; s < end && d < limit; s++ ) {
1708 if (ch & 128 && !isPRINT_LC(ch)) {
1717 else if (ch == '\r') {
1721 else if (ch == '\f') {
1725 else if (ch == '\\') {
1729 else if (ch == '\0') {
1733 else if (isPRINT_LC(ch))
1750 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1751 "Argument \"%s\" isn't numeric in %s", pv,
1754 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1755 "Argument \"%s\" isn't numeric", pv);
1759 =for apidoc looks_like_number
1761 Test if the content of an SV looks like a number (or is a number).
1762 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1763 non-numeric warning), even if your atof() doesn't grok them.
1769 Perl_looks_like_number(pTHX_ SV *const sv)
1771 register const char *sbegin;
1774 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1777 sbegin = SvPVX_const(sv);
1780 else if (SvPOKp(sv))
1781 sbegin = SvPV_const(sv, len);
1783 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1784 return grok_number(sbegin, len, NULL);
1788 S_glob_2number(pTHX_ GV * const gv)
1790 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1791 SV *const buffer = sv_newmortal();
1793 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1795 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1798 gv_efullname3(buffer, gv, "*");
1799 SvFLAGS(gv) |= wasfake;
1801 /* We know that all GVs stringify to something that is not-a-number,
1802 so no need to test that. */
1803 if (ckWARN(WARN_NUMERIC))
1804 not_a_number(buffer);
1805 /* We just want something true to return, so that S_sv_2iuv_common
1806 can tail call us and return true. */
1811 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1813 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1814 SV *const buffer = sv_newmortal();
1816 PERL_ARGS_ASSERT_GLOB_2PV;
1818 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1821 gv_efullname3(buffer, gv, "*");
1822 SvFLAGS(gv) |= wasfake;
1824 assert(SvPOK(buffer));
1826 *len = SvCUR(buffer);
1828 return SvPVX(buffer);
1831 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1832 until proven guilty, assume that things are not that bad... */
1837 As 64 bit platforms often have an NV that doesn't preserve all bits of
1838 an IV (an assumption perl has been based on to date) it becomes necessary
1839 to remove the assumption that the NV always carries enough precision to
1840 recreate the IV whenever needed, and that the NV is the canonical form.
1841 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1842 precision as a side effect of conversion (which would lead to insanity
1843 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1844 1) to distinguish between IV/UV/NV slots that have cached a valid
1845 conversion where precision was lost and IV/UV/NV slots that have a
1846 valid conversion which has lost no precision
1847 2) to ensure that if a numeric conversion to one form is requested that
1848 would lose precision, the precise conversion (or differently
1849 imprecise conversion) is also performed and cached, to prevent
1850 requests for different numeric formats on the same SV causing
1851 lossy conversion chains. (lossless conversion chains are perfectly
1856 SvIOKp is true if the IV slot contains a valid value
1857 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1858 SvNOKp is true if the NV slot contains a valid value
1859 SvNOK is true only if the NV value is accurate
1862 while converting from PV to NV, check to see if converting that NV to an
1863 IV(or UV) would lose accuracy over a direct conversion from PV to
1864 IV(or UV). If it would, cache both conversions, return NV, but mark
1865 SV as IOK NOKp (ie not NOK).
1867 While converting from PV to IV, check to see if converting that IV to an
1868 NV would lose accuracy over a direct conversion from PV to NV. If it
1869 would, cache both conversions, flag similarly.
1871 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1872 correctly because if IV & NV were set NV *always* overruled.
1873 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1874 changes - now IV and NV together means that the two are interchangeable:
1875 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1877 The benefit of this is that operations such as pp_add know that if
1878 SvIOK is true for both left and right operands, then integer addition
1879 can be used instead of floating point (for cases where the result won't
1880 overflow). Before, floating point was always used, which could lead to
1881 loss of precision compared with integer addition.
1883 * making IV and NV equal status should make maths accurate on 64 bit
1885 * may speed up maths somewhat if pp_add and friends start to use
1886 integers when possible instead of fp. (Hopefully the overhead in
1887 looking for SvIOK and checking for overflow will not outweigh the
1888 fp to integer speedup)
1889 * will slow down integer operations (callers of SvIV) on "inaccurate"
1890 values, as the change from SvIOK to SvIOKp will cause a call into
1891 sv_2iv each time rather than a macro access direct to the IV slot
1892 * should speed up number->string conversion on integers as IV is
1893 favoured when IV and NV are equally accurate
1895 ####################################################################
1896 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1897 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1898 On the other hand, SvUOK is true iff UV.
1899 ####################################################################
1901 Your mileage will vary depending your CPU's relative fp to integer
1905 #ifndef NV_PRESERVES_UV
1906 # define IS_NUMBER_UNDERFLOW_IV 1
1907 # define IS_NUMBER_UNDERFLOW_UV 2
1908 # define IS_NUMBER_IV_AND_UV 2
1909 # define IS_NUMBER_OVERFLOW_IV 4
1910 # define IS_NUMBER_OVERFLOW_UV 5
1912 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1914 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1916 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1924 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1926 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));
1927 if (SvNVX(sv) < (NV)IV_MIN) {
1928 (void)SvIOKp_on(sv);
1930 SvIV_set(sv, IV_MIN);
1931 return IS_NUMBER_UNDERFLOW_IV;
1933 if (SvNVX(sv) > (NV)UV_MAX) {
1934 (void)SvIOKp_on(sv);
1937 SvUV_set(sv, UV_MAX);
1938 return IS_NUMBER_OVERFLOW_UV;
1940 (void)SvIOKp_on(sv);
1942 /* Can't use strtol etc to convert this string. (See truth table in
1944 if (SvNVX(sv) <= (UV)IV_MAX) {
1945 SvIV_set(sv, I_V(SvNVX(sv)));
1946 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1947 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1949 /* Integer is imprecise. NOK, IOKp */
1951 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1954 SvUV_set(sv, U_V(SvNVX(sv)));
1955 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1956 if (SvUVX(sv) == UV_MAX) {
1957 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1958 possibly be preserved by NV. Hence, it must be overflow.
1960 return IS_NUMBER_OVERFLOW_UV;
1962 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1964 /* Integer is imprecise. NOK, IOKp */
1966 return IS_NUMBER_OVERFLOW_IV;
1968 #endif /* !NV_PRESERVES_UV*/
1971 S_sv_2iuv_common(pTHX_ SV *const sv)
1975 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1978 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1979 * without also getting a cached IV/UV from it at the same time
1980 * (ie PV->NV conversion should detect loss of accuracy and cache
1981 * IV or UV at same time to avoid this. */
1982 /* IV-over-UV optimisation - choose to cache IV if possible */
1984 if (SvTYPE(sv) == SVt_NV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1988 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1989 certainly cast into the IV range at IV_MAX, whereas the correct
1990 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1992 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1993 if (Perl_isnan(SvNVX(sv))) {
1999 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2000 SvIV_set(sv, I_V(SvNVX(sv)));
2001 if (SvNVX(sv) == (NV) SvIVX(sv)
2002 #ifndef NV_PRESERVES_UV
2003 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2004 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2005 /* Don't flag it as "accurately an integer" if the number
2006 came from a (by definition imprecise) NV operation, and
2007 we're outside the range of NV integer precision */
2011 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2013 /* scalar has trailing garbage, eg "42a" */
2015 DEBUG_c(PerlIO_printf(Perl_debug_log,
2016 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2022 /* IV not precise. No need to convert from PV, as NV
2023 conversion would already have cached IV if it detected
2024 that PV->IV would be better than PV->NV->IV
2025 flags already correct - don't set public IOK. */
2026 DEBUG_c(PerlIO_printf(Perl_debug_log,
2027 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2032 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2033 but the cast (NV)IV_MIN rounds to a the value less (more
2034 negative) than IV_MIN which happens to be equal to SvNVX ??
2035 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2036 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2037 (NV)UVX == NVX are both true, but the values differ. :-(
2038 Hopefully for 2s complement IV_MIN is something like
2039 0x8000000000000000 which will be exact. NWC */
2042 SvUV_set(sv, U_V(SvNVX(sv)));
2044 (SvNVX(sv) == (NV) SvUVX(sv))
2045 #ifndef NV_PRESERVES_UV
2046 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2047 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2048 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2049 /* Don't flag it as "accurately an integer" if the number
2050 came from a (by definition imprecise) NV operation, and
2051 we're outside the range of NV integer precision */
2057 DEBUG_c(PerlIO_printf(Perl_debug_log,
2058 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2064 else if (SvPOKp(sv) && SvLEN(sv)) {
2066 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2067 /* We want to avoid a possible problem when we cache an IV/ a UV which
2068 may be later translated to an NV, and the resulting NV is not
2069 the same as the direct translation of the initial string
2070 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2071 be careful to ensure that the value with the .456 is around if the
2072 NV value is requested in the future).
2074 This means that if we cache such an IV/a UV, we need to cache the
2075 NV as well. Moreover, we trade speed for space, and do not
2076 cache the NV if we are sure it's not needed.
2079 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2080 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2081 == IS_NUMBER_IN_UV) {
2082 /* It's definitely an integer, only upgrade to PVIV */
2083 if (SvTYPE(sv) < SVt_PVIV)
2084 sv_upgrade(sv, SVt_PVIV);
2086 } else if (SvTYPE(sv) < SVt_PVNV)
2087 sv_upgrade(sv, SVt_PVNV);
2089 /* If NVs preserve UVs then we only use the UV value if we know that
2090 we aren't going to call atof() below. If NVs don't preserve UVs
2091 then the value returned may have more precision than atof() will
2092 return, even though value isn't perfectly accurate. */
2093 if ((numtype & (IS_NUMBER_IN_UV
2094 #ifdef NV_PRESERVES_UV
2097 )) == IS_NUMBER_IN_UV) {
2098 /* This won't turn off the public IOK flag if it was set above */
2099 (void)SvIOKp_on(sv);
2101 if (!(numtype & IS_NUMBER_NEG)) {
2103 if (value <= (UV)IV_MAX) {
2104 SvIV_set(sv, (IV)value);
2106 /* it didn't overflow, and it was positive. */
2107 SvUV_set(sv, value);
2111 /* 2s complement assumption */
2112 if (value <= (UV)IV_MIN) {
2113 SvIV_set(sv, -(IV)value);
2115 /* Too negative for an IV. This is a double upgrade, but
2116 I'm assuming it will be rare. */
2117 if (SvTYPE(sv) < SVt_PVNV)
2118 sv_upgrade(sv, SVt_PVNV);
2122 SvNV_set(sv, -(NV)value);
2123 SvIV_set(sv, IV_MIN);
2127 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2128 will be in the previous block to set the IV slot, and the next
2129 block to set the NV slot. So no else here. */
2131 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2132 != IS_NUMBER_IN_UV) {
2133 /* It wasn't an (integer that doesn't overflow the UV). */
2134 SvNV_set(sv, Atof(SvPVX_const(sv)));
2136 if (! numtype && ckWARN(WARN_NUMERIC))
2139 #if defined(USE_LONG_DOUBLE)
2140 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2141 PTR2UV(sv), SvNVX(sv)));
2143 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2144 PTR2UV(sv), SvNVX(sv)));
2147 #ifdef NV_PRESERVES_UV
2148 (void)SvIOKp_on(sv);
2150 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2151 SvIV_set(sv, I_V(SvNVX(sv)));
2152 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2155 NOOP; /* Integer is imprecise. NOK, IOKp */
2157 /* UV will not work better than IV */
2159 if (SvNVX(sv) > (NV)UV_MAX) {
2161 /* Integer is inaccurate. NOK, IOKp, is UV */
2162 SvUV_set(sv, UV_MAX);
2164 SvUV_set(sv, U_V(SvNVX(sv)));
2165 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2166 NV preservse UV so can do correct comparison. */
2167 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2170 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2175 #else /* NV_PRESERVES_UV */
2176 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2177 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2178 /* The IV/UV slot will have been set from value returned by
2179 grok_number above. The NV slot has just been set using
2182 assert (SvIOKp(sv));
2184 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2185 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2186 /* Small enough to preserve all bits. */
2187 (void)SvIOKp_on(sv);
2189 SvIV_set(sv, I_V(SvNVX(sv)));
2190 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2192 /* Assumption: first non-preserved integer is < IV_MAX,
2193 this NV is in the preserved range, therefore: */
2194 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2196 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);
2200 0 0 already failed to read UV.
2201 0 1 already failed to read UV.
2202 1 0 you won't get here in this case. IV/UV
2203 slot set, public IOK, Atof() unneeded.
2204 1 1 already read UV.
2205 so there's no point in sv_2iuv_non_preserve() attempting
2206 to use atol, strtol, strtoul etc. */
2208 sv_2iuv_non_preserve (sv, numtype);
2210 sv_2iuv_non_preserve (sv);
2214 #endif /* NV_PRESERVES_UV */
2215 /* It might be more code efficient to go through the entire logic above
2216 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2217 gets complex and potentially buggy, so more programmer efficient
2218 to do it this way, by turning off the public flags: */
2220 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2224 if (isGV_with_GP(sv))
2225 return glob_2number((GV *)sv);
2227 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2228 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2231 if (SvTYPE(sv) < SVt_IV)
2232 /* Typically the caller expects that sv_any is not NULL now. */
2233 sv_upgrade(sv, SVt_IV);
2234 /* Return 0 from the caller. */
2241 =for apidoc sv_2iv_flags
2243 Return the integer value of an SV, doing any necessary string
2244 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2245 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2251 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2256 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2257 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2258 cache IVs just in case. In practice it seems that they never
2259 actually anywhere accessible by user Perl code, let alone get used
2260 in anything other than a string context. */
2261 if (flags & SV_GMAGIC)
2266 return I_V(SvNVX(sv));
2268 if (SvPOKp(sv) && SvLEN(sv)) {
2271 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2273 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2274 == IS_NUMBER_IN_UV) {
2275 /* It's definitely an integer */
2276 if (numtype & IS_NUMBER_NEG) {
2277 if (value < (UV)IV_MIN)
2280 if (value < (UV)IV_MAX)
2285 if (ckWARN(WARN_NUMERIC))
2288 return I_V(Atof(SvPVX_const(sv)));
2293 assert(SvTYPE(sv) >= SVt_PVMG);
2294 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2295 } else if (SvTHINKFIRST(sv)) {
2299 SV * const tmpstr=AMG_CALLun(sv,numer);
2300 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2301 return SvIV(tmpstr);
2304 return PTR2IV(SvRV(sv));
2307 sv_force_normal_flags(sv, 0);
2309 if (SvREADONLY(sv) && !SvOK(sv)) {
2310 if (ckWARN(WARN_UNINITIALIZED))
2316 if (S_sv_2iuv_common(aTHX_ sv))
2319 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2320 PTR2UV(sv),SvIVX(sv)));
2321 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2325 =for apidoc sv_2uv_flags
2327 Return the unsigned integer value of an SV, doing any necessary string
2328 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2329 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2335 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2340 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2341 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2342 cache IVs just in case. */
2343 if (flags & SV_GMAGIC)
2348 return U_V(SvNVX(sv));
2349 if (SvPOKp(sv) && SvLEN(sv)) {
2352 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2354 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2355 == IS_NUMBER_IN_UV) {
2356 /* It's definitely an integer */
2357 if (!(numtype & IS_NUMBER_NEG))
2361 if (ckWARN(WARN_NUMERIC))
2364 return U_V(Atof(SvPVX_const(sv)));
2369 assert(SvTYPE(sv) >= SVt_PVMG);
2370 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2371 } else if (SvTHINKFIRST(sv)) {
2375 SV *const tmpstr = AMG_CALLun(sv,numer);
2376 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2377 return SvUV(tmpstr);
2380 return PTR2UV(SvRV(sv));
2383 sv_force_normal_flags(sv, 0);
2385 if (SvREADONLY(sv) && !SvOK(sv)) {
2386 if (ckWARN(WARN_UNINITIALIZED))
2392 if (S_sv_2iuv_common(aTHX_ sv))
2396 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2397 PTR2UV(sv),SvUVX(sv)));
2398 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2404 Return the num value of an SV, doing any necessary string or integer
2405 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2412 Perl_sv_2nv(pTHX_ register SV *const sv)
2417 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2418 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2419 cache IVs just in case. */
2423 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2424 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2425 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2427 return Atof(SvPVX_const(sv));
2431 return (NV)SvUVX(sv);
2433 return (NV)SvIVX(sv);
2438 assert(SvTYPE(sv) >= SVt_PVMG);
2439 /* This falls through to the report_uninit near the end of the
2441 } else if (SvTHINKFIRST(sv)) {
2445 SV *const tmpstr = AMG_CALLun(sv,numer);
2446 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2447 return SvNV(tmpstr);
2450 return PTR2NV(SvRV(sv));
2453 sv_force_normal_flags(sv, 0);
2455 if (SvREADONLY(sv) && !SvOK(sv)) {
2456 if (ckWARN(WARN_UNINITIALIZED))
2461 if (SvTYPE(sv) < SVt_NV) {
2462 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2463 sv_upgrade(sv, SVt_NV);
2464 #ifdef USE_LONG_DOUBLE
2466 STORE_NUMERIC_LOCAL_SET_STANDARD();
2467 PerlIO_printf(Perl_debug_log,
2468 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2469 PTR2UV(sv), SvNVX(sv));
2470 RESTORE_NUMERIC_LOCAL();
2474 STORE_NUMERIC_LOCAL_SET_STANDARD();
2475 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 else if (SvTYPE(sv) < SVt_PVNV)
2482 sv_upgrade(sv, SVt_PVNV);
2487 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2488 #ifdef NV_PRESERVES_UV
2494 /* Only set the public NV OK flag if this NV preserves the IV */
2495 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2497 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2498 : (SvIVX(sv) == I_V(SvNVX(sv))))
2504 else if (SvPOKp(sv) && SvLEN(sv)) {
2506 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2507 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2509 #ifdef NV_PRESERVES_UV
2510 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2511 == IS_NUMBER_IN_UV) {
2512 /* It's definitely an integer */
2513 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2515 SvNV_set(sv, Atof(SvPVX_const(sv)));
2521 SvNV_set(sv, Atof(SvPVX_const(sv)));
2522 /* Only set the public NV OK flag if this NV preserves the value in
2523 the PV at least as well as an IV/UV would.
2524 Not sure how to do this 100% reliably. */
2525 /* if that shift count is out of range then Configure's test is
2526 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2528 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2529 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2530 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2531 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2532 /* Can't use strtol etc to convert this string, so don't try.
2533 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2536 /* value has been set. It may not be precise. */
2537 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2538 /* 2s complement assumption for (UV)IV_MIN */
2539 SvNOK_on(sv); /* Integer is too negative. */
2544 if (numtype & IS_NUMBER_NEG) {
2545 SvIV_set(sv, -(IV)value);
2546 } else if (value <= (UV)IV_MAX) {
2547 SvIV_set(sv, (IV)value);
2549 SvUV_set(sv, value);
2553 if (numtype & IS_NUMBER_NOT_INT) {
2554 /* I believe that even if the original PV had decimals,
2555 they are lost beyond the limit of the FP precision.
2556 However, neither is canonical, so both only get p
2557 flags. NWC, 2000/11/25 */
2558 /* Both already have p flags, so do nothing */
2560 const NV nv = SvNVX(sv);
2561 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2562 if (SvIVX(sv) == I_V(nv)) {
2565 /* It had no "." so it must be integer. */
2569 /* between IV_MAX and NV(UV_MAX).
2570 Could be slightly > UV_MAX */
2572 if (numtype & IS_NUMBER_NOT_INT) {
2573 /* UV and NV both imprecise. */
2575 const UV nv_as_uv = U_V(nv);
2577 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2586 /* It might be more code efficient to go through the entire logic above
2587 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2588 gets complex and potentially buggy, so more programmer efficient
2589 to do it this way, by turning off the public flags: */
2591 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2592 #endif /* NV_PRESERVES_UV */
2595 if (isGV_with_GP(sv)) {
2596 glob_2number((GV *)sv);
2600 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2602 assert (SvTYPE(sv) >= SVt_NV);
2603 /* Typically the caller expects that sv_any is not NULL now. */
2604 /* XXX Ilya implies that this is a bug in callers that assume this
2605 and ideally should be fixed. */
2608 #if defined(USE_LONG_DOUBLE)
2610 STORE_NUMERIC_LOCAL_SET_STANDARD();
2611 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2612 PTR2UV(sv), SvNVX(sv));
2613 RESTORE_NUMERIC_LOCAL();
2617 STORE_NUMERIC_LOCAL_SET_STANDARD();
2618 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2619 PTR2UV(sv), SvNVX(sv));
2620 RESTORE_NUMERIC_LOCAL();
2629 Return an SV with the numeric value of the source SV, doing any necessary
2630 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2631 access this function.
2637 Perl_sv_2num(pTHX_ register SV *const sv)
2639 PERL_ARGS_ASSERT_SV_2NUM;
2644 SV * const tmpsv = AMG_CALLun(sv,numer);
2645 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2646 return sv_2num(tmpsv);
2648 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2651 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2652 * UV as a string towards the end of buf, and return pointers to start and
2655 * We assume that buf is at least TYPE_CHARS(UV) long.
2659 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2661 char *ptr = buf + TYPE_CHARS(UV);
2662 char * const ebuf = ptr;
2665 PERL_ARGS_ASSERT_UIV_2BUF;
2677 *--ptr = '0' + (char)(uv % 10);
2686 =for apidoc sv_2pv_flags
2688 Returns a pointer to the string value of an SV, and sets *lp to its length.
2689 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2691 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2692 usually end up here too.
2698 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2708 if (SvGMAGICAL(sv)) {
2709 if (flags & SV_GMAGIC)
2714 if (flags & SV_MUTABLE_RETURN)
2715 return SvPVX_mutable(sv);
2716 if (flags & SV_CONST_RETURN)
2717 return (char *)SvPVX_const(sv);
2720 if (SvIOKp(sv) || SvNOKp(sv)) {
2721 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2726 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2727 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2729 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2736 #ifdef FIXNEGATIVEZERO
2737 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2743 SvUPGRADE(sv, SVt_PV);
2746 s = SvGROW_mutable(sv, len + 1);
2749 return (char*)memcpy(s, tbuf, len + 1);
2755 assert(SvTYPE(sv) >= SVt_PVMG);
2756 /* This falls through to the report_uninit near the end of the
2758 } else if (SvTHINKFIRST(sv)) {
2762 SV *const tmpstr = AMG_CALLun(sv,string);
2763 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2765 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2769 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2770 if (flags & SV_CONST_RETURN) {
2771 pv = (char *) SvPVX_const(tmpstr);
2773 pv = (flags & SV_MUTABLE_RETURN)
2774 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2777 *lp = SvCUR(tmpstr);
2779 pv = sv_2pv_flags(tmpstr, lp, flags);
2792 const SV *const referent = (SV*)SvRV(sv);
2796 retval = buffer = savepvn("NULLREF", len);
2797 } else if (SvTYPE(referent) == SVt_REGEXP) {
2798 const REGEXP * const re = (REGEXP *)referent;
2803 /* If the regex is UTF-8 we want the containing scalar to
2804 have an UTF-8 flag too */
2810 if ((seen_evals = RX_SEEN_EVALS(re)))
2811 PL_reginterp_cnt += seen_evals;
2814 *lp = RX_WRAPLEN(re);
2816 return RX_WRAPPED(re);
2818 const char *const typestr = sv_reftype(referent, 0);
2819 const STRLEN typelen = strlen(typestr);
2820 UV addr = PTR2UV(referent);
2821 const char *stashname = NULL;
2822 STRLEN stashnamelen = 0; /* hush, gcc */
2823 const char *buffer_end;
2825 if (SvOBJECT(referent)) {
2826 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2829 stashname = HEK_KEY(name);
2830 stashnamelen = HEK_LEN(name);
2832 if (HEK_UTF8(name)) {
2838 stashname = "__ANON__";
2841 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2842 + 2 * sizeof(UV) + 2 /* )\0 */;
2844 len = typelen + 3 /* (0x */
2845 + 2 * sizeof(UV) + 2 /* )\0 */;
2848 Newx(buffer, len, char);
2849 buffer_end = retval = buffer + len;
2851 /* Working backwards */
2855 *--retval = PL_hexdigit[addr & 15];
2856 } while (addr >>= 4);
2862 memcpy(retval, typestr, typelen);
2866 retval -= stashnamelen;
2867 memcpy(retval, stashname, stashnamelen);
2869 /* retval may not neccesarily have reached the start of the
2871 assert (retval >= buffer);
2873 len = buffer_end - retval - 1; /* -1 for that \0 */
2881 if (SvREADONLY(sv) && !SvOK(sv)) {
2884 if (flags & SV_UNDEF_RETURNS_NULL)
2886 if (ckWARN(WARN_UNINITIALIZED))
2891 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2892 /* I'm assuming that if both IV and NV are equally valid then
2893 converting the IV is going to be more efficient */
2894 const U32 isUIOK = SvIsUV(sv);
2895 char buf[TYPE_CHARS(UV)];
2899 if (SvTYPE(sv) < SVt_PVIV)
2900 sv_upgrade(sv, SVt_PVIV);
2901 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2903 /* inlined from sv_setpvn */
2904 s = SvGROW_mutable(sv, len + 1);
2905 Move(ptr, s, len, char);
2909 else if (SvNOKp(sv)) {
2910 const int olderrno = errno;
2911 if (SvTYPE(sv) < SVt_PVNV)
2912 sv_upgrade(sv, SVt_PVNV);
2913 /* The +20 is pure guesswork. Configure test needed. --jhi */
2914 s = SvGROW_mutable(sv, NV_DIG + 20);
2915 /* some Xenix systems wipe out errno here */
2917 if (SvNVX(sv) == 0.0)
2918 my_strlcpy(s, "0", SvLEN(sv));
2922 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2925 #ifdef FIXNEGATIVEZERO
2926 if (*s == '-' && s[1] == '0' && !s[2]) {
2938 if (isGV_with_GP(sv))
2939 return glob_2pv((GV *)sv, lp);
2943 if (flags & SV_UNDEF_RETURNS_NULL)
2945 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2947 if (SvTYPE(sv) < SVt_PV)
2948 /* Typically the caller expects that sv_any is not NULL now. */
2949 sv_upgrade(sv, SVt_PV);
2953 const STRLEN len = s - SvPVX_const(sv);
2959 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2960 PTR2UV(sv),SvPVX_const(sv)));
2961 if (flags & SV_CONST_RETURN)
2962 return (char *)SvPVX_const(sv);
2963 if (flags & SV_MUTABLE_RETURN)
2964 return SvPVX_mutable(sv);
2969 =for apidoc sv_copypv
2971 Copies a stringified representation of the source SV into the
2972 destination SV. Automatically performs any necessary mg_get and
2973 coercion of numeric values into strings. Guaranteed to preserve
2974 UTF8 flag even from overloaded objects. Similar in nature to
2975 sv_2pv[_flags] but operates directly on an SV instead of just the
2976 string. Mostly uses sv_2pv_flags to do its work, except when that
2977 would lose the UTF-8'ness of the PV.
2983 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2986 const char * const s = SvPV_const(ssv,len);
2988 PERL_ARGS_ASSERT_SV_COPYPV;
2990 sv_setpvn(dsv,s,len);
2998 =for apidoc sv_2pvbyte
3000 Return a pointer to the byte-encoded representation of the SV, and set *lp
3001 to its length. May cause the SV to be downgraded from UTF-8 as a
3004 Usually accessed via the C<SvPVbyte> macro.
3010 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3012 PERL_ARGS_ASSERT_SV_2PVBYTE;
3014 sv_utf8_downgrade(sv,0);
3015 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3019 =for apidoc sv_2pvutf8
3021 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3022 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3024 Usually accessed via the C<SvPVutf8> macro.
3030 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3032 PERL_ARGS_ASSERT_SV_2PVUTF8;
3034 sv_utf8_upgrade(sv);
3035 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3040 =for apidoc sv_2bool
3042 This function is only called on magical items, and is only used by
3043 sv_true() or its macro equivalent.
3049 Perl_sv_2bool(pTHX_ register SV *const sv)
3053 PERL_ARGS_ASSERT_SV_2BOOL;
3061 SV * const tmpsv = AMG_CALLun(sv,bool_);
3062 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3063 return (bool)SvTRUE(tmpsv);
3065 return SvRV(sv) != 0;
3068 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3070 (*sv->sv_u.svu_pv > '0' ||
3071 Xpvtmp->xpv_cur > 1 ||
3072 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3079 return SvIVX(sv) != 0;
3082 return SvNVX(sv) != 0.0;
3084 if (isGV_with_GP(sv))
3094 =for apidoc sv_utf8_upgrade
3096 Converts the PV of an SV to its UTF-8-encoded form.
3097 Forces the SV to string form if it is not already.
3098 Always sets the SvUTF8 flag to avoid future validity checks even
3099 if all the bytes have hibit clear.
3101 This is not as a general purpose byte encoding to Unicode interface:
3102 use the Encode extension for that.
3104 =for apidoc sv_utf8_upgrade_flags
3106 Converts the PV of an SV to its UTF-8-encoded form.
3107 Forces the SV to string form if it is not already.
3108 Always sets the SvUTF8 flag to avoid future validity checks even
3109 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3110 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3111 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3113 This is not as a general purpose byte encoding to Unicode interface:
3114 use the Encode extension for that.
3120 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3124 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3126 if (sv == &PL_sv_undef)
3130 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3131 (void) sv_2pv_flags(sv,&len, flags);
3135 (void) SvPV_force(sv,len);
3144 sv_force_normal_flags(sv, 0);
3147 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3148 sv_recode_to_utf8(sv, PL_encoding);
3149 else { /* Assume Latin-1/EBCDIC */
3150 /* This function could be much more efficient if we
3151 * had a FLAG in SVs to signal if there are any hibit
3152 * chars in the PV. Given that there isn't such a flag
3153 * make the loop as fast as possible. */
3154 const U8 * const s = (U8 *) SvPVX_const(sv);
3155 const U8 * const e = (U8 *) SvEND(sv);
3160 /* Check for hi bit */
3161 if (!NATIVE_IS_INVARIANT(ch)) {
3162 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3163 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3165 SvPV_free(sv); /* No longer using what was there before. */
3166 SvPV_set(sv, (char*)recoded);
3167 SvCUR_set(sv, len - 1);
3168 SvLEN_set(sv, len); /* No longer know the real size. */
3172 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3179 =for apidoc sv_utf8_downgrade
3181 Attempts to convert the PV of an SV from characters to bytes.
3182 If the PV contains a character beyond byte, this conversion will fail;
3183 in this case, either returns false or, if C<fail_ok> is not
3186 This is not as a general purpose Unicode to byte encoding interface:
3187 use the Encode extension for that.
3193 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3197 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3199 if (SvPOKp(sv) && SvUTF8(sv)) {
3205 sv_force_normal_flags(sv, 0);
3207 s = (U8 *) SvPV(sv, len);
3208 if (!utf8_to_bytes(s, &len)) {
3213 Perl_croak(aTHX_ "Wide character in %s",
3216 Perl_croak(aTHX_ "Wide character");
3227 =for apidoc sv_utf8_encode
3229 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3230 flag off so that it looks like octets again.
3236 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3238 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3241 sv_force_normal_flags(sv, 0);
3243 if (SvREADONLY(sv)) {
3244 Perl_croak(aTHX_ PL_no_modify);
3246 (void) sv_utf8_upgrade(sv);
3251 =for apidoc sv_utf8_decode
3253 If the PV of the SV is an octet sequence in UTF-8
3254 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3255 so that it looks like a character. If the PV contains only single-byte
3256 characters, the C<SvUTF8> flag stays being off.
3257 Scans PV for validity and returns false if the PV is invalid UTF-8.
3263 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3265 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3271 /* The octets may have got themselves encoded - get them back as
3274 if (!sv_utf8_downgrade(sv, TRUE))
3277 /* it is actually just a matter of turning the utf8 flag on, but
3278 * we want to make sure everything inside is valid utf8 first.
3280 c = (const U8 *) SvPVX_const(sv);
3281 if (!is_utf8_string(c, SvCUR(sv)+1))
3283 e = (const U8 *) SvEND(sv);
3286 if (!UTF8_IS_INVARIANT(ch)) {
3296 =for apidoc sv_setsv
3298 Copies the contents of the source SV C<ssv> into the destination SV
3299 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3300 function if the source SV needs to be reused. Does not handle 'set' magic.
3301 Loosely speaking, it performs a copy-by-value, obliterating any previous
3302 content of the destination.
3304 You probably want to use one of the assortment of wrappers, such as
3305 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3306 C<SvSetMagicSV_nosteal>.
3308 =for apidoc sv_setsv_flags
3310 Copies the contents of the source SV C<ssv> into the destination SV
3311 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3312 function if the source SV needs to be reused. Does not handle 'set' magic.
3313 Loosely speaking, it performs a copy-by-value, obliterating any previous
3314 content of the destination.
3315 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3316 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3317 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3318 and C<sv_setsv_nomg> are implemented in terms of this function.
3320 You probably want to use one of the assortment of wrappers, such as
3321 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3322 C<SvSetMagicSV_nosteal>.
3324 This is the primary function for copying scalars, and most other
3325 copy-ish functions and macros use this underneath.
3331 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3333 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3335 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3337 if (dtype != SVt_PVGV) {
3338 const char * const name = GvNAME(sstr);
3339 const STRLEN len = GvNAMELEN(sstr);
3341 if (dtype >= SVt_PV) {
3347 SvUPGRADE(dstr, SVt_PVGV);
3348 (void)SvOK_off(dstr);
3349 /* FIXME - why are we doing this, then turning it off and on again
3351 isGV_with_GP_on(dstr);
3353 GvSTASH(dstr) = GvSTASH(sstr);
3355 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3356 gv_name_set((GV *)dstr, name, len, GV_ADD);
3357 SvFAKE_on(dstr); /* can coerce to non-glob */
3360 #ifdef GV_UNIQUE_CHECK
3361 if (GvUNIQUE((GV*)dstr)) {
3362 Perl_croak(aTHX_ PL_no_modify);
3366 if(GvGP((GV*)sstr)) {
3367 /* If source has method cache entry, clear it */
3369 SvREFCNT_dec(GvCV(sstr));
3373 /* If source has a real method, then a method is
3375 else if(GvCV((GV*)sstr)) {
3380 /* If dest already had a real method, that's a change as well */
3381 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3385 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3389 isGV_with_GP_off(dstr);
3390 (void)SvOK_off(dstr);
3391 isGV_with_GP_on(dstr);
3392 GvINTRO_off(dstr); /* one-shot flag */
3393 GvGP(dstr) = gp_ref(GvGP(sstr));
3394 if (SvTAINTED(sstr))
3396 if (GvIMPORTED(dstr) != GVf_IMPORTED
3397 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3399 GvIMPORTED_on(dstr);
3402 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3403 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3408 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3410 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3412 const int intro = GvINTRO(dstr);
3415 const U32 stype = SvTYPE(sref);
3417 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3419 #ifdef GV_UNIQUE_CHECK
3420 if (GvUNIQUE((GV*)dstr)) {
3421 Perl_croak(aTHX_ PL_no_modify);
3426 GvINTRO_off(dstr); /* one-shot flag */
3427 GvLINE(dstr) = CopLINE(PL_curcop);
3428 GvEGV(dstr) = (GV*)dstr;
3433 location = (SV **) &GvCV(dstr);
3434 import_flag = GVf_IMPORTED_CV;
3437 location = (SV **) &GvHV(dstr);
3438 import_flag = GVf_IMPORTED_HV;
3441 location = (SV **) &GvAV(dstr);
3442 import_flag = GVf_IMPORTED_AV;
3445 location = (SV **) &GvIOp(dstr);
3448 location = (SV **) &GvFORM(dstr);
3450 location = &GvSV(dstr);
3451 import_flag = GVf_IMPORTED_SV;
3454 if (stype == SVt_PVCV) {
3455 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3456 if (GvCVGEN(dstr)) {
3457 SvREFCNT_dec(GvCV(dstr));
3459 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3462 SAVEGENERICSV(*location);
3466 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3467 CV* const cv = (CV*)*location;
3469 if (!GvCVGEN((GV*)dstr) &&
3470 (CvROOT(cv) || CvXSUB(cv)))
3472 /* Redefining a sub - warning is mandatory if
3473 it was a const and its value changed. */
3474 if (CvCONST(cv) && CvCONST((CV*)sref)
3475 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3477 /* They are 2 constant subroutines generated from
3478 the same constant. This probably means that
3479 they are really the "same" proxy subroutine
3480 instantiated in 2 places. Most likely this is
3481 when a constant is exported twice. Don't warn.
3484 else if (ckWARN(WARN_REDEFINE)
3486 && (!CvCONST((CV*)sref)
3487 || sv_cmp(cv_const_sv(cv),
3488 cv_const_sv((CV*)sref))))) {
3489 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3492 ? "Constant subroutine %s::%s redefined"
3493 : "Subroutine %s::%s redefined"),
3494 HvNAME_get(GvSTASH((GV*)dstr)),
3495 GvENAME((GV*)dstr));
3499 cv_ckproto_len(cv, (GV*)dstr,
3500 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3501 SvPOK(sref) ? SvCUR(sref) : 0);
3503 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3504 GvASSUMECV_on(dstr);
3505 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3508 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3509 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3510 GvFLAGS(dstr) |= import_flag;
3515 if (SvTAINTED(sstr))
3521 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3524 register U32 sflags;
3526 register svtype stype;
3528 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3533 if (SvIS_FREED(dstr)) {
3534 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3535 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3537 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3539 sstr = &PL_sv_undef;
3540 if (SvIS_FREED(sstr)) {
3541 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3542 (void*)sstr, (void*)dstr);
3544 stype = SvTYPE(sstr);
3545 dtype = SvTYPE(dstr);
3547 (void)SvAMAGIC_off(dstr);
3550 /* need to nuke the magic */
3552 SvRMAGICAL_off(dstr);
3555 /* There's a lot of redundancy below but we're going for speed here */
3560 if (dtype != SVt_PVGV) {
3561 (void)SvOK_off(dstr);
3569 sv_upgrade(dstr, SVt_IV);
3573 sv_upgrade(dstr, SVt_PVIV);
3576 goto end_of_first_switch;
3578 (void)SvIOK_only(dstr);
3579 SvIV_set(dstr, SvIVX(sstr));
3582 /* SvTAINTED can only be true if the SV has taint magic, which in
3583 turn means that the SV type is PVMG (or greater). This is the
3584 case statement for SVt_IV, so this cannot be true (whatever gcov
3586 assert(!SvTAINTED(sstr));
3591 if (dtype < SVt_PV && dtype != SVt_IV)
3592 sv_upgrade(dstr, SVt_IV);
3600 sv_upgrade(dstr, SVt_NV);
3604 sv_upgrade(dstr, SVt_PVNV);
3607 goto end_of_first_switch;
3609 SvNV_set(dstr, SvNVX(sstr));
3610 (void)SvNOK_only(dstr);
3611 /* SvTAINTED can only be true if the SV has taint magic, which in
3612 turn means that the SV type is PVMG (or greater). This is the
3613 case statement for SVt_NV, so this cannot be true (whatever gcov
3615 assert(!SvTAINTED(sstr));
3621 #ifdef PERL_OLD_COPY_ON_WRITE
3622 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3623 if (dtype < SVt_PVIV)
3624 sv_upgrade(dstr, SVt_PVIV);
3632 sv_upgrade(dstr, SVt_PV);
3635 if (dtype < SVt_PVIV)
3636 sv_upgrade(dstr, SVt_PVIV);
3639 if (dtype < SVt_PVNV)
3640 sv_upgrade(dstr, SVt_PVNV);
3644 const char * const type = sv_reftype(sstr,0);
3646 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3648 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3652 /* case SVt_BIND: */
3655 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3656 glob_assign_glob(dstr, sstr, dtype);
3659 /* SvVALID means that this PVGV is playing at being an FBM. */
3663 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3665 if (SvTYPE(sstr) != stype) {
3666 stype = SvTYPE(sstr);
3667 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3668 glob_assign_glob(dstr, sstr, dtype);
3673 if (stype == SVt_PVLV)
3674 SvUPGRADE(dstr, SVt_PVNV);
3676 SvUPGRADE(dstr, (svtype)stype);
3678 end_of_first_switch:
3680 /* dstr may have been upgraded. */
3681 dtype = SvTYPE(dstr);
3682 sflags = SvFLAGS(sstr);
3684 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3685 /* Assigning to a subroutine sets the prototype. */
3688 const char *const ptr = SvPV_const(sstr, len);
3690 SvGROW(dstr, len + 1);
3691 Copy(ptr, SvPVX(dstr), len + 1, char);
3692 SvCUR_set(dstr, len);
3694 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3698 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3699 const char * const type = sv_reftype(dstr,0);
3701 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3703 Perl_croak(aTHX_ "Cannot copy to %s", type);
3704 } else if (sflags & SVf_ROK) {
3705 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3706 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3709 if (GvIMPORTED(dstr) != GVf_IMPORTED
3710 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3712 GvIMPORTED_on(dstr);
3717 glob_assign_glob(dstr, sstr, dtype);
3721 if (dtype >= SVt_PV) {
3722 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3723 glob_assign_ref(dstr, sstr);
3726 if (SvPVX_const(dstr)) {
3732 (void)SvOK_off(dstr);
3733 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3734 SvFLAGS(dstr) |= sflags & SVf_ROK;
3735 assert(!(sflags & SVp_NOK));
3736 assert(!(sflags & SVp_IOK));
3737 assert(!(sflags & SVf_NOK));
3738 assert(!(sflags & SVf_IOK));
3740 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3741 if (!(sflags & SVf_OK)) {
3742 if (ckWARN(WARN_MISC))
3743 Perl_warner(aTHX_ packWARN(WARN_MISC),
3744 "Undefined value assigned to typeglob");
3747 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3748 if (dstr != (SV*)gv) {
3751 GvGP(dstr) = gp_ref(GvGP(gv));
3755 else if (sflags & SVp_POK) {
3759 * Check to see if we can just swipe the string. If so, it's a
3760 * possible small lose on short strings, but a big win on long ones.
3761 * It might even be a win on short strings if SvPVX_const(dstr)
3762 * has to be allocated and SvPVX_const(sstr) has to be freed.
3763 * Likewise if we can set up COW rather than doing an actual copy, we
3764 * drop to the else clause, as the swipe code and the COW setup code
3765 * have much in common.
3768 /* Whichever path we take through the next code, we want this true,
3769 and doing it now facilitates the COW check. */
3770 (void)SvPOK_only(dstr);
3773 /* If we're already COW then this clause is not true, and if COW
3774 is allowed then we drop down to the else and make dest COW
3775 with us. If caller hasn't said that we're allowed to COW
3776 shared hash keys then we don't do the COW setup, even if the
3777 source scalar is a shared hash key scalar. */
3778 (((flags & SV_COW_SHARED_HASH_KEYS)
3779 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3780 : 1 /* If making a COW copy is forbidden then the behaviour we
3781 desire is as if the source SV isn't actually already
3782 COW, even if it is. So we act as if the source flags
3783 are not COW, rather than actually testing them. */
3785 #ifndef PERL_OLD_COPY_ON_WRITE
3786 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3787 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3788 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3789 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3790 but in turn, it's somewhat dead code, never expected to go
3791 live, but more kept as a placeholder on how to do it better
3792 in a newer implementation. */
3793 /* If we are COW and dstr is a suitable target then we drop down
3794 into the else and make dest a COW of us. */
3795 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3800 (sflags & SVs_TEMP) && /* slated for free anyway? */
3801 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3802 (!(flags & SV_NOSTEAL)) &&
3803 /* and we're allowed to steal temps */
3804 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3805 SvLEN(sstr) && /* and really is a string */
3806 /* and won't be needed again, potentially */
3807 !(PL_op && PL_op->op_type == OP_AASSIGN))
3808 #ifdef PERL_OLD_COPY_ON_WRITE
3809 && ((flags & SV_COW_SHARED_HASH_KEYS)
3810 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3811 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3812 && SvTYPE(sstr) >= SVt_PVIV))
3816 /* Failed the swipe test, and it's not a shared hash key either.
3817 Have to copy the string. */
3818 STRLEN len = SvCUR(sstr);
3819 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3820 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3821 SvCUR_set(dstr, len);
3822 *SvEND(dstr) = '\0';
3824 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3826 /* Either it's a shared hash key, or it's suitable for
3827 copy-on-write or we can swipe the string. */
3829 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3833 #ifdef PERL_OLD_COPY_ON_WRITE
3835 /* I believe I should acquire a global SV mutex if
3836 it's a COW sv (not a shared hash key) to stop
3837 it going un copy-on-write.
3838 If the source SV has gone un copy on write between up there
3839 and down here, then (assert() that) it is of the correct
3840 form to make it copy on write again */
3841 if ((sflags & (SVf_FAKE | SVf_READONLY))
3842 != (SVf_FAKE | SVf_READONLY)) {
3843 SvREADONLY_on(sstr);
3845 /* Make the source SV into a loop of 1.
3846 (about to become 2) */
3847 SV_COW_NEXT_SV_SET(sstr, sstr);
3851 /* Initial code is common. */
3852 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3857 /* making another shared SV. */
3858 STRLEN cur = SvCUR(sstr);
3859 STRLEN len = SvLEN(sstr);
3860 #ifdef PERL_OLD_COPY_ON_WRITE
3862 assert (SvTYPE(dstr) >= SVt_PVIV);
3863 /* SvIsCOW_normal */
3864 /* splice us in between source and next-after-source. */
3865 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3866 SV_COW_NEXT_SV_SET(sstr, dstr);
3867 SvPV_set(dstr, SvPVX_mutable(sstr));
3871 /* SvIsCOW_shared_hash */
3872 DEBUG_C(PerlIO_printf(Perl_debug_log,
3873 "Copy on write: Sharing hash\n"));
3875 assert (SvTYPE(dstr) >= SVt_PV);
3877 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3879 SvLEN_set(dstr, len);
3880 SvCUR_set(dstr, cur);
3881 SvREADONLY_on(dstr);
3883 /* Relesase a global SV mutex. */
3886 { /* Passes the swipe test. */
3887 SvPV_set(dstr, SvPVX_mutable(sstr));
3888 SvLEN_set(dstr, SvLEN(sstr));
3889 SvCUR_set(dstr, SvCUR(sstr));
3892 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3893 SvPV_set(sstr, NULL);
3899 if (sflags & SVp_NOK) {
3900 SvNV_set(dstr, SvNVX(sstr));
3902 if (sflags & SVp_IOK) {
3903 SvIV_set(dstr, SvIVX(sstr));
3904 /* Must do this otherwise some other overloaded use of 0x80000000
3905 gets confused. I guess SVpbm_VALID */
3906 if (sflags & SVf_IVisUV)
3909 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3911 const MAGIC * const smg = SvVSTRING_mg(sstr);
3913 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3914 smg->mg_ptr, smg->mg_len);
3915 SvRMAGICAL_on(dstr);
3919 else if (sflags & (SVp_IOK|SVp_NOK)) {
3920 (void)SvOK_off(dstr);
3921 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3922 if (sflags & SVp_IOK) {
3923 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3924 SvIV_set(dstr, SvIVX(sstr));
3926 if (sflags & SVp_NOK) {
3927 SvNV_set(dstr, SvNVX(sstr));
3931 if (isGV_with_GP(sstr)) {
3932 /* This stringification rule for globs is spread in 3 places.
3933 This feels bad. FIXME. */
3934 const U32 wasfake = sflags & SVf_FAKE;
3936 /* FAKE globs can get coerced, so need to turn this off
3937 temporarily if it is on. */
3939 gv_efullname3(dstr, (GV *)sstr, "*");
3940 SvFLAGS(sstr) |= wasfake;
3943 (void)SvOK_off(dstr);
3945 if (SvTAINTED(sstr))
3950 =for apidoc sv_setsv_mg
3952 Like C<sv_setsv>, but also handles 'set' magic.
3958 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3960 PERL_ARGS_ASSERT_SV_SETSV_MG;
3962 sv_setsv(dstr,sstr);
3966 #ifdef PERL_OLD_COPY_ON_WRITE
3968 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3970 STRLEN cur = SvCUR(sstr);
3971 STRLEN len = SvLEN(sstr);
3972 register char *new_pv;
3974 PERL_ARGS_ASSERT_SV_SETSV_COW;
3977 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3978 (void*)sstr, (void*)dstr);
3985 if (SvTHINKFIRST(dstr))
3986 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3987 else if (SvPVX_const(dstr))
3988 Safefree(SvPVX_const(dstr));
3992 SvUPGRADE(dstr, SVt_PVIV);
3994 assert (SvPOK(sstr));
3995 assert (SvPOKp(sstr));
3996 assert (!SvIOK(sstr));
3997 assert (!SvIOKp(sstr));
3998 assert (!SvNOK(sstr));
3999 assert (!SvNOKp(sstr));
4001 if (SvIsCOW(sstr)) {
4003 if (SvLEN(sstr) == 0) {
4004 /* source is a COW shared hash key. */
4005 DEBUG_C(PerlIO_printf(Perl_debug_log,
4006 "Fast copy on write: Sharing hash\n"));
4007 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4010 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4012 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4013 SvUPGRADE(sstr, SVt_PVIV);
4014 SvREADONLY_on(sstr);
4016 DEBUG_C(PerlIO_printf(Perl_debug_log,
4017 "Fast copy on write: Converting sstr to COW\n"));
4018 SV_COW_NEXT_SV_SET(dstr, sstr);
4020 SV_COW_NEXT_SV_SET(sstr, dstr);
4021 new_pv = SvPVX_mutable(sstr);
4024 SvPV_set(dstr, new_pv);
4025 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4028 SvLEN_set(dstr, len);
4029 SvCUR_set(dstr, cur);
4038 =for apidoc sv_setpvn
4040 Copies a string into an SV. The C<len> parameter indicates the number of
4041 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4042 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4048 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4051 register char *dptr;
4053 PERL_ARGS_ASSERT_SV_SETPVN;
4055 SV_CHECK_THINKFIRST_COW_DROP(sv);
4061 /* len is STRLEN which is unsigned, need to copy to signed */
4064 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4066 SvUPGRADE(sv, SVt_PV);
4068 dptr = SvGROW(sv, len + 1);
4069 Move(ptr,dptr,len,char);
4072 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4077 =for apidoc sv_setpvn_mg
4079 Like C<sv_setpvn>, but also handles 'set' magic.
4085 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4087 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4089 sv_setpvn(sv,ptr,len);
4094 =for apidoc sv_setpv
4096 Copies a string into an SV. The string must be null-terminated. Does not
4097 handle 'set' magic. See C<sv_setpv_mg>.
4103 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4106 register STRLEN len;
4108 PERL_ARGS_ASSERT_SV_SETPV;
4110 SV_CHECK_THINKFIRST_COW_DROP(sv);
4116 SvUPGRADE(sv, SVt_PV);
4118 SvGROW(sv, len + 1);
4119 Move(ptr,SvPVX(sv),len+1,char);
4121 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4126 =for apidoc sv_setpv_mg
4128 Like C<sv_setpv>, but also handles 'set' magic.
4134 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4136 PERL_ARGS_ASSERT_SV_SETPV_MG;
4143 =for apidoc sv_usepvn_flags
4145 Tells an SV to use C<ptr> to find its string value. Normally the
4146 string is stored inside the SV but sv_usepvn allows the SV to use an
4147 outside string. The C<ptr> should point to memory that was allocated
4148 by C<malloc>. The string length, C<len>, must be supplied. By default
4149 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4150 so that pointer should not be freed or used by the programmer after
4151 giving it to sv_usepvn, and neither should any pointers from "behind"
4152 that pointer (e.g. ptr + 1) be used.
4154 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4155 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4156 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4157 C<len>, and already meets the requirements for storing in C<SvPVX>)
4163 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4168 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4170 SV_CHECK_THINKFIRST_COW_DROP(sv);
4171 SvUPGRADE(sv, SVt_PV);
4174 if (flags & SV_SMAGIC)
4178 if (SvPVX_const(sv))
4182 if (flags & SV_HAS_TRAILING_NUL)
4183 assert(ptr[len] == '\0');
4186 allocate = (flags & SV_HAS_TRAILING_NUL)
4188 #ifdef Perl_safesysmalloc_size
4191 PERL_STRLEN_ROUNDUP(len + 1);
4193 if (flags & SV_HAS_TRAILING_NUL) {
4194 /* It's long enough - do nothing.
4195 Specfically Perl_newCONSTSUB is relying on this. */
4198 /* Force a move to shake out bugs in callers. */
4199 char *new_ptr = (char*)safemalloc(allocate);
4200 Copy(ptr, new_ptr, len, char);
4201 PoisonFree(ptr,len,char);
4205 ptr = (char*) saferealloc (ptr, allocate);
4208 #ifdef Perl_safesysmalloc_size
4209 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4211 SvLEN_set(sv, allocate);
4215 if (!(flags & SV_HAS_TRAILING_NUL)) {
4218 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4220 if (flags & SV_SMAGIC)
4224 #ifdef PERL_OLD_COPY_ON_WRITE
4225 /* Need to do this *after* making the SV normal, as we need the buffer
4226 pointer to remain valid until after we've copied it. If we let go too early,
4227 another thread could invalidate it by unsharing last of the same hash key
4228 (which it can do by means other than releasing copy-on-write Svs)
4229 or by changing the other copy-on-write SVs in the loop. */
4231 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4233 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4235 { /* this SV was SvIsCOW_normal(sv) */
4236 /* we need to find the SV pointing to us. */
4237 SV *current = SV_COW_NEXT_SV(after);
4239 if (current == sv) {
4240 /* The SV we point to points back to us (there were only two of us
4242 Hence other SV is no longer copy on write either. */
4244 SvREADONLY_off(after);
4246 /* We need to follow the pointers around the loop. */
4248 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4251 /* don't loop forever if the structure is bust, and we have
4252 a pointer into a closed loop. */
4253 assert (current != after);
4254 assert (SvPVX_const(current) == pvx);
4256 /* Make the SV before us point to the SV after us. */
4257 SV_COW_NEXT_SV_SET(current, after);
4263 =for apidoc sv_force_normal_flags
4265 Undo various types of fakery on an SV: if the PV is a shared string, make
4266 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4267 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4268 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4269 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4270 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4271 set to some other value.) In addition, the C<flags> parameter gets passed to
4272 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4273 with flags set to 0.
4279 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4283 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4285 #ifdef PERL_OLD_COPY_ON_WRITE
4286 if (SvREADONLY(sv)) {
4287 /* At this point I believe I should acquire a global SV mutex. */
4289 const char * const pvx = SvPVX_const(sv);
4290 const STRLEN len = SvLEN(sv);
4291 const STRLEN cur = SvCUR(sv);
4292 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4293 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4294 we'll fail an assertion. */
4295 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4298 PerlIO_printf(Perl_debug_log,
4299 "Copy on write: Force normal %ld\n",
4305 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4308 if (flags & SV_COW_DROP_PV) {
4309 /* OK, so we don't need to copy our buffer. */
4312 SvGROW(sv, cur + 1);
4313 Move(pvx,SvPVX(sv),cur,char);
4318 sv_release_COW(sv, pvx, next);
4320 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4326 else if (IN_PERL_RUNTIME)
4327 Perl_croak(aTHX_ PL_no_modify);
4328 /* At this point I believe that I can drop the global SV mutex. */
4331 if (SvREADONLY(sv)) {
4333 const char * const pvx = SvPVX_const(sv);
4334 const STRLEN len = SvCUR(sv);
4339 SvGROW(sv, len + 1);
4340 Move(pvx,SvPVX(sv),len,char);
4342 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4344 else if (IN_PERL_RUNTIME)
4345 Perl_croak(aTHX_ PL_no_modify);
4349 sv_unref_flags(sv, flags);
4350 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4357 Efficient removal of characters from the beginning of the string buffer.
4358 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4359 the string buffer. The C<ptr> becomes the first character of the adjusted
4360 string. Uses the "OOK hack".
4361 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4362 refer to the same chunk of data.
4368 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4374 const U8 *real_start;
4377 PERL_ARGS_ASSERT_SV_CHOP;
4379 if (!ptr || !SvPOKp(sv))
4381 delta = ptr - SvPVX_const(sv);
4383 /* Nothing to do. */
4386 assert(ptr > SvPVX_const(sv));
4387 SV_CHECK_THINKFIRST(sv);
4390 if (!SvLEN(sv)) { /* make copy of shared string */
4391 const char *pvx = SvPVX_const(sv);
4392 const STRLEN len = SvCUR(sv);
4393 SvGROW(sv, len + 1);
4394 Move(pvx,SvPVX(sv),len,char);
4397 SvFLAGS(sv) |= SVf_OOK;
4400 SvOOK_offset(sv, old_delta);
4402 SvLEN_set(sv, SvLEN(sv) - delta);
4403 SvCUR_set(sv, SvCUR(sv) - delta);
4404 SvPV_set(sv, SvPVX(sv) + delta);
4406 p = (U8 *)SvPVX_const(sv);
4411 real_start = p - delta;
4415 if (delta < 0x100) {
4419 p -= sizeof(STRLEN);
4420 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4424 /* Fill the preceding buffer with sentinals to verify that no-one is
4426 while (p > real_start) {
4434 =for apidoc sv_catpvn
4436 Concatenates the string onto the end of the string which is in the SV. The
4437 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4438 status set, then the bytes appended should be valid UTF-8.
4439 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4441 =for apidoc sv_catpvn_flags
4443 Concatenates the string onto the end of the string which is in the SV. The
4444 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4445 status set, then the bytes appended should be valid UTF-8.
4446 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4447 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4448 in terms of this function.
4454 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4458 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4460 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4462 SvGROW(dsv, dlen + slen + 1);
4464 sstr = SvPVX_const(dsv);
4465 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4466 SvCUR_set(dsv, SvCUR(dsv) + slen);
4468 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4470 if (flags & SV_SMAGIC)
4475 =for apidoc sv_catsv
4477 Concatenates the string from SV C<ssv> onto the end of the string in
4478 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4479 not 'set' magic. See C<sv_catsv_mg>.
4481 =for apidoc sv_catsv_flags
4483 Concatenates the string from SV C<ssv> onto the end of the string in
4484 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4485 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4486 and C<sv_catsv_nomg> are implemented in terms of this function.
4491 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4495 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4499 const char *spv = SvPV_const(ssv, slen);
4501 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4502 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4503 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4504 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4505 dsv->sv_flags doesn't have that bit set.
4506 Andy Dougherty 12 Oct 2001
4508 const I32 sutf8 = DO_UTF8(ssv);
4511 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4513 dutf8 = DO_UTF8(dsv);
4515 if (dutf8 != sutf8) {
4517 /* Not modifying source SV, so taking a temporary copy. */
4518 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4520 sv_utf8_upgrade(csv);
4521 spv = SvPV_const(csv, slen);
4524 sv_utf8_upgrade_nomg(dsv);
4526 sv_catpvn_nomg(dsv, spv, slen);
4529 if (flags & SV_SMAGIC)
4534 =for apidoc sv_catpv
4536 Concatenates the string onto the end of the string which is in the SV.
4537 If the SV has the UTF-8 status set, then the bytes appended should be
4538 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4543 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4546 register STRLEN len;
4550 PERL_ARGS_ASSERT_SV_CATPV;
4554 junk = SvPV_force(sv, tlen);
4556 SvGROW(sv, tlen + len + 1);
4558 ptr = SvPVX_const(sv);
4559 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4560 SvCUR_set(sv, SvCUR(sv) + len);
4561 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4566 =for apidoc sv_catpv_mg
4568 Like C<sv_catpv>, but also handles 'set' magic.
4574 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4576 PERL_ARGS_ASSERT_SV_CATPV_MG;
4585 Creates a new SV. A non-zero C<len> parameter indicates the number of
4586 bytes of preallocated string space the SV should have. An extra byte for a
4587 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4588 space is allocated.) The reference count for the new SV is set to 1.
4590 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4591 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4592 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4593 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4594 modules supporting older perls.
4600 Perl_newSV(pTHX_ const STRLEN len)
4607 sv_upgrade(sv, SVt_PV);
4608 SvGROW(sv, len + 1);
4613 =for apidoc sv_magicext
4615 Adds magic to an SV, upgrading it if necessary. Applies the
4616 supplied vtable and returns a pointer to the magic added.
4618 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4619 In particular, you can add magic to SvREADONLY SVs, and add more than
4620 one instance of the same 'how'.
4622 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4623 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4624 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4625 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4627 (This is now used as a subroutine by C<sv_magic>.)
4632 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4633 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4638 PERL_ARGS_ASSERT_SV_MAGICEXT;
4640 SvUPGRADE(sv, SVt_PVMG);
4641 Newxz(mg, 1, MAGIC);
4642 mg->mg_moremagic = SvMAGIC(sv);
4643 SvMAGIC_set(sv, mg);
4645 /* Sometimes a magic contains a reference loop, where the sv and
4646 object refer to each other. To prevent a reference loop that
4647 would prevent such objects being freed, we look for such loops
4648 and if we find one we avoid incrementing the object refcount.
4650 Note we cannot do this to avoid self-tie loops as intervening RV must
4651 have its REFCNT incremented to keep it in existence.
4654 if (!obj || obj == sv ||
4655 how == PERL_MAGIC_arylen ||
4656 how == PERL_MAGIC_symtab ||
4657 (SvTYPE(obj) == SVt_PVGV &&
4658 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4659 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4660 GvFORM(obj) == (CV*)sv)))
4665 mg->mg_obj = SvREFCNT_inc_simple(obj);
4666 mg->mg_flags |= MGf_REFCOUNTED;
4669 /* Normal self-ties simply pass a null object, and instead of
4670 using mg_obj directly, use the SvTIED_obj macro to produce a
4671 new RV as needed. For glob "self-ties", we are tieing the PVIO
4672 with an RV obj pointing to the glob containing the PVIO. In
4673 this case, to avoid a reference loop, we need to weaken the
4677 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4678 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4684 mg->mg_len = namlen;
4687 mg->mg_ptr = savepvn(name, namlen);
4688 else if (namlen == HEf_SVKEY)
4689 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4691 mg->mg_ptr = (char *) name;
4693 mg->mg_virtual = (MGVTBL *) vtable;
4697 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4702 =for apidoc sv_magic
4704 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4705 then adds a new magic item of type C<how> to the head of the magic list.
4707 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4708 handling of the C<name> and C<namlen> arguments.
4710 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4711 to add more than one instance of the same 'how'.
4717 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4718 const char *const name, const I32 namlen)
4721 const MGVTBL *vtable;
4724 PERL_ARGS_ASSERT_SV_MAGIC;
4726 #ifdef PERL_OLD_COPY_ON_WRITE
4728 sv_force_normal_flags(sv, 0);
4730 if (SvREADONLY(sv)) {
4732 /* its okay to attach magic to shared strings; the subsequent
4733 * upgrade to PVMG will unshare the string */
4734 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4737 && how != PERL_MAGIC_regex_global
4738 && how != PERL_MAGIC_bm
4739 && how != PERL_MAGIC_fm
4740 && how != PERL_MAGIC_sv
4741 && how != PERL_MAGIC_backref
4744 Perl_croak(aTHX_ PL_no_modify);
4747 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4748 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4749 /* sv_magic() refuses to add a magic of the same 'how' as an
4752 if (how == PERL_MAGIC_taint) {
4754 /* Any scalar which already had taint magic on which someone
4755 (erroneously?) did SvIOK_on() or similar will now be
4756 incorrectly sporting public "OK" flags. */
4757 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4765 vtable = &PL_vtbl_sv;
4767 case PERL_MAGIC_overload:
4768 vtable = &PL_vtbl_amagic;
4770 case PERL_MAGIC_overload_elem:
4771 vtable = &PL_vtbl_amagicelem;
4773 case PERL_MAGIC_overload_table:
4774 vtable = &PL_vtbl_ovrld;
4777 vtable = &PL_vtbl_bm;
4779 case PERL_MAGIC_regdata:
4780 vtable = &PL_vtbl_regdata;
4782 case PERL_MAGIC_regdatum:
4783 vtable = &PL_vtbl_regdatum;
4785 case PERL_MAGIC_env:
4786 vtable = &PL_vtbl_env;
4789 vtable = &PL_vtbl_fm;
4791 case PERL_MAGIC_envelem:
4792 vtable = &PL_vtbl_envelem;
4794 case PERL_MAGIC_regex_global:
4795 vtable = &PL_vtbl_mglob;
4797 case PERL_MAGIC_isa:
4798 vtable = &PL_vtbl_isa;
4800 case PERL_MAGIC_isaelem:
4801 vtable = &PL_vtbl_isaelem;
4803 case PERL_MAGIC_nkeys:
4804 vtable = &PL_vtbl_nkeys;
4806 case PERL_MAGIC_dbfile:
4809 case PERL_MAGIC_dbline:
4810 vtable = &PL_vtbl_dbline;
4812 #ifdef USE_LOCALE_COLLATE
4813 case PERL_MAGIC_collxfrm:
4814 vtable = &PL_vtbl_collxfrm;
4816 #endif /* USE_LOCALE_COLLATE */
4817 case PERL_MAGIC_tied:
4818 vtable = &PL_vtbl_pack;
4820 case PERL_MAGIC_tiedelem:
4821 case PERL_MAGIC_tiedscalar:
4822 vtable = &PL_vtbl_packelem;
4825 vtable = &PL_vtbl_regexp;
4827 case PERL_MAGIC_hints:
4828 /* As this vtable is all NULL, we can reuse it. */
4829 case PERL_MAGIC_sig:
4830 vtable = &PL_vtbl_sig;
4832 case PERL_MAGIC_sigelem:
4833 vtable = &PL_vtbl_sigelem;
4835 case PERL_MAGIC_taint:
4836 vtable = &PL_vtbl_taint;
4838 case PERL_MAGIC_uvar:
4839 vtable = &PL_vtbl_uvar;
4841 case PERL_MAGIC_vec:
4842 vtable = &PL_vtbl_vec;
4844 case PERL_MAGIC_arylen_p:
4845 case PERL_MAGIC_rhash:
4846 case PERL_MAGIC_symtab:
4847 case PERL_MAGIC_vstring:
4850 case PERL_MAGIC_utf8:
4851 vtable = &PL_vtbl_utf8;
4853 case PERL_MAGIC_substr:
4854 vtable = &PL_vtbl_substr;
4856 case PERL_MAGIC_defelem:
4857 vtable = &PL_vtbl_defelem;
4859 case PERL_MAGIC_arylen:
4860 vtable = &PL_vtbl_arylen;
4862 case PERL_MAGIC_pos:
4863 vtable = &PL_vtbl_pos;
4865 case PERL_MAGIC_backref:
4866 vtable = &PL_vtbl_backref;
4868 case PERL_MAGIC_hintselem:
4869 vtable = &PL_vtbl_hintselem;
4871 case PERL_MAGIC_ext:
4872 /* Reserved for use by extensions not perl internals. */
4873 /* Useful for attaching extension internal data to perl vars. */
4874 /* Note that multiple extensions may clash if magical scalars */
4875 /* etc holding private data from one are passed to another. */
4879 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4882 /* Rest of work is done else where */
4883 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4886 case PERL_MAGIC_taint:
4889 case PERL_MAGIC_ext:
4890 case PERL_MAGIC_dbfile:
4897 =for apidoc sv_unmagic
4899 Removes all magic of type C<type> from an SV.
4905 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4910 PERL_ARGS_ASSERT_SV_UNMAGIC;
4912 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4914 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4915 for (mg = *mgp; mg; mg = *mgp) {
4916 if (mg->mg_type == type) {
4917 const MGVTBL* const vtbl = mg->mg_virtual;
4918 *mgp = mg->mg_moremagic;
4919 if (vtbl && vtbl->svt_free)
4920 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4921 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4923 Safefree(mg->mg_ptr);
4924 else if (mg->mg_len == HEf_SVKEY)
4925 SvREFCNT_dec((SV*)mg->mg_ptr);
4926 else if (mg->mg_type == PERL_MAGIC_utf8)
4927 Safefree(mg->mg_ptr);
4929 if (mg->mg_flags & MGf_REFCOUNTED)
4930 SvREFCNT_dec(mg->mg_obj);
4934 mgp = &mg->mg_moremagic;
4938 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4939 SvMAGIC_set(sv, NULL);
4946 =for apidoc sv_rvweaken
4948 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4949 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4950 push a back-reference to this RV onto the array of backreferences
4951 associated with that magic. If the RV is magical, set magic will be
4952 called after the RV is cleared.
4958 Perl_sv_rvweaken(pTHX_ SV *const sv)
4962 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4964 if (!SvOK(sv)) /* let undefs pass */
4967 Perl_croak(aTHX_ "Can't weaken a nonreference");
4968 else if (SvWEAKREF(sv)) {
4969 if (ckWARN(WARN_MISC))
4970 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4974 Perl_sv_add_backref(aTHX_ tsv, sv);
4980 /* Give tsv backref magic if it hasn't already got it, then push a
4981 * back-reference to sv onto the array associated with the backref magic.
4985 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4990 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4992 if (SvTYPE(tsv) == SVt_PVHV) {
4993 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4997 /* There is no AV in the offical place - try a fixup. */
4998 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5001 /* Aha. They've got it stowed in magic. Bring it back. */
5002 av = (AV*)mg->mg_obj;
5003 /* Stop mg_free decreasing the refernce count. */
5005 /* Stop mg_free even calling the destructor, given that
5006 there's no AV to free up. */
5008 sv_unmagic(tsv, PERL_MAGIC_backref);
5012 SvREFCNT_inc_simple_void(av);
5017 const MAGIC *const mg
5018 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5020 av = (AV*)mg->mg_obj;
5024 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5025 /* av now has a refcnt of 2, which avoids it getting freed
5026 * before us during global cleanup. The extra ref is removed
5027 * by magic_killbackrefs() when tsv is being freed */
5030 if (AvFILLp(av) >= AvMAX(av)) {
5031 av_extend(av, AvFILLp(av)+1);
5033 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5036 /* delete a back-reference to ourselves from the backref magic associated
5037 * with the SV we point to.
5041 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5048 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5050 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5051 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5052 /* We mustn't attempt to "fix up" the hash here by moving the
5053 backreference array back to the hv_aux structure, as that is stored
5054 in the main HvARRAY(), and hfreentries assumes that no-one
5055 reallocates HvARRAY() while it is running. */
5058 const MAGIC *const mg
5059 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5061 av = (AV *)mg->mg_obj;
5064 if (PL_in_clean_all)
5066 Perl_croak(aTHX_ "panic: del_backref");
5073 /* We shouldn't be in here more than once, but for paranoia reasons lets
5075 for (i = AvFILLp(av); i >= 0; i--) {
5077 const SSize_t fill = AvFILLp(av);
5079 /* We weren't the last entry.
5080 An unordered list has this property that you can take the
5081 last element off the end to fill the hole, and it's still
5082 an unordered list :-)
5087 AvFILLp(av) = fill - 1;
5093 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5095 SV **svp = AvARRAY(av);
5097 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5098 PERL_UNUSED_ARG(sv);
5100 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5101 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5102 if (svp && !SvIS_FREED(av)) {
5103 SV *const *const last = svp + AvFILLp(av);
5105 while (svp <= last) {
5107 SV *const referrer = *svp;
5108 if (SvWEAKREF(referrer)) {
5109 /* XXX Should we check that it hasn't changed? */
5110 SvRV_set(referrer, 0);
5112 SvWEAKREF_off(referrer);
5113 SvSETMAGIC(referrer);
5114 } else if (SvTYPE(referrer) == SVt_PVGV ||
5115 SvTYPE(referrer) == SVt_PVLV) {
5116 /* You lookin' at me? */
5117 assert(GvSTASH(referrer));
5118 assert(GvSTASH(referrer) == (HV*)sv);
5119 GvSTASH(referrer) = 0;
5122 "panic: magic_killbackrefs (flags=%"UVxf")",
5123 (UV)SvFLAGS(referrer));
5131 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5136 =for apidoc sv_insert
5138 Inserts a string at the specified offset/length within the SV. Similar to
5139 the Perl substr() function.
5145 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
5146 const char *const little, const STRLEN littlelen)
5151 register char *midend;
5152 register char *bigend;
5156 PERL_ARGS_ASSERT_SV_INSERT;
5159 Perl_croak(aTHX_ "Can't modify non-existent substring");
5160 SvPV_force(bigstr, curlen);
5161 (void)SvPOK_only_UTF8(bigstr);
5162 if (offset + len > curlen) {
5163 SvGROW(bigstr, offset+len+1);
5164 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5165 SvCUR_set(bigstr, offset+len);
5169 i = littlelen - len;
5170 if (i > 0) { /* string might grow */
5171 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5172 mid = big + offset + len;
5173 midend = bigend = big + SvCUR(bigstr);
5176 while (midend > mid) /* shove everything down */
5177 *--bigend = *--midend;
5178 Move(little,big+offset,littlelen,char);
5179 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5184 Move(little,SvPVX(bigstr)+offset,len,char);
5189 big = SvPVX(bigstr);
5192 bigend = big + SvCUR(bigstr);
5194 if (midend > bigend)
5195 Perl_croak(aTHX_ "panic: sv_insert");
5197 if (mid - big > bigend - midend) { /* faster to shorten from end */
5199 Move(little, mid, littlelen,char);
5202 i = bigend - midend;
5204 Move(midend, mid, i,char);
5208 SvCUR_set(bigstr, mid - big);
5210 else if ((i = mid - big)) { /* faster from front */
5211 midend -= littlelen;
5213 Move(big, midend - i, i, char);
5214 sv_chop(bigstr,midend-i);
5216 Move(little, mid, littlelen,char);
5218 else if (littlelen) {
5219 midend -= littlelen;
5220 sv_chop(bigstr,midend);
5221 Move(little,midend,littlelen,char);
5224 sv_chop(bigstr,midend);
5230 =for apidoc sv_replace
5232 Make the first argument a copy of the second, then delete the original.
5233 The target SV physically takes over ownership of the body of the source SV
5234 and inherits its flags; however, the target keeps any magic it owns,
5235 and any magic in the source is discarded.
5236 Note that this is a rather specialist SV copying operation; most of the
5237 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5243 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5246 const U32 refcnt = SvREFCNT(sv);
5248 PERL_ARGS_ASSERT_SV_REPLACE;
5250 SV_CHECK_THINKFIRST_COW_DROP(sv);
5251 if (SvREFCNT(nsv) != 1) {
5252 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5253 UVuf " != 1)", (UV) SvREFCNT(nsv));
5255 if (SvMAGICAL(sv)) {
5259 sv_upgrade(nsv, SVt_PVMG);
5260 SvMAGIC_set(nsv, SvMAGIC(sv));
5261 SvFLAGS(nsv) |= SvMAGICAL(sv);
5263 SvMAGIC_set(sv, NULL);
5267 assert(!SvREFCNT(sv));
5268 #ifdef DEBUG_LEAKING_SCALARS
5269 sv->sv_flags = nsv->sv_flags;
5270 sv->sv_any = nsv->sv_any;
5271 sv->sv_refcnt = nsv->sv_refcnt;
5272 sv->sv_u = nsv->sv_u;
5274 StructCopy(nsv,sv,SV);
5276 if(SvTYPE(sv) == SVt_IV) {
5278 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5282 #ifdef PERL_OLD_COPY_ON_WRITE
5283 if (SvIsCOW_normal(nsv)) {
5284 /* We need to follow the pointers around the loop to make the
5285 previous SV point to sv, rather than nsv. */
5288 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5291 assert(SvPVX_const(current) == SvPVX_const(nsv));
5293 /* Make the SV before us point to the SV after us. */
5295 PerlIO_printf(Perl_debug_log, "previous is\n");
5297 PerlIO_printf(Perl_debug_log,
5298 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5299 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5301 SV_COW_NEXT_SV_SET(current, sv);
5304 SvREFCNT(sv) = refcnt;
5305 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5311 =for apidoc sv_clear
5313 Clear an SV: call any destructors, free up any memory used by the body,
5314 and free the body itself. The SV's head is I<not> freed, although
5315 its type is set to all 1's so that it won't inadvertently be assumed
5316 to be live during global destruction etc.
5317 This function should only be called when REFCNT is zero. Most of the time
5318 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5325 Perl_sv_clear(pTHX_ register SV *const sv)
5328 const U32 type = SvTYPE(sv);
5329 const struct body_details *const sv_type_details
5330 = bodies_by_type + type;
5333 PERL_ARGS_ASSERT_SV_CLEAR;
5334 assert(SvREFCNT(sv) == 0);
5335 assert(SvTYPE(sv) != SVTYPEMASK);
5337 if (type <= SVt_IV) {
5338 /* See the comment in sv.h about the collusion between this early
5339 return and the overloading of the NULL and IV slots in the size
5342 SV * const target = SvRV(sv);
5344 sv_del_backref(target, sv);
5346 SvREFCNT_dec(target);
5348 SvFLAGS(sv) &= SVf_BREAK;
5349 SvFLAGS(sv) |= SVTYPEMASK;
5354 if (PL_defstash && /* Still have a symbol table? */
5361 stash = SvSTASH(sv);
5362 destructor = StashHANDLER(stash,DESTROY);
5364 SV* const tmpref = newRV(sv);
5365 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5367 PUSHSTACKi(PERLSI_DESTROY);
5372 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5378 if(SvREFCNT(tmpref) < 2) {
5379 /* tmpref is not kept alive! */
5381 SvRV_set(tmpref, NULL);
5384 SvREFCNT_dec(tmpref);
5386 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5390 if (PL_in_clean_objs)
5391 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5393 /* DESTROY gave object new lease on life */
5399 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5400 SvOBJECT_off(sv); /* Curse the object. */
5401 if (type != SVt_PVIO)
5402 --PL_sv_objcount; /* XXX Might want something more general */
5405 if (type >= SVt_PVMG) {
5406 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5407 SvREFCNT_dec(SvOURSTASH(sv));
5408 } else if (SvMAGIC(sv))
5410 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5411 SvREFCNT_dec(SvSTASH(sv));
5414 /* case SVt_BIND: */
5417 IoIFP(sv) != PerlIO_stdin() &&
5418 IoIFP(sv) != PerlIO_stdout() &&
5419 IoIFP(sv) != PerlIO_stderr())
5421 io_close((IO*)sv, FALSE);
5423 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5424 PerlDir_close(IoDIRP(sv));
5425 IoDIRP(sv) = (DIR*)NULL;
5426 Safefree(IoTOP_NAME(sv));
5427 Safefree(IoFMT_NAME(sv));
5428 Safefree(IoBOTTOM_NAME(sv));
5431 /* FIXME for plugins */
5432 pregfree2((REGEXP*) sv);
5439 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5443 if (PL_comppad == (AV*)sv) {
5450 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5451 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5452 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5453 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5455 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5456 SvREFCNT_dec(LvTARG(sv));
5458 if (isGV_with_GP(sv)) {
5459 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5460 mro_method_changed_in(stash);
5463 unshare_hek(GvNAME_HEK(sv));
5464 /* If we're in a stash, we don't own a reference to it. However it does
5465 have a back reference to us, which needs to be cleared. */
5466 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5467 sv_del_backref((SV*)stash, sv);
5469 /* FIXME. There are probably more unreferenced pointers to SVs in the
5470 interpreter struct that we should check and tidy in a similar
5472 if ((GV*)sv == PL_last_in_gv)
5473 PL_last_in_gv = NULL;
5479 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5482 SvOOK_offset(sv, offset);
5483 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5484 /* Don't even bother with turning off the OOK flag. */
5487 SV * const target = SvRV(sv);
5489 sv_del_backref(target, sv);
5491 SvREFCNT_dec(target);
5493 #ifdef PERL_OLD_COPY_ON_WRITE
5494 else if (SvPVX_const(sv)) {
5496 /* I believe I need to grab the global SV mutex here and
5497 then recheck the COW status. */
5499 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5503 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5505 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5508 /* And drop it here. */
5510 } else if (SvLEN(sv)) {
5511 Safefree(SvPVX_const(sv));
5515 else if (SvPVX_const(sv) && SvLEN(sv))
5516 Safefree(SvPVX_mutable(sv));
5517 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5518 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5527 SvFLAGS(sv) &= SVf_BREAK;
5528 SvFLAGS(sv) |= SVTYPEMASK;
5530 if (sv_type_details->arena) {
5531 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5532 &PL_body_roots[type]);
5534 else if (sv_type_details->body_size) {
5535 my_safefree(SvANY(sv));
5540 =for apidoc sv_newref
5542 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5549 Perl_sv_newref(pTHX_ SV *const sv)
5551 PERL_UNUSED_CONTEXT;
5560 Decrement an SV's reference count, and if it drops to zero, call
5561 C<sv_clear> to invoke destructors and free up any memory used by
5562 the body; finally, deallocate the SV's head itself.
5563 Normally called via a wrapper macro C<SvREFCNT_dec>.
5569 Perl_sv_free(pTHX_ SV *const sv)
5574 if (SvREFCNT(sv) == 0) {
5575 if (SvFLAGS(sv) & SVf_BREAK)
5576 /* this SV's refcnt has been artificially decremented to
5577 * trigger cleanup */
5579 if (PL_in_clean_all) /* All is fair */
5581 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5582 /* make sure SvREFCNT(sv)==0 happens very seldom */
5583 SvREFCNT(sv) = (~(U32)0)/2;
5586 if (ckWARN_d(WARN_INTERNAL)) {
5587 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5588 Perl_dump_sv_child(aTHX_ sv);
5590 #ifdef DEBUG_LEAKING_SCALARS
5593 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5594 if (PL_warnhook == PERL_WARNHOOK_FATAL
5595 || ckDEAD(packWARN(WARN_INTERNAL))) {
5596 /* Don't let Perl_warner cause us to escape our fate: */
5600 /* This may not return: */
5601 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5602 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5603 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5606 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5611 if (--(SvREFCNT(sv)) > 0)
5613 Perl_sv_free2(aTHX_ sv);
5617 Perl_sv_free2(pTHX_ SV *const sv)
5621 PERL_ARGS_ASSERT_SV_FREE2;
5625 if (ckWARN_d(WARN_DEBUGGING))
5626 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5627 "Attempt to free temp prematurely: SV 0x%"UVxf
5628 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5632 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5633 /* make sure SvREFCNT(sv)==0 happens very seldom */
5634 SvREFCNT(sv) = (~(U32)0)/2;
5645 Returns the length of the string in the SV. Handles magic and type
5646 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5652 Perl_sv_len(pTHX_ register SV *const sv)
5660 len = mg_length(sv);
5662 (void)SvPV_const(sv, len);
5667 =for apidoc sv_len_utf8
5669 Returns the number of characters in the string in an SV, counting wide
5670 UTF-8 bytes as a single character. Handles magic and type coercion.
5676 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5677 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5678 * (Note that the mg_len is not the length of the mg_ptr field.
5679 * This allows the cache to store the character length of the string without
5680 * needing to malloc() extra storage to attach to the mg_ptr.)
5685 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5691 return mg_length(sv);
5695 const U8 *s = (U8*)SvPV_const(sv, len);
5699 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5701 if (mg && mg->mg_len != -1) {
5703 if (PL_utf8cache < 0) {
5704 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5706 /* Need to turn the assertions off otherwise we may
5707 recurse infinitely while printing error messages.
5709 SAVEI8(PL_utf8cache);
5711 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5712 " real %"UVuf" for %"SVf,
5713 (UV) ulen, (UV) real, SVfARG(sv));
5718 ulen = Perl_utf8_length(aTHX_ s, s + len);
5719 if (!SvREADONLY(sv)) {
5721 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5722 &PL_vtbl_utf8, 0, 0);
5730 return Perl_utf8_length(aTHX_ s, s + len);
5734 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5737 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5740 const U8 *s = start;
5742 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5744 while (s < send && uoffset--)
5747 /* This is the existing behaviour. Possibly it should be a croak, as
5748 it's actually a bounds error */
5754 /* Given the length of the string in both bytes and UTF-8 characters, decide
5755 whether to walk forwards or backwards to find the byte corresponding to
5756 the passed in UTF-8 offset. */
5758 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5759 const STRLEN uoffset, const STRLEN uend)
5761 STRLEN backw = uend - uoffset;
5763 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5765 if (uoffset < 2 * backw) {
5766 /* The assumption is that going forwards is twice the speed of going
5767 forward (that's where the 2 * backw comes from).
5768 (The real figure of course depends on the UTF-8 data.) */
5769 return sv_pos_u2b_forwards(start, send, uoffset);
5774 while (UTF8_IS_CONTINUATION(*send))
5777 return send - start;
5780 /* For the string representation of the given scalar, find the byte
5781 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5782 give another position in the string, *before* the sought offset, which
5783 (which is always true, as 0, 0 is a valid pair of positions), which should
5784 help reduce the amount of linear searching.
5785 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5786 will be used to reduce the amount of linear searching. The cache will be
5787 created if necessary, and the found value offered to it for update. */
5789 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5790 const U8 *const send, const STRLEN uoffset,
5791 STRLEN uoffset0, STRLEN boffset0)
5793 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5796 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5798 assert (uoffset >= uoffset0);
5800 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5801 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5802 if ((*mgp)->mg_ptr) {
5803 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5804 if (cache[0] == uoffset) {
5805 /* An exact match. */
5808 if (cache[2] == uoffset) {
5809 /* An exact match. */
5813 if (cache[0] < uoffset) {
5814 /* The cache already knows part of the way. */
5815 if (cache[0] > uoffset0) {
5816 /* The cache knows more than the passed in pair */
5817 uoffset0 = cache[0];
5818 boffset0 = cache[1];
5820 if ((*mgp)->mg_len != -1) {
5821 /* And we know the end too. */
5823 + sv_pos_u2b_midway(start + boffset0, send,
5825 (*mgp)->mg_len - uoffset0);
5828 + sv_pos_u2b_forwards(start + boffset0,
5829 send, uoffset - uoffset0);
5832 else if (cache[2] < uoffset) {
5833 /* We're between the two cache entries. */
5834 if (cache[2] > uoffset0) {
5835 /* and the cache knows more than the passed in pair */
5836 uoffset0 = cache[2];
5837 boffset0 = cache[3];
5841 + sv_pos_u2b_midway(start + boffset0,
5844 cache[0] - uoffset0);
5847 + sv_pos_u2b_midway(start + boffset0,
5850 cache[2] - uoffset0);
5854 else if ((*mgp)->mg_len != -1) {
5855 /* If we can take advantage of a passed in offset, do so. */
5856 /* In fact, offset0 is either 0, or less than offset, so don't
5857 need to worry about the other possibility. */
5859 + sv_pos_u2b_midway(start + boffset0, send,
5861 (*mgp)->mg_len - uoffset0);
5866 if (!found || PL_utf8cache < 0) {
5867 const STRLEN real_boffset
5868 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5869 send, uoffset - uoffset0);
5871 if (found && PL_utf8cache < 0) {
5872 if (real_boffset != boffset) {
5873 /* Need to turn the assertions off otherwise we may recurse
5874 infinitely while printing error messages. */
5875 SAVEI8(PL_utf8cache);
5877 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5878 " real %"UVuf" for %"SVf,
5879 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5882 boffset = real_boffset;
5885 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5891 =for apidoc sv_pos_u2b
5893 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5894 the start of the string, to a count of the equivalent number of bytes; if
5895 lenp is non-zero, it does the same to lenp, but this time starting from
5896 the offset, rather than from the start of the string. Handles magic and
5903 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5904 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5905 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5910 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5915 PERL_ARGS_ASSERT_SV_POS_U2B;
5920 start = (U8*)SvPV_const(sv, len);
5922 STRLEN uoffset = (STRLEN) *offsetp;
5923 const U8 * const send = start + len;
5925 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5928 *offsetp = (I32) boffset;
5931 /* Convert the relative offset to absolute. */
5932 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5933 const STRLEN boffset2
5934 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5935 uoffset, boffset) - boffset;
5949 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5950 byte length pairing. The (byte) length of the total SV is passed in too,
5951 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5952 may not have updated SvCUR, so we can't rely on reading it directly.
5954 The proffered utf8/byte length pairing isn't used if the cache already has
5955 two pairs, and swapping either for the proffered pair would increase the
5956 RMS of the intervals between known byte offsets.
5958 The cache itself consists of 4 STRLEN values
5959 0: larger UTF-8 offset
5960 1: corresponding byte offset
5961 2: smaller UTF-8 offset
5962 3: corresponding byte offset
5964 Unused cache pairs have the value 0, 0.
5965 Keeping the cache "backwards" means that the invariant of
5966 cache[0] >= cache[2] is maintained even with empty slots, which means that
5967 the code that uses it doesn't need to worry if only 1 entry has actually
5968 been set to non-zero. It also makes the "position beyond the end of the
5969 cache" logic much simpler, as the first slot is always the one to start
5973 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5974 const STRLEN utf8, const STRLEN blen)
5978 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5984 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5986 (*mgp)->mg_len = -1;
5990 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5991 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5992 (*mgp)->mg_ptr = (char *) cache;
5996 if (PL_utf8cache < 0) {
5997 const U8 *start = (const U8 *) SvPVX_const(sv);
5998 const STRLEN realutf8 = utf8_length(start, start + byte);
6000 if (realutf8 != utf8) {
6001 /* Need to turn the assertions off otherwise we may recurse
6002 infinitely while printing error messages. */
6003 SAVEI8(PL_utf8cache);
6005 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6006 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6010 /* Cache is held with the later position first, to simplify the code
6011 that deals with unbounded ends. */
6013 ASSERT_UTF8_CACHE(cache);
6014 if (cache[1] == 0) {
6015 /* Cache is totally empty */
6018 } else if (cache[3] == 0) {
6019 if (byte > cache[1]) {
6020 /* New one is larger, so goes first. */
6021 cache[2] = cache[0];
6022 cache[3] = cache[1];
6030 #define THREEWAY_SQUARE(a,b,c,d) \
6031 ((float)((d) - (c))) * ((float)((d) - (c))) \
6032 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6033 + ((float)((b) - (a))) * ((float)((b) - (a)))
6035 /* Cache has 2 slots in use, and we know three potential pairs.
6036 Keep the two that give the lowest RMS distance. Do the
6037 calcualation in bytes simply because we always know the byte
6038 length. squareroot has the same ordering as the positive value,
6039 so don't bother with the actual square root. */
6040 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6041 if (byte > cache[1]) {
6042 /* New position is after the existing pair of pairs. */
6043 const float keep_earlier
6044 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6045 const float keep_later
6046 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6048 if (keep_later < keep_earlier) {
6049 if (keep_later < existing) {
6050 cache[2] = cache[0];
6051 cache[3] = cache[1];
6057 if (keep_earlier < existing) {
6063 else if (byte > cache[3]) {
6064 /* New position is between the existing pair of pairs. */
6065 const float keep_earlier
6066 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6067 const float keep_later
6068 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6070 if (keep_later < keep_earlier) {
6071 if (keep_later < existing) {
6077 if (keep_earlier < existing) {
6084 /* New position is before the existing pair of pairs. */
6085 const float keep_earlier
6086 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6087 const float keep_later
6088 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6090 if (keep_later < keep_earlier) {
6091 if (keep_later < existing) {
6097 if (keep_earlier < existing) {
6098 cache[0] = cache[2];
6099 cache[1] = cache[3];
6106 ASSERT_UTF8_CACHE(cache);
6109 /* We already know all of the way, now we may be able to walk back. The same
6110 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6111 backward is half the speed of walking forward. */
6113 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6114 const U8 *end, STRLEN endu)
6116 const STRLEN forw = target - s;
6117 STRLEN backw = end - target;
6119 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6121 if (forw < 2 * backw) {
6122 return utf8_length(s, target);
6125 while (end > target) {
6127 while (UTF8_IS_CONTINUATION(*end)) {
6136 =for apidoc sv_pos_b2u
6138 Converts the value pointed to by offsetp from a count of bytes from the
6139 start of the string, to a count of the equivalent number of UTF-8 chars.
6140 Handles magic and type coercion.
6146 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6147 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6152 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6155 const STRLEN byte = *offsetp;
6156 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6162 PERL_ARGS_ASSERT_SV_POS_B2U;
6167 s = (const U8*)SvPV_const(sv, blen);
6170 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6174 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6175 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6177 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6178 if (cache[1] == byte) {
6179 /* An exact match. */
6180 *offsetp = cache[0];
6183 if (cache[3] == byte) {
6184 /* An exact match. */
6185 *offsetp = cache[2];
6189 if (cache[1] < byte) {
6190 /* We already know part of the way. */
6191 if (mg->mg_len != -1) {
6192 /* Actually, we know the end too. */
6194 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6195 s + blen, mg->mg_len - cache[0]);
6197 len = cache[0] + utf8_length(s + cache[1], send);
6200 else if (cache[3] < byte) {
6201 /* We're between the two cached pairs, so we do the calculation
6202 offset by the byte/utf-8 positions for the earlier pair,
6203 then add the utf-8 characters from the string start to
6205 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6206 s + cache[1], cache[0] - cache[2])
6210 else { /* cache[3] > byte */
6211 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6215 ASSERT_UTF8_CACHE(cache);
6217 } else if (mg->mg_len != -1) {
6218 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6222 if (!found || PL_utf8cache < 0) {
6223 const STRLEN real_len = utf8_length(s, send);
6225 if (found && PL_utf8cache < 0) {
6226 if (len != real_len) {
6227 /* Need to turn the assertions off otherwise we may recurse
6228 infinitely while printing error messages. */
6229 SAVEI8(PL_utf8cache);
6231 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6232 " real %"UVuf" for %"SVf,
6233 (UV) len, (UV) real_len, SVfARG(sv));
6240 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6246 Returns a boolean indicating whether the strings in the two SVs are
6247 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6248 coerce its args to strings if necessary.
6254 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6263 SV* svrecode = NULL;
6270 /* if pv1 and pv2 are the same, second SvPV_const call may
6271 * invalidate pv1, so we may need to make a copy */
6272 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6273 pv1 = SvPV_const(sv1, cur1);
6274 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6276 pv1 = SvPV_const(sv1, cur1);
6284 pv2 = SvPV_const(sv2, cur2);
6286 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6287 /* Differing utf8ness.
6288 * Do not UTF8size the comparands as a side-effect. */
6291 svrecode = newSVpvn(pv2, cur2);
6292 sv_recode_to_utf8(svrecode, PL_encoding);
6293 pv2 = SvPV_const(svrecode, cur2);
6296 svrecode = newSVpvn(pv1, cur1);
6297 sv_recode_to_utf8(svrecode, PL_encoding);
6298 pv1 = SvPV_const(svrecode, cur1);
6300 /* Now both are in UTF-8. */
6302 SvREFCNT_dec(svrecode);
6307 bool is_utf8 = TRUE;
6310 /* sv1 is the UTF-8 one,
6311 * if is equal it must be downgrade-able */
6312 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6318 /* sv2 is the UTF-8 one,
6319 * if is equal it must be downgrade-able */
6320 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6326 /* Downgrade not possible - cannot be eq */
6334 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6336 SvREFCNT_dec(svrecode);
6346 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6347 string in C<sv1> is less than, equal to, or greater than the string in
6348 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6349 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6355 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6359 const char *pv1, *pv2;
6362 SV *svrecode = NULL;
6369 pv1 = SvPV_const(sv1, cur1);
6376 pv2 = SvPV_const(sv2, cur2);
6378 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6379 /* Differing utf8ness.
6380 * Do not UTF8size the comparands as a side-effect. */
6383 svrecode = newSVpvn(pv2, cur2);
6384 sv_recode_to_utf8(svrecode, PL_encoding);
6385 pv2 = SvPV_const(svrecode, cur2);
6388 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6393 svrecode = newSVpvn(pv1, cur1);
6394 sv_recode_to_utf8(svrecode, PL_encoding);
6395 pv1 = SvPV_const(svrecode, cur1);
6398 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6404 cmp = cur2 ? -1 : 0;
6408 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6411 cmp = retval < 0 ? -1 : 1;
6412 } else if (cur1 == cur2) {
6415 cmp = cur1 < cur2 ? -1 : 1;
6419 SvREFCNT_dec(svrecode);
6427 =for apidoc sv_cmp_locale
6429 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6430 'use bytes' aware, handles get magic, and will coerce its args to strings
6431 if necessary. See also C<sv_cmp>.
6437 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6440 #ifdef USE_LOCALE_COLLATE
6446 if (PL_collation_standard)
6450 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6452 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6454 if (!pv1 || !len1) {
6465 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6468 return retval < 0 ? -1 : 1;
6471 * When the result of collation is equality, that doesn't mean
6472 * that there are no differences -- some locales exclude some
6473 * characters from consideration. So to avoid false equalities,
6474 * we use the raw string as a tiebreaker.
6480 #endif /* USE_LOCALE_COLLATE */
6482 return sv_cmp(sv1, sv2);
6486 #ifdef USE_LOCALE_COLLATE
6489 =for apidoc sv_collxfrm
6491 Add Collate Transform magic to an SV if it doesn't already have it.
6493 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6494 scalar data of the variable, but transformed to such a format that a normal
6495 memory comparison can be used to compare the data according to the locale
6502 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6507 PERL_ARGS_ASSERT_SV_COLLXFRM;
6509 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6510 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6516 Safefree(mg->mg_ptr);
6517 s = SvPV_const(sv, len);
6518 if ((xf = mem_collxfrm(s, len, &xlen))) {
6520 #ifdef PERL_OLD_COPY_ON_WRITE
6522 sv_force_normal_flags(sv, 0);
6524 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6538 if (mg && mg->mg_ptr) {
6540 return mg->mg_ptr + sizeof(PL_collation_ix);
6548 #endif /* USE_LOCALE_COLLATE */
6553 Get a line from the filehandle and store it into the SV, optionally
6554 appending to the currently-stored string.
6560 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6565 register STDCHAR rslast;
6566 register STDCHAR *bp;
6571 PERL_ARGS_ASSERT_SV_GETS;
6573 if (SvTHINKFIRST(sv))
6574 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6575 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6577 However, perlbench says it's slower, because the existing swipe code
6578 is faster than copy on write.
6579 Swings and roundabouts. */
6580 SvUPGRADE(sv, SVt_PV);
6585 if (PerlIO_isutf8(fp)) {
6587 sv_utf8_upgrade_nomg(sv);
6588 sv_pos_u2b(sv,&append,0);
6590 } else if (SvUTF8(sv)) {
6591 SV * const tsv = newSV(0);
6592 sv_gets(tsv, fp, 0);
6593 sv_utf8_upgrade_nomg(tsv);
6594 SvCUR_set(sv,append);
6597 goto return_string_or_null;
6602 if (PerlIO_isutf8(fp))
6605 if (IN_PERL_COMPILETIME) {
6606 /* we always read code in line mode */
6610 else if (RsSNARF(PL_rs)) {
6611 /* If it is a regular disk file use size from stat() as estimate
6612 of amount we are going to read -- may result in mallocing
6613 more memory than we really need if the layers below reduce
6614 the size we read (e.g. CRLF or a gzip layer).
6617 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6618 const Off_t offset = PerlIO_tell(fp);
6619 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6620 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6626 else if (RsRECORD(PL_rs)) {
6631 /* Grab the size of the record we're getting */
6632 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6633 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6636 /* VMS wants read instead of fread, because fread doesn't respect */
6637 /* RMS record boundaries. This is not necessarily a good thing to be */
6638 /* doing, but we've got no other real choice - except avoid stdio
6639 as implementation - perhaps write a :vms layer ?
6641 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6643 bytesread = PerlIO_read(fp, buffer, recsize);
6647 SvCUR_set(sv, bytesread += append);
6648 buffer[bytesread] = '\0';
6649 goto return_string_or_null;
6651 else if (RsPARA(PL_rs)) {
6657 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6658 if (PerlIO_isutf8(fp)) {
6659 rsptr = SvPVutf8(PL_rs, rslen);
6662 if (SvUTF8(PL_rs)) {
6663 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6664 Perl_croak(aTHX_ "Wide character in $/");
6667 rsptr = SvPV_const(PL_rs, rslen);
6671 rslast = rslen ? rsptr[rslen - 1] : '\0';
6673 if (rspara) { /* have to do this both before and after */
6674 do { /* to make sure file boundaries work right */
6677 i = PerlIO_getc(fp);
6681 PerlIO_ungetc(fp,i);
6687 /* See if we know enough about I/O mechanism to cheat it ! */
6689 /* This used to be #ifdef test - it is made run-time test for ease
6690 of abstracting out stdio interface. One call should be cheap
6691 enough here - and may even be a macro allowing compile
6695 if (PerlIO_fast_gets(fp)) {
6698 * We're going to steal some values from the stdio struct
6699 * and put EVERYTHING in the innermost loop into registers.
6701 register STDCHAR *ptr;
6705 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6706 /* An ungetc()d char is handled separately from the regular
6707 * buffer, so we getc() it back out and stuff it in the buffer.
6709 i = PerlIO_getc(fp);
6710 if (i == EOF) return 0;
6711 *(--((*fp)->_ptr)) = (unsigned char) i;
6715 /* Here is some breathtakingly efficient cheating */
6717 cnt = PerlIO_get_cnt(fp); /* get count into register */
6718 /* make sure we have the room */
6719 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6720 /* Not room for all of it
6721 if we are looking for a separator and room for some
6723 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6724 /* just process what we have room for */
6725 shortbuffered = cnt - SvLEN(sv) + append + 1;
6726 cnt -= shortbuffered;
6730 /* remember that cnt can be negative */
6731 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6736 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6737 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6738 DEBUG_P(PerlIO_printf(Perl_debug_log,
6739 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6740 DEBUG_P(PerlIO_printf(Perl_debug_log,
6741 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6742 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6743 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6748 while (cnt > 0) { /* this | eat */
6750 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6751 goto thats_all_folks; /* screams | sed :-) */
6755 Copy(ptr, bp, cnt, char); /* this | eat */
6756 bp += cnt; /* screams | dust */
6757 ptr += cnt; /* louder | sed :-) */
6762 if (shortbuffered) { /* oh well, must extend */
6763 cnt = shortbuffered;
6765 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6767 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6768 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6772 DEBUG_P(PerlIO_printf(Perl_debug_log,
6773 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6774 PTR2UV(ptr),(long)cnt));
6775 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6777 DEBUG_P(PerlIO_printf(Perl_debug_log,
6778 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6779 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6780 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6782 /* This used to call 'filbuf' in stdio form, but as that behaves like
6783 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6784 another abstraction. */
6785 i = PerlIO_getc(fp); /* get more characters */
6787 DEBUG_P(PerlIO_printf(Perl_debug_log,
6788 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6789 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6790 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6792 cnt = PerlIO_get_cnt(fp);
6793 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6794 DEBUG_P(PerlIO_printf(Perl_debug_log,
6795 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6797 if (i == EOF) /* all done for ever? */
6798 goto thats_really_all_folks;
6800 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6802 SvGROW(sv, bpx + cnt + 2);
6803 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6805 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6807 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6808 goto thats_all_folks;
6812 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6813 memNE((char*)bp - rslen, rsptr, rslen))
6814 goto screamer; /* go back to the fray */
6815 thats_really_all_folks:
6817 cnt += shortbuffered;
6818 DEBUG_P(PerlIO_printf(Perl_debug_log,
6819 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6820 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6821 DEBUG_P(PerlIO_printf(Perl_debug_log,
6822 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6823 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6824 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6826 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6827 DEBUG_P(PerlIO_printf(Perl_debug_log,
6828 "Screamer: done, len=%ld, string=|%.*s|\n",
6829 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6833 /*The big, slow, and stupid way. */
6834 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6835 STDCHAR *buf = NULL;
6836 Newx(buf, 8192, STDCHAR);
6844 register const STDCHAR * const bpe = buf + sizeof(buf);
6846 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6847 ; /* keep reading */
6851 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6852 /* Accomodate broken VAXC compiler, which applies U8 cast to
6853 * both args of ?: operator, causing EOF to change into 255
6856 i = (U8)buf[cnt - 1];
6862 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6864 sv_catpvn(sv, (char *) buf, cnt);
6866 sv_setpvn(sv, (char *) buf, cnt);
6868 if (i != EOF && /* joy */
6870 SvCUR(sv) < rslen ||
6871 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6875 * If we're reading from a TTY and we get a short read,
6876 * indicating that the user hit his EOF character, we need
6877 * to notice it now, because if we try to read from the TTY
6878 * again, the EOF condition will disappear.
6880 * The comparison of cnt to sizeof(buf) is an optimization
6881 * that prevents unnecessary calls to feof().
6885 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6889 #ifdef USE_HEAP_INSTEAD_OF_STACK
6894 if (rspara) { /* have to do this both before and after */
6895 while (i != EOF) { /* to make sure file boundaries work right */
6896 i = PerlIO_getc(fp);
6898 PerlIO_ungetc(fp,i);
6904 return_string_or_null:
6905 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6911 Auto-increment of the value in the SV, doing string to numeric conversion
6912 if necessary. Handles 'get' magic.
6918 Perl_sv_inc(pTHX_ register SV *const sv)
6927 if (SvTHINKFIRST(sv)) {
6929 sv_force_normal_flags(sv, 0);
6930 if (SvREADONLY(sv)) {
6931 if (IN_PERL_RUNTIME)
6932 Perl_croak(aTHX_ PL_no_modify);
6936 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6938 i = PTR2IV(SvRV(sv));
6943 flags = SvFLAGS(sv);
6944 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6945 /* It's (privately or publicly) a float, but not tested as an
6946 integer, so test it to see. */
6948 flags = SvFLAGS(sv);
6950 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6951 /* It's publicly an integer, or privately an integer-not-float */
6952 #ifdef PERL_PRESERVE_IVUV
6956 if (SvUVX(sv) == UV_MAX)
6957 sv_setnv(sv, UV_MAX_P1);
6959 (void)SvIOK_only_UV(sv);
6960 SvUV_set(sv, SvUVX(sv) + 1);
6962 if (SvIVX(sv) == IV_MAX)
6963 sv_setuv(sv, (UV)IV_MAX + 1);
6965 (void)SvIOK_only(sv);
6966 SvIV_set(sv, SvIVX(sv) + 1);
6971 if (flags & SVp_NOK) {
6972 const NV was = SvNVX(sv);
6973 if (NV_OVERFLOWS_INTEGERS_AT &&
6974 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6975 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6976 "Lost precision when incrementing %" NVff " by 1",
6979 (void)SvNOK_only(sv);
6980 SvNV_set(sv, was + 1.0);
6984 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6985 if ((flags & SVTYPEMASK) < SVt_PVIV)
6986 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6987 (void)SvIOK_only(sv);
6992 while (isALPHA(*d)) d++;
6993 while (isDIGIT(*d)) d++;
6995 #ifdef PERL_PRESERVE_IVUV
6996 /* Got to punt this as an integer if needs be, but we don't issue
6997 warnings. Probably ought to make the sv_iv_please() that does
6998 the conversion if possible, and silently. */
6999 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7000 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7001 /* Need to try really hard to see if it's an integer.
7002 9.22337203685478e+18 is an integer.
7003 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7004 so $a="9.22337203685478e+18"; $a+0; $a++
7005 needs to be the same as $a="9.22337203685478e+18"; $a++
7012 /* sv_2iv *should* have made this an NV */
7013 if (flags & SVp_NOK) {
7014 (void)SvNOK_only(sv);
7015 SvNV_set(sv, SvNVX(sv) + 1.0);
7018 /* I don't think we can get here. Maybe I should assert this
7019 And if we do get here I suspect that sv_setnv will croak. NWC
7021 #if defined(USE_LONG_DOUBLE)
7022 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",
7023 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7025 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7026 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7029 #endif /* PERL_PRESERVE_IVUV */
7030 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7034 while (d >= SvPVX_const(sv)) {
7042 /* MKS: The original code here died if letters weren't consecutive.
7043 * at least it didn't have to worry about non-C locales. The
7044 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7045 * arranged in order (although not consecutively) and that only
7046 * [A-Za-z] are accepted by isALPHA in the C locale.
7048 if (*d != 'z' && *d != 'Z') {
7049 do { ++*d; } while (!isALPHA(*d));
7052 *(d--) -= 'z' - 'a';
7057 *(d--) -= 'z' - 'a' + 1;
7061 /* oh,oh, the number grew */
7062 SvGROW(sv, SvCUR(sv) + 2);
7063 SvCUR_set(sv, SvCUR(sv) + 1);
7064 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7075 Auto-decrement of the value in the SV, doing string to numeric conversion
7076 if necessary. Handles 'get' magic.
7082 Perl_sv_dec(pTHX_ register SV *const sv)
7090 if (SvTHINKFIRST(sv)) {
7092 sv_force_normal_flags(sv, 0);
7093 if (SvREADONLY(sv)) {
7094 if (IN_PERL_RUNTIME)
7095 Perl_croak(aTHX_ PL_no_modify);
7099 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7101 i = PTR2IV(SvRV(sv));
7106 /* Unlike sv_inc we don't have to worry about string-never-numbers
7107 and keeping them magic. But we mustn't warn on punting */
7108 flags = SvFLAGS(sv);
7109 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7110 /* It's publicly an integer, or privately an integer-not-float */
7111 #ifdef PERL_PRESERVE_IVUV
7115 if (SvUVX(sv) == 0) {
7116 (void)SvIOK_only(sv);
7120 (void)SvIOK_only_UV(sv);
7121 SvUV_set(sv, SvUVX(sv) - 1);
7124 if (SvIVX(sv) == IV_MIN) {
7125 sv_setnv(sv, (NV)IV_MIN);
7129 (void)SvIOK_only(sv);
7130 SvIV_set(sv, SvIVX(sv) - 1);
7135 if (flags & SVp_NOK) {
7138 const NV was = SvNVX(sv);
7139 if (NV_OVERFLOWS_INTEGERS_AT &&
7140 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7141 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7142 "Lost precision when decrementing %" NVff " by 1",
7145 (void)SvNOK_only(sv);
7146 SvNV_set(sv, was - 1.0);
7150 if (!(flags & SVp_POK)) {
7151 if ((flags & SVTYPEMASK) < SVt_PVIV)
7152 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7154 (void)SvIOK_only(sv);
7157 #ifdef PERL_PRESERVE_IVUV
7159 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7160 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7161 /* Need to try really hard to see if it's an integer.
7162 9.22337203685478e+18 is an integer.
7163 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7164 so $a="9.22337203685478e+18"; $a+0; $a--
7165 needs to be the same as $a="9.22337203685478e+18"; $a--
7172 /* sv_2iv *should* have made this an NV */
7173 if (flags & SVp_NOK) {
7174 (void)SvNOK_only(sv);
7175 SvNV_set(sv, SvNVX(sv) - 1.0);
7178 /* I don't think we can get here. Maybe I should assert this
7179 And if we do get here I suspect that sv_setnv will croak. NWC
7181 #if defined(USE_LONG_DOUBLE)
7182 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",
7183 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7185 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7186 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7190 #endif /* PERL_PRESERVE_IVUV */
7191 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7195 =for apidoc sv_mortalcopy
7197 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7198 The new SV is marked as mortal. It will be destroyed "soon", either by an
7199 explicit call to FREETMPS, or by an implicit call at places such as
7200 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7205 /* Make a string that will exist for the duration of the expression
7206 * evaluation. Actually, it may have to last longer than that, but
7207 * hopefully we won't free it until it has been assigned to a
7208 * permanent location. */
7211 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7217 sv_setsv(sv,oldstr);
7219 PL_tmps_stack[++PL_tmps_ix] = sv;
7225 =for apidoc sv_newmortal
7227 Creates a new null SV which is mortal. The reference count of the SV is
7228 set to 1. It will be destroyed "soon", either by an explicit call to
7229 FREETMPS, or by an implicit call at places such as statement boundaries.
7230 See also C<sv_mortalcopy> and C<sv_2mortal>.
7236 Perl_sv_newmortal(pTHX)
7242 SvFLAGS(sv) = SVs_TEMP;
7244 PL_tmps_stack[++PL_tmps_ix] = sv;
7250 =for apidoc newSVpvn_flags
7252 Creates a new SV and copies a string into it. The reference count for the
7253 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7254 string. You are responsible for ensuring that the source string is at least
7255 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7256 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7257 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7258 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7259 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7261 #define newSVpvn_utf8(s, len, u) \
7262 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7268 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7273 /* All the flags we don't support must be zero.
7274 And we're new code so I'm going to assert this from the start. */
7275 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7277 sv_setpvn(sv,s,len);
7278 SvFLAGS(sv) |= (flags & SVf_UTF8);
7279 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7283 =for apidoc sv_2mortal
7285 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7286 by an explicit call to FREETMPS, or by an implicit call at places such as
7287 statement boundaries. SvTEMP() is turned on which means that the SV's
7288 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7289 and C<sv_mortalcopy>.
7295 Perl_sv_2mortal(pTHX_ register SV *const sv)
7300 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7303 PL_tmps_stack[++PL_tmps_ix] = sv;
7311 Creates a new SV and copies a string into it. The reference count for the
7312 SV is set to 1. If C<len> is zero, Perl will compute the length using
7313 strlen(). For efficiency, consider using C<newSVpvn> instead.
7319 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7325 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7330 =for apidoc newSVpvn
7332 Creates a new SV and copies a string into it. The reference count for the
7333 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7334 string. You are responsible for ensuring that the source string is at least
7335 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7341 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7347 sv_setpvn(sv,s,len);
7352 =for apidoc newSVhek
7354 Creates a new SV from the hash key structure. It will generate scalars that
7355 point to the shared string table where possible. Returns a new (undefined)
7356 SV if the hek is NULL.
7362 Perl_newSVhek(pTHX_ const HEK *const hek)
7372 if (HEK_LEN(hek) == HEf_SVKEY) {
7373 return newSVsv(*(SV**)HEK_KEY(hek));
7375 const int flags = HEK_FLAGS(hek);
7376 if (flags & HVhek_WASUTF8) {
7378 Andreas would like keys he put in as utf8 to come back as utf8
7380 STRLEN utf8_len = HEK_LEN(hek);
7381 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7382 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7385 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7387 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7388 /* We don't have a pointer to the hv, so we have to replicate the
7389 flag into every HEK. This hv is using custom a hasing
7390 algorithm. Hence we can't return a shared string scalar, as
7391 that would contain the (wrong) hash value, and might get passed
7392 into an hv routine with a regular hash.
7393 Similarly, a hash that isn't using shared hash keys has to have
7394 the flag in every key so that we know not to try to call
7395 share_hek_kek on it. */
7397 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7402 /* This will be overwhelminly the most common case. */
7404 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7405 more efficient than sharepvn(). */
7409 sv_upgrade(sv, SVt_PV);
7410 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7411 SvCUR_set(sv, HEK_LEN(hek));
7424 =for apidoc newSVpvn_share
7426 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7427 table. If the string does not already exist in the table, it is created
7428 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7429 value is used; otherwise the hash is computed. The string's hash can be later
7430 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7431 that as the string table is used for shared hash keys these strings will have
7432 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7438 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7442 bool is_utf8 = FALSE;
7443 const char *const orig_src = src;
7446 STRLEN tmplen = -len;
7448 /* See the note in hv.c:hv_fetch() --jhi */
7449 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7453 PERL_HASH(hash, src, len);
7455 sv_upgrade(sv, SVt_PV);
7456 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7464 if (src != orig_src)
7470 #if defined(PERL_IMPLICIT_CONTEXT)
7472 /* pTHX_ magic can't cope with varargs, so this is a no-context
7473 * version of the main function, (which may itself be aliased to us).
7474 * Don't access this version directly.
7478 Perl_newSVpvf_nocontext(const char *const pat, ...)
7484 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7486 va_start(args, pat);
7487 sv = vnewSVpvf(pat, &args);
7494 =for apidoc newSVpvf
7496 Creates a new SV and initializes it with the string formatted like
7503 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7508 PERL_ARGS_ASSERT_NEWSVPVF;
7510 va_start(args, pat);
7511 sv = vnewSVpvf(pat, &args);
7516 /* backend for newSVpvf() and newSVpvf_nocontext() */
7519 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7524 PERL_ARGS_ASSERT_VNEWSVPVF;
7527 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7534 Creates a new SV and copies a floating point value into it.
7535 The reference count for the SV is set to 1.
7541 Perl_newSVnv(pTHX_ const NV n)
7554 Creates a new SV and copies an integer into it. The reference count for the
7561 Perl_newSViv(pTHX_ const IV i)
7574 Creates a new SV and copies an unsigned integer into it.
7575 The reference count for the SV is set to 1.
7581 Perl_newSVuv(pTHX_ const UV u)
7592 =for apidoc newSV_type
7594 Creates a new SV, of the type specified. The reference count for the new SV
7601 Perl_newSV_type(pTHX_ const svtype type)
7606 sv_upgrade(sv, type);
7611 =for apidoc newRV_noinc
7613 Creates an RV wrapper for an SV. The reference count for the original
7614 SV is B<not> incremented.
7620 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7623 register SV *sv = newSV_type(SVt_IV);
7625 PERL_ARGS_ASSERT_NEWRV_NOINC;
7628 SvRV_set(sv, tmpRef);
7633 /* newRV_inc is the official function name to use now.
7634 * newRV_inc is in fact #defined to newRV in sv.h
7638 Perl_newRV(pTHX_ SV *const sv)
7642 PERL_ARGS_ASSERT_NEWRV;
7644 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7650 Creates a new SV which is an exact duplicate of the original SV.
7657 Perl_newSVsv(pTHX_ register SV *const old)
7664 if (SvTYPE(old) == SVTYPEMASK) {
7665 if (ckWARN_d(WARN_INTERNAL))
7666 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7670 /* SV_GMAGIC is the default for sv_setv()
7671 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7672 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7673 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7678 =for apidoc sv_reset
7680 Underlying implementation for the C<reset> Perl function.
7681 Note that the perl-level function is vaguely deprecated.
7687 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7690 char todo[PERL_UCHAR_MAX+1];
7692 PERL_ARGS_ASSERT_SV_RESET;
7697 if (!*s) { /* reset ?? searches */
7698 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7700 const U32 count = mg->mg_len / sizeof(PMOP**);
7701 PMOP **pmp = (PMOP**) mg->mg_ptr;
7702 PMOP *const *const end = pmp + count;
7706 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7708 (*pmp)->op_pmflags &= ~PMf_USED;
7716 /* reset variables */
7718 if (!HvARRAY(stash))
7721 Zero(todo, 256, char);
7724 I32 i = (unsigned char)*s;
7728 max = (unsigned char)*s++;
7729 for ( ; i <= max; i++) {
7732 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7734 for (entry = HvARRAY(stash)[i];
7736 entry = HeNEXT(entry))
7741 if (!todo[(U8)*HeKEY(entry)])
7743 gv = (GV*)HeVAL(entry);
7746 if (SvTHINKFIRST(sv)) {
7747 if (!SvREADONLY(sv) && SvROK(sv))
7749 /* XXX Is this continue a bug? Why should THINKFIRST
7750 exempt us from resetting arrays and hashes? */
7754 if (SvTYPE(sv) >= SVt_PV) {
7756 if (SvPVX_const(sv) != NULL)
7764 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7766 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7769 # if defined(USE_ENVIRON_ARRAY)
7772 # endif /* USE_ENVIRON_ARRAY */
7783 Using various gambits, try to get an IO from an SV: the IO slot if its a
7784 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7785 named after the PV if we're a string.
7791 Perl_sv_2io(pTHX_ SV *const sv)
7796 PERL_ARGS_ASSERT_SV_2IO;
7798 switch (SvTYPE(sv)) {
7806 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7810 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7812 return sv_2io(SvRV(sv));
7813 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7819 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7828 Using various gambits, try to get a CV from an SV; in addition, try if
7829 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7830 The flags in C<lref> are passed to sv_fetchsv.
7836 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7842 PERL_ARGS_ASSERT_SV_2CV;
7849 switch (SvTYPE(sv)) {
7868 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7869 tryAMAGICunDEREF(to_cv);
7872 if (SvTYPE(sv) == SVt_PVCV) {
7881 Perl_croak(aTHX_ "Not a subroutine reference");
7886 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7892 /* Some flags to gv_fetchsv mean don't really create the GV */
7893 if (SvTYPE(gv) != SVt_PVGV) {
7899 if (lref && !GvCVu(gv)) {
7903 gv_efullname3(tmpsv, gv, NULL);
7904 /* XXX this is probably not what they think they're getting.
7905 * It has the same effect as "sub name;", i.e. just a forward
7907 newSUB(start_subparse(FALSE, 0),
7908 newSVOP(OP_CONST, 0, tmpsv),
7912 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7913 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7922 Returns true if the SV has a true value by Perl's rules.
7923 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7924 instead use an in-line version.
7930 Perl_sv_true(pTHX_ register SV *const sv)
7935 register const XPV* const tXpv = (XPV*)SvANY(sv);
7937 (tXpv->xpv_cur > 1 ||
7938 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7945 return SvIVX(sv) != 0;
7948 return SvNVX(sv) != 0.0;
7950 return sv_2bool(sv);
7956 =for apidoc sv_pvn_force
7958 Get a sensible string out of the SV somehow.
7959 A private implementation of the C<SvPV_force> macro for compilers which
7960 can't cope with complex macro expressions. Always use the macro instead.
7962 =for apidoc sv_pvn_force_flags
7964 Get a sensible string out of the SV somehow.
7965 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7966 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7967 implemented in terms of this function.
7968 You normally want to use the various wrapper macros instead: see
7969 C<SvPV_force> and C<SvPV_force_nomg>
7975 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
7979 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7981 if (SvTHINKFIRST(sv) && !SvROK(sv))
7982 sv_force_normal_flags(sv, 0);
7992 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7993 const char * const ref = sv_reftype(sv,0);
7995 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7996 ref, OP_NAME(PL_op));
7998 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8000 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8001 || isGV_with_GP(sv))
8002 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8004 s = sv_2pv_flags(sv, &len, flags);
8008 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8011 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8012 SvGROW(sv, len + 1);
8013 Move(s,SvPVX(sv),len,char);
8015 SvPVX(sv)[len] = '\0';
8018 SvPOK_on(sv); /* validate pointer */
8020 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8021 PTR2UV(sv),SvPVX_const(sv)));
8024 return SvPVX_mutable(sv);
8028 =for apidoc sv_pvbyten_force
8030 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8036 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8038 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8040 sv_pvn_force(sv,lp);
8041 sv_utf8_downgrade(sv,0);
8047 =for apidoc sv_pvutf8n_force
8049 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8055 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8057 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8059 sv_pvn_force(sv,lp);
8060 sv_utf8_upgrade(sv);
8066 =for apidoc sv_reftype
8068 Returns a string describing what the SV is a reference to.
8074 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8076 PERL_ARGS_ASSERT_SV_REFTYPE;
8078 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8079 inside return suggests a const propagation bug in g++. */
8080 if (ob && SvOBJECT(sv)) {
8081 char * const name = HvNAME_get(SvSTASH(sv));
8082 return name ? name : (char *) "__ANON__";
8085 switch (SvTYPE(sv)) {
8100 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8101 /* tied lvalues should appear to be
8102 * scalars for backwards compatitbility */
8103 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8104 ? "SCALAR" : "LVALUE");
8105 case SVt_PVAV: return "ARRAY";
8106 case SVt_PVHV: return "HASH";
8107 case SVt_PVCV: return "CODE";
8108 case SVt_PVGV: return "GLOB";
8109 case SVt_PVFM: return "FORMAT";
8110 case SVt_PVIO: return "IO";
8111 case SVt_BIND: return "BIND";
8112 case SVt_REGEXP: return "REGEXP";
8113 default: return "UNKNOWN";
8119 =for apidoc sv_isobject
8121 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8122 object. If the SV is not an RV, or if the object is not blessed, then this
8129 Perl_sv_isobject(pTHX_ SV *sv)
8145 Returns a boolean indicating whether the SV is blessed into the specified
8146 class. This does not check for subtypes; use C<sv_derived_from> to verify
8147 an inheritance relationship.
8153 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8157 PERL_ARGS_ASSERT_SV_ISA;
8167 hvname = HvNAME_get(SvSTASH(sv));
8171 return strEQ(hvname, name);
8177 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8178 it will be upgraded to one. If C<classname> is non-null then the new SV will
8179 be blessed in the specified package. The new SV is returned and its
8180 reference count is 1.
8186 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8191 PERL_ARGS_ASSERT_NEWSVRV;
8195 SV_CHECK_THINKFIRST_COW_DROP(rv);
8196 (void)SvAMAGIC_off(rv);
8198 if (SvTYPE(rv) >= SVt_PVMG) {
8199 const U32 refcnt = SvREFCNT(rv);
8203 SvREFCNT(rv) = refcnt;
8205 sv_upgrade(rv, SVt_IV);
8206 } else if (SvROK(rv)) {
8207 SvREFCNT_dec(SvRV(rv));
8209 prepare_SV_for_RV(rv);
8217 HV* const stash = gv_stashpv(classname, GV_ADD);
8218 (void)sv_bless(rv, stash);
8224 =for apidoc sv_setref_pv
8226 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8227 argument will be upgraded to an RV. That RV will be modified to point to
8228 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8229 into the SV. The C<classname> argument indicates the package for the
8230 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8231 will have a reference count of 1, and the RV will be returned.
8233 Do not use with other Perl types such as HV, AV, SV, CV, because those
8234 objects will become corrupted by the pointer copy process.
8236 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8242 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8246 PERL_ARGS_ASSERT_SV_SETREF_PV;
8249 sv_setsv(rv, &PL_sv_undef);
8253 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8258 =for apidoc sv_setref_iv
8260 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8261 argument will be upgraded to an RV. That RV will be modified to point to
8262 the new SV. The C<classname> argument indicates the package for the
8263 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8264 will have a reference count of 1, and the RV will be returned.
8270 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8272 PERL_ARGS_ASSERT_SV_SETREF_IV;
8274 sv_setiv(newSVrv(rv,classname), iv);
8279 =for apidoc sv_setref_uv
8281 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8282 argument will be upgraded to an RV. That RV will be modified to point to
8283 the new SV. The C<classname> argument indicates the package for the
8284 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8285 will have a reference count of 1, and the RV will be returned.
8291 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8293 PERL_ARGS_ASSERT_SV_SETREF_UV;
8295 sv_setuv(newSVrv(rv,classname), uv);
8300 =for apidoc sv_setref_nv
8302 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8303 argument will be upgraded to an RV. That RV will be modified to point to
8304 the new SV. The C<classname> argument indicates the package for the
8305 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8306 will have a reference count of 1, and the RV will be returned.
8312 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8314 PERL_ARGS_ASSERT_SV_SETREF_NV;
8316 sv_setnv(newSVrv(rv,classname), nv);
8321 =for apidoc sv_setref_pvn
8323 Copies a string into a new SV, optionally blessing the SV. The length of the
8324 string must be specified with C<n>. The C<rv> argument will be upgraded to
8325 an RV. That RV will be modified to point to the new SV. The C<classname>
8326 argument indicates the package for the blessing. Set C<classname> to
8327 C<NULL> to avoid the blessing. The new SV will have a reference count
8328 of 1, and the RV will be returned.
8330 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8336 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8337 const char *const pv, const STRLEN n)
8339 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8341 sv_setpvn(newSVrv(rv,classname), pv, n);
8346 =for apidoc sv_bless
8348 Blesses an SV into a specified package. The SV must be an RV. The package
8349 must be designated by its stash (see C<gv_stashpv()>). The reference count
8350 of the SV is unaffected.
8356 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8361 PERL_ARGS_ASSERT_SV_BLESS;
8364 Perl_croak(aTHX_ "Can't bless non-reference value");
8366 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8367 if (SvIsCOW(tmpRef))
8368 sv_force_normal_flags(tmpRef, 0);
8369 if (SvREADONLY(tmpRef))
8370 Perl_croak(aTHX_ PL_no_modify);
8371 if (SvOBJECT(tmpRef)) {
8372 if (SvTYPE(tmpRef) != SVt_PVIO)
8374 SvREFCNT_dec(SvSTASH(tmpRef));
8377 SvOBJECT_on(tmpRef);
8378 if (SvTYPE(tmpRef) != SVt_PVIO)
8380 SvUPGRADE(tmpRef, SVt_PVMG);
8381 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8386 (void)SvAMAGIC_off(sv);
8388 if(SvSMAGICAL(tmpRef))
8389 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8397 /* Downgrades a PVGV to a PVMG.
8401 S_sv_unglob(pTHX_ SV *const sv)
8406 SV * const temp = sv_newmortal();
8408 PERL_ARGS_ASSERT_SV_UNGLOB;
8410 assert(SvTYPE(sv) == SVt_PVGV);
8412 gv_efullname3(temp, (GV *) sv, "*");
8415 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8416 mro_method_changed_in(stash);
8420 sv_del_backref((SV*)GvSTASH(sv), sv);
8424 if (GvNAME_HEK(sv)) {
8425 unshare_hek(GvNAME_HEK(sv));
8427 isGV_with_GP_off(sv);
8429 /* need to keep SvANY(sv) in the right arena */
8430 xpvmg = new_XPVMG();
8431 StructCopy(SvANY(sv), xpvmg, XPVMG);
8432 del_XPVGV(SvANY(sv));
8435 SvFLAGS(sv) &= ~SVTYPEMASK;
8436 SvFLAGS(sv) |= SVt_PVMG;
8438 /* Intentionally not calling any local SET magic, as this isn't so much a
8439 set operation as merely an internal storage change. */
8440 sv_setsv_flags(sv, temp, 0);
8444 =for apidoc sv_unref_flags
8446 Unsets the RV status of the SV, and decrements the reference count of
8447 whatever was being referenced by the RV. This can almost be thought of
8448 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8449 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8450 (otherwise the decrementing is conditional on the reference count being
8451 different from one or the reference being a readonly SV).
8458 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8460 SV* const target = SvRV(ref);
8462 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8464 if (SvWEAKREF(ref)) {
8465 sv_del_backref(target, ref);
8467 SvRV_set(ref, NULL);
8470 SvRV_set(ref, NULL);
8472 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8473 assigned to as BEGIN {$a = \"Foo"} will fail. */
8474 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8475 SvREFCNT_dec(target);
8476 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8477 sv_2mortal(target); /* Schedule for freeing later */
8481 =for apidoc sv_untaint
8483 Untaint an SV. Use C<SvTAINTED_off> instead.
8488 Perl_sv_untaint(pTHX_ SV *const sv)
8490 PERL_ARGS_ASSERT_SV_UNTAINT;
8492 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8493 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8500 =for apidoc sv_tainted
8502 Test an SV for taintedness. Use C<SvTAINTED> instead.
8507 Perl_sv_tainted(pTHX_ SV *const sv)
8509 PERL_ARGS_ASSERT_SV_TAINTED;
8511 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8512 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8513 if (mg && (mg->mg_len & 1) )
8520 =for apidoc sv_setpviv
8522 Copies an integer into the given SV, also updating its string value.
8523 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8529 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8531 char buf[TYPE_CHARS(UV)];
8533 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8535 PERL_ARGS_ASSERT_SV_SETPVIV;
8537 sv_setpvn(sv, ptr, ebuf - ptr);
8541 =for apidoc sv_setpviv_mg
8543 Like C<sv_setpviv>, but also handles 'set' magic.
8549 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8551 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8557 #if defined(PERL_IMPLICIT_CONTEXT)
8559 /* pTHX_ magic can't cope with varargs, so this is a no-context
8560 * version of the main function, (which may itself be aliased to us).
8561 * Don't access this version directly.
8565 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8570 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8572 va_start(args, pat);
8573 sv_vsetpvf(sv, pat, &args);
8577 /* pTHX_ magic can't cope with varargs, so this is a no-context
8578 * version of the main function, (which may itself be aliased to us).
8579 * Don't access this version directly.
8583 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8588 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8590 va_start(args, pat);
8591 sv_vsetpvf_mg(sv, pat, &args);
8597 =for apidoc sv_setpvf
8599 Works like C<sv_catpvf> but copies the text into the SV instead of
8600 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8606 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8610 PERL_ARGS_ASSERT_SV_SETPVF;
8612 va_start(args, pat);
8613 sv_vsetpvf(sv, pat, &args);
8618 =for apidoc sv_vsetpvf
8620 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8621 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8623 Usually used via its frontend C<sv_setpvf>.
8629 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8631 PERL_ARGS_ASSERT_SV_VSETPVF;
8633 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8637 =for apidoc sv_setpvf_mg
8639 Like C<sv_setpvf>, but also handles 'set' magic.
8645 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8649 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8651 va_start(args, pat);
8652 sv_vsetpvf_mg(sv, pat, &args);
8657 =for apidoc sv_vsetpvf_mg
8659 Like C<sv_vsetpvf>, but also handles 'set' magic.
8661 Usually used via its frontend C<sv_setpvf_mg>.
8667 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8669 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8671 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8675 #if defined(PERL_IMPLICIT_CONTEXT)
8677 /* pTHX_ magic can't cope with varargs, so this is a no-context
8678 * version of the main function, (which may itself be aliased to us).
8679 * Don't access this version directly.
8683 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8688 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8690 va_start(args, pat);
8691 sv_vcatpvf(sv, pat, &args);
8695 /* pTHX_ magic can't cope with varargs, so this is a no-context
8696 * version of the main function, (which may itself be aliased to us).
8697 * Don't access this version directly.
8701 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8706 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8708 va_start(args, pat);
8709 sv_vcatpvf_mg(sv, pat, &args);
8715 =for apidoc sv_catpvf
8717 Processes its arguments like C<sprintf> and appends the formatted
8718 output to an SV. If the appended data contains "wide" characters
8719 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8720 and characters >255 formatted with %c), the original SV might get
8721 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8722 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8723 valid UTF-8; if the original SV was bytes, the pattern should be too.
8728 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8732 PERL_ARGS_ASSERT_SV_CATPVF;
8734 va_start(args, pat);
8735 sv_vcatpvf(sv, pat, &args);
8740 =for apidoc sv_vcatpvf
8742 Processes its arguments like C<vsprintf> and appends the formatted output
8743 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8745 Usually used via its frontend C<sv_catpvf>.
8751 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8753 PERL_ARGS_ASSERT_SV_VCATPVF;
8755 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8759 =for apidoc sv_catpvf_mg
8761 Like C<sv_catpvf>, but also handles 'set' magic.
8767 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8771 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8773 va_start(args, pat);
8774 sv_vcatpvf_mg(sv, pat, &args);
8779 =for apidoc sv_vcatpvf_mg
8781 Like C<sv_vcatpvf>, but also handles 'set' magic.
8783 Usually used via its frontend C<sv_catpvf_mg>.
8789 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8791 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8793 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8798 =for apidoc sv_vsetpvfn
8800 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8803 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8809 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8810 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8812 PERL_ARGS_ASSERT_SV_VSETPVFN;
8814 sv_setpvn(sv, "", 0);
8815 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8819 S_expect_number(pTHX_ char **const pattern)
8824 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8826 switch (**pattern) {
8827 case '1': case '2': case '3':
8828 case '4': case '5': case '6':
8829 case '7': case '8': case '9':
8830 var = *(*pattern)++ - '0';
8831 while (isDIGIT(**pattern)) {
8832 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8834 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8842 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8844 const int neg = nv < 0;
8847 PERL_ARGS_ASSERT_F0CONVERT;
8855 if (uv & 1 && uv == nv)
8856 uv--; /* Round to even */
8858 const unsigned dig = uv % 10;
8871 =for apidoc sv_vcatpvfn
8873 Processes its arguments like C<vsprintf> and appends the formatted output
8874 to an SV. Uses an array of SVs if the C style variable argument list is
8875 missing (NULL). When running with taint checks enabled, indicates via
8876 C<maybe_tainted> if results are untrustworthy (often due to the use of
8879 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8885 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8886 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8887 vec_utf8 = DO_UTF8(vecsv);
8889 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8892 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8893 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8901 static const char nullstr[] = "(null)";
8903 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8904 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8906 /* Times 4: a decimal digit takes more than 3 binary digits.
8907 * NV_DIG: mantissa takes than many decimal digits.
8908 * Plus 32: Playing safe. */
8909 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8910 /* large enough for "%#.#f" --chip */
8911 /* what about long double NVs? --jhi */
8913 PERL_ARGS_ASSERT_SV_VCATPVFN;
8914 PERL_UNUSED_ARG(maybe_tainted);
8916 /* no matter what, this is a string now */
8917 (void)SvPV_force(sv, origlen);
8919 /* special-case "", "%s", and "%-p" (SVf - see below) */
8922 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8924 const char * const s = va_arg(*args, char*);
8925 sv_catpv(sv, s ? s : nullstr);
8927 else if (svix < svmax) {
8928 sv_catsv(sv, *svargs);
8932 if (args && patlen == 3 && pat[0] == '%' &&
8933 pat[1] == '-' && pat[2] == 'p') {
8934 argsv = (SV*)va_arg(*args, void*);
8935 sv_catsv(sv, argsv);
8939 #ifndef USE_LONG_DOUBLE
8940 /* special-case "%.<number>[gf]" */
8941 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8942 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8943 unsigned digits = 0;
8947 while (*pp >= '0' && *pp <= '9')
8948 digits = 10 * digits + (*pp++ - '0');
8949 if (pp - pat == (int)patlen - 1) {
8957 /* Add check for digits != 0 because it seems that some
8958 gconverts are buggy in this case, and we don't yet have
8959 a Configure test for this. */
8960 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8961 /* 0, point, slack */
8962 Gconvert(nv, (int)digits, 0, ebuf);
8964 if (*ebuf) /* May return an empty string for digits==0 */
8967 } else if (!digits) {
8970 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8971 sv_catpvn(sv, p, l);
8977 #endif /* !USE_LONG_DOUBLE */
8979 if (!args && svix < svmax && DO_UTF8(*svargs))
8982 patend = (char*)pat + patlen;
8983 for (p = (char*)pat; p < patend; p = q) {
8986 bool vectorize = FALSE;
8987 bool vectorarg = FALSE;
8988 bool vec_utf8 = FALSE;
8994 bool has_precis = FALSE;
8996 const I32 osvix = svix;
8997 bool is_utf8 = FALSE; /* is this item utf8? */
8998 #ifdef HAS_LDBL_SPRINTF_BUG
8999 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9000 with sfio - Allen <allens@cpan.org> */
9001 bool fix_ldbl_sprintf_bug = FALSE;
9005 U8 utf8buf[UTF8_MAXBYTES+1];
9006 STRLEN esignlen = 0;
9008 const char *eptr = NULL;
9011 const U8 *vecstr = NULL;
9018 /* we need a long double target in case HAS_LONG_DOUBLE but
9021 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9029 const char *dotstr = ".";
9030 STRLEN dotstrlen = 1;
9031 I32 efix = 0; /* explicit format parameter index */
9032 I32 ewix = 0; /* explicit width index */
9033 I32 epix = 0; /* explicit precision index */
9034 I32 evix = 0; /* explicit vector index */
9035 bool asterisk = FALSE;
9037 /* echo everything up to the next format specification */
9038 for (q = p; q < patend && *q != '%'; ++q) ;
9040 if (has_utf8 && !pat_utf8)
9041 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9043 sv_catpvn(sv, p, q - p);
9050 We allow format specification elements in this order:
9051 \d+\$ explicit format parameter index
9053 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9054 0 flag (as above): repeated to allow "v02"
9055 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9056 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9058 [%bcdefginopsuxDFOUX] format (mandatory)
9063 As of perl5.9.3, printf format checking is on by default.
9064 Internally, perl uses %p formats to provide an escape to
9065 some extended formatting. This block deals with those
9066 extensions: if it does not match, (char*)q is reset and
9067 the normal format processing code is used.
9069 Currently defined extensions are:
9070 %p include pointer address (standard)
9071 %-p (SVf) include an SV (previously %_)
9072 %-<num>p include an SV with precision <num>
9073 %<num>p reserved for future extensions
9075 Robin Barker 2005-07-14
9077 %1p (VDf) removed. RMB 2007-10-19
9084 n = expect_number(&q);
9091 argsv = (SV*)va_arg(*args, void*);
9092 eptr = SvPV_const(argsv, elen);
9098 if (ckWARN_d(WARN_INTERNAL))
9099 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9100 "internal %%<num>p might conflict with future printf extensions");
9106 if ( (width = expect_number(&q)) ) {
9121 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9150 if ( (ewix = expect_number(&q)) )
9159 if ((vectorarg = asterisk)) {
9172 width = expect_number(&q);
9178 vecsv = va_arg(*args, SV*);
9180 vecsv = (evix > 0 && evix <= svmax)
9181 ? svargs[evix-1] : &PL_sv_undef;
9183 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9185 dotstr = SvPV_const(vecsv, dotstrlen);
9186 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9187 bad with tied or overloaded values that return UTF8. */
9190 else if (has_utf8) {
9191 vecsv = sv_mortalcopy(vecsv);
9192 sv_utf8_upgrade(vecsv);
9193 dotstr = SvPV_const(vecsv, dotstrlen);
9200 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9201 vecsv = svargs[efix ? efix-1 : svix++];
9202 vecstr = (U8*)SvPV_const(vecsv,veclen);
9203 vec_utf8 = DO_UTF8(vecsv);
9205 /* if this is a version object, we need to convert
9206 * back into v-string notation and then let the
9207 * vectorize happen normally
9209 if (sv_derived_from(vecsv, "version")) {
9210 char *version = savesvpv(vecsv);
9211 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9212 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9213 "vector argument not supported with alpha versions");
9216 vecsv = sv_newmortal();
9217 scan_vstring(version, version + veclen, vecsv);
9218 vecstr = (U8*)SvPV_const(vecsv, veclen);
9219 vec_utf8 = DO_UTF8(vecsv);
9231 i = va_arg(*args, int);
9233 i = (ewix ? ewix <= svmax : svix < svmax) ?
9234 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9236 width = (i < 0) ? -i : i;
9246 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9248 /* XXX: todo, support specified precision parameter */
9252 i = va_arg(*args, int);
9254 i = (ewix ? ewix <= svmax : svix < svmax)
9255 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9257 has_precis = !(i < 0);
9262 precis = precis * 10 + (*q++ - '0');
9271 case 'I': /* Ix, I32x, and I64x */
9273 if (q[1] == '6' && q[2] == '4') {
9279 if (q[1] == '3' && q[2] == '2') {
9289 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9300 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9301 if (*(q + 1) == 'l') { /* lld, llf */
9327 if (!vectorize && !args) {
9329 const I32 i = efix-1;
9330 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9332 argsv = (svix >= 0 && svix < svmax)
9333 ? svargs[svix++] : &PL_sv_undef;
9344 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9346 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9348 eptr = (char*)utf8buf;
9349 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9363 eptr = va_arg(*args, char*);
9365 #ifdef MACOS_TRADITIONAL
9366 /* On MacOS, %#s format is used for Pascal strings */
9371 elen = strlen(eptr);
9373 eptr = (char *)nullstr;
9374 elen = sizeof nullstr - 1;
9378 eptr = SvPV_const(argsv, elen);
9379 if (DO_UTF8(argsv)) {
9380 I32 old_precis = precis;
9381 if (has_precis && precis < elen) {
9383 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9386 if (width) { /* fudge width (can't fudge elen) */
9387 if (has_precis && precis < elen)
9388 width += precis - old_precis;
9390 width += elen - sv_len_utf8(argsv);
9397 if (has_precis && elen > precis)
9404 if (alt || vectorize)
9406 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9427 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9436 esignbuf[esignlen++] = plus;
9440 case 'h': iv = (short)va_arg(*args, int); break;
9441 case 'l': iv = va_arg(*args, long); break;
9442 case 'V': iv = va_arg(*args, IV); break;
9443 default: iv = va_arg(*args, int); break;
9445 case 'q': iv = va_arg(*args, Quad_t); break;
9450 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9452 case 'h': iv = (short)tiv; break;
9453 case 'l': iv = (long)tiv; break;
9455 default: iv = tiv; break;
9457 case 'q': iv = (Quad_t)tiv; break;
9461 if ( !vectorize ) /* we already set uv above */
9466 esignbuf[esignlen++] = plus;
9470 esignbuf[esignlen++] = '-';
9514 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9525 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9526 case 'l': uv = va_arg(*args, unsigned long); break;
9527 case 'V': uv = va_arg(*args, UV); break;
9528 default: uv = va_arg(*args, unsigned); break;
9530 case 'q': uv = va_arg(*args, Uquad_t); break;
9535 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9537 case 'h': uv = (unsigned short)tuv; break;
9538 case 'l': uv = (unsigned long)tuv; break;
9540 default: uv = tuv; break;
9542 case 'q': uv = (Uquad_t)tuv; break;
9549 char *ptr = ebuf + sizeof ebuf;
9550 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9556 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9562 esignbuf[esignlen++] = '0';
9563 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9571 if (alt && *ptr != '0')
9580 esignbuf[esignlen++] = '0';
9581 esignbuf[esignlen++] = c;
9584 default: /* it had better be ten or less */
9588 } while (uv /= base);
9591 elen = (ebuf + sizeof ebuf) - ptr;
9595 zeros = precis - elen;
9596 else if (precis == 0 && elen == 1 && *eptr == '0'
9597 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9600 /* a precision nullifies the 0 flag. */
9607 /* FLOATING POINT */
9610 c = 'f'; /* maybe %F isn't supported here */
9618 /* This is evil, but floating point is even more evil */
9620 /* for SV-style calling, we can only get NV
9621 for C-style calling, we assume %f is double;
9622 for simplicity we allow any of %Lf, %llf, %qf for long double
9626 #if defined(USE_LONG_DOUBLE)
9630 /* [perl #20339] - we should accept and ignore %lf rather than die */
9634 #if defined(USE_LONG_DOUBLE)
9635 intsize = args ? 0 : 'q';
9639 #if defined(HAS_LONG_DOUBLE)
9648 /* now we need (long double) if intsize == 'q', else (double) */
9650 #if LONG_DOUBLESIZE > DOUBLESIZE
9652 va_arg(*args, long double) :
9653 va_arg(*args, double)
9655 va_arg(*args, double)
9660 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9661 else. frexp() has some unspecified behaviour for those three */
9662 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9664 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9665 will cast our (long double) to (double) */
9666 (void)Perl_frexp(nv, &i);
9667 if (i == PERL_INT_MIN)
9668 Perl_die(aTHX_ "panic: frexp");
9670 need = BIT_DIGITS(i);
9672 need += has_precis ? precis : 6; /* known default */
9677 #ifdef HAS_LDBL_SPRINTF_BUG
9678 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9679 with sfio - Allen <allens@cpan.org> */
9682 # define MY_DBL_MAX DBL_MAX
9683 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9684 # if DOUBLESIZE >= 8
9685 # define MY_DBL_MAX 1.7976931348623157E+308L
9687 # define MY_DBL_MAX 3.40282347E+38L
9691 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9692 # define MY_DBL_MAX_BUG 1L
9694 # define MY_DBL_MAX_BUG MY_DBL_MAX
9698 # define MY_DBL_MIN DBL_MIN
9699 # else /* XXX guessing! -Allen */
9700 # if DOUBLESIZE >= 8
9701 # define MY_DBL_MIN 2.2250738585072014E-308L
9703 # define MY_DBL_MIN 1.17549435E-38L
9707 if ((intsize == 'q') && (c == 'f') &&
9708 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9710 /* it's going to be short enough that
9711 * long double precision is not needed */
9713 if ((nv <= 0L) && (nv >= -0L))
9714 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9716 /* would use Perl_fp_class as a double-check but not
9717 * functional on IRIX - see perl.h comments */
9719 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9720 /* It's within the range that a double can represent */
9721 #if defined(DBL_MAX) && !defined(DBL_MIN)
9722 if ((nv >= ((long double)1/DBL_MAX)) ||
9723 (nv <= (-(long double)1/DBL_MAX)))
9725 fix_ldbl_sprintf_bug = TRUE;
9728 if (fix_ldbl_sprintf_bug == TRUE) {
9738 # undef MY_DBL_MAX_BUG
9741 #endif /* HAS_LDBL_SPRINTF_BUG */
9743 need += 20; /* fudge factor */
9744 if (PL_efloatsize < need) {
9745 Safefree(PL_efloatbuf);
9746 PL_efloatsize = need + 20; /* more fudge */
9747 Newx(PL_efloatbuf, PL_efloatsize, char);
9748 PL_efloatbuf[0] = '\0';
9751 if ( !(width || left || plus || alt) && fill != '0'
9752 && has_precis && intsize != 'q' ) { /* Shortcuts */
9753 /* See earlier comment about buggy Gconvert when digits,
9755 if ( c == 'g' && precis) {
9756 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9757 /* May return an empty string for digits==0 */
9758 if (*PL_efloatbuf) {
9759 elen = strlen(PL_efloatbuf);
9760 goto float_converted;
9762 } else if ( c == 'f' && !precis) {
9763 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9768 char *ptr = ebuf + sizeof ebuf;
9771 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9772 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9773 if (intsize == 'q') {
9774 /* Copy the one or more characters in a long double
9775 * format before the 'base' ([efgEFG]) character to
9776 * the format string. */
9777 static char const prifldbl[] = PERL_PRIfldbl;
9778 char const *p = prifldbl + sizeof(prifldbl) - 3;
9779 while (p >= prifldbl) { *--ptr = *p--; }
9784 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9789 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9801 /* No taint. Otherwise we are in the strange situation
9802 * where printf() taints but print($float) doesn't.
9804 #if defined(HAS_LONG_DOUBLE)
9805 elen = ((intsize == 'q')
9806 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9807 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9809 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9813 eptr = PL_efloatbuf;
9821 i = SvCUR(sv) - origlen;
9824 case 'h': *(va_arg(*args, short*)) = i; break;
9825 default: *(va_arg(*args, int*)) = i; break;
9826 case 'l': *(va_arg(*args, long*)) = i; break;
9827 case 'V': *(va_arg(*args, IV*)) = i; break;
9829 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9834 sv_setuv_mg(argsv, (UV)i);
9835 continue; /* not "break" */
9842 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9843 && ckWARN(WARN_PRINTF))
9845 SV * const msg = sv_newmortal();
9846 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9847 (PL_op->op_type == OP_PRTF) ? "" : "s");
9850 Perl_sv_catpvf(aTHX_ msg,
9851 "\"%%%c\"", c & 0xFF);
9853 Perl_sv_catpvf(aTHX_ msg,
9854 "\"%%\\%03"UVof"\"",
9857 sv_catpvs(msg, "end of string");
9858 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9861 /* output mangled stuff ... */
9867 /* ... right here, because formatting flags should not apply */
9868 SvGROW(sv, SvCUR(sv) + elen + 1);
9870 Copy(eptr, p, elen, char);
9873 SvCUR_set(sv, p - SvPVX_const(sv));
9875 continue; /* not "break" */
9878 if (is_utf8 != has_utf8) {
9881 sv_utf8_upgrade(sv);
9884 const STRLEN old_elen = elen;
9885 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9886 sv_utf8_upgrade(nsv);
9887 eptr = SvPVX_const(nsv);
9890 if (width) { /* fudge width (can't fudge elen) */
9891 width += elen - old_elen;
9897 have = esignlen + zeros + elen;
9899 Perl_croak_nocontext(PL_memory_wrap);
9901 need = (have > width ? have : width);
9904 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9905 Perl_croak_nocontext(PL_memory_wrap);
9906 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9908 if (esignlen && fill == '0') {
9910 for (i = 0; i < (int)esignlen; i++)
9914 memset(p, fill, gap);
9917 if (esignlen && fill != '0') {
9919 for (i = 0; i < (int)esignlen; i++)
9924 for (i = zeros; i; i--)
9928 Copy(eptr, p, elen, char);
9932 memset(p, ' ', gap);
9937 Copy(dotstr, p, dotstrlen, char);
9941 vectorize = FALSE; /* done iterating over vecstr */
9948 SvCUR_set(sv, p - SvPVX_const(sv));
9956 /* =========================================================================
9958 =head1 Cloning an interpreter
9960 All the macros and functions in this section are for the private use of
9961 the main function, perl_clone().
9963 The foo_dup() functions make an exact copy of an existing foo thingy.
9964 During the course of a cloning, a hash table is used to map old addresses
9965 to new addresses. The table is created and manipulated with the
9966 ptr_table_* functions.
9970 ============================================================================*/
9973 #if defined(USE_ITHREADS)
9975 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9976 #ifndef GpREFCNT_inc
9977 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9981 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9982 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9983 If this changes, please unmerge ss_dup. */
9984 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9985 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9986 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9987 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9988 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9989 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9990 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9991 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9992 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9993 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9994 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9995 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9996 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9997 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9999 /* clone a parser */
10002 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10006 PERL_ARGS_ASSERT_PARSER_DUP;
10011 /* look for it in the table first */
10012 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10016 /* create anew and remember what it is */
10017 Newxz(parser, 1, yy_parser);
10018 ptr_table_store(PL_ptr_table, proto, parser);
10020 parser->yyerrstatus = 0;
10021 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10023 /* XXX these not yet duped */
10024 parser->old_parser = NULL;
10025 parser->stack = NULL;
10027 parser->stack_size = 0;
10028 /* XXX parser->stack->state = 0; */
10030 /* XXX eventually, just Copy() most of the parser struct ? */
10032 parser->lex_brackets = proto->lex_brackets;
10033 parser->lex_casemods = proto->lex_casemods;
10034 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10035 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10036 parser->lex_casestack = savepvn(proto->lex_casestack,
10037 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10038 parser->lex_defer = proto->lex_defer;
10039 parser->lex_dojoin = proto->lex_dojoin;
10040 parser->lex_expect = proto->lex_expect;
10041 parser->lex_formbrack = proto->lex_formbrack;
10042 parser->lex_inpat = proto->lex_inpat;
10043 parser->lex_inwhat = proto->lex_inwhat;
10044 parser->lex_op = proto->lex_op;
10045 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10046 parser->lex_starts = proto->lex_starts;
10047 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10048 parser->multi_close = proto->multi_close;
10049 parser->multi_open = proto->multi_open;
10050 parser->multi_start = proto->multi_start;
10051 parser->multi_end = proto->multi_end;
10052 parser->pending_ident = proto->pending_ident;
10053 parser->preambled = proto->preambled;
10054 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10055 parser->linestr = sv_dup_inc(proto->linestr, param);
10056 parser->expect = proto->expect;
10057 parser->copline = proto->copline;
10058 parser->last_lop_op = proto->last_lop_op;
10059 parser->lex_state = proto->lex_state;
10060 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10061 /* rsfp_filters entries have fake IoDIRP() */
10062 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10063 parser->in_my = proto->in_my;
10064 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10065 parser->error_count = proto->error_count;
10068 parser->linestr = sv_dup_inc(proto->linestr, param);
10071 char * const ols = SvPVX(proto->linestr);
10072 char * const ls = SvPVX(parser->linestr);
10074 parser->bufptr = ls + (proto->bufptr >= ols ?
10075 proto->bufptr - ols : 0);
10076 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10077 proto->oldbufptr - ols : 0);
10078 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10079 proto->oldoldbufptr - ols : 0);
10080 parser->linestart = ls + (proto->linestart >= ols ?
10081 proto->linestart - ols : 0);
10082 parser->last_uni = ls + (proto->last_uni >= ols ?
10083 proto->last_uni - ols : 0);
10084 parser->last_lop = ls + (proto->last_lop >= ols ?
10085 proto->last_lop - ols : 0);
10087 parser->bufend = ls + SvCUR(parser->linestr);
10090 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10094 parser->endwhite = proto->endwhite;
10095 parser->faketokens = proto->faketokens;
10096 parser->lasttoke = proto->lasttoke;
10097 parser->nextwhite = proto->nextwhite;
10098 parser->realtokenstart = proto->realtokenstart;
10099 parser->skipwhite = proto->skipwhite;
10100 parser->thisclose = proto->thisclose;
10101 parser->thismad = proto->thismad;
10102 parser->thisopen = proto->thisopen;
10103 parser->thisstuff = proto->thisstuff;
10104 parser->thistoken = proto->thistoken;
10105 parser->thiswhite = proto->thiswhite;
10107 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10108 parser->curforce = proto->curforce;
10110 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10111 Copy(proto->nexttype, parser->nexttype, 5, I32);
10112 parser->nexttoke = proto->nexttoke;
10118 /* duplicate a file handle */
10121 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10125 PERL_ARGS_ASSERT_FP_DUP;
10126 PERL_UNUSED_ARG(type);
10129 return (PerlIO*)NULL;
10131 /* look for it in the table first */
10132 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10136 /* create anew and remember what it is */
10137 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10138 ptr_table_store(PL_ptr_table, fp, ret);
10142 /* duplicate a directory handle */
10145 Perl_dirp_dup(pTHX_ DIR *const dp)
10147 PERL_UNUSED_CONTEXT;
10154 /* duplicate a typeglob */
10157 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10161 PERL_ARGS_ASSERT_GP_DUP;
10165 /* look for it in the table first */
10166 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10170 /* create anew and remember what it is */
10172 ptr_table_store(PL_ptr_table, gp, ret);
10175 ret->gp_refcnt = 0; /* must be before any other dups! */
10176 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10177 ret->gp_io = io_dup_inc(gp->gp_io, param);
10178 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10179 ret->gp_av = av_dup_inc(gp->gp_av, param);
10180 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10181 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10182 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10183 ret->gp_cvgen = gp->gp_cvgen;
10184 ret->gp_line = gp->gp_line;
10185 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10189 /* duplicate a chain of magic */
10192 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10194 MAGIC *mgprev = (MAGIC*)NULL;
10197 PERL_ARGS_ASSERT_MG_DUP;
10200 return (MAGIC*)NULL;
10201 /* look for it in the table first */
10202 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10206 for (; mg; mg = mg->mg_moremagic) {
10208 Newxz(nmg, 1, MAGIC);
10210 mgprev->mg_moremagic = nmg;
10213 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10214 nmg->mg_private = mg->mg_private;
10215 nmg->mg_type = mg->mg_type;
10216 nmg->mg_flags = mg->mg_flags;
10217 /* FIXME for plugins
10218 if (mg->mg_type == PERL_MAGIC_qr) {
10219 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10223 if(mg->mg_type == PERL_MAGIC_backref) {
10224 /* The backref AV has its reference count deliberately bumped by
10226 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10229 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10230 ? sv_dup_inc(mg->mg_obj, param)
10231 : sv_dup(mg->mg_obj, param);
10233 nmg->mg_len = mg->mg_len;
10234 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10235 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10236 if (mg->mg_len > 0) {
10237 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10238 if (mg->mg_type == PERL_MAGIC_overload_table &&
10239 AMT_AMAGIC((AMT*)mg->mg_ptr))
10241 const AMT * const amtp = (AMT*)mg->mg_ptr;
10242 AMT * const namtp = (AMT*)nmg->mg_ptr;
10244 for (i = 1; i < NofAMmeth; i++) {
10245 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10249 else if (mg->mg_len == HEf_SVKEY)
10250 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10252 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10253 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10260 #endif /* USE_ITHREADS */
10262 /* create a new pointer-mapping table */
10265 Perl_ptr_table_new(pTHX)
10268 PERL_UNUSED_CONTEXT;
10270 Newxz(tbl, 1, PTR_TBL_t);
10271 tbl->tbl_max = 511;
10272 tbl->tbl_items = 0;
10273 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10277 #define PTR_TABLE_HASH(ptr) \
10278 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10281 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10282 following define) and at call to new_body_inline made below in
10283 Perl_ptr_table_store()
10286 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10288 /* map an existing pointer using a table */
10290 STATIC PTR_TBL_ENT_t *
10291 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv)
10293 PTR_TBL_ENT_t *tblent;
10294 const UV hash = PTR_TABLE_HASH(sv);
10296 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10298 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10299 for (; tblent; tblent = tblent->next) {
10300 if (tblent->oldval == sv)
10307 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10309 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10311 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10312 PERL_UNUSED_CONTEXT;
10314 return tblent ? tblent->newval : NULL;
10317 /* add a new entry to a pointer-mapping table */
10320 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10322 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10324 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10325 PERL_UNUSED_CONTEXT;
10328 tblent->newval = newsv;
10330 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10332 new_body_inline(tblent, PTE_SVSLOT);
10334 tblent->oldval = oldsv;
10335 tblent->newval = newsv;
10336 tblent->next = tbl->tbl_ary[entry];
10337 tbl->tbl_ary[entry] = tblent;
10339 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10340 ptr_table_split(tbl);
10344 /* double the hash bucket size of an existing ptr table */
10347 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10349 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10350 const UV oldsize = tbl->tbl_max + 1;
10351 UV newsize = oldsize * 2;
10354 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10355 PERL_UNUSED_CONTEXT;
10357 Renew(ary, newsize, PTR_TBL_ENT_t*);
10358 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10359 tbl->tbl_max = --newsize;
10360 tbl->tbl_ary = ary;
10361 for (i=0; i < oldsize; i++, ary++) {
10362 PTR_TBL_ENT_t **curentp, **entp, *ent;
10365 curentp = ary + oldsize;
10366 for (entp = ary, ent = *ary; ent; ent = *entp) {
10367 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10369 ent->next = *curentp;
10379 /* remove all the entries from a ptr table */
10382 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10384 if (tbl && tbl->tbl_items) {
10385 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10386 UV riter = tbl->tbl_max;
10389 PTR_TBL_ENT_t *entry = array[riter];
10392 PTR_TBL_ENT_t * const oentry = entry;
10393 entry = entry->next;
10398 tbl->tbl_items = 0;
10402 /* clear and free a ptr table */
10405 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10410 ptr_table_clear(tbl);
10411 Safefree(tbl->tbl_ary);
10415 #if defined(USE_ITHREADS)
10418 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10420 PERL_ARGS_ASSERT_RVPV_DUP;
10423 SvRV_set(dstr, SvWEAKREF(sstr)
10424 ? sv_dup(SvRV(sstr), param)
10425 : sv_dup_inc(SvRV(sstr), param));
10428 else if (SvPVX_const(sstr)) {
10429 /* Has something there */
10431 /* Normal PV - clone whole allocated space */
10432 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10433 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10434 /* Not that normal - actually sstr is copy on write.
10435 But we are a true, independant SV, so: */
10436 SvREADONLY_off(dstr);
10441 /* Special case - not normally malloced for some reason */
10442 if (isGV_with_GP(sstr)) {
10443 /* Don't need to do anything here. */
10445 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10446 /* A "shared" PV - clone it as "shared" PV */
10448 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10452 /* Some other special case - random pointer */
10453 SvPV_set(dstr, SvPVX(sstr));
10458 /* Copy the NULL */
10459 SvPV_set(dstr, NULL);
10463 /* duplicate an SV of any type (including AV, HV etc) */
10466 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10471 PERL_ARGS_ASSERT_SV_DUP;
10475 if (SvTYPE(sstr) == SVTYPEMASK) {
10476 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10481 /* look for it in the table first */
10482 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10486 if(param->flags & CLONEf_JOIN_IN) {
10487 /** We are joining here so we don't want do clone
10488 something that is bad **/
10489 if (SvTYPE(sstr) == SVt_PVHV) {
10490 const HEK * const hvname = HvNAME_HEK(sstr);
10492 /** don't clone stashes if they already exist **/
10493 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10497 /* create anew and remember what it is */
10500 #ifdef DEBUG_LEAKING_SCALARS
10501 dstr->sv_debug_optype = sstr->sv_debug_optype;
10502 dstr->sv_debug_line = sstr->sv_debug_line;
10503 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10504 dstr->sv_debug_cloned = 1;
10505 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10508 ptr_table_store(PL_ptr_table, sstr, dstr);
10511 SvFLAGS(dstr) = SvFLAGS(sstr);
10512 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10513 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10516 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10517 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10518 (void*)PL_watch_pvx, SvPVX_const(sstr));
10521 /* don't clone objects whose class has asked us not to */
10522 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10527 switch (SvTYPE(sstr)) {
10529 SvANY(dstr) = NULL;
10532 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10534 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10536 SvIV_set(dstr, SvIVX(sstr));
10540 SvANY(dstr) = new_XNV();
10541 SvNV_set(dstr, SvNVX(sstr));
10543 /* case SVt_BIND: */
10546 /* These are all the types that need complex bodies allocating. */
10548 const svtype sv_type = SvTYPE(sstr);
10549 const struct body_details *const sv_type_details
10550 = bodies_by_type + sv_type;
10554 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10558 if (GvUNIQUE((GV*)sstr)) {
10559 NOOP; /* Do sharing here, and fall through */
10572 assert(sv_type_details->body_size);
10573 if (sv_type_details->arena) {
10574 new_body_inline(new_body, sv_type);
10576 = (void*)((char*)new_body - sv_type_details->offset);
10578 new_body = new_NOARENA(sv_type_details);
10582 SvANY(dstr) = new_body;
10585 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10586 ((char*)SvANY(dstr)) + sv_type_details->offset,
10587 sv_type_details->copy, char);
10589 Copy(((char*)SvANY(sstr)),
10590 ((char*)SvANY(dstr)),
10591 sv_type_details->body_size + sv_type_details->offset, char);
10594 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10595 && !isGV_with_GP(dstr))
10596 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10598 /* The Copy above means that all the source (unduplicated) pointers
10599 are now in the destination. We can check the flags and the
10600 pointers in either, but it's possible that there's less cache
10601 missing by always going for the destination.
10602 FIXME - instrument and check that assumption */
10603 if (sv_type >= SVt_PVMG) {
10604 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10605 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10606 } else if (SvMAGIC(dstr))
10607 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10609 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10612 /* The cast silences a GCC warning about unhandled types. */
10613 switch ((int)sv_type) {
10623 /* FIXME for plugins */
10624 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10627 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10628 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10629 LvTARG(dstr) = dstr;
10630 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10631 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10633 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10635 if(isGV_with_GP(sstr)) {
10636 if (GvNAME_HEK(dstr))
10637 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10638 /* Don't call sv_add_backref here as it's going to be
10639 created as part of the magic cloning of the symbol
10641 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10642 at the point of this comment. */
10643 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10644 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10645 (void)GpREFCNT_inc(GvGP(dstr));
10647 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10650 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10651 if (IoOFP(dstr) == IoIFP(sstr))
10652 IoOFP(dstr) = IoIFP(dstr);
10654 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10655 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10656 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10657 /* I have no idea why fake dirp (rsfps)
10658 should be treated differently but otherwise
10659 we end up with leaks -- sky*/
10660 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10661 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10662 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10664 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10665 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10666 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10667 if (IoDIRP(dstr)) {
10668 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10671 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10674 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10675 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10676 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10679 if (AvARRAY((AV*)sstr)) {
10680 SV **dst_ary, **src_ary;
10681 SSize_t items = AvFILLp((AV*)sstr) + 1;
10683 src_ary = AvARRAY((AV*)sstr);
10684 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10685 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10686 AvARRAY((AV*)dstr) = dst_ary;
10687 AvALLOC((AV*)dstr) = dst_ary;
10688 if (AvREAL((AV*)sstr)) {
10689 while (items-- > 0)
10690 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10693 while (items-- > 0)
10694 *dst_ary++ = sv_dup(*src_ary++, param);
10696 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10697 while (items-- > 0) {
10698 *dst_ary++ = &PL_sv_undef;
10702 AvARRAY((AV*)dstr) = NULL;
10703 AvALLOC((AV*)dstr) = (SV**)NULL;
10707 if (HvARRAY((HV*)sstr)) {
10709 const bool sharekeys = !!HvSHAREKEYS(sstr);
10710 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10711 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10713 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10714 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10716 HvARRAY(dstr) = (HE**)darray;
10717 while (i <= sxhv->xhv_max) {
10718 const HE * const source = HvARRAY(sstr)[i];
10719 HvARRAY(dstr)[i] = source
10720 ? he_dup(source, sharekeys, param) : 0;
10725 const struct xpvhv_aux * const saux = HvAUX(sstr);
10726 struct xpvhv_aux * const daux = HvAUX(dstr);
10727 /* This flag isn't copied. */
10728 /* SvOOK_on(hv) attacks the IV flags. */
10729 SvFLAGS(dstr) |= SVf_OOK;
10731 hvname = saux->xhv_name;
10732 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10734 daux->xhv_riter = saux->xhv_riter;
10735 daux->xhv_eiter = saux->xhv_eiter
10736 ? he_dup(saux->xhv_eiter,
10737 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10738 daux->xhv_backreferences =
10739 saux->xhv_backreferences
10740 ? (AV*) SvREFCNT_inc(
10741 sv_dup((SV*)saux->xhv_backreferences, param))
10744 daux->xhv_mro_meta = saux->xhv_mro_meta
10745 ? mro_meta_dup(saux->xhv_mro_meta, param)
10748 /* Record stashes for possible cloning in Perl_clone(). */
10750 av_push(param->stashes, dstr);
10754 HvARRAY((HV*)dstr) = NULL;
10757 if (!(param->flags & CLONEf_COPY_STACKS)) {
10761 /* NOTE: not refcounted */
10762 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10764 if (!CvISXSUB(dstr))
10765 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10767 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10768 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10769 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10770 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10772 /* don't dup if copying back - CvGV isn't refcounted, so the
10773 * duped GV may never be freed. A bit of a hack! DAPM */
10774 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10775 NULL : gv_dup(CvGV(dstr), param) ;
10776 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10778 CvWEAKOUTSIDE(sstr)
10779 ? cv_dup( CvOUTSIDE(dstr), param)
10780 : cv_dup_inc(CvOUTSIDE(dstr), param);
10781 if (!CvISXSUB(dstr))
10782 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10788 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10794 /* duplicate a context */
10797 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10799 PERL_CONTEXT *ncxs;
10801 PERL_ARGS_ASSERT_CX_DUP;
10804 return (PERL_CONTEXT*)NULL;
10806 /* look for it in the table first */
10807 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10811 /* create anew and remember what it is */
10812 Newx(ncxs, max + 1, PERL_CONTEXT);
10813 ptr_table_store(PL_ptr_table, cxs, ncxs);
10814 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10817 PERL_CONTEXT * const ncx = &ncxs[ix];
10818 if (CxTYPE(ncx) == CXt_SUBST) {
10819 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10822 switch (CxTYPE(ncx)) {
10824 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10825 ? cv_dup_inc(ncx->blk_sub.cv, param)
10826 : cv_dup(ncx->blk_sub.cv,param));
10827 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10828 ? av_dup_inc(ncx->blk_sub.argarray,
10831 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10833 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10834 ncx->blk_sub.oldcomppad);
10837 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10839 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10841 case CXt_LOOP_LAZYSV:
10842 ncx->blk_loop.state_u.lazysv.end
10843 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10844 /* We are taking advantage of av_dup_inc and sv_dup_inc
10845 actually being the same function, and order equivalance of
10847 We can assert the later [but only at run time :-(] */
10848 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10849 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10851 ncx->blk_loop.state_u.ary.ary
10852 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10853 case CXt_LOOP_LAZYIV:
10854 case CXt_LOOP_PLAIN:
10855 if (CxPADLOOP(ncx)) {
10856 ncx->blk_loop.oldcomppad
10857 = (PAD*)ptr_table_fetch(PL_ptr_table,
10858 ncx->blk_loop.oldcomppad);
10860 ncx->blk_loop.oldcomppad
10861 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10865 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10866 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10867 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10880 /* duplicate a stack info structure */
10883 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10887 PERL_ARGS_ASSERT_SI_DUP;
10890 return (PERL_SI*)NULL;
10892 /* look for it in the table first */
10893 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10897 /* create anew and remember what it is */
10898 Newxz(nsi, 1, PERL_SI);
10899 ptr_table_store(PL_ptr_table, si, nsi);
10901 nsi->si_stack = av_dup_inc(si->si_stack, param);
10902 nsi->si_cxix = si->si_cxix;
10903 nsi->si_cxmax = si->si_cxmax;
10904 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10905 nsi->si_type = si->si_type;
10906 nsi->si_prev = si_dup(si->si_prev, param);
10907 nsi->si_next = si_dup(si->si_next, param);
10908 nsi->si_markoff = si->si_markoff;
10913 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10914 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10915 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10916 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10917 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10918 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10919 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10920 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10921 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10922 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10923 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10924 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10925 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10926 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10929 #define pv_dup_inc(p) SAVEPV(p)
10930 #define pv_dup(p) SAVEPV(p)
10931 #define svp_dup_inc(p,pp) any_dup(p,pp)
10933 /* map any object to the new equivent - either something in the
10934 * ptr table, or something in the interpreter structure
10938 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10942 PERL_ARGS_ASSERT_ANY_DUP;
10945 return (void*)NULL;
10947 /* look for it in the table first */
10948 ret = ptr_table_fetch(PL_ptr_table, v);
10952 /* see if it is part of the interpreter structure */
10953 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10954 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10962 /* duplicate the save stack */
10965 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10968 ANY * const ss = proto_perl->Isavestack;
10969 const I32 max = proto_perl->Isavestack_max;
10970 I32 ix = proto_perl->Isavestack_ix;
10983 void (*dptr) (void*);
10984 void (*dxptr) (pTHX_ void*);
10986 PERL_ARGS_ASSERT_SS_DUP;
10988 Newxz(nss, max, ANY);
10991 const I32 type = POPINT(ss,ix);
10992 TOPINT(nss,ix) = type;
10994 case SAVEt_HELEM: /* hash element */
10995 sv = (SV*)POPPTR(ss,ix);
10996 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10998 case SAVEt_ITEM: /* normal string */
10999 case SAVEt_SV: /* scalar reference */
11000 sv = (SV*)POPPTR(ss,ix);
11001 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11004 case SAVEt_MORTALIZESV:
11005 sv = (SV*)POPPTR(ss,ix);
11006 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11008 case SAVEt_SHARED_PVREF: /* char* in shared space */
11009 c = (char*)POPPTR(ss,ix);
11010 TOPPTR(nss,ix) = savesharedpv(c);
11011 ptr = POPPTR(ss,ix);
11012 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11014 case SAVEt_GENERIC_SVREF: /* generic sv */
11015 case SAVEt_SVREF: /* scalar reference */
11016 sv = (SV*)POPPTR(ss,ix);
11017 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11018 ptr = POPPTR(ss,ix);
11019 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11021 case SAVEt_HV: /* hash reference */
11022 case SAVEt_AV: /* array reference */
11023 sv = (SV*) POPPTR(ss,ix);
11024 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11026 case SAVEt_COMPPAD:
11028 sv = (SV*) POPPTR(ss,ix);
11029 TOPPTR(nss,ix) = sv_dup(sv, param);
11031 case SAVEt_INT: /* int reference */
11032 ptr = POPPTR(ss,ix);
11033 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11034 intval = (int)POPINT(ss,ix);
11035 TOPINT(nss,ix) = intval;
11037 case SAVEt_LONG: /* long reference */
11038 ptr = POPPTR(ss,ix);
11039 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11041 case SAVEt_CLEARSV:
11042 longval = (long)POPLONG(ss,ix);
11043 TOPLONG(nss,ix) = longval;
11045 case SAVEt_I32: /* I32 reference */
11046 case SAVEt_I16: /* I16 reference */
11047 case SAVEt_I8: /* I8 reference */
11048 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11049 ptr = POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11052 TOPINT(nss,ix) = i;
11054 case SAVEt_IV: /* IV reference */
11055 ptr = POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11058 TOPIV(nss,ix) = iv;
11060 case SAVEt_HPTR: /* HV* reference */
11061 case SAVEt_APTR: /* AV* reference */
11062 case SAVEt_SPTR: /* SV* reference */
11063 ptr = POPPTR(ss,ix);
11064 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11065 sv = (SV*)POPPTR(ss,ix);
11066 TOPPTR(nss,ix) = sv_dup(sv, param);
11068 case SAVEt_VPTR: /* random* reference */
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11071 ptr = POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11074 case SAVEt_GENERIC_PVREF: /* generic char* */
11075 case SAVEt_PPTR: /* char* reference */
11076 ptr = POPPTR(ss,ix);
11077 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11078 c = (char*)POPPTR(ss,ix);
11079 TOPPTR(nss,ix) = pv_dup(c);
11081 case SAVEt_GP: /* scalar reference */
11082 gp = (GP*)POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11084 (void)GpREFCNT_inc(gp);
11085 gv = (GV*)POPPTR(ss,ix);
11086 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11089 ptr = POPPTR(ss,ix);
11090 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11091 /* these are assumed to be refcounted properly */
11093 switch (((OP*)ptr)->op_type) {
11095 case OP_LEAVESUBLV:
11099 case OP_LEAVEWRITE:
11100 TOPPTR(nss,ix) = ptr;
11103 (void) OpREFCNT_inc(o);
11107 TOPPTR(nss,ix) = NULL;
11112 TOPPTR(nss,ix) = NULL;
11115 c = (char*)POPPTR(ss,ix);
11116 TOPPTR(nss,ix) = pv_dup_inc(c);
11119 hv = (HV*)POPPTR(ss,ix);
11120 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11121 c = (char*)POPPTR(ss,ix);
11122 TOPPTR(nss,ix) = pv_dup_inc(c);
11124 case SAVEt_STACK_POS: /* Position on Perl stack */
11126 TOPINT(nss,ix) = i;
11128 case SAVEt_DESTRUCTOR:
11129 ptr = POPPTR(ss,ix);
11130 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11131 dptr = POPDPTR(ss,ix);
11132 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11133 any_dup(FPTR2DPTR(void *, dptr),
11136 case SAVEt_DESTRUCTOR_X:
11137 ptr = POPPTR(ss,ix);
11138 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11139 dxptr = POPDXPTR(ss,ix);
11140 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11141 any_dup(FPTR2DPTR(void *, dxptr),
11144 case SAVEt_REGCONTEXT:
11147 TOPINT(nss,ix) = i;
11150 case SAVEt_AELEM: /* array element */
11151 sv = (SV*)POPPTR(ss,ix);
11152 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11154 TOPINT(nss,ix) = i;
11155 av = (AV*)POPPTR(ss,ix);
11156 TOPPTR(nss,ix) = av_dup_inc(av, param);
11159 ptr = POPPTR(ss,ix);
11160 TOPPTR(nss,ix) = ptr;
11164 TOPINT(nss,ix) = i;
11165 ptr = POPPTR(ss,ix);
11168 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11169 HINTS_REFCNT_UNLOCK;
11171 TOPPTR(nss,ix) = ptr;
11172 if (i & HINT_LOCALIZE_HH) {
11173 hv = (HV*)POPPTR(ss,ix);
11174 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11177 case SAVEt_PADSV_AND_MORTALIZE:
11178 longval = (long)POPLONG(ss,ix);
11179 TOPLONG(nss,ix) = longval;
11180 ptr = POPPTR(ss,ix);
11181 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11182 sv = (SV*)POPPTR(ss,ix);
11183 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11186 ptr = POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11188 longval = (long)POPBOOL(ss,ix);
11189 TOPBOOL(nss,ix) = (bool)longval;
11191 case SAVEt_SET_SVFLAGS:
11193 TOPINT(nss,ix) = i;
11195 TOPINT(nss,ix) = i;
11196 sv = (SV*)POPPTR(ss,ix);
11197 TOPPTR(nss,ix) = sv_dup(sv, param);
11199 case SAVEt_RE_STATE:
11201 const struct re_save_state *const old_state
11202 = (struct re_save_state *)
11203 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11204 struct re_save_state *const new_state
11205 = (struct re_save_state *)
11206 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11208 Copy(old_state, new_state, 1, struct re_save_state);
11209 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11211 new_state->re_state_bostr
11212 = pv_dup(old_state->re_state_bostr);
11213 new_state->re_state_reginput
11214 = pv_dup(old_state->re_state_reginput);
11215 new_state->re_state_regeol
11216 = pv_dup(old_state->re_state_regeol);
11217 new_state->re_state_regoffs
11218 = (regexp_paren_pair*)
11219 any_dup(old_state->re_state_regoffs, proto_perl);
11220 new_state->re_state_reglastparen
11221 = (U32*) any_dup(old_state->re_state_reglastparen,
11223 new_state->re_state_reglastcloseparen
11224 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11226 /* XXX This just has to be broken. The old save_re_context
11227 code did SAVEGENERICPV(PL_reg_start_tmp);
11228 PL_reg_start_tmp is char **.
11229 Look above to what the dup code does for
11230 SAVEt_GENERIC_PVREF
11231 It can never have worked.
11232 So this is merely a faithful copy of the exiting bug: */
11233 new_state->re_state_reg_start_tmp
11234 = (char **) pv_dup((char *)
11235 old_state->re_state_reg_start_tmp);
11236 /* I assume that it only ever "worked" because no-one called
11237 (pseudo)fork while the regexp engine had re-entered itself.
11239 #ifdef PERL_OLD_COPY_ON_WRITE
11240 new_state->re_state_nrs
11241 = sv_dup(old_state->re_state_nrs, param);
11243 new_state->re_state_reg_magic
11244 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11246 new_state->re_state_reg_oldcurpm
11247 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11249 new_state->re_state_reg_curpm
11250 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11252 new_state->re_state_reg_oldsaved
11253 = pv_dup(old_state->re_state_reg_oldsaved);
11254 new_state->re_state_reg_poscache
11255 = pv_dup(old_state->re_state_reg_poscache);
11256 new_state->re_state_reg_starttry
11257 = pv_dup(old_state->re_state_reg_starttry);
11260 case SAVEt_COMPILE_WARNINGS:
11261 ptr = POPPTR(ss,ix);
11262 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11265 ptr = POPPTR(ss,ix);
11266 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11270 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11278 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11279 * flag to the result. This is done for each stash before cloning starts,
11280 * so we know which stashes want their objects cloned */
11283 do_mark_cloneable_stash(pTHX_ SV *const sv)
11285 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11287 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11288 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11289 if (cloner && GvCV(cloner)) {
11296 mXPUSHs(newSVhek(hvname));
11298 call_sv((SV*)GvCV(cloner), G_SCALAR);
11305 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11313 =for apidoc perl_clone
11315 Create and return a new interpreter by cloning the current one.
11317 perl_clone takes these flags as parameters:
11319 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11320 without it we only clone the data and zero the stacks,
11321 with it we copy the stacks and the new perl interpreter is
11322 ready to run at the exact same point as the previous one.
11323 The pseudo-fork code uses COPY_STACKS while the
11324 threads->create doesn't.
11326 CLONEf_KEEP_PTR_TABLE
11327 perl_clone keeps a ptr_table with the pointer of the old
11328 variable as a key and the new variable as a value,
11329 this allows it to check if something has been cloned and not
11330 clone it again but rather just use the value and increase the
11331 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11332 the ptr_table using the function
11333 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11334 reason to keep it around is if you want to dup some of your own
11335 variable who are outside the graph perl scans, example of this
11336 code is in threads.xs create
11339 This is a win32 thing, it is ignored on unix, it tells perls
11340 win32host code (which is c++) to clone itself, this is needed on
11341 win32 if you want to run two threads at the same time,
11342 if you just want to do some stuff in a separate perl interpreter
11343 and then throw it away and return to the original one,
11344 you don't need to do anything.
11349 /* XXX the above needs expanding by someone who actually understands it ! */
11350 EXTERN_C PerlInterpreter *
11351 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11354 perl_clone(PerlInterpreter *proto_perl, UV flags)
11357 #ifdef PERL_IMPLICIT_SYS
11359 PERL_ARGS_ASSERT_PERL_CLONE;
11361 /* perlhost.h so we need to call into it
11362 to clone the host, CPerlHost should have a c interface, sky */
11364 if (flags & CLONEf_CLONE_HOST) {
11365 return perl_clone_host(proto_perl,flags);
11367 return perl_clone_using(proto_perl, flags,
11369 proto_perl->IMemShared,
11370 proto_perl->IMemParse,
11372 proto_perl->IStdIO,
11376 proto_perl->IProc);
11380 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11381 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11382 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11383 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11384 struct IPerlDir* ipD, struct IPerlSock* ipS,
11385 struct IPerlProc* ipP)
11387 /* XXX many of the string copies here can be optimized if they're
11388 * constants; they need to be allocated as common memory and just
11389 * their pointers copied. */
11392 CLONE_PARAMS clone_params;
11393 CLONE_PARAMS* const param = &clone_params;
11395 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11397 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11399 /* for each stash, determine whether its objects should be cloned */
11400 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11401 PERL_SET_THX(my_perl);
11404 PoisonNew(my_perl, 1, PerlInterpreter);
11410 PL_savestack_ix = 0;
11411 PL_savestack_max = -1;
11412 PL_sig_pending = 0;
11414 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11415 # else /* !DEBUGGING */
11416 Zero(my_perl, 1, PerlInterpreter);
11417 # endif /* DEBUGGING */
11419 /* host pointers */
11421 PL_MemShared = ipMS;
11422 PL_MemParse = ipMP;
11429 #else /* !PERL_IMPLICIT_SYS */
11431 CLONE_PARAMS clone_params;
11432 CLONE_PARAMS* param = &clone_params;
11433 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11435 PERL_ARGS_ASSERT_PERL_CLONE;
11437 /* for each stash, determine whether its objects should be cloned */
11438 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11439 PERL_SET_THX(my_perl);
11442 PoisonNew(my_perl, 1, PerlInterpreter);
11448 PL_savestack_ix = 0;
11449 PL_savestack_max = -1;
11450 PL_sig_pending = 0;
11452 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11453 # else /* !DEBUGGING */
11454 Zero(my_perl, 1, PerlInterpreter);
11455 # endif /* DEBUGGING */
11456 #endif /* PERL_IMPLICIT_SYS */
11457 param->flags = flags;
11458 param->proto_perl = proto_perl;
11460 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11462 PL_body_arenas = NULL;
11463 Zero(&PL_body_roots, 1, PL_body_roots);
11465 PL_nice_chunk = NULL;
11466 PL_nice_chunk_size = 0;
11468 PL_sv_objcount = 0;
11470 PL_sv_arenaroot = NULL;
11472 PL_debug = proto_perl->Idebug;
11474 PL_hash_seed = proto_perl->Ihash_seed;
11475 PL_rehash_seed = proto_perl->Irehash_seed;
11477 #ifdef USE_REENTRANT_API
11478 /* XXX: things like -Dm will segfault here in perlio, but doing
11479 * PERL_SET_CONTEXT(proto_perl);
11480 * breaks too many other things
11482 Perl_reentrant_init(aTHX);
11485 /* create SV map for pointer relocation */
11486 PL_ptr_table = ptr_table_new();
11488 /* initialize these special pointers as early as possible */
11489 SvANY(&PL_sv_undef) = NULL;
11490 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11491 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11492 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11494 SvANY(&PL_sv_no) = new_XPVNV();
11495 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11496 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11497 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11498 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11499 SvCUR_set(&PL_sv_no, 0);
11500 SvLEN_set(&PL_sv_no, 1);
11501 SvIV_set(&PL_sv_no, 0);
11502 SvNV_set(&PL_sv_no, 0);
11503 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11505 SvANY(&PL_sv_yes) = new_XPVNV();
11506 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11507 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11508 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11509 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11510 SvCUR_set(&PL_sv_yes, 1);
11511 SvLEN_set(&PL_sv_yes, 2);
11512 SvIV_set(&PL_sv_yes, 1);
11513 SvNV_set(&PL_sv_yes, 1);
11514 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11516 /* create (a non-shared!) shared string table */
11517 PL_strtab = newHV();
11518 HvSHAREKEYS_off(PL_strtab);
11519 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11520 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11522 PL_compiling = proto_perl->Icompiling;
11524 /* These two PVs will be free'd special way so must set them same way op.c does */
11525 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11526 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11528 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11529 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11531 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11532 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11533 if (PL_compiling.cop_hints_hash) {
11535 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11536 HINTS_REFCNT_UNLOCK;
11538 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11539 #ifdef PERL_DEBUG_READONLY_OPS
11544 /* pseudo environmental stuff */
11545 PL_origargc = proto_perl->Iorigargc;
11546 PL_origargv = proto_perl->Iorigargv;
11548 param->stashes = newAV(); /* Setup array of objects to call clone on */
11550 /* Set tainting stuff before PerlIO_debug can possibly get called */
11551 PL_tainting = proto_perl->Itainting;
11552 PL_taint_warn = proto_perl->Itaint_warn;
11554 #ifdef PERLIO_LAYERS
11555 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11556 PerlIO_clone(aTHX_ proto_perl, param);
11559 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11560 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11561 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11562 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11563 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11564 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11567 PL_minus_c = proto_perl->Iminus_c;
11568 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11569 PL_localpatches = proto_perl->Ilocalpatches;
11570 PL_splitstr = proto_perl->Isplitstr;
11571 PL_minus_n = proto_perl->Iminus_n;
11572 PL_minus_p = proto_perl->Iminus_p;
11573 PL_minus_l = proto_perl->Iminus_l;
11574 PL_minus_a = proto_perl->Iminus_a;
11575 PL_minus_E = proto_perl->Iminus_E;
11576 PL_minus_F = proto_perl->Iminus_F;
11577 PL_doswitches = proto_perl->Idoswitches;
11578 PL_dowarn = proto_perl->Idowarn;
11579 PL_doextract = proto_perl->Idoextract;
11580 PL_sawampersand = proto_perl->Isawampersand;
11581 PL_unsafe = proto_perl->Iunsafe;
11582 PL_inplace = SAVEPV(proto_perl->Iinplace);
11583 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11584 PL_perldb = proto_perl->Iperldb;
11585 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11586 PL_exit_flags = proto_perl->Iexit_flags;
11588 /* magical thingies */
11589 /* XXX time(&PL_basetime) when asked for? */
11590 PL_basetime = proto_perl->Ibasetime;
11591 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11593 PL_maxsysfd = proto_perl->Imaxsysfd;
11594 PL_statusvalue = proto_perl->Istatusvalue;
11596 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11598 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11600 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11602 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11603 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11604 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11607 /* RE engine related */
11608 Zero(&PL_reg_state, 1, struct re_save_state);
11609 PL_reginterp_cnt = 0;
11610 PL_regmatch_slab = NULL;
11612 /* Clone the regex array */
11613 /* ORANGE FIXME for plugins, probably in the SV dup code.
11614 newSViv(PTR2IV(CALLREGDUPE(
11615 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11617 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11618 PL_regex_pad = AvARRAY(PL_regex_padav);
11620 /* shortcuts to various I/O objects */
11621 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11622 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11623 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11624 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11625 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11626 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11628 /* shortcuts to regexp stuff */
11629 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11631 /* shortcuts to misc objects */
11632 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11634 /* shortcuts to debugging objects */
11635 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11636 PL_DBline = gv_dup(proto_perl->IDBline, param);
11637 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11638 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11639 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11640 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11641 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11643 /* symbol tables */
11644 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11645 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11646 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11647 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11648 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11650 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11651 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11652 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11653 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11654 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11655 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11656 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11657 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11659 PL_sub_generation = proto_perl->Isub_generation;
11660 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11662 /* funky return mechanisms */
11663 PL_forkprocess = proto_perl->Iforkprocess;
11665 /* subprocess state */
11666 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11668 /* internal state */
11669 PL_maxo = proto_perl->Imaxo;
11670 if (proto_perl->Iop_mask)
11671 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11674 /* PL_asserting = proto_perl->Iasserting; */
11676 /* current interpreter roots */
11677 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11679 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11681 PL_main_start = proto_perl->Imain_start;
11682 PL_eval_root = proto_perl->Ieval_root;
11683 PL_eval_start = proto_perl->Ieval_start;
11685 /* runtime control stuff */
11686 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11688 PL_filemode = proto_perl->Ifilemode;
11689 PL_lastfd = proto_perl->Ilastfd;
11690 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11693 PL_gensym = proto_perl->Igensym;
11694 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11695 PL_laststatval = proto_perl->Ilaststatval;
11696 PL_laststype = proto_perl->Ilaststype;
11699 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11701 /* interpreter atexit processing */
11702 PL_exitlistlen = proto_perl->Iexitlistlen;
11703 if (PL_exitlistlen) {
11704 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11705 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11708 PL_exitlist = (PerlExitListEntry*)NULL;
11710 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11711 if (PL_my_cxt_size) {
11712 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11713 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11714 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11715 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11716 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11720 PL_my_cxt_list = (void**)NULL;
11721 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11722 PL_my_cxt_keys = (const char**)NULL;
11725 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11726 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11727 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11729 PL_profiledata = NULL;
11731 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11733 PAD_CLONE_VARS(proto_perl, param);
11735 #ifdef HAVE_INTERP_INTERN
11736 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11739 /* more statics moved here */
11740 PL_generation = proto_perl->Igeneration;
11741 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11743 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11744 PL_in_clean_all = proto_perl->Iin_clean_all;
11746 PL_uid = proto_perl->Iuid;
11747 PL_euid = proto_perl->Ieuid;
11748 PL_gid = proto_perl->Igid;
11749 PL_egid = proto_perl->Iegid;
11750 PL_nomemok = proto_perl->Inomemok;
11751 PL_an = proto_perl->Ian;
11752 PL_evalseq = proto_perl->Ievalseq;
11753 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11754 PL_origalen = proto_perl->Iorigalen;
11755 #ifdef PERL_USES_PL_PIDSTATUS
11756 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11758 PL_osname = SAVEPV(proto_perl->Iosname);
11759 PL_sighandlerp = proto_perl->Isighandlerp;
11761 PL_runops = proto_perl->Irunops;
11763 PL_parser = parser_dup(proto_perl->Iparser, param);
11765 PL_subline = proto_perl->Isubline;
11766 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11769 PL_cryptseen = proto_perl->Icryptseen;
11772 PL_hints = proto_perl->Ihints;
11774 PL_amagic_generation = proto_perl->Iamagic_generation;
11776 #ifdef USE_LOCALE_COLLATE
11777 PL_collation_ix = proto_perl->Icollation_ix;
11778 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11779 PL_collation_standard = proto_perl->Icollation_standard;
11780 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11781 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11782 #endif /* USE_LOCALE_COLLATE */
11784 #ifdef USE_LOCALE_NUMERIC
11785 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11786 PL_numeric_standard = proto_perl->Inumeric_standard;
11787 PL_numeric_local = proto_perl->Inumeric_local;
11788 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11789 #endif /* !USE_LOCALE_NUMERIC */
11791 /* utf8 character classes */
11792 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11793 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11794 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11795 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11796 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11797 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11798 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11799 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11800 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11801 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11802 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11803 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11804 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11805 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11806 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11807 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11808 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11809 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11810 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11811 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11813 /* Did the locale setup indicate UTF-8? */
11814 PL_utf8locale = proto_perl->Iutf8locale;
11815 /* Unicode features (see perlrun/-C) */
11816 PL_unicode = proto_perl->Iunicode;
11818 /* Pre-5.8 signals control */
11819 PL_signals = proto_perl->Isignals;
11821 /* times() ticks per second */
11822 PL_clocktick = proto_perl->Iclocktick;
11824 /* Recursion stopper for PerlIO_find_layer */
11825 PL_in_load_module = proto_perl->Iin_load_module;
11827 /* sort() routine */
11828 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11830 /* Not really needed/useful since the reenrant_retint is "volatile",
11831 * but do it for consistency's sake. */
11832 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11834 /* Hooks to shared SVs and locks. */
11835 PL_sharehook = proto_perl->Isharehook;
11836 PL_lockhook = proto_perl->Ilockhook;
11837 PL_unlockhook = proto_perl->Iunlockhook;
11838 PL_threadhook = proto_perl->Ithreadhook;
11839 PL_destroyhook = proto_perl->Idestroyhook;
11841 #ifdef THREADS_HAVE_PIDS
11842 PL_ppid = proto_perl->Ippid;
11846 PL_last_swash_hv = NULL; /* reinits on demand */
11847 PL_last_swash_klen = 0;
11848 PL_last_swash_key[0]= '\0';
11849 PL_last_swash_tmps = (U8*)NULL;
11850 PL_last_swash_slen = 0;
11852 PL_glob_index = proto_perl->Iglob_index;
11853 PL_srand_called = proto_perl->Isrand_called;
11854 PL_bitcount = NULL; /* reinits on demand */
11856 if (proto_perl->Ipsig_pend) {
11857 Newxz(PL_psig_pend, SIG_SIZE, int);
11860 PL_psig_pend = (int*)NULL;
11863 if (proto_perl->Ipsig_ptr) {
11864 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11865 Newxz(PL_psig_name, SIG_SIZE, SV*);
11866 for (i = 1; i < SIG_SIZE; i++) {
11867 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11868 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11872 PL_psig_ptr = (SV**)NULL;
11873 PL_psig_name = (SV**)NULL;
11876 /* intrpvar.h stuff */
11878 if (flags & CLONEf_COPY_STACKS) {
11879 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11880 PL_tmps_ix = proto_perl->Itmps_ix;
11881 PL_tmps_max = proto_perl->Itmps_max;
11882 PL_tmps_floor = proto_perl->Itmps_floor;
11883 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11885 while (i <= PL_tmps_ix) {
11886 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11890 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11891 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11892 Newxz(PL_markstack, i, I32);
11893 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11894 - proto_perl->Imarkstack);
11895 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11896 - proto_perl->Imarkstack);
11897 Copy(proto_perl->Imarkstack, PL_markstack,
11898 PL_markstack_ptr - PL_markstack + 1, I32);
11900 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11901 * NOTE: unlike the others! */
11902 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11903 PL_scopestack_max = proto_perl->Iscopestack_max;
11904 Newxz(PL_scopestack, PL_scopestack_max, I32);
11905 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11907 /* NOTE: si_dup() looks at PL_markstack */
11908 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11910 /* PL_curstack = PL_curstackinfo->si_stack; */
11911 PL_curstack = av_dup(proto_perl->Icurstack, param);
11912 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11914 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11915 PL_stack_base = AvARRAY(PL_curstack);
11916 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11917 - proto_perl->Istack_base);
11918 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11920 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11921 * NOTE: unlike the others! */
11922 PL_savestack_ix = proto_perl->Isavestack_ix;
11923 PL_savestack_max = proto_perl->Isavestack_max;
11924 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11925 PL_savestack = ss_dup(proto_perl, param);
11929 ENTER; /* perl_destruct() wants to LEAVE; */
11931 /* although we're not duplicating the tmps stack, we should still
11932 * add entries for any SVs on the tmps stack that got cloned by a
11933 * non-refcount means (eg a temp in @_); otherwise they will be
11936 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11937 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11938 proto_perl->Itmps_stack[i]);
11939 if (nsv && !SvREFCNT(nsv)) {
11941 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11946 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11947 PL_top_env = &PL_start_env;
11949 PL_op = proto_perl->Iop;
11952 PL_Xpv = (XPV*)NULL;
11953 my_perl->Ina = proto_perl->Ina;
11955 PL_statbuf = proto_perl->Istatbuf;
11956 PL_statcache = proto_perl->Istatcache;
11957 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11958 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11960 PL_timesbuf = proto_perl->Itimesbuf;
11963 PL_tainted = proto_perl->Itainted;
11964 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11965 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11966 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11967 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11968 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11969 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11970 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11971 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11972 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11974 PL_restartop = proto_perl->Irestartop;
11975 PL_in_eval = proto_perl->Iin_eval;
11976 PL_delaymagic = proto_perl->Idelaymagic;
11977 PL_dirty = proto_perl->Idirty;
11978 PL_localizing = proto_perl->Ilocalizing;
11980 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11981 PL_hv_fetch_ent_mh = NULL;
11982 PL_modcount = proto_perl->Imodcount;
11983 PL_lastgotoprobe = NULL;
11984 PL_dumpindent = proto_perl->Idumpindent;
11986 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11987 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11988 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11989 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11990 PL_efloatbuf = NULL; /* reinits on demand */
11991 PL_efloatsize = 0; /* reinits on demand */
11995 PL_screamfirst = NULL;
11996 PL_screamnext = NULL;
11997 PL_maxscream = -1; /* reinits on demand */
11998 PL_lastscream = NULL;
12001 PL_regdummy = proto_perl->Iregdummy;
12002 PL_colorset = 0; /* reinits PL_colors[] */
12003 /*PL_colors[6] = {0,0,0,0,0,0};*/
12007 /* Pluggable optimizer */
12008 PL_peepp = proto_perl->Ipeepp;
12010 PL_stashcache = newHV();
12012 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12013 proto_perl->Iwatchaddr);
12014 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12015 if (PL_debug && PL_watchaddr) {
12016 PerlIO_printf(Perl_debug_log,
12017 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12018 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12019 PTR2UV(PL_watchok));
12022 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12023 ptr_table_free(PL_ptr_table);
12024 PL_ptr_table = NULL;
12027 /* Call the ->CLONE method, if it exists, for each of the stashes
12028 identified by sv_dup() above.
12030 while(av_len(param->stashes) != -1) {
12031 HV* const stash = (HV*) av_shift(param->stashes);
12032 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12033 if (cloner && GvCV(cloner)) {
12038 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12040 call_sv((SV*)GvCV(cloner), G_DISCARD);
12046 SvREFCNT_dec(param->stashes);
12048 /* orphaned? eg threads->new inside BEGIN or use */
12049 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12050 SvREFCNT_inc_simple_void(PL_compcv);
12051 SAVEFREESV(PL_compcv);
12057 #endif /* USE_ITHREADS */
12060 =head1 Unicode Support
12062 =for apidoc sv_recode_to_utf8
12064 The encoding is assumed to be an Encode object, on entry the PV
12065 of the sv is assumed to be octets in that encoding, and the sv
12066 will be converted into Unicode (and UTF-8).
12068 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12069 is not a reference, nothing is done to the sv. If the encoding is not
12070 an C<Encode::XS> Encoding object, bad things will happen.
12071 (See F<lib/encoding.pm> and L<Encode>).
12073 The PV of the sv is returned.
12078 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12082 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12084 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12098 Passing sv_yes is wrong - it needs to be or'ed set of constants
12099 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12100 remove converted chars from source.
12102 Both will default the value - let them.
12104 XPUSHs(&PL_sv_yes);
12107 call_method("decode", G_SCALAR);
12111 s = SvPV_const(uni, len);
12112 if (s != SvPVX_const(sv)) {
12113 SvGROW(sv, len + 1);
12114 Move(s, SvPVX(sv), len + 1, char);
12115 SvCUR_set(sv, len);
12122 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12126 =for apidoc sv_cat_decode
12128 The encoding is assumed to be an Encode object, the PV of the ssv is
12129 assumed to be octets in that encoding and decoding the input starts
12130 from the position which (PV + *offset) pointed to. The dsv will be
12131 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12132 when the string tstr appears in decoding output or the input ends on
12133 the PV of the ssv. The value which the offset points will be modified
12134 to the last input position on the ssv.
12136 Returns TRUE if the terminator was found, else returns FALSE.
12141 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12142 SV *ssv, int *offset, char *tstr, int tlen)
12147 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12149 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12160 offsv = newSViv(*offset);
12162 mXPUSHp(tstr, tlen);
12164 call_method("cat_decode", G_SCALAR);
12166 ret = SvTRUE(TOPs);
12167 *offset = SvIV(offsv);
12173 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12178 /* ---------------------------------------------------------------------
12180 * support functions for report_uninit()
12183 /* the maxiumum size of array or hash where we will scan looking
12184 * for the undefined element that triggered the warning */
12186 #define FUV_MAX_SEARCH_SIZE 1000
12188 /* Look for an entry in the hash whose value has the same SV as val;
12189 * If so, return a mortal copy of the key. */
12192 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12195 register HE **array;
12198 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12200 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12201 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12204 array = HvARRAY(hv);
12206 for (i=HvMAX(hv); i>0; i--) {
12207 register HE *entry;
12208 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12209 if (HeVAL(entry) != val)
12211 if ( HeVAL(entry) == &PL_sv_undef ||
12212 HeVAL(entry) == &PL_sv_placeholder)
12216 if (HeKLEN(entry) == HEf_SVKEY)
12217 return sv_mortalcopy(HeKEY_sv(entry));
12218 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12224 /* Look for an entry in the array whose value has the same SV as val;
12225 * If so, return the index, otherwise return -1. */
12228 S_find_array_subscript(pTHX_ AV *av, SV* val)
12232 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12234 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12235 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12238 if (val != &PL_sv_undef) {
12239 SV ** const svp = AvARRAY(av);
12242 for (i=AvFILLp(av); i>=0; i--)
12249 /* S_varname(): return the name of a variable, optionally with a subscript.
12250 * If gv is non-zero, use the name of that global, along with gvtype (one
12251 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12252 * targ. Depending on the value of the subscript_type flag, return:
12255 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12256 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12257 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12258 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12261 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12262 SV* keyname, I32 aindex, int subscript_type)
12265 SV * const name = sv_newmortal();
12268 buffer[0] = gvtype;
12271 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12273 gv_fullname4(name, gv, buffer, 0);
12275 if ((unsigned int)SvPVX(name)[1] <= 26) {
12277 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12279 /* Swap the 1 unprintable control character for the 2 byte pretty
12280 version - ie substr($name, 1, 1) = $buffer; */
12281 sv_insert(name, 1, 1, buffer, 2);
12285 CV * const cv = find_runcv(NULL);
12289 if (!cv || !CvPADLIST(cv))
12291 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12292 sv = *av_fetch(av, targ, FALSE);
12293 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12296 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12297 SV * const sv = newSV(0);
12298 *SvPVX(name) = '$';
12299 Perl_sv_catpvf(aTHX_ name, "{%s}",
12300 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12303 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12304 *SvPVX(name) = '$';
12305 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12307 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
12308 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
12315 =for apidoc find_uninit_var
12317 Find the name of the undefined variable (if any) that caused the operator o
12318 to issue a "Use of uninitialized value" warning.
12319 If match is true, only return a name if it's value matches uninit_sv.
12320 So roughly speaking, if a unary operator (such as OP_COS) generates a
12321 warning, then following the direct child of the op may yield an
12322 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12323 other hand, with OP_ADD there are two branches to follow, so we only print
12324 the variable name if we get an exact match.
12326 The name is returned as a mortal SV.
12328 Assumes that PL_op is the op that originally triggered the error, and that
12329 PL_comppad/PL_curpad points to the currently executing pad.
12335 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12343 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12344 uninit_sv == &PL_sv_placeholder)))
12347 switch (obase->op_type) {
12354 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12355 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12358 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12360 if (pad) { /* @lex, %lex */
12361 sv = PAD_SVl(obase->op_targ);
12365 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12366 /* @global, %global */
12367 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12370 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12372 else /* @{expr}, %{expr} */
12373 return find_uninit_var(cUNOPx(obase)->op_first,
12377 /* attempt to find a match within the aggregate */
12379 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12381 subscript_type = FUV_SUBSCRIPT_HASH;
12384 index = find_array_subscript((AV*)sv, uninit_sv);
12386 subscript_type = FUV_SUBSCRIPT_ARRAY;
12389 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12392 return varname(gv, hash ? '%' : '@', obase->op_targ,
12393 keysv, index, subscript_type);
12397 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12399 return varname(NULL, '$', obase->op_targ,
12400 NULL, 0, FUV_SUBSCRIPT_NONE);
12403 gv = cGVOPx_gv(obase);
12404 if (!gv || (match && GvSV(gv) != uninit_sv))
12406 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12409 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12412 av = (AV*)PAD_SV(obase->op_targ);
12413 if (!av || SvRMAGICAL(av))
12415 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12416 if (!svp || *svp != uninit_sv)
12419 return varname(NULL, '$', obase->op_targ,
12420 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12423 gv = cGVOPx_gv(obase);
12429 if (!av || SvRMAGICAL(av))
12431 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12432 if (!svp || *svp != uninit_sv)
12435 return varname(gv, '$', 0,
12436 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12441 o = cUNOPx(obase)->op_first;
12442 if (!o || o->op_type != OP_NULL ||
12443 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12445 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12449 if (PL_op == obase)
12450 /* $a[uninit_expr] or $h{uninit_expr} */
12451 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12454 o = cBINOPx(obase)->op_first;
12455 kid = cBINOPx(obase)->op_last;
12457 /* get the av or hv, and optionally the gv */
12459 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12460 sv = PAD_SV(o->op_targ);
12462 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12463 && cUNOPo->op_first->op_type == OP_GV)
12465 gv = cGVOPx_gv(cUNOPo->op_first);
12468 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12473 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12474 /* index is constant */
12478 if (obase->op_type == OP_HELEM) {
12479 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12480 if (!he || HeVAL(he) != uninit_sv)
12484 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12485 if (!svp || *svp != uninit_sv)
12489 if (obase->op_type == OP_HELEM)
12490 return varname(gv, '%', o->op_targ,
12491 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12493 return varname(gv, '@', o->op_targ, NULL,
12494 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12497 /* index is an expression;
12498 * attempt to find a match within the aggregate */
12499 if (obase->op_type == OP_HELEM) {
12500 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12502 return varname(gv, '%', o->op_targ,
12503 keysv, 0, FUV_SUBSCRIPT_HASH);
12506 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12508 return varname(gv, '@', o->op_targ,
12509 NULL, index, FUV_SUBSCRIPT_ARRAY);
12514 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12516 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12521 /* only examine RHS */
12522 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12525 o = cUNOPx(obase)->op_first;
12526 if (o->op_type == OP_PUSHMARK)
12529 if (!o->op_sibling) {
12530 /* one-arg version of open is highly magical */
12532 if (o->op_type == OP_GV) { /* open FOO; */
12534 if (match && GvSV(gv) != uninit_sv)
12536 return varname(gv, '$', 0,
12537 NULL, 0, FUV_SUBSCRIPT_NONE);
12539 /* other possibilities not handled are:
12540 * open $x; or open my $x; should return '${*$x}'
12541 * open expr; should return '$'.expr ideally
12547 /* ops where $_ may be an implicit arg */
12551 if ( !(obase->op_flags & OPf_STACKED)) {
12552 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12553 ? PAD_SVl(obase->op_targ)
12556 sv = sv_newmortal();
12557 sv_setpvn(sv, "$_", 2);
12566 /* skip filehandle as it can't produce 'undef' warning */
12567 o = cUNOPx(obase)->op_first;
12568 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12569 o = o->op_sibling->op_sibling;
12573 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12576 match = 1; /* XS or custom code could trigger random warnings */
12581 /* XXX tmp hack: these two may call an XS sub, and currently
12582 XS subs don't have a SUB entry on the context stack, so CV and
12583 pad determination goes wrong, and BAD things happen. So, just
12584 don't try to determine the value under those circumstances.
12585 Need a better fix at dome point. DAPM 11/2007 */
12589 /* def-ness of rval pos() is independent of the def-ness of its arg */
12590 if ( !(obase->op_flags & OPf_MOD))
12595 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12596 return newSVpvs_flags("${$/}", SVs_TEMP);
12601 if (!(obase->op_flags & OPf_KIDS))
12603 o = cUNOPx(obase)->op_first;
12609 /* if all except one arg are constant, or have no side-effects,
12610 * or are optimized away, then it's unambiguous */
12612 for (kid=o; kid; kid = kid->op_sibling) {
12614 const OPCODE type = kid->op_type;
12615 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12616 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12617 || (type == OP_PUSHMARK)
12621 if (o2) { /* more than one found */
12628 return find_uninit_var(o2, uninit_sv, match);
12630 /* scan all args */
12632 sv = find_uninit_var(o, uninit_sv, 1);
12644 =for apidoc report_uninit
12646 Print appropriate "Use of uninitialized variable" warning
12652 Perl_report_uninit(pTHX_ SV* uninit_sv)
12656 SV* varname = NULL;
12658 varname = find_uninit_var(PL_op, uninit_sv,0);
12660 sv_insert(varname, 0, 0, " ", 1);
12662 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12663 varname ? SvPV_nolen_const(varname) : "",
12664 " in ", OP_DESC(PL_op));
12667 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12673 * c-indentation-style: bsd
12674 * c-basic-offset: 4
12675 * indent-tabs-mode: t
12678 * ex: set ts=8 sts=4 sw=4 noet: