3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *const chunk, const U32 chunk_size)
163 PERL_ARGS_ASSERT_OFFER_NICE_CHUNK;
165 new_chunk = (void *)(chunk);
166 new_chunk_size = (chunk_size);
167 if (new_chunk_size > PL_nice_chunk_size) {
168 Safefree(PL_nice_chunk);
169 PL_nice_chunk = (char *) new_chunk;
170 PL_nice_chunk_size = new_chunk_size;
176 #ifdef DEBUG_LEAKING_SCALARS
177 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
179 # define FREE_SV_DEBUG_FILE(sv)
183 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
184 /* Whilst I'd love to do this, it seems that things like to check on
186 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
188 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
189 PoisonNew(&SvREFCNT(sv), 1, U32)
191 # define SvARENA_CHAIN(sv) SvANY(sv)
192 # define POSION_SV_HEAD(sv)
195 #define plant_SV(p) \
197 FREE_SV_DEBUG_FILE(p); \
199 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
200 SvFLAGS(p) = SVTYPEMASK; \
205 #define uproot_SV(p) \
208 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
213 /* make some more SVs by adding another arena */
222 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
223 PL_nice_chunk = NULL;
224 PL_nice_chunk_size = 0;
227 char *chunk; /* must use New here to match call to */
228 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
229 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
235 /* new_SV(): return a new, empty SV head */
237 #ifdef DEBUG_LEAKING_SCALARS
238 /* provide a real function for a debugger to play with */
247 sv = S_more_sv(aTHX);
251 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
252 sv->sv_debug_line = (U16) (PL_parser
253 ? PL_parser->copline == NOLINE
259 sv->sv_debug_inpad = 0;
260 sv->sv_debug_cloned = 0;
261 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
265 # define new_SV(p) (p)=S_new_SV(aTHX)
273 (p) = S_more_sv(aTHX); \
281 /* del_SV(): return an empty SV head to the free list */
294 S_del_sv(pTHX_ SV *p)
298 PERL_ARGS_ASSERT_DEL_SV;
303 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
304 const SV * const sv = sva + 1;
305 const SV * const svend = &sva[SvREFCNT(sva)];
306 if (p >= sv && p < svend) {
312 if (ckWARN_d(WARN_INTERNAL))
313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
314 "Attempt to free non-arena SV: 0x%"UVxf
315 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
322 #else /* ! DEBUGGING */
324 #define del_SV(p) plant_SV(p)
326 #endif /* DEBUGGING */
330 =head1 SV Manipulation Functions
332 =for apidoc sv_add_arena
334 Given a chunk of memory, link it to the head of the list of arenas,
335 and split it into a list of free SVs.
341 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
344 SV* const sva = (SV*)ptr;
348 PERL_ARGS_ASSERT_SV_ADD_ARENA;
350 /* The first SV in an arena isn't an SV. */
351 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
352 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
353 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
355 PL_sv_arenaroot = sva;
356 PL_sv_root = sva + 1;
358 svend = &sva[SvREFCNT(sva) - 1];
361 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
365 /* Must always set typemask because it's always checked in on cleanup
366 when the arenas are walked looking for objects. */
367 SvFLAGS(sv) = SVTYPEMASK;
370 SvARENA_CHAIN(sv) = 0;
374 SvFLAGS(sv) = SVTYPEMASK;
377 /* visit(): call the named function for each non-free SV in the arenas
378 * whose flags field matches the flags/mask args. */
381 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
387 PERL_ARGS_ASSERT_VISIT;
389 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
390 register const SV * const svend = &sva[SvREFCNT(sva)];
392 for (sv = sva + 1; sv < svend; ++sv) {
393 if (SvTYPE(sv) != SVTYPEMASK
394 && (sv->sv_flags & mask) == flags
407 /* called by sv_report_used() for each live SV */
410 do_report_used(pTHX_ SV *const sv)
412 if (SvTYPE(sv) != SVTYPEMASK) {
413 PerlIO_printf(Perl_debug_log, "****\n");
420 =for apidoc sv_report_used
422 Dump the contents of all SVs not yet freed. (Debugging aid).
428 Perl_sv_report_used(pTHX)
431 visit(do_report_used, 0, 0);
437 /* called by sv_clean_objs() for each live SV */
440 do_clean_objs(pTHX_ SV *const ref)
445 SV * const target = SvRV(ref);
446 if (SvOBJECT(target)) {
447 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
448 if (SvWEAKREF(ref)) {
449 sv_del_backref(target, ref);
455 SvREFCNT_dec(target);
460 /* XXX Might want to check arrays, etc. */
463 /* called by sv_clean_objs() for each live SV */
465 #ifndef DISABLE_DESTRUCTOR_KLUDGE
467 do_clean_named_objs(pTHX_ SV *const sv)
470 assert(SvTYPE(sv) == SVt_PVGV);
471 assert(isGV_with_GP(sv));
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
481 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
482 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
484 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
485 SvFLAGS(sv) |= SVf_BREAK;
493 =for apidoc sv_clean_objs
495 Attempt to destroy all objects not yet freed
501 Perl_sv_clean_objs(pTHX)
504 PL_in_clean_objs = TRUE;
505 visit(do_clean_objs, SVf_ROK, SVf_ROK);
506 #ifndef DISABLE_DESTRUCTOR_KLUDGE
507 /* some barnacles may yet remain, clinging to typeglobs */
508 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
510 PL_in_clean_objs = FALSE;
513 /* called by sv_clean_all() for each live SV */
516 do_clean_all(pTHX_ SV *const sv)
519 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
520 /* don't clean pid table and strtab */
523 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
524 SvFLAGS(sv) |= SVf_BREAK;
529 =for apidoc sv_clean_all
531 Decrement the refcnt of each remaining SV, possibly triggering a
532 cleanup. This function may have to be called multiple times to free
533 SVs which are in complex self-referential hierarchies.
539 Perl_sv_clean_all(pTHX)
543 PL_in_clean_all = TRUE;
544 cleaned = visit(do_clean_all, 0,0);
545 PL_in_clean_all = FALSE;
550 ARENASETS: a meta-arena implementation which separates arena-info
551 into struct arena_set, which contains an array of struct
552 arena_descs, each holding info for a single arena. By separating
553 the meta-info from the arena, we recover the 1st slot, formerly
554 borrowed for list management. The arena_set is about the size of an
555 arena, avoiding the needless malloc overhead of a naive linked-list.
557 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
558 memory in the last arena-set (1/2 on average). In trade, we get
559 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
560 smaller types). The recovery of the wasted space allows use of
561 small arenas for large, rare body types, by changing array* fields
562 in body_details_by_type[] below.
565 char *arena; /* the raw storage, allocated aligned */
566 size_t size; /* its size ~4k typ */
567 U32 misc; /* type, and in future other things. */
572 /* Get the maximum number of elements in set[] such that struct arena_set
573 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
574 therefore likely to be 1 aligned memory page. */
576 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
577 - 2 * sizeof(int)) / sizeof (struct arena_desc))
580 struct arena_set* next;
581 unsigned int set_size; /* ie ARENAS_PER_SET */
582 unsigned int curr; /* index of next available arena-desc */
583 struct arena_desc set[ARENAS_PER_SET];
587 =for apidoc sv_free_arenas
589 Deallocate the memory used by all arenas. Note that all the individual SV
590 heads and bodies within the arenas must already have been freed.
595 Perl_sv_free_arenas(pTHX)
602 /* Free arenas here, but be careful about fake ones. (We assume
603 contiguity of the fake ones with the corresponding real ones.) */
605 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
606 svanext = (SV*) SvANY(sva);
607 while (svanext && SvFAKE(svanext))
608 svanext = (SV*) SvANY(svanext);
615 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
618 struct arena_set *current = aroot;
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 i = PERL_ARENA_ROOTS_SIZE;
632 PL_body_roots[i] = 0;
634 Safefree(PL_nice_chunk);
635 PL_nice_chunk = NULL;
636 PL_nice_chunk_size = 0;
642 Here are mid-level routines that manage the allocation of bodies out
643 of the various arenas. There are 5 kinds of arenas:
645 1. SV-head arenas, which are discussed and handled above
646 2. regular body arenas
647 3. arenas for reduced-size bodies
649 5. pte arenas (thread related)
651 Arena types 2 & 3 are chained by body-type off an array of
652 arena-root pointers, which is indexed by svtype. Some of the
653 larger/less used body types are malloced singly, since a large
654 unused block of them is wasteful. Also, several svtypes dont have
655 bodies; the data fits into the sv-head itself. The arena-root
656 pointer thus has a few unused root-pointers (which may be hijacked
657 later for arena types 4,5)
659 3 differs from 2 as an optimization; some body types have several
660 unused fields in the front of the structure (which are kept in-place
661 for consistency). These bodies can be allocated in smaller chunks,
662 because the leading fields arent accessed. Pointers to such bodies
663 are decremented to point at the unused 'ghost' memory, knowing that
664 the pointers are used with offsets to the real memory.
666 HE, HEK arenas are managed separately, with separate code, but may
667 be merge-able later..
669 PTE arenas are not sv-bodies, but they share these mid-level
670 mechanics, so are considered here. The new mid-level mechanics rely
671 on the sv_type of the body being allocated, so we just reserve one
672 of the unused body-slots for PTEs, then use it in those (2) PTE
673 contexts below (line ~10k)
676 /* get_arena(size): this creates custom-sized arenas
677 TBD: export properly for hv.c: S_more_he().
680 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
683 struct arena_desc* adesc;
684 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
687 /* shouldnt need this
688 if (!arena_size) arena_size = PERL_ARENA_SIZE;
691 /* may need new arena-set to hold new arena */
692 if (!aroot || aroot->curr >= aroot->set_size) {
693 struct arena_set *newroot;
694 Newxz(newroot, 1, struct arena_set);
695 newroot->set_size = ARENAS_PER_SET;
696 newroot->next = aroot;
698 PL_body_arenas = (void *) newroot;
699 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
702 /* ok, now have arena-set with at least 1 empty/available arena-desc */
703 curr = aroot->curr++;
704 adesc = &(aroot->set[curr]);
705 assert(!adesc->arena);
707 Newx(adesc->arena, arena_size, char);
708 adesc->size = arena_size;
710 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
711 curr, (void*)adesc->arena, (UV)arena_size));
717 /* return a thing to the free list */
719 #define del_body(thing, root) \
721 void ** const thing_copy = (void **)thing;\
722 *thing_copy = *root; \
723 *root = (void*)thing_copy; \
728 =head1 SV-Body Allocation
730 Allocation of SV-bodies is similar to SV-heads, differing as follows;
731 the allocation mechanism is used for many body types, so is somewhat
732 more complicated, it uses arena-sets, and has no need for still-live
735 At the outermost level, (new|del)_X*V macros return bodies of the
736 appropriate type. These macros call either (new|del)_body_type or
737 (new|del)_body_allocated macro pairs, depending on specifics of the
738 type. Most body types use the former pair, the latter pair is used to
739 allocate body types with "ghost fields".
741 "ghost fields" are fields that are unused in certain types, and
742 consequently dont need to actually exist. They are declared because
743 they're part of a "base type", which allows use of functions as
744 methods. The simplest examples are AVs and HVs, 2 aggregate types
745 which don't use the fields which support SCALAR semantics.
747 For these types, the arenas are carved up into *_allocated size
748 chunks, we thus avoid wasted memory for those unaccessed members.
749 When bodies are allocated, we adjust the pointer back in memory by the
750 size of the bit not allocated, so it's as if we allocated the full
751 structure. (But things will all go boom if you write to the part that
752 is "not there", because you'll be overwriting the last members of the
753 preceding structure in memory.)
755 We calculate the correction using the STRUCT_OFFSET macro. For
756 example, if xpv_allocated is the same structure as XPV then the two
757 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
758 structure is smaller (no initial NV actually allocated) then the net
759 effect is to subtract the size of the NV from the pointer, to return a
760 new pointer as if an initial NV were actually allocated.
762 This is the same trick as was used for NV and IV bodies. Ironically it
763 doesn't need to be used for NV bodies any more, because NV is now at
764 the start of the structure. IV bodies don't need it either, because
765 they are no longer allocated.
767 In turn, the new_body_* allocators call S_new_body(), which invokes
768 new_body_inline macro, which takes a lock, and takes a body off the
769 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
770 necessary to refresh an empty list. Then the lock is released, and
771 the body is returned.
773 S_more_bodies calls get_arena(), and carves it up into an array of N
774 bodies, which it strings into a linked list. It looks up arena-size
775 and body-size from the body_details table described below, thus
776 supporting the multiple body-types.
778 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
779 the (new|del)_X*V macros are mapped directly to malloc/free.
785 For each sv-type, struct body_details bodies_by_type[] carries
786 parameters which control these aspects of SV handling:
788 Arena_size determines whether arenas are used for this body type, and if
789 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
790 zero, forcing individual mallocs and frees.
792 Body_size determines how big a body is, and therefore how many fit into
793 each arena. Offset carries the body-pointer adjustment needed for
794 *_allocated body types, and is used in *_allocated macros.
796 But its main purpose is to parameterize info needed in
797 Perl_sv_upgrade(). The info here dramatically simplifies the function
798 vs the implementation in 5.8.7, making it table-driven. All fields
799 are used for this, except for arena_size.
801 For the sv-types that have no bodies, arenas are not used, so those
802 PL_body_roots[sv_type] are unused, and can be overloaded. In
803 something of a special case, SVt_NULL is borrowed for HE arenas;
804 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
805 bodies_by_type[SVt_NULL] slot is not used, as the table is not
808 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
809 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
810 just use the same allocation semantics. At first, PTEs were also
811 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
812 bugs, so was simplified by claiming a new slot. This choice has no
813 consequence at this time.
817 struct body_details {
818 U8 body_size; /* Size to allocate */
819 U8 copy; /* Size of structure to copy (may be shorter) */
821 unsigned int type : 4; /* We have space for a sanity check. */
822 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
823 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
824 unsigned int arena : 1; /* Allocated from an arena */
825 size_t arena_size; /* Size of arena to allocate */
833 /* With -DPURFIY we allocate everything directly, and don't use arenas.
834 This seems a rather elegant way to simplify some of the code below. */
835 #define HASARENA FALSE
837 #define HASARENA TRUE
839 #define NOARENA FALSE
841 /* Size the arenas to exactly fit a given number of bodies. A count
842 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
843 simplifying the default. If count > 0, the arena is sized to fit
844 only that many bodies, allowing arenas to be used for large, rare
845 bodies (XPVFM, XPVIO) without undue waste. The arena size is
846 limited by PERL_ARENA_SIZE, so we can safely oversize the
849 #define FIT_ARENA0(body_size) \
850 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
851 #define FIT_ARENAn(count,body_size) \
852 ( count * body_size <= PERL_ARENA_SIZE) \
853 ? count * body_size \
854 : FIT_ARENA0 (body_size)
855 #define FIT_ARENA(count,body_size) \
857 ? FIT_ARENAn (count, body_size) \
858 : FIT_ARENA0 (body_size)
860 /* A macro to work out the offset needed to subtract from a pointer to (say)
867 to make its members accessible via a pointer to (say)
877 #define relative_STRUCT_OFFSET(longer, shorter, member) \
878 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
880 /* Calculate the length to copy. Specifically work out the length less any
881 final padding the compiler needed to add. See the comment in sv_upgrade
882 for why copying the padding proved to be a bug. */
884 #define copy_length(type, last_member) \
885 STRUCT_OFFSET(type, last_member) \
886 + sizeof (((type*)SvANY((SV*)0))->last_member)
888 static const struct body_details bodies_by_type[] = {
889 { sizeof(HE), 0, 0, SVt_NULL,
890 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
892 /* The bind placeholder pretends to be an RV for now.
893 Also it's marked as "can't upgrade" to stop anyone using it before it's
895 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
897 /* IVs are in the head, so the allocation size is 0.
898 However, the slot is overloaded for PTEs. */
899 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
900 sizeof(IV), /* This is used to copy out the IV body. */
901 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
902 NOARENA /* IVS don't need an arena */,
903 /* But PTEs need to know the size of their arena */
904 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
909 FIT_ARENA(0, sizeof(NV)) },
911 /* 8 bytes on most ILP32 with IEEE doubles */
912 { sizeof(xpv_allocated),
913 copy_length(XPV, xpv_len)
914 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
916 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
919 { sizeof(xpviv_allocated),
920 copy_length(XPVIV, xiv_u)
921 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
923 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
926 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
930 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
934 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
935 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
936 SVt_REGEXP, FALSE, NONV, HASARENA,
937 FIT_ARENA(0, sizeof(struct regexp_allocated))
941 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
942 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
945 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
946 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
948 { sizeof(xpvav_allocated),
949 copy_length(XPVAV, xmg_stash)
950 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
952 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
954 { sizeof(xpvhv_allocated),
955 copy_length(XPVHV, xmg_stash)
956 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
958 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
961 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
962 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
963 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
965 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
966 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
967 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
969 /* XPVIO is 84 bytes, fits 48x */
970 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
971 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
972 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
975 #define new_body_type(sv_type) \
976 (void *)((char *)S_new_body(aTHX_ sv_type))
978 #define del_body_type(p, sv_type) \
979 del_body(p, &PL_body_roots[sv_type])
982 #define new_body_allocated(sv_type) \
983 (void *)((char *)S_new_body(aTHX_ sv_type) \
984 - bodies_by_type[sv_type].offset)
986 #define del_body_allocated(p, sv_type) \
987 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
990 #define my_safemalloc(s) (void*)safemalloc(s)
991 #define my_safecalloc(s) (void*)safecalloc(s, 1)
992 #define my_safefree(p) safefree((char*)p)
996 #define new_XNV() my_safemalloc(sizeof(XPVNV))
997 #define del_XNV(p) my_safefree(p)
999 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1000 #define del_XPVNV(p) my_safefree(p)
1002 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1003 #define del_XPVAV(p) my_safefree(p)
1005 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1006 #define del_XPVHV(p) my_safefree(p)
1008 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1009 #define del_XPVMG(p) my_safefree(p)
1011 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1012 #define del_XPVGV(p) my_safefree(p)
1016 #define new_XNV() new_body_type(SVt_NV)
1017 #define del_XNV(p) del_body_type(p, SVt_NV)
1019 #define new_XPVNV() new_body_type(SVt_PVNV)
1020 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1022 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1023 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1025 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1026 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1028 #define new_XPVMG() new_body_type(SVt_PVMG)
1029 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1031 #define new_XPVGV() new_body_type(SVt_PVGV)
1032 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1036 /* no arena for you! */
1038 #define new_NOARENA(details) \
1039 my_safemalloc((details)->body_size + (details)->offset)
1040 #define new_NOARENAZ(details) \
1041 my_safecalloc((details)->body_size + (details)->offset)
1044 S_more_bodies (pTHX_ const svtype sv_type)
1047 void ** const root = &PL_body_roots[sv_type];
1048 const struct body_details * const bdp = &bodies_by_type[sv_type];
1049 const size_t body_size = bdp->body_size;
1052 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1053 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1054 static bool done_sanity_check;
1056 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1057 * variables like done_sanity_check. */
1058 if (!done_sanity_check) {
1059 unsigned int i = SVt_LAST;
1061 done_sanity_check = TRUE;
1064 assert (bodies_by_type[i].type == i);
1068 assert(bdp->arena_size);
1070 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1072 end = start + arena_size - 2 * body_size;
1074 /* computed count doesnt reflect the 1st slot reservation */
1075 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1076 DEBUG_m(PerlIO_printf(Perl_debug_log,
1077 "arena %p end %p arena-size %d (from %d) type %d "
1079 (void*)start, (void*)end, (int)arena_size,
1080 (int)bdp->arena_size, sv_type, (int)body_size,
1081 (int)arena_size / (int)body_size));
1083 DEBUG_m(PerlIO_printf(Perl_debug_log,
1084 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1085 (void*)start, (void*)end,
1086 (int)bdp->arena_size, sv_type, (int)body_size,
1087 (int)bdp->arena_size / (int)body_size));
1089 *root = (void *)start;
1091 while (start <= end) {
1092 char * const next = start + body_size;
1093 *(void**) start = (void *)next;
1096 *(void **)start = 0;
1101 /* grab a new thing from the free list, allocating more if necessary.
1102 The inline version is used for speed in hot routines, and the
1103 function using it serves the rest (unless PURIFY).
1105 #define new_body_inline(xpv, sv_type) \
1107 void ** const r3wt = &PL_body_roots[sv_type]; \
1108 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1109 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1110 *(r3wt) = *(void**)(xpv); \
1116 S_new_body(pTHX_ const svtype sv_type)
1120 new_body_inline(xpv, sv_type);
1126 static const struct body_details fake_rv =
1127 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1130 =for apidoc sv_upgrade
1132 Upgrade an SV to a more complex form. Generally adds a new body type to the
1133 SV, then copies across as much information as possible from the old body.
1134 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1140 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1145 const svtype old_type = SvTYPE(sv);
1146 const struct body_details *new_type_details;
1147 const struct body_details *old_type_details
1148 = bodies_by_type + old_type;
1149 SV *referant = NULL;
1151 PERL_ARGS_ASSERT_SV_UPGRADE;
1153 if (new_type != SVt_PV && SvIsCOW(sv)) {
1154 sv_force_normal_flags(sv, 0);
1157 if (old_type == new_type)
1160 old_body = SvANY(sv);
1162 /* Copying structures onto other structures that have been neatly zeroed
1163 has a subtle gotcha. Consider XPVMG
1165 +------+------+------+------+------+-------+-------+
1166 | NV | CUR | LEN | IV | MAGIC | STASH |
1167 +------+------+------+------+------+-------+-------+
1168 0 4 8 12 16 20 24 28
1170 where NVs are aligned to 8 bytes, so that sizeof that structure is
1171 actually 32 bytes long, with 4 bytes of padding at the end:
1173 +------+------+------+------+------+-------+-------+------+
1174 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1175 +------+------+------+------+------+-------+-------+------+
1176 0 4 8 12 16 20 24 28 32
1178 so what happens if you allocate memory for this structure:
1180 +------+------+------+------+------+-------+-------+------+------+...
1181 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1182 +------+------+------+------+------+-------+-------+------+------+...
1183 0 4 8 12 16 20 24 28 32 36
1185 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1186 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1187 started out as zero once, but it's quite possible that it isn't. So now,
1188 rather than a nicely zeroed GP, you have it pointing somewhere random.
1191 (In fact, GP ends up pointing at a previous GP structure, because the
1192 principle cause of the padding in XPVMG getting garbage is a copy of
1193 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1194 this happens to be moot because XPVGV has been re-ordered, with GP
1195 no longer after STASH)
1197 So we are careful and work out the size of used parts of all the
1205 referant = SvRV(sv);
1206 old_type_details = &fake_rv;
1207 if (new_type == SVt_NV)
1208 new_type = SVt_PVNV;
1210 if (new_type < SVt_PVIV) {
1211 new_type = (new_type == SVt_NV)
1212 ? SVt_PVNV : SVt_PVIV;
1217 if (new_type < SVt_PVNV) {
1218 new_type = SVt_PVNV;
1222 assert(new_type > SVt_PV);
1223 assert(SVt_IV < SVt_PV);
1224 assert(SVt_NV < SVt_PV);
1231 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1232 there's no way that it can be safely upgraded, because perl.c
1233 expects to Safefree(SvANY(PL_mess_sv)) */
1234 assert(sv != PL_mess_sv);
1235 /* This flag bit is used to mean other things in other scalar types.
1236 Given that it only has meaning inside the pad, it shouldn't be set
1237 on anything that can get upgraded. */
1238 assert(!SvPAD_TYPED(sv));
1241 if (old_type_details->cant_upgrade)
1242 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1243 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1246 if (old_type > new_type)
1247 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1248 (int)old_type, (int)new_type);
1250 new_type_details = bodies_by_type + new_type;
1252 SvFLAGS(sv) &= ~SVTYPEMASK;
1253 SvFLAGS(sv) |= new_type;
1255 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1256 the return statements above will have triggered. */
1257 assert (new_type != SVt_NULL);
1260 assert(old_type == SVt_NULL);
1261 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1265 assert(old_type == SVt_NULL);
1266 SvANY(sv) = new_XNV();
1271 assert(new_type_details->body_size);
1274 assert(new_type_details->arena);
1275 assert(new_type_details->arena_size);
1276 /* This points to the start of the allocated area. */
1277 new_body_inline(new_body, new_type);
1278 Zero(new_body, new_type_details->body_size, char);
1279 new_body = ((char *)new_body) - new_type_details->offset;
1281 /* We always allocated the full length item with PURIFY. To do this
1282 we fake things so that arena is false for all 16 types.. */
1283 new_body = new_NOARENAZ(new_type_details);
1285 SvANY(sv) = new_body;
1286 if (new_type == SVt_PVAV) {
1290 if (old_type_details->body_size) {
1293 /* It will have been zeroed when the new body was allocated.
1294 Lets not write to it, in case it confuses a write-back
1300 #ifndef NODEFAULT_SHAREKEYS
1301 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1303 HvMAX(sv) = 7; /* (start with 8 buckets) */
1304 if (old_type_details->body_size) {
1307 /* It will have been zeroed when the new body was allocated.
1308 Lets not write to it, in case it confuses a write-back
1313 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1314 The target created by newSVrv also is, and it can have magic.
1315 However, it never has SvPVX set.
1317 if (old_type == SVt_IV) {
1319 } else if (old_type >= SVt_PV) {
1320 assert(SvPVX_const(sv) == 0);
1323 if (old_type >= SVt_PVMG) {
1324 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1325 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1327 sv->sv_u.svu_array = NULL; /* or svu_hash */
1333 /* XXX Is this still needed? Was it ever needed? Surely as there is
1334 no route from NV to PVIV, NOK can never be true */
1335 assert(!SvNOKp(sv));
1347 assert(new_type_details->body_size);
1348 /* We always allocated the full length item with PURIFY. To do this
1349 we fake things so that arena is false for all 16 types.. */
1350 if(new_type_details->arena) {
1351 /* This points to the start of the allocated area. */
1352 new_body_inline(new_body, new_type);
1353 Zero(new_body, new_type_details->body_size, char);
1354 new_body = ((char *)new_body) - new_type_details->offset;
1356 new_body = new_NOARENAZ(new_type_details);
1358 SvANY(sv) = new_body;
1360 if (old_type_details->copy) {
1361 /* There is now the potential for an upgrade from something without
1362 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1363 int offset = old_type_details->offset;
1364 int length = old_type_details->copy;
1366 if (new_type_details->offset > old_type_details->offset) {
1367 const int difference
1368 = new_type_details->offset - old_type_details->offset;
1369 offset += difference;
1370 length -= difference;
1372 assert (length >= 0);
1374 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1378 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1379 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1380 * correct 0.0 for us. Otherwise, if the old body didn't have an
1381 * NV slot, but the new one does, then we need to initialise the
1382 * freshly created NV slot with whatever the correct bit pattern is
1384 if (old_type_details->zero_nv && !new_type_details->zero_nv
1385 && !isGV_with_GP(sv))
1389 if (new_type == SVt_PVIO)
1390 IoPAGE_LEN(sv) = 60;
1391 if (old_type < SVt_PV) {
1392 /* referant will be NULL unless the old type was SVt_IV emulating
1394 sv->sv_u.svu_rv = referant;
1398 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1399 (unsigned long)new_type);
1402 if (old_type_details->arena) {
1403 /* If there was an old body, then we need to free it.
1404 Note that there is an assumption that all bodies of types that
1405 can be upgraded came from arenas. Only the more complex non-
1406 upgradable types are allowed to be directly malloc()ed. */
1408 my_safefree(old_body);
1410 del_body((void*)((char*)old_body + old_type_details->offset),
1411 &PL_body_roots[old_type]);
1417 =for apidoc sv_backoff
1419 Remove any string offset. You should normally use the C<SvOOK_off> macro
1426 Perl_sv_backoff(pTHX_ register SV *const sv)
1429 const char * const s = SvPVX_const(sv);
1431 PERL_ARGS_ASSERT_SV_BACKOFF;
1432 PERL_UNUSED_CONTEXT;
1435 assert(SvTYPE(sv) != SVt_PVHV);
1436 assert(SvTYPE(sv) != SVt_PVAV);
1438 SvOOK_offset(sv, delta);
1440 SvLEN_set(sv, SvLEN(sv) + delta);
1441 SvPV_set(sv, SvPVX(sv) - delta);
1442 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1443 SvFLAGS(sv) &= ~SVf_OOK;
1450 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1451 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1452 Use the C<SvGROW> wrapper instead.
1458 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1462 PERL_ARGS_ASSERT_SV_GROW;
1464 if (PL_madskills && newlen >= 0x100000) {
1465 PerlIO_printf(Perl_debug_log,
1466 "Allocation too large: %"UVxf"\n", (UV)newlen);
1468 #ifdef HAS_64K_LIMIT
1469 if (newlen >= 0x10000) {
1470 PerlIO_printf(Perl_debug_log,
1471 "Allocation too large: %"UVxf"\n", (UV)newlen);
1474 #endif /* HAS_64K_LIMIT */
1477 if (SvTYPE(sv) < SVt_PV) {
1478 sv_upgrade(sv, SVt_PV);
1479 s = SvPVX_mutable(sv);
1481 else if (SvOOK(sv)) { /* pv is offset? */
1483 s = SvPVX_mutable(sv);
1484 if (newlen > SvLEN(sv))
1485 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1486 #ifdef HAS_64K_LIMIT
1487 if (newlen >= 0x10000)
1492 s = SvPVX_mutable(sv);
1494 if (newlen > SvLEN(sv)) { /* need more room? */
1496 newlen = PERL_STRLEN_ROUNDUP(newlen);
1498 if (SvLEN(sv) && s) {
1499 s = (char*)saferealloc(s, newlen);
1502 s = (char*)safemalloc(newlen);
1503 if (SvPVX_const(sv) && SvCUR(sv)) {
1504 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1508 #ifdef Perl_safesysmalloc_size
1509 /* Do this here, do it once, do it right, and then we will never get
1510 called back into sv_grow() unless there really is some growing
1512 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1514 SvLEN_set(sv, newlen);
1521 =for apidoc sv_setiv
1523 Copies an integer into the given SV, upgrading first if necessary.
1524 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1530 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1534 PERL_ARGS_ASSERT_SV_SETIV;
1536 SV_CHECK_THINKFIRST_COW_DROP(sv);
1537 switch (SvTYPE(sv)) {
1540 sv_upgrade(sv, SVt_IV);
1543 sv_upgrade(sv, SVt_PVIV);
1552 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1556 (void)SvIOK_only(sv); /* validate number */
1562 =for apidoc sv_setiv_mg
1564 Like C<sv_setiv>, but also handles 'set' magic.
1570 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1572 PERL_ARGS_ASSERT_SV_SETIV_MG;
1579 =for apidoc sv_setuv
1581 Copies an unsigned integer into the given SV, upgrading first if necessary.
1582 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1588 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1590 PERL_ARGS_ASSERT_SV_SETUV;
1592 /* With these two if statements:
1593 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1596 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1598 If you wish to remove them, please benchmark to see what the effect is
1600 if (u <= (UV)IV_MAX) {
1601 sv_setiv(sv, (IV)u);
1610 =for apidoc sv_setuv_mg
1612 Like C<sv_setuv>, but also handles 'set' magic.
1618 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1620 PERL_ARGS_ASSERT_SV_SETUV_MG;
1627 =for apidoc sv_setnv
1629 Copies a double into the given SV, upgrading first if necessary.
1630 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1636 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1640 PERL_ARGS_ASSERT_SV_SETNV;
1642 SV_CHECK_THINKFIRST_COW_DROP(sv);
1643 switch (SvTYPE(sv)) {
1646 sv_upgrade(sv, SVt_NV);
1650 sv_upgrade(sv, SVt_PVNV);
1659 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1664 (void)SvNOK_only(sv); /* validate number */
1669 =for apidoc sv_setnv_mg
1671 Like C<sv_setnv>, but also handles 'set' magic.
1677 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1679 PERL_ARGS_ASSERT_SV_SETNV_MG;
1685 /* Print an "isn't numeric" warning, using a cleaned-up,
1686 * printable version of the offending string
1690 S_not_a_number(pTHX_ SV *const sv)
1697 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1700 dsv = newSVpvs_flags("", SVs_TEMP);
1701 pv = sv_uni_display(dsv, sv, 10, 0);
1704 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1705 /* each *s can expand to 4 chars + "...\0",
1706 i.e. need room for 8 chars */
1708 const char *s = SvPVX_const(sv);
1709 const char * const end = s + SvCUR(sv);
1710 for ( ; s < end && d < limit; s++ ) {
1712 if (ch & 128 && !isPRINT_LC(ch)) {
1721 else if (ch == '\r') {
1725 else if (ch == '\f') {
1729 else if (ch == '\\') {
1733 else if (ch == '\0') {
1737 else if (isPRINT_LC(ch))
1754 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1755 "Argument \"%s\" isn't numeric in %s", pv,
1758 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1759 "Argument \"%s\" isn't numeric", pv);
1763 =for apidoc looks_like_number
1765 Test if the content of an SV looks like a number (or is a number).
1766 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1767 non-numeric warning), even if your atof() doesn't grok them.
1773 Perl_looks_like_number(pTHX_ SV *const sv)
1775 register const char *sbegin;
1778 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1781 sbegin = SvPVX_const(sv);
1784 else if (SvPOKp(sv))
1785 sbegin = SvPV_const(sv, len);
1787 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1788 return grok_number(sbegin, len, NULL);
1792 S_glob_2number(pTHX_ GV * const gv)
1794 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1795 SV *const buffer = sv_newmortal();
1797 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1799 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1802 gv_efullname3(buffer, gv, "*");
1803 SvFLAGS(gv) |= wasfake;
1805 /* We know that all GVs stringify to something that is not-a-number,
1806 so no need to test that. */
1807 if (ckWARN(WARN_NUMERIC))
1808 not_a_number(buffer);
1809 /* We just want something true to return, so that S_sv_2iuv_common
1810 can tail call us and return true. */
1815 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1817 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1818 SV *const buffer = sv_newmortal();
1820 PERL_ARGS_ASSERT_GLOB_2PV;
1822 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1825 gv_efullname3(buffer, gv, "*");
1826 SvFLAGS(gv) |= wasfake;
1828 assert(SvPOK(buffer));
1830 *len = SvCUR(buffer);
1832 return SvPVX(buffer);
1835 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1836 until proven guilty, assume that things are not that bad... */
1841 As 64 bit platforms often have an NV that doesn't preserve all bits of
1842 an IV (an assumption perl has been based on to date) it becomes necessary
1843 to remove the assumption that the NV always carries enough precision to
1844 recreate the IV whenever needed, and that the NV is the canonical form.
1845 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1846 precision as a side effect of conversion (which would lead to insanity
1847 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1848 1) to distinguish between IV/UV/NV slots that have cached a valid
1849 conversion where precision was lost and IV/UV/NV slots that have a
1850 valid conversion which has lost no precision
1851 2) to ensure that if a numeric conversion to one form is requested that
1852 would lose precision, the precise conversion (or differently
1853 imprecise conversion) is also performed and cached, to prevent
1854 requests for different numeric formats on the same SV causing
1855 lossy conversion chains. (lossless conversion chains are perfectly
1860 SvIOKp is true if the IV slot contains a valid value
1861 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1862 SvNOKp is true if the NV slot contains a valid value
1863 SvNOK is true only if the NV value is accurate
1866 while converting from PV to NV, check to see if converting that NV to an
1867 IV(or UV) would lose accuracy over a direct conversion from PV to
1868 IV(or UV). If it would, cache both conversions, return NV, but mark
1869 SV as IOK NOKp (ie not NOK).
1871 While converting from PV to IV, check to see if converting that IV to an
1872 NV would lose accuracy over a direct conversion from PV to NV. If it
1873 would, cache both conversions, flag similarly.
1875 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1876 correctly because if IV & NV were set NV *always* overruled.
1877 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1878 changes - now IV and NV together means that the two are interchangeable:
1879 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1881 The benefit of this is that operations such as pp_add know that if
1882 SvIOK is true for both left and right operands, then integer addition
1883 can be used instead of floating point (for cases where the result won't
1884 overflow). Before, floating point was always used, which could lead to
1885 loss of precision compared with integer addition.
1887 * making IV and NV equal status should make maths accurate on 64 bit
1889 * may speed up maths somewhat if pp_add and friends start to use
1890 integers when possible instead of fp. (Hopefully the overhead in
1891 looking for SvIOK and checking for overflow will not outweigh the
1892 fp to integer speedup)
1893 * will slow down integer operations (callers of SvIV) on "inaccurate"
1894 values, as the change from SvIOK to SvIOKp will cause a call into
1895 sv_2iv each time rather than a macro access direct to the IV slot
1896 * should speed up number->string conversion on integers as IV is
1897 favoured when IV and NV are equally accurate
1899 ####################################################################
1900 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1901 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1902 On the other hand, SvUOK is true iff UV.
1903 ####################################################################
1905 Your mileage will vary depending your CPU's relative fp to integer
1909 #ifndef NV_PRESERVES_UV
1910 # define IS_NUMBER_UNDERFLOW_IV 1
1911 # define IS_NUMBER_UNDERFLOW_UV 2
1912 # define IS_NUMBER_IV_AND_UV 2
1913 # define IS_NUMBER_OVERFLOW_IV 4
1914 # define IS_NUMBER_OVERFLOW_UV 5
1916 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1918 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1920 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1928 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1930 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1931 if (SvNVX(sv) < (NV)IV_MIN) {
1932 (void)SvIOKp_on(sv);
1934 SvIV_set(sv, IV_MIN);
1935 return IS_NUMBER_UNDERFLOW_IV;
1937 if (SvNVX(sv) > (NV)UV_MAX) {
1938 (void)SvIOKp_on(sv);
1941 SvUV_set(sv, UV_MAX);
1942 return IS_NUMBER_OVERFLOW_UV;
1944 (void)SvIOKp_on(sv);
1946 /* Can't use strtol etc to convert this string. (See truth table in
1948 if (SvNVX(sv) <= (UV)IV_MAX) {
1949 SvIV_set(sv, I_V(SvNVX(sv)));
1950 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1951 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1953 /* Integer is imprecise. NOK, IOKp */
1955 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1958 SvUV_set(sv, U_V(SvNVX(sv)));
1959 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1960 if (SvUVX(sv) == UV_MAX) {
1961 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1962 possibly be preserved by NV. Hence, it must be overflow.
1964 return IS_NUMBER_OVERFLOW_UV;
1966 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1968 /* Integer is imprecise. NOK, IOKp */
1970 return IS_NUMBER_OVERFLOW_IV;
1972 #endif /* !NV_PRESERVES_UV*/
1975 S_sv_2iuv_common(pTHX_ SV *const sv)
1979 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1982 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1983 * without also getting a cached IV/UV from it at the same time
1984 * (ie PV->NV conversion should detect loss of accuracy and cache
1985 * IV or UV at same time to avoid this. */
1986 /* IV-over-UV optimisation - choose to cache IV if possible */
1988 if (SvTYPE(sv) == SVt_NV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1992 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1993 certainly cast into the IV range at IV_MAX, whereas the correct
1994 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1996 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1997 if (Perl_isnan(SvNVX(sv))) {
2003 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2004 SvIV_set(sv, I_V(SvNVX(sv)));
2005 if (SvNVX(sv) == (NV) SvIVX(sv)
2006 #ifndef NV_PRESERVES_UV
2007 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2008 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2009 /* Don't flag it as "accurately an integer" if the number
2010 came from a (by definition imprecise) NV operation, and
2011 we're outside the range of NV integer precision */
2015 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2017 /* scalar has trailing garbage, eg "42a" */
2019 DEBUG_c(PerlIO_printf(Perl_debug_log,
2020 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2026 /* IV not precise. No need to convert from PV, as NV
2027 conversion would already have cached IV if it detected
2028 that PV->IV would be better than PV->NV->IV
2029 flags already correct - don't set public IOK. */
2030 DEBUG_c(PerlIO_printf(Perl_debug_log,
2031 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2036 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2037 but the cast (NV)IV_MIN rounds to a the value less (more
2038 negative) than IV_MIN which happens to be equal to SvNVX ??
2039 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2040 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2041 (NV)UVX == NVX are both true, but the values differ. :-(
2042 Hopefully for 2s complement IV_MIN is something like
2043 0x8000000000000000 which will be exact. NWC */
2046 SvUV_set(sv, U_V(SvNVX(sv)));
2048 (SvNVX(sv) == (NV) SvUVX(sv))
2049 #ifndef NV_PRESERVES_UV
2050 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2051 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2052 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2053 /* Don't flag it as "accurately an integer" if the number
2054 came from a (by definition imprecise) NV operation, and
2055 we're outside the range of NV integer precision */
2061 DEBUG_c(PerlIO_printf(Perl_debug_log,
2062 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2068 else if (SvPOKp(sv) && SvLEN(sv)) {
2070 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2071 /* We want to avoid a possible problem when we cache an IV/ a UV which
2072 may be later translated to an NV, and the resulting NV is not
2073 the same as the direct translation of the initial string
2074 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2075 be careful to ensure that the value with the .456 is around if the
2076 NV value is requested in the future).
2078 This means that if we cache such an IV/a UV, we need to cache the
2079 NV as well. Moreover, we trade speed for space, and do not
2080 cache the NV if we are sure it's not needed.
2083 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2084 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2085 == IS_NUMBER_IN_UV) {
2086 /* It's definitely an integer, only upgrade to PVIV */
2087 if (SvTYPE(sv) < SVt_PVIV)
2088 sv_upgrade(sv, SVt_PVIV);
2090 } else if (SvTYPE(sv) < SVt_PVNV)
2091 sv_upgrade(sv, SVt_PVNV);
2093 /* If NVs preserve UVs then we only use the UV value if we know that
2094 we aren't going to call atof() below. If NVs don't preserve UVs
2095 then the value returned may have more precision than atof() will
2096 return, even though value isn't perfectly accurate. */
2097 if ((numtype & (IS_NUMBER_IN_UV
2098 #ifdef NV_PRESERVES_UV
2101 )) == IS_NUMBER_IN_UV) {
2102 /* This won't turn off the public IOK flag if it was set above */
2103 (void)SvIOKp_on(sv);
2105 if (!(numtype & IS_NUMBER_NEG)) {
2107 if (value <= (UV)IV_MAX) {
2108 SvIV_set(sv, (IV)value);
2110 /* it didn't overflow, and it was positive. */
2111 SvUV_set(sv, value);
2115 /* 2s complement assumption */
2116 if (value <= (UV)IV_MIN) {
2117 SvIV_set(sv, -(IV)value);
2119 /* Too negative for an IV. This is a double upgrade, but
2120 I'm assuming it will be rare. */
2121 if (SvTYPE(sv) < SVt_PVNV)
2122 sv_upgrade(sv, SVt_PVNV);
2126 SvNV_set(sv, -(NV)value);
2127 SvIV_set(sv, IV_MIN);
2131 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2132 will be in the previous block to set the IV slot, and the next
2133 block to set the NV slot. So no else here. */
2135 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2136 != IS_NUMBER_IN_UV) {
2137 /* It wasn't an (integer that doesn't overflow the UV). */
2138 SvNV_set(sv, Atof(SvPVX_const(sv)));
2140 if (! numtype && ckWARN(WARN_NUMERIC))
2143 #if defined(USE_LONG_DOUBLE)
2144 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2145 PTR2UV(sv), SvNVX(sv)));
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2151 #ifdef NV_PRESERVES_UV
2152 (void)SvIOKp_on(sv);
2154 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2155 SvIV_set(sv, I_V(SvNVX(sv)));
2156 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2159 NOOP; /* Integer is imprecise. NOK, IOKp */
2161 /* UV will not work better than IV */
2163 if (SvNVX(sv) > (NV)UV_MAX) {
2165 /* Integer is inaccurate. NOK, IOKp, is UV */
2166 SvUV_set(sv, UV_MAX);
2168 SvUV_set(sv, U_V(SvNVX(sv)));
2169 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2170 NV preservse UV so can do correct comparison. */
2171 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2174 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2179 #else /* NV_PRESERVES_UV */
2180 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2181 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2182 /* The IV/UV slot will have been set from value returned by
2183 grok_number above. The NV slot has just been set using
2186 assert (SvIOKp(sv));
2188 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2189 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2190 /* Small enough to preserve all bits. */
2191 (void)SvIOKp_on(sv);
2193 SvIV_set(sv, I_V(SvNVX(sv)));
2194 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2196 /* Assumption: first non-preserved integer is < IV_MAX,
2197 this NV is in the preserved range, therefore: */
2198 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2200 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2204 0 0 already failed to read UV.
2205 0 1 already failed to read UV.
2206 1 0 you won't get here in this case. IV/UV
2207 slot set, public IOK, Atof() unneeded.
2208 1 1 already read UV.
2209 so there's no point in sv_2iuv_non_preserve() attempting
2210 to use atol, strtol, strtoul etc. */
2212 sv_2iuv_non_preserve (sv, numtype);
2214 sv_2iuv_non_preserve (sv);
2218 #endif /* NV_PRESERVES_UV */
2219 /* It might be more code efficient to go through the entire logic above
2220 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2221 gets complex and potentially buggy, so more programmer efficient
2222 to do it this way, by turning off the public flags: */
2224 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2228 if (isGV_with_GP(sv))
2229 return glob_2number((GV *)sv);
2231 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2232 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2235 if (SvTYPE(sv) < SVt_IV)
2236 /* Typically the caller expects that sv_any is not NULL now. */
2237 sv_upgrade(sv, SVt_IV);
2238 /* Return 0 from the caller. */
2245 =for apidoc sv_2iv_flags
2247 Return the integer value of an SV, doing any necessary string
2248 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2249 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2255 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2260 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2261 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2262 cache IVs just in case. In practice it seems that they never
2263 actually anywhere accessible by user Perl code, let alone get used
2264 in anything other than a string context. */
2265 if (flags & SV_GMAGIC)
2270 return I_V(SvNVX(sv));
2272 if (SvPOKp(sv) && SvLEN(sv)) {
2275 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2277 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2278 == IS_NUMBER_IN_UV) {
2279 /* It's definitely an integer */
2280 if (numtype & IS_NUMBER_NEG) {
2281 if (value < (UV)IV_MIN)
2284 if (value < (UV)IV_MAX)
2289 if (ckWARN(WARN_NUMERIC))
2292 return I_V(Atof(SvPVX_const(sv)));
2297 assert(SvTYPE(sv) >= SVt_PVMG);
2298 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2299 } else if (SvTHINKFIRST(sv)) {
2303 SV * const tmpstr=AMG_CALLun(sv,numer);
2304 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2305 return SvIV(tmpstr);
2308 return PTR2IV(SvRV(sv));
2311 sv_force_normal_flags(sv, 0);
2313 if (SvREADONLY(sv) && !SvOK(sv)) {
2314 if (ckWARN(WARN_UNINITIALIZED))
2320 if (S_sv_2iuv_common(aTHX_ sv))
2323 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2324 PTR2UV(sv),SvIVX(sv)));
2325 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2329 =for apidoc sv_2uv_flags
2331 Return the unsigned integer value of an SV, doing any necessary string
2332 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2333 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2339 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2344 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2345 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2346 cache IVs just in case. */
2347 if (flags & SV_GMAGIC)
2352 return U_V(SvNVX(sv));
2353 if (SvPOKp(sv) && SvLEN(sv)) {
2356 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2358 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2359 == IS_NUMBER_IN_UV) {
2360 /* It's definitely an integer */
2361 if (!(numtype & IS_NUMBER_NEG))
2365 if (ckWARN(WARN_NUMERIC))
2368 return U_V(Atof(SvPVX_const(sv)));
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2375 } else if (SvTHINKFIRST(sv)) {
2379 SV *const tmpstr = AMG_CALLun(sv,numer);
2380 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2381 return SvUV(tmpstr);
2384 return PTR2UV(SvRV(sv));
2387 sv_force_normal_flags(sv, 0);
2389 if (SvREADONLY(sv) && !SvOK(sv)) {
2390 if (ckWARN(WARN_UNINITIALIZED))
2396 if (S_sv_2iuv_common(aTHX_ sv))
2400 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2401 PTR2UV(sv),SvUVX(sv)));
2402 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2408 Return the num value of an SV, doing any necessary string or integer
2409 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2416 Perl_sv_2nv(pTHX_ register SV *const sv)
2421 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2422 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2423 cache IVs just in case. */
2427 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2428 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2429 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2431 return Atof(SvPVX_const(sv));
2435 return (NV)SvUVX(sv);
2437 return (NV)SvIVX(sv);
2442 assert(SvTYPE(sv) >= SVt_PVMG);
2443 /* This falls through to the report_uninit near the end of the
2445 } else if (SvTHINKFIRST(sv)) {
2449 SV *const tmpstr = AMG_CALLun(sv,numer);
2450 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2451 return SvNV(tmpstr);
2454 return PTR2NV(SvRV(sv));
2457 sv_force_normal_flags(sv, 0);
2459 if (SvREADONLY(sv) && !SvOK(sv)) {
2460 if (ckWARN(WARN_UNINITIALIZED))
2465 if (SvTYPE(sv) < SVt_NV) {
2466 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2467 sv_upgrade(sv, SVt_NV);
2468 #ifdef USE_LONG_DOUBLE
2470 STORE_NUMERIC_LOCAL_SET_STANDARD();
2471 PerlIO_printf(Perl_debug_log,
2472 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2473 PTR2UV(sv), SvNVX(sv));
2474 RESTORE_NUMERIC_LOCAL();
2478 STORE_NUMERIC_LOCAL_SET_STANDARD();
2479 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2480 PTR2UV(sv), SvNVX(sv));
2481 RESTORE_NUMERIC_LOCAL();
2485 else if (SvTYPE(sv) < SVt_PVNV)
2486 sv_upgrade(sv, SVt_PVNV);
2491 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2492 #ifdef NV_PRESERVES_UV
2498 /* Only set the public NV OK flag if this NV preserves the IV */
2499 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2501 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2502 : (SvIVX(sv) == I_V(SvNVX(sv))))
2508 else if (SvPOKp(sv) && SvLEN(sv)) {
2510 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2511 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2513 #ifdef NV_PRESERVES_UV
2514 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2515 == IS_NUMBER_IN_UV) {
2516 /* It's definitely an integer */
2517 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2519 SvNV_set(sv, Atof(SvPVX_const(sv)));
2525 SvNV_set(sv, Atof(SvPVX_const(sv)));
2526 /* Only set the public NV OK flag if this NV preserves the value in
2527 the PV at least as well as an IV/UV would.
2528 Not sure how to do this 100% reliably. */
2529 /* if that shift count is out of range then Configure's test is
2530 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2532 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2533 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2534 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2535 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2536 /* Can't use strtol etc to convert this string, so don't try.
2537 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2540 /* value has been set. It may not be precise. */
2541 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2542 /* 2s complement assumption for (UV)IV_MIN */
2543 SvNOK_on(sv); /* Integer is too negative. */
2548 if (numtype & IS_NUMBER_NEG) {
2549 SvIV_set(sv, -(IV)value);
2550 } else if (value <= (UV)IV_MAX) {
2551 SvIV_set(sv, (IV)value);
2553 SvUV_set(sv, value);
2557 if (numtype & IS_NUMBER_NOT_INT) {
2558 /* I believe that even if the original PV had decimals,
2559 they are lost beyond the limit of the FP precision.
2560 However, neither is canonical, so both only get p
2561 flags. NWC, 2000/11/25 */
2562 /* Both already have p flags, so do nothing */
2564 const NV nv = SvNVX(sv);
2565 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2566 if (SvIVX(sv) == I_V(nv)) {
2569 /* It had no "." so it must be integer. */
2573 /* between IV_MAX and NV(UV_MAX).
2574 Could be slightly > UV_MAX */
2576 if (numtype & IS_NUMBER_NOT_INT) {
2577 /* UV and NV both imprecise. */
2579 const UV nv_as_uv = U_V(nv);
2581 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2590 /* It might be more code efficient to go through the entire logic above
2591 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2592 gets complex and potentially buggy, so more programmer efficient
2593 to do it this way, by turning off the public flags: */
2595 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2596 #endif /* NV_PRESERVES_UV */
2599 if (isGV_with_GP(sv)) {
2600 glob_2number((GV *)sv);
2604 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2606 assert (SvTYPE(sv) >= SVt_NV);
2607 /* Typically the caller expects that sv_any is not NULL now. */
2608 /* XXX Ilya implies that this is a bug in callers that assume this
2609 and ideally should be fixed. */
2612 #if defined(USE_LONG_DOUBLE)
2614 STORE_NUMERIC_LOCAL_SET_STANDARD();
2615 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2616 PTR2UV(sv), SvNVX(sv));
2617 RESTORE_NUMERIC_LOCAL();
2621 STORE_NUMERIC_LOCAL_SET_STANDARD();
2622 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2623 PTR2UV(sv), SvNVX(sv));
2624 RESTORE_NUMERIC_LOCAL();
2633 Return an SV with the numeric value of the source SV, doing any necessary
2634 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2635 access this function.
2641 Perl_sv_2num(pTHX_ register SV *const sv)
2643 PERL_ARGS_ASSERT_SV_2NUM;
2648 SV * const tmpsv = AMG_CALLun(sv,numer);
2649 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2650 return sv_2num(tmpsv);
2652 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2655 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2656 * UV as a string towards the end of buf, and return pointers to start and
2659 * We assume that buf is at least TYPE_CHARS(UV) long.
2663 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2665 char *ptr = buf + TYPE_CHARS(UV);
2666 char * const ebuf = ptr;
2669 PERL_ARGS_ASSERT_UIV_2BUF;
2681 *--ptr = '0' + (char)(uv % 10);
2690 =for apidoc sv_2pv_flags
2692 Returns a pointer to the string value of an SV, and sets *lp to its length.
2693 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2695 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2696 usually end up here too.
2702 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2712 if (SvGMAGICAL(sv)) {
2713 if (flags & SV_GMAGIC)
2718 if (flags & SV_MUTABLE_RETURN)
2719 return SvPVX_mutable(sv);
2720 if (flags & SV_CONST_RETURN)
2721 return (char *)SvPVX_const(sv);
2724 if (SvIOKp(sv) || SvNOKp(sv)) {
2725 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2730 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2731 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2733 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2740 #ifdef FIXNEGATIVEZERO
2741 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2747 SvUPGRADE(sv, SVt_PV);
2750 s = SvGROW_mutable(sv, len + 1);
2753 return (char*)memcpy(s, tbuf, len + 1);
2759 assert(SvTYPE(sv) >= SVt_PVMG);
2760 /* This falls through to the report_uninit near the end of the
2762 } else if (SvTHINKFIRST(sv)) {
2766 SV *const tmpstr = AMG_CALLun(sv,string);
2767 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2769 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2773 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2774 if (flags & SV_CONST_RETURN) {
2775 pv = (char *) SvPVX_const(tmpstr);
2777 pv = (flags & SV_MUTABLE_RETURN)
2778 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2781 *lp = SvCUR(tmpstr);
2783 pv = sv_2pv_flags(tmpstr, lp, flags);
2796 const SV *const referent = (SV*)SvRV(sv);
2800 retval = buffer = savepvn("NULLREF", len);
2801 } else if (SvTYPE(referent) == SVt_REGEXP) {
2802 const REGEXP * const re = (REGEXP *)referent;
2807 /* If the regex is UTF-8 we want the containing scalar to
2808 have an UTF-8 flag too */
2814 if ((seen_evals = RX_SEEN_EVALS(re)))
2815 PL_reginterp_cnt += seen_evals;
2818 *lp = RX_WRAPLEN(re);
2820 return RX_WRAPPED(re);
2822 const char *const typestr = sv_reftype(referent, 0);
2823 const STRLEN typelen = strlen(typestr);
2824 UV addr = PTR2UV(referent);
2825 const char *stashname = NULL;
2826 STRLEN stashnamelen = 0; /* hush, gcc */
2827 const char *buffer_end;
2829 if (SvOBJECT(referent)) {
2830 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2833 stashname = HEK_KEY(name);
2834 stashnamelen = HEK_LEN(name);
2836 if (HEK_UTF8(name)) {
2842 stashname = "__ANON__";
2845 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2846 + 2 * sizeof(UV) + 2 /* )\0 */;
2848 len = typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2852 Newx(buffer, len, char);
2853 buffer_end = retval = buffer + len;
2855 /* Working backwards */
2859 *--retval = PL_hexdigit[addr & 15];
2860 } while (addr >>= 4);
2866 memcpy(retval, typestr, typelen);
2870 retval -= stashnamelen;
2871 memcpy(retval, stashname, stashnamelen);
2873 /* retval may not neccesarily have reached the start of the
2875 assert (retval >= buffer);
2877 len = buffer_end - retval - 1; /* -1 for that \0 */
2885 if (SvREADONLY(sv) && !SvOK(sv)) {
2888 if (flags & SV_UNDEF_RETURNS_NULL)
2890 if (ckWARN(WARN_UNINITIALIZED))
2895 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2896 /* I'm assuming that if both IV and NV are equally valid then
2897 converting the IV is going to be more efficient */
2898 const U32 isUIOK = SvIsUV(sv);
2899 char buf[TYPE_CHARS(UV)];
2903 if (SvTYPE(sv) < SVt_PVIV)
2904 sv_upgrade(sv, SVt_PVIV);
2905 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2907 /* inlined from sv_setpvn */
2908 s = SvGROW_mutable(sv, len + 1);
2909 Move(ptr, s, len, char);
2913 else if (SvNOKp(sv)) {
2914 const int olderrno = errno;
2915 if (SvTYPE(sv) < SVt_PVNV)
2916 sv_upgrade(sv, SVt_PVNV);
2917 /* The +20 is pure guesswork. Configure test needed. --jhi */
2918 s = SvGROW_mutable(sv, NV_DIG + 20);
2919 /* some Xenix systems wipe out errno here */
2921 if (SvNVX(sv) == 0.0)
2922 my_strlcpy(s, "0", SvLEN(sv));
2926 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2929 #ifdef FIXNEGATIVEZERO
2930 if (*s == '-' && s[1] == '0' && !s[2]) {
2942 if (isGV_with_GP(sv))
2943 return glob_2pv((GV *)sv, lp);
2947 if (flags & SV_UNDEF_RETURNS_NULL)
2949 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2951 if (SvTYPE(sv) < SVt_PV)
2952 /* Typically the caller expects that sv_any is not NULL now. */
2953 sv_upgrade(sv, SVt_PV);
2957 const STRLEN len = s - SvPVX_const(sv);
2963 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2964 PTR2UV(sv),SvPVX_const(sv)));
2965 if (flags & SV_CONST_RETURN)
2966 return (char *)SvPVX_const(sv);
2967 if (flags & SV_MUTABLE_RETURN)
2968 return SvPVX_mutable(sv);
2973 =for apidoc sv_copypv
2975 Copies a stringified representation of the source SV into the
2976 destination SV. Automatically performs any necessary mg_get and
2977 coercion of numeric values into strings. Guaranteed to preserve
2978 UTF8 flag even from overloaded objects. Similar in nature to
2979 sv_2pv[_flags] but operates directly on an SV instead of just the
2980 string. Mostly uses sv_2pv_flags to do its work, except when that
2981 would lose the UTF-8'ness of the PV.
2987 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2990 const char * const s = SvPV_const(ssv,len);
2992 PERL_ARGS_ASSERT_SV_COPYPV;
2994 sv_setpvn(dsv,s,len);
3002 =for apidoc sv_2pvbyte
3004 Return a pointer to the byte-encoded representation of the SV, and set *lp
3005 to its length. May cause the SV to be downgraded from UTF-8 as a
3008 Usually accessed via the C<SvPVbyte> macro.
3014 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3016 PERL_ARGS_ASSERT_SV_2PVBYTE;
3018 sv_utf8_downgrade(sv,0);
3019 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3023 =for apidoc sv_2pvutf8
3025 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3026 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3028 Usually accessed via the C<SvPVutf8> macro.
3034 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3036 PERL_ARGS_ASSERT_SV_2PVUTF8;
3038 sv_utf8_upgrade(sv);
3039 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3044 =for apidoc sv_2bool
3046 This function is only called on magical items, and is only used by
3047 sv_true() or its macro equivalent.
3053 Perl_sv_2bool(pTHX_ register SV *const sv)
3057 PERL_ARGS_ASSERT_SV_2BOOL;
3065 SV * const tmpsv = AMG_CALLun(sv,bool_);
3066 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3067 return (bool)SvTRUE(tmpsv);
3069 return SvRV(sv) != 0;
3072 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3074 (*sv->sv_u.svu_pv > '0' ||
3075 Xpvtmp->xpv_cur > 1 ||
3076 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3083 return SvIVX(sv) != 0;
3086 return SvNVX(sv) != 0.0;
3088 if (isGV_with_GP(sv))
3098 =for apidoc sv_utf8_upgrade
3100 Converts the PV of an SV to its UTF-8-encoded form.
3101 Forces the SV to string form if it is not already.
3102 Always sets the SvUTF8 flag to avoid future validity checks even
3103 if all the bytes have hibit clear.
3105 This is not as a general purpose byte encoding to Unicode interface:
3106 use the Encode extension for that.
3108 =for apidoc sv_utf8_upgrade_flags
3110 Converts the PV of an SV to its UTF-8-encoded form.
3111 Forces the SV to string form if it is not already.
3112 Always sets the SvUTF8 flag to avoid future validity checks even
3113 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3114 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3115 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3117 This is not as a general purpose byte encoding to Unicode interface:
3118 use the Encode extension for that.
3124 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3128 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3130 if (sv == &PL_sv_undef)
3134 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3135 (void) sv_2pv_flags(sv,&len, flags);
3139 (void) SvPV_force(sv,len);
3148 sv_force_normal_flags(sv, 0);
3151 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3152 sv_recode_to_utf8(sv, PL_encoding);
3153 else { /* Assume Latin-1/EBCDIC */
3154 /* This function could be much more efficient if we
3155 * had a FLAG in SVs to signal if there are any hibit
3156 * chars in the PV. Given that there isn't such a flag
3157 * make the loop as fast as possible. */
3158 const U8 * const s = (U8 *) SvPVX_const(sv);
3159 const U8 * const e = (U8 *) SvEND(sv);
3164 /* Check for hi bit */
3165 if (!NATIVE_IS_INVARIANT(ch)) {
3166 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3167 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3169 SvPV_free(sv); /* No longer using what was there before. */
3170 SvPV_set(sv, (char*)recoded);
3171 SvCUR_set(sv, len - 1);
3172 SvLEN_set(sv, len); /* No longer know the real size. */
3176 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3183 =for apidoc sv_utf8_downgrade
3185 Attempts to convert the PV of an SV from characters to bytes.
3186 If the PV contains a character beyond byte, this conversion will fail;
3187 in this case, either returns false or, if C<fail_ok> is not
3190 This is not as a general purpose Unicode to byte encoding interface:
3191 use the Encode extension for that.
3197 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3201 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3203 if (SvPOKp(sv) && SvUTF8(sv)) {
3209 sv_force_normal_flags(sv, 0);
3211 s = (U8 *) SvPV(sv, len);
3212 if (!utf8_to_bytes(s, &len)) {
3217 Perl_croak(aTHX_ "Wide character in %s",
3220 Perl_croak(aTHX_ "Wide character");
3231 =for apidoc sv_utf8_encode
3233 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3234 flag off so that it looks like octets again.
3240 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3242 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3245 sv_force_normal_flags(sv, 0);
3247 if (SvREADONLY(sv)) {
3248 Perl_croak(aTHX_ PL_no_modify);
3250 (void) sv_utf8_upgrade(sv);
3255 =for apidoc sv_utf8_decode
3257 If the PV of the SV is an octet sequence in UTF-8
3258 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3259 so that it looks like a character. If the PV contains only single-byte
3260 characters, the C<SvUTF8> flag stays being off.
3261 Scans PV for validity and returns false if the PV is invalid UTF-8.
3267 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3269 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3275 /* The octets may have got themselves encoded - get them back as
3278 if (!sv_utf8_downgrade(sv, TRUE))
3281 /* it is actually just a matter of turning the utf8 flag on, but
3282 * we want to make sure everything inside is valid utf8 first.
3284 c = (const U8 *) SvPVX_const(sv);
3285 if (!is_utf8_string(c, SvCUR(sv)+1))
3287 e = (const U8 *) SvEND(sv);
3290 if (!UTF8_IS_INVARIANT(ch)) {
3300 =for apidoc sv_setsv
3302 Copies the contents of the source SV C<ssv> into the destination SV
3303 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3304 function if the source SV needs to be reused. Does not handle 'set' magic.
3305 Loosely speaking, it performs a copy-by-value, obliterating any previous
3306 content of the destination.
3308 You probably want to use one of the assortment of wrappers, such as
3309 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3310 C<SvSetMagicSV_nosteal>.
3312 =for apidoc sv_setsv_flags
3314 Copies the contents of the source SV C<ssv> into the destination SV
3315 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3316 function if the source SV needs to be reused. Does not handle 'set' magic.
3317 Loosely speaking, it performs a copy-by-value, obliterating any previous
3318 content of the destination.
3319 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3320 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3321 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3322 and C<sv_setsv_nomg> are implemented in terms of this function.
3324 You probably want to use one of the assortment of wrappers, such as
3325 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3326 C<SvSetMagicSV_nosteal>.
3328 This is the primary function for copying scalars, and most other
3329 copy-ish functions and macros use this underneath.
3335 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3337 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3339 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3341 if (dtype != SVt_PVGV) {
3342 const char * const name = GvNAME(sstr);
3343 const STRLEN len = GvNAMELEN(sstr);
3345 if (dtype >= SVt_PV) {
3351 SvUPGRADE(dstr, SVt_PVGV);
3352 (void)SvOK_off(dstr);
3353 /* FIXME - why are we doing this, then turning it off and on again
3355 isGV_with_GP_on(dstr);
3357 GvSTASH(dstr) = GvSTASH(sstr);
3359 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3360 gv_name_set((GV *)dstr, name, len, GV_ADD);
3361 SvFAKE_on(dstr); /* can coerce to non-glob */
3364 #ifdef GV_UNIQUE_CHECK
3365 if (GvUNIQUE((GV*)dstr)) {
3366 Perl_croak(aTHX_ PL_no_modify);
3370 if(GvGP((GV*)sstr)) {
3371 /* If source has method cache entry, clear it */
3373 SvREFCNT_dec(GvCV(sstr));
3377 /* If source has a real method, then a method is
3379 else if(GvCV((GV*)sstr)) {
3384 /* If dest already had a real method, that's a change as well */
3385 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3389 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3393 isGV_with_GP_off(dstr);
3394 (void)SvOK_off(dstr);
3395 isGV_with_GP_on(dstr);
3396 GvINTRO_off(dstr); /* one-shot flag */
3397 GvGP(dstr) = gp_ref(GvGP(sstr));
3398 if (SvTAINTED(sstr))
3400 if (GvIMPORTED(dstr) != GVf_IMPORTED
3401 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3403 GvIMPORTED_on(dstr);
3406 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3407 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3412 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3414 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3416 const int intro = GvINTRO(dstr);
3419 const U32 stype = SvTYPE(sref);
3421 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3423 #ifdef GV_UNIQUE_CHECK
3424 if (GvUNIQUE((GV*)dstr)) {
3425 Perl_croak(aTHX_ PL_no_modify);
3430 GvINTRO_off(dstr); /* one-shot flag */
3431 GvLINE(dstr) = CopLINE(PL_curcop);
3432 GvEGV(dstr) = (GV*)dstr;
3437 location = (SV **) &GvCV(dstr);
3438 import_flag = GVf_IMPORTED_CV;
3441 location = (SV **) &GvHV(dstr);
3442 import_flag = GVf_IMPORTED_HV;
3445 location = (SV **) &GvAV(dstr);
3446 import_flag = GVf_IMPORTED_AV;
3449 location = (SV **) &GvIOp(dstr);
3452 location = (SV **) &GvFORM(dstr);
3454 location = &GvSV(dstr);
3455 import_flag = GVf_IMPORTED_SV;
3458 if (stype == SVt_PVCV) {
3459 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3460 if (GvCVGEN(dstr)) {
3461 SvREFCNT_dec(GvCV(dstr));
3463 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3466 SAVEGENERICSV(*location);
3470 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3471 CV* const cv = (CV*)*location;
3473 if (!GvCVGEN((GV*)dstr) &&
3474 (CvROOT(cv) || CvXSUB(cv)))
3476 /* Redefining a sub - warning is mandatory if
3477 it was a const and its value changed. */
3478 if (CvCONST(cv) && CvCONST((CV*)sref)
3479 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3481 /* They are 2 constant subroutines generated from
3482 the same constant. This probably means that
3483 they are really the "same" proxy subroutine
3484 instantiated in 2 places. Most likely this is
3485 when a constant is exported twice. Don't warn.
3488 else if (ckWARN(WARN_REDEFINE)
3490 && (!CvCONST((CV*)sref)
3491 || sv_cmp(cv_const_sv(cv),
3492 cv_const_sv((CV*)sref))))) {
3493 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3496 ? "Constant subroutine %s::%s redefined"
3497 : "Subroutine %s::%s redefined"),
3498 HvNAME_get(GvSTASH((GV*)dstr)),
3499 GvENAME((GV*)dstr));
3503 cv_ckproto_len(cv, (GV*)dstr,
3504 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3505 SvPOK(sref) ? SvCUR(sref) : 0);
3507 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3508 GvASSUMECV_on(dstr);
3509 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3512 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3513 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3514 GvFLAGS(dstr) |= import_flag;
3519 if (SvTAINTED(sstr))
3525 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3528 register U32 sflags;
3530 register svtype stype;
3532 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3537 if (SvIS_FREED(dstr)) {
3538 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3539 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3541 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3543 sstr = &PL_sv_undef;
3544 if (SvIS_FREED(sstr)) {
3545 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3546 (void*)sstr, (void*)dstr);
3548 stype = SvTYPE(sstr);
3549 dtype = SvTYPE(dstr);
3551 (void)SvAMAGIC_off(dstr);
3554 /* need to nuke the magic */
3556 SvRMAGICAL_off(dstr);
3559 /* There's a lot of redundancy below but we're going for speed here */
3564 if (dtype != SVt_PVGV) {
3565 (void)SvOK_off(dstr);
3573 sv_upgrade(dstr, SVt_IV);
3577 sv_upgrade(dstr, SVt_PVIV);
3580 goto end_of_first_switch;
3582 (void)SvIOK_only(dstr);
3583 SvIV_set(dstr, SvIVX(sstr));
3586 /* SvTAINTED can only be true if the SV has taint magic, which in
3587 turn means that the SV type is PVMG (or greater). This is the
3588 case statement for SVt_IV, so this cannot be true (whatever gcov
3590 assert(!SvTAINTED(sstr));
3595 if (dtype < SVt_PV && dtype != SVt_IV)
3596 sv_upgrade(dstr, SVt_IV);
3604 sv_upgrade(dstr, SVt_NV);
3608 sv_upgrade(dstr, SVt_PVNV);
3611 goto end_of_first_switch;
3613 SvNV_set(dstr, SvNVX(sstr));
3614 (void)SvNOK_only(dstr);
3615 /* SvTAINTED can only be true if the SV has taint magic, which in
3616 turn means that the SV type is PVMG (or greater). This is the
3617 case statement for SVt_NV, so this cannot be true (whatever gcov
3619 assert(!SvTAINTED(sstr));
3625 #ifdef PERL_OLD_COPY_ON_WRITE
3626 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3627 if (dtype < SVt_PVIV)
3628 sv_upgrade(dstr, SVt_PVIV);
3636 sv_upgrade(dstr, SVt_PV);
3639 if (dtype < SVt_PVIV)
3640 sv_upgrade(dstr, SVt_PVIV);
3643 if (dtype < SVt_PVNV)
3644 sv_upgrade(dstr, SVt_PVNV);
3648 const char * const type = sv_reftype(sstr,0);
3650 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3652 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3656 /* case SVt_BIND: */
3659 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3660 glob_assign_glob(dstr, sstr, dtype);
3663 /* SvVALID means that this PVGV is playing at being an FBM. */
3667 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3669 if (SvTYPE(sstr) != stype) {
3670 stype = SvTYPE(sstr);
3671 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3672 glob_assign_glob(dstr, sstr, dtype);
3677 if (stype == SVt_PVLV)
3678 SvUPGRADE(dstr, SVt_PVNV);
3680 SvUPGRADE(dstr, (svtype)stype);
3682 end_of_first_switch:
3684 /* dstr may have been upgraded. */
3685 dtype = SvTYPE(dstr);
3686 sflags = SvFLAGS(sstr);
3688 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3689 /* Assigning to a subroutine sets the prototype. */
3692 const char *const ptr = SvPV_const(sstr, len);
3694 SvGROW(dstr, len + 1);
3695 Copy(ptr, SvPVX(dstr), len + 1, char);
3696 SvCUR_set(dstr, len);
3698 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3702 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3703 const char * const type = sv_reftype(dstr,0);
3705 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3707 Perl_croak(aTHX_ "Cannot copy to %s", type);
3708 } else if (sflags & SVf_ROK) {
3709 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3710 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3713 if (GvIMPORTED(dstr) != GVf_IMPORTED
3714 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3716 GvIMPORTED_on(dstr);
3721 glob_assign_glob(dstr, sstr, dtype);
3725 if (dtype >= SVt_PV) {
3726 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3727 glob_assign_ref(dstr, sstr);
3730 if (SvPVX_const(dstr)) {
3736 (void)SvOK_off(dstr);
3737 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3738 SvFLAGS(dstr) |= sflags & SVf_ROK;
3739 assert(!(sflags & SVp_NOK));
3740 assert(!(sflags & SVp_IOK));
3741 assert(!(sflags & SVf_NOK));
3742 assert(!(sflags & SVf_IOK));
3744 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3745 if (!(sflags & SVf_OK)) {
3746 if (ckWARN(WARN_MISC))
3747 Perl_warner(aTHX_ packWARN(WARN_MISC),
3748 "Undefined value assigned to typeglob");
3751 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3752 if (dstr != (SV*)gv) {
3755 GvGP(dstr) = gp_ref(GvGP(gv));
3759 else if (sflags & SVp_POK) {
3763 * Check to see if we can just swipe the string. If so, it's a
3764 * possible small lose on short strings, but a big win on long ones.
3765 * It might even be a win on short strings if SvPVX_const(dstr)
3766 * has to be allocated and SvPVX_const(sstr) has to be freed.
3767 * Likewise if we can set up COW rather than doing an actual copy, we
3768 * drop to the else clause, as the swipe code and the COW setup code
3769 * have much in common.
3772 /* Whichever path we take through the next code, we want this true,
3773 and doing it now facilitates the COW check. */
3774 (void)SvPOK_only(dstr);
3777 /* If we're already COW then this clause is not true, and if COW
3778 is allowed then we drop down to the else and make dest COW
3779 with us. If caller hasn't said that we're allowed to COW
3780 shared hash keys then we don't do the COW setup, even if the
3781 source scalar is a shared hash key scalar. */
3782 (((flags & SV_COW_SHARED_HASH_KEYS)
3783 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3784 : 1 /* If making a COW copy is forbidden then the behaviour we
3785 desire is as if the source SV isn't actually already
3786 COW, even if it is. So we act as if the source flags
3787 are not COW, rather than actually testing them. */
3789 #ifndef PERL_OLD_COPY_ON_WRITE
3790 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3791 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3792 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3793 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3794 but in turn, it's somewhat dead code, never expected to go
3795 live, but more kept as a placeholder on how to do it better
3796 in a newer implementation. */
3797 /* If we are COW and dstr is a suitable target then we drop down
3798 into the else and make dest a COW of us. */
3799 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3804 (sflags & SVs_TEMP) && /* slated for free anyway? */
3805 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3806 (!(flags & SV_NOSTEAL)) &&
3807 /* and we're allowed to steal temps */
3808 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3809 SvLEN(sstr) && /* and really is a string */
3810 /* and won't be needed again, potentially */
3811 !(PL_op && PL_op->op_type == OP_AASSIGN))
3812 #ifdef PERL_OLD_COPY_ON_WRITE
3813 && ((flags & SV_COW_SHARED_HASH_KEYS)
3814 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3815 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3816 && SvTYPE(sstr) >= SVt_PVIV))
3820 /* Failed the swipe test, and it's not a shared hash key either.
3821 Have to copy the string. */
3822 STRLEN len = SvCUR(sstr);
3823 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3824 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3825 SvCUR_set(dstr, len);
3826 *SvEND(dstr) = '\0';
3828 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3830 /* Either it's a shared hash key, or it's suitable for
3831 copy-on-write or we can swipe the string. */
3833 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3837 #ifdef PERL_OLD_COPY_ON_WRITE
3839 /* I believe I should acquire a global SV mutex if
3840 it's a COW sv (not a shared hash key) to stop
3841 it going un copy-on-write.
3842 If the source SV has gone un copy on write between up there
3843 and down here, then (assert() that) it is of the correct
3844 form to make it copy on write again */
3845 if ((sflags & (SVf_FAKE | SVf_READONLY))
3846 != (SVf_FAKE | SVf_READONLY)) {
3847 SvREADONLY_on(sstr);
3849 /* Make the source SV into a loop of 1.
3850 (about to become 2) */
3851 SV_COW_NEXT_SV_SET(sstr, sstr);
3855 /* Initial code is common. */
3856 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3861 /* making another shared SV. */
3862 STRLEN cur = SvCUR(sstr);
3863 STRLEN len = SvLEN(sstr);
3864 #ifdef PERL_OLD_COPY_ON_WRITE
3866 assert (SvTYPE(dstr) >= SVt_PVIV);
3867 /* SvIsCOW_normal */
3868 /* splice us in between source and next-after-source. */
3869 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3870 SV_COW_NEXT_SV_SET(sstr, dstr);
3871 SvPV_set(dstr, SvPVX_mutable(sstr));
3875 /* SvIsCOW_shared_hash */
3876 DEBUG_C(PerlIO_printf(Perl_debug_log,
3877 "Copy on write: Sharing hash\n"));
3879 assert (SvTYPE(dstr) >= SVt_PV);
3881 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3883 SvLEN_set(dstr, len);
3884 SvCUR_set(dstr, cur);
3885 SvREADONLY_on(dstr);
3887 /* Relesase a global SV mutex. */
3890 { /* Passes the swipe test. */
3891 SvPV_set(dstr, SvPVX_mutable(sstr));
3892 SvLEN_set(dstr, SvLEN(sstr));
3893 SvCUR_set(dstr, SvCUR(sstr));
3896 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3897 SvPV_set(sstr, NULL);
3903 if (sflags & SVp_NOK) {
3904 SvNV_set(dstr, SvNVX(sstr));
3906 if (sflags & SVp_IOK) {
3907 SvIV_set(dstr, SvIVX(sstr));
3908 /* Must do this otherwise some other overloaded use of 0x80000000
3909 gets confused. I guess SVpbm_VALID */
3910 if (sflags & SVf_IVisUV)
3913 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3915 const MAGIC * const smg = SvVSTRING_mg(sstr);
3917 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3918 smg->mg_ptr, smg->mg_len);
3919 SvRMAGICAL_on(dstr);
3923 else if (sflags & (SVp_IOK|SVp_NOK)) {
3924 (void)SvOK_off(dstr);
3925 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3926 if (sflags & SVp_IOK) {
3927 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3928 SvIV_set(dstr, SvIVX(sstr));
3930 if (sflags & SVp_NOK) {
3931 SvNV_set(dstr, SvNVX(sstr));
3935 if (isGV_with_GP(sstr)) {
3936 /* This stringification rule for globs is spread in 3 places.
3937 This feels bad. FIXME. */
3938 const U32 wasfake = sflags & SVf_FAKE;
3940 /* FAKE globs can get coerced, so need to turn this off
3941 temporarily if it is on. */
3943 gv_efullname3(dstr, (GV *)sstr, "*");
3944 SvFLAGS(sstr) |= wasfake;
3947 (void)SvOK_off(dstr);
3949 if (SvTAINTED(sstr))
3954 =for apidoc sv_setsv_mg
3956 Like C<sv_setsv>, but also handles 'set' magic.
3962 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3964 PERL_ARGS_ASSERT_SV_SETSV_MG;
3966 sv_setsv(dstr,sstr);
3970 #ifdef PERL_OLD_COPY_ON_WRITE
3972 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3974 STRLEN cur = SvCUR(sstr);
3975 STRLEN len = SvLEN(sstr);
3976 register char *new_pv;
3978 PERL_ARGS_ASSERT_SV_SETSV_COW;
3981 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3982 (void*)sstr, (void*)dstr);
3989 if (SvTHINKFIRST(dstr))
3990 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3991 else if (SvPVX_const(dstr))
3992 Safefree(SvPVX_const(dstr));
3996 SvUPGRADE(dstr, SVt_PVIV);
3998 assert (SvPOK(sstr));
3999 assert (SvPOKp(sstr));
4000 assert (!SvIOK(sstr));
4001 assert (!SvIOKp(sstr));
4002 assert (!SvNOK(sstr));
4003 assert (!SvNOKp(sstr));
4005 if (SvIsCOW(sstr)) {
4007 if (SvLEN(sstr) == 0) {
4008 /* source is a COW shared hash key. */
4009 DEBUG_C(PerlIO_printf(Perl_debug_log,
4010 "Fast copy on write: Sharing hash\n"));
4011 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4014 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4016 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4017 SvUPGRADE(sstr, SVt_PVIV);
4018 SvREADONLY_on(sstr);
4020 DEBUG_C(PerlIO_printf(Perl_debug_log,
4021 "Fast copy on write: Converting sstr to COW\n"));
4022 SV_COW_NEXT_SV_SET(dstr, sstr);
4024 SV_COW_NEXT_SV_SET(sstr, dstr);
4025 new_pv = SvPVX_mutable(sstr);
4028 SvPV_set(dstr, new_pv);
4029 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4032 SvLEN_set(dstr, len);
4033 SvCUR_set(dstr, cur);
4042 =for apidoc sv_setpvn
4044 Copies a string into an SV. The C<len> parameter indicates the number of
4045 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4046 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4052 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4055 register char *dptr;
4057 PERL_ARGS_ASSERT_SV_SETPVN;
4059 SV_CHECK_THINKFIRST_COW_DROP(sv);
4065 /* len is STRLEN which is unsigned, need to copy to signed */
4068 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4070 SvUPGRADE(sv, SVt_PV);
4072 dptr = SvGROW(sv, len + 1);
4073 Move(ptr,dptr,len,char);
4076 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4081 =for apidoc sv_setpvn_mg
4083 Like C<sv_setpvn>, but also handles 'set' magic.
4089 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4091 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4093 sv_setpvn(sv,ptr,len);
4098 =for apidoc sv_setpv
4100 Copies a string into an SV. The string must be null-terminated. Does not
4101 handle 'set' magic. See C<sv_setpv_mg>.
4107 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4110 register STRLEN len;
4112 PERL_ARGS_ASSERT_SV_SETPV;
4114 SV_CHECK_THINKFIRST_COW_DROP(sv);
4120 SvUPGRADE(sv, SVt_PV);
4122 SvGROW(sv, len + 1);
4123 Move(ptr,SvPVX(sv),len+1,char);
4125 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4130 =for apidoc sv_setpv_mg
4132 Like C<sv_setpv>, but also handles 'set' magic.
4138 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4140 PERL_ARGS_ASSERT_SV_SETPV_MG;
4147 =for apidoc sv_usepvn_flags
4149 Tells an SV to use C<ptr> to find its string value. Normally the
4150 string is stored inside the SV but sv_usepvn allows the SV to use an
4151 outside string. The C<ptr> should point to memory that was allocated
4152 by C<malloc>. The string length, C<len>, must be supplied. By default
4153 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4154 so that pointer should not be freed or used by the programmer after
4155 giving it to sv_usepvn, and neither should any pointers from "behind"
4156 that pointer (e.g. ptr + 1) be used.
4158 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4159 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4160 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4161 C<len>, and already meets the requirements for storing in C<SvPVX>)
4167 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4172 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4174 SV_CHECK_THINKFIRST_COW_DROP(sv);
4175 SvUPGRADE(sv, SVt_PV);
4178 if (flags & SV_SMAGIC)
4182 if (SvPVX_const(sv))
4186 if (flags & SV_HAS_TRAILING_NUL)
4187 assert(ptr[len] == '\0');
4190 allocate = (flags & SV_HAS_TRAILING_NUL)
4192 #ifdef Perl_safesysmalloc_size
4195 PERL_STRLEN_ROUNDUP(len + 1);
4197 if (flags & SV_HAS_TRAILING_NUL) {
4198 /* It's long enough - do nothing.
4199 Specfically Perl_newCONSTSUB is relying on this. */
4202 /* Force a move to shake out bugs in callers. */
4203 char *new_ptr = (char*)safemalloc(allocate);
4204 Copy(ptr, new_ptr, len, char);
4205 PoisonFree(ptr,len,char);
4209 ptr = (char*) saferealloc (ptr, allocate);
4212 #ifdef Perl_safesysmalloc_size
4213 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4215 SvLEN_set(sv, allocate);
4219 if (!(flags & SV_HAS_TRAILING_NUL)) {
4222 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4224 if (flags & SV_SMAGIC)
4228 #ifdef PERL_OLD_COPY_ON_WRITE
4229 /* Need to do this *after* making the SV normal, as we need the buffer
4230 pointer to remain valid until after we've copied it. If we let go too early,
4231 another thread could invalidate it by unsharing last of the same hash key
4232 (which it can do by means other than releasing copy-on-write Svs)
4233 or by changing the other copy-on-write SVs in the loop. */
4235 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4237 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4239 { /* this SV was SvIsCOW_normal(sv) */
4240 /* we need to find the SV pointing to us. */
4241 SV *current = SV_COW_NEXT_SV(after);
4243 if (current == sv) {
4244 /* The SV we point to points back to us (there were only two of us
4246 Hence other SV is no longer copy on write either. */
4248 SvREADONLY_off(after);
4250 /* We need to follow the pointers around the loop. */
4252 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4255 /* don't loop forever if the structure is bust, and we have
4256 a pointer into a closed loop. */
4257 assert (current != after);
4258 assert (SvPVX_const(current) == pvx);
4260 /* Make the SV before us point to the SV after us. */
4261 SV_COW_NEXT_SV_SET(current, after);
4267 =for apidoc sv_force_normal_flags
4269 Undo various types of fakery on an SV: if the PV is a shared string, make
4270 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4271 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4272 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4273 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4274 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4275 set to some other value.) In addition, the C<flags> parameter gets passed to
4276 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4277 with flags set to 0.
4283 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4287 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4289 #ifdef PERL_OLD_COPY_ON_WRITE
4290 if (SvREADONLY(sv)) {
4291 /* At this point I believe I should acquire a global SV mutex. */
4293 const char * const pvx = SvPVX_const(sv);
4294 const STRLEN len = SvLEN(sv);
4295 const STRLEN cur = SvCUR(sv);
4296 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4297 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4298 we'll fail an assertion. */
4299 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4302 PerlIO_printf(Perl_debug_log,
4303 "Copy on write: Force normal %ld\n",
4309 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4312 if (flags & SV_COW_DROP_PV) {
4313 /* OK, so we don't need to copy our buffer. */
4316 SvGROW(sv, cur + 1);
4317 Move(pvx,SvPVX(sv),cur,char);
4322 sv_release_COW(sv, pvx, next);
4324 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4330 else if (IN_PERL_RUNTIME)
4331 Perl_croak(aTHX_ PL_no_modify);
4332 /* At this point I believe that I can drop the global SV mutex. */
4335 if (SvREADONLY(sv)) {
4337 const char * const pvx = SvPVX_const(sv);
4338 const STRLEN len = SvCUR(sv);
4343 SvGROW(sv, len + 1);
4344 Move(pvx,SvPVX(sv),len,char);
4346 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4348 else if (IN_PERL_RUNTIME)
4349 Perl_croak(aTHX_ PL_no_modify);
4353 sv_unref_flags(sv, flags);
4354 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4361 Efficient removal of characters from the beginning of the string buffer.
4362 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4363 the string buffer. The C<ptr> becomes the first character of the adjusted
4364 string. Uses the "OOK hack".
4365 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4366 refer to the same chunk of data.
4372 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4378 const U8 *real_start;
4381 PERL_ARGS_ASSERT_SV_CHOP;
4383 if (!ptr || !SvPOKp(sv))
4385 delta = ptr - SvPVX_const(sv);
4387 /* Nothing to do. */
4390 assert(ptr > SvPVX_const(sv));
4391 SV_CHECK_THINKFIRST(sv);
4394 if (!SvLEN(sv)) { /* make copy of shared string */
4395 const char *pvx = SvPVX_const(sv);
4396 const STRLEN len = SvCUR(sv);
4397 SvGROW(sv, len + 1);
4398 Move(pvx,SvPVX(sv),len,char);
4401 SvFLAGS(sv) |= SVf_OOK;
4404 SvOOK_offset(sv, old_delta);
4406 SvLEN_set(sv, SvLEN(sv) - delta);
4407 SvCUR_set(sv, SvCUR(sv) - delta);
4408 SvPV_set(sv, SvPVX(sv) + delta);
4410 p = (U8 *)SvPVX_const(sv);
4415 real_start = p - delta;
4419 if (delta < 0x100) {
4423 p -= sizeof(STRLEN);
4424 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4428 /* Fill the preceding buffer with sentinals to verify that no-one is
4430 while (p > real_start) {
4438 =for apidoc sv_catpvn
4440 Concatenates the string onto the end of the string which is in the SV. The
4441 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4442 status set, then the bytes appended should be valid UTF-8.
4443 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4445 =for apidoc sv_catpvn_flags
4447 Concatenates the string onto the end of the string which is in the SV. The
4448 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4449 status set, then the bytes appended should be valid UTF-8.
4450 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4451 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4452 in terms of this function.
4458 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4462 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4464 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4466 SvGROW(dsv, dlen + slen + 1);
4468 sstr = SvPVX_const(dsv);
4469 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4470 SvCUR_set(dsv, SvCUR(dsv) + slen);
4472 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4474 if (flags & SV_SMAGIC)
4479 =for apidoc sv_catsv
4481 Concatenates the string from SV C<ssv> onto the end of the string in
4482 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4483 not 'set' magic. See C<sv_catsv_mg>.
4485 =for apidoc sv_catsv_flags
4487 Concatenates the string from SV C<ssv> onto the end of the string in
4488 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4489 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4490 and C<sv_catsv_nomg> are implemented in terms of this function.
4495 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4499 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4503 const char *spv = SvPV_const(ssv, slen);
4505 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4506 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4507 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4508 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4509 dsv->sv_flags doesn't have that bit set.
4510 Andy Dougherty 12 Oct 2001
4512 const I32 sutf8 = DO_UTF8(ssv);
4515 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4517 dutf8 = DO_UTF8(dsv);
4519 if (dutf8 != sutf8) {
4521 /* Not modifying source SV, so taking a temporary copy. */
4522 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4524 sv_utf8_upgrade(csv);
4525 spv = SvPV_const(csv, slen);
4528 sv_utf8_upgrade_nomg(dsv);
4530 sv_catpvn_nomg(dsv, spv, slen);
4533 if (flags & SV_SMAGIC)
4538 =for apidoc sv_catpv
4540 Concatenates the string onto the end of the string which is in the SV.
4541 If the SV has the UTF-8 status set, then the bytes appended should be
4542 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4547 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4550 register STRLEN len;
4554 PERL_ARGS_ASSERT_SV_CATPV;
4558 junk = SvPV_force(sv, tlen);
4560 SvGROW(sv, tlen + len + 1);
4562 ptr = SvPVX_const(sv);
4563 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4564 SvCUR_set(sv, SvCUR(sv) + len);
4565 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4570 =for apidoc sv_catpv_mg
4572 Like C<sv_catpv>, but also handles 'set' magic.
4578 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4580 PERL_ARGS_ASSERT_SV_CATPV_MG;
4589 Creates a new SV. A non-zero C<len> parameter indicates the number of
4590 bytes of preallocated string space the SV should have. An extra byte for a
4591 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4592 space is allocated.) The reference count for the new SV is set to 1.
4594 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4595 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4596 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4597 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4598 modules supporting older perls.
4604 Perl_newSV(pTHX_ const STRLEN len)
4611 sv_upgrade(sv, SVt_PV);
4612 SvGROW(sv, len + 1);
4617 =for apidoc sv_magicext
4619 Adds magic to an SV, upgrading it if necessary. Applies the
4620 supplied vtable and returns a pointer to the magic added.
4622 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4623 In particular, you can add magic to SvREADONLY SVs, and add more than
4624 one instance of the same 'how'.
4626 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4627 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4628 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4629 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4631 (This is now used as a subroutine by C<sv_magic>.)
4636 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4637 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4642 PERL_ARGS_ASSERT_SV_MAGICEXT;
4644 SvUPGRADE(sv, SVt_PVMG);
4645 Newxz(mg, 1, MAGIC);
4646 mg->mg_moremagic = SvMAGIC(sv);
4647 SvMAGIC_set(sv, mg);
4649 /* Sometimes a magic contains a reference loop, where the sv and
4650 object refer to each other. To prevent a reference loop that
4651 would prevent such objects being freed, we look for such loops
4652 and if we find one we avoid incrementing the object refcount.
4654 Note we cannot do this to avoid self-tie loops as intervening RV must
4655 have its REFCNT incremented to keep it in existence.
4658 if (!obj || obj == sv ||
4659 how == PERL_MAGIC_arylen ||
4660 how == PERL_MAGIC_symtab ||
4661 (SvTYPE(obj) == SVt_PVGV &&
4662 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4663 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4664 GvFORM(obj) == (CV*)sv)))
4669 mg->mg_obj = SvREFCNT_inc_simple(obj);
4670 mg->mg_flags |= MGf_REFCOUNTED;
4673 /* Normal self-ties simply pass a null object, and instead of
4674 using mg_obj directly, use the SvTIED_obj macro to produce a
4675 new RV as needed. For glob "self-ties", we are tieing the PVIO
4676 with an RV obj pointing to the glob containing the PVIO. In
4677 this case, to avoid a reference loop, we need to weaken the
4681 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4682 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4688 mg->mg_len = namlen;
4691 mg->mg_ptr = savepvn(name, namlen);
4692 else if (namlen == HEf_SVKEY)
4693 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4695 mg->mg_ptr = (char *) name;
4697 mg->mg_virtual = (MGVTBL *) vtable;
4701 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4706 =for apidoc sv_magic
4708 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4709 then adds a new magic item of type C<how> to the head of the magic list.
4711 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4712 handling of the C<name> and C<namlen> arguments.
4714 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4715 to add more than one instance of the same 'how'.
4721 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4722 const char *const name, const I32 namlen)
4725 const MGVTBL *vtable;
4728 PERL_ARGS_ASSERT_SV_MAGIC;
4730 #ifdef PERL_OLD_COPY_ON_WRITE
4732 sv_force_normal_flags(sv, 0);
4734 if (SvREADONLY(sv)) {
4736 /* its okay to attach magic to shared strings; the subsequent
4737 * upgrade to PVMG will unshare the string */
4738 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4741 && how != PERL_MAGIC_regex_global
4742 && how != PERL_MAGIC_bm
4743 && how != PERL_MAGIC_fm
4744 && how != PERL_MAGIC_sv
4745 && how != PERL_MAGIC_backref
4748 Perl_croak(aTHX_ PL_no_modify);
4751 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4752 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4753 /* sv_magic() refuses to add a magic of the same 'how' as an
4756 if (how == PERL_MAGIC_taint) {
4758 /* Any scalar which already had taint magic on which someone
4759 (erroneously?) did SvIOK_on() or similar will now be
4760 incorrectly sporting public "OK" flags. */
4761 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4769 vtable = &PL_vtbl_sv;
4771 case PERL_MAGIC_overload:
4772 vtable = &PL_vtbl_amagic;
4774 case PERL_MAGIC_overload_elem:
4775 vtable = &PL_vtbl_amagicelem;
4777 case PERL_MAGIC_overload_table:
4778 vtable = &PL_vtbl_ovrld;
4781 vtable = &PL_vtbl_bm;
4783 case PERL_MAGIC_regdata:
4784 vtable = &PL_vtbl_regdata;
4786 case PERL_MAGIC_regdatum:
4787 vtable = &PL_vtbl_regdatum;
4789 case PERL_MAGIC_env:
4790 vtable = &PL_vtbl_env;
4793 vtable = &PL_vtbl_fm;
4795 case PERL_MAGIC_envelem:
4796 vtable = &PL_vtbl_envelem;
4798 case PERL_MAGIC_regex_global:
4799 vtable = &PL_vtbl_mglob;
4801 case PERL_MAGIC_isa:
4802 vtable = &PL_vtbl_isa;
4804 case PERL_MAGIC_isaelem:
4805 vtable = &PL_vtbl_isaelem;
4807 case PERL_MAGIC_nkeys:
4808 vtable = &PL_vtbl_nkeys;
4810 case PERL_MAGIC_dbfile:
4813 case PERL_MAGIC_dbline:
4814 vtable = &PL_vtbl_dbline;
4816 #ifdef USE_LOCALE_COLLATE
4817 case PERL_MAGIC_collxfrm:
4818 vtable = &PL_vtbl_collxfrm;
4820 #endif /* USE_LOCALE_COLLATE */
4821 case PERL_MAGIC_tied:
4822 vtable = &PL_vtbl_pack;
4824 case PERL_MAGIC_tiedelem:
4825 case PERL_MAGIC_tiedscalar:
4826 vtable = &PL_vtbl_packelem;
4829 vtable = &PL_vtbl_regexp;
4831 case PERL_MAGIC_hints:
4832 /* As this vtable is all NULL, we can reuse it. */
4833 case PERL_MAGIC_sig:
4834 vtable = &PL_vtbl_sig;
4836 case PERL_MAGIC_sigelem:
4837 vtable = &PL_vtbl_sigelem;
4839 case PERL_MAGIC_taint:
4840 vtable = &PL_vtbl_taint;
4842 case PERL_MAGIC_uvar:
4843 vtable = &PL_vtbl_uvar;
4845 case PERL_MAGIC_vec:
4846 vtable = &PL_vtbl_vec;
4848 case PERL_MAGIC_arylen_p:
4849 case PERL_MAGIC_rhash:
4850 case PERL_MAGIC_symtab:
4851 case PERL_MAGIC_vstring:
4854 case PERL_MAGIC_utf8:
4855 vtable = &PL_vtbl_utf8;
4857 case PERL_MAGIC_substr:
4858 vtable = &PL_vtbl_substr;
4860 case PERL_MAGIC_defelem:
4861 vtable = &PL_vtbl_defelem;
4863 case PERL_MAGIC_arylen:
4864 vtable = &PL_vtbl_arylen;
4866 case PERL_MAGIC_pos:
4867 vtable = &PL_vtbl_pos;
4869 case PERL_MAGIC_backref:
4870 vtable = &PL_vtbl_backref;
4872 case PERL_MAGIC_hintselem:
4873 vtable = &PL_vtbl_hintselem;
4875 case PERL_MAGIC_ext:
4876 /* Reserved for use by extensions not perl internals. */
4877 /* Useful for attaching extension internal data to perl vars. */
4878 /* Note that multiple extensions may clash if magical scalars */
4879 /* etc holding private data from one are passed to another. */
4883 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4886 /* Rest of work is done else where */
4887 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4890 case PERL_MAGIC_taint:
4893 case PERL_MAGIC_ext:
4894 case PERL_MAGIC_dbfile:
4901 =for apidoc sv_unmagic
4903 Removes all magic of type C<type> from an SV.
4909 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4914 PERL_ARGS_ASSERT_SV_UNMAGIC;
4916 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4918 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4919 for (mg = *mgp; mg; mg = *mgp) {
4920 if (mg->mg_type == type) {
4921 const MGVTBL* const vtbl = mg->mg_virtual;
4922 *mgp = mg->mg_moremagic;
4923 if (vtbl && vtbl->svt_free)
4924 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4925 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4927 Safefree(mg->mg_ptr);
4928 else if (mg->mg_len == HEf_SVKEY)
4929 SvREFCNT_dec((SV*)mg->mg_ptr);
4930 else if (mg->mg_type == PERL_MAGIC_utf8)
4931 Safefree(mg->mg_ptr);
4933 if (mg->mg_flags & MGf_REFCOUNTED)
4934 SvREFCNT_dec(mg->mg_obj);
4938 mgp = &mg->mg_moremagic;
4942 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4943 SvMAGIC_set(sv, NULL);
4950 =for apidoc sv_rvweaken
4952 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4953 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4954 push a back-reference to this RV onto the array of backreferences
4955 associated with that magic. If the RV is magical, set magic will be
4956 called after the RV is cleared.
4962 Perl_sv_rvweaken(pTHX_ SV *const sv)
4966 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4968 if (!SvOK(sv)) /* let undefs pass */
4971 Perl_croak(aTHX_ "Can't weaken a nonreference");
4972 else if (SvWEAKREF(sv)) {
4973 if (ckWARN(WARN_MISC))
4974 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4978 Perl_sv_add_backref(aTHX_ tsv, sv);
4984 /* Give tsv backref magic if it hasn't already got it, then push a
4985 * back-reference to sv onto the array associated with the backref magic.
4989 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4994 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
4996 if (SvTYPE(tsv) == SVt_PVHV) {
4997 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5001 /* There is no AV in the offical place - try a fixup. */
5002 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5005 /* Aha. They've got it stowed in magic. Bring it back. */
5006 av = (AV*)mg->mg_obj;
5007 /* Stop mg_free decreasing the refernce count. */
5009 /* Stop mg_free even calling the destructor, given that
5010 there's no AV to free up. */
5012 sv_unmagic(tsv, PERL_MAGIC_backref);
5016 SvREFCNT_inc_simple_void(av);
5021 const MAGIC *const mg
5022 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5024 av = (AV*)mg->mg_obj;
5028 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5029 /* av now has a refcnt of 2, which avoids it getting freed
5030 * before us during global cleanup. The extra ref is removed
5031 * by magic_killbackrefs() when tsv is being freed */
5034 if (AvFILLp(av) >= AvMAX(av)) {
5035 av_extend(av, AvFILLp(av)+1);
5037 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5040 /* delete a back-reference to ourselves from the backref magic associated
5041 * with the SV we point to.
5045 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5052 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5054 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5055 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5056 /* We mustn't attempt to "fix up" the hash here by moving the
5057 backreference array back to the hv_aux structure, as that is stored
5058 in the main HvARRAY(), and hfreentries assumes that no-one
5059 reallocates HvARRAY() while it is running. */
5062 const MAGIC *const mg
5063 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5065 av = (AV *)mg->mg_obj;
5068 if (PL_in_clean_all)
5070 Perl_croak(aTHX_ "panic: del_backref");
5077 /* We shouldn't be in here more than once, but for paranoia reasons lets
5079 for (i = AvFILLp(av); i >= 0; i--) {
5081 const SSize_t fill = AvFILLp(av);
5083 /* We weren't the last entry.
5084 An unordered list has this property that you can take the
5085 last element off the end to fill the hole, and it's still
5086 an unordered list :-)
5091 AvFILLp(av) = fill - 1;
5097 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5099 SV **svp = AvARRAY(av);
5101 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5102 PERL_UNUSED_ARG(sv);
5104 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5105 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5106 if (svp && !SvIS_FREED(av)) {
5107 SV *const *const last = svp + AvFILLp(av);
5109 while (svp <= last) {
5111 SV *const referrer = *svp;
5112 if (SvWEAKREF(referrer)) {
5113 /* XXX Should we check that it hasn't changed? */
5114 SvRV_set(referrer, 0);
5116 SvWEAKREF_off(referrer);
5117 SvSETMAGIC(referrer);
5118 } else if (SvTYPE(referrer) == SVt_PVGV ||
5119 SvTYPE(referrer) == SVt_PVLV) {
5120 /* You lookin' at me? */
5121 assert(GvSTASH(referrer));
5122 assert(GvSTASH(referrer) == (HV*)sv);
5123 GvSTASH(referrer) = 0;
5126 "panic: magic_killbackrefs (flags=%"UVxf")",
5127 (UV)SvFLAGS(referrer));
5135 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5140 =for apidoc sv_insert
5142 Inserts a string at the specified offset/length within the SV. Similar to
5143 the Perl substr() function.
5149 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
5150 const char *const little, const STRLEN littlelen)
5155 register char *midend;
5156 register char *bigend;
5160 PERL_ARGS_ASSERT_SV_INSERT;
5163 Perl_croak(aTHX_ "Can't modify non-existent substring");
5164 SvPV_force(bigstr, curlen);
5165 (void)SvPOK_only_UTF8(bigstr);
5166 if (offset + len > curlen) {
5167 SvGROW(bigstr, offset+len+1);
5168 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5169 SvCUR_set(bigstr, offset+len);
5173 i = littlelen - len;
5174 if (i > 0) { /* string might grow */
5175 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5176 mid = big + offset + len;
5177 midend = bigend = big + SvCUR(bigstr);
5180 while (midend > mid) /* shove everything down */
5181 *--bigend = *--midend;
5182 Move(little,big+offset,littlelen,char);
5183 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5188 Move(little,SvPVX(bigstr)+offset,len,char);
5193 big = SvPVX(bigstr);
5196 bigend = big + SvCUR(bigstr);
5198 if (midend > bigend)
5199 Perl_croak(aTHX_ "panic: sv_insert");
5201 if (mid - big > bigend - midend) { /* faster to shorten from end */
5203 Move(little, mid, littlelen,char);
5206 i = bigend - midend;
5208 Move(midend, mid, i,char);
5212 SvCUR_set(bigstr, mid - big);
5214 else if ((i = mid - big)) { /* faster from front */
5215 midend -= littlelen;
5217 Move(big, midend - i, i, char);
5218 sv_chop(bigstr,midend-i);
5220 Move(little, mid, littlelen,char);
5222 else if (littlelen) {
5223 midend -= littlelen;
5224 sv_chop(bigstr,midend);
5225 Move(little,midend,littlelen,char);
5228 sv_chop(bigstr,midend);
5234 =for apidoc sv_replace
5236 Make the first argument a copy of the second, then delete the original.
5237 The target SV physically takes over ownership of the body of the source SV
5238 and inherits its flags; however, the target keeps any magic it owns,
5239 and any magic in the source is discarded.
5240 Note that this is a rather specialist SV copying operation; most of the
5241 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5247 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5250 const U32 refcnt = SvREFCNT(sv);
5252 PERL_ARGS_ASSERT_SV_REPLACE;
5254 SV_CHECK_THINKFIRST_COW_DROP(sv);
5255 if (SvREFCNT(nsv) != 1) {
5256 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5257 UVuf " != 1)", (UV) SvREFCNT(nsv));
5259 if (SvMAGICAL(sv)) {
5263 sv_upgrade(nsv, SVt_PVMG);
5264 SvMAGIC_set(nsv, SvMAGIC(sv));
5265 SvFLAGS(nsv) |= SvMAGICAL(sv);
5267 SvMAGIC_set(sv, NULL);
5271 assert(!SvREFCNT(sv));
5272 #ifdef DEBUG_LEAKING_SCALARS
5273 sv->sv_flags = nsv->sv_flags;
5274 sv->sv_any = nsv->sv_any;
5275 sv->sv_refcnt = nsv->sv_refcnt;
5276 sv->sv_u = nsv->sv_u;
5278 StructCopy(nsv,sv,SV);
5280 if(SvTYPE(sv) == SVt_IV) {
5282 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5286 #ifdef PERL_OLD_COPY_ON_WRITE
5287 if (SvIsCOW_normal(nsv)) {
5288 /* We need to follow the pointers around the loop to make the
5289 previous SV point to sv, rather than nsv. */
5292 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5295 assert(SvPVX_const(current) == SvPVX_const(nsv));
5297 /* Make the SV before us point to the SV after us. */
5299 PerlIO_printf(Perl_debug_log, "previous is\n");
5301 PerlIO_printf(Perl_debug_log,
5302 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5303 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5305 SV_COW_NEXT_SV_SET(current, sv);
5308 SvREFCNT(sv) = refcnt;
5309 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5315 =for apidoc sv_clear
5317 Clear an SV: call any destructors, free up any memory used by the body,
5318 and free the body itself. The SV's head is I<not> freed, although
5319 its type is set to all 1's so that it won't inadvertently be assumed
5320 to be live during global destruction etc.
5321 This function should only be called when REFCNT is zero. Most of the time
5322 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5329 Perl_sv_clear(pTHX_ register SV *const sv)
5332 const U32 type = SvTYPE(sv);
5333 const struct body_details *const sv_type_details
5334 = bodies_by_type + type;
5337 PERL_ARGS_ASSERT_SV_CLEAR;
5338 assert(SvREFCNT(sv) == 0);
5339 assert(SvTYPE(sv) != SVTYPEMASK);
5341 if (type <= SVt_IV) {
5342 /* See the comment in sv.h about the collusion between this early
5343 return and the overloading of the NULL and IV slots in the size
5346 SV * const target = SvRV(sv);
5348 sv_del_backref(target, sv);
5350 SvREFCNT_dec(target);
5352 SvFLAGS(sv) &= SVf_BREAK;
5353 SvFLAGS(sv) |= SVTYPEMASK;
5358 if (PL_defstash && /* Still have a symbol table? */
5365 stash = SvSTASH(sv);
5366 destructor = StashHANDLER(stash,DESTROY);
5368 SV* const tmpref = newRV(sv);
5369 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5371 PUSHSTACKi(PERLSI_DESTROY);
5376 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5382 if(SvREFCNT(tmpref) < 2) {
5383 /* tmpref is not kept alive! */
5385 SvRV_set(tmpref, NULL);
5388 SvREFCNT_dec(tmpref);
5390 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5394 if (PL_in_clean_objs)
5395 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5397 /* DESTROY gave object new lease on life */
5403 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5404 SvOBJECT_off(sv); /* Curse the object. */
5405 if (type != SVt_PVIO)
5406 --PL_sv_objcount; /* XXX Might want something more general */
5409 if (type >= SVt_PVMG) {
5410 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5411 SvREFCNT_dec(SvOURSTASH(sv));
5412 } else if (SvMAGIC(sv))
5414 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5415 SvREFCNT_dec(SvSTASH(sv));
5418 /* case SVt_BIND: */
5421 IoIFP(sv) != PerlIO_stdin() &&
5422 IoIFP(sv) != PerlIO_stdout() &&
5423 IoIFP(sv) != PerlIO_stderr())
5425 io_close((IO*)sv, FALSE);
5427 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5428 PerlDir_close(IoDIRP(sv));
5429 IoDIRP(sv) = (DIR*)NULL;
5430 Safefree(IoTOP_NAME(sv));
5431 Safefree(IoFMT_NAME(sv));
5432 Safefree(IoBOTTOM_NAME(sv));
5435 /* FIXME for plugins */
5436 pregfree2((REGEXP*) sv);
5443 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5447 if (PL_comppad == (AV*)sv) {
5454 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5455 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5456 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5457 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5459 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5460 SvREFCNT_dec(LvTARG(sv));
5462 if (isGV_with_GP(sv)) {
5463 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5464 mro_method_changed_in(stash);
5467 unshare_hek(GvNAME_HEK(sv));
5468 /* If we're in a stash, we don't own a reference to it. However it does
5469 have a back reference to us, which needs to be cleared. */
5470 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5471 sv_del_backref((SV*)stash, sv);
5473 /* FIXME. There are probably more unreferenced pointers to SVs in the
5474 interpreter struct that we should check and tidy in a similar
5476 if ((GV*)sv == PL_last_in_gv)
5477 PL_last_in_gv = NULL;
5483 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5486 SvOOK_offset(sv, offset);
5487 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5488 /* Don't even bother with turning off the OOK flag. */
5491 SV * const target = SvRV(sv);
5493 sv_del_backref(target, sv);
5495 SvREFCNT_dec(target);
5497 #ifdef PERL_OLD_COPY_ON_WRITE
5498 else if (SvPVX_const(sv)) {
5500 /* I believe I need to grab the global SV mutex here and
5501 then recheck the COW status. */
5503 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5507 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5509 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5512 /* And drop it here. */
5514 } else if (SvLEN(sv)) {
5515 Safefree(SvPVX_const(sv));
5519 else if (SvPVX_const(sv) && SvLEN(sv))
5520 Safefree(SvPVX_mutable(sv));
5521 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5522 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5531 SvFLAGS(sv) &= SVf_BREAK;
5532 SvFLAGS(sv) |= SVTYPEMASK;
5534 if (sv_type_details->arena) {
5535 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5536 &PL_body_roots[type]);
5538 else if (sv_type_details->body_size) {
5539 my_safefree(SvANY(sv));
5544 =for apidoc sv_newref
5546 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5553 Perl_sv_newref(pTHX_ SV *const sv)
5555 PERL_UNUSED_CONTEXT;
5564 Decrement an SV's reference count, and if it drops to zero, call
5565 C<sv_clear> to invoke destructors and free up any memory used by
5566 the body; finally, deallocate the SV's head itself.
5567 Normally called via a wrapper macro C<SvREFCNT_dec>.
5573 Perl_sv_free(pTHX_ SV *const sv)
5578 if (SvREFCNT(sv) == 0) {
5579 if (SvFLAGS(sv) & SVf_BREAK)
5580 /* this SV's refcnt has been artificially decremented to
5581 * trigger cleanup */
5583 if (PL_in_clean_all) /* All is fair */
5585 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5586 /* make sure SvREFCNT(sv)==0 happens very seldom */
5587 SvREFCNT(sv) = (~(U32)0)/2;
5590 if (ckWARN_d(WARN_INTERNAL)) {
5591 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5592 Perl_dump_sv_child(aTHX_ sv);
5594 #ifdef DEBUG_LEAKING_SCALARS
5597 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5598 if (PL_warnhook == PERL_WARNHOOK_FATAL
5599 || ckDEAD(packWARN(WARN_INTERNAL))) {
5600 /* Don't let Perl_warner cause us to escape our fate: */
5604 /* This may not return: */
5605 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5606 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5607 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5610 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5615 if (--(SvREFCNT(sv)) > 0)
5617 Perl_sv_free2(aTHX_ sv);
5621 Perl_sv_free2(pTHX_ SV *const sv)
5625 PERL_ARGS_ASSERT_SV_FREE2;
5629 if (ckWARN_d(WARN_DEBUGGING))
5630 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5631 "Attempt to free temp prematurely: SV 0x%"UVxf
5632 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5636 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5637 /* make sure SvREFCNT(sv)==0 happens very seldom */
5638 SvREFCNT(sv) = (~(U32)0)/2;
5649 Returns the length of the string in the SV. Handles magic and type
5650 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5656 Perl_sv_len(pTHX_ register SV *const sv)
5664 len = mg_length(sv);
5666 (void)SvPV_const(sv, len);
5671 =for apidoc sv_len_utf8
5673 Returns the number of characters in the string in an SV, counting wide
5674 UTF-8 bytes as a single character. Handles magic and type coercion.
5680 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5681 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5682 * (Note that the mg_len is not the length of the mg_ptr field.
5683 * This allows the cache to store the character length of the string without
5684 * needing to malloc() extra storage to attach to the mg_ptr.)
5689 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5695 return mg_length(sv);
5699 const U8 *s = (U8*)SvPV_const(sv, len);
5703 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5705 if (mg && mg->mg_len != -1) {
5707 if (PL_utf8cache < 0) {
5708 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5710 /* Need to turn the assertions off otherwise we may
5711 recurse infinitely while printing error messages.
5713 SAVEI8(PL_utf8cache);
5715 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5716 " real %"UVuf" for %"SVf,
5717 (UV) ulen, (UV) real, SVfARG(sv));
5722 ulen = Perl_utf8_length(aTHX_ s, s + len);
5723 if (!SvREADONLY(sv)) {
5725 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5726 &PL_vtbl_utf8, 0, 0);
5734 return Perl_utf8_length(aTHX_ s, s + len);
5738 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5741 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5744 const U8 *s = start;
5746 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5748 while (s < send && uoffset--)
5751 /* This is the existing behaviour. Possibly it should be a croak, as
5752 it's actually a bounds error */
5758 /* Given the length of the string in both bytes and UTF-8 characters, decide
5759 whether to walk forwards or backwards to find the byte corresponding to
5760 the passed in UTF-8 offset. */
5762 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5763 const STRLEN uoffset, const STRLEN uend)
5765 STRLEN backw = uend - uoffset;
5767 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5769 if (uoffset < 2 * backw) {
5770 /* The assumption is that going forwards is twice the speed of going
5771 forward (that's where the 2 * backw comes from).
5772 (The real figure of course depends on the UTF-8 data.) */
5773 return sv_pos_u2b_forwards(start, send, uoffset);
5778 while (UTF8_IS_CONTINUATION(*send))
5781 return send - start;
5784 /* For the string representation of the given scalar, find the byte
5785 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5786 give another position in the string, *before* the sought offset, which
5787 (which is always true, as 0, 0 is a valid pair of positions), which should
5788 help reduce the amount of linear searching.
5789 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5790 will be used to reduce the amount of linear searching. The cache will be
5791 created if necessary, and the found value offered to it for update. */
5793 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5794 const U8 *const send, const STRLEN uoffset,
5795 STRLEN uoffset0, STRLEN boffset0)
5797 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5800 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5802 assert (uoffset >= uoffset0);
5804 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5805 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5806 if ((*mgp)->mg_ptr) {
5807 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5808 if (cache[0] == uoffset) {
5809 /* An exact match. */
5812 if (cache[2] == uoffset) {
5813 /* An exact match. */
5817 if (cache[0] < uoffset) {
5818 /* The cache already knows part of the way. */
5819 if (cache[0] > uoffset0) {
5820 /* The cache knows more than the passed in pair */
5821 uoffset0 = cache[0];
5822 boffset0 = cache[1];
5824 if ((*mgp)->mg_len != -1) {
5825 /* And we know the end too. */
5827 + sv_pos_u2b_midway(start + boffset0, send,
5829 (*mgp)->mg_len - uoffset0);
5832 + sv_pos_u2b_forwards(start + boffset0,
5833 send, uoffset - uoffset0);
5836 else if (cache[2] < uoffset) {
5837 /* We're between the two cache entries. */
5838 if (cache[2] > uoffset0) {
5839 /* and the cache knows more than the passed in pair */
5840 uoffset0 = cache[2];
5841 boffset0 = cache[3];
5845 + sv_pos_u2b_midway(start + boffset0,
5848 cache[0] - uoffset0);
5851 + sv_pos_u2b_midway(start + boffset0,
5854 cache[2] - uoffset0);
5858 else if ((*mgp)->mg_len != -1) {
5859 /* If we can take advantage of a passed in offset, do so. */
5860 /* In fact, offset0 is either 0, or less than offset, so don't
5861 need to worry about the other possibility. */
5863 + sv_pos_u2b_midway(start + boffset0, send,
5865 (*mgp)->mg_len - uoffset0);
5870 if (!found || PL_utf8cache < 0) {
5871 const STRLEN real_boffset
5872 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5873 send, uoffset - uoffset0);
5875 if (found && PL_utf8cache < 0) {
5876 if (real_boffset != boffset) {
5877 /* Need to turn the assertions off otherwise we may recurse
5878 infinitely while printing error messages. */
5879 SAVEI8(PL_utf8cache);
5881 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5882 " real %"UVuf" for %"SVf,
5883 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5886 boffset = real_boffset;
5890 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5896 =for apidoc sv_pos_u2b
5898 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5899 the start of the string, to a count of the equivalent number of bytes; if
5900 lenp is non-zero, it does the same to lenp, but this time starting from
5901 the offset, rather than from the start of the string. Handles magic and
5908 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5909 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5910 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5915 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5920 PERL_ARGS_ASSERT_SV_POS_U2B;
5925 start = (U8*)SvPV_const(sv, len);
5927 STRLEN uoffset = (STRLEN) *offsetp;
5928 const U8 * const send = start + len;
5930 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5933 *offsetp = (I32) boffset;
5936 /* Convert the relative offset to absolute. */
5937 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5938 const STRLEN boffset2
5939 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5940 uoffset, boffset) - boffset;
5954 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5955 byte length pairing. The (byte) length of the total SV is passed in too,
5956 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5957 may not have updated SvCUR, so we can't rely on reading it directly.
5959 The proffered utf8/byte length pairing isn't used if the cache already has
5960 two pairs, and swapping either for the proffered pair would increase the
5961 RMS of the intervals between known byte offsets.
5963 The cache itself consists of 4 STRLEN values
5964 0: larger UTF-8 offset
5965 1: corresponding byte offset
5966 2: smaller UTF-8 offset
5967 3: corresponding byte offset
5969 Unused cache pairs have the value 0, 0.
5970 Keeping the cache "backwards" means that the invariant of
5971 cache[0] >= cache[2] is maintained even with empty slots, which means that
5972 the code that uses it doesn't need to worry if only 1 entry has actually
5973 been set to non-zero. It also makes the "position beyond the end of the
5974 cache" logic much simpler, as the first slot is always the one to start
5978 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5979 const STRLEN utf8, const STRLEN blen)
5983 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5989 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5991 (*mgp)->mg_len = -1;
5995 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5996 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5997 (*mgp)->mg_ptr = (char *) cache;
6001 if (PL_utf8cache < 0) {
6002 const U8 *start = (const U8 *) SvPVX_const(sv);
6003 const STRLEN realutf8 = utf8_length(start, start + byte);
6005 if (realutf8 != utf8) {
6006 /* Need to turn the assertions off otherwise we may recurse
6007 infinitely while printing error messages. */
6008 SAVEI8(PL_utf8cache);
6010 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6011 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6015 /* Cache is held with the later position first, to simplify the code
6016 that deals with unbounded ends. */
6018 ASSERT_UTF8_CACHE(cache);
6019 if (cache[1] == 0) {
6020 /* Cache is totally empty */
6023 } else if (cache[3] == 0) {
6024 if (byte > cache[1]) {
6025 /* New one is larger, so goes first. */
6026 cache[2] = cache[0];
6027 cache[3] = cache[1];
6035 #define THREEWAY_SQUARE(a,b,c,d) \
6036 ((float)((d) - (c))) * ((float)((d) - (c))) \
6037 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6038 + ((float)((b) - (a))) * ((float)((b) - (a)))
6040 /* Cache has 2 slots in use, and we know three potential pairs.
6041 Keep the two that give the lowest RMS distance. Do the
6042 calcualation in bytes simply because we always know the byte
6043 length. squareroot has the same ordering as the positive value,
6044 so don't bother with the actual square root. */
6045 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6046 if (byte > cache[1]) {
6047 /* New position is after the existing pair of pairs. */
6048 const float keep_earlier
6049 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6050 const float keep_later
6051 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6053 if (keep_later < keep_earlier) {
6054 if (keep_later < existing) {
6055 cache[2] = cache[0];
6056 cache[3] = cache[1];
6062 if (keep_earlier < existing) {
6068 else if (byte > cache[3]) {
6069 /* New position is between the existing pair of pairs. */
6070 const float keep_earlier
6071 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6072 const float keep_later
6073 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6075 if (keep_later < keep_earlier) {
6076 if (keep_later < existing) {
6082 if (keep_earlier < existing) {
6089 /* New position is before the existing pair of pairs. */
6090 const float keep_earlier
6091 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6092 const float keep_later
6093 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6095 if (keep_later < keep_earlier) {
6096 if (keep_later < existing) {
6102 if (keep_earlier < existing) {
6103 cache[0] = cache[2];
6104 cache[1] = cache[3];
6111 ASSERT_UTF8_CACHE(cache);
6114 /* We already know all of the way, now we may be able to walk back. The same
6115 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6116 backward is half the speed of walking forward. */
6118 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6119 const U8 *end, STRLEN endu)
6121 const STRLEN forw = target - s;
6122 STRLEN backw = end - target;
6124 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6126 if (forw < 2 * backw) {
6127 return utf8_length(s, target);
6130 while (end > target) {
6132 while (UTF8_IS_CONTINUATION(*end)) {
6141 =for apidoc sv_pos_b2u
6143 Converts the value pointed to by offsetp from a count of bytes from the
6144 start of the string, to a count of the equivalent number of UTF-8 chars.
6145 Handles magic and type coercion.
6151 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6152 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6157 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6160 const STRLEN byte = *offsetp;
6161 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6167 PERL_ARGS_ASSERT_SV_POS_B2U;
6172 s = (const U8*)SvPV_const(sv, blen);
6175 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6179 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6180 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6182 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6183 if (cache[1] == byte) {
6184 /* An exact match. */
6185 *offsetp = cache[0];
6188 if (cache[3] == byte) {
6189 /* An exact match. */
6190 *offsetp = cache[2];
6194 if (cache[1] < byte) {
6195 /* We already know part of the way. */
6196 if (mg->mg_len != -1) {
6197 /* Actually, we know the end too. */
6199 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6200 s + blen, mg->mg_len - cache[0]);
6202 len = cache[0] + utf8_length(s + cache[1], send);
6205 else if (cache[3] < byte) {
6206 /* We're between the two cached pairs, so we do the calculation
6207 offset by the byte/utf-8 positions for the earlier pair,
6208 then add the utf-8 characters from the string start to
6210 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6211 s + cache[1], cache[0] - cache[2])
6215 else { /* cache[3] > byte */
6216 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6220 ASSERT_UTF8_CACHE(cache);
6222 } else if (mg->mg_len != -1) {
6223 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6227 if (!found || PL_utf8cache < 0) {
6228 const STRLEN real_len = utf8_length(s, send);
6230 if (found && PL_utf8cache < 0) {
6231 if (len != real_len) {
6232 /* Need to turn the assertions off otherwise we may recurse
6233 infinitely while printing error messages. */
6234 SAVEI8(PL_utf8cache);
6236 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6237 " real %"UVuf" for %"SVf,
6238 (UV) len, (UV) real_len, SVfARG(sv));
6246 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6252 Returns a boolean indicating whether the strings in the two SVs are
6253 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6254 coerce its args to strings if necessary.
6260 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6269 SV* svrecode = NULL;
6276 /* if pv1 and pv2 are the same, second SvPV_const call may
6277 * invalidate pv1, so we may need to make a copy */
6278 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6279 pv1 = SvPV_const(sv1, cur1);
6280 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6282 pv1 = SvPV_const(sv1, cur1);
6290 pv2 = SvPV_const(sv2, cur2);
6292 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6293 /* Differing utf8ness.
6294 * Do not UTF8size the comparands as a side-effect. */
6297 svrecode = newSVpvn(pv2, cur2);
6298 sv_recode_to_utf8(svrecode, PL_encoding);
6299 pv2 = SvPV_const(svrecode, cur2);
6302 svrecode = newSVpvn(pv1, cur1);
6303 sv_recode_to_utf8(svrecode, PL_encoding);
6304 pv1 = SvPV_const(svrecode, cur1);
6306 /* Now both are in UTF-8. */
6308 SvREFCNT_dec(svrecode);
6313 bool is_utf8 = TRUE;
6316 /* sv1 is the UTF-8 one,
6317 * if is equal it must be downgrade-able */
6318 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6324 /* sv2 is the UTF-8 one,
6325 * if is equal it must be downgrade-able */
6326 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6332 /* Downgrade not possible - cannot be eq */
6340 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6342 SvREFCNT_dec(svrecode);
6352 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6353 string in C<sv1> is less than, equal to, or greater than the string in
6354 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6355 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6361 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6365 const char *pv1, *pv2;
6368 SV *svrecode = NULL;
6375 pv1 = SvPV_const(sv1, cur1);
6382 pv2 = SvPV_const(sv2, cur2);
6384 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6385 /* Differing utf8ness.
6386 * Do not UTF8size the comparands as a side-effect. */
6389 svrecode = newSVpvn(pv2, cur2);
6390 sv_recode_to_utf8(svrecode, PL_encoding);
6391 pv2 = SvPV_const(svrecode, cur2);
6394 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6399 svrecode = newSVpvn(pv1, cur1);
6400 sv_recode_to_utf8(svrecode, PL_encoding);
6401 pv1 = SvPV_const(svrecode, cur1);
6404 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6410 cmp = cur2 ? -1 : 0;
6414 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6417 cmp = retval < 0 ? -1 : 1;
6418 } else if (cur1 == cur2) {
6421 cmp = cur1 < cur2 ? -1 : 1;
6425 SvREFCNT_dec(svrecode);
6433 =for apidoc sv_cmp_locale
6435 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6436 'use bytes' aware, handles get magic, and will coerce its args to strings
6437 if necessary. See also C<sv_cmp>.
6443 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6446 #ifdef USE_LOCALE_COLLATE
6452 if (PL_collation_standard)
6456 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6458 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6460 if (!pv1 || !len1) {
6471 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6474 return retval < 0 ? -1 : 1;
6477 * When the result of collation is equality, that doesn't mean
6478 * that there are no differences -- some locales exclude some
6479 * characters from consideration. So to avoid false equalities,
6480 * we use the raw string as a tiebreaker.
6486 #endif /* USE_LOCALE_COLLATE */
6488 return sv_cmp(sv1, sv2);
6492 #ifdef USE_LOCALE_COLLATE
6495 =for apidoc sv_collxfrm
6497 Add Collate Transform magic to an SV if it doesn't already have it.
6499 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6500 scalar data of the variable, but transformed to such a format that a normal
6501 memory comparison can be used to compare the data according to the locale
6508 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6513 PERL_ARGS_ASSERT_SV_COLLXFRM;
6515 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6516 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6522 Safefree(mg->mg_ptr);
6523 s = SvPV_const(sv, len);
6524 if ((xf = mem_collxfrm(s, len, &xlen))) {
6526 #ifdef PERL_OLD_COPY_ON_WRITE
6528 sv_force_normal_flags(sv, 0);
6530 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6544 if (mg && mg->mg_ptr) {
6546 return mg->mg_ptr + sizeof(PL_collation_ix);
6554 #endif /* USE_LOCALE_COLLATE */
6559 Get a line from the filehandle and store it into the SV, optionally
6560 appending to the currently-stored string.
6566 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6571 register STDCHAR rslast;
6572 register STDCHAR *bp;
6577 PERL_ARGS_ASSERT_SV_GETS;
6579 if (SvTHINKFIRST(sv))
6580 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6581 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6583 However, perlbench says it's slower, because the existing swipe code
6584 is faster than copy on write.
6585 Swings and roundabouts. */
6586 SvUPGRADE(sv, SVt_PV);
6591 if (PerlIO_isutf8(fp)) {
6593 sv_utf8_upgrade_nomg(sv);
6594 sv_pos_u2b(sv,&append,0);
6596 } else if (SvUTF8(sv)) {
6597 SV * const tsv = newSV(0);
6598 sv_gets(tsv, fp, 0);
6599 sv_utf8_upgrade_nomg(tsv);
6600 SvCUR_set(sv,append);
6603 goto return_string_or_null;
6608 if (PerlIO_isutf8(fp))
6611 if (IN_PERL_COMPILETIME) {
6612 /* we always read code in line mode */
6616 else if (RsSNARF(PL_rs)) {
6617 /* If it is a regular disk file use size from stat() as estimate
6618 of amount we are going to read -- may result in mallocing
6619 more memory than we really need if the layers below reduce
6620 the size we read (e.g. CRLF or a gzip layer).
6623 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6624 const Off_t offset = PerlIO_tell(fp);
6625 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6626 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6632 else if (RsRECORD(PL_rs)) {
6637 /* Grab the size of the record we're getting */
6638 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6639 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6642 /* VMS wants read instead of fread, because fread doesn't respect */
6643 /* RMS record boundaries. This is not necessarily a good thing to be */
6644 /* doing, but we've got no other real choice - except avoid stdio
6645 as implementation - perhaps write a :vms layer ?
6647 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6649 bytesread = PerlIO_read(fp, buffer, recsize);
6653 SvCUR_set(sv, bytesread += append);
6654 buffer[bytesread] = '\0';
6655 goto return_string_or_null;
6657 else if (RsPARA(PL_rs)) {
6663 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6664 if (PerlIO_isutf8(fp)) {
6665 rsptr = SvPVutf8(PL_rs, rslen);
6668 if (SvUTF8(PL_rs)) {
6669 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6670 Perl_croak(aTHX_ "Wide character in $/");
6673 rsptr = SvPV_const(PL_rs, rslen);
6677 rslast = rslen ? rsptr[rslen - 1] : '\0';
6679 if (rspara) { /* have to do this both before and after */
6680 do { /* to make sure file boundaries work right */
6683 i = PerlIO_getc(fp);
6687 PerlIO_ungetc(fp,i);
6693 /* See if we know enough about I/O mechanism to cheat it ! */
6695 /* This used to be #ifdef test - it is made run-time test for ease
6696 of abstracting out stdio interface. One call should be cheap
6697 enough here - and may even be a macro allowing compile
6701 if (PerlIO_fast_gets(fp)) {
6704 * We're going to steal some values from the stdio struct
6705 * and put EVERYTHING in the innermost loop into registers.
6707 register STDCHAR *ptr;
6711 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6712 /* An ungetc()d char is handled separately from the regular
6713 * buffer, so we getc() it back out and stuff it in the buffer.
6715 i = PerlIO_getc(fp);
6716 if (i == EOF) return 0;
6717 *(--((*fp)->_ptr)) = (unsigned char) i;
6721 /* Here is some breathtakingly efficient cheating */
6723 cnt = PerlIO_get_cnt(fp); /* get count into register */
6724 /* make sure we have the room */
6725 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6726 /* Not room for all of it
6727 if we are looking for a separator and room for some
6729 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6730 /* just process what we have room for */
6731 shortbuffered = cnt - SvLEN(sv) + append + 1;
6732 cnt -= shortbuffered;
6736 /* remember that cnt can be negative */
6737 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6742 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6743 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6744 DEBUG_P(PerlIO_printf(Perl_debug_log,
6745 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6746 DEBUG_P(PerlIO_printf(Perl_debug_log,
6747 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6748 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6749 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6754 while (cnt > 0) { /* this | eat */
6756 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6757 goto thats_all_folks; /* screams | sed :-) */
6761 Copy(ptr, bp, cnt, char); /* this | eat */
6762 bp += cnt; /* screams | dust */
6763 ptr += cnt; /* louder | sed :-) */
6768 if (shortbuffered) { /* oh well, must extend */
6769 cnt = shortbuffered;
6771 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6773 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6774 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6778 DEBUG_P(PerlIO_printf(Perl_debug_log,
6779 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6780 PTR2UV(ptr),(long)cnt));
6781 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6783 DEBUG_P(PerlIO_printf(Perl_debug_log,
6784 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6785 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6786 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6788 /* This used to call 'filbuf' in stdio form, but as that behaves like
6789 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6790 another abstraction. */
6791 i = PerlIO_getc(fp); /* get more characters */
6793 DEBUG_P(PerlIO_printf(Perl_debug_log,
6794 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6795 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6796 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6798 cnt = PerlIO_get_cnt(fp);
6799 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6800 DEBUG_P(PerlIO_printf(Perl_debug_log,
6801 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6803 if (i == EOF) /* all done for ever? */
6804 goto thats_really_all_folks;
6806 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6808 SvGROW(sv, bpx + cnt + 2);
6809 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6811 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6813 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6814 goto thats_all_folks;
6818 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6819 memNE((char*)bp - rslen, rsptr, rslen))
6820 goto screamer; /* go back to the fray */
6821 thats_really_all_folks:
6823 cnt += shortbuffered;
6824 DEBUG_P(PerlIO_printf(Perl_debug_log,
6825 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6826 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6827 DEBUG_P(PerlIO_printf(Perl_debug_log,
6828 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6829 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6830 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6832 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6833 DEBUG_P(PerlIO_printf(Perl_debug_log,
6834 "Screamer: done, len=%ld, string=|%.*s|\n",
6835 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6839 /*The big, slow, and stupid way. */
6840 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6841 STDCHAR *buf = NULL;
6842 Newx(buf, 8192, STDCHAR);
6850 register const STDCHAR * const bpe = buf + sizeof(buf);
6852 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6853 ; /* keep reading */
6857 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6858 /* Accomodate broken VAXC compiler, which applies U8 cast to
6859 * both args of ?: operator, causing EOF to change into 255
6862 i = (U8)buf[cnt - 1];
6868 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6870 sv_catpvn(sv, (char *) buf, cnt);
6872 sv_setpvn(sv, (char *) buf, cnt);
6874 if (i != EOF && /* joy */
6876 SvCUR(sv) < rslen ||
6877 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6881 * If we're reading from a TTY and we get a short read,
6882 * indicating that the user hit his EOF character, we need
6883 * to notice it now, because if we try to read from the TTY
6884 * again, the EOF condition will disappear.
6886 * The comparison of cnt to sizeof(buf) is an optimization
6887 * that prevents unnecessary calls to feof().
6891 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6895 #ifdef USE_HEAP_INSTEAD_OF_STACK
6900 if (rspara) { /* have to do this both before and after */
6901 while (i != EOF) { /* to make sure file boundaries work right */
6902 i = PerlIO_getc(fp);
6904 PerlIO_ungetc(fp,i);
6910 return_string_or_null:
6911 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6917 Auto-increment of the value in the SV, doing string to numeric conversion
6918 if necessary. Handles 'get' magic.
6924 Perl_sv_inc(pTHX_ register SV *const sv)
6933 if (SvTHINKFIRST(sv)) {
6935 sv_force_normal_flags(sv, 0);
6936 if (SvREADONLY(sv)) {
6937 if (IN_PERL_RUNTIME)
6938 Perl_croak(aTHX_ PL_no_modify);
6942 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6944 i = PTR2IV(SvRV(sv));
6949 flags = SvFLAGS(sv);
6950 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6951 /* It's (privately or publicly) a float, but not tested as an
6952 integer, so test it to see. */
6954 flags = SvFLAGS(sv);
6956 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6957 /* It's publicly an integer, or privately an integer-not-float */
6958 #ifdef PERL_PRESERVE_IVUV
6962 if (SvUVX(sv) == UV_MAX)
6963 sv_setnv(sv, UV_MAX_P1);
6965 (void)SvIOK_only_UV(sv);
6966 SvUV_set(sv, SvUVX(sv) + 1);
6968 if (SvIVX(sv) == IV_MAX)
6969 sv_setuv(sv, (UV)IV_MAX + 1);
6971 (void)SvIOK_only(sv);
6972 SvIV_set(sv, SvIVX(sv) + 1);
6977 if (flags & SVp_NOK) {
6978 const NV was = SvNVX(sv);
6979 if (NV_OVERFLOWS_INTEGERS_AT &&
6980 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6981 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6982 "Lost precision when incrementing %" NVff " by 1",
6985 (void)SvNOK_only(sv);
6986 SvNV_set(sv, was + 1.0);
6990 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6991 if ((flags & SVTYPEMASK) < SVt_PVIV)
6992 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6993 (void)SvIOK_only(sv);
6998 while (isALPHA(*d)) d++;
6999 while (isDIGIT(*d)) d++;
7001 #ifdef PERL_PRESERVE_IVUV
7002 /* Got to punt this as an integer if needs be, but we don't issue
7003 warnings. Probably ought to make the sv_iv_please() that does
7004 the conversion if possible, and silently. */
7005 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7006 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7007 /* Need to try really hard to see if it's an integer.
7008 9.22337203685478e+18 is an integer.
7009 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7010 so $a="9.22337203685478e+18"; $a+0; $a++
7011 needs to be the same as $a="9.22337203685478e+18"; $a++
7018 /* sv_2iv *should* have made this an NV */
7019 if (flags & SVp_NOK) {
7020 (void)SvNOK_only(sv);
7021 SvNV_set(sv, SvNVX(sv) + 1.0);
7024 /* I don't think we can get here. Maybe I should assert this
7025 And if we do get here I suspect that sv_setnv will croak. NWC
7027 #if defined(USE_LONG_DOUBLE)
7028 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",
7029 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7031 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7032 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7035 #endif /* PERL_PRESERVE_IVUV */
7036 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7040 while (d >= SvPVX_const(sv)) {
7048 /* MKS: The original code here died if letters weren't consecutive.
7049 * at least it didn't have to worry about non-C locales. The
7050 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7051 * arranged in order (although not consecutively) and that only
7052 * [A-Za-z] are accepted by isALPHA in the C locale.
7054 if (*d != 'z' && *d != 'Z') {
7055 do { ++*d; } while (!isALPHA(*d));
7058 *(d--) -= 'z' - 'a';
7063 *(d--) -= 'z' - 'a' + 1;
7067 /* oh,oh, the number grew */
7068 SvGROW(sv, SvCUR(sv) + 2);
7069 SvCUR_set(sv, SvCUR(sv) + 1);
7070 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7081 Auto-decrement of the value in the SV, doing string to numeric conversion
7082 if necessary. Handles 'get' magic.
7088 Perl_sv_dec(pTHX_ register SV *const sv)
7096 if (SvTHINKFIRST(sv)) {
7098 sv_force_normal_flags(sv, 0);
7099 if (SvREADONLY(sv)) {
7100 if (IN_PERL_RUNTIME)
7101 Perl_croak(aTHX_ PL_no_modify);
7105 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7107 i = PTR2IV(SvRV(sv));
7112 /* Unlike sv_inc we don't have to worry about string-never-numbers
7113 and keeping them magic. But we mustn't warn on punting */
7114 flags = SvFLAGS(sv);
7115 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7116 /* It's publicly an integer, or privately an integer-not-float */
7117 #ifdef PERL_PRESERVE_IVUV
7121 if (SvUVX(sv) == 0) {
7122 (void)SvIOK_only(sv);
7126 (void)SvIOK_only_UV(sv);
7127 SvUV_set(sv, SvUVX(sv) - 1);
7130 if (SvIVX(sv) == IV_MIN) {
7131 sv_setnv(sv, (NV)IV_MIN);
7135 (void)SvIOK_only(sv);
7136 SvIV_set(sv, SvIVX(sv) - 1);
7141 if (flags & SVp_NOK) {
7144 const NV was = SvNVX(sv);
7145 if (NV_OVERFLOWS_INTEGERS_AT &&
7146 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7147 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7148 "Lost precision when decrementing %" NVff " by 1",
7151 (void)SvNOK_only(sv);
7152 SvNV_set(sv, was - 1.0);
7156 if (!(flags & SVp_POK)) {
7157 if ((flags & SVTYPEMASK) < SVt_PVIV)
7158 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7160 (void)SvIOK_only(sv);
7163 #ifdef PERL_PRESERVE_IVUV
7165 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7166 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7167 /* Need to try really hard to see if it's an integer.
7168 9.22337203685478e+18 is an integer.
7169 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7170 so $a="9.22337203685478e+18"; $a+0; $a--
7171 needs to be the same as $a="9.22337203685478e+18"; $a--
7178 /* sv_2iv *should* have made this an NV */
7179 if (flags & SVp_NOK) {
7180 (void)SvNOK_only(sv);
7181 SvNV_set(sv, SvNVX(sv) - 1.0);
7184 /* I don't think we can get here. Maybe I should assert this
7185 And if we do get here I suspect that sv_setnv will croak. NWC
7187 #if defined(USE_LONG_DOUBLE)
7188 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",
7189 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7191 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7192 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7196 #endif /* PERL_PRESERVE_IVUV */
7197 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7201 =for apidoc sv_mortalcopy
7203 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7204 The new SV is marked as mortal. It will be destroyed "soon", either by an
7205 explicit call to FREETMPS, or by an implicit call at places such as
7206 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7211 /* Make a string that will exist for the duration of the expression
7212 * evaluation. Actually, it may have to last longer than that, but
7213 * hopefully we won't free it until it has been assigned to a
7214 * permanent location. */
7217 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7223 sv_setsv(sv,oldstr);
7225 PL_tmps_stack[++PL_tmps_ix] = sv;
7231 =for apidoc sv_newmortal
7233 Creates a new null SV which is mortal. The reference count of the SV is
7234 set to 1. It will be destroyed "soon", either by an explicit call to
7235 FREETMPS, or by an implicit call at places such as statement boundaries.
7236 See also C<sv_mortalcopy> and C<sv_2mortal>.
7242 Perl_sv_newmortal(pTHX)
7248 SvFLAGS(sv) = SVs_TEMP;
7250 PL_tmps_stack[++PL_tmps_ix] = sv;
7256 =for apidoc newSVpvn_flags
7258 Creates a new SV and copies a string into it. The reference count for the
7259 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7260 string. You are responsible for ensuring that the source string is at least
7261 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7262 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7263 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7264 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7265 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7267 #define newSVpvn_utf8(s, len, u) \
7268 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7274 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7279 /* All the flags we don't support must be zero.
7280 And we're new code so I'm going to assert this from the start. */
7281 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7283 sv_setpvn(sv,s,len);
7284 SvFLAGS(sv) |= (flags & SVf_UTF8);
7285 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7289 =for apidoc sv_2mortal
7291 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7292 by an explicit call to FREETMPS, or by an implicit call at places such as
7293 statement boundaries. SvTEMP() is turned on which means that the SV's
7294 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7295 and C<sv_mortalcopy>.
7301 Perl_sv_2mortal(pTHX_ register SV *const sv)
7306 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7309 PL_tmps_stack[++PL_tmps_ix] = sv;
7317 Creates a new SV and copies a string into it. The reference count for the
7318 SV is set to 1. If C<len> is zero, Perl will compute the length using
7319 strlen(). For efficiency, consider using C<newSVpvn> instead.
7325 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7331 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7336 =for apidoc newSVpvn
7338 Creates a new SV and copies a string into it. The reference count for the
7339 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7340 string. You are responsible for ensuring that the source string is at least
7341 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7347 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7353 sv_setpvn(sv,s,len);
7358 =for apidoc newSVhek
7360 Creates a new SV from the hash key structure. It will generate scalars that
7361 point to the shared string table where possible. Returns a new (undefined)
7362 SV if the hek is NULL.
7368 Perl_newSVhek(pTHX_ const HEK *const hek)
7378 if (HEK_LEN(hek) == HEf_SVKEY) {
7379 return newSVsv(*(SV**)HEK_KEY(hek));
7381 const int flags = HEK_FLAGS(hek);
7382 if (flags & HVhek_WASUTF8) {
7384 Andreas would like keys he put in as utf8 to come back as utf8
7386 STRLEN utf8_len = HEK_LEN(hek);
7387 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7388 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7391 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7393 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7394 /* We don't have a pointer to the hv, so we have to replicate the
7395 flag into every HEK. This hv is using custom a hasing
7396 algorithm. Hence we can't return a shared string scalar, as
7397 that would contain the (wrong) hash value, and might get passed
7398 into an hv routine with a regular hash.
7399 Similarly, a hash that isn't using shared hash keys has to have
7400 the flag in every key so that we know not to try to call
7401 share_hek_kek on it. */
7403 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7408 /* This will be overwhelminly the most common case. */
7410 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7411 more efficient than sharepvn(). */
7415 sv_upgrade(sv, SVt_PV);
7416 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7417 SvCUR_set(sv, HEK_LEN(hek));
7430 =for apidoc newSVpvn_share
7432 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7433 table. If the string does not already exist in the table, it is created
7434 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7435 value is used; otherwise the hash is computed. The string's hash can be later
7436 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7437 that as the string table is used for shared hash keys these strings will have
7438 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7444 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7448 bool is_utf8 = FALSE;
7449 const char *const orig_src = src;
7452 STRLEN tmplen = -len;
7454 /* See the note in hv.c:hv_fetch() --jhi */
7455 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7459 PERL_HASH(hash, src, len);
7461 sv_upgrade(sv, SVt_PV);
7462 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7470 if (src != orig_src)
7476 #if defined(PERL_IMPLICIT_CONTEXT)
7478 /* pTHX_ magic can't cope with varargs, so this is a no-context
7479 * version of the main function, (which may itself be aliased to us).
7480 * Don't access this version directly.
7484 Perl_newSVpvf_nocontext(const char *const pat, ...)
7490 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7492 va_start(args, pat);
7493 sv = vnewSVpvf(pat, &args);
7500 =for apidoc newSVpvf
7502 Creates a new SV and initializes it with the string formatted like
7509 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7514 PERL_ARGS_ASSERT_NEWSVPVF;
7516 va_start(args, pat);
7517 sv = vnewSVpvf(pat, &args);
7522 /* backend for newSVpvf() and newSVpvf_nocontext() */
7525 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7530 PERL_ARGS_ASSERT_VNEWSVPVF;
7533 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7540 Creates a new SV and copies a floating point value into it.
7541 The reference count for the SV is set to 1.
7547 Perl_newSVnv(pTHX_ const NV n)
7560 Creates a new SV and copies an integer into it. The reference count for the
7567 Perl_newSViv(pTHX_ const IV i)
7580 Creates a new SV and copies an unsigned integer into it.
7581 The reference count for the SV is set to 1.
7587 Perl_newSVuv(pTHX_ const UV u)
7598 =for apidoc newSV_type
7600 Creates a new SV, of the type specified. The reference count for the new SV
7607 Perl_newSV_type(pTHX_ const svtype type)
7612 sv_upgrade(sv, type);
7617 =for apidoc newRV_noinc
7619 Creates an RV wrapper for an SV. The reference count for the original
7620 SV is B<not> incremented.
7626 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7629 register SV *sv = newSV_type(SVt_IV);
7631 PERL_ARGS_ASSERT_NEWRV_NOINC;
7634 SvRV_set(sv, tmpRef);
7639 /* newRV_inc is the official function name to use now.
7640 * newRV_inc is in fact #defined to newRV in sv.h
7644 Perl_newRV(pTHX_ SV *const sv)
7648 PERL_ARGS_ASSERT_NEWRV;
7650 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7656 Creates a new SV which is an exact duplicate of the original SV.
7663 Perl_newSVsv(pTHX_ register SV *const old)
7670 if (SvTYPE(old) == SVTYPEMASK) {
7671 if (ckWARN_d(WARN_INTERNAL))
7672 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7676 /* SV_GMAGIC is the default for sv_setv()
7677 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7678 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7679 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7684 =for apidoc sv_reset
7686 Underlying implementation for the C<reset> Perl function.
7687 Note that the perl-level function is vaguely deprecated.
7693 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7696 char todo[PERL_UCHAR_MAX+1];
7698 PERL_ARGS_ASSERT_SV_RESET;
7703 if (!*s) { /* reset ?? searches */
7704 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7706 const U32 count = mg->mg_len / sizeof(PMOP**);
7707 PMOP **pmp = (PMOP**) mg->mg_ptr;
7708 PMOP *const *const end = pmp + count;
7712 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7714 (*pmp)->op_pmflags &= ~PMf_USED;
7722 /* reset variables */
7724 if (!HvARRAY(stash))
7727 Zero(todo, 256, char);
7730 I32 i = (unsigned char)*s;
7734 max = (unsigned char)*s++;
7735 for ( ; i <= max; i++) {
7738 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7740 for (entry = HvARRAY(stash)[i];
7742 entry = HeNEXT(entry))
7747 if (!todo[(U8)*HeKEY(entry)])
7749 gv = (GV*)HeVAL(entry);
7752 if (SvTHINKFIRST(sv)) {
7753 if (!SvREADONLY(sv) && SvROK(sv))
7755 /* XXX Is this continue a bug? Why should THINKFIRST
7756 exempt us from resetting arrays and hashes? */
7760 if (SvTYPE(sv) >= SVt_PV) {
7762 if (SvPVX_const(sv) != NULL)
7770 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7772 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7775 # if defined(USE_ENVIRON_ARRAY)
7778 # endif /* USE_ENVIRON_ARRAY */
7789 Using various gambits, try to get an IO from an SV: the IO slot if its a
7790 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7791 named after the PV if we're a string.
7797 Perl_sv_2io(pTHX_ SV *const sv)
7802 PERL_ARGS_ASSERT_SV_2IO;
7804 switch (SvTYPE(sv)) {
7812 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7816 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7818 return sv_2io(SvRV(sv));
7819 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7825 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7834 Using various gambits, try to get a CV from an SV; in addition, try if
7835 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7836 The flags in C<lref> are passed to sv_fetchsv.
7842 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7848 PERL_ARGS_ASSERT_SV_2CV;
7855 switch (SvTYPE(sv)) {
7874 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7875 tryAMAGICunDEREF(to_cv);
7878 if (SvTYPE(sv) == SVt_PVCV) {
7887 Perl_croak(aTHX_ "Not a subroutine reference");
7892 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7898 /* Some flags to gv_fetchsv mean don't really create the GV */
7899 if (SvTYPE(gv) != SVt_PVGV) {
7905 if (lref && !GvCVu(gv)) {
7909 gv_efullname3(tmpsv, gv, NULL);
7910 /* XXX this is probably not what they think they're getting.
7911 * It has the same effect as "sub name;", i.e. just a forward
7913 newSUB(start_subparse(FALSE, 0),
7914 newSVOP(OP_CONST, 0, tmpsv),
7918 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7919 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7928 Returns true if the SV has a true value by Perl's rules.
7929 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7930 instead use an in-line version.
7936 Perl_sv_true(pTHX_ register SV *const sv)
7941 register const XPV* const tXpv = (XPV*)SvANY(sv);
7943 (tXpv->xpv_cur > 1 ||
7944 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7951 return SvIVX(sv) != 0;
7954 return SvNVX(sv) != 0.0;
7956 return sv_2bool(sv);
7962 =for apidoc sv_pvn_force
7964 Get a sensible string out of the SV somehow.
7965 A private implementation of the C<SvPV_force> macro for compilers which
7966 can't cope with complex macro expressions. Always use the macro instead.
7968 =for apidoc sv_pvn_force_flags
7970 Get a sensible string out of the SV somehow.
7971 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7972 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7973 implemented in terms of this function.
7974 You normally want to use the various wrapper macros instead: see
7975 C<SvPV_force> and C<SvPV_force_nomg>
7981 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
7985 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
7987 if (SvTHINKFIRST(sv) && !SvROK(sv))
7988 sv_force_normal_flags(sv, 0);
7998 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7999 const char * const ref = sv_reftype(sv,0);
8001 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8002 ref, OP_NAME(PL_op));
8004 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8006 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8007 || isGV_with_GP(sv))
8008 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8010 s = sv_2pv_flags(sv, &len, flags);
8014 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8017 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8018 SvGROW(sv, len + 1);
8019 Move(s,SvPVX(sv),len,char);
8021 SvPVX(sv)[len] = '\0';
8024 SvPOK_on(sv); /* validate pointer */
8026 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8027 PTR2UV(sv),SvPVX_const(sv)));
8030 return SvPVX_mutable(sv);
8034 =for apidoc sv_pvbyten_force
8036 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8042 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8044 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8046 sv_pvn_force(sv,lp);
8047 sv_utf8_downgrade(sv,0);
8053 =for apidoc sv_pvutf8n_force
8055 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8061 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8063 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8065 sv_pvn_force(sv,lp);
8066 sv_utf8_upgrade(sv);
8072 =for apidoc sv_reftype
8074 Returns a string describing what the SV is a reference to.
8080 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8082 PERL_ARGS_ASSERT_SV_REFTYPE;
8084 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8085 inside return suggests a const propagation bug in g++. */
8086 if (ob && SvOBJECT(sv)) {
8087 char * const name = HvNAME_get(SvSTASH(sv));
8088 return name ? name : (char *) "__ANON__";
8091 switch (SvTYPE(sv)) {
8106 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8107 /* tied lvalues should appear to be
8108 * scalars for backwards compatitbility */
8109 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8110 ? "SCALAR" : "LVALUE");
8111 case SVt_PVAV: return "ARRAY";
8112 case SVt_PVHV: return "HASH";
8113 case SVt_PVCV: return "CODE";
8114 case SVt_PVGV: return "GLOB";
8115 case SVt_PVFM: return "FORMAT";
8116 case SVt_PVIO: return "IO";
8117 case SVt_BIND: return "BIND";
8118 case SVt_REGEXP: return "REGEXP";
8119 default: return "UNKNOWN";
8125 =for apidoc sv_isobject
8127 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8128 object. If the SV is not an RV, or if the object is not blessed, then this
8135 Perl_sv_isobject(pTHX_ SV *sv)
8151 Returns a boolean indicating whether the SV is blessed into the specified
8152 class. This does not check for subtypes; use C<sv_derived_from> to verify
8153 an inheritance relationship.
8159 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8163 PERL_ARGS_ASSERT_SV_ISA;
8173 hvname = HvNAME_get(SvSTASH(sv));
8177 return strEQ(hvname, name);
8183 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8184 it will be upgraded to one. If C<classname> is non-null then the new SV will
8185 be blessed in the specified package. The new SV is returned and its
8186 reference count is 1.
8192 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8197 PERL_ARGS_ASSERT_NEWSVRV;
8201 SV_CHECK_THINKFIRST_COW_DROP(rv);
8202 (void)SvAMAGIC_off(rv);
8204 if (SvTYPE(rv) >= SVt_PVMG) {
8205 const U32 refcnt = SvREFCNT(rv);
8209 SvREFCNT(rv) = refcnt;
8211 sv_upgrade(rv, SVt_IV);
8212 } else if (SvROK(rv)) {
8213 SvREFCNT_dec(SvRV(rv));
8215 prepare_SV_for_RV(rv);
8223 HV* const stash = gv_stashpv(classname, GV_ADD);
8224 (void)sv_bless(rv, stash);
8230 =for apidoc sv_setref_pv
8232 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8233 argument will be upgraded to an RV. That RV will be modified to point to
8234 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8235 into the SV. The C<classname> argument indicates the package for the
8236 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8237 will have a reference count of 1, and the RV will be returned.
8239 Do not use with other Perl types such as HV, AV, SV, CV, because those
8240 objects will become corrupted by the pointer copy process.
8242 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8248 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8252 PERL_ARGS_ASSERT_SV_SETREF_PV;
8255 sv_setsv(rv, &PL_sv_undef);
8259 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8264 =for apidoc sv_setref_iv
8266 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8267 argument will be upgraded to an RV. That RV will be modified to point to
8268 the new SV. The C<classname> argument indicates the package for the
8269 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8270 will have a reference count of 1, and the RV will be returned.
8276 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8278 PERL_ARGS_ASSERT_SV_SETREF_IV;
8280 sv_setiv(newSVrv(rv,classname), iv);
8285 =for apidoc sv_setref_uv
8287 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8288 argument will be upgraded to an RV. That RV will be modified to point to
8289 the new SV. The C<classname> argument indicates the package for the
8290 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8291 will have a reference count of 1, and the RV will be returned.
8297 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8299 PERL_ARGS_ASSERT_SV_SETREF_UV;
8301 sv_setuv(newSVrv(rv,classname), uv);
8306 =for apidoc sv_setref_nv
8308 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8309 argument will be upgraded to an RV. That RV will be modified to point to
8310 the new SV. The C<classname> argument indicates the package for the
8311 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8312 will have a reference count of 1, and the RV will be returned.
8318 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8320 PERL_ARGS_ASSERT_SV_SETREF_NV;
8322 sv_setnv(newSVrv(rv,classname), nv);
8327 =for apidoc sv_setref_pvn
8329 Copies a string into a new SV, optionally blessing the SV. The length of the
8330 string must be specified with C<n>. The C<rv> argument will be upgraded to
8331 an RV. That RV will be modified to point to the new SV. The C<classname>
8332 argument indicates the package for the blessing. Set C<classname> to
8333 C<NULL> to avoid the blessing. The new SV will have a reference count
8334 of 1, and the RV will be returned.
8336 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8342 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8343 const char *const pv, const STRLEN n)
8345 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8347 sv_setpvn(newSVrv(rv,classname), pv, n);
8352 =for apidoc sv_bless
8354 Blesses an SV into a specified package. The SV must be an RV. The package
8355 must be designated by its stash (see C<gv_stashpv()>). The reference count
8356 of the SV is unaffected.
8362 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8367 PERL_ARGS_ASSERT_SV_BLESS;
8370 Perl_croak(aTHX_ "Can't bless non-reference value");
8372 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8373 if (SvIsCOW(tmpRef))
8374 sv_force_normal_flags(tmpRef, 0);
8375 if (SvREADONLY(tmpRef))
8376 Perl_croak(aTHX_ PL_no_modify);
8377 if (SvOBJECT(tmpRef)) {
8378 if (SvTYPE(tmpRef) != SVt_PVIO)
8380 SvREFCNT_dec(SvSTASH(tmpRef));
8383 SvOBJECT_on(tmpRef);
8384 if (SvTYPE(tmpRef) != SVt_PVIO)
8386 SvUPGRADE(tmpRef, SVt_PVMG);
8387 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8392 (void)SvAMAGIC_off(sv);
8394 if(SvSMAGICAL(tmpRef))
8395 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8403 /* Downgrades a PVGV to a PVMG.
8407 S_sv_unglob(pTHX_ SV *const sv)
8412 SV * const temp = sv_newmortal();
8414 PERL_ARGS_ASSERT_SV_UNGLOB;
8416 assert(SvTYPE(sv) == SVt_PVGV);
8418 gv_efullname3(temp, (GV *) sv, "*");
8421 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8422 mro_method_changed_in(stash);
8426 sv_del_backref((SV*)GvSTASH(sv), sv);
8430 if (GvNAME_HEK(sv)) {
8431 unshare_hek(GvNAME_HEK(sv));
8433 isGV_with_GP_off(sv);
8435 /* need to keep SvANY(sv) in the right arena */
8436 xpvmg = new_XPVMG();
8437 StructCopy(SvANY(sv), xpvmg, XPVMG);
8438 del_XPVGV(SvANY(sv));
8441 SvFLAGS(sv) &= ~SVTYPEMASK;
8442 SvFLAGS(sv) |= SVt_PVMG;
8444 /* Intentionally not calling any local SET magic, as this isn't so much a
8445 set operation as merely an internal storage change. */
8446 sv_setsv_flags(sv, temp, 0);
8450 =for apidoc sv_unref_flags
8452 Unsets the RV status of the SV, and decrements the reference count of
8453 whatever was being referenced by the RV. This can almost be thought of
8454 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8455 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8456 (otherwise the decrementing is conditional on the reference count being
8457 different from one or the reference being a readonly SV).
8464 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8466 SV* const target = SvRV(ref);
8468 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8470 if (SvWEAKREF(ref)) {
8471 sv_del_backref(target, ref);
8473 SvRV_set(ref, NULL);
8476 SvRV_set(ref, NULL);
8478 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8479 assigned to as BEGIN {$a = \"Foo"} will fail. */
8480 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8481 SvREFCNT_dec(target);
8482 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8483 sv_2mortal(target); /* Schedule for freeing later */
8487 =for apidoc sv_untaint
8489 Untaint an SV. Use C<SvTAINTED_off> instead.
8494 Perl_sv_untaint(pTHX_ SV *const sv)
8496 PERL_ARGS_ASSERT_SV_UNTAINT;
8498 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8499 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8506 =for apidoc sv_tainted
8508 Test an SV for taintedness. Use C<SvTAINTED> instead.
8513 Perl_sv_tainted(pTHX_ SV *const sv)
8515 PERL_ARGS_ASSERT_SV_TAINTED;
8517 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8518 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8519 if (mg && (mg->mg_len & 1) )
8526 =for apidoc sv_setpviv
8528 Copies an integer into the given SV, also updating its string value.
8529 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8535 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8537 char buf[TYPE_CHARS(UV)];
8539 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8541 PERL_ARGS_ASSERT_SV_SETPVIV;
8543 sv_setpvn(sv, ptr, ebuf - ptr);
8547 =for apidoc sv_setpviv_mg
8549 Like C<sv_setpviv>, but also handles 'set' magic.
8555 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8557 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8563 #if defined(PERL_IMPLICIT_CONTEXT)
8565 /* pTHX_ magic can't cope with varargs, so this is a no-context
8566 * version of the main function, (which may itself be aliased to us).
8567 * Don't access this version directly.
8571 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8576 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8578 va_start(args, pat);
8579 sv_vsetpvf(sv, pat, &args);
8583 /* pTHX_ magic can't cope with varargs, so this is a no-context
8584 * version of the main function, (which may itself be aliased to us).
8585 * Don't access this version directly.
8589 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8594 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8596 va_start(args, pat);
8597 sv_vsetpvf_mg(sv, pat, &args);
8603 =for apidoc sv_setpvf
8605 Works like C<sv_catpvf> but copies the text into the SV instead of
8606 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8612 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8616 PERL_ARGS_ASSERT_SV_SETPVF;
8618 va_start(args, pat);
8619 sv_vsetpvf(sv, pat, &args);
8624 =for apidoc sv_vsetpvf
8626 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8627 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8629 Usually used via its frontend C<sv_setpvf>.
8635 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8637 PERL_ARGS_ASSERT_SV_VSETPVF;
8639 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8643 =for apidoc sv_setpvf_mg
8645 Like C<sv_setpvf>, but also handles 'set' magic.
8651 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8655 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8657 va_start(args, pat);
8658 sv_vsetpvf_mg(sv, pat, &args);
8663 =for apidoc sv_vsetpvf_mg
8665 Like C<sv_vsetpvf>, but also handles 'set' magic.
8667 Usually used via its frontend C<sv_setpvf_mg>.
8673 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8675 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8677 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8681 #if defined(PERL_IMPLICIT_CONTEXT)
8683 /* pTHX_ magic can't cope with varargs, so this is a no-context
8684 * version of the main function, (which may itself be aliased to us).
8685 * Don't access this version directly.
8689 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8694 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8696 va_start(args, pat);
8697 sv_vcatpvf(sv, pat, &args);
8701 /* pTHX_ magic can't cope with varargs, so this is a no-context
8702 * version of the main function, (which may itself be aliased to us).
8703 * Don't access this version directly.
8707 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8712 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8714 va_start(args, pat);
8715 sv_vcatpvf_mg(sv, pat, &args);
8721 =for apidoc sv_catpvf
8723 Processes its arguments like C<sprintf> and appends the formatted
8724 output to an SV. If the appended data contains "wide" characters
8725 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8726 and characters >255 formatted with %c), the original SV might get
8727 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8728 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8729 valid UTF-8; if the original SV was bytes, the pattern should be too.
8734 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8738 PERL_ARGS_ASSERT_SV_CATPVF;
8740 va_start(args, pat);
8741 sv_vcatpvf(sv, pat, &args);
8746 =for apidoc sv_vcatpvf
8748 Processes its arguments like C<vsprintf> and appends the formatted output
8749 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8751 Usually used via its frontend C<sv_catpvf>.
8757 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8759 PERL_ARGS_ASSERT_SV_VCATPVF;
8761 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8765 =for apidoc sv_catpvf_mg
8767 Like C<sv_catpvf>, but also handles 'set' magic.
8773 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8777 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8779 va_start(args, pat);
8780 sv_vcatpvf_mg(sv, pat, &args);
8785 =for apidoc sv_vcatpvf_mg
8787 Like C<sv_vcatpvf>, but also handles 'set' magic.
8789 Usually used via its frontend C<sv_catpvf_mg>.
8795 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8797 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8799 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8804 =for apidoc sv_vsetpvfn
8806 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8809 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8815 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8816 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8818 PERL_ARGS_ASSERT_SV_VSETPVFN;
8820 sv_setpvn(sv, "", 0);
8821 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8825 S_expect_number(pTHX_ char **const pattern)
8830 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8832 switch (**pattern) {
8833 case '1': case '2': case '3':
8834 case '4': case '5': case '6':
8835 case '7': case '8': case '9':
8836 var = *(*pattern)++ - '0';
8837 while (isDIGIT(**pattern)) {
8838 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8840 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8848 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8850 const int neg = nv < 0;
8853 PERL_ARGS_ASSERT_F0CONVERT;
8861 if (uv & 1 && uv == nv)
8862 uv--; /* Round to even */
8864 const unsigned dig = uv % 10;
8877 =for apidoc sv_vcatpvfn
8879 Processes its arguments like C<vsprintf> and appends the formatted output
8880 to an SV. Uses an array of SVs if the C style variable argument list is
8881 missing (NULL). When running with taint checks enabled, indicates via
8882 C<maybe_tainted> if results are untrustworthy (often due to the use of
8885 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8891 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8892 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8893 vec_utf8 = DO_UTF8(vecsv);
8895 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8898 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8899 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8907 static const char nullstr[] = "(null)";
8909 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8910 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8912 /* Times 4: a decimal digit takes more than 3 binary digits.
8913 * NV_DIG: mantissa takes than many decimal digits.
8914 * Plus 32: Playing safe. */
8915 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8916 /* large enough for "%#.#f" --chip */
8917 /* what about long double NVs? --jhi */
8919 PERL_ARGS_ASSERT_SV_VCATPVFN;
8920 PERL_UNUSED_ARG(maybe_tainted);
8922 /* no matter what, this is a string now */
8923 (void)SvPV_force(sv, origlen);
8925 /* special-case "", "%s", and "%-p" (SVf - see below) */
8928 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8930 const char * const s = va_arg(*args, char*);
8931 sv_catpv(sv, s ? s : nullstr);
8933 else if (svix < svmax) {
8934 sv_catsv(sv, *svargs);
8938 if (args && patlen == 3 && pat[0] == '%' &&
8939 pat[1] == '-' && pat[2] == 'p') {
8940 argsv = (SV*)va_arg(*args, void*);
8941 sv_catsv(sv, argsv);
8945 #ifndef USE_LONG_DOUBLE
8946 /* special-case "%.<number>[gf]" */
8947 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8948 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8949 unsigned digits = 0;
8953 while (*pp >= '0' && *pp <= '9')
8954 digits = 10 * digits + (*pp++ - '0');
8955 if (pp - pat == (int)patlen - 1) {
8963 /* Add check for digits != 0 because it seems that some
8964 gconverts are buggy in this case, and we don't yet have
8965 a Configure test for this. */
8966 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8967 /* 0, point, slack */
8968 Gconvert(nv, (int)digits, 0, ebuf);
8970 if (*ebuf) /* May return an empty string for digits==0 */
8973 } else if (!digits) {
8976 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8977 sv_catpvn(sv, p, l);
8983 #endif /* !USE_LONG_DOUBLE */
8985 if (!args && svix < svmax && DO_UTF8(*svargs))
8988 patend = (char*)pat + patlen;
8989 for (p = (char*)pat; p < patend; p = q) {
8992 bool vectorize = FALSE;
8993 bool vectorarg = FALSE;
8994 bool vec_utf8 = FALSE;
9000 bool has_precis = FALSE;
9002 const I32 osvix = svix;
9003 bool is_utf8 = FALSE; /* is this item utf8? */
9004 #ifdef HAS_LDBL_SPRINTF_BUG
9005 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9006 with sfio - Allen <allens@cpan.org> */
9007 bool fix_ldbl_sprintf_bug = FALSE;
9011 U8 utf8buf[UTF8_MAXBYTES+1];
9012 STRLEN esignlen = 0;
9014 const char *eptr = NULL;
9017 const U8 *vecstr = NULL;
9024 /* we need a long double target in case HAS_LONG_DOUBLE but
9027 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9035 const char *dotstr = ".";
9036 STRLEN dotstrlen = 1;
9037 I32 efix = 0; /* explicit format parameter index */
9038 I32 ewix = 0; /* explicit width index */
9039 I32 epix = 0; /* explicit precision index */
9040 I32 evix = 0; /* explicit vector index */
9041 bool asterisk = FALSE;
9043 /* echo everything up to the next format specification */
9044 for (q = p; q < patend && *q != '%'; ++q) ;
9046 if (has_utf8 && !pat_utf8)
9047 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9049 sv_catpvn(sv, p, q - p);
9056 We allow format specification elements in this order:
9057 \d+\$ explicit format parameter index
9059 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9060 0 flag (as above): repeated to allow "v02"
9061 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9062 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9064 [%bcdefginopsuxDFOUX] format (mandatory)
9069 As of perl5.9.3, printf format checking is on by default.
9070 Internally, perl uses %p formats to provide an escape to
9071 some extended formatting. This block deals with those
9072 extensions: if it does not match, (char*)q is reset and
9073 the normal format processing code is used.
9075 Currently defined extensions are:
9076 %p include pointer address (standard)
9077 %-p (SVf) include an SV (previously %_)
9078 %-<num>p include an SV with precision <num>
9079 %<num>p reserved for future extensions
9081 Robin Barker 2005-07-14
9083 %1p (VDf) removed. RMB 2007-10-19
9090 n = expect_number(&q);
9097 argsv = (SV*)va_arg(*args, void*);
9098 eptr = SvPV_const(argsv, elen);
9104 if (ckWARN_d(WARN_INTERNAL))
9105 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9106 "internal %%<num>p might conflict with future printf extensions");
9112 if ( (width = expect_number(&q)) ) {
9127 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9156 if ( (ewix = expect_number(&q)) )
9165 if ((vectorarg = asterisk)) {
9178 width = expect_number(&q);
9184 vecsv = va_arg(*args, SV*);
9186 vecsv = (evix > 0 && evix <= svmax)
9187 ? svargs[evix-1] : &PL_sv_undef;
9189 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9191 dotstr = SvPV_const(vecsv, dotstrlen);
9192 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9193 bad with tied or overloaded values that return UTF8. */
9196 else if (has_utf8) {
9197 vecsv = sv_mortalcopy(vecsv);
9198 sv_utf8_upgrade(vecsv);
9199 dotstr = SvPV_const(vecsv, dotstrlen);
9206 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9207 vecsv = svargs[efix ? efix-1 : svix++];
9208 vecstr = (U8*)SvPV_const(vecsv,veclen);
9209 vec_utf8 = DO_UTF8(vecsv);
9211 /* if this is a version object, we need to convert
9212 * back into v-string notation and then let the
9213 * vectorize happen normally
9215 if (sv_derived_from(vecsv, "version")) {
9216 char *version = savesvpv(vecsv);
9217 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9218 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9219 "vector argument not supported with alpha versions");
9222 vecsv = sv_newmortal();
9223 scan_vstring(version, version + veclen, vecsv);
9224 vecstr = (U8*)SvPV_const(vecsv, veclen);
9225 vec_utf8 = DO_UTF8(vecsv);
9237 i = va_arg(*args, int);
9239 i = (ewix ? ewix <= svmax : svix < svmax) ?
9240 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9242 width = (i < 0) ? -i : i;
9252 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9254 /* XXX: todo, support specified precision parameter */
9258 i = va_arg(*args, int);
9260 i = (ewix ? ewix <= svmax : svix < svmax)
9261 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9263 has_precis = !(i < 0);
9268 precis = precis * 10 + (*q++ - '0');
9277 case 'I': /* Ix, I32x, and I64x */
9279 if (q[1] == '6' && q[2] == '4') {
9285 if (q[1] == '3' && q[2] == '2') {
9295 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9306 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9307 if (*(q + 1) == 'l') { /* lld, llf */
9333 if (!vectorize && !args) {
9335 const I32 i = efix-1;
9336 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9338 argsv = (svix >= 0 && svix < svmax)
9339 ? svargs[svix++] : &PL_sv_undef;
9350 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9352 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9354 eptr = (char*)utf8buf;
9355 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9369 eptr = va_arg(*args, char*);
9371 #ifdef MACOS_TRADITIONAL
9372 /* On MacOS, %#s format is used for Pascal strings */
9377 elen = strlen(eptr);
9379 eptr = (char *)nullstr;
9380 elen = sizeof nullstr - 1;
9384 eptr = SvPV_const(argsv, elen);
9385 if (DO_UTF8(argsv)) {
9386 I32 old_precis = precis;
9387 if (has_precis && precis < elen) {
9389 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9392 if (width) { /* fudge width (can't fudge elen) */
9393 if (has_precis && precis < elen)
9394 width += precis - old_precis;
9396 width += elen - sv_len_utf8(argsv);
9403 if (has_precis && elen > precis)
9410 if (alt || vectorize)
9412 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9433 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9442 esignbuf[esignlen++] = plus;
9446 case 'h': iv = (short)va_arg(*args, int); break;
9447 case 'l': iv = va_arg(*args, long); break;
9448 case 'V': iv = va_arg(*args, IV); break;
9449 default: iv = va_arg(*args, int); break;
9451 case 'q': iv = va_arg(*args, Quad_t); break;
9456 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9458 case 'h': iv = (short)tiv; break;
9459 case 'l': iv = (long)tiv; break;
9461 default: iv = tiv; break;
9463 case 'q': iv = (Quad_t)tiv; break;
9467 if ( !vectorize ) /* we already set uv above */
9472 esignbuf[esignlen++] = plus;
9476 esignbuf[esignlen++] = '-';
9520 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9531 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9532 case 'l': uv = va_arg(*args, unsigned long); break;
9533 case 'V': uv = va_arg(*args, UV); break;
9534 default: uv = va_arg(*args, unsigned); break;
9536 case 'q': uv = va_arg(*args, Uquad_t); break;
9541 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9543 case 'h': uv = (unsigned short)tuv; break;
9544 case 'l': uv = (unsigned long)tuv; break;
9546 default: uv = tuv; break;
9548 case 'q': uv = (Uquad_t)tuv; break;
9555 char *ptr = ebuf + sizeof ebuf;
9556 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9562 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9568 esignbuf[esignlen++] = '0';
9569 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9577 if (alt && *ptr != '0')
9586 esignbuf[esignlen++] = '0';
9587 esignbuf[esignlen++] = c;
9590 default: /* it had better be ten or less */
9594 } while (uv /= base);
9597 elen = (ebuf + sizeof ebuf) - ptr;
9601 zeros = precis - elen;
9602 else if (precis == 0 && elen == 1 && *eptr == '0'
9603 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9606 /* a precision nullifies the 0 flag. */
9613 /* FLOATING POINT */
9616 c = 'f'; /* maybe %F isn't supported here */
9624 /* This is evil, but floating point is even more evil */
9626 /* for SV-style calling, we can only get NV
9627 for C-style calling, we assume %f is double;
9628 for simplicity we allow any of %Lf, %llf, %qf for long double
9632 #if defined(USE_LONG_DOUBLE)
9636 /* [perl #20339] - we should accept and ignore %lf rather than die */
9640 #if defined(USE_LONG_DOUBLE)
9641 intsize = args ? 0 : 'q';
9645 #if defined(HAS_LONG_DOUBLE)
9654 /* now we need (long double) if intsize == 'q', else (double) */
9656 #if LONG_DOUBLESIZE > DOUBLESIZE
9658 va_arg(*args, long double) :
9659 va_arg(*args, double)
9661 va_arg(*args, double)
9666 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9667 else. frexp() has some unspecified behaviour for those three */
9668 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9670 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9671 will cast our (long double) to (double) */
9672 (void)Perl_frexp(nv, &i);
9673 if (i == PERL_INT_MIN)
9674 Perl_die(aTHX_ "panic: frexp");
9676 need = BIT_DIGITS(i);
9678 need += has_precis ? precis : 6; /* known default */
9683 #ifdef HAS_LDBL_SPRINTF_BUG
9684 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9685 with sfio - Allen <allens@cpan.org> */
9688 # define MY_DBL_MAX DBL_MAX
9689 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9690 # if DOUBLESIZE >= 8
9691 # define MY_DBL_MAX 1.7976931348623157E+308L
9693 # define MY_DBL_MAX 3.40282347E+38L
9697 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9698 # define MY_DBL_MAX_BUG 1L
9700 # define MY_DBL_MAX_BUG MY_DBL_MAX
9704 # define MY_DBL_MIN DBL_MIN
9705 # else /* XXX guessing! -Allen */
9706 # if DOUBLESIZE >= 8
9707 # define MY_DBL_MIN 2.2250738585072014E-308L
9709 # define MY_DBL_MIN 1.17549435E-38L
9713 if ((intsize == 'q') && (c == 'f') &&
9714 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9716 /* it's going to be short enough that
9717 * long double precision is not needed */
9719 if ((nv <= 0L) && (nv >= -0L))
9720 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9722 /* would use Perl_fp_class as a double-check but not
9723 * functional on IRIX - see perl.h comments */
9725 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9726 /* It's within the range that a double can represent */
9727 #if defined(DBL_MAX) && !defined(DBL_MIN)
9728 if ((nv >= ((long double)1/DBL_MAX)) ||
9729 (nv <= (-(long double)1/DBL_MAX)))
9731 fix_ldbl_sprintf_bug = TRUE;
9734 if (fix_ldbl_sprintf_bug == TRUE) {
9744 # undef MY_DBL_MAX_BUG
9747 #endif /* HAS_LDBL_SPRINTF_BUG */
9749 need += 20; /* fudge factor */
9750 if (PL_efloatsize < need) {
9751 Safefree(PL_efloatbuf);
9752 PL_efloatsize = need + 20; /* more fudge */
9753 Newx(PL_efloatbuf, PL_efloatsize, char);
9754 PL_efloatbuf[0] = '\0';
9757 if ( !(width || left || plus || alt) && fill != '0'
9758 && has_precis && intsize != 'q' ) { /* Shortcuts */
9759 /* See earlier comment about buggy Gconvert when digits,
9761 if ( c == 'g' && precis) {
9762 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9763 /* May return an empty string for digits==0 */
9764 if (*PL_efloatbuf) {
9765 elen = strlen(PL_efloatbuf);
9766 goto float_converted;
9768 } else if ( c == 'f' && !precis) {
9769 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9774 char *ptr = ebuf + sizeof ebuf;
9777 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9778 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9779 if (intsize == 'q') {
9780 /* Copy the one or more characters in a long double
9781 * format before the 'base' ([efgEFG]) character to
9782 * the format string. */
9783 static char const prifldbl[] = PERL_PRIfldbl;
9784 char const *p = prifldbl + sizeof(prifldbl) - 3;
9785 while (p >= prifldbl) { *--ptr = *p--; }
9790 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9795 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9807 /* No taint. Otherwise we are in the strange situation
9808 * where printf() taints but print($float) doesn't.
9810 #if defined(HAS_LONG_DOUBLE)
9811 elen = ((intsize == 'q')
9812 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9813 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9815 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9819 eptr = PL_efloatbuf;
9827 i = SvCUR(sv) - origlen;
9830 case 'h': *(va_arg(*args, short*)) = i; break;
9831 default: *(va_arg(*args, int*)) = i; break;
9832 case 'l': *(va_arg(*args, long*)) = i; break;
9833 case 'V': *(va_arg(*args, IV*)) = i; break;
9835 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9840 sv_setuv_mg(argsv, (UV)i);
9841 continue; /* not "break" */
9848 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9849 && ckWARN(WARN_PRINTF))
9851 SV * const msg = sv_newmortal();
9852 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9853 (PL_op->op_type == OP_PRTF) ? "" : "s");
9856 Perl_sv_catpvf(aTHX_ msg,
9857 "\"%%%c\"", c & 0xFF);
9859 Perl_sv_catpvf(aTHX_ msg,
9860 "\"%%\\%03"UVof"\"",
9863 sv_catpvs(msg, "end of string");
9864 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9867 /* output mangled stuff ... */
9873 /* ... right here, because formatting flags should not apply */
9874 SvGROW(sv, SvCUR(sv) + elen + 1);
9876 Copy(eptr, p, elen, char);
9879 SvCUR_set(sv, p - SvPVX_const(sv));
9881 continue; /* not "break" */
9884 if (is_utf8 != has_utf8) {
9887 sv_utf8_upgrade(sv);
9890 const STRLEN old_elen = elen;
9891 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9892 sv_utf8_upgrade(nsv);
9893 eptr = SvPVX_const(nsv);
9896 if (width) { /* fudge width (can't fudge elen) */
9897 width += elen - old_elen;
9903 have = esignlen + zeros + elen;
9905 Perl_croak_nocontext(PL_memory_wrap);
9907 need = (have > width ? have : width);
9910 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9911 Perl_croak_nocontext(PL_memory_wrap);
9912 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9914 if (esignlen && fill == '0') {
9916 for (i = 0; i < (int)esignlen; i++)
9920 memset(p, fill, gap);
9923 if (esignlen && fill != '0') {
9925 for (i = 0; i < (int)esignlen; i++)
9930 for (i = zeros; i; i--)
9934 Copy(eptr, p, elen, char);
9938 memset(p, ' ', gap);
9943 Copy(dotstr, p, dotstrlen, char);
9947 vectorize = FALSE; /* done iterating over vecstr */
9954 SvCUR_set(sv, p - SvPVX_const(sv));
9962 /* =========================================================================
9964 =head1 Cloning an interpreter
9966 All the macros and functions in this section are for the private use of
9967 the main function, perl_clone().
9969 The foo_dup() functions make an exact copy of an existing foo thingy.
9970 During the course of a cloning, a hash table is used to map old addresses
9971 to new addresses. The table is created and manipulated with the
9972 ptr_table_* functions.
9976 ============================================================================*/
9979 #if defined(USE_ITHREADS)
9981 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9982 #ifndef GpREFCNT_inc
9983 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9987 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9988 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9989 If this changes, please unmerge ss_dup. */
9990 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9991 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9992 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9993 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9994 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9995 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9996 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9997 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9998 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9999 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10000 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10001 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10002 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10003 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10005 /* clone a parser */
10008 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10012 PERL_ARGS_ASSERT_PARSER_DUP;
10017 /* look for it in the table first */
10018 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10022 /* create anew and remember what it is */
10023 Newxz(parser, 1, yy_parser);
10024 ptr_table_store(PL_ptr_table, proto, parser);
10026 parser->yyerrstatus = 0;
10027 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10029 /* XXX these not yet duped */
10030 parser->old_parser = NULL;
10031 parser->stack = NULL;
10033 parser->stack_size = 0;
10034 /* XXX parser->stack->state = 0; */
10036 /* XXX eventually, just Copy() most of the parser struct ? */
10038 parser->lex_brackets = proto->lex_brackets;
10039 parser->lex_casemods = proto->lex_casemods;
10040 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10041 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10042 parser->lex_casestack = savepvn(proto->lex_casestack,
10043 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10044 parser->lex_defer = proto->lex_defer;
10045 parser->lex_dojoin = proto->lex_dojoin;
10046 parser->lex_expect = proto->lex_expect;
10047 parser->lex_formbrack = proto->lex_formbrack;
10048 parser->lex_inpat = proto->lex_inpat;
10049 parser->lex_inwhat = proto->lex_inwhat;
10050 parser->lex_op = proto->lex_op;
10051 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10052 parser->lex_starts = proto->lex_starts;
10053 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10054 parser->multi_close = proto->multi_close;
10055 parser->multi_open = proto->multi_open;
10056 parser->multi_start = proto->multi_start;
10057 parser->multi_end = proto->multi_end;
10058 parser->pending_ident = proto->pending_ident;
10059 parser->preambled = proto->preambled;
10060 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10061 parser->linestr = sv_dup_inc(proto->linestr, param);
10062 parser->expect = proto->expect;
10063 parser->copline = proto->copline;
10064 parser->last_lop_op = proto->last_lop_op;
10065 parser->lex_state = proto->lex_state;
10066 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10067 /* rsfp_filters entries have fake IoDIRP() */
10068 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10069 parser->in_my = proto->in_my;
10070 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10071 parser->error_count = proto->error_count;
10074 parser->linestr = sv_dup_inc(proto->linestr, param);
10077 char * const ols = SvPVX(proto->linestr);
10078 char * const ls = SvPVX(parser->linestr);
10080 parser->bufptr = ls + (proto->bufptr >= ols ?
10081 proto->bufptr - ols : 0);
10082 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10083 proto->oldbufptr - ols : 0);
10084 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10085 proto->oldoldbufptr - ols : 0);
10086 parser->linestart = ls + (proto->linestart >= ols ?
10087 proto->linestart - ols : 0);
10088 parser->last_uni = ls + (proto->last_uni >= ols ?
10089 proto->last_uni - ols : 0);
10090 parser->last_lop = ls + (proto->last_lop >= ols ?
10091 proto->last_lop - ols : 0);
10093 parser->bufend = ls + SvCUR(parser->linestr);
10096 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10100 parser->endwhite = proto->endwhite;
10101 parser->faketokens = proto->faketokens;
10102 parser->lasttoke = proto->lasttoke;
10103 parser->nextwhite = proto->nextwhite;
10104 parser->realtokenstart = proto->realtokenstart;
10105 parser->skipwhite = proto->skipwhite;
10106 parser->thisclose = proto->thisclose;
10107 parser->thismad = proto->thismad;
10108 parser->thisopen = proto->thisopen;
10109 parser->thisstuff = proto->thisstuff;
10110 parser->thistoken = proto->thistoken;
10111 parser->thiswhite = proto->thiswhite;
10113 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10114 parser->curforce = proto->curforce;
10116 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10117 Copy(proto->nexttype, parser->nexttype, 5, I32);
10118 parser->nexttoke = proto->nexttoke;
10124 /* duplicate a file handle */
10127 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10131 PERL_ARGS_ASSERT_FP_DUP;
10132 PERL_UNUSED_ARG(type);
10135 return (PerlIO*)NULL;
10137 /* look for it in the table first */
10138 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10142 /* create anew and remember what it is */
10143 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10144 ptr_table_store(PL_ptr_table, fp, ret);
10148 /* duplicate a directory handle */
10151 Perl_dirp_dup(pTHX_ DIR *const dp)
10153 PERL_UNUSED_CONTEXT;
10160 /* duplicate a typeglob */
10163 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10167 PERL_ARGS_ASSERT_GP_DUP;
10171 /* look for it in the table first */
10172 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10176 /* create anew and remember what it is */
10178 ptr_table_store(PL_ptr_table, gp, ret);
10181 ret->gp_refcnt = 0; /* must be before any other dups! */
10182 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10183 ret->gp_io = io_dup_inc(gp->gp_io, param);
10184 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10185 ret->gp_av = av_dup_inc(gp->gp_av, param);
10186 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10187 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10188 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10189 ret->gp_cvgen = gp->gp_cvgen;
10190 ret->gp_line = gp->gp_line;
10191 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10195 /* duplicate a chain of magic */
10198 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10200 MAGIC *mgprev = (MAGIC*)NULL;
10203 PERL_ARGS_ASSERT_MG_DUP;
10206 return (MAGIC*)NULL;
10207 /* look for it in the table first */
10208 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10212 for (; mg; mg = mg->mg_moremagic) {
10214 Newxz(nmg, 1, MAGIC);
10216 mgprev->mg_moremagic = nmg;
10219 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10220 nmg->mg_private = mg->mg_private;
10221 nmg->mg_type = mg->mg_type;
10222 nmg->mg_flags = mg->mg_flags;
10223 /* FIXME for plugins
10224 if (mg->mg_type == PERL_MAGIC_qr) {
10225 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10229 if(mg->mg_type == PERL_MAGIC_backref) {
10230 /* The backref AV has its reference count deliberately bumped by
10232 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10235 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10236 ? sv_dup_inc(mg->mg_obj, param)
10237 : sv_dup(mg->mg_obj, param);
10239 nmg->mg_len = mg->mg_len;
10240 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10241 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10242 if (mg->mg_len > 0) {
10243 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10244 if (mg->mg_type == PERL_MAGIC_overload_table &&
10245 AMT_AMAGIC((AMT*)mg->mg_ptr))
10247 const AMT * const amtp = (AMT*)mg->mg_ptr;
10248 AMT * const namtp = (AMT*)nmg->mg_ptr;
10250 for (i = 1; i < NofAMmeth; i++) {
10251 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10255 else if (mg->mg_len == HEf_SVKEY)
10256 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10258 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10259 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10266 #endif /* USE_ITHREADS */
10268 /* create a new pointer-mapping table */
10271 Perl_ptr_table_new(pTHX)
10274 PERL_UNUSED_CONTEXT;
10276 Newxz(tbl, 1, PTR_TBL_t);
10277 tbl->tbl_max = 511;
10278 tbl->tbl_items = 0;
10279 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10283 #define PTR_TABLE_HASH(ptr) \
10284 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10287 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10288 following define) and at call to new_body_inline made below in
10289 Perl_ptr_table_store()
10292 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10294 /* map an existing pointer using a table */
10296 STATIC PTR_TBL_ENT_t *
10297 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10299 PTR_TBL_ENT_t *tblent;
10300 const UV hash = PTR_TABLE_HASH(sv);
10302 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10304 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10305 for (; tblent; tblent = tblent->next) {
10306 if (tblent->oldval == sv)
10313 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10315 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10317 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10318 PERL_UNUSED_CONTEXT;
10320 return tblent ? tblent->newval : NULL;
10323 /* add a new entry to a pointer-mapping table */
10326 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10328 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10330 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10331 PERL_UNUSED_CONTEXT;
10334 tblent->newval = newsv;
10336 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10338 new_body_inline(tblent, PTE_SVSLOT);
10340 tblent->oldval = oldsv;
10341 tblent->newval = newsv;
10342 tblent->next = tbl->tbl_ary[entry];
10343 tbl->tbl_ary[entry] = tblent;
10345 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10346 ptr_table_split(tbl);
10350 /* double the hash bucket size of an existing ptr table */
10353 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10355 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10356 const UV oldsize = tbl->tbl_max + 1;
10357 UV newsize = oldsize * 2;
10360 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10361 PERL_UNUSED_CONTEXT;
10363 Renew(ary, newsize, PTR_TBL_ENT_t*);
10364 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10365 tbl->tbl_max = --newsize;
10366 tbl->tbl_ary = ary;
10367 for (i=0; i < oldsize; i++, ary++) {
10368 PTR_TBL_ENT_t **curentp, **entp, *ent;
10371 curentp = ary + oldsize;
10372 for (entp = ary, ent = *ary; ent; ent = *entp) {
10373 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10375 ent->next = *curentp;
10385 /* remove all the entries from a ptr table */
10388 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10390 if (tbl && tbl->tbl_items) {
10391 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10392 UV riter = tbl->tbl_max;
10395 PTR_TBL_ENT_t *entry = array[riter];
10398 PTR_TBL_ENT_t * const oentry = entry;
10399 entry = entry->next;
10404 tbl->tbl_items = 0;
10408 /* clear and free a ptr table */
10411 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10416 ptr_table_clear(tbl);
10417 Safefree(tbl->tbl_ary);
10421 #if defined(USE_ITHREADS)
10424 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10426 PERL_ARGS_ASSERT_RVPV_DUP;
10429 SvRV_set(dstr, SvWEAKREF(sstr)
10430 ? sv_dup(SvRV(sstr), param)
10431 : sv_dup_inc(SvRV(sstr), param));
10434 else if (SvPVX_const(sstr)) {
10435 /* Has something there */
10437 /* Normal PV - clone whole allocated space */
10438 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10439 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10440 /* Not that normal - actually sstr is copy on write.
10441 But we are a true, independant SV, so: */
10442 SvREADONLY_off(dstr);
10447 /* Special case - not normally malloced for some reason */
10448 if (isGV_with_GP(sstr)) {
10449 /* Don't need to do anything here. */
10451 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10452 /* A "shared" PV - clone it as "shared" PV */
10454 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10458 /* Some other special case - random pointer */
10459 SvPV_set(dstr, SvPVX(sstr));
10464 /* Copy the NULL */
10465 SvPV_set(dstr, NULL);
10469 /* duplicate an SV of any type (including AV, HV etc) */
10472 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10477 PERL_ARGS_ASSERT_SV_DUP;
10481 if (SvTYPE(sstr) == SVTYPEMASK) {
10482 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10487 /* look for it in the table first */
10488 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10492 if(param->flags & CLONEf_JOIN_IN) {
10493 /** We are joining here so we don't want do clone
10494 something that is bad **/
10495 if (SvTYPE(sstr) == SVt_PVHV) {
10496 const HEK * const hvname = HvNAME_HEK(sstr);
10498 /** don't clone stashes if they already exist **/
10499 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10503 /* create anew and remember what it is */
10506 #ifdef DEBUG_LEAKING_SCALARS
10507 dstr->sv_debug_optype = sstr->sv_debug_optype;
10508 dstr->sv_debug_line = sstr->sv_debug_line;
10509 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10510 dstr->sv_debug_cloned = 1;
10511 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10514 ptr_table_store(PL_ptr_table, sstr, dstr);
10517 SvFLAGS(dstr) = SvFLAGS(sstr);
10518 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10519 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10522 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10523 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10524 (void*)PL_watch_pvx, SvPVX_const(sstr));
10527 /* don't clone objects whose class has asked us not to */
10528 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10533 switch (SvTYPE(sstr)) {
10535 SvANY(dstr) = NULL;
10538 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10540 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10542 SvIV_set(dstr, SvIVX(sstr));
10546 SvANY(dstr) = new_XNV();
10547 SvNV_set(dstr, SvNVX(sstr));
10549 /* case SVt_BIND: */
10552 /* These are all the types that need complex bodies allocating. */
10554 const svtype sv_type = SvTYPE(sstr);
10555 const struct body_details *const sv_type_details
10556 = bodies_by_type + sv_type;
10560 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10564 if (GvUNIQUE((GV*)sstr)) {
10565 NOOP; /* Do sharing here, and fall through */
10578 assert(sv_type_details->body_size);
10579 if (sv_type_details->arena) {
10580 new_body_inline(new_body, sv_type);
10582 = (void*)((char*)new_body - sv_type_details->offset);
10584 new_body = new_NOARENA(sv_type_details);
10588 SvANY(dstr) = new_body;
10591 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10592 ((char*)SvANY(dstr)) + sv_type_details->offset,
10593 sv_type_details->copy, char);
10595 Copy(((char*)SvANY(sstr)),
10596 ((char*)SvANY(dstr)),
10597 sv_type_details->body_size + sv_type_details->offset, char);
10600 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10601 && !isGV_with_GP(dstr))
10602 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10604 /* The Copy above means that all the source (unduplicated) pointers
10605 are now in the destination. We can check the flags and the
10606 pointers in either, but it's possible that there's less cache
10607 missing by always going for the destination.
10608 FIXME - instrument and check that assumption */
10609 if (sv_type >= SVt_PVMG) {
10610 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10611 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10612 } else if (SvMAGIC(dstr))
10613 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10615 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10618 /* The cast silences a GCC warning about unhandled types. */
10619 switch ((int)sv_type) {
10629 /* FIXME for plugins */
10630 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10633 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10634 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10635 LvTARG(dstr) = dstr;
10636 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10637 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10639 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10641 if(isGV_with_GP(sstr)) {
10642 if (GvNAME_HEK(dstr))
10643 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10644 /* Don't call sv_add_backref here as it's going to be
10645 created as part of the magic cloning of the symbol
10647 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10648 at the point of this comment. */
10649 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10650 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10651 (void)GpREFCNT_inc(GvGP(dstr));
10653 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10656 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10657 if (IoOFP(dstr) == IoIFP(sstr))
10658 IoOFP(dstr) = IoIFP(dstr);
10660 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10661 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10662 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10663 /* I have no idea why fake dirp (rsfps)
10664 should be treated differently but otherwise
10665 we end up with leaks -- sky*/
10666 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10667 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10668 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10670 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10671 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10672 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10673 if (IoDIRP(dstr)) {
10674 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10677 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10680 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10681 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10682 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10685 if (AvARRAY((AV*)sstr)) {
10686 SV **dst_ary, **src_ary;
10687 SSize_t items = AvFILLp((AV*)sstr) + 1;
10689 src_ary = AvARRAY((AV*)sstr);
10690 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10691 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10692 AvARRAY((AV*)dstr) = dst_ary;
10693 AvALLOC((AV*)dstr) = dst_ary;
10694 if (AvREAL((AV*)sstr)) {
10695 while (items-- > 0)
10696 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10699 while (items-- > 0)
10700 *dst_ary++ = sv_dup(*src_ary++, param);
10702 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10703 while (items-- > 0) {
10704 *dst_ary++ = &PL_sv_undef;
10708 AvARRAY((AV*)dstr) = NULL;
10709 AvALLOC((AV*)dstr) = (SV**)NULL;
10713 if (HvARRAY((HV*)sstr)) {
10715 const bool sharekeys = !!HvSHAREKEYS(sstr);
10716 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10717 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10719 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10720 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10722 HvARRAY(dstr) = (HE**)darray;
10723 while (i <= sxhv->xhv_max) {
10724 const HE * const source = HvARRAY(sstr)[i];
10725 HvARRAY(dstr)[i] = source
10726 ? he_dup(source, sharekeys, param) : 0;
10731 const struct xpvhv_aux * const saux = HvAUX(sstr);
10732 struct xpvhv_aux * const daux = HvAUX(dstr);
10733 /* This flag isn't copied. */
10734 /* SvOOK_on(hv) attacks the IV flags. */
10735 SvFLAGS(dstr) |= SVf_OOK;
10737 hvname = saux->xhv_name;
10738 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10740 daux->xhv_riter = saux->xhv_riter;
10741 daux->xhv_eiter = saux->xhv_eiter
10742 ? he_dup(saux->xhv_eiter,
10743 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10744 daux->xhv_backreferences =
10745 saux->xhv_backreferences
10746 ? (AV*) SvREFCNT_inc(
10747 sv_dup((SV*)saux->xhv_backreferences, param))
10750 daux->xhv_mro_meta = saux->xhv_mro_meta
10751 ? mro_meta_dup(saux->xhv_mro_meta, param)
10754 /* Record stashes for possible cloning in Perl_clone(). */
10756 av_push(param->stashes, dstr);
10760 HvARRAY((HV*)dstr) = NULL;
10763 if (!(param->flags & CLONEf_COPY_STACKS)) {
10767 /* NOTE: not refcounted */
10768 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10770 if (!CvISXSUB(dstr))
10771 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10773 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10774 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10775 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10776 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10778 /* don't dup if copying back - CvGV isn't refcounted, so the
10779 * duped GV may never be freed. A bit of a hack! DAPM */
10780 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10781 NULL : gv_dup(CvGV(dstr), param) ;
10782 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10784 CvWEAKOUTSIDE(sstr)
10785 ? cv_dup( CvOUTSIDE(dstr), param)
10786 : cv_dup_inc(CvOUTSIDE(dstr), param);
10787 if (!CvISXSUB(dstr))
10788 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10794 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10800 /* duplicate a context */
10803 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10805 PERL_CONTEXT *ncxs;
10807 PERL_ARGS_ASSERT_CX_DUP;
10810 return (PERL_CONTEXT*)NULL;
10812 /* look for it in the table first */
10813 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10817 /* create anew and remember what it is */
10818 Newx(ncxs, max + 1, PERL_CONTEXT);
10819 ptr_table_store(PL_ptr_table, cxs, ncxs);
10820 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10823 PERL_CONTEXT * const ncx = &ncxs[ix];
10824 if (CxTYPE(ncx) == CXt_SUBST) {
10825 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10828 switch (CxTYPE(ncx)) {
10830 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10831 ? cv_dup_inc(ncx->blk_sub.cv, param)
10832 : cv_dup(ncx->blk_sub.cv,param));
10833 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10834 ? av_dup_inc(ncx->blk_sub.argarray,
10837 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10839 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10840 ncx->blk_sub.oldcomppad);
10843 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10845 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10847 case CXt_LOOP_LAZYSV:
10848 ncx->blk_loop.state_u.lazysv.end
10849 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10850 /* We are taking advantage of av_dup_inc and sv_dup_inc
10851 actually being the same function, and order equivalance of
10853 We can assert the later [but only at run time :-(] */
10854 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10855 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10857 ncx->blk_loop.state_u.ary.ary
10858 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10859 case CXt_LOOP_LAZYIV:
10860 case CXt_LOOP_PLAIN:
10861 if (CxPADLOOP(ncx)) {
10862 ncx->blk_loop.oldcomppad
10863 = (PAD*)ptr_table_fetch(PL_ptr_table,
10864 ncx->blk_loop.oldcomppad);
10866 ncx->blk_loop.oldcomppad
10867 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10871 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10872 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10873 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10886 /* duplicate a stack info structure */
10889 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10893 PERL_ARGS_ASSERT_SI_DUP;
10896 return (PERL_SI*)NULL;
10898 /* look for it in the table first */
10899 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10903 /* create anew and remember what it is */
10904 Newxz(nsi, 1, PERL_SI);
10905 ptr_table_store(PL_ptr_table, si, nsi);
10907 nsi->si_stack = av_dup_inc(si->si_stack, param);
10908 nsi->si_cxix = si->si_cxix;
10909 nsi->si_cxmax = si->si_cxmax;
10910 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10911 nsi->si_type = si->si_type;
10912 nsi->si_prev = si_dup(si->si_prev, param);
10913 nsi->si_next = si_dup(si->si_next, param);
10914 nsi->si_markoff = si->si_markoff;
10919 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10920 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10921 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10922 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10923 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10924 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10925 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10926 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10927 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10928 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10929 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10930 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10931 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10932 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10935 #define pv_dup_inc(p) SAVEPV(p)
10936 #define pv_dup(p) SAVEPV(p)
10937 #define svp_dup_inc(p,pp) any_dup(p,pp)
10939 /* map any object to the new equivent - either something in the
10940 * ptr table, or something in the interpreter structure
10944 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10948 PERL_ARGS_ASSERT_ANY_DUP;
10951 return (void*)NULL;
10953 /* look for it in the table first */
10954 ret = ptr_table_fetch(PL_ptr_table, v);
10958 /* see if it is part of the interpreter structure */
10959 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10960 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10968 /* duplicate the save stack */
10971 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10974 ANY * const ss = proto_perl->Isavestack;
10975 const I32 max = proto_perl->Isavestack_max;
10976 I32 ix = proto_perl->Isavestack_ix;
10989 void (*dptr) (void*);
10990 void (*dxptr) (pTHX_ void*);
10992 PERL_ARGS_ASSERT_SS_DUP;
10994 Newxz(nss, max, ANY);
10997 const I32 type = POPINT(ss,ix);
10998 TOPINT(nss,ix) = type;
11000 case SAVEt_HELEM: /* hash element */
11001 sv = (SV*)POPPTR(ss,ix);
11002 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11004 case SAVEt_ITEM: /* normal string */
11005 case SAVEt_SV: /* scalar reference */
11006 sv = (SV*)POPPTR(ss,ix);
11007 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11010 case SAVEt_MORTALIZESV:
11011 sv = (SV*)POPPTR(ss,ix);
11012 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11014 case SAVEt_SHARED_PVREF: /* char* in shared space */
11015 c = (char*)POPPTR(ss,ix);
11016 TOPPTR(nss,ix) = savesharedpv(c);
11017 ptr = POPPTR(ss,ix);
11018 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11020 case SAVEt_GENERIC_SVREF: /* generic sv */
11021 case SAVEt_SVREF: /* scalar reference */
11022 sv = (SV*)POPPTR(ss,ix);
11023 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11024 ptr = POPPTR(ss,ix);
11025 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11027 case SAVEt_HV: /* hash reference */
11028 case SAVEt_AV: /* array reference */
11029 sv = (SV*) POPPTR(ss,ix);
11030 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11032 case SAVEt_COMPPAD:
11034 sv = (SV*) POPPTR(ss,ix);
11035 TOPPTR(nss,ix) = sv_dup(sv, param);
11037 case SAVEt_INT: /* int reference */
11038 ptr = POPPTR(ss,ix);
11039 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11040 intval = (int)POPINT(ss,ix);
11041 TOPINT(nss,ix) = intval;
11043 case SAVEt_LONG: /* long reference */
11044 ptr = POPPTR(ss,ix);
11045 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11047 case SAVEt_CLEARSV:
11048 longval = (long)POPLONG(ss,ix);
11049 TOPLONG(nss,ix) = longval;
11051 case SAVEt_I32: /* I32 reference */
11052 case SAVEt_I16: /* I16 reference */
11053 case SAVEt_I8: /* I8 reference */
11054 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11055 ptr = POPPTR(ss,ix);
11056 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11058 TOPINT(nss,ix) = i;
11060 case SAVEt_IV: /* IV reference */
11061 ptr = POPPTR(ss,ix);
11062 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11064 TOPIV(nss,ix) = iv;
11066 case SAVEt_HPTR: /* HV* reference */
11067 case SAVEt_APTR: /* AV* reference */
11068 case SAVEt_SPTR: /* SV* reference */
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11071 sv = (SV*)POPPTR(ss,ix);
11072 TOPPTR(nss,ix) = sv_dup(sv, param);
11074 case SAVEt_VPTR: /* random* reference */
11075 ptr = POPPTR(ss,ix);
11076 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11077 ptr = POPPTR(ss,ix);
11078 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11080 case SAVEt_GENERIC_PVREF: /* generic char* */
11081 case SAVEt_PPTR: /* char* reference */
11082 ptr = POPPTR(ss,ix);
11083 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11084 c = (char*)POPPTR(ss,ix);
11085 TOPPTR(nss,ix) = pv_dup(c);
11087 case SAVEt_GP: /* scalar reference */
11088 gp = (GP*)POPPTR(ss,ix);
11089 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11090 (void)GpREFCNT_inc(gp);
11091 gv = (GV*)POPPTR(ss,ix);
11092 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11095 ptr = POPPTR(ss,ix);
11096 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11097 /* these are assumed to be refcounted properly */
11099 switch (((OP*)ptr)->op_type) {
11101 case OP_LEAVESUBLV:
11105 case OP_LEAVEWRITE:
11106 TOPPTR(nss,ix) = ptr;
11109 (void) OpREFCNT_inc(o);
11113 TOPPTR(nss,ix) = NULL;
11118 TOPPTR(nss,ix) = NULL;
11121 c = (char*)POPPTR(ss,ix);
11122 TOPPTR(nss,ix) = pv_dup_inc(c);
11125 hv = (HV*)POPPTR(ss,ix);
11126 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11127 c = (char*)POPPTR(ss,ix);
11128 TOPPTR(nss,ix) = pv_dup_inc(c);
11130 case SAVEt_STACK_POS: /* Position on Perl stack */
11132 TOPINT(nss,ix) = i;
11134 case SAVEt_DESTRUCTOR:
11135 ptr = POPPTR(ss,ix);
11136 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11137 dptr = POPDPTR(ss,ix);
11138 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11139 any_dup(FPTR2DPTR(void *, dptr),
11142 case SAVEt_DESTRUCTOR_X:
11143 ptr = POPPTR(ss,ix);
11144 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11145 dxptr = POPDXPTR(ss,ix);
11146 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11147 any_dup(FPTR2DPTR(void *, dxptr),
11150 case SAVEt_REGCONTEXT:
11153 TOPINT(nss,ix) = i;
11156 case SAVEt_AELEM: /* array element */
11157 sv = (SV*)POPPTR(ss,ix);
11158 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11160 TOPINT(nss,ix) = i;
11161 av = (AV*)POPPTR(ss,ix);
11162 TOPPTR(nss,ix) = av_dup_inc(av, param);
11165 ptr = POPPTR(ss,ix);
11166 TOPPTR(nss,ix) = ptr;
11170 TOPINT(nss,ix) = i;
11171 ptr = POPPTR(ss,ix);
11174 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11175 HINTS_REFCNT_UNLOCK;
11177 TOPPTR(nss,ix) = ptr;
11178 if (i & HINT_LOCALIZE_HH) {
11179 hv = (HV*)POPPTR(ss,ix);
11180 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11183 case SAVEt_PADSV_AND_MORTALIZE:
11184 longval = (long)POPLONG(ss,ix);
11185 TOPLONG(nss,ix) = longval;
11186 ptr = POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11188 sv = (SV*)POPPTR(ss,ix);
11189 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11192 ptr = POPPTR(ss,ix);
11193 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11194 longval = (long)POPBOOL(ss,ix);
11195 TOPBOOL(nss,ix) = (bool)longval;
11197 case SAVEt_SET_SVFLAGS:
11199 TOPINT(nss,ix) = i;
11201 TOPINT(nss,ix) = i;
11202 sv = (SV*)POPPTR(ss,ix);
11203 TOPPTR(nss,ix) = sv_dup(sv, param);
11205 case SAVEt_RE_STATE:
11207 const struct re_save_state *const old_state
11208 = (struct re_save_state *)
11209 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11210 struct re_save_state *const new_state
11211 = (struct re_save_state *)
11212 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11214 Copy(old_state, new_state, 1, struct re_save_state);
11215 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11217 new_state->re_state_bostr
11218 = pv_dup(old_state->re_state_bostr);
11219 new_state->re_state_reginput
11220 = pv_dup(old_state->re_state_reginput);
11221 new_state->re_state_regeol
11222 = pv_dup(old_state->re_state_regeol);
11223 new_state->re_state_regoffs
11224 = (regexp_paren_pair*)
11225 any_dup(old_state->re_state_regoffs, proto_perl);
11226 new_state->re_state_reglastparen
11227 = (U32*) any_dup(old_state->re_state_reglastparen,
11229 new_state->re_state_reglastcloseparen
11230 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11232 /* XXX This just has to be broken. The old save_re_context
11233 code did SAVEGENERICPV(PL_reg_start_tmp);
11234 PL_reg_start_tmp is char **.
11235 Look above to what the dup code does for
11236 SAVEt_GENERIC_PVREF
11237 It can never have worked.
11238 So this is merely a faithful copy of the exiting bug: */
11239 new_state->re_state_reg_start_tmp
11240 = (char **) pv_dup((char *)
11241 old_state->re_state_reg_start_tmp);
11242 /* I assume that it only ever "worked" because no-one called
11243 (pseudo)fork while the regexp engine had re-entered itself.
11245 #ifdef PERL_OLD_COPY_ON_WRITE
11246 new_state->re_state_nrs
11247 = sv_dup(old_state->re_state_nrs, param);
11249 new_state->re_state_reg_magic
11250 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11252 new_state->re_state_reg_oldcurpm
11253 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11255 new_state->re_state_reg_curpm
11256 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11258 new_state->re_state_reg_oldsaved
11259 = pv_dup(old_state->re_state_reg_oldsaved);
11260 new_state->re_state_reg_poscache
11261 = pv_dup(old_state->re_state_reg_poscache);
11262 new_state->re_state_reg_starttry
11263 = pv_dup(old_state->re_state_reg_starttry);
11266 case SAVEt_COMPILE_WARNINGS:
11267 ptr = POPPTR(ss,ix);
11268 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11271 ptr = POPPTR(ss,ix);
11272 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11276 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11284 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11285 * flag to the result. This is done for each stash before cloning starts,
11286 * so we know which stashes want their objects cloned */
11289 do_mark_cloneable_stash(pTHX_ SV *const sv)
11291 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11293 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11294 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11295 if (cloner && GvCV(cloner)) {
11302 mXPUSHs(newSVhek(hvname));
11304 call_sv((SV*)GvCV(cloner), G_SCALAR);
11311 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11319 =for apidoc perl_clone
11321 Create and return a new interpreter by cloning the current one.
11323 perl_clone takes these flags as parameters:
11325 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11326 without it we only clone the data and zero the stacks,
11327 with it we copy the stacks and the new perl interpreter is
11328 ready to run at the exact same point as the previous one.
11329 The pseudo-fork code uses COPY_STACKS while the
11330 threads->create doesn't.
11332 CLONEf_KEEP_PTR_TABLE
11333 perl_clone keeps a ptr_table with the pointer of the old
11334 variable as a key and the new variable as a value,
11335 this allows it to check if something has been cloned and not
11336 clone it again but rather just use the value and increase the
11337 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11338 the ptr_table using the function
11339 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11340 reason to keep it around is if you want to dup some of your own
11341 variable who are outside the graph perl scans, example of this
11342 code is in threads.xs create
11345 This is a win32 thing, it is ignored on unix, it tells perls
11346 win32host code (which is c++) to clone itself, this is needed on
11347 win32 if you want to run two threads at the same time,
11348 if you just want to do some stuff in a separate perl interpreter
11349 and then throw it away and return to the original one,
11350 you don't need to do anything.
11355 /* XXX the above needs expanding by someone who actually understands it ! */
11356 EXTERN_C PerlInterpreter *
11357 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11360 perl_clone(PerlInterpreter *proto_perl, UV flags)
11363 #ifdef PERL_IMPLICIT_SYS
11365 PERL_ARGS_ASSERT_PERL_CLONE;
11367 /* perlhost.h so we need to call into it
11368 to clone the host, CPerlHost should have a c interface, sky */
11370 if (flags & CLONEf_CLONE_HOST) {
11371 return perl_clone_host(proto_perl,flags);
11373 return perl_clone_using(proto_perl, flags,
11375 proto_perl->IMemShared,
11376 proto_perl->IMemParse,
11378 proto_perl->IStdIO,
11382 proto_perl->IProc);
11386 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11387 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11388 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11389 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11390 struct IPerlDir* ipD, struct IPerlSock* ipS,
11391 struct IPerlProc* ipP)
11393 /* XXX many of the string copies here can be optimized if they're
11394 * constants; they need to be allocated as common memory and just
11395 * their pointers copied. */
11398 CLONE_PARAMS clone_params;
11399 CLONE_PARAMS* const param = &clone_params;
11401 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11403 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11405 /* for each stash, determine whether its objects should be cloned */
11406 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11407 PERL_SET_THX(my_perl);
11410 PoisonNew(my_perl, 1, PerlInterpreter);
11416 PL_savestack_ix = 0;
11417 PL_savestack_max = -1;
11418 PL_sig_pending = 0;
11420 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11421 # else /* !DEBUGGING */
11422 Zero(my_perl, 1, PerlInterpreter);
11423 # endif /* DEBUGGING */
11425 /* host pointers */
11427 PL_MemShared = ipMS;
11428 PL_MemParse = ipMP;
11435 #else /* !PERL_IMPLICIT_SYS */
11437 CLONE_PARAMS clone_params;
11438 CLONE_PARAMS* param = &clone_params;
11439 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11441 PERL_ARGS_ASSERT_PERL_CLONE;
11443 /* for each stash, determine whether its objects should be cloned */
11444 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11445 PERL_SET_THX(my_perl);
11448 PoisonNew(my_perl, 1, PerlInterpreter);
11454 PL_savestack_ix = 0;
11455 PL_savestack_max = -1;
11456 PL_sig_pending = 0;
11458 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11459 # else /* !DEBUGGING */
11460 Zero(my_perl, 1, PerlInterpreter);
11461 # endif /* DEBUGGING */
11462 #endif /* PERL_IMPLICIT_SYS */
11463 param->flags = flags;
11464 param->proto_perl = proto_perl;
11466 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11468 PL_body_arenas = NULL;
11469 Zero(&PL_body_roots, 1, PL_body_roots);
11471 PL_nice_chunk = NULL;
11472 PL_nice_chunk_size = 0;
11474 PL_sv_objcount = 0;
11476 PL_sv_arenaroot = NULL;
11478 PL_debug = proto_perl->Idebug;
11480 PL_hash_seed = proto_perl->Ihash_seed;
11481 PL_rehash_seed = proto_perl->Irehash_seed;
11483 #ifdef USE_REENTRANT_API
11484 /* XXX: things like -Dm will segfault here in perlio, but doing
11485 * PERL_SET_CONTEXT(proto_perl);
11486 * breaks too many other things
11488 Perl_reentrant_init(aTHX);
11491 /* create SV map for pointer relocation */
11492 PL_ptr_table = ptr_table_new();
11494 /* initialize these special pointers as early as possible */
11495 SvANY(&PL_sv_undef) = NULL;
11496 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11497 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11498 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11500 SvANY(&PL_sv_no) = new_XPVNV();
11501 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11502 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11503 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11504 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11505 SvCUR_set(&PL_sv_no, 0);
11506 SvLEN_set(&PL_sv_no, 1);
11507 SvIV_set(&PL_sv_no, 0);
11508 SvNV_set(&PL_sv_no, 0);
11509 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11511 SvANY(&PL_sv_yes) = new_XPVNV();
11512 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11513 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11514 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11515 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11516 SvCUR_set(&PL_sv_yes, 1);
11517 SvLEN_set(&PL_sv_yes, 2);
11518 SvIV_set(&PL_sv_yes, 1);
11519 SvNV_set(&PL_sv_yes, 1);
11520 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11522 /* create (a non-shared!) shared string table */
11523 PL_strtab = newHV();
11524 HvSHAREKEYS_off(PL_strtab);
11525 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11526 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11528 PL_compiling = proto_perl->Icompiling;
11530 /* These two PVs will be free'd special way so must set them same way op.c does */
11531 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11532 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11534 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11535 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11537 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11538 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11539 if (PL_compiling.cop_hints_hash) {
11541 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11542 HINTS_REFCNT_UNLOCK;
11544 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11545 #ifdef PERL_DEBUG_READONLY_OPS
11550 /* pseudo environmental stuff */
11551 PL_origargc = proto_perl->Iorigargc;
11552 PL_origargv = proto_perl->Iorigargv;
11554 param->stashes = newAV(); /* Setup array of objects to call clone on */
11556 /* Set tainting stuff before PerlIO_debug can possibly get called */
11557 PL_tainting = proto_perl->Itainting;
11558 PL_taint_warn = proto_perl->Itaint_warn;
11560 #ifdef PERLIO_LAYERS
11561 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11562 PerlIO_clone(aTHX_ proto_perl, param);
11565 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11566 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11567 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11568 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11569 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11570 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11573 PL_minus_c = proto_perl->Iminus_c;
11574 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11575 PL_localpatches = proto_perl->Ilocalpatches;
11576 PL_splitstr = proto_perl->Isplitstr;
11577 PL_minus_n = proto_perl->Iminus_n;
11578 PL_minus_p = proto_perl->Iminus_p;
11579 PL_minus_l = proto_perl->Iminus_l;
11580 PL_minus_a = proto_perl->Iminus_a;
11581 PL_minus_E = proto_perl->Iminus_E;
11582 PL_minus_F = proto_perl->Iminus_F;
11583 PL_doswitches = proto_perl->Idoswitches;
11584 PL_dowarn = proto_perl->Idowarn;
11585 PL_doextract = proto_perl->Idoextract;
11586 PL_sawampersand = proto_perl->Isawampersand;
11587 PL_unsafe = proto_perl->Iunsafe;
11588 PL_inplace = SAVEPV(proto_perl->Iinplace);
11589 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11590 PL_perldb = proto_perl->Iperldb;
11591 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11592 PL_exit_flags = proto_perl->Iexit_flags;
11594 /* magical thingies */
11595 /* XXX time(&PL_basetime) when asked for? */
11596 PL_basetime = proto_perl->Ibasetime;
11597 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11599 PL_maxsysfd = proto_perl->Imaxsysfd;
11600 PL_statusvalue = proto_perl->Istatusvalue;
11602 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11604 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11606 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11608 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11609 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11610 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11613 /* RE engine related */
11614 Zero(&PL_reg_state, 1, struct re_save_state);
11615 PL_reginterp_cnt = 0;
11616 PL_regmatch_slab = NULL;
11618 /* Clone the regex array */
11619 /* ORANGE FIXME for plugins, probably in the SV dup code.
11620 newSViv(PTR2IV(CALLREGDUPE(
11621 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11623 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11624 PL_regex_pad = AvARRAY(PL_regex_padav);
11626 /* shortcuts to various I/O objects */
11627 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11628 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11629 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11630 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11631 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11632 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11634 /* shortcuts to regexp stuff */
11635 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11637 /* shortcuts to misc objects */
11638 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11640 /* shortcuts to debugging objects */
11641 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11642 PL_DBline = gv_dup(proto_perl->IDBline, param);
11643 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11644 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11645 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11646 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11647 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11649 /* symbol tables */
11650 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11651 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11652 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11653 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11654 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11656 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11657 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11658 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11659 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11660 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11661 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11662 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11663 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11665 PL_sub_generation = proto_perl->Isub_generation;
11666 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11668 /* funky return mechanisms */
11669 PL_forkprocess = proto_perl->Iforkprocess;
11671 /* subprocess state */
11672 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11674 /* internal state */
11675 PL_maxo = proto_perl->Imaxo;
11676 if (proto_perl->Iop_mask)
11677 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11680 /* PL_asserting = proto_perl->Iasserting; */
11682 /* current interpreter roots */
11683 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11685 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11687 PL_main_start = proto_perl->Imain_start;
11688 PL_eval_root = proto_perl->Ieval_root;
11689 PL_eval_start = proto_perl->Ieval_start;
11691 /* runtime control stuff */
11692 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11694 PL_filemode = proto_perl->Ifilemode;
11695 PL_lastfd = proto_perl->Ilastfd;
11696 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11699 PL_gensym = proto_perl->Igensym;
11700 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11701 PL_laststatval = proto_perl->Ilaststatval;
11702 PL_laststype = proto_perl->Ilaststype;
11705 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11707 /* interpreter atexit processing */
11708 PL_exitlistlen = proto_perl->Iexitlistlen;
11709 if (PL_exitlistlen) {
11710 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11711 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11714 PL_exitlist = (PerlExitListEntry*)NULL;
11716 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11717 if (PL_my_cxt_size) {
11718 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11719 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11720 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11721 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11722 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11726 PL_my_cxt_list = (void**)NULL;
11727 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11728 PL_my_cxt_keys = (const char**)NULL;
11731 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11732 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11733 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11735 PL_profiledata = NULL;
11737 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11739 PAD_CLONE_VARS(proto_perl, param);
11741 #ifdef HAVE_INTERP_INTERN
11742 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11745 /* more statics moved here */
11746 PL_generation = proto_perl->Igeneration;
11747 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11749 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11750 PL_in_clean_all = proto_perl->Iin_clean_all;
11752 PL_uid = proto_perl->Iuid;
11753 PL_euid = proto_perl->Ieuid;
11754 PL_gid = proto_perl->Igid;
11755 PL_egid = proto_perl->Iegid;
11756 PL_nomemok = proto_perl->Inomemok;
11757 PL_an = proto_perl->Ian;
11758 PL_evalseq = proto_perl->Ievalseq;
11759 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11760 PL_origalen = proto_perl->Iorigalen;
11761 #ifdef PERL_USES_PL_PIDSTATUS
11762 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11764 PL_osname = SAVEPV(proto_perl->Iosname);
11765 PL_sighandlerp = proto_perl->Isighandlerp;
11767 PL_runops = proto_perl->Irunops;
11769 PL_parser = parser_dup(proto_perl->Iparser, param);
11771 PL_subline = proto_perl->Isubline;
11772 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11775 PL_cryptseen = proto_perl->Icryptseen;
11778 PL_hints = proto_perl->Ihints;
11780 PL_amagic_generation = proto_perl->Iamagic_generation;
11782 #ifdef USE_LOCALE_COLLATE
11783 PL_collation_ix = proto_perl->Icollation_ix;
11784 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11785 PL_collation_standard = proto_perl->Icollation_standard;
11786 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11787 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11788 #endif /* USE_LOCALE_COLLATE */
11790 #ifdef USE_LOCALE_NUMERIC
11791 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11792 PL_numeric_standard = proto_perl->Inumeric_standard;
11793 PL_numeric_local = proto_perl->Inumeric_local;
11794 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11795 #endif /* !USE_LOCALE_NUMERIC */
11797 /* utf8 character classes */
11798 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11799 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11800 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11801 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11802 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11803 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11804 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11805 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11806 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11807 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11808 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11809 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11810 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11811 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11812 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11813 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11814 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11815 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11816 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11817 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11819 /* Did the locale setup indicate UTF-8? */
11820 PL_utf8locale = proto_perl->Iutf8locale;
11821 /* Unicode features (see perlrun/-C) */
11822 PL_unicode = proto_perl->Iunicode;
11824 /* Pre-5.8 signals control */
11825 PL_signals = proto_perl->Isignals;
11827 /* times() ticks per second */
11828 PL_clocktick = proto_perl->Iclocktick;
11830 /* Recursion stopper for PerlIO_find_layer */
11831 PL_in_load_module = proto_perl->Iin_load_module;
11833 /* sort() routine */
11834 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11836 /* Not really needed/useful since the reenrant_retint is "volatile",
11837 * but do it for consistency's sake. */
11838 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11840 /* Hooks to shared SVs and locks. */
11841 PL_sharehook = proto_perl->Isharehook;
11842 PL_lockhook = proto_perl->Ilockhook;
11843 PL_unlockhook = proto_perl->Iunlockhook;
11844 PL_threadhook = proto_perl->Ithreadhook;
11845 PL_destroyhook = proto_perl->Idestroyhook;
11847 #ifdef THREADS_HAVE_PIDS
11848 PL_ppid = proto_perl->Ippid;
11852 PL_last_swash_hv = NULL; /* reinits on demand */
11853 PL_last_swash_klen = 0;
11854 PL_last_swash_key[0]= '\0';
11855 PL_last_swash_tmps = (U8*)NULL;
11856 PL_last_swash_slen = 0;
11858 PL_glob_index = proto_perl->Iglob_index;
11859 PL_srand_called = proto_perl->Isrand_called;
11860 PL_bitcount = NULL; /* reinits on demand */
11862 if (proto_perl->Ipsig_pend) {
11863 Newxz(PL_psig_pend, SIG_SIZE, int);
11866 PL_psig_pend = (int*)NULL;
11869 if (proto_perl->Ipsig_ptr) {
11870 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11871 Newxz(PL_psig_name, SIG_SIZE, SV*);
11872 for (i = 1; i < SIG_SIZE; i++) {
11873 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11874 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11878 PL_psig_ptr = (SV**)NULL;
11879 PL_psig_name = (SV**)NULL;
11882 /* intrpvar.h stuff */
11884 if (flags & CLONEf_COPY_STACKS) {
11885 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11886 PL_tmps_ix = proto_perl->Itmps_ix;
11887 PL_tmps_max = proto_perl->Itmps_max;
11888 PL_tmps_floor = proto_perl->Itmps_floor;
11889 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11891 while (i <= PL_tmps_ix) {
11892 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11896 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11897 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11898 Newxz(PL_markstack, i, I32);
11899 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11900 - proto_perl->Imarkstack);
11901 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11902 - proto_perl->Imarkstack);
11903 Copy(proto_perl->Imarkstack, PL_markstack,
11904 PL_markstack_ptr - PL_markstack + 1, I32);
11906 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11907 * NOTE: unlike the others! */
11908 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11909 PL_scopestack_max = proto_perl->Iscopestack_max;
11910 Newxz(PL_scopestack, PL_scopestack_max, I32);
11911 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11913 /* NOTE: si_dup() looks at PL_markstack */
11914 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11916 /* PL_curstack = PL_curstackinfo->si_stack; */
11917 PL_curstack = av_dup(proto_perl->Icurstack, param);
11918 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11920 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11921 PL_stack_base = AvARRAY(PL_curstack);
11922 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11923 - proto_perl->Istack_base);
11924 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11926 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11927 * NOTE: unlike the others! */
11928 PL_savestack_ix = proto_perl->Isavestack_ix;
11929 PL_savestack_max = proto_perl->Isavestack_max;
11930 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11931 PL_savestack = ss_dup(proto_perl, param);
11935 ENTER; /* perl_destruct() wants to LEAVE; */
11937 /* although we're not duplicating the tmps stack, we should still
11938 * add entries for any SVs on the tmps stack that got cloned by a
11939 * non-refcount means (eg a temp in @_); otherwise they will be
11942 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11943 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11944 proto_perl->Itmps_stack[i]);
11945 if (nsv && !SvREFCNT(nsv)) {
11947 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11952 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11953 PL_top_env = &PL_start_env;
11955 PL_op = proto_perl->Iop;
11958 PL_Xpv = (XPV*)NULL;
11959 my_perl->Ina = proto_perl->Ina;
11961 PL_statbuf = proto_perl->Istatbuf;
11962 PL_statcache = proto_perl->Istatcache;
11963 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11964 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11966 PL_timesbuf = proto_perl->Itimesbuf;
11969 PL_tainted = proto_perl->Itainted;
11970 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11971 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11972 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11973 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11974 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11975 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11976 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11977 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11978 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11980 PL_restartop = proto_perl->Irestartop;
11981 PL_in_eval = proto_perl->Iin_eval;
11982 PL_delaymagic = proto_perl->Idelaymagic;
11983 PL_dirty = proto_perl->Idirty;
11984 PL_localizing = proto_perl->Ilocalizing;
11986 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11987 PL_hv_fetch_ent_mh = NULL;
11988 PL_modcount = proto_perl->Imodcount;
11989 PL_lastgotoprobe = NULL;
11990 PL_dumpindent = proto_perl->Idumpindent;
11992 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11993 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11994 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11995 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11996 PL_efloatbuf = NULL; /* reinits on demand */
11997 PL_efloatsize = 0; /* reinits on demand */
12001 PL_screamfirst = NULL;
12002 PL_screamnext = NULL;
12003 PL_maxscream = -1; /* reinits on demand */
12004 PL_lastscream = NULL;
12007 PL_regdummy = proto_perl->Iregdummy;
12008 PL_colorset = 0; /* reinits PL_colors[] */
12009 /*PL_colors[6] = {0,0,0,0,0,0};*/
12013 /* Pluggable optimizer */
12014 PL_peepp = proto_perl->Ipeepp;
12016 PL_stashcache = newHV();
12018 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12019 proto_perl->Iwatchaddr);
12020 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12021 if (PL_debug && PL_watchaddr) {
12022 PerlIO_printf(Perl_debug_log,
12023 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12024 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12025 PTR2UV(PL_watchok));
12028 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12029 ptr_table_free(PL_ptr_table);
12030 PL_ptr_table = NULL;
12033 /* Call the ->CLONE method, if it exists, for each of the stashes
12034 identified by sv_dup() above.
12036 while(av_len(param->stashes) != -1) {
12037 HV* const stash = (HV*) av_shift(param->stashes);
12038 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12039 if (cloner && GvCV(cloner)) {
12044 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12046 call_sv((SV*)GvCV(cloner), G_DISCARD);
12052 SvREFCNT_dec(param->stashes);
12054 /* orphaned? eg threads->new inside BEGIN or use */
12055 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12056 SvREFCNT_inc_simple_void(PL_compcv);
12057 SAVEFREESV(PL_compcv);
12063 #endif /* USE_ITHREADS */
12066 =head1 Unicode Support
12068 =for apidoc sv_recode_to_utf8
12070 The encoding is assumed to be an Encode object, on entry the PV
12071 of the sv is assumed to be octets in that encoding, and the sv
12072 will be converted into Unicode (and UTF-8).
12074 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12075 is not a reference, nothing is done to the sv. If the encoding is not
12076 an C<Encode::XS> Encoding object, bad things will happen.
12077 (See F<lib/encoding.pm> and L<Encode>).
12079 The PV of the sv is returned.
12084 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12088 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12090 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12104 Passing sv_yes is wrong - it needs to be or'ed set of constants
12105 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12106 remove converted chars from source.
12108 Both will default the value - let them.
12110 XPUSHs(&PL_sv_yes);
12113 call_method("decode", G_SCALAR);
12117 s = SvPV_const(uni, len);
12118 if (s != SvPVX_const(sv)) {
12119 SvGROW(sv, len + 1);
12120 Move(s, SvPVX(sv), len + 1, char);
12121 SvCUR_set(sv, len);
12128 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12132 =for apidoc sv_cat_decode
12134 The encoding is assumed to be an Encode object, the PV of the ssv is
12135 assumed to be octets in that encoding and decoding the input starts
12136 from the position which (PV + *offset) pointed to. The dsv will be
12137 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12138 when the string tstr appears in decoding output or the input ends on
12139 the PV of the ssv. The value which the offset points will be modified
12140 to the last input position on the ssv.
12142 Returns TRUE if the terminator was found, else returns FALSE.
12147 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12148 SV *ssv, int *offset, char *tstr, int tlen)
12153 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12155 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12166 offsv = newSViv(*offset);
12168 mXPUSHp(tstr, tlen);
12170 call_method("cat_decode", G_SCALAR);
12172 ret = SvTRUE(TOPs);
12173 *offset = SvIV(offsv);
12179 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12184 /* ---------------------------------------------------------------------
12186 * support functions for report_uninit()
12189 /* the maxiumum size of array or hash where we will scan looking
12190 * for the undefined element that triggered the warning */
12192 #define FUV_MAX_SEARCH_SIZE 1000
12194 /* Look for an entry in the hash whose value has the same SV as val;
12195 * If so, return a mortal copy of the key. */
12198 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12201 register HE **array;
12204 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12206 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12207 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12210 array = HvARRAY(hv);
12212 for (i=HvMAX(hv); i>0; i--) {
12213 register HE *entry;
12214 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12215 if (HeVAL(entry) != val)
12217 if ( HeVAL(entry) == &PL_sv_undef ||
12218 HeVAL(entry) == &PL_sv_placeholder)
12222 if (HeKLEN(entry) == HEf_SVKEY)
12223 return sv_mortalcopy(HeKEY_sv(entry));
12224 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12230 /* Look for an entry in the array whose value has the same SV as val;
12231 * If so, return the index, otherwise return -1. */
12234 S_find_array_subscript(pTHX_ AV *av, SV* val)
12238 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12240 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12241 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12244 if (val != &PL_sv_undef) {
12245 SV ** const svp = AvARRAY(av);
12248 for (i=AvFILLp(av); i>=0; i--)
12255 /* S_varname(): return the name of a variable, optionally with a subscript.
12256 * If gv is non-zero, use the name of that global, along with gvtype (one
12257 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12258 * targ. Depending on the value of the subscript_type flag, return:
12261 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12262 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12263 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12264 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12267 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12268 SV* keyname, I32 aindex, int subscript_type)
12271 SV * const name = sv_newmortal();
12274 buffer[0] = gvtype;
12277 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12279 gv_fullname4(name, gv, buffer, 0);
12281 if ((unsigned int)SvPVX(name)[1] <= 26) {
12283 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12285 /* Swap the 1 unprintable control character for the 2 byte pretty
12286 version - ie substr($name, 1, 1) = $buffer; */
12287 sv_insert(name, 1, 1, buffer, 2);
12291 CV * const cv = find_runcv(NULL);
12295 if (!cv || !CvPADLIST(cv))
12297 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12298 sv = *av_fetch(av, targ, FALSE);
12299 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12302 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12303 SV * const sv = newSV(0);
12304 *SvPVX(name) = '$';
12305 Perl_sv_catpvf(aTHX_ name, "{%s}",
12306 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12309 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12310 *SvPVX(name) = '$';
12311 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12313 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
12314 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
12321 =for apidoc find_uninit_var
12323 Find the name of the undefined variable (if any) that caused the operator o
12324 to issue a "Use of uninitialized value" warning.
12325 If match is true, only return a name if it's value matches uninit_sv.
12326 So roughly speaking, if a unary operator (such as OP_COS) generates a
12327 warning, then following the direct child of the op may yield an
12328 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12329 other hand, with OP_ADD there are two branches to follow, so we only print
12330 the variable name if we get an exact match.
12332 The name is returned as a mortal SV.
12334 Assumes that PL_op is the op that originally triggered the error, and that
12335 PL_comppad/PL_curpad points to the currently executing pad.
12341 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12349 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12350 uninit_sv == &PL_sv_placeholder)))
12353 switch (obase->op_type) {
12360 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12361 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12364 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12366 if (pad) { /* @lex, %lex */
12367 sv = PAD_SVl(obase->op_targ);
12371 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12372 /* @global, %global */
12373 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12376 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12378 else /* @{expr}, %{expr} */
12379 return find_uninit_var(cUNOPx(obase)->op_first,
12383 /* attempt to find a match within the aggregate */
12385 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12387 subscript_type = FUV_SUBSCRIPT_HASH;
12390 index = find_array_subscript((AV*)sv, uninit_sv);
12392 subscript_type = FUV_SUBSCRIPT_ARRAY;
12395 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12398 return varname(gv, hash ? '%' : '@', obase->op_targ,
12399 keysv, index, subscript_type);
12403 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12405 return varname(NULL, '$', obase->op_targ,
12406 NULL, 0, FUV_SUBSCRIPT_NONE);
12409 gv = cGVOPx_gv(obase);
12410 if (!gv || (match && GvSV(gv) != uninit_sv))
12412 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12415 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12418 av = (AV*)PAD_SV(obase->op_targ);
12419 if (!av || SvRMAGICAL(av))
12421 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12422 if (!svp || *svp != uninit_sv)
12425 return varname(NULL, '$', obase->op_targ,
12426 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12429 gv = cGVOPx_gv(obase);
12435 if (!av || SvRMAGICAL(av))
12437 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12438 if (!svp || *svp != uninit_sv)
12441 return varname(gv, '$', 0,
12442 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12447 o = cUNOPx(obase)->op_first;
12448 if (!o || o->op_type != OP_NULL ||
12449 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12451 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12455 if (PL_op == obase)
12456 /* $a[uninit_expr] or $h{uninit_expr} */
12457 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12460 o = cBINOPx(obase)->op_first;
12461 kid = cBINOPx(obase)->op_last;
12463 /* get the av or hv, and optionally the gv */
12465 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12466 sv = PAD_SV(o->op_targ);
12468 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12469 && cUNOPo->op_first->op_type == OP_GV)
12471 gv = cGVOPx_gv(cUNOPo->op_first);
12474 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12479 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12480 /* index is constant */
12484 if (obase->op_type == OP_HELEM) {
12485 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12486 if (!he || HeVAL(he) != uninit_sv)
12490 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12491 if (!svp || *svp != uninit_sv)
12495 if (obase->op_type == OP_HELEM)
12496 return varname(gv, '%', o->op_targ,
12497 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12499 return varname(gv, '@', o->op_targ, NULL,
12500 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12503 /* index is an expression;
12504 * attempt to find a match within the aggregate */
12505 if (obase->op_type == OP_HELEM) {
12506 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12508 return varname(gv, '%', o->op_targ,
12509 keysv, 0, FUV_SUBSCRIPT_HASH);
12512 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12514 return varname(gv, '@', o->op_targ,
12515 NULL, index, FUV_SUBSCRIPT_ARRAY);
12520 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12522 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12527 /* only examine RHS */
12528 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12531 o = cUNOPx(obase)->op_first;
12532 if (o->op_type == OP_PUSHMARK)
12535 if (!o->op_sibling) {
12536 /* one-arg version of open is highly magical */
12538 if (o->op_type == OP_GV) { /* open FOO; */
12540 if (match && GvSV(gv) != uninit_sv)
12542 return varname(gv, '$', 0,
12543 NULL, 0, FUV_SUBSCRIPT_NONE);
12545 /* other possibilities not handled are:
12546 * open $x; or open my $x; should return '${*$x}'
12547 * open expr; should return '$'.expr ideally
12553 /* ops where $_ may be an implicit arg */
12557 if ( !(obase->op_flags & OPf_STACKED)) {
12558 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12559 ? PAD_SVl(obase->op_targ)
12562 sv = sv_newmortal();
12563 sv_setpvn(sv, "$_", 2);
12572 /* skip filehandle as it can't produce 'undef' warning */
12573 o = cUNOPx(obase)->op_first;
12574 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12575 o = o->op_sibling->op_sibling;
12579 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12582 match = 1; /* XS or custom code could trigger random warnings */
12587 /* XXX tmp hack: these two may call an XS sub, and currently
12588 XS subs don't have a SUB entry on the context stack, so CV and
12589 pad determination goes wrong, and BAD things happen. So, just
12590 don't try to determine the value under those circumstances.
12591 Need a better fix at dome point. DAPM 11/2007 */
12595 /* def-ness of rval pos() is independent of the def-ness of its arg */
12596 if ( !(obase->op_flags & OPf_MOD))
12601 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12602 return newSVpvs_flags("${$/}", SVs_TEMP);
12607 if (!(obase->op_flags & OPf_KIDS))
12609 o = cUNOPx(obase)->op_first;
12615 /* if all except one arg are constant, or have no side-effects,
12616 * or are optimized away, then it's unambiguous */
12618 for (kid=o; kid; kid = kid->op_sibling) {
12620 const OPCODE type = kid->op_type;
12621 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12622 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12623 || (type == OP_PUSHMARK)
12627 if (o2) { /* more than one found */
12634 return find_uninit_var(o2, uninit_sv, match);
12636 /* scan all args */
12638 sv = find_uninit_var(o, uninit_sv, 1);
12650 =for apidoc report_uninit
12652 Print appropriate "Use of uninitialized variable" warning
12658 Perl_report_uninit(pTHX_ SV* uninit_sv)
12662 SV* varname = NULL;
12664 varname = find_uninit_var(PL_op, uninit_sv,0);
12666 sv_insert(varname, 0, 0, " ", 1);
12668 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12669 varname ? SvPV_nolen_const(varname) : "",
12670 " in ", OP_DESC(PL_op));
12673 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12679 * c-indentation-style: bsd
12680 * c-basic-offset: 4
12681 * indent-tabs-mode: t
12684 * ex: set ts=8 sts=4 sw=4 noet: