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 && PL_parser->copline != NOLINE
258 sv->sv_debug_inpad = 0;
259 sv->sv_debug_cloned = 0;
260 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
264 # define new_SV(p) (p)=S_new_SV(aTHX)
272 (p) = S_more_sv(aTHX); \
280 /* del_SV(): return an empty SV head to the free list */
293 S_del_sv(pTHX_ SV *p)
297 PERL_ARGS_ASSERT_DEL_SV;
302 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
303 const SV * const sv = sva + 1;
304 const SV * const svend = &sva[SvREFCNT(sva)];
305 if (p >= sv && p < svend) {
311 if (ckWARN_d(WARN_INTERNAL))
312 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
313 "Attempt to free non-arena SV: 0x%"UVxf
314 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
321 #else /* ! DEBUGGING */
323 #define del_SV(p) plant_SV(p)
325 #endif /* DEBUGGING */
329 =head1 SV Manipulation Functions
331 =for apidoc sv_add_arena
333 Given a chunk of memory, link it to the head of the list of arenas,
334 and split it into a list of free SVs.
340 Perl_sv_add_arena(pTHX_ char *const ptr, const U32 size, const U32 flags)
343 SV* const sva = (SV*)ptr;
347 PERL_ARGS_ASSERT_SV_ADD_ARENA;
349 /* The first SV in an arena isn't an SV. */
350 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
351 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
352 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
354 PL_sv_arenaroot = sva;
355 PL_sv_root = sva + 1;
357 svend = &sva[SvREFCNT(sva) - 1];
360 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
364 /* Must always set typemask because it's always checked in on cleanup
365 when the arenas are walked looking for objects. */
366 SvFLAGS(sv) = SVTYPEMASK;
369 SvARENA_CHAIN(sv) = 0;
373 SvFLAGS(sv) = SVTYPEMASK;
376 /* visit(): call the named function for each non-free SV in the arenas
377 * whose flags field matches the flags/mask args. */
380 S_visit(pTHX_ SVFUNC_t f, const U32 flags, const U32 mask)
386 PERL_ARGS_ASSERT_VISIT;
388 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
389 register const SV * const svend = &sva[SvREFCNT(sva)];
391 for (sv = sva + 1; sv < svend; ++sv) {
392 if (SvTYPE(sv) != SVTYPEMASK
393 && (sv->sv_flags & mask) == flags
406 /* called by sv_report_used() for each live SV */
409 do_report_used(pTHX_ SV *const sv)
411 if (SvTYPE(sv) != SVTYPEMASK) {
412 PerlIO_printf(Perl_debug_log, "****\n");
419 =for apidoc sv_report_used
421 Dump the contents of all SVs not yet freed. (Debugging aid).
427 Perl_sv_report_used(pTHX)
430 visit(do_report_used, 0, 0);
436 /* called by sv_clean_objs() for each live SV */
439 do_clean_objs(pTHX_ SV *const ref)
444 SV * const target = SvRV(ref);
445 if (SvOBJECT(target)) {
446 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
447 if (SvWEAKREF(ref)) {
448 sv_del_backref(target, ref);
454 SvREFCNT_dec(target);
459 /* XXX Might want to check arrays, etc. */
462 /* called by sv_clean_objs() for each live SV */
464 #ifndef DISABLE_DESTRUCTOR_KLUDGE
466 do_clean_named_objs(pTHX_ SV *const sv)
469 assert(SvTYPE(sv) == SVt_PVGV);
470 assert(isGV_with_GP(sv));
473 #ifdef PERL_DONT_CREATE_GVSV
476 SvOBJECT(GvSV(sv))) ||
477 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
478 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
479 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
480 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *const sv)
518 if (sv == (SV*) PL_fdpid || sv == (SV *)PL_strtab) {
519 /* don't clean pid table and strtab */
522 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
523 SvFLAGS(sv) |= SVf_BREAK;
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list.
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types, by changing array* fields
561 in body_details_by_type[] below.
564 char *arena; /* the raw storage, allocated aligned */
565 size_t size; /* its size ~4k typ */
566 U32 misc; /* type, and in future other things. */
571 /* Get the maximum number of elements in set[] such that struct arena_set
572 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
573 therefore likely to be 1 aligned memory page. */
575 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
576 - 2 * sizeof(int)) / sizeof (struct arena_desc))
579 struct arena_set* next;
580 unsigned int set_size; /* ie ARENAS_PER_SET */
581 unsigned int curr; /* index of next available arena-desc */
582 struct arena_desc set[ARENAS_PER_SET];
586 =for apidoc sv_free_arenas
588 Deallocate the memory used by all arenas. Note that all the individual SV
589 heads and bodies within the arenas must already have been freed.
594 Perl_sv_free_arenas(pTHX)
601 /* Free arenas here, but be careful about fake ones. (We assume
602 contiguity of the fake ones with the corresponding real ones.) */
604 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
605 svanext = (SV*) SvANY(sva);
606 while (svanext && SvFAKE(svanext))
607 svanext = (SV*) SvANY(svanext);
614 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
617 struct arena_set *current = aroot;
620 assert(aroot->set[i].arena);
621 Safefree(aroot->set[i].arena);
629 i = PERL_ARENA_ROOTS_SIZE;
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ const size_t arena_size, const U32 misc)
682 struct arena_desc* adesc;
683 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!aroot || aroot->curr >= aroot->set_size) {
692 struct arena_set *newroot;
693 Newxz(newroot, 1, struct arena_set);
694 newroot->set_size = ARENAS_PER_SET;
695 newroot->next = aroot;
697 PL_body_arenas = (void *) newroot;
698 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
701 /* ok, now have arena-set with at least 1 empty/available arena-desc */
702 curr = aroot->curr++;
703 adesc = &(aroot->set[curr]);
704 assert(!adesc->arena);
706 Newx(adesc->arena, arena_size, char);
707 adesc->size = arena_size;
709 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
710 curr, (void*)adesc->arena, (UV)arena_size));
716 /* return a thing to the free list */
718 #define del_body(thing, root) \
720 void ** const thing_copy = (void **)thing;\
721 *thing_copy = *root; \
722 *root = (void*)thing_copy; \
727 =head1 SV-Body Allocation
729 Allocation of SV-bodies is similar to SV-heads, differing as follows;
730 the allocation mechanism is used for many body types, so is somewhat
731 more complicated, it uses arena-sets, and has no need for still-live
734 At the outermost level, (new|del)_X*V macros return bodies of the
735 appropriate type. These macros call either (new|del)_body_type or
736 (new|del)_body_allocated macro pairs, depending on specifics of the
737 type. Most body types use the former pair, the latter pair is used to
738 allocate body types with "ghost fields".
740 "ghost fields" are fields that are unused in certain types, and
741 consequently dont need to actually exist. They are declared because
742 they're part of a "base type", which allows use of functions as
743 methods. The simplest examples are AVs and HVs, 2 aggregate types
744 which don't use the fields which support SCALAR semantics.
746 For these types, the arenas are carved up into *_allocated size
747 chunks, we thus avoid wasted memory for those unaccessed members.
748 When bodies are allocated, we adjust the pointer back in memory by the
749 size of the bit not allocated, so it's as if we allocated the full
750 structure. (But things will all go boom if you write to the part that
751 is "not there", because you'll be overwriting the last members of the
752 preceding structure in memory.)
754 We calculate the correction using the STRUCT_OFFSET macro. For
755 example, if xpv_allocated is the same structure as XPV then the two
756 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
757 structure is smaller (no initial NV actually allocated) then the net
758 effect is to subtract the size of the NV from the pointer, to return a
759 new pointer as if an initial NV were actually allocated.
761 This is the same trick as was used for NV and IV bodies. Ironically it
762 doesn't need to be used for NV bodies any more, because NV is now at
763 the start of the structure. IV bodies don't need it either, because
764 they are no longer allocated.
766 In turn, the new_body_* allocators call S_new_body(), which invokes
767 new_body_inline macro, which takes a lock, and takes a body off the
768 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
769 necessary to refresh an empty list. Then the lock is released, and
770 the body is returned.
772 S_more_bodies calls get_arena(), and carves it up into an array of N
773 bodies, which it strings into a linked list. It looks up arena-size
774 and body-size from the body_details table described below, thus
775 supporting the multiple body-types.
777 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
778 the (new|del)_X*V macros are mapped directly to malloc/free.
784 For each sv-type, struct body_details bodies_by_type[] carries
785 parameters which control these aspects of SV handling:
787 Arena_size determines whether arenas are used for this body type, and if
788 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
789 zero, forcing individual mallocs and frees.
791 Body_size determines how big a body is, and therefore how many fit into
792 each arena. Offset carries the body-pointer adjustment needed for
793 *_allocated body types, and is used in *_allocated macros.
795 But its main purpose is to parameterize info needed in
796 Perl_sv_upgrade(). The info here dramatically simplifies the function
797 vs the implementation in 5.8.7, making it table-driven. All fields
798 are used for this, except for arena_size.
800 For the sv-types that have no bodies, arenas are not used, so those
801 PL_body_roots[sv_type] are unused, and can be overloaded. In
802 something of a special case, SVt_NULL is borrowed for HE arenas;
803 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
804 bodies_by_type[SVt_NULL] slot is not used, as the table is not
807 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
808 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
809 just use the same allocation semantics. At first, PTEs were also
810 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
811 bugs, so was simplified by claiming a new slot. This choice has no
812 consequence at this time.
816 struct body_details {
817 U8 body_size; /* Size to allocate */
818 U8 copy; /* Size of structure to copy (may be shorter) */
820 unsigned int type : 4; /* We have space for a sanity check. */
821 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
822 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
823 unsigned int arena : 1; /* Allocated from an arena */
824 size_t arena_size; /* Size of arena to allocate */
832 /* With -DPURFIY we allocate everything directly, and don't use arenas.
833 This seems a rather elegant way to simplify some of the code below. */
834 #define HASARENA FALSE
836 #define HASARENA TRUE
838 #define NOARENA FALSE
840 /* Size the arenas to exactly fit a given number of bodies. A count
841 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
842 simplifying the default. If count > 0, the arena is sized to fit
843 only that many bodies, allowing arenas to be used for large, rare
844 bodies (XPVFM, XPVIO) without undue waste. The arena size is
845 limited by PERL_ARENA_SIZE, so we can safely oversize the
848 #define FIT_ARENA0(body_size) \
849 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
850 #define FIT_ARENAn(count,body_size) \
851 ( count * body_size <= PERL_ARENA_SIZE) \
852 ? count * body_size \
853 : FIT_ARENA0 (body_size)
854 #define FIT_ARENA(count,body_size) \
856 ? FIT_ARENAn (count, body_size) \
857 : FIT_ARENA0 (body_size)
859 /* A macro to work out the offset needed to subtract from a pointer to (say)
866 to make its members accessible via a pointer to (say)
876 #define relative_STRUCT_OFFSET(longer, shorter, member) \
877 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
879 /* Calculate the length to copy. Specifically work out the length less any
880 final padding the compiler needed to add. See the comment in sv_upgrade
881 for why copying the padding proved to be a bug. */
883 #define copy_length(type, last_member) \
884 STRUCT_OFFSET(type, last_member) \
885 + sizeof (((type*)SvANY((SV*)0))->last_member)
887 static const struct body_details bodies_by_type[] = {
888 { sizeof(HE), 0, 0, SVt_NULL,
889 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
891 /* The bind placeholder pretends to be an RV for now.
892 Also it's marked as "can't upgrade" to stop anyone using it before it's
894 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
896 /* IVs are in the head, so the allocation size is 0.
897 However, the slot is overloaded for PTEs. */
898 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
899 sizeof(IV), /* This is used to copy out the IV body. */
900 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
901 NOARENA /* IVS don't need an arena */,
902 /* But PTEs need to know the size of their arena */
903 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
906 /* 8 bytes on most ILP32 with IEEE doubles */
907 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
908 FIT_ARENA(0, sizeof(NV)) },
910 /* 8 bytes on most ILP32 with IEEE doubles */
911 { sizeof(xpv_allocated),
912 copy_length(XPV, xpv_len)
913 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
914 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
915 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
918 { sizeof(xpviv_allocated),
919 copy_length(XPVIV, xiv_u)
920 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
921 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
922 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
925 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
929 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
933 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
934 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
935 SVt_REGEXP, FALSE, NONV, HASARENA,
936 FIT_ARENA(0, sizeof(struct regexp_allocated))
940 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
941 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
944 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
945 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
947 { sizeof(xpvav_allocated),
948 copy_length(XPVAV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
950 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
951 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
953 { sizeof(xpvhv_allocated),
954 copy_length(XPVHV, xmg_stash)
955 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
956 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
957 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
960 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
961 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
962 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
964 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
965 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
966 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
968 /* XPVIO is 84 bytes, fits 48x */
969 { sizeof(xpvio_allocated), sizeof(xpvio_allocated),
970 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
971 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
974 #define new_body_type(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type))
977 #define del_body_type(p, sv_type) \
978 del_body(p, &PL_body_roots[sv_type])
981 #define new_body_allocated(sv_type) \
982 (void *)((char *)S_new_body(aTHX_ sv_type) \
983 - bodies_by_type[sv_type].offset)
985 #define del_body_allocated(p, sv_type) \
986 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
989 #define my_safemalloc(s) (void*)safemalloc(s)
990 #define my_safecalloc(s) (void*)safecalloc(s, 1)
991 #define my_safefree(p) safefree((char*)p)
995 #define new_XNV() my_safemalloc(sizeof(XPVNV))
996 #define del_XNV(p) my_safefree(p)
998 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
999 #define del_XPVNV(p) my_safefree(p)
1001 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1002 #define del_XPVAV(p) my_safefree(p)
1004 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1005 #define del_XPVHV(p) my_safefree(p)
1007 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1008 #define del_XPVMG(p) my_safefree(p)
1010 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1011 #define del_XPVGV(p) my_safefree(p)
1015 #define new_XNV() new_body_type(SVt_NV)
1016 #define del_XNV(p) del_body_type(p, SVt_NV)
1018 #define new_XPVNV() new_body_type(SVt_PVNV)
1019 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1021 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1022 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1024 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1025 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1027 #define new_XPVMG() new_body_type(SVt_PVMG)
1028 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1030 #define new_XPVGV() new_body_type(SVt_PVGV)
1031 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1035 /* no arena for you! */
1037 #define new_NOARENA(details) \
1038 my_safemalloc((details)->body_size + (details)->offset)
1039 #define new_NOARENAZ(details) \
1040 my_safecalloc((details)->body_size + (details)->offset)
1043 S_more_bodies (pTHX_ const svtype sv_type)
1046 void ** const root = &PL_body_roots[sv_type];
1047 const struct body_details * const bdp = &bodies_by_type[sv_type];
1048 const size_t body_size = bdp->body_size;
1051 const size_t arena_size = Perl_malloc_good_size(bdp->arena_size);
1052 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1053 static bool done_sanity_check;
1055 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1056 * variables like done_sanity_check. */
1057 if (!done_sanity_check) {
1058 unsigned int i = SVt_LAST;
1060 done_sanity_check = TRUE;
1063 assert (bodies_by_type[i].type == i);
1067 assert(bdp->arena_size);
1069 start = (char*) Perl_get_arena(aTHX_ arena_size, sv_type);
1071 end = start + arena_size - 2 * body_size;
1073 /* computed count doesnt reflect the 1st slot reservation */
1074 #if defined(MYMALLOC) || defined(HAS_MALLOC_GOOD_SIZE)
1075 DEBUG_m(PerlIO_printf(Perl_debug_log,
1076 "arena %p end %p arena-size %d (from %d) type %d "
1078 (void*)start, (void*)end, (int)arena_size,
1079 (int)bdp->arena_size, sv_type, (int)body_size,
1080 (int)arena_size / (int)body_size));
1082 DEBUG_m(PerlIO_printf(Perl_debug_log,
1083 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1084 (void*)start, (void*)end,
1085 (int)bdp->arena_size, sv_type, (int)body_size,
1086 (int)bdp->arena_size / (int)body_size));
1088 *root = (void *)start;
1090 while (start <= end) {
1091 char * const next = start + body_size;
1092 *(void**) start = (void *)next;
1095 *(void **)start = 0;
1100 /* grab a new thing from the free list, allocating more if necessary.
1101 The inline version is used for speed in hot routines, and the
1102 function using it serves the rest (unless PURIFY).
1104 #define new_body_inline(xpv, sv_type) \
1106 void ** const r3wt = &PL_body_roots[sv_type]; \
1107 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1108 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1109 *(r3wt) = *(void**)(xpv); \
1115 S_new_body(pTHX_ const svtype sv_type)
1119 new_body_inline(xpv, sv_type);
1125 static const struct body_details fake_rv =
1126 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1129 =for apidoc sv_upgrade
1131 Upgrade an SV to a more complex form. Generally adds a new body type to the
1132 SV, then copies across as much information as possible from the old body.
1133 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1139 Perl_sv_upgrade(pTHX_ register SV *const sv, svtype new_type)
1144 const svtype old_type = SvTYPE(sv);
1145 const struct body_details *new_type_details;
1146 const struct body_details *old_type_details
1147 = bodies_by_type + old_type;
1148 SV *referant = NULL;
1150 PERL_ARGS_ASSERT_SV_UPGRADE;
1152 if (new_type != SVt_PV && SvIsCOW(sv)) {
1153 sv_force_normal_flags(sv, 0);
1156 if (old_type == new_type)
1159 old_body = SvANY(sv);
1161 /* Copying structures onto other structures that have been neatly zeroed
1162 has a subtle gotcha. Consider XPVMG
1164 +------+------+------+------+------+-------+-------+
1165 | NV | CUR | LEN | IV | MAGIC | STASH |
1166 +------+------+------+------+------+-------+-------+
1167 0 4 8 12 16 20 24 28
1169 where NVs are aligned to 8 bytes, so that sizeof that structure is
1170 actually 32 bytes long, with 4 bytes of padding at the end:
1172 +------+------+------+------+------+-------+-------+------+
1173 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1174 +------+------+------+------+------+-------+-------+------+
1175 0 4 8 12 16 20 24 28 32
1177 so what happens if you allocate memory for this structure:
1179 +------+------+------+------+------+-------+-------+------+------+...
1180 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1181 +------+------+------+------+------+-------+-------+------+------+...
1182 0 4 8 12 16 20 24 28 32 36
1184 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1185 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1186 started out as zero once, but it's quite possible that it isn't. So now,
1187 rather than a nicely zeroed GP, you have it pointing somewhere random.
1190 (In fact, GP ends up pointing at a previous GP structure, because the
1191 principle cause of the padding in XPVMG getting garbage is a copy of
1192 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1193 this happens to be moot because XPVGV has been re-ordered, with GP
1194 no longer after STASH)
1196 So we are careful and work out the size of used parts of all the
1204 referant = SvRV(sv);
1205 old_type_details = &fake_rv;
1206 if (new_type == SVt_NV)
1207 new_type = SVt_PVNV;
1209 if (new_type < SVt_PVIV) {
1210 new_type = (new_type == SVt_NV)
1211 ? SVt_PVNV : SVt_PVIV;
1216 if (new_type < SVt_PVNV) {
1217 new_type = SVt_PVNV;
1221 assert(new_type > SVt_PV);
1222 assert(SVt_IV < SVt_PV);
1223 assert(SVt_NV < SVt_PV);
1230 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1231 there's no way that it can be safely upgraded, because perl.c
1232 expects to Safefree(SvANY(PL_mess_sv)) */
1233 assert(sv != PL_mess_sv);
1234 /* This flag bit is used to mean other things in other scalar types.
1235 Given that it only has meaning inside the pad, it shouldn't be set
1236 on anything that can get upgraded. */
1237 assert(!SvPAD_TYPED(sv));
1240 if (old_type_details->cant_upgrade)
1241 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1242 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1245 if (old_type > new_type)
1246 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1247 (int)old_type, (int)new_type);
1249 new_type_details = bodies_by_type + new_type;
1251 SvFLAGS(sv) &= ~SVTYPEMASK;
1252 SvFLAGS(sv) |= new_type;
1254 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1255 the return statements above will have triggered. */
1256 assert (new_type != SVt_NULL);
1259 assert(old_type == SVt_NULL);
1260 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1264 assert(old_type == SVt_NULL);
1265 SvANY(sv) = new_XNV();
1270 assert(new_type_details->body_size);
1273 assert(new_type_details->arena);
1274 assert(new_type_details->arena_size);
1275 /* This points to the start of the allocated area. */
1276 new_body_inline(new_body, new_type);
1277 Zero(new_body, new_type_details->body_size, char);
1278 new_body = ((char *)new_body) - new_type_details->offset;
1280 /* We always allocated the full length item with PURIFY. To do this
1281 we fake things so that arena is false for all 16 types.. */
1282 new_body = new_NOARENAZ(new_type_details);
1284 SvANY(sv) = new_body;
1285 if (new_type == SVt_PVAV) {
1289 if (old_type_details->body_size) {
1292 /* It will have been zeroed when the new body was allocated.
1293 Lets not write to it, in case it confuses a write-back
1299 #ifndef NODEFAULT_SHAREKEYS
1300 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1302 HvMAX(sv) = 7; /* (start with 8 buckets) */
1303 if (old_type_details->body_size) {
1306 /* It will have been zeroed when the new body was allocated.
1307 Lets not write to it, in case it confuses a write-back
1312 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1313 The target created by newSVrv also is, and it can have magic.
1314 However, it never has SvPVX set.
1316 if (old_type == SVt_IV) {
1318 } else if (old_type >= SVt_PV) {
1319 assert(SvPVX_const(sv) == 0);
1322 if (old_type >= SVt_PVMG) {
1323 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1324 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1326 sv->sv_u.svu_array = NULL; /* or svu_hash */
1332 /* XXX Is this still needed? Was it ever needed? Surely as there is
1333 no route from NV to PVIV, NOK can never be true */
1334 assert(!SvNOKp(sv));
1346 assert(new_type_details->body_size);
1347 /* We always allocated the full length item with PURIFY. To do this
1348 we fake things so that arena is false for all 16 types.. */
1349 if(new_type_details->arena) {
1350 /* This points to the start of the allocated area. */
1351 new_body_inline(new_body, new_type);
1352 Zero(new_body, new_type_details->body_size, char);
1353 new_body = ((char *)new_body) - new_type_details->offset;
1355 new_body = new_NOARENAZ(new_type_details);
1357 SvANY(sv) = new_body;
1359 if (old_type_details->copy) {
1360 /* There is now the potential for an upgrade from something without
1361 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1362 int offset = old_type_details->offset;
1363 int length = old_type_details->copy;
1365 if (new_type_details->offset > old_type_details->offset) {
1366 const int difference
1367 = new_type_details->offset - old_type_details->offset;
1368 offset += difference;
1369 length -= difference;
1371 assert (length >= 0);
1373 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1377 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1378 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1379 * correct 0.0 for us. Otherwise, if the old body didn't have an
1380 * NV slot, but the new one does, then we need to initialise the
1381 * freshly created NV slot with whatever the correct bit pattern is
1383 if (old_type_details->zero_nv && !new_type_details->zero_nv
1384 && !isGV_with_GP(sv))
1388 if (new_type == SVt_PVIO)
1389 IoPAGE_LEN(sv) = 60;
1390 if (old_type < SVt_PV) {
1391 /* referant will be NULL unless the old type was SVt_IV emulating
1393 sv->sv_u.svu_rv = referant;
1397 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1398 (unsigned long)new_type);
1401 if (old_type_details->arena) {
1402 /* If there was an old body, then we need to free it.
1403 Note that there is an assumption that all bodies of types that
1404 can be upgraded came from arenas. Only the more complex non-
1405 upgradable types are allowed to be directly malloc()ed. */
1407 my_safefree(old_body);
1409 del_body((void*)((char*)old_body + old_type_details->offset),
1410 &PL_body_roots[old_type]);
1416 =for apidoc sv_backoff
1418 Remove any string offset. You should normally use the C<SvOOK_off> macro
1425 Perl_sv_backoff(pTHX_ register SV *const sv)
1428 const char * const s = SvPVX_const(sv);
1430 PERL_ARGS_ASSERT_SV_BACKOFF;
1431 PERL_UNUSED_CONTEXT;
1434 assert(SvTYPE(sv) != SVt_PVHV);
1435 assert(SvTYPE(sv) != SVt_PVAV);
1437 SvOOK_offset(sv, delta);
1439 SvLEN_set(sv, SvLEN(sv) + delta);
1440 SvPV_set(sv, SvPVX(sv) - delta);
1441 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1442 SvFLAGS(sv) &= ~SVf_OOK;
1449 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1450 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1451 Use the C<SvGROW> wrapper instead.
1457 Perl_sv_grow(pTHX_ register SV *const sv, register STRLEN newlen)
1461 PERL_ARGS_ASSERT_SV_GROW;
1463 if (PL_madskills && newlen >= 0x100000) {
1464 PerlIO_printf(Perl_debug_log,
1465 "Allocation too large: %"UVxf"\n", (UV)newlen);
1467 #ifdef HAS_64K_LIMIT
1468 if (newlen >= 0x10000) {
1469 PerlIO_printf(Perl_debug_log,
1470 "Allocation too large: %"UVxf"\n", (UV)newlen);
1473 #endif /* HAS_64K_LIMIT */
1476 if (SvTYPE(sv) < SVt_PV) {
1477 sv_upgrade(sv, SVt_PV);
1478 s = SvPVX_mutable(sv);
1480 else if (SvOOK(sv)) { /* pv is offset? */
1482 s = SvPVX_mutable(sv);
1483 if (newlen > SvLEN(sv))
1484 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1485 #ifdef HAS_64K_LIMIT
1486 if (newlen >= 0x10000)
1491 s = SvPVX_mutable(sv);
1493 if (newlen > SvLEN(sv)) { /* need more room? */
1494 #ifndef Perl_safesysmalloc_size
1495 newlen = PERL_STRLEN_ROUNDUP(newlen);
1497 if (SvLEN(sv) && s) {
1498 s = (char*)saferealloc(s, newlen);
1501 s = (char*)safemalloc(newlen);
1502 if (SvPVX_const(sv) && SvCUR(sv)) {
1503 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1507 #ifdef Perl_safesysmalloc_size
1508 /* Do this here, do it once, do it right, and then we will never get
1509 called back into sv_grow() unless there really is some growing
1511 SvLEN_set(sv, Perl_safesysmalloc_size(s));
1513 SvLEN_set(sv, newlen);
1520 =for apidoc sv_setiv
1522 Copies an integer into the given SV, upgrading first if necessary.
1523 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1529 Perl_sv_setiv(pTHX_ register SV *const sv, const IV i)
1533 PERL_ARGS_ASSERT_SV_SETIV;
1535 SV_CHECK_THINKFIRST_COW_DROP(sv);
1536 switch (SvTYPE(sv)) {
1539 sv_upgrade(sv, SVt_IV);
1542 sv_upgrade(sv, SVt_PVIV);
1546 if (!isGV_with_GP(sv))
1553 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1557 (void)SvIOK_only(sv); /* validate number */
1563 =for apidoc sv_setiv_mg
1565 Like C<sv_setiv>, but also handles 'set' magic.
1571 Perl_sv_setiv_mg(pTHX_ register SV *const sv, const IV i)
1573 PERL_ARGS_ASSERT_SV_SETIV_MG;
1580 =for apidoc sv_setuv
1582 Copies an unsigned integer into the given SV, upgrading first if necessary.
1583 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1589 Perl_sv_setuv(pTHX_ register SV *const sv, const UV u)
1591 PERL_ARGS_ASSERT_SV_SETUV;
1593 /* With these two if statements:
1594 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1597 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1599 If you wish to remove them, please benchmark to see what the effect is
1601 if (u <= (UV)IV_MAX) {
1602 sv_setiv(sv, (IV)u);
1611 =for apidoc sv_setuv_mg
1613 Like C<sv_setuv>, but also handles 'set' magic.
1619 Perl_sv_setuv_mg(pTHX_ register SV *const sv, const UV u)
1621 PERL_ARGS_ASSERT_SV_SETUV_MG;
1628 =for apidoc sv_setnv
1630 Copies a double into the given SV, upgrading first if necessary.
1631 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1637 Perl_sv_setnv(pTHX_ register SV *const sv, const NV num)
1641 PERL_ARGS_ASSERT_SV_SETNV;
1643 SV_CHECK_THINKFIRST_COW_DROP(sv);
1644 switch (SvTYPE(sv)) {
1647 sv_upgrade(sv, SVt_NV);
1651 sv_upgrade(sv, SVt_PVNV);
1655 if (!isGV_with_GP(sv))
1662 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1667 (void)SvNOK_only(sv); /* validate number */
1672 =for apidoc sv_setnv_mg
1674 Like C<sv_setnv>, but also handles 'set' magic.
1680 Perl_sv_setnv_mg(pTHX_ register SV *const sv, const NV num)
1682 PERL_ARGS_ASSERT_SV_SETNV_MG;
1688 /* Print an "isn't numeric" warning, using a cleaned-up,
1689 * printable version of the offending string
1693 S_not_a_number(pTHX_ SV *const sv)
1700 PERL_ARGS_ASSERT_NOT_A_NUMBER;
1703 dsv = newSVpvs_flags("", SVs_TEMP);
1704 pv = sv_uni_display(dsv, sv, 10, 0);
1707 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1708 /* each *s can expand to 4 chars + "...\0",
1709 i.e. need room for 8 chars */
1711 const char *s = SvPVX_const(sv);
1712 const char * const end = s + SvCUR(sv);
1713 for ( ; s < end && d < limit; s++ ) {
1715 if (ch & 128 && !isPRINT_LC(ch)) {
1724 else if (ch == '\r') {
1728 else if (ch == '\f') {
1732 else if (ch == '\\') {
1736 else if (ch == '\0') {
1740 else if (isPRINT_LC(ch))
1757 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1758 "Argument \"%s\" isn't numeric in %s", pv,
1761 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1762 "Argument \"%s\" isn't numeric", pv);
1766 =for apidoc looks_like_number
1768 Test if the content of an SV looks like a number (or is a number).
1769 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1770 non-numeric warning), even if your atof() doesn't grok them.
1776 Perl_looks_like_number(pTHX_ SV *const sv)
1778 register const char *sbegin;
1781 PERL_ARGS_ASSERT_LOOKS_LIKE_NUMBER;
1784 sbegin = SvPVX_const(sv);
1787 else if (SvPOKp(sv))
1788 sbegin = SvPV_const(sv, len);
1790 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1791 return grok_number(sbegin, len, NULL);
1795 S_glob_2number(pTHX_ GV * const gv)
1797 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1798 SV *const buffer = sv_newmortal();
1800 PERL_ARGS_ASSERT_GLOB_2NUMBER;
1802 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1805 gv_efullname3(buffer, gv, "*");
1806 SvFLAGS(gv) |= wasfake;
1808 /* We know that all GVs stringify to something that is not-a-number,
1809 so no need to test that. */
1810 if (ckWARN(WARN_NUMERIC))
1811 not_a_number(buffer);
1812 /* We just want something true to return, so that S_sv_2iuv_common
1813 can tail call us and return true. */
1818 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1820 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1821 SV *const buffer = sv_newmortal();
1823 PERL_ARGS_ASSERT_GLOB_2PV;
1825 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1828 gv_efullname3(buffer, gv, "*");
1829 SvFLAGS(gv) |= wasfake;
1831 assert(SvPOK(buffer));
1833 *len = SvCUR(buffer);
1835 return SvPVX(buffer);
1838 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1839 until proven guilty, assume that things are not that bad... */
1844 As 64 bit platforms often have an NV that doesn't preserve all bits of
1845 an IV (an assumption perl has been based on to date) it becomes necessary
1846 to remove the assumption that the NV always carries enough precision to
1847 recreate the IV whenever needed, and that the NV is the canonical form.
1848 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1849 precision as a side effect of conversion (which would lead to insanity
1850 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1851 1) to distinguish between IV/UV/NV slots that have cached a valid
1852 conversion where precision was lost and IV/UV/NV slots that have a
1853 valid conversion which has lost no precision
1854 2) to ensure that if a numeric conversion to one form is requested that
1855 would lose precision, the precise conversion (or differently
1856 imprecise conversion) is also performed and cached, to prevent
1857 requests for different numeric formats on the same SV causing
1858 lossy conversion chains. (lossless conversion chains are perfectly
1863 SvIOKp is true if the IV slot contains a valid value
1864 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1865 SvNOKp is true if the NV slot contains a valid value
1866 SvNOK is true only if the NV value is accurate
1869 while converting from PV to NV, check to see if converting that NV to an
1870 IV(or UV) would lose accuracy over a direct conversion from PV to
1871 IV(or UV). If it would, cache both conversions, return NV, but mark
1872 SV as IOK NOKp (ie not NOK).
1874 While converting from PV to IV, check to see if converting that IV to an
1875 NV would lose accuracy over a direct conversion from PV to NV. If it
1876 would, cache both conversions, flag similarly.
1878 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1879 correctly because if IV & NV were set NV *always* overruled.
1880 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1881 changes - now IV and NV together means that the two are interchangeable:
1882 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1884 The benefit of this is that operations such as pp_add know that if
1885 SvIOK is true for both left and right operands, then integer addition
1886 can be used instead of floating point (for cases where the result won't
1887 overflow). Before, floating point was always used, which could lead to
1888 loss of precision compared with integer addition.
1890 * making IV and NV equal status should make maths accurate on 64 bit
1892 * may speed up maths somewhat if pp_add and friends start to use
1893 integers when possible instead of fp. (Hopefully the overhead in
1894 looking for SvIOK and checking for overflow will not outweigh the
1895 fp to integer speedup)
1896 * will slow down integer operations (callers of SvIV) on "inaccurate"
1897 values, as the change from SvIOK to SvIOKp will cause a call into
1898 sv_2iv each time rather than a macro access direct to the IV slot
1899 * should speed up number->string conversion on integers as IV is
1900 favoured when IV and NV are equally accurate
1902 ####################################################################
1903 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1904 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1905 On the other hand, SvUOK is true iff UV.
1906 ####################################################################
1908 Your mileage will vary depending your CPU's relative fp to integer
1912 #ifndef NV_PRESERVES_UV
1913 # define IS_NUMBER_UNDERFLOW_IV 1
1914 # define IS_NUMBER_UNDERFLOW_UV 2
1915 # define IS_NUMBER_IV_AND_UV 2
1916 # define IS_NUMBER_OVERFLOW_IV 4
1917 # define IS_NUMBER_OVERFLOW_UV 5
1919 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1921 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1923 S_sv_2iuv_non_preserve(pTHX_ register SV *const sv
1931 PERL_ARGS_ASSERT_SV_2IUV_NON_PRESERVE;
1933 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));
1934 if (SvNVX(sv) < (NV)IV_MIN) {
1935 (void)SvIOKp_on(sv);
1937 SvIV_set(sv, IV_MIN);
1938 return IS_NUMBER_UNDERFLOW_IV;
1940 if (SvNVX(sv) > (NV)UV_MAX) {
1941 (void)SvIOKp_on(sv);
1944 SvUV_set(sv, UV_MAX);
1945 return IS_NUMBER_OVERFLOW_UV;
1947 (void)SvIOKp_on(sv);
1949 /* Can't use strtol etc to convert this string. (See truth table in
1951 if (SvNVX(sv) <= (UV)IV_MAX) {
1952 SvIV_set(sv, I_V(SvNVX(sv)));
1953 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1954 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1956 /* Integer is imprecise. NOK, IOKp */
1958 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1961 SvUV_set(sv, U_V(SvNVX(sv)));
1962 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1963 if (SvUVX(sv) == UV_MAX) {
1964 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1965 possibly be preserved by NV. Hence, it must be overflow.
1967 return IS_NUMBER_OVERFLOW_UV;
1969 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1971 /* Integer is imprecise. NOK, IOKp */
1973 return IS_NUMBER_OVERFLOW_IV;
1975 #endif /* !NV_PRESERVES_UV*/
1978 S_sv_2iuv_common(pTHX_ SV *const sv)
1982 PERL_ARGS_ASSERT_SV_2IUV_COMMON;
1985 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1986 * without also getting a cached IV/UV from it at the same time
1987 * (ie PV->NV conversion should detect loss of accuracy and cache
1988 * IV or UV at same time to avoid this. */
1989 /* IV-over-UV optimisation - choose to cache IV if possible */
1991 if (SvTYPE(sv) == SVt_NV)
1992 sv_upgrade(sv, SVt_PVNV);
1994 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1995 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1996 certainly cast into the IV range at IV_MAX, whereas the correct
1997 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1999 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
2000 if (Perl_isnan(SvNVX(sv))) {
2006 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2007 SvIV_set(sv, I_V(SvNVX(sv)));
2008 if (SvNVX(sv) == (NV) SvIVX(sv)
2009 #ifndef NV_PRESERVES_UV
2010 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2011 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2012 /* Don't flag it as "accurately an integer" if the number
2013 came from a (by definition imprecise) NV operation, and
2014 we're outside the range of NV integer precision */
2018 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2020 /* scalar has trailing garbage, eg "42a" */
2022 DEBUG_c(PerlIO_printf(Perl_debug_log,
2023 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2029 /* IV not precise. No need to convert from PV, as NV
2030 conversion would already have cached IV if it detected
2031 that PV->IV would be better than PV->NV->IV
2032 flags already correct - don't set public IOK. */
2033 DEBUG_c(PerlIO_printf(Perl_debug_log,
2034 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2039 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2040 but the cast (NV)IV_MIN rounds to a the value less (more
2041 negative) than IV_MIN which happens to be equal to SvNVX ??
2042 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2043 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2044 (NV)UVX == NVX are both true, but the values differ. :-(
2045 Hopefully for 2s complement IV_MIN is something like
2046 0x8000000000000000 which will be exact. NWC */
2049 SvUV_set(sv, U_V(SvNVX(sv)));
2051 (SvNVX(sv) == (NV) SvUVX(sv))
2052 #ifndef NV_PRESERVES_UV
2053 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2054 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2055 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2056 /* Don't flag it as "accurately an integer" if the number
2057 came from a (by definition imprecise) NV operation, and
2058 we're outside the range of NV integer precision */
2064 DEBUG_c(PerlIO_printf(Perl_debug_log,
2065 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2071 else if (SvPOKp(sv) && SvLEN(sv)) {
2073 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2074 /* We want to avoid a possible problem when we cache an IV/ a UV which
2075 may be later translated to an NV, and the resulting NV is not
2076 the same as the direct translation of the initial string
2077 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2078 be careful to ensure that the value with the .456 is around if the
2079 NV value is requested in the future).
2081 This means that if we cache such an IV/a UV, we need to cache the
2082 NV as well. Moreover, we trade speed for space, and do not
2083 cache the NV if we are sure it's not needed.
2086 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2087 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2088 == IS_NUMBER_IN_UV) {
2089 /* It's definitely an integer, only upgrade to PVIV */
2090 if (SvTYPE(sv) < SVt_PVIV)
2091 sv_upgrade(sv, SVt_PVIV);
2093 } else if (SvTYPE(sv) < SVt_PVNV)
2094 sv_upgrade(sv, SVt_PVNV);
2096 /* If NVs preserve UVs then we only use the UV value if we know that
2097 we aren't going to call atof() below. If NVs don't preserve UVs
2098 then the value returned may have more precision than atof() will
2099 return, even though value isn't perfectly accurate. */
2100 if ((numtype & (IS_NUMBER_IN_UV
2101 #ifdef NV_PRESERVES_UV
2104 )) == IS_NUMBER_IN_UV) {
2105 /* This won't turn off the public IOK flag if it was set above */
2106 (void)SvIOKp_on(sv);
2108 if (!(numtype & IS_NUMBER_NEG)) {
2110 if (value <= (UV)IV_MAX) {
2111 SvIV_set(sv, (IV)value);
2113 /* it didn't overflow, and it was positive. */
2114 SvUV_set(sv, value);
2118 /* 2s complement assumption */
2119 if (value <= (UV)IV_MIN) {
2120 SvIV_set(sv, -(IV)value);
2122 /* Too negative for an IV. This is a double upgrade, but
2123 I'm assuming it will be rare. */
2124 if (SvTYPE(sv) < SVt_PVNV)
2125 sv_upgrade(sv, SVt_PVNV);
2129 SvNV_set(sv, -(NV)value);
2130 SvIV_set(sv, IV_MIN);
2134 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2135 will be in the previous block to set the IV slot, and the next
2136 block to set the NV slot. So no else here. */
2138 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2139 != IS_NUMBER_IN_UV) {
2140 /* It wasn't an (integer that doesn't overflow the UV). */
2141 SvNV_set(sv, Atof(SvPVX_const(sv)));
2143 if (! numtype && ckWARN(WARN_NUMERIC))
2146 #if defined(USE_LONG_DOUBLE)
2147 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2148 PTR2UV(sv), SvNVX(sv)));
2150 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2151 PTR2UV(sv), SvNVX(sv)));
2154 #ifdef NV_PRESERVES_UV
2155 (void)SvIOKp_on(sv);
2157 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2158 SvIV_set(sv, I_V(SvNVX(sv)));
2159 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2162 NOOP; /* Integer is imprecise. NOK, IOKp */
2164 /* UV will not work better than IV */
2166 if (SvNVX(sv) > (NV)UV_MAX) {
2168 /* Integer is inaccurate. NOK, IOKp, is UV */
2169 SvUV_set(sv, UV_MAX);
2171 SvUV_set(sv, U_V(SvNVX(sv)));
2172 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2173 NV preservse UV so can do correct comparison. */
2174 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2177 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2182 #else /* NV_PRESERVES_UV */
2183 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2184 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2185 /* The IV/UV slot will have been set from value returned by
2186 grok_number above. The NV slot has just been set using
2189 assert (SvIOKp(sv));
2191 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2192 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2193 /* Small enough to preserve all bits. */
2194 (void)SvIOKp_on(sv);
2196 SvIV_set(sv, I_V(SvNVX(sv)));
2197 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2199 /* Assumption: first non-preserved integer is < IV_MAX,
2200 this NV is in the preserved range, therefore: */
2201 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2203 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);
2207 0 0 already failed to read UV.
2208 0 1 already failed to read UV.
2209 1 0 you won't get here in this case. IV/UV
2210 slot set, public IOK, Atof() unneeded.
2211 1 1 already read UV.
2212 so there's no point in sv_2iuv_non_preserve() attempting
2213 to use atol, strtol, strtoul etc. */
2215 sv_2iuv_non_preserve (sv, numtype);
2217 sv_2iuv_non_preserve (sv);
2221 #endif /* NV_PRESERVES_UV */
2222 /* It might be more code efficient to go through the entire logic above
2223 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2224 gets complex and potentially buggy, so more programmer efficient
2225 to do it this way, by turning off the public flags: */
2227 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2231 if (isGV_with_GP(sv))
2232 return glob_2number((GV *)sv);
2234 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2235 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2238 if (SvTYPE(sv) < SVt_IV)
2239 /* Typically the caller expects that sv_any is not NULL now. */
2240 sv_upgrade(sv, SVt_IV);
2241 /* Return 0 from the caller. */
2248 =for apidoc sv_2iv_flags
2250 Return the integer value of an SV, doing any necessary string
2251 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2252 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2258 Perl_sv_2iv_flags(pTHX_ register SV *const sv, const I32 flags)
2263 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2264 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2265 cache IVs just in case. In practice it seems that they never
2266 actually anywhere accessible by user Perl code, let alone get used
2267 in anything other than a string context. */
2268 if (flags & SV_GMAGIC)
2273 return I_V(SvNVX(sv));
2275 if (SvPOKp(sv) && SvLEN(sv)) {
2278 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2281 == IS_NUMBER_IN_UV) {
2282 /* It's definitely an integer */
2283 if (numtype & IS_NUMBER_NEG) {
2284 if (value < (UV)IV_MIN)
2287 if (value < (UV)IV_MAX)
2292 if (ckWARN(WARN_NUMERIC))
2295 return I_V(Atof(SvPVX_const(sv)));
2300 assert(SvTYPE(sv) >= SVt_PVMG);
2301 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2302 } else if (SvTHINKFIRST(sv)) {
2306 SV * const tmpstr=AMG_CALLun(sv,numer);
2307 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2308 return SvIV(tmpstr);
2311 return PTR2IV(SvRV(sv));
2314 sv_force_normal_flags(sv, 0);
2316 if (SvREADONLY(sv) && !SvOK(sv)) {
2317 if (ckWARN(WARN_UNINITIALIZED))
2323 if (S_sv_2iuv_common(aTHX_ sv))
2326 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2327 PTR2UV(sv),SvIVX(sv)));
2328 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2332 =for apidoc sv_2uv_flags
2334 Return the unsigned integer value of an SV, doing any necessary string
2335 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2336 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2342 Perl_sv_2uv_flags(pTHX_ register SV *const sv, const I32 flags)
2347 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2348 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2349 cache IVs just in case. */
2350 if (flags & SV_GMAGIC)
2355 return U_V(SvNVX(sv));
2356 if (SvPOKp(sv) && SvLEN(sv)) {
2359 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2361 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2362 == IS_NUMBER_IN_UV) {
2363 /* It's definitely an integer */
2364 if (!(numtype & IS_NUMBER_NEG))
2368 if (ckWARN(WARN_NUMERIC))
2371 return U_V(Atof(SvPVX_const(sv)));
2376 assert(SvTYPE(sv) >= SVt_PVMG);
2377 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2378 } else if (SvTHINKFIRST(sv)) {
2382 SV *const tmpstr = AMG_CALLun(sv,numer);
2383 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2384 return SvUV(tmpstr);
2387 return PTR2UV(SvRV(sv));
2390 sv_force_normal_flags(sv, 0);
2392 if (SvREADONLY(sv) && !SvOK(sv)) {
2393 if (ckWARN(WARN_UNINITIALIZED))
2399 if (S_sv_2iuv_common(aTHX_ sv))
2403 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2404 PTR2UV(sv),SvUVX(sv)));
2405 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2411 Return the num value of an SV, doing any necessary string or integer
2412 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2419 Perl_sv_2nv(pTHX_ register SV *const sv)
2424 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2425 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2426 cache IVs just in case. */
2430 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2431 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2432 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2434 return Atof(SvPVX_const(sv));
2438 return (NV)SvUVX(sv);
2440 return (NV)SvIVX(sv);
2445 assert(SvTYPE(sv) >= SVt_PVMG);
2446 /* This falls through to the report_uninit near the end of the
2448 } else if (SvTHINKFIRST(sv)) {
2452 SV *const tmpstr = AMG_CALLun(sv,numer);
2453 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2454 return SvNV(tmpstr);
2457 return PTR2NV(SvRV(sv));
2460 sv_force_normal_flags(sv, 0);
2462 if (SvREADONLY(sv) && !SvOK(sv)) {
2463 if (ckWARN(WARN_UNINITIALIZED))
2468 if (SvTYPE(sv) < SVt_NV) {
2469 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2470 sv_upgrade(sv, SVt_NV);
2471 #ifdef USE_LONG_DOUBLE
2473 STORE_NUMERIC_LOCAL_SET_STANDARD();
2474 PerlIO_printf(Perl_debug_log,
2475 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2476 PTR2UV(sv), SvNVX(sv));
2477 RESTORE_NUMERIC_LOCAL();
2481 STORE_NUMERIC_LOCAL_SET_STANDARD();
2482 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2483 PTR2UV(sv), SvNVX(sv));
2484 RESTORE_NUMERIC_LOCAL();
2488 else if (SvTYPE(sv) < SVt_PVNV)
2489 sv_upgrade(sv, SVt_PVNV);
2494 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2495 #ifdef NV_PRESERVES_UV
2501 /* Only set the public NV OK flag if this NV preserves the IV */
2502 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2504 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2505 : (SvIVX(sv) == I_V(SvNVX(sv))))
2511 else if (SvPOKp(sv) && SvLEN(sv)) {
2513 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2514 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2516 #ifdef NV_PRESERVES_UV
2517 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2518 == IS_NUMBER_IN_UV) {
2519 /* It's definitely an integer */
2520 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2522 SvNV_set(sv, Atof(SvPVX_const(sv)));
2528 SvNV_set(sv, Atof(SvPVX_const(sv)));
2529 /* Only set the public NV OK flag if this NV preserves the value in
2530 the PV at least as well as an IV/UV would.
2531 Not sure how to do this 100% reliably. */
2532 /* if that shift count is out of range then Configure's test is
2533 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2535 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2536 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2537 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2538 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2539 /* Can't use strtol etc to convert this string, so don't try.
2540 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2543 /* value has been set. It may not be precise. */
2544 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2545 /* 2s complement assumption for (UV)IV_MIN */
2546 SvNOK_on(sv); /* Integer is too negative. */
2551 if (numtype & IS_NUMBER_NEG) {
2552 SvIV_set(sv, -(IV)value);
2553 } else if (value <= (UV)IV_MAX) {
2554 SvIV_set(sv, (IV)value);
2556 SvUV_set(sv, value);
2560 if (numtype & IS_NUMBER_NOT_INT) {
2561 /* I believe that even if the original PV had decimals,
2562 they are lost beyond the limit of the FP precision.
2563 However, neither is canonical, so both only get p
2564 flags. NWC, 2000/11/25 */
2565 /* Both already have p flags, so do nothing */
2567 const NV nv = SvNVX(sv);
2568 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2569 if (SvIVX(sv) == I_V(nv)) {
2572 /* It had no "." so it must be integer. */
2576 /* between IV_MAX and NV(UV_MAX).
2577 Could be slightly > UV_MAX */
2579 if (numtype & IS_NUMBER_NOT_INT) {
2580 /* UV and NV both imprecise. */
2582 const UV nv_as_uv = U_V(nv);
2584 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2593 /* It might be more code efficient to go through the entire logic above
2594 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2595 gets complex and potentially buggy, so more programmer efficient
2596 to do it this way, by turning off the public flags: */
2598 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2599 #endif /* NV_PRESERVES_UV */
2602 if (isGV_with_GP(sv)) {
2603 glob_2number((GV *)sv);
2607 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2609 assert (SvTYPE(sv) >= SVt_NV);
2610 /* Typically the caller expects that sv_any is not NULL now. */
2611 /* XXX Ilya implies that this is a bug in callers that assume this
2612 and ideally should be fixed. */
2615 #if defined(USE_LONG_DOUBLE)
2617 STORE_NUMERIC_LOCAL_SET_STANDARD();
2618 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2619 PTR2UV(sv), SvNVX(sv));
2620 RESTORE_NUMERIC_LOCAL();
2624 STORE_NUMERIC_LOCAL_SET_STANDARD();
2625 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2626 PTR2UV(sv), SvNVX(sv));
2627 RESTORE_NUMERIC_LOCAL();
2636 Return an SV with the numeric value of the source SV, doing any necessary
2637 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2638 access this function.
2644 Perl_sv_2num(pTHX_ register SV *const sv)
2646 PERL_ARGS_ASSERT_SV_2NUM;
2651 SV * const tmpsv = AMG_CALLun(sv,numer);
2652 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2653 return sv_2num(tmpsv);
2655 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2658 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2659 * UV as a string towards the end of buf, and return pointers to start and
2662 * We assume that buf is at least TYPE_CHARS(UV) long.
2666 S_uiv_2buf(char *const buf, const IV iv, UV uv, const int is_uv, char **const peob)
2668 char *ptr = buf + TYPE_CHARS(UV);
2669 char * const ebuf = ptr;
2672 PERL_ARGS_ASSERT_UIV_2BUF;
2684 *--ptr = '0' + (char)(uv % 10);
2693 =for apidoc sv_2pv_flags
2695 Returns a pointer to the string value of an SV, and sets *lp to its length.
2696 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2698 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2699 usually end up here too.
2705 Perl_sv_2pv_flags(pTHX_ register SV *const sv, STRLEN *const lp, const I32 flags)
2715 if (SvGMAGICAL(sv)) {
2716 if (flags & SV_GMAGIC)
2721 if (flags & SV_MUTABLE_RETURN)
2722 return SvPVX_mutable(sv);
2723 if (flags & SV_CONST_RETURN)
2724 return (char *)SvPVX_const(sv);
2727 if (SvIOKp(sv) || SvNOKp(sv)) {
2728 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2733 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2734 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2736 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2743 #ifdef FIXNEGATIVEZERO
2744 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2750 SvUPGRADE(sv, SVt_PV);
2753 s = SvGROW_mutable(sv, len + 1);
2756 return (char*)memcpy(s, tbuf, len + 1);
2762 assert(SvTYPE(sv) >= SVt_PVMG);
2763 /* This falls through to the report_uninit near the end of the
2765 } else if (SvTHINKFIRST(sv)) {
2769 SV *const tmpstr = AMG_CALLun(sv,string);
2770 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2772 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2776 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2777 if (flags & SV_CONST_RETURN) {
2778 pv = (char *) SvPVX_const(tmpstr);
2780 pv = (flags & SV_MUTABLE_RETURN)
2781 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2784 *lp = SvCUR(tmpstr);
2786 pv = sv_2pv_flags(tmpstr, lp, flags);
2799 const SV *const referent = (SV*)SvRV(sv);
2803 retval = buffer = savepvn("NULLREF", len);
2804 } else if (SvTYPE(referent) == SVt_REGEXP) {
2805 const REGEXP * const re = (REGEXP *)referent;
2810 /* If the regex is UTF-8 we want the containing scalar to
2811 have an UTF-8 flag too */
2817 if ((seen_evals = RX_SEEN_EVALS(re)))
2818 PL_reginterp_cnt += seen_evals;
2821 *lp = RX_WRAPLEN(re);
2823 return RX_WRAPPED(re);
2825 const char *const typestr = sv_reftype(referent, 0);
2826 const STRLEN typelen = strlen(typestr);
2827 UV addr = PTR2UV(referent);
2828 const char *stashname = NULL;
2829 STRLEN stashnamelen = 0; /* hush, gcc */
2830 const char *buffer_end;
2832 if (SvOBJECT(referent)) {
2833 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2836 stashname = HEK_KEY(name);
2837 stashnamelen = HEK_LEN(name);
2839 if (HEK_UTF8(name)) {
2845 stashname = "__ANON__";
2848 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2849 + 2 * sizeof(UV) + 2 /* )\0 */;
2851 len = typelen + 3 /* (0x */
2852 + 2 * sizeof(UV) + 2 /* )\0 */;
2855 Newx(buffer, len, char);
2856 buffer_end = retval = buffer + len;
2858 /* Working backwards */
2862 *--retval = PL_hexdigit[addr & 15];
2863 } while (addr >>= 4);
2869 memcpy(retval, typestr, typelen);
2873 retval -= stashnamelen;
2874 memcpy(retval, stashname, stashnamelen);
2876 /* retval may not neccesarily have reached the start of the
2878 assert (retval >= buffer);
2880 len = buffer_end - retval - 1; /* -1 for that \0 */
2888 if (SvREADONLY(sv) && !SvOK(sv)) {
2891 if (flags & SV_UNDEF_RETURNS_NULL)
2893 if (ckWARN(WARN_UNINITIALIZED))
2898 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2899 /* I'm assuming that if both IV and NV are equally valid then
2900 converting the IV is going to be more efficient */
2901 const U32 isUIOK = SvIsUV(sv);
2902 char buf[TYPE_CHARS(UV)];
2906 if (SvTYPE(sv) < SVt_PVIV)
2907 sv_upgrade(sv, SVt_PVIV);
2908 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2910 /* inlined from sv_setpvn */
2911 s = SvGROW_mutable(sv, len + 1);
2912 Move(ptr, s, len, char);
2916 else if (SvNOKp(sv)) {
2917 const int olderrno = errno;
2918 if (SvTYPE(sv) < SVt_PVNV)
2919 sv_upgrade(sv, SVt_PVNV);
2920 /* The +20 is pure guesswork. Configure test needed. --jhi */
2921 s = SvGROW_mutable(sv, NV_DIG + 20);
2922 /* some Xenix systems wipe out errno here */
2924 if (SvNVX(sv) == 0.0)
2925 my_strlcpy(s, "0", SvLEN(sv));
2929 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2932 #ifdef FIXNEGATIVEZERO
2933 if (*s == '-' && s[1] == '0' && !s[2]) {
2945 if (isGV_with_GP(sv))
2946 return glob_2pv((GV *)sv, lp);
2950 if (flags & SV_UNDEF_RETURNS_NULL)
2952 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2954 if (SvTYPE(sv) < SVt_PV)
2955 /* Typically the caller expects that sv_any is not NULL now. */
2956 sv_upgrade(sv, SVt_PV);
2960 const STRLEN len = s - SvPVX_const(sv);
2966 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2967 PTR2UV(sv),SvPVX_const(sv)));
2968 if (flags & SV_CONST_RETURN)
2969 return (char *)SvPVX_const(sv);
2970 if (flags & SV_MUTABLE_RETURN)
2971 return SvPVX_mutable(sv);
2976 =for apidoc sv_copypv
2978 Copies a stringified representation of the source SV into the
2979 destination SV. Automatically performs any necessary mg_get and
2980 coercion of numeric values into strings. Guaranteed to preserve
2981 UTF8 flag even from overloaded objects. Similar in nature to
2982 sv_2pv[_flags] but operates directly on an SV instead of just the
2983 string. Mostly uses sv_2pv_flags to do its work, except when that
2984 would lose the UTF-8'ness of the PV.
2990 Perl_sv_copypv(pTHX_ SV *const dsv, register SV *const ssv)
2993 const char * const s = SvPV_const(ssv,len);
2995 PERL_ARGS_ASSERT_SV_COPYPV;
2997 sv_setpvn(dsv,s,len);
3005 =for apidoc sv_2pvbyte
3007 Return a pointer to the byte-encoded representation of the SV, and set *lp
3008 to its length. May cause the SV to be downgraded from UTF-8 as a
3011 Usually accessed via the C<SvPVbyte> macro.
3017 Perl_sv_2pvbyte(pTHX_ register SV *const sv, STRLEN *const lp)
3019 PERL_ARGS_ASSERT_SV_2PVBYTE;
3021 sv_utf8_downgrade(sv,0);
3022 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3026 =for apidoc sv_2pvutf8
3028 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3029 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3031 Usually accessed via the C<SvPVutf8> macro.
3037 Perl_sv_2pvutf8(pTHX_ register SV *const sv, STRLEN *const lp)
3039 PERL_ARGS_ASSERT_SV_2PVUTF8;
3041 sv_utf8_upgrade(sv);
3042 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
3047 =for apidoc sv_2bool
3049 This function is only called on magical items, and is only used by
3050 sv_true() or its macro equivalent.
3056 Perl_sv_2bool(pTHX_ register SV *const sv)
3060 PERL_ARGS_ASSERT_SV_2BOOL;
3068 SV * const tmpsv = AMG_CALLun(sv,bool_);
3069 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3070 return (bool)SvTRUE(tmpsv);
3072 return SvRV(sv) != 0;
3075 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
3077 (*sv->sv_u.svu_pv > '0' ||
3078 Xpvtmp->xpv_cur > 1 ||
3079 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3086 return SvIVX(sv) != 0;
3089 return SvNVX(sv) != 0.0;
3091 if (isGV_with_GP(sv))
3101 =for apidoc sv_utf8_upgrade
3103 Converts the PV of an SV to its UTF-8-encoded form.
3104 Forces the SV to string form if it is not already.
3105 Always sets the SvUTF8 flag to avoid future validity checks even
3106 if all the bytes have hibit clear.
3108 This is not as a general purpose byte encoding to Unicode interface:
3109 use the Encode extension for that.
3111 =for apidoc sv_utf8_upgrade_flags
3113 Converts the PV of an SV to its UTF-8-encoded form.
3114 Forces the SV to string form if it is not already.
3115 Always sets the SvUTF8 flag to avoid future validity checks even
3116 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3117 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3118 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3120 This is not as a general purpose byte encoding to Unicode interface:
3121 use the Encode extension for that.
3127 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *const sv, const I32 flags)
3131 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE_FLAGS;
3133 if (sv == &PL_sv_undef)
3137 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3138 (void) sv_2pv_flags(sv,&len, flags);
3142 (void) SvPV_force(sv,len);
3151 sv_force_normal_flags(sv, 0);
3154 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3155 sv_recode_to_utf8(sv, PL_encoding);
3156 else { /* Assume Latin-1/EBCDIC */
3157 /* This function could be much more efficient if we
3158 * had a FLAG in SVs to signal if there are any hibit
3159 * chars in the PV. Given that there isn't such a flag
3160 * make the loop as fast as possible. */
3161 const U8 * const s = (U8 *) SvPVX_const(sv);
3162 const U8 * const e = (U8 *) SvEND(sv);
3167 /* Check for hi bit */
3168 if (!NATIVE_IS_INVARIANT(ch)) {
3169 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3170 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3172 SvPV_free(sv); /* No longer using what was there before. */
3173 SvPV_set(sv, (char*)recoded);
3174 SvCUR_set(sv, len - 1);
3175 SvLEN_set(sv, len); /* No longer know the real size. */
3179 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3186 =for apidoc sv_utf8_downgrade
3188 Attempts to convert the PV of an SV from characters to bytes.
3189 If the PV contains a character beyond byte, this conversion will fail;
3190 in this case, either returns false or, if C<fail_ok> is not
3193 This is not as a general purpose Unicode to byte encoding interface:
3194 use the Encode extension for that.
3200 Perl_sv_utf8_downgrade(pTHX_ register SV *const sv, const bool fail_ok)
3204 PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
3206 if (SvPOKp(sv) && SvUTF8(sv)) {
3212 sv_force_normal_flags(sv, 0);
3214 s = (U8 *) SvPV(sv, len);
3215 if (!utf8_to_bytes(s, &len)) {
3220 Perl_croak(aTHX_ "Wide character in %s",
3223 Perl_croak(aTHX_ "Wide character");
3234 =for apidoc sv_utf8_encode
3236 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3237 flag off so that it looks like octets again.
3243 Perl_sv_utf8_encode(pTHX_ register SV *const sv)
3245 PERL_ARGS_ASSERT_SV_UTF8_ENCODE;
3248 sv_force_normal_flags(sv, 0);
3250 if (SvREADONLY(sv)) {
3251 Perl_croak(aTHX_ PL_no_modify);
3253 (void) sv_utf8_upgrade(sv);
3258 =for apidoc sv_utf8_decode
3260 If the PV of the SV is an octet sequence in UTF-8
3261 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3262 so that it looks like a character. If the PV contains only single-byte
3263 characters, the C<SvUTF8> flag stays being off.
3264 Scans PV for validity and returns false if the PV is invalid UTF-8.
3270 Perl_sv_utf8_decode(pTHX_ register SV *const sv)
3272 PERL_ARGS_ASSERT_SV_UTF8_DECODE;
3278 /* The octets may have got themselves encoded - get them back as
3281 if (!sv_utf8_downgrade(sv, TRUE))
3284 /* it is actually just a matter of turning the utf8 flag on, but
3285 * we want to make sure everything inside is valid utf8 first.
3287 c = (const U8 *) SvPVX_const(sv);
3288 if (!is_utf8_string(c, SvCUR(sv)+1))
3290 e = (const U8 *) SvEND(sv);
3293 if (!UTF8_IS_INVARIANT(ch)) {
3303 =for apidoc sv_setsv
3305 Copies the contents of the source SV C<ssv> into the destination SV
3306 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3307 function if the source SV needs to be reused. Does not handle 'set' magic.
3308 Loosely speaking, it performs a copy-by-value, obliterating any previous
3309 content of the destination.
3311 You probably want to use one of the assortment of wrappers, such as
3312 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3313 C<SvSetMagicSV_nosteal>.
3315 =for apidoc sv_setsv_flags
3317 Copies the contents of the source SV C<ssv> into the destination SV
3318 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3319 function if the source SV needs to be reused. Does not handle 'set' magic.
3320 Loosely speaking, it performs a copy-by-value, obliterating any previous
3321 content of the destination.
3322 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3323 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3324 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3325 and C<sv_setsv_nomg> are implemented in terms of this function.
3327 You probably want to use one of the assortment of wrappers, such as
3328 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3329 C<SvSetMagicSV_nosteal>.
3331 This is the primary function for copying scalars, and most other
3332 copy-ish functions and macros use this underneath.
3338 S_glob_assign_glob(pTHX_ SV *const dstr, SV *const sstr, const int dtype)
3340 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3342 PERL_ARGS_ASSERT_GLOB_ASSIGN_GLOB;
3344 if (dtype != SVt_PVGV) {
3345 const char * const name = GvNAME(sstr);
3346 const STRLEN len = GvNAMELEN(sstr);
3348 if (dtype >= SVt_PV) {
3354 SvUPGRADE(dstr, SVt_PVGV);
3355 (void)SvOK_off(dstr);
3356 /* FIXME - why are we doing this, then turning it off and on again
3358 isGV_with_GP_on(dstr);
3360 GvSTASH(dstr) = GvSTASH(sstr);
3362 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3363 gv_name_set((GV *)dstr, name, len, GV_ADD);
3364 SvFAKE_on(dstr); /* can coerce to non-glob */
3367 #ifdef GV_UNIQUE_CHECK
3368 if (GvUNIQUE((GV*)dstr)) {
3369 Perl_croak(aTHX_ PL_no_modify);
3373 if(GvGP((GV*)sstr)) {
3374 /* If source has method cache entry, clear it */
3376 SvREFCNT_dec(GvCV(sstr));
3380 /* If source has a real method, then a method is
3382 else if(GvCV((GV*)sstr)) {
3387 /* If dest already had a real method, that's a change as well */
3388 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3392 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3396 isGV_with_GP_off(dstr);
3397 (void)SvOK_off(dstr);
3398 isGV_with_GP_on(dstr);
3399 GvINTRO_off(dstr); /* one-shot flag */
3400 GvGP(dstr) = gp_ref(GvGP(sstr));
3401 if (SvTAINTED(sstr))
3403 if (GvIMPORTED(dstr) != GVf_IMPORTED
3404 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3406 GvIMPORTED_on(dstr);
3409 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3410 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3415 S_glob_assign_ref(pTHX_ SV *const dstr, SV *const sstr)
3417 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3419 const int intro = GvINTRO(dstr);
3422 const U32 stype = SvTYPE(sref);
3424 PERL_ARGS_ASSERT_GLOB_ASSIGN_REF;
3426 #ifdef GV_UNIQUE_CHECK
3427 if (GvUNIQUE((GV*)dstr)) {
3428 Perl_croak(aTHX_ PL_no_modify);
3433 GvINTRO_off(dstr); /* one-shot flag */
3434 GvLINE(dstr) = CopLINE(PL_curcop);
3435 GvEGV(dstr) = (GV*)dstr;
3440 location = (SV **) &GvCV(dstr);
3441 import_flag = GVf_IMPORTED_CV;
3444 location = (SV **) &GvHV(dstr);
3445 import_flag = GVf_IMPORTED_HV;
3448 location = (SV **) &GvAV(dstr);
3449 import_flag = GVf_IMPORTED_AV;
3452 location = (SV **) &GvIOp(dstr);
3455 location = (SV **) &GvFORM(dstr);
3457 location = &GvSV(dstr);
3458 import_flag = GVf_IMPORTED_SV;
3461 if (stype == SVt_PVCV) {
3462 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3463 if (GvCVGEN(dstr)) {
3464 SvREFCNT_dec(GvCV(dstr));
3466 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3469 SAVEGENERICSV(*location);
3473 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3474 CV* const cv = (CV*)*location;
3476 if (!GvCVGEN((GV*)dstr) &&
3477 (CvROOT(cv) || CvXSUB(cv)))
3479 /* Redefining a sub - warning is mandatory if
3480 it was a const and its value changed. */
3481 if (CvCONST(cv) && CvCONST((CV*)sref)
3482 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3484 /* They are 2 constant subroutines generated from
3485 the same constant. This probably means that
3486 they are really the "same" proxy subroutine
3487 instantiated in 2 places. Most likely this is
3488 when a constant is exported twice. Don't warn.
3491 else if (ckWARN(WARN_REDEFINE)
3493 && (!CvCONST((CV*)sref)
3494 || sv_cmp(cv_const_sv(cv),
3495 cv_const_sv((CV*)sref))))) {
3496 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3499 ? "Constant subroutine %s::%s redefined"
3500 : "Subroutine %s::%s redefined"),
3501 HvNAME_get(GvSTASH((GV*)dstr)),
3502 GvENAME((GV*)dstr));
3506 cv_ckproto_len(cv, (GV*)dstr,
3507 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3508 SvPOK(sref) ? SvCUR(sref) : 0);
3510 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3511 GvASSUMECV_on(dstr);
3512 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3515 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3516 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3517 GvFLAGS(dstr) |= import_flag;
3522 if (SvTAINTED(sstr))
3528 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV* sstr, const I32 flags)
3531 register U32 sflags;
3533 register svtype stype;
3535 PERL_ARGS_ASSERT_SV_SETSV_FLAGS;
3540 if (SvIS_FREED(dstr)) {
3541 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3542 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3544 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3546 sstr = &PL_sv_undef;
3547 if (SvIS_FREED(sstr)) {
3548 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3549 (void*)sstr, (void*)dstr);
3551 stype = SvTYPE(sstr);
3552 dtype = SvTYPE(dstr);
3554 (void)SvAMAGIC_off(dstr);
3557 /* need to nuke the magic */
3561 /* There's a lot of redundancy below but we're going for speed here */
3566 if (dtype != SVt_PVGV) {
3567 (void)SvOK_off(dstr);
3575 sv_upgrade(dstr, SVt_IV);
3579 sv_upgrade(dstr, SVt_PVIV);
3582 goto end_of_first_switch;
3584 (void)SvIOK_only(dstr);
3585 SvIV_set(dstr, SvIVX(sstr));
3588 /* SvTAINTED can only be true if the SV has taint magic, which in
3589 turn means that the SV type is PVMG (or greater). This is the
3590 case statement for SVt_IV, so this cannot be true (whatever gcov
3592 assert(!SvTAINTED(sstr));
3597 if (dtype < SVt_PV && dtype != SVt_IV)
3598 sv_upgrade(dstr, SVt_IV);
3606 sv_upgrade(dstr, SVt_NV);
3610 sv_upgrade(dstr, SVt_PVNV);
3613 goto end_of_first_switch;
3615 SvNV_set(dstr, SvNVX(sstr));
3616 (void)SvNOK_only(dstr);
3617 /* SvTAINTED can only be true if the SV has taint magic, which in
3618 turn means that the SV type is PVMG (or greater). This is the
3619 case statement for SVt_NV, so this cannot be true (whatever gcov
3621 assert(!SvTAINTED(sstr));
3627 #ifdef PERL_OLD_COPY_ON_WRITE
3628 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3629 if (dtype < SVt_PVIV)
3630 sv_upgrade(dstr, SVt_PVIV);
3638 sv_upgrade(dstr, SVt_PV);
3641 if (dtype < SVt_PVIV)
3642 sv_upgrade(dstr, SVt_PVIV);
3645 if (dtype < SVt_PVNV)
3646 sv_upgrade(dstr, SVt_PVNV);
3650 const char * const type = sv_reftype(sstr,0);
3652 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3654 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3658 /* case SVt_BIND: */
3661 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3662 glob_assign_glob(dstr, sstr, dtype);
3665 /* SvVALID means that this PVGV is playing at being an FBM. */
3669 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3671 if (SvTYPE(sstr) != stype) {
3672 stype = SvTYPE(sstr);
3673 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3674 glob_assign_glob(dstr, sstr, dtype);
3679 if (stype == SVt_PVLV)
3680 SvUPGRADE(dstr, SVt_PVNV);
3682 SvUPGRADE(dstr, (svtype)stype);
3684 end_of_first_switch:
3686 /* dstr may have been upgraded. */
3687 dtype = SvTYPE(dstr);
3688 sflags = SvFLAGS(sstr);
3690 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3691 /* Assigning to a subroutine sets the prototype. */
3694 const char *const ptr = SvPV_const(sstr, len);
3696 SvGROW(dstr, len + 1);
3697 Copy(ptr, SvPVX(dstr), len + 1, char);
3698 SvCUR_set(dstr, len);
3700 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3704 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3705 const char * const type = sv_reftype(dstr,0);
3707 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3709 Perl_croak(aTHX_ "Cannot copy to %s", type);
3710 } else if (sflags & SVf_ROK) {
3711 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3712 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3715 if (GvIMPORTED(dstr) != GVf_IMPORTED
3716 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3718 GvIMPORTED_on(dstr);
3723 if (isGV_with_GP(sstr)) {
3724 glob_assign_glob(dstr, sstr, dtype);
3729 if (dtype >= SVt_PV) {
3730 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3731 glob_assign_ref(dstr, sstr);
3734 if (SvPVX_const(dstr)) {
3740 (void)SvOK_off(dstr);
3741 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3742 SvFLAGS(dstr) |= sflags & SVf_ROK;
3743 assert(!(sflags & SVp_NOK));
3744 assert(!(sflags & SVp_IOK));
3745 assert(!(sflags & SVf_NOK));
3746 assert(!(sflags & SVf_IOK));
3748 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3749 if (!(sflags & SVf_OK)) {
3750 if (ckWARN(WARN_MISC))
3751 Perl_warner(aTHX_ packWARN(WARN_MISC),
3752 "Undefined value assigned to typeglob");
3755 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3756 if (dstr != (SV*)gv) {
3759 GvGP(dstr) = gp_ref(GvGP(gv));
3763 else if (sflags & SVp_POK) {
3767 * Check to see if we can just swipe the string. If so, it's a
3768 * possible small lose on short strings, but a big win on long ones.
3769 * It might even be a win on short strings if SvPVX_const(dstr)
3770 * has to be allocated and SvPVX_const(sstr) has to be freed.
3771 * Likewise if we can set up COW rather than doing an actual copy, we
3772 * drop to the else clause, as the swipe code and the COW setup code
3773 * have much in common.
3776 /* Whichever path we take through the next code, we want this true,
3777 and doing it now facilitates the COW check. */
3778 (void)SvPOK_only(dstr);
3781 /* If we're already COW then this clause is not true, and if COW
3782 is allowed then we drop down to the else and make dest COW
3783 with us. If caller hasn't said that we're allowed to COW
3784 shared hash keys then we don't do the COW setup, even if the
3785 source scalar is a shared hash key scalar. */
3786 (((flags & SV_COW_SHARED_HASH_KEYS)
3787 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3788 : 1 /* If making a COW copy is forbidden then the behaviour we
3789 desire is as if the source SV isn't actually already
3790 COW, even if it is. So we act as if the source flags
3791 are not COW, rather than actually testing them. */
3793 #ifndef PERL_OLD_COPY_ON_WRITE
3794 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3795 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3796 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3797 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3798 but in turn, it's somewhat dead code, never expected to go
3799 live, but more kept as a placeholder on how to do it better
3800 in a newer implementation. */
3801 /* If we are COW and dstr is a suitable target then we drop down
3802 into the else and make dest a COW of us. */
3803 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3808 (sflags & SVs_TEMP) && /* slated for free anyway? */
3809 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3810 (!(flags & SV_NOSTEAL)) &&
3811 /* and we're allowed to steal temps */
3812 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3813 SvLEN(sstr) && /* and really is a string */
3814 /* and won't be needed again, potentially */
3815 !(PL_op && PL_op->op_type == OP_AASSIGN))
3816 #ifdef PERL_OLD_COPY_ON_WRITE
3817 && ((flags & SV_COW_SHARED_HASH_KEYS)
3818 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3819 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3820 && SvTYPE(sstr) >= SVt_PVIV))
3824 /* Failed the swipe test, and it's not a shared hash key either.
3825 Have to copy the string. */
3826 STRLEN len = SvCUR(sstr);
3827 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3828 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3829 SvCUR_set(dstr, len);
3830 *SvEND(dstr) = '\0';
3832 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3834 /* Either it's a shared hash key, or it's suitable for
3835 copy-on-write or we can swipe the string. */
3837 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3841 #ifdef PERL_OLD_COPY_ON_WRITE
3843 /* I believe I should acquire a global SV mutex if
3844 it's a COW sv (not a shared hash key) to stop
3845 it going un copy-on-write.
3846 If the source SV has gone un copy on write between up there
3847 and down here, then (assert() that) it is of the correct
3848 form to make it copy on write again */
3849 if ((sflags & (SVf_FAKE | SVf_READONLY))
3850 != (SVf_FAKE | SVf_READONLY)) {
3851 SvREADONLY_on(sstr);
3853 /* Make the source SV into a loop of 1.
3854 (about to become 2) */
3855 SV_COW_NEXT_SV_SET(sstr, sstr);
3859 /* Initial code is common. */
3860 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3865 /* making another shared SV. */
3866 STRLEN cur = SvCUR(sstr);
3867 STRLEN len = SvLEN(sstr);
3868 #ifdef PERL_OLD_COPY_ON_WRITE
3870 assert (SvTYPE(dstr) >= SVt_PVIV);
3871 /* SvIsCOW_normal */
3872 /* splice us in between source and next-after-source. */
3873 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3874 SV_COW_NEXT_SV_SET(sstr, dstr);
3875 SvPV_set(dstr, SvPVX_mutable(sstr));
3879 /* SvIsCOW_shared_hash */
3880 DEBUG_C(PerlIO_printf(Perl_debug_log,
3881 "Copy on write: Sharing hash\n"));
3883 assert (SvTYPE(dstr) >= SVt_PV);
3885 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3887 SvLEN_set(dstr, len);
3888 SvCUR_set(dstr, cur);
3889 SvREADONLY_on(dstr);
3891 /* Relesase a global SV mutex. */
3894 { /* Passes the swipe test. */
3895 SvPV_set(dstr, SvPVX_mutable(sstr));
3896 SvLEN_set(dstr, SvLEN(sstr));
3897 SvCUR_set(dstr, SvCUR(sstr));
3900 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3901 SvPV_set(sstr, NULL);
3907 if (sflags & SVp_NOK) {
3908 SvNV_set(dstr, SvNVX(sstr));
3910 if (sflags & SVp_IOK) {
3911 SvIV_set(dstr, SvIVX(sstr));
3912 /* Must do this otherwise some other overloaded use of 0x80000000
3913 gets confused. I guess SVpbm_VALID */
3914 if (sflags & SVf_IVisUV)
3917 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3919 const MAGIC * const smg = SvVSTRING_mg(sstr);
3921 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3922 smg->mg_ptr, smg->mg_len);
3923 SvRMAGICAL_on(dstr);
3927 else if (sflags & (SVp_IOK|SVp_NOK)) {
3928 (void)SvOK_off(dstr);
3929 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3930 if (sflags & SVp_IOK) {
3931 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3932 SvIV_set(dstr, SvIVX(sstr));
3934 if (sflags & SVp_NOK) {
3935 SvNV_set(dstr, SvNVX(sstr));
3939 if (isGV_with_GP(sstr)) {
3940 /* This stringification rule for globs is spread in 3 places.
3941 This feels bad. FIXME. */
3942 const U32 wasfake = sflags & SVf_FAKE;
3944 /* FAKE globs can get coerced, so need to turn this off
3945 temporarily if it is on. */
3947 gv_efullname3(dstr, (GV *)sstr, "*");
3948 SvFLAGS(sstr) |= wasfake;
3951 (void)SvOK_off(dstr);
3953 if (SvTAINTED(sstr))
3958 =for apidoc sv_setsv_mg
3960 Like C<sv_setsv>, but also handles 'set' magic.
3966 Perl_sv_setsv_mg(pTHX_ SV *const dstr, register SV *const sstr)
3968 PERL_ARGS_ASSERT_SV_SETSV_MG;
3970 sv_setsv(dstr,sstr);
3974 #ifdef PERL_OLD_COPY_ON_WRITE
3976 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3978 STRLEN cur = SvCUR(sstr);
3979 STRLEN len = SvLEN(sstr);
3980 register char *new_pv;
3982 PERL_ARGS_ASSERT_SV_SETSV_COW;
3985 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3986 (void*)sstr, (void*)dstr);
3993 if (SvTHINKFIRST(dstr))
3994 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3995 else if (SvPVX_const(dstr))
3996 Safefree(SvPVX_const(dstr));
4000 SvUPGRADE(dstr, SVt_PVIV);
4002 assert (SvPOK(sstr));
4003 assert (SvPOKp(sstr));
4004 assert (!SvIOK(sstr));
4005 assert (!SvIOKp(sstr));
4006 assert (!SvNOK(sstr));
4007 assert (!SvNOKp(sstr));
4009 if (SvIsCOW(sstr)) {
4011 if (SvLEN(sstr) == 0) {
4012 /* source is a COW shared hash key. */
4013 DEBUG_C(PerlIO_printf(Perl_debug_log,
4014 "Fast copy on write: Sharing hash\n"));
4015 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
4018 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4020 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4021 SvUPGRADE(sstr, SVt_PVIV);
4022 SvREADONLY_on(sstr);
4024 DEBUG_C(PerlIO_printf(Perl_debug_log,
4025 "Fast copy on write: Converting sstr to COW\n"));
4026 SV_COW_NEXT_SV_SET(dstr, sstr);
4028 SV_COW_NEXT_SV_SET(sstr, dstr);
4029 new_pv = SvPVX_mutable(sstr);
4032 SvPV_set(dstr, new_pv);
4033 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4036 SvLEN_set(dstr, len);
4037 SvCUR_set(dstr, cur);
4046 =for apidoc sv_setpvn
4048 Copies a string into an SV. The C<len> parameter indicates the number of
4049 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4050 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4056 Perl_sv_setpvn(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4059 register char *dptr;
4061 PERL_ARGS_ASSERT_SV_SETPVN;
4063 SV_CHECK_THINKFIRST_COW_DROP(sv);
4069 /* len is STRLEN which is unsigned, need to copy to signed */
4072 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4074 SvUPGRADE(sv, SVt_PV);
4076 dptr = SvGROW(sv, len + 1);
4077 Move(ptr,dptr,len,char);
4080 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4085 =for apidoc sv_setpvn_mg
4087 Like C<sv_setpvn>, but also handles 'set' magic.
4093 Perl_sv_setpvn_mg(pTHX_ register SV *const sv, register const char *const ptr, register const STRLEN len)
4095 PERL_ARGS_ASSERT_SV_SETPVN_MG;
4097 sv_setpvn(sv,ptr,len);
4102 =for apidoc sv_setpv
4104 Copies a string into an SV. The string must be null-terminated. Does not
4105 handle 'set' magic. See C<sv_setpv_mg>.
4111 Perl_sv_setpv(pTHX_ register SV *const sv, register const char *const ptr)
4114 register STRLEN len;
4116 PERL_ARGS_ASSERT_SV_SETPV;
4118 SV_CHECK_THINKFIRST_COW_DROP(sv);
4124 SvUPGRADE(sv, SVt_PV);
4126 SvGROW(sv, len + 1);
4127 Move(ptr,SvPVX(sv),len+1,char);
4129 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4134 =for apidoc sv_setpv_mg
4136 Like C<sv_setpv>, but also handles 'set' magic.
4142 Perl_sv_setpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4144 PERL_ARGS_ASSERT_SV_SETPV_MG;
4151 =for apidoc sv_usepvn_flags
4153 Tells an SV to use C<ptr> to find its string value. Normally the
4154 string is stored inside the SV but sv_usepvn allows the SV to use an
4155 outside string. The C<ptr> should point to memory that was allocated
4156 by C<malloc>. The string length, C<len>, must be supplied. By default
4157 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4158 so that pointer should not be freed or used by the programmer after
4159 giving it to sv_usepvn, and neither should any pointers from "behind"
4160 that pointer (e.g. ptr + 1) be used.
4162 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4163 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4164 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4165 C<len>, and already meets the requirements for storing in C<SvPVX>)
4171 Perl_sv_usepvn_flags(pTHX_ SV *const sv, char *ptr, const STRLEN len, const U32 flags)
4176 PERL_ARGS_ASSERT_SV_USEPVN_FLAGS;
4178 SV_CHECK_THINKFIRST_COW_DROP(sv);
4179 SvUPGRADE(sv, SVt_PV);
4182 if (flags & SV_SMAGIC)
4186 if (SvPVX_const(sv))
4190 if (flags & SV_HAS_TRAILING_NUL)
4191 assert(ptr[len] == '\0');
4194 allocate = (flags & SV_HAS_TRAILING_NUL)
4196 #ifdef Perl_safesysmalloc_size
4199 PERL_STRLEN_ROUNDUP(len + 1);
4201 if (flags & SV_HAS_TRAILING_NUL) {
4202 /* It's long enough - do nothing.
4203 Specfically Perl_newCONSTSUB is relying on this. */
4206 /* Force a move to shake out bugs in callers. */
4207 char *new_ptr = (char*)safemalloc(allocate);
4208 Copy(ptr, new_ptr, len, char);
4209 PoisonFree(ptr,len,char);
4213 ptr = (char*) saferealloc (ptr, allocate);
4216 #ifdef Perl_safesysmalloc_size
4217 SvLEN_set(sv, Perl_safesysmalloc_size(ptr));
4219 SvLEN_set(sv, allocate);
4223 if (!(flags & SV_HAS_TRAILING_NUL)) {
4226 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4228 if (flags & SV_SMAGIC)
4232 #ifdef PERL_OLD_COPY_ON_WRITE
4233 /* Need to do this *after* making the SV normal, as we need the buffer
4234 pointer to remain valid until after we've copied it. If we let go too early,
4235 another thread could invalidate it by unsharing last of the same hash key
4236 (which it can do by means other than releasing copy-on-write Svs)
4237 or by changing the other copy-on-write SVs in the loop. */
4239 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4241 PERL_ARGS_ASSERT_SV_RELEASE_COW;
4243 { /* this SV was SvIsCOW_normal(sv) */
4244 /* we need to find the SV pointing to us. */
4245 SV *current = SV_COW_NEXT_SV(after);
4247 if (current == sv) {
4248 /* The SV we point to points back to us (there were only two of us
4250 Hence other SV is no longer copy on write either. */
4252 SvREADONLY_off(after);
4254 /* We need to follow the pointers around the loop. */
4256 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4259 /* don't loop forever if the structure is bust, and we have
4260 a pointer into a closed loop. */
4261 assert (current != after);
4262 assert (SvPVX_const(current) == pvx);
4264 /* Make the SV before us point to the SV after us. */
4265 SV_COW_NEXT_SV_SET(current, after);
4271 =for apidoc sv_force_normal_flags
4273 Undo various types of fakery on an SV: if the PV is a shared string, make
4274 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4275 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4276 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4277 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4278 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4279 set to some other value.) In addition, the C<flags> parameter gets passed to
4280 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4281 with flags set to 0.
4287 Perl_sv_force_normal_flags(pTHX_ register SV *const sv, const U32 flags)
4291 PERL_ARGS_ASSERT_SV_FORCE_NORMAL_FLAGS;
4293 #ifdef PERL_OLD_COPY_ON_WRITE
4294 if (SvREADONLY(sv)) {
4295 /* At this point I believe I should acquire a global SV mutex. */
4297 const char * const pvx = SvPVX_const(sv);
4298 const STRLEN len = SvLEN(sv);
4299 const STRLEN cur = SvCUR(sv);
4300 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4301 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4302 we'll fail an assertion. */
4303 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4306 PerlIO_printf(Perl_debug_log,
4307 "Copy on write: Force normal %ld\n",
4313 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4316 if (flags & SV_COW_DROP_PV) {
4317 /* OK, so we don't need to copy our buffer. */
4320 SvGROW(sv, cur + 1);
4321 Move(pvx,SvPVX(sv),cur,char);
4326 sv_release_COW(sv, pvx, next);
4328 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4334 else if (IN_PERL_RUNTIME)
4335 Perl_croak(aTHX_ PL_no_modify);
4336 /* At this point I believe that I can drop the global SV mutex. */
4339 if (SvREADONLY(sv)) {
4341 const char * const pvx = SvPVX_const(sv);
4342 const STRLEN len = SvCUR(sv);
4347 SvGROW(sv, len + 1);
4348 Move(pvx,SvPVX(sv),len,char);
4350 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4352 else if (IN_PERL_RUNTIME)
4353 Perl_croak(aTHX_ PL_no_modify);
4357 sv_unref_flags(sv, flags);
4358 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4365 Efficient removal of characters from the beginning of the string buffer.
4366 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4367 the string buffer. The C<ptr> becomes the first character of the adjusted
4368 string. Uses the "OOK hack".
4369 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4370 refer to the same chunk of data.
4376 Perl_sv_chop(pTHX_ register SV *const sv, register const char *const ptr)
4382 const U8 *real_start;
4385 PERL_ARGS_ASSERT_SV_CHOP;
4387 if (!ptr || !SvPOKp(sv))
4389 delta = ptr - SvPVX_const(sv);
4391 /* Nothing to do. */
4394 assert(ptr > SvPVX_const(sv));
4395 SV_CHECK_THINKFIRST(sv);
4398 if (!SvLEN(sv)) { /* make copy of shared string */
4399 const char *pvx = SvPVX_const(sv);
4400 const STRLEN len = SvCUR(sv);
4401 SvGROW(sv, len + 1);
4402 Move(pvx,SvPVX(sv),len,char);
4405 SvFLAGS(sv) |= SVf_OOK;
4408 SvOOK_offset(sv, old_delta);
4410 SvLEN_set(sv, SvLEN(sv) - delta);
4411 SvCUR_set(sv, SvCUR(sv) - delta);
4412 SvPV_set(sv, SvPVX(sv) + delta);
4414 p = (U8 *)SvPVX_const(sv);
4419 real_start = p - delta;
4423 if (delta < 0x100) {
4427 p -= sizeof(STRLEN);
4428 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4432 /* Fill the preceding buffer with sentinals to verify that no-one is
4434 while (p > real_start) {
4442 =for apidoc sv_catpvn
4444 Concatenates the string onto the end of the string which is in the SV. The
4445 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4446 status set, then the bytes appended should be valid UTF-8.
4447 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4449 =for apidoc sv_catpvn_flags
4451 Concatenates the string onto the end of the string which is in the SV. The
4452 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4453 status set, then the bytes appended should be valid UTF-8.
4454 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4455 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4456 in terms of this function.
4462 Perl_sv_catpvn_flags(pTHX_ register SV *const dsv, register const char *sstr, register const STRLEN slen, const I32 flags)
4466 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4468 PERL_ARGS_ASSERT_SV_CATPVN_FLAGS;
4470 SvGROW(dsv, dlen + slen + 1);
4472 sstr = SvPVX_const(dsv);
4473 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4474 SvCUR_set(dsv, SvCUR(dsv) + slen);
4476 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4478 if (flags & SV_SMAGIC)
4483 =for apidoc sv_catsv
4485 Concatenates the string from SV C<ssv> onto the end of the string in
4486 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4487 not 'set' magic. See C<sv_catsv_mg>.
4489 =for apidoc sv_catsv_flags
4491 Concatenates the string from SV C<ssv> onto the end of the string in
4492 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4493 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4494 and C<sv_catsv_nomg> are implemented in terms of this function.
4499 Perl_sv_catsv_flags(pTHX_ SV *const dsv, register SV *const ssv, const I32 flags)
4503 PERL_ARGS_ASSERT_SV_CATSV_FLAGS;
4507 const char *spv = SvPV_const(ssv, slen);
4509 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4510 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4511 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4512 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4513 dsv->sv_flags doesn't have that bit set.
4514 Andy Dougherty 12 Oct 2001
4516 const I32 sutf8 = DO_UTF8(ssv);
4519 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4521 dutf8 = DO_UTF8(dsv);
4523 if (dutf8 != sutf8) {
4525 /* Not modifying source SV, so taking a temporary copy. */
4526 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4528 sv_utf8_upgrade(csv);
4529 spv = SvPV_const(csv, slen);
4532 sv_utf8_upgrade_nomg(dsv);
4534 sv_catpvn_nomg(dsv, spv, slen);
4537 if (flags & SV_SMAGIC)
4542 =for apidoc sv_catpv
4544 Concatenates the string onto the end of the string which is in the SV.
4545 If the SV has the UTF-8 status set, then the bytes appended should be
4546 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4551 Perl_sv_catpv(pTHX_ register SV *const sv, register const char *ptr)
4554 register STRLEN len;
4558 PERL_ARGS_ASSERT_SV_CATPV;
4562 junk = SvPV_force(sv, tlen);
4564 SvGROW(sv, tlen + len + 1);
4566 ptr = SvPVX_const(sv);
4567 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4568 SvCUR_set(sv, SvCUR(sv) + len);
4569 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4574 =for apidoc sv_catpv_mg
4576 Like C<sv_catpv>, but also handles 'set' magic.
4582 Perl_sv_catpv_mg(pTHX_ register SV *const sv, register const char *const ptr)
4584 PERL_ARGS_ASSERT_SV_CATPV_MG;
4593 Creates a new SV. A non-zero C<len> parameter indicates the number of
4594 bytes of preallocated string space the SV should have. An extra byte for a
4595 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4596 space is allocated.) The reference count for the new SV is set to 1.
4598 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4599 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4600 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4601 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4602 modules supporting older perls.
4608 Perl_newSV(pTHX_ const STRLEN len)
4615 sv_upgrade(sv, SVt_PV);
4616 SvGROW(sv, len + 1);
4621 =for apidoc sv_magicext
4623 Adds magic to an SV, upgrading it if necessary. Applies the
4624 supplied vtable and returns a pointer to the magic added.
4626 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4627 In particular, you can add magic to SvREADONLY SVs, and add more than
4628 one instance of the same 'how'.
4630 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4631 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4632 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4633 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4635 (This is now used as a subroutine by C<sv_magic>.)
4640 Perl_sv_magicext(pTHX_ SV *const sv, SV *const obj, const int how,
4641 const MGVTBL *const vtable, const char *const name, const I32 namlen)
4646 PERL_ARGS_ASSERT_SV_MAGICEXT;
4648 SvUPGRADE(sv, SVt_PVMG);
4649 Newxz(mg, 1, MAGIC);
4650 mg->mg_moremagic = SvMAGIC(sv);
4651 SvMAGIC_set(sv, mg);
4653 /* Sometimes a magic contains a reference loop, where the sv and
4654 object refer to each other. To prevent a reference loop that
4655 would prevent such objects being freed, we look for such loops
4656 and if we find one we avoid incrementing the object refcount.
4658 Note we cannot do this to avoid self-tie loops as intervening RV must
4659 have its REFCNT incremented to keep it in existence.
4662 if (!obj || obj == sv ||
4663 how == PERL_MAGIC_arylen ||
4664 how == PERL_MAGIC_symtab ||
4665 (SvTYPE(obj) == SVt_PVGV &&
4666 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4667 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4668 GvFORM(obj) == (CV*)sv)))
4673 mg->mg_obj = SvREFCNT_inc_simple(obj);
4674 mg->mg_flags |= MGf_REFCOUNTED;
4677 /* Normal self-ties simply pass a null object, and instead of
4678 using mg_obj directly, use the SvTIED_obj macro to produce a
4679 new RV as needed. For glob "self-ties", we are tieing the PVIO
4680 with an RV obj pointing to the glob containing the PVIO. In
4681 this case, to avoid a reference loop, we need to weaken the
4685 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4686 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4692 mg->mg_len = namlen;
4695 mg->mg_ptr = savepvn(name, namlen);
4696 else if (namlen == HEf_SVKEY)
4697 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4699 mg->mg_ptr = (char *) name;
4701 mg->mg_virtual = (MGVTBL *) vtable;
4705 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4710 =for apidoc sv_magic
4712 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4713 then adds a new magic item of type C<how> to the head of the magic list.
4715 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4716 handling of the C<name> and C<namlen> arguments.
4718 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4719 to add more than one instance of the same 'how'.
4725 Perl_sv_magic(pTHX_ register SV *const sv, SV *const obj, const int how,
4726 const char *const name, const I32 namlen)
4729 const MGVTBL *vtable;
4732 PERL_ARGS_ASSERT_SV_MAGIC;
4734 #ifdef PERL_OLD_COPY_ON_WRITE
4736 sv_force_normal_flags(sv, 0);
4738 if (SvREADONLY(sv)) {
4740 /* its okay to attach magic to shared strings; the subsequent
4741 * upgrade to PVMG will unshare the string */
4742 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4745 && how != PERL_MAGIC_regex_global
4746 && how != PERL_MAGIC_bm
4747 && how != PERL_MAGIC_fm
4748 && how != PERL_MAGIC_sv
4749 && how != PERL_MAGIC_backref
4752 Perl_croak(aTHX_ PL_no_modify);
4755 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4756 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4757 /* sv_magic() refuses to add a magic of the same 'how' as an
4760 if (how == PERL_MAGIC_taint) {
4762 /* Any scalar which already had taint magic on which someone
4763 (erroneously?) did SvIOK_on() or similar will now be
4764 incorrectly sporting public "OK" flags. */
4765 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4773 vtable = &PL_vtbl_sv;
4775 case PERL_MAGIC_overload:
4776 vtable = &PL_vtbl_amagic;
4778 case PERL_MAGIC_overload_elem:
4779 vtable = &PL_vtbl_amagicelem;
4781 case PERL_MAGIC_overload_table:
4782 vtable = &PL_vtbl_ovrld;
4785 vtable = &PL_vtbl_bm;
4787 case PERL_MAGIC_regdata:
4788 vtable = &PL_vtbl_regdata;
4790 case PERL_MAGIC_regdatum:
4791 vtable = &PL_vtbl_regdatum;
4793 case PERL_MAGIC_env:
4794 vtable = &PL_vtbl_env;
4797 vtable = &PL_vtbl_fm;
4799 case PERL_MAGIC_envelem:
4800 vtable = &PL_vtbl_envelem;
4802 case PERL_MAGIC_regex_global:
4803 vtable = &PL_vtbl_mglob;
4805 case PERL_MAGIC_isa:
4806 vtable = &PL_vtbl_isa;
4808 case PERL_MAGIC_isaelem:
4809 vtable = &PL_vtbl_isaelem;
4811 case PERL_MAGIC_nkeys:
4812 vtable = &PL_vtbl_nkeys;
4814 case PERL_MAGIC_dbfile:
4817 case PERL_MAGIC_dbline:
4818 vtable = &PL_vtbl_dbline;
4820 #ifdef USE_LOCALE_COLLATE
4821 case PERL_MAGIC_collxfrm:
4822 vtable = &PL_vtbl_collxfrm;
4824 #endif /* USE_LOCALE_COLLATE */
4825 case PERL_MAGIC_tied:
4826 vtable = &PL_vtbl_pack;
4828 case PERL_MAGIC_tiedelem:
4829 case PERL_MAGIC_tiedscalar:
4830 vtable = &PL_vtbl_packelem;
4833 vtable = &PL_vtbl_regexp;
4835 case PERL_MAGIC_hints:
4836 /* As this vtable is all NULL, we can reuse it. */
4837 case PERL_MAGIC_sig:
4838 vtable = &PL_vtbl_sig;
4840 case PERL_MAGIC_sigelem:
4841 vtable = &PL_vtbl_sigelem;
4843 case PERL_MAGIC_taint:
4844 vtable = &PL_vtbl_taint;
4846 case PERL_MAGIC_uvar:
4847 vtable = &PL_vtbl_uvar;
4849 case PERL_MAGIC_vec:
4850 vtable = &PL_vtbl_vec;
4852 case PERL_MAGIC_arylen_p:
4853 case PERL_MAGIC_rhash:
4854 case PERL_MAGIC_symtab:
4855 case PERL_MAGIC_vstring:
4858 case PERL_MAGIC_utf8:
4859 vtable = &PL_vtbl_utf8;
4861 case PERL_MAGIC_substr:
4862 vtable = &PL_vtbl_substr;
4864 case PERL_MAGIC_defelem:
4865 vtable = &PL_vtbl_defelem;
4867 case PERL_MAGIC_arylen:
4868 vtable = &PL_vtbl_arylen;
4870 case PERL_MAGIC_pos:
4871 vtable = &PL_vtbl_pos;
4873 case PERL_MAGIC_backref:
4874 vtable = &PL_vtbl_backref;
4876 case PERL_MAGIC_hintselem:
4877 vtable = &PL_vtbl_hintselem;
4879 case PERL_MAGIC_ext:
4880 /* Reserved for use by extensions not perl internals. */
4881 /* Useful for attaching extension internal data to perl vars. */
4882 /* Note that multiple extensions may clash if magical scalars */
4883 /* etc holding private data from one are passed to another. */
4887 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4890 /* Rest of work is done else where */
4891 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4894 case PERL_MAGIC_taint:
4897 case PERL_MAGIC_ext:
4898 case PERL_MAGIC_dbfile:
4905 =for apidoc sv_unmagic
4907 Removes all magic of type C<type> from an SV.
4913 Perl_sv_unmagic(pTHX_ SV *const sv, const int type)
4918 PERL_ARGS_ASSERT_SV_UNMAGIC;
4920 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4922 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4923 for (mg = *mgp; mg; mg = *mgp) {
4924 if (mg->mg_type == type) {
4925 const MGVTBL* const vtbl = mg->mg_virtual;
4926 *mgp = mg->mg_moremagic;
4927 if (vtbl && vtbl->svt_free)
4928 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4929 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4931 Safefree(mg->mg_ptr);
4932 else if (mg->mg_len == HEf_SVKEY)
4933 SvREFCNT_dec((SV*)mg->mg_ptr);
4934 else if (mg->mg_type == PERL_MAGIC_utf8)
4935 Safefree(mg->mg_ptr);
4937 if (mg->mg_flags & MGf_REFCOUNTED)
4938 SvREFCNT_dec(mg->mg_obj);
4942 mgp = &mg->mg_moremagic;
4946 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4947 SvMAGIC_set(sv, NULL);
4954 =for apidoc sv_rvweaken
4956 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4957 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4958 push a back-reference to this RV onto the array of backreferences
4959 associated with that magic. If the RV is magical, set magic will be
4960 called after the RV is cleared.
4966 Perl_sv_rvweaken(pTHX_ SV *const sv)
4970 PERL_ARGS_ASSERT_SV_RVWEAKEN;
4972 if (!SvOK(sv)) /* let undefs pass */
4975 Perl_croak(aTHX_ "Can't weaken a nonreference");
4976 else if (SvWEAKREF(sv)) {
4977 if (ckWARN(WARN_MISC))
4978 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4982 Perl_sv_add_backref(aTHX_ tsv, sv);
4988 /* Give tsv backref magic if it hasn't already got it, then push a
4989 * back-reference to sv onto the array associated with the backref magic.
4993 Perl_sv_add_backref(pTHX_ SV *const tsv, SV *const sv)
4998 PERL_ARGS_ASSERT_SV_ADD_BACKREF;
5000 if (SvTYPE(tsv) == SVt_PVHV) {
5001 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5005 /* There is no AV in the offical place - try a fixup. */
5006 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
5009 /* Aha. They've got it stowed in magic. Bring it back. */
5010 av = (AV*)mg->mg_obj;
5011 /* Stop mg_free decreasing the refernce count. */
5013 /* Stop mg_free even calling the destructor, given that
5014 there's no AV to free up. */
5016 sv_unmagic(tsv, PERL_MAGIC_backref);
5020 SvREFCNT_inc_simple_void(av);
5025 const MAGIC *const mg
5026 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5028 av = (AV*)mg->mg_obj;
5032 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5033 /* av now has a refcnt of 2, which avoids it getting freed
5034 * before us during global cleanup. The extra ref is removed
5035 * by magic_killbackrefs() when tsv is being freed */
5038 if (AvFILLp(av) >= AvMAX(av)) {
5039 av_extend(av, AvFILLp(av)+1);
5041 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5044 /* delete a back-reference to ourselves from the backref magic associated
5045 * with the SV we point to.
5049 S_sv_del_backref(pTHX_ SV *const tsv, SV *const sv)
5056 PERL_ARGS_ASSERT_SV_DEL_BACKREF;
5058 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
5059 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
5060 /* We mustn't attempt to "fix up" the hash here by moving the
5061 backreference array back to the hv_aux structure, as that is stored
5062 in the main HvARRAY(), and hfreentries assumes that no-one
5063 reallocates HvARRAY() while it is running. */
5066 const MAGIC *const mg
5067 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
5069 av = (AV *)mg->mg_obj;
5072 if (PL_in_clean_all)
5074 Perl_croak(aTHX_ "panic: del_backref");
5081 /* We shouldn't be in here more than once, but for paranoia reasons lets
5083 for (i = AvFILLp(av); i >= 0; i--) {
5085 const SSize_t fill = AvFILLp(av);
5087 /* We weren't the last entry.
5088 An unordered list has this property that you can take the
5089 last element off the end to fill the hole, and it's still
5090 an unordered list :-)
5095 AvFILLp(av) = fill - 1;
5101 Perl_sv_kill_backrefs(pTHX_ SV *const sv, AV *const av)
5103 SV **svp = AvARRAY(av);
5105 PERL_ARGS_ASSERT_SV_KILL_BACKREFS;
5106 PERL_UNUSED_ARG(sv);
5108 /* Not sure why the av can get freed ahead of its sv, but somehow it does
5109 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
5110 if (svp && !SvIS_FREED(av)) {
5111 SV *const *const last = svp + AvFILLp(av);
5113 while (svp <= last) {
5115 SV *const referrer = *svp;
5116 if (SvWEAKREF(referrer)) {
5117 /* XXX Should we check that it hasn't changed? */
5118 SvRV_set(referrer, 0);
5120 SvWEAKREF_off(referrer);
5121 SvSETMAGIC(referrer);
5122 } else if (SvTYPE(referrer) == SVt_PVGV ||
5123 SvTYPE(referrer) == SVt_PVLV) {
5124 /* You lookin' at me? */
5125 assert(GvSTASH(referrer));
5126 assert(GvSTASH(referrer) == (HV*)sv);
5127 GvSTASH(referrer) = 0;
5130 "panic: magic_killbackrefs (flags=%"UVxf")",
5131 (UV)SvFLAGS(referrer));
5139 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
5144 =for apidoc sv_insert
5146 Inserts a string at the specified offset/length within the SV. Similar to
5147 the Perl substr() function. Handles get magic.
5149 =for apidoc sv_insert_flags
5151 Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
5157 Perl_sv_insert_flags(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
5162 register char *midend;
5163 register char *bigend;
5167 PERL_ARGS_ASSERT_SV_INSERT_FLAGS;
5170 Perl_croak(aTHX_ "Can't modify non-existent substring");
5171 SvPV_force_flags(bigstr, curlen, flags);
5172 (void)SvPOK_only_UTF8(bigstr);
5173 if (offset + len > curlen) {
5174 SvGROW(bigstr, offset+len+1);
5175 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5176 SvCUR_set(bigstr, offset+len);
5180 i = littlelen - len;
5181 if (i > 0) { /* string might grow */
5182 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5183 mid = big + offset + len;
5184 midend = bigend = big + SvCUR(bigstr);
5187 while (midend > mid) /* shove everything down */
5188 *--bigend = *--midend;
5189 Move(little,big+offset,littlelen,char);
5190 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5195 Move(little,SvPVX(bigstr)+offset,len,char);
5200 big = SvPVX(bigstr);
5203 bigend = big + SvCUR(bigstr);
5205 if (midend > bigend)
5206 Perl_croak(aTHX_ "panic: sv_insert");
5208 if (mid - big > bigend - midend) { /* faster to shorten from end */
5210 Move(little, mid, littlelen,char);
5213 i = bigend - midend;
5215 Move(midend, mid, i,char);
5219 SvCUR_set(bigstr, mid - big);
5221 else if ((i = mid - big)) { /* faster from front */
5222 midend -= littlelen;
5224 Move(big, midend - i, i, char);
5225 sv_chop(bigstr,midend-i);
5227 Move(little, mid, littlelen,char);
5229 else if (littlelen) {
5230 midend -= littlelen;
5231 sv_chop(bigstr,midend);
5232 Move(little,midend,littlelen,char);
5235 sv_chop(bigstr,midend);
5241 =for apidoc sv_replace
5243 Make the first argument a copy of the second, then delete the original.
5244 The target SV physically takes over ownership of the body of the source SV
5245 and inherits its flags; however, the target keeps any magic it owns,
5246 and any magic in the source is discarded.
5247 Note that this is a rather specialist SV copying operation; most of the
5248 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5254 Perl_sv_replace(pTHX_ register SV *const sv, register SV *const nsv)
5257 const U32 refcnt = SvREFCNT(sv);
5259 PERL_ARGS_ASSERT_SV_REPLACE;
5261 SV_CHECK_THINKFIRST_COW_DROP(sv);
5262 if (SvREFCNT(nsv) != 1) {
5263 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5264 UVuf " != 1)", (UV) SvREFCNT(nsv));
5266 if (SvMAGICAL(sv)) {
5270 sv_upgrade(nsv, SVt_PVMG);
5271 SvMAGIC_set(nsv, SvMAGIC(sv));
5272 SvFLAGS(nsv) |= SvMAGICAL(sv);
5274 SvMAGIC_set(sv, NULL);
5278 assert(!SvREFCNT(sv));
5279 #ifdef DEBUG_LEAKING_SCALARS
5280 sv->sv_flags = nsv->sv_flags;
5281 sv->sv_any = nsv->sv_any;
5282 sv->sv_refcnt = nsv->sv_refcnt;
5283 sv->sv_u = nsv->sv_u;
5285 StructCopy(nsv,sv,SV);
5287 if(SvTYPE(sv) == SVt_IV) {
5289 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5293 #ifdef PERL_OLD_COPY_ON_WRITE
5294 if (SvIsCOW_normal(nsv)) {
5295 /* We need to follow the pointers around the loop to make the
5296 previous SV point to sv, rather than nsv. */
5299 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5302 assert(SvPVX_const(current) == SvPVX_const(nsv));
5304 /* Make the SV before us point to the SV after us. */
5306 PerlIO_printf(Perl_debug_log, "previous is\n");
5308 PerlIO_printf(Perl_debug_log,
5309 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5310 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5312 SV_COW_NEXT_SV_SET(current, sv);
5315 SvREFCNT(sv) = refcnt;
5316 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5322 =for apidoc sv_clear
5324 Clear an SV: call any destructors, free up any memory used by the body,
5325 and free the body itself. The SV's head is I<not> freed, although
5326 its type is set to all 1's so that it won't inadvertently be assumed
5327 to be live during global destruction etc.
5328 This function should only be called when REFCNT is zero. Most of the time
5329 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5336 Perl_sv_clear(pTHX_ register SV *const sv)
5339 const U32 type = SvTYPE(sv);
5340 const struct body_details *const sv_type_details
5341 = bodies_by_type + type;
5344 PERL_ARGS_ASSERT_SV_CLEAR;
5345 assert(SvREFCNT(sv) == 0);
5346 assert(SvTYPE(sv) != SVTYPEMASK);
5348 if (type <= SVt_IV) {
5349 /* See the comment in sv.h about the collusion between this early
5350 return and the overloading of the NULL and IV slots in the size
5353 SV * const target = SvRV(sv);
5355 sv_del_backref(target, sv);
5357 SvREFCNT_dec(target);
5359 SvFLAGS(sv) &= SVf_BREAK;
5360 SvFLAGS(sv) |= SVTYPEMASK;
5365 if (PL_defstash && /* Still have a symbol table? */
5372 stash = SvSTASH(sv);
5373 destructor = StashHANDLER(stash,DESTROY);
5375 SV* const tmpref = newRV(sv);
5376 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5378 PUSHSTACKi(PERLSI_DESTROY);
5383 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5389 if(SvREFCNT(tmpref) < 2) {
5390 /* tmpref is not kept alive! */
5392 SvRV_set(tmpref, NULL);
5395 SvREFCNT_dec(tmpref);
5397 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5401 if (PL_in_clean_objs)
5402 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5404 /* DESTROY gave object new lease on life */
5410 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5411 SvOBJECT_off(sv); /* Curse the object. */
5412 if (type != SVt_PVIO)
5413 --PL_sv_objcount; /* XXX Might want something more general */
5416 if (type >= SVt_PVMG) {
5417 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5418 SvREFCNT_dec(SvOURSTASH(sv));
5419 } else if (SvMAGIC(sv))
5421 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5422 SvREFCNT_dec(SvSTASH(sv));
5425 /* case SVt_BIND: */
5428 IoIFP(sv) != PerlIO_stdin() &&
5429 IoIFP(sv) != PerlIO_stdout() &&
5430 IoIFP(sv) != PerlIO_stderr())
5432 io_close((IO*)sv, FALSE);
5434 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5435 PerlDir_close(IoDIRP(sv));
5436 IoDIRP(sv) = (DIR*)NULL;
5437 Safefree(IoTOP_NAME(sv));
5438 Safefree(IoFMT_NAME(sv));
5439 Safefree(IoBOTTOM_NAME(sv));
5442 /* FIXME for plugins */
5443 pregfree2((REGEXP*) sv);
5450 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5454 if (PL_comppad == (AV*)sv) {
5461 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5462 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5463 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5464 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5466 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5467 SvREFCNT_dec(LvTARG(sv));
5469 if (isGV_with_GP(sv)) {
5470 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5471 mro_method_changed_in(stash);
5474 unshare_hek(GvNAME_HEK(sv));
5475 /* If we're in a stash, we don't own a reference to it. However it does
5476 have a back reference to us, which needs to be cleared. */
5477 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5478 sv_del_backref((SV*)stash, sv);
5480 /* FIXME. There are probably more unreferenced pointers to SVs in the
5481 interpreter struct that we should check and tidy in a similar
5483 if ((GV*)sv == PL_last_in_gv)
5484 PL_last_in_gv = NULL;
5490 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5493 SvOOK_offset(sv, offset);
5494 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5495 /* Don't even bother with turning off the OOK flag. */
5498 SV * const target = SvRV(sv);
5500 sv_del_backref(target, sv);
5502 SvREFCNT_dec(target);
5504 #ifdef PERL_OLD_COPY_ON_WRITE
5505 else if (SvPVX_const(sv)) {
5507 /* I believe I need to grab the global SV mutex here and
5508 then recheck the COW status. */
5510 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5514 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5516 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5519 /* And drop it here. */
5521 } else if (SvLEN(sv)) {
5522 Safefree(SvPVX_const(sv));
5526 else if (SvPVX_const(sv) && SvLEN(sv))
5527 Safefree(SvPVX_mutable(sv));
5528 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5529 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5538 SvFLAGS(sv) &= SVf_BREAK;
5539 SvFLAGS(sv) |= SVTYPEMASK;
5541 if (sv_type_details->arena) {
5542 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5543 &PL_body_roots[type]);
5545 else if (sv_type_details->body_size) {
5546 my_safefree(SvANY(sv));
5551 =for apidoc sv_newref
5553 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5560 Perl_sv_newref(pTHX_ SV *const sv)
5562 PERL_UNUSED_CONTEXT;
5571 Decrement an SV's reference count, and if it drops to zero, call
5572 C<sv_clear> to invoke destructors and free up any memory used by
5573 the body; finally, deallocate the SV's head itself.
5574 Normally called via a wrapper macro C<SvREFCNT_dec>.
5580 Perl_sv_free(pTHX_ SV *const sv)
5585 if (SvREFCNT(sv) == 0) {
5586 if (SvFLAGS(sv) & SVf_BREAK)
5587 /* this SV's refcnt has been artificially decremented to
5588 * trigger cleanup */
5590 if (PL_in_clean_all) /* All is fair */
5592 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5593 /* make sure SvREFCNT(sv)==0 happens very seldom */
5594 SvREFCNT(sv) = (~(U32)0)/2;
5597 if (ckWARN_d(WARN_INTERNAL)) {
5598 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5599 Perl_dump_sv_child(aTHX_ sv);
5601 #ifdef DEBUG_LEAKING_SCALARS
5604 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5605 if (PL_warnhook == PERL_WARNHOOK_FATAL
5606 || ckDEAD(packWARN(WARN_INTERNAL))) {
5607 /* Don't let Perl_warner cause us to escape our fate: */
5611 /* This may not return: */
5612 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5613 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5614 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5617 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5622 if (--(SvREFCNT(sv)) > 0)
5624 Perl_sv_free2(aTHX_ sv);
5628 Perl_sv_free2(pTHX_ SV *const sv)
5632 PERL_ARGS_ASSERT_SV_FREE2;
5636 if (ckWARN_d(WARN_DEBUGGING))
5637 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5638 "Attempt to free temp prematurely: SV 0x%"UVxf
5639 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5643 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5644 /* make sure SvREFCNT(sv)==0 happens very seldom */
5645 SvREFCNT(sv) = (~(U32)0)/2;
5656 Returns the length of the string in the SV. Handles magic and type
5657 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5663 Perl_sv_len(pTHX_ register SV *const sv)
5671 len = mg_length(sv);
5673 (void)SvPV_const(sv, len);
5678 =for apidoc sv_len_utf8
5680 Returns the number of characters in the string in an SV, counting wide
5681 UTF-8 bytes as a single character. Handles magic and type coercion.
5687 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5688 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5689 * (Note that the mg_len is not the length of the mg_ptr field.
5690 * This allows the cache to store the character length of the string without
5691 * needing to malloc() extra storage to attach to the mg_ptr.)
5696 Perl_sv_len_utf8(pTHX_ register SV *const sv)
5702 return mg_length(sv);
5706 const U8 *s = (U8*)SvPV_const(sv, len);
5710 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5712 if (mg && mg->mg_len != -1) {
5714 if (PL_utf8cache < 0) {
5715 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5717 /* Need to turn the assertions off otherwise we may
5718 recurse infinitely while printing error messages.
5720 SAVEI8(PL_utf8cache);
5722 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5723 " real %"UVuf" for %"SVf,
5724 (UV) ulen, (UV) real, SVfARG(sv));
5729 ulen = Perl_utf8_length(aTHX_ s, s + len);
5730 if (!SvREADONLY(sv)) {
5732 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5733 &PL_vtbl_utf8, 0, 0);
5741 return Perl_utf8_length(aTHX_ s, s + len);
5745 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5748 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5751 const U8 *s = start;
5753 PERL_ARGS_ASSERT_SV_POS_U2B_FORWARDS;
5755 while (s < send && uoffset--)
5758 /* This is the existing behaviour. Possibly it should be a croak, as
5759 it's actually a bounds error */
5765 /* Given the length of the string in both bytes and UTF-8 characters, decide
5766 whether to walk forwards or backwards to find the byte corresponding to
5767 the passed in UTF-8 offset. */
5769 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5770 const STRLEN uoffset, const STRLEN uend)
5772 STRLEN backw = uend - uoffset;
5774 PERL_ARGS_ASSERT_SV_POS_U2B_MIDWAY;
5776 if (uoffset < 2 * backw) {
5777 /* The assumption is that going forwards is twice the speed of going
5778 forward (that's where the 2 * backw comes from).
5779 (The real figure of course depends on the UTF-8 data.) */
5780 return sv_pos_u2b_forwards(start, send, uoffset);
5785 while (UTF8_IS_CONTINUATION(*send))
5788 return send - start;
5791 /* For the string representation of the given scalar, find the byte
5792 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5793 give another position in the string, *before* the sought offset, which
5794 (which is always true, as 0, 0 is a valid pair of positions), which should
5795 help reduce the amount of linear searching.
5796 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5797 will be used to reduce the amount of linear searching. The cache will be
5798 created if necessary, and the found value offered to it for update. */
5800 S_sv_pos_u2b_cached(pTHX_ SV *const sv, MAGIC **const mgp, const U8 *const start,
5801 const U8 *const send, const STRLEN uoffset,
5802 STRLEN uoffset0, STRLEN boffset0)
5804 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5807 PERL_ARGS_ASSERT_SV_POS_U2B_CACHED;
5809 assert (uoffset >= uoffset0);
5811 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5812 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5813 if ((*mgp)->mg_ptr) {
5814 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5815 if (cache[0] == uoffset) {
5816 /* An exact match. */
5819 if (cache[2] == uoffset) {
5820 /* An exact match. */
5824 if (cache[0] < uoffset) {
5825 /* The cache already knows part of the way. */
5826 if (cache[0] > uoffset0) {
5827 /* The cache knows more than the passed in pair */
5828 uoffset0 = cache[0];
5829 boffset0 = cache[1];
5831 if ((*mgp)->mg_len != -1) {
5832 /* And we know the end too. */
5834 + sv_pos_u2b_midway(start + boffset0, send,
5836 (*mgp)->mg_len - uoffset0);
5839 + sv_pos_u2b_forwards(start + boffset0,
5840 send, uoffset - uoffset0);
5843 else if (cache[2] < uoffset) {
5844 /* We're between the two cache entries. */
5845 if (cache[2] > uoffset0) {
5846 /* and the cache knows more than the passed in pair */
5847 uoffset0 = cache[2];
5848 boffset0 = cache[3];
5852 + sv_pos_u2b_midway(start + boffset0,
5855 cache[0] - uoffset0);
5858 + sv_pos_u2b_midway(start + boffset0,
5861 cache[2] - uoffset0);
5865 else if ((*mgp)->mg_len != -1) {
5866 /* If we can take advantage of a passed in offset, do so. */
5867 /* In fact, offset0 is either 0, or less than offset, so don't
5868 need to worry about the other possibility. */
5870 + sv_pos_u2b_midway(start + boffset0, send,
5872 (*mgp)->mg_len - uoffset0);
5877 if (!found || PL_utf8cache < 0) {
5878 const STRLEN real_boffset
5879 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5880 send, uoffset - uoffset0);
5882 if (found && PL_utf8cache < 0) {
5883 if (real_boffset != boffset) {
5884 /* Need to turn the assertions off otherwise we may recurse
5885 infinitely while printing error messages. */
5886 SAVEI8(PL_utf8cache);
5888 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5889 " real %"UVuf" for %"SVf,
5890 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5893 boffset = real_boffset;
5897 utf8_mg_pos_cache_update(sv, mgp, boffset, uoffset, send - start);
5903 =for apidoc sv_pos_u2b
5905 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5906 the start of the string, to a count of the equivalent number of bytes; if
5907 lenp is non-zero, it does the same to lenp, but this time starting from
5908 the offset, rather than from the start of the string. Handles magic and
5915 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5916 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5917 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5922 Perl_sv_pos_u2b(pTHX_ register SV *const sv, I32 *const offsetp, I32 *const lenp)
5927 PERL_ARGS_ASSERT_SV_POS_U2B;
5932 start = (U8*)SvPV_const(sv, len);
5934 STRLEN uoffset = (STRLEN) *offsetp;
5935 const U8 * const send = start + len;
5937 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5940 *offsetp = (I32) boffset;
5943 /* Convert the relative offset to absolute. */
5944 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5945 const STRLEN boffset2
5946 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5947 uoffset, boffset) - boffset;
5961 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5962 byte length pairing. The (byte) length of the total SV is passed in too,
5963 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5964 may not have updated SvCUR, so we can't rely on reading it directly.
5966 The proffered utf8/byte length pairing isn't used if the cache already has
5967 two pairs, and swapping either for the proffered pair would increase the
5968 RMS of the intervals between known byte offsets.
5970 The cache itself consists of 4 STRLEN values
5971 0: larger UTF-8 offset
5972 1: corresponding byte offset
5973 2: smaller UTF-8 offset
5974 3: corresponding byte offset
5976 Unused cache pairs have the value 0, 0.
5977 Keeping the cache "backwards" means that the invariant of
5978 cache[0] >= cache[2] is maintained even with empty slots, which means that
5979 the code that uses it doesn't need to worry if only 1 entry has actually
5980 been set to non-zero. It also makes the "position beyond the end of the
5981 cache" logic much simpler, as the first slot is always the one to start
5985 S_utf8_mg_pos_cache_update(pTHX_ SV *const sv, MAGIC **const mgp, const STRLEN byte,
5986 const STRLEN utf8, const STRLEN blen)
5990 PERL_ARGS_ASSERT_UTF8_MG_POS_CACHE_UPDATE;
5996 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5998 (*mgp)->mg_len = -1;
6002 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
6003 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6004 (*mgp)->mg_ptr = (char *) cache;
6008 if (PL_utf8cache < 0) {
6009 const U8 *start = (const U8 *) SvPVX_const(sv);
6010 const STRLEN realutf8 = utf8_length(start, start + byte);
6012 if (realutf8 != utf8) {
6013 /* Need to turn the assertions off otherwise we may recurse
6014 infinitely while printing error messages. */
6015 SAVEI8(PL_utf8cache);
6017 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
6018 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
6022 /* Cache is held with the later position first, to simplify the code
6023 that deals with unbounded ends. */
6025 ASSERT_UTF8_CACHE(cache);
6026 if (cache[1] == 0) {
6027 /* Cache is totally empty */
6030 } else if (cache[3] == 0) {
6031 if (byte > cache[1]) {
6032 /* New one is larger, so goes first. */
6033 cache[2] = cache[0];
6034 cache[3] = cache[1];
6042 #define THREEWAY_SQUARE(a,b,c,d) \
6043 ((float)((d) - (c))) * ((float)((d) - (c))) \
6044 + ((float)((c) - (b))) * ((float)((c) - (b))) \
6045 + ((float)((b) - (a))) * ((float)((b) - (a)))
6047 /* Cache has 2 slots in use, and we know three potential pairs.
6048 Keep the two that give the lowest RMS distance. Do the
6049 calcualation in bytes simply because we always know the byte
6050 length. squareroot has the same ordering as the positive value,
6051 so don't bother with the actual square root. */
6052 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
6053 if (byte > cache[1]) {
6054 /* New position is after the existing pair of pairs. */
6055 const float keep_earlier
6056 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6057 const float keep_later
6058 = THREEWAY_SQUARE(0, cache[1], byte, blen);
6060 if (keep_later < keep_earlier) {
6061 if (keep_later < existing) {
6062 cache[2] = cache[0];
6063 cache[3] = cache[1];
6069 if (keep_earlier < existing) {
6075 else if (byte > cache[3]) {
6076 /* New position is between the existing pair of pairs. */
6077 const float keep_earlier
6078 = THREEWAY_SQUARE(0, cache[3], byte, blen);
6079 const float keep_later
6080 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6082 if (keep_later < keep_earlier) {
6083 if (keep_later < existing) {
6089 if (keep_earlier < existing) {
6096 /* New position is before the existing pair of pairs. */
6097 const float keep_earlier
6098 = THREEWAY_SQUARE(0, byte, cache[3], blen);
6099 const float keep_later
6100 = THREEWAY_SQUARE(0, byte, cache[1], blen);
6102 if (keep_later < keep_earlier) {
6103 if (keep_later < existing) {
6109 if (keep_earlier < existing) {
6110 cache[0] = cache[2];
6111 cache[1] = cache[3];
6118 ASSERT_UTF8_CACHE(cache);
6121 /* We already know all of the way, now we may be able to walk back. The same
6122 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
6123 backward is half the speed of walking forward. */
6125 S_sv_pos_b2u_midway(pTHX_ const U8 *const s, const U8 *const target,
6126 const U8 *end, STRLEN endu)
6128 const STRLEN forw = target - s;
6129 STRLEN backw = end - target;
6131 PERL_ARGS_ASSERT_SV_POS_B2U_MIDWAY;
6133 if (forw < 2 * backw) {
6134 return utf8_length(s, target);
6137 while (end > target) {
6139 while (UTF8_IS_CONTINUATION(*end)) {
6148 =for apidoc sv_pos_b2u
6150 Converts the value pointed to by offsetp from a count of bytes from the
6151 start of the string, to a count of the equivalent number of UTF-8 chars.
6152 Handles magic and type coercion.
6158 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6159 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6164 Perl_sv_pos_b2u(pTHX_ register SV *const sv, I32 *const offsetp)
6167 const STRLEN byte = *offsetp;
6168 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
6174 PERL_ARGS_ASSERT_SV_POS_B2U;
6179 s = (const U8*)SvPV_const(sv, blen);
6182 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6186 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6187 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6189 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6190 if (cache[1] == byte) {
6191 /* An exact match. */
6192 *offsetp = cache[0];
6195 if (cache[3] == byte) {
6196 /* An exact match. */
6197 *offsetp = cache[2];
6201 if (cache[1] < byte) {
6202 /* We already know part of the way. */
6203 if (mg->mg_len != -1) {
6204 /* Actually, we know the end too. */
6206 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6207 s + blen, mg->mg_len - cache[0]);
6209 len = cache[0] + utf8_length(s + cache[1], send);
6212 else if (cache[3] < byte) {
6213 /* We're between the two cached pairs, so we do the calculation
6214 offset by the byte/utf-8 positions for the earlier pair,
6215 then add the utf-8 characters from the string start to
6217 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6218 s + cache[1], cache[0] - cache[2])
6222 else { /* cache[3] > byte */
6223 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6227 ASSERT_UTF8_CACHE(cache);
6229 } else if (mg->mg_len != -1) {
6230 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6234 if (!found || PL_utf8cache < 0) {
6235 const STRLEN real_len = utf8_length(s, send);
6237 if (found && PL_utf8cache < 0) {
6238 if (len != real_len) {
6239 /* Need to turn the assertions off otherwise we may recurse
6240 infinitely while printing error messages. */
6241 SAVEI8(PL_utf8cache);
6243 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6244 " real %"UVuf" for %"SVf,
6245 (UV) len, (UV) real_len, SVfARG(sv));
6253 utf8_mg_pos_cache_update(sv, &mg, byte, len, blen);
6259 Returns a boolean indicating whether the strings in the two SVs are
6260 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6261 coerce its args to strings if necessary.
6267 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6276 SV* svrecode = NULL;
6283 /* if pv1 and pv2 are the same, second SvPV_const call may
6284 * invalidate pv1, so we may need to make a copy */
6285 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6286 pv1 = SvPV_const(sv1, cur1);
6287 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6289 pv1 = SvPV_const(sv1, cur1);
6297 pv2 = SvPV_const(sv2, cur2);
6299 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6300 /* Differing utf8ness.
6301 * Do not UTF8size the comparands as a side-effect. */
6304 svrecode = newSVpvn(pv2, cur2);
6305 sv_recode_to_utf8(svrecode, PL_encoding);
6306 pv2 = SvPV_const(svrecode, cur2);
6309 svrecode = newSVpvn(pv1, cur1);
6310 sv_recode_to_utf8(svrecode, PL_encoding);
6311 pv1 = SvPV_const(svrecode, cur1);
6313 /* Now both are in UTF-8. */
6315 SvREFCNT_dec(svrecode);
6320 bool is_utf8 = TRUE;
6323 /* sv1 is the UTF-8 one,
6324 * if is equal it must be downgrade-able */
6325 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6331 /* sv2 is the UTF-8 one,
6332 * if is equal it must be downgrade-able */
6333 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6339 /* Downgrade not possible - cannot be eq */
6347 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6349 SvREFCNT_dec(svrecode);
6359 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6360 string in C<sv1> is less than, equal to, or greater than the string in
6361 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6362 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6368 Perl_sv_cmp(pTHX_ register SV *const sv1, register SV *const sv2)
6372 const char *pv1, *pv2;
6375 SV *svrecode = NULL;
6382 pv1 = SvPV_const(sv1, cur1);
6389 pv2 = SvPV_const(sv2, cur2);
6391 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6392 /* Differing utf8ness.
6393 * Do not UTF8size the comparands as a side-effect. */
6396 svrecode = newSVpvn(pv2, cur2);
6397 sv_recode_to_utf8(svrecode, PL_encoding);
6398 pv2 = SvPV_const(svrecode, cur2);
6401 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6406 svrecode = newSVpvn(pv1, cur1);
6407 sv_recode_to_utf8(svrecode, PL_encoding);
6408 pv1 = SvPV_const(svrecode, cur1);
6411 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6417 cmp = cur2 ? -1 : 0;
6421 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6424 cmp = retval < 0 ? -1 : 1;
6425 } else if (cur1 == cur2) {
6428 cmp = cur1 < cur2 ? -1 : 1;
6432 SvREFCNT_dec(svrecode);
6440 =for apidoc sv_cmp_locale
6442 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6443 'use bytes' aware, handles get magic, and will coerce its args to strings
6444 if necessary. See also C<sv_cmp>.
6450 Perl_sv_cmp_locale(pTHX_ register SV *const sv1, register SV *const sv2)
6453 #ifdef USE_LOCALE_COLLATE
6459 if (PL_collation_standard)
6463 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6465 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6467 if (!pv1 || !len1) {
6478 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6481 return retval < 0 ? -1 : 1;
6484 * When the result of collation is equality, that doesn't mean
6485 * that there are no differences -- some locales exclude some
6486 * characters from consideration. So to avoid false equalities,
6487 * we use the raw string as a tiebreaker.
6493 #endif /* USE_LOCALE_COLLATE */
6495 return sv_cmp(sv1, sv2);
6499 #ifdef USE_LOCALE_COLLATE
6502 =for apidoc sv_collxfrm
6504 Add Collate Transform magic to an SV if it doesn't already have it.
6506 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6507 scalar data of the variable, but transformed to such a format that a normal
6508 memory comparison can be used to compare the data according to the locale
6515 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
6520 PERL_ARGS_ASSERT_SV_COLLXFRM;
6522 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6523 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6529 Safefree(mg->mg_ptr);
6530 s = SvPV_const(sv, len);
6531 if ((xf = mem_collxfrm(s, len, &xlen))) {
6533 #ifdef PERL_OLD_COPY_ON_WRITE
6535 sv_force_normal_flags(sv, 0);
6537 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6551 if (mg && mg->mg_ptr) {
6553 return mg->mg_ptr + sizeof(PL_collation_ix);
6561 #endif /* USE_LOCALE_COLLATE */
6566 Get a line from the filehandle and store it into the SV, optionally
6567 appending to the currently-stored string.
6573 Perl_sv_gets(pTHX_ register SV *const sv, register PerlIO *const fp, I32 append)
6578 register STDCHAR rslast;
6579 register STDCHAR *bp;
6584 PERL_ARGS_ASSERT_SV_GETS;
6586 if (SvTHINKFIRST(sv))
6587 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6588 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6590 However, perlbench says it's slower, because the existing swipe code
6591 is faster than copy on write.
6592 Swings and roundabouts. */
6593 SvUPGRADE(sv, SVt_PV);
6598 if (PerlIO_isutf8(fp)) {
6600 sv_utf8_upgrade_nomg(sv);
6601 sv_pos_u2b(sv,&append,0);
6603 } else if (SvUTF8(sv)) {
6604 SV * const tsv = newSV(0);
6605 sv_gets(tsv, fp, 0);
6606 sv_utf8_upgrade_nomg(tsv);
6607 SvCUR_set(sv,append);
6610 goto return_string_or_null;
6615 if (PerlIO_isutf8(fp))
6618 if (IN_PERL_COMPILETIME) {
6619 /* we always read code in line mode */
6623 else if (RsSNARF(PL_rs)) {
6624 /* If it is a regular disk file use size from stat() as estimate
6625 of amount we are going to read -- may result in mallocing
6626 more memory than we really need if the layers below reduce
6627 the size we read (e.g. CRLF or a gzip layer).
6630 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6631 const Off_t offset = PerlIO_tell(fp);
6632 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6633 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6639 else if (RsRECORD(PL_rs)) {
6647 /* Grab the size of the record we're getting */
6648 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6649 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6652 /* VMS wants read instead of fread, because fread doesn't respect */
6653 /* RMS record boundaries. This is not necessarily a good thing to be */
6654 /* doing, but we've got no other real choice - except avoid stdio
6655 as implementation - perhaps write a :vms layer ?
6657 fd = PerlIO_fileno(fp);
6658 if (fd == -1) { /* in-memory file from PerlIO::Scalar */
6659 bytesread = PerlIO_read(fp, buffer, recsize);
6662 bytesread = PerlLIO_read(fd, buffer, recsize);
6665 bytesread = PerlIO_read(fp, buffer, recsize);
6669 SvCUR_set(sv, bytesread += append);
6670 buffer[bytesread] = '\0';
6671 goto return_string_or_null;
6673 else if (RsPARA(PL_rs)) {
6679 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6680 if (PerlIO_isutf8(fp)) {
6681 rsptr = SvPVutf8(PL_rs, rslen);
6684 if (SvUTF8(PL_rs)) {
6685 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6686 Perl_croak(aTHX_ "Wide character in $/");
6689 rsptr = SvPV_const(PL_rs, rslen);
6693 rslast = rslen ? rsptr[rslen - 1] : '\0';
6695 if (rspara) { /* have to do this both before and after */
6696 do { /* to make sure file boundaries work right */
6699 i = PerlIO_getc(fp);
6703 PerlIO_ungetc(fp,i);
6709 /* See if we know enough about I/O mechanism to cheat it ! */
6711 /* This used to be #ifdef test - it is made run-time test for ease
6712 of abstracting out stdio interface. One call should be cheap
6713 enough here - and may even be a macro allowing compile
6717 if (PerlIO_fast_gets(fp)) {
6720 * We're going to steal some values from the stdio struct
6721 * and put EVERYTHING in the innermost loop into registers.
6723 register STDCHAR *ptr;
6727 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6728 /* An ungetc()d char is handled separately from the regular
6729 * buffer, so we getc() it back out and stuff it in the buffer.
6731 i = PerlIO_getc(fp);
6732 if (i == EOF) return 0;
6733 *(--((*fp)->_ptr)) = (unsigned char) i;
6737 /* Here is some breathtakingly efficient cheating */
6739 cnt = PerlIO_get_cnt(fp); /* get count into register */
6740 /* make sure we have the room */
6741 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6742 /* Not room for all of it
6743 if we are looking for a separator and room for some
6745 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6746 /* just process what we have room for */
6747 shortbuffered = cnt - SvLEN(sv) + append + 1;
6748 cnt -= shortbuffered;
6752 /* remember that cnt can be negative */
6753 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6758 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6759 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6760 DEBUG_P(PerlIO_printf(Perl_debug_log,
6761 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6762 DEBUG_P(PerlIO_printf(Perl_debug_log,
6763 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6764 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6765 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6770 while (cnt > 0) { /* this | eat */
6772 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6773 goto thats_all_folks; /* screams | sed :-) */
6777 Copy(ptr, bp, cnt, char); /* this | eat */
6778 bp += cnt; /* screams | dust */
6779 ptr += cnt; /* louder | sed :-) */
6784 if (shortbuffered) { /* oh well, must extend */
6785 cnt = shortbuffered;
6787 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6789 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6790 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6794 DEBUG_P(PerlIO_printf(Perl_debug_log,
6795 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6796 PTR2UV(ptr),(long)cnt));
6797 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6799 DEBUG_P(PerlIO_printf(Perl_debug_log,
6800 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6801 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6802 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6804 /* This used to call 'filbuf' in stdio form, but as that behaves like
6805 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6806 another abstraction. */
6807 i = PerlIO_getc(fp); /* get more characters */
6809 DEBUG_P(PerlIO_printf(Perl_debug_log,
6810 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6811 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6812 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6814 cnt = PerlIO_get_cnt(fp);
6815 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6816 DEBUG_P(PerlIO_printf(Perl_debug_log,
6817 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6819 if (i == EOF) /* all done for ever? */
6820 goto thats_really_all_folks;
6822 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6824 SvGROW(sv, bpx + cnt + 2);
6825 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6827 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6829 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6830 goto thats_all_folks;
6834 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6835 memNE((char*)bp - rslen, rsptr, rslen))
6836 goto screamer; /* go back to the fray */
6837 thats_really_all_folks:
6839 cnt += shortbuffered;
6840 DEBUG_P(PerlIO_printf(Perl_debug_log,
6841 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6842 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6843 DEBUG_P(PerlIO_printf(Perl_debug_log,
6844 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6845 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6846 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6848 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6849 DEBUG_P(PerlIO_printf(Perl_debug_log,
6850 "Screamer: done, len=%ld, string=|%.*s|\n",
6851 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6855 /*The big, slow, and stupid way. */
6856 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6857 STDCHAR *buf = NULL;
6858 Newx(buf, 8192, STDCHAR);
6866 register const STDCHAR * const bpe = buf + sizeof(buf);
6868 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6869 ; /* keep reading */
6873 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6874 /* Accomodate broken VAXC compiler, which applies U8 cast to
6875 * both args of ?: operator, causing EOF to change into 255
6878 i = (U8)buf[cnt - 1];
6884 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6886 sv_catpvn(sv, (char *) buf, cnt);
6888 sv_setpvn(sv, (char *) buf, cnt);
6890 if (i != EOF && /* joy */
6892 SvCUR(sv) < rslen ||
6893 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6897 * If we're reading from a TTY and we get a short read,
6898 * indicating that the user hit his EOF character, we need
6899 * to notice it now, because if we try to read from the TTY
6900 * again, the EOF condition will disappear.
6902 * The comparison of cnt to sizeof(buf) is an optimization
6903 * that prevents unnecessary calls to feof().
6907 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6911 #ifdef USE_HEAP_INSTEAD_OF_STACK
6916 if (rspara) { /* have to do this both before and after */
6917 while (i != EOF) { /* to make sure file boundaries work right */
6918 i = PerlIO_getc(fp);
6920 PerlIO_ungetc(fp,i);
6926 return_string_or_null:
6927 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6933 Auto-increment of the value in the SV, doing string to numeric conversion
6934 if necessary. Handles 'get' magic.
6940 Perl_sv_inc(pTHX_ register SV *const sv)
6949 if (SvTHINKFIRST(sv)) {
6951 sv_force_normal_flags(sv, 0);
6952 if (SvREADONLY(sv)) {
6953 if (IN_PERL_RUNTIME)
6954 Perl_croak(aTHX_ PL_no_modify);
6958 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6960 i = PTR2IV(SvRV(sv));
6965 flags = SvFLAGS(sv);
6966 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6967 /* It's (privately or publicly) a float, but not tested as an
6968 integer, so test it to see. */
6970 flags = SvFLAGS(sv);
6972 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6973 /* It's publicly an integer, or privately an integer-not-float */
6974 #ifdef PERL_PRESERVE_IVUV
6978 if (SvUVX(sv) == UV_MAX)
6979 sv_setnv(sv, UV_MAX_P1);
6981 (void)SvIOK_only_UV(sv);
6982 SvUV_set(sv, SvUVX(sv) + 1);
6984 if (SvIVX(sv) == IV_MAX)
6985 sv_setuv(sv, (UV)IV_MAX + 1);
6987 (void)SvIOK_only(sv);
6988 SvIV_set(sv, SvIVX(sv) + 1);
6993 if (flags & SVp_NOK) {
6994 const NV was = SvNVX(sv);
6995 if (NV_OVERFLOWS_INTEGERS_AT &&
6996 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6997 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6998 "Lost precision when incrementing %" NVff " by 1",
7001 (void)SvNOK_only(sv);
7002 SvNV_set(sv, was + 1.0);
7006 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
7007 if ((flags & SVTYPEMASK) < SVt_PVIV)
7008 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
7009 (void)SvIOK_only(sv);
7014 while (isALPHA(*d)) d++;
7015 while (isDIGIT(*d)) d++;
7017 #ifdef PERL_PRESERVE_IVUV
7018 /* Got to punt this as an integer if needs be, but we don't issue
7019 warnings. Probably ought to make the sv_iv_please() that does
7020 the conversion if possible, and silently. */
7021 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7022 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7023 /* Need to try really hard to see if it's an integer.
7024 9.22337203685478e+18 is an integer.
7025 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7026 so $a="9.22337203685478e+18"; $a+0; $a++
7027 needs to be the same as $a="9.22337203685478e+18"; $a++
7034 /* sv_2iv *should* have made this an NV */
7035 if (flags & SVp_NOK) {
7036 (void)SvNOK_only(sv);
7037 SvNV_set(sv, SvNVX(sv) + 1.0);
7040 /* I don't think we can get here. Maybe I should assert this
7041 And if we do get here I suspect that sv_setnv will croak. NWC
7043 #if defined(USE_LONG_DOUBLE)
7044 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",
7045 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7047 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7048 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7051 #endif /* PERL_PRESERVE_IVUV */
7052 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
7056 while (d >= SvPVX_const(sv)) {
7064 /* MKS: The original code here died if letters weren't consecutive.
7065 * at least it didn't have to worry about non-C locales. The
7066 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7067 * arranged in order (although not consecutively) and that only
7068 * [A-Za-z] are accepted by isALPHA in the C locale.
7070 if (*d != 'z' && *d != 'Z') {
7071 do { ++*d; } while (!isALPHA(*d));
7074 *(d--) -= 'z' - 'a';
7079 *(d--) -= 'z' - 'a' + 1;
7083 /* oh,oh, the number grew */
7084 SvGROW(sv, SvCUR(sv) + 2);
7085 SvCUR_set(sv, SvCUR(sv) + 1);
7086 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
7097 Auto-decrement of the value in the SV, doing string to numeric conversion
7098 if necessary. Handles 'get' magic.
7104 Perl_sv_dec(pTHX_ register SV *const sv)
7112 if (SvTHINKFIRST(sv)) {
7114 sv_force_normal_flags(sv, 0);
7115 if (SvREADONLY(sv)) {
7116 if (IN_PERL_RUNTIME)
7117 Perl_croak(aTHX_ PL_no_modify);
7121 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7123 i = PTR2IV(SvRV(sv));
7128 /* Unlike sv_inc we don't have to worry about string-never-numbers
7129 and keeping them magic. But we mustn't warn on punting */
7130 flags = SvFLAGS(sv);
7131 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7132 /* It's publicly an integer, or privately an integer-not-float */
7133 #ifdef PERL_PRESERVE_IVUV
7137 if (SvUVX(sv) == 0) {
7138 (void)SvIOK_only(sv);
7142 (void)SvIOK_only_UV(sv);
7143 SvUV_set(sv, SvUVX(sv) - 1);
7146 if (SvIVX(sv) == IV_MIN) {
7147 sv_setnv(sv, (NV)IV_MIN);
7151 (void)SvIOK_only(sv);
7152 SvIV_set(sv, SvIVX(sv) - 1);
7157 if (flags & SVp_NOK) {
7160 const NV was = SvNVX(sv);
7161 if (NV_OVERFLOWS_INTEGERS_AT &&
7162 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
7163 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
7164 "Lost precision when decrementing %" NVff " by 1",
7167 (void)SvNOK_only(sv);
7168 SvNV_set(sv, was - 1.0);
7172 if (!(flags & SVp_POK)) {
7173 if ((flags & SVTYPEMASK) < SVt_PVIV)
7174 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
7176 (void)SvIOK_only(sv);
7179 #ifdef PERL_PRESERVE_IVUV
7181 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
7182 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7183 /* Need to try really hard to see if it's an integer.
7184 9.22337203685478e+18 is an integer.
7185 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7186 so $a="9.22337203685478e+18"; $a+0; $a--
7187 needs to be the same as $a="9.22337203685478e+18"; $a--
7194 /* sv_2iv *should* have made this an NV */
7195 if (flags & SVp_NOK) {
7196 (void)SvNOK_only(sv);
7197 SvNV_set(sv, SvNVX(sv) - 1.0);
7200 /* I don't think we can get here. Maybe I should assert this
7201 And if we do get here I suspect that sv_setnv will croak. NWC
7203 #if defined(USE_LONG_DOUBLE)
7204 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",
7205 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7207 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7208 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7212 #endif /* PERL_PRESERVE_IVUV */
7213 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7217 =for apidoc sv_mortalcopy
7219 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7220 The new SV is marked as mortal. It will be destroyed "soon", either by an
7221 explicit call to FREETMPS, or by an implicit call at places such as
7222 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7227 /* Make a string that will exist for the duration of the expression
7228 * evaluation. Actually, it may have to last longer than that, but
7229 * hopefully we won't free it until it has been assigned to a
7230 * permanent location. */
7233 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
7239 sv_setsv(sv,oldstr);
7241 PL_tmps_stack[++PL_tmps_ix] = sv;
7247 =for apidoc sv_newmortal
7249 Creates a new null SV which is mortal. The reference count of the SV is
7250 set to 1. It will be destroyed "soon", either by an explicit call to
7251 FREETMPS, or by an implicit call at places such as statement boundaries.
7252 See also C<sv_mortalcopy> and C<sv_2mortal>.
7258 Perl_sv_newmortal(pTHX)
7264 SvFLAGS(sv) = SVs_TEMP;
7266 PL_tmps_stack[++PL_tmps_ix] = sv;
7272 =for apidoc newSVpvn_flags
7274 Creates a new SV and copies a string into it. The reference count for the
7275 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7276 string. You are responsible for ensuring that the source string is at least
7277 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7278 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7279 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7280 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7281 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7283 #define newSVpvn_utf8(s, len, u) \
7284 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7290 Perl_newSVpvn_flags(pTHX_ const char *const s, const STRLEN len, const U32 flags)
7295 /* All the flags we don't support must be zero.
7296 And we're new code so I'm going to assert this from the start. */
7297 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7299 sv_setpvn(sv,s,len);
7300 SvFLAGS(sv) |= (flags & SVf_UTF8);
7301 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7305 =for apidoc sv_2mortal
7307 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7308 by an explicit call to FREETMPS, or by an implicit call at places such as
7309 statement boundaries. SvTEMP() is turned on which means that the SV's
7310 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7311 and C<sv_mortalcopy>.
7317 Perl_sv_2mortal(pTHX_ register SV *const sv)
7322 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7325 PL_tmps_stack[++PL_tmps_ix] = sv;
7333 Creates a new SV and copies a string into it. The reference count for the
7334 SV is set to 1. If C<len> is zero, Perl will compute the length using
7335 strlen(). For efficiency, consider using C<newSVpvn> instead.
7341 Perl_newSVpv(pTHX_ const char *const s, const STRLEN len)
7347 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7352 =for apidoc newSVpvn
7354 Creates a new SV and copies a string into it. The reference count for the
7355 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7356 string. You are responsible for ensuring that the source string is at least
7357 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7363 Perl_newSVpvn(pTHX_ const char *const s, const STRLEN len)
7369 sv_setpvn(sv,s,len);
7374 =for apidoc newSVhek
7376 Creates a new SV from the hash key structure. It will generate scalars that
7377 point to the shared string table where possible. Returns a new (undefined)
7378 SV if the hek is NULL.
7384 Perl_newSVhek(pTHX_ const HEK *const hek)
7394 if (HEK_LEN(hek) == HEf_SVKEY) {
7395 return newSVsv(*(SV**)HEK_KEY(hek));
7397 const int flags = HEK_FLAGS(hek);
7398 if (flags & HVhek_WASUTF8) {
7400 Andreas would like keys he put in as utf8 to come back as utf8
7402 STRLEN utf8_len = HEK_LEN(hek);
7403 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7404 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7407 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7409 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7410 /* We don't have a pointer to the hv, so we have to replicate the
7411 flag into every HEK. This hv is using custom a hasing
7412 algorithm. Hence we can't return a shared string scalar, as
7413 that would contain the (wrong) hash value, and might get passed
7414 into an hv routine with a regular hash.
7415 Similarly, a hash that isn't using shared hash keys has to have
7416 the flag in every key so that we know not to try to call
7417 share_hek_kek on it. */
7419 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7424 /* This will be overwhelminly the most common case. */
7426 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7427 more efficient than sharepvn(). */
7431 sv_upgrade(sv, SVt_PV);
7432 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7433 SvCUR_set(sv, HEK_LEN(hek));
7446 =for apidoc newSVpvn_share
7448 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7449 table. If the string does not already exist in the table, it is created
7450 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7451 value is used; otherwise the hash is computed. The string's hash can be later
7452 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7453 that as the string table is used for shared hash keys these strings will have
7454 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7460 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7464 bool is_utf8 = FALSE;
7465 const char *const orig_src = src;
7468 STRLEN tmplen = -len;
7470 /* See the note in hv.c:hv_fetch() --jhi */
7471 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7475 PERL_HASH(hash, src, len);
7477 sv_upgrade(sv, SVt_PV);
7478 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7486 if (src != orig_src)
7492 #if defined(PERL_IMPLICIT_CONTEXT)
7494 /* pTHX_ magic can't cope with varargs, so this is a no-context
7495 * version of the main function, (which may itself be aliased to us).
7496 * Don't access this version directly.
7500 Perl_newSVpvf_nocontext(const char *const pat, ...)
7506 PERL_ARGS_ASSERT_NEWSVPVF_NOCONTEXT;
7508 va_start(args, pat);
7509 sv = vnewSVpvf(pat, &args);
7516 =for apidoc newSVpvf
7518 Creates a new SV and initializes it with the string formatted like
7525 Perl_newSVpvf(pTHX_ const char *const pat, ...)
7530 PERL_ARGS_ASSERT_NEWSVPVF;
7532 va_start(args, pat);
7533 sv = vnewSVpvf(pat, &args);
7538 /* backend for newSVpvf() and newSVpvf_nocontext() */
7541 Perl_vnewSVpvf(pTHX_ const char *const pat, va_list *const args)
7546 PERL_ARGS_ASSERT_VNEWSVPVF;
7549 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7556 Creates a new SV and copies a floating point value into it.
7557 The reference count for the SV is set to 1.
7563 Perl_newSVnv(pTHX_ const NV n)
7576 Creates a new SV and copies an integer into it. The reference count for the
7583 Perl_newSViv(pTHX_ const IV i)
7596 Creates a new SV and copies an unsigned integer into it.
7597 The reference count for the SV is set to 1.
7603 Perl_newSVuv(pTHX_ const UV u)
7614 =for apidoc newSV_type
7616 Creates a new SV, of the type specified. The reference count for the new SV
7623 Perl_newSV_type(pTHX_ const svtype type)
7628 sv_upgrade(sv, type);
7633 =for apidoc newRV_noinc
7635 Creates an RV wrapper for an SV. The reference count for the original
7636 SV is B<not> incremented.
7642 Perl_newRV_noinc(pTHX_ SV *const tmpRef)
7645 register SV *sv = newSV_type(SVt_IV);
7647 PERL_ARGS_ASSERT_NEWRV_NOINC;
7650 SvRV_set(sv, tmpRef);
7655 /* newRV_inc is the official function name to use now.
7656 * newRV_inc is in fact #defined to newRV in sv.h
7660 Perl_newRV(pTHX_ SV *const sv)
7664 PERL_ARGS_ASSERT_NEWRV;
7666 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7672 Creates a new SV which is an exact duplicate of the original SV.
7679 Perl_newSVsv(pTHX_ register SV *const old)
7686 if (SvTYPE(old) == SVTYPEMASK) {
7687 if (ckWARN_d(WARN_INTERNAL))
7688 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7692 /* SV_GMAGIC is the default for sv_setv()
7693 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7694 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7695 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7700 =for apidoc sv_reset
7702 Underlying implementation for the C<reset> Perl function.
7703 Note that the perl-level function is vaguely deprecated.
7709 Perl_sv_reset(pTHX_ register const char *s, HV *const stash)
7712 char todo[PERL_UCHAR_MAX+1];
7714 PERL_ARGS_ASSERT_SV_RESET;
7719 if (!*s) { /* reset ?? searches */
7720 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7722 const U32 count = mg->mg_len / sizeof(PMOP**);
7723 PMOP **pmp = (PMOP**) mg->mg_ptr;
7724 PMOP *const *const end = pmp + count;
7728 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7730 (*pmp)->op_pmflags &= ~PMf_USED;
7738 /* reset variables */
7740 if (!HvARRAY(stash))
7743 Zero(todo, 256, char);
7746 I32 i = (unsigned char)*s;
7750 max = (unsigned char)*s++;
7751 for ( ; i <= max; i++) {
7754 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7756 for (entry = HvARRAY(stash)[i];
7758 entry = HeNEXT(entry))
7763 if (!todo[(U8)*HeKEY(entry)])
7765 gv = (GV*)HeVAL(entry);
7768 if (SvTHINKFIRST(sv)) {
7769 if (!SvREADONLY(sv) && SvROK(sv))
7771 /* XXX Is this continue a bug? Why should THINKFIRST
7772 exempt us from resetting arrays and hashes? */
7776 if (SvTYPE(sv) >= SVt_PV) {
7778 if (SvPVX_const(sv) != NULL)
7786 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7788 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7791 # if defined(USE_ENVIRON_ARRAY)
7794 # endif /* USE_ENVIRON_ARRAY */
7805 Using various gambits, try to get an IO from an SV: the IO slot if its a
7806 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7807 named after the PV if we're a string.
7813 Perl_sv_2io(pTHX_ SV *const sv)
7818 PERL_ARGS_ASSERT_SV_2IO;
7820 switch (SvTYPE(sv)) {
7825 if (isGV_with_GP(sv)) {
7829 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7835 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7837 return sv_2io(SvRV(sv));
7838 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7844 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7853 Using various gambits, try to get a CV from an SV; in addition, try if
7854 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7855 The flags in C<lref> are passed to sv_fetchsv.
7861 Perl_sv_2cv(pTHX_ SV *sv, HV **const st, GV **const gvp, const I32 lref)
7867 PERL_ARGS_ASSERT_SV_2CV;
7874 switch (SvTYPE(sv)) {
7885 if (isGV_with_GP(sv)) {
7895 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7897 tryAMAGICunDEREF(to_cv);
7900 if (SvTYPE(sv) == SVt_PVCV) {
7906 else if(isGV_with_GP(sv))
7909 Perl_croak(aTHX_ "Not a subroutine reference");
7911 else if (isGV_with_GP(sv)) {
7916 gv = gv_fetchsv(sv, lref, SVt_PVCV); /* Calls get magic */
7922 /* Some flags to gv_fetchsv mean don't really create the GV */
7923 if (!isGV_with_GP(gv)) {
7929 if (lref && !GvCVu(gv)) {
7933 gv_efullname3(tmpsv, gv, NULL);
7934 /* XXX this is probably not what they think they're getting.
7935 * It has the same effect as "sub name;", i.e. just a forward
7937 newSUB(start_subparse(FALSE, 0),
7938 newSVOP(OP_CONST, 0, tmpsv),
7942 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7943 SVfARG(SvOK(sv) ? sv : &PL_sv_no));
7952 Returns true if the SV has a true value by Perl's rules.
7953 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7954 instead use an in-line version.
7960 Perl_sv_true(pTHX_ register SV *const sv)
7965 register const XPV* const tXpv = (XPV*)SvANY(sv);
7967 (tXpv->xpv_cur > 1 ||
7968 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7975 return SvIVX(sv) != 0;
7978 return SvNVX(sv) != 0.0;
7980 return sv_2bool(sv);
7986 =for apidoc sv_pvn_force
7988 Get a sensible string out of the SV somehow.
7989 A private implementation of the C<SvPV_force> macro for compilers which
7990 can't cope with complex macro expressions. Always use the macro instead.
7992 =for apidoc sv_pvn_force_flags
7994 Get a sensible string out of the SV somehow.
7995 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7996 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7997 implemented in terms of this function.
7998 You normally want to use the various wrapper macros instead: see
7999 C<SvPV_force> and C<SvPV_force_nomg>
8005 Perl_sv_pvn_force_flags(pTHX_ SV *const sv, STRLEN *const lp, const I32 flags)
8009 PERL_ARGS_ASSERT_SV_PVN_FORCE_FLAGS;
8011 if (SvTHINKFIRST(sv) && !SvROK(sv))
8012 sv_force_normal_flags(sv, 0);
8022 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
8023 const char * const ref = sv_reftype(sv,0);
8025 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
8026 ref, OP_NAME(PL_op));
8028 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
8030 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
8031 || isGV_with_GP(sv))
8032 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8034 s = sv_2pv_flags(sv, &len, flags);
8038 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
8041 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8042 SvGROW(sv, len + 1);
8043 Move(s,SvPVX(sv),len,char);
8045 SvPVX(sv)[len] = '\0';
8048 SvPOK_on(sv); /* validate pointer */
8050 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8051 PTR2UV(sv),SvPVX_const(sv)));
8054 return SvPVX_mutable(sv);
8058 =for apidoc sv_pvbyten_force
8060 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
8066 Perl_sv_pvbyten_force(pTHX_ SV *const sv, STRLEN *const lp)
8068 PERL_ARGS_ASSERT_SV_PVBYTEN_FORCE;
8070 sv_pvn_force(sv,lp);
8071 sv_utf8_downgrade(sv,0);
8077 =for apidoc sv_pvutf8n_force
8079 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
8085 Perl_sv_pvutf8n_force(pTHX_ SV *const sv, STRLEN *const lp)
8087 PERL_ARGS_ASSERT_SV_PVUTF8N_FORCE;
8089 sv_pvn_force(sv,lp);
8090 sv_utf8_upgrade(sv);
8096 =for apidoc sv_reftype
8098 Returns a string describing what the SV is a reference to.
8104 Perl_sv_reftype(pTHX_ const SV *const sv, const int ob)
8106 PERL_ARGS_ASSERT_SV_REFTYPE;
8108 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8109 inside return suggests a const propagation bug in g++. */
8110 if (ob && SvOBJECT(sv)) {
8111 char * const name = HvNAME_get(SvSTASH(sv));
8112 return name ? name : (char *) "__ANON__";
8115 switch (SvTYPE(sv)) {
8130 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8131 /* tied lvalues should appear to be
8132 * scalars for backwards compatitbility */
8133 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8134 ? "SCALAR" : "LVALUE");
8135 case SVt_PVAV: return "ARRAY";
8136 case SVt_PVHV: return "HASH";
8137 case SVt_PVCV: return "CODE";
8138 case SVt_PVGV: return (char *) (isGV_with_GP(sv)
8139 ? "GLOB" : "SCALAR");
8140 case SVt_PVFM: return "FORMAT";
8141 case SVt_PVIO: return "IO";
8142 case SVt_BIND: return "BIND";
8143 case SVt_REGEXP: return "REGEXP";
8144 default: return "UNKNOWN";
8150 =for apidoc sv_isobject
8152 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8153 object. If the SV is not an RV, or if the object is not blessed, then this
8160 Perl_sv_isobject(pTHX_ SV *sv)
8176 Returns a boolean indicating whether the SV is blessed into the specified
8177 class. This does not check for subtypes; use C<sv_derived_from> to verify
8178 an inheritance relationship.
8184 Perl_sv_isa(pTHX_ SV *sv, const char *const name)
8188 PERL_ARGS_ASSERT_SV_ISA;
8198 hvname = HvNAME_get(SvSTASH(sv));
8202 return strEQ(hvname, name);
8208 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8209 it will be upgraded to one. If C<classname> is non-null then the new SV will
8210 be blessed in the specified package. The new SV is returned and its
8211 reference count is 1.
8217 Perl_newSVrv(pTHX_ SV *const rv, const char *const classname)
8222 PERL_ARGS_ASSERT_NEWSVRV;
8226 SV_CHECK_THINKFIRST_COW_DROP(rv);
8227 (void)SvAMAGIC_off(rv);
8229 if (SvTYPE(rv) >= SVt_PVMG) {
8230 const U32 refcnt = SvREFCNT(rv);
8234 SvREFCNT(rv) = refcnt;
8236 sv_upgrade(rv, SVt_IV);
8237 } else if (SvROK(rv)) {
8238 SvREFCNT_dec(SvRV(rv));
8240 prepare_SV_for_RV(rv);
8248 HV* const stash = gv_stashpv(classname, GV_ADD);
8249 (void)sv_bless(rv, stash);
8255 =for apidoc sv_setref_pv
8257 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8258 argument will be upgraded to an RV. That RV will be modified to point to
8259 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8260 into the SV. The C<classname> argument indicates the package for the
8261 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8262 will have a reference count of 1, and the RV will be returned.
8264 Do not use with other Perl types such as HV, AV, SV, CV, because those
8265 objects will become corrupted by the pointer copy process.
8267 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8273 Perl_sv_setref_pv(pTHX_ SV *const rv, const char *const classname, void *const pv)
8277 PERL_ARGS_ASSERT_SV_SETREF_PV;
8280 sv_setsv(rv, &PL_sv_undef);
8284 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8289 =for apidoc sv_setref_iv
8291 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8292 argument will be upgraded to an RV. That RV will be modified to point to
8293 the new SV. The C<classname> argument indicates the package for the
8294 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8295 will have a reference count of 1, and the RV will be returned.
8301 Perl_sv_setref_iv(pTHX_ SV *const rv, const char *const classname, const IV iv)
8303 PERL_ARGS_ASSERT_SV_SETREF_IV;
8305 sv_setiv(newSVrv(rv,classname), iv);
8310 =for apidoc sv_setref_uv
8312 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8313 argument will be upgraded to an RV. That RV will be modified to point to
8314 the new SV. The C<classname> argument indicates the package for the
8315 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8316 will have a reference count of 1, and the RV will be returned.
8322 Perl_sv_setref_uv(pTHX_ SV *const rv, const char *const classname, const UV uv)
8324 PERL_ARGS_ASSERT_SV_SETREF_UV;
8326 sv_setuv(newSVrv(rv,classname), uv);
8331 =for apidoc sv_setref_nv
8333 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8334 argument will be upgraded to an RV. That RV will be modified to point to
8335 the new SV. The C<classname> argument indicates the package for the
8336 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8337 will have a reference count of 1, and the RV will be returned.
8343 Perl_sv_setref_nv(pTHX_ SV *const rv, const char *const classname, const NV nv)
8345 PERL_ARGS_ASSERT_SV_SETREF_NV;
8347 sv_setnv(newSVrv(rv,classname), nv);
8352 =for apidoc sv_setref_pvn
8354 Copies a string into a new SV, optionally blessing the SV. The length of the
8355 string must be specified with C<n>. The C<rv> argument will be upgraded to
8356 an RV. That RV will be modified to point to the new SV. The C<classname>
8357 argument indicates the package for the blessing. Set C<classname> to
8358 C<NULL> to avoid the blessing. The new SV will have a reference count
8359 of 1, and the RV will be returned.
8361 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8367 Perl_sv_setref_pvn(pTHX_ SV *const rv, const char *const classname,
8368 const char *const pv, const STRLEN n)
8370 PERL_ARGS_ASSERT_SV_SETREF_PVN;
8372 sv_setpvn(newSVrv(rv,classname), pv, n);
8377 =for apidoc sv_bless
8379 Blesses an SV into a specified package. The SV must be an RV. The package
8380 must be designated by its stash (see C<gv_stashpv()>). The reference count
8381 of the SV is unaffected.
8387 Perl_sv_bless(pTHX_ SV *const sv, HV *const stash)
8392 PERL_ARGS_ASSERT_SV_BLESS;
8395 Perl_croak(aTHX_ "Can't bless non-reference value");
8397 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8398 if (SvIsCOW(tmpRef))
8399 sv_force_normal_flags(tmpRef, 0);
8400 if (SvREADONLY(tmpRef))
8401 Perl_croak(aTHX_ PL_no_modify);
8402 if (SvOBJECT(tmpRef)) {
8403 if (SvTYPE(tmpRef) != SVt_PVIO)
8405 SvREFCNT_dec(SvSTASH(tmpRef));
8408 SvOBJECT_on(tmpRef);
8409 if (SvTYPE(tmpRef) != SVt_PVIO)
8411 SvUPGRADE(tmpRef, SVt_PVMG);
8412 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8417 (void)SvAMAGIC_off(sv);
8419 if(SvSMAGICAL(tmpRef))
8420 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8428 /* Downgrades a PVGV to a PVMG.
8432 S_sv_unglob(pTHX_ SV *const sv)
8437 SV * const temp = sv_newmortal();
8439 PERL_ARGS_ASSERT_SV_UNGLOB;
8441 assert(SvTYPE(sv) == SVt_PVGV);
8443 gv_efullname3(temp, (GV *) sv, "*");
8446 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8447 mro_method_changed_in(stash);
8451 sv_del_backref((SV*)GvSTASH(sv), sv);
8455 if (GvNAME_HEK(sv)) {
8456 unshare_hek(GvNAME_HEK(sv));
8458 isGV_with_GP_off(sv);
8460 /* need to keep SvANY(sv) in the right arena */
8461 xpvmg = new_XPVMG();
8462 StructCopy(SvANY(sv), xpvmg, XPVMG);
8463 del_XPVGV(SvANY(sv));
8466 SvFLAGS(sv) &= ~SVTYPEMASK;
8467 SvFLAGS(sv) |= SVt_PVMG;
8469 /* Intentionally not calling any local SET magic, as this isn't so much a
8470 set operation as merely an internal storage change. */
8471 sv_setsv_flags(sv, temp, 0);
8475 =for apidoc sv_unref_flags
8477 Unsets the RV status of the SV, and decrements the reference count of
8478 whatever was being referenced by the RV. This can almost be thought of
8479 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8480 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8481 (otherwise the decrementing is conditional on the reference count being
8482 different from one or the reference being a readonly SV).
8489 Perl_sv_unref_flags(pTHX_ SV *const ref, const U32 flags)
8491 SV* const target = SvRV(ref);
8493 PERL_ARGS_ASSERT_SV_UNREF_FLAGS;
8495 if (SvWEAKREF(ref)) {
8496 sv_del_backref(target, ref);
8498 SvRV_set(ref, NULL);
8501 SvRV_set(ref, NULL);
8503 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8504 assigned to as BEGIN {$a = \"Foo"} will fail. */
8505 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8506 SvREFCNT_dec(target);
8507 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8508 sv_2mortal(target); /* Schedule for freeing later */
8512 =for apidoc sv_untaint
8514 Untaint an SV. Use C<SvTAINTED_off> instead.
8519 Perl_sv_untaint(pTHX_ SV *const sv)
8521 PERL_ARGS_ASSERT_SV_UNTAINT;
8523 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8524 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8531 =for apidoc sv_tainted
8533 Test an SV for taintedness. Use C<SvTAINTED> instead.
8538 Perl_sv_tainted(pTHX_ SV *const sv)
8540 PERL_ARGS_ASSERT_SV_TAINTED;
8542 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8543 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8544 if (mg && (mg->mg_len & 1) )
8551 =for apidoc sv_setpviv
8553 Copies an integer into the given SV, also updating its string value.
8554 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8560 Perl_sv_setpviv(pTHX_ SV *const sv, const IV iv)
8562 char buf[TYPE_CHARS(UV)];
8564 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8566 PERL_ARGS_ASSERT_SV_SETPVIV;
8568 sv_setpvn(sv, ptr, ebuf - ptr);
8572 =for apidoc sv_setpviv_mg
8574 Like C<sv_setpviv>, but also handles 'set' magic.
8580 Perl_sv_setpviv_mg(pTHX_ SV *const sv, const IV iv)
8582 PERL_ARGS_ASSERT_SV_SETPVIV_MG;
8588 #if defined(PERL_IMPLICIT_CONTEXT)
8590 /* pTHX_ magic can't cope with varargs, so this is a no-context
8591 * version of the main function, (which may itself be aliased to us).
8592 * Don't access this version directly.
8596 Perl_sv_setpvf_nocontext(SV *const sv, const char *const pat, ...)
8601 PERL_ARGS_ASSERT_SV_SETPVF_NOCONTEXT;
8603 va_start(args, pat);
8604 sv_vsetpvf(sv, pat, &args);
8608 /* pTHX_ magic can't cope with varargs, so this is a no-context
8609 * version of the main function, (which may itself be aliased to us).
8610 * Don't access this version directly.
8614 Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8619 PERL_ARGS_ASSERT_SV_SETPVF_MG_NOCONTEXT;
8621 va_start(args, pat);
8622 sv_vsetpvf_mg(sv, pat, &args);
8628 =for apidoc sv_setpvf
8630 Works like C<sv_catpvf> but copies the text into the SV instead of
8631 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8637 Perl_sv_setpvf(pTHX_ SV *const sv, const char *const pat, ...)
8641 PERL_ARGS_ASSERT_SV_SETPVF;
8643 va_start(args, pat);
8644 sv_vsetpvf(sv, pat, &args);
8649 =for apidoc sv_vsetpvf
8651 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8652 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8654 Usually used via its frontend C<sv_setpvf>.
8660 Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8662 PERL_ARGS_ASSERT_SV_VSETPVF;
8664 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8668 =for apidoc sv_setpvf_mg
8670 Like C<sv_setpvf>, but also handles 'set' magic.
8676 Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8680 PERL_ARGS_ASSERT_SV_SETPVF_MG;
8682 va_start(args, pat);
8683 sv_vsetpvf_mg(sv, pat, &args);
8688 =for apidoc sv_vsetpvf_mg
8690 Like C<sv_vsetpvf>, but also handles 'set' magic.
8692 Usually used via its frontend C<sv_setpvf_mg>.
8698 Perl_sv_vsetpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8700 PERL_ARGS_ASSERT_SV_VSETPVF_MG;
8702 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8706 #if defined(PERL_IMPLICIT_CONTEXT)
8708 /* pTHX_ magic can't cope with varargs, so this is a no-context
8709 * version of the main function, (which may itself be aliased to us).
8710 * Don't access this version directly.
8714 Perl_sv_catpvf_nocontext(SV *const sv, const char *const pat, ...)
8719 PERL_ARGS_ASSERT_SV_CATPVF_NOCONTEXT;
8721 va_start(args, pat);
8722 sv_vcatpvf(sv, pat, &args);
8726 /* pTHX_ magic can't cope with varargs, so this is a no-context
8727 * version of the main function, (which may itself be aliased to us).
8728 * Don't access this version directly.
8732 Perl_sv_catpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
8737 PERL_ARGS_ASSERT_SV_CATPVF_MG_NOCONTEXT;
8739 va_start(args, pat);
8740 sv_vcatpvf_mg(sv, pat, &args);
8746 =for apidoc sv_catpvf
8748 Processes its arguments like C<sprintf> and appends the formatted
8749 output to an SV. If the appended data contains "wide" characters
8750 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8751 and characters >255 formatted with %c), the original SV might get
8752 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8753 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8754 valid UTF-8; if the original SV was bytes, the pattern should be too.
8759 Perl_sv_catpvf(pTHX_ SV *const sv, const char *const pat, ...)
8763 PERL_ARGS_ASSERT_SV_CATPVF;
8765 va_start(args, pat);
8766 sv_vcatpvf(sv, pat, &args);
8771 =for apidoc sv_vcatpvf
8773 Processes its arguments like C<vsprintf> and appends the formatted output
8774 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8776 Usually used via its frontend C<sv_catpvf>.
8782 Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8784 PERL_ARGS_ASSERT_SV_VCATPVF;
8786 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8790 =for apidoc sv_catpvf_mg
8792 Like C<sv_catpvf>, but also handles 'set' magic.
8798 Perl_sv_catpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
8802 PERL_ARGS_ASSERT_SV_CATPVF_MG;
8804 va_start(args, pat);
8805 sv_vcatpvf_mg(sv, pat, &args);
8810 =for apidoc sv_vcatpvf_mg
8812 Like C<sv_vcatpvf>, but also handles 'set' magic.
8814 Usually used via its frontend C<sv_catpvf_mg>.
8820 Perl_sv_vcatpvf_mg(pTHX_ SV *const sv, const char *const pat, va_list *const args)
8822 PERL_ARGS_ASSERT_SV_VCATPVF_MG;
8824 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8829 =for apidoc sv_vsetpvfn
8831 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8834 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8840 Perl_sv_vsetpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8841 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8843 PERL_ARGS_ASSERT_SV_VSETPVFN;
8845 sv_setpvn(sv, "", 0);
8846 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8850 S_expect_number(pTHX_ char **const pattern)
8855 PERL_ARGS_ASSERT_EXPECT_NUMBER;
8857 switch (**pattern) {
8858 case '1': case '2': case '3':
8859 case '4': case '5': case '6':
8860 case '7': case '8': case '9':
8861 var = *(*pattern)++ - '0';
8862 while (isDIGIT(**pattern)) {
8863 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8865 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8873 S_F0convert(NV nv, char *const endbuf, STRLEN *const len)
8875 const int neg = nv < 0;
8878 PERL_ARGS_ASSERT_F0CONVERT;
8886 if (uv & 1 && uv == nv)
8887 uv--; /* Round to even */
8889 const unsigned dig = uv % 10;
8902 =for apidoc sv_vcatpvfn
8904 Processes its arguments like C<vsprintf> and appends the formatted output
8905 to an SV. Uses an array of SVs if the C style variable argument list is
8906 missing (NULL). When running with taint checks enabled, indicates via
8907 C<maybe_tainted> if results are untrustworthy (often due to the use of
8910 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8916 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8917 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8918 vec_utf8 = DO_UTF8(vecsv);
8920 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8923 Perl_sv_vcatpvfn(pTHX_ SV *const sv, const char *const pat, const STRLEN patlen,
8924 va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
8932 static const char nullstr[] = "(null)";
8934 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8935 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8937 /* Times 4: a decimal digit takes more than 3 binary digits.
8938 * NV_DIG: mantissa takes than many decimal digits.
8939 * Plus 32: Playing safe. */
8940 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8941 /* large enough for "%#.#f" --chip */
8942 /* what about long double NVs? --jhi */
8944 PERL_ARGS_ASSERT_SV_VCATPVFN;
8945 PERL_UNUSED_ARG(maybe_tainted);
8947 /* no matter what, this is a string now */
8948 (void)SvPV_force(sv, origlen);
8950 /* special-case "", "%s", and "%-p" (SVf - see below) */
8953 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8955 const char * const s = va_arg(*args, char*);
8956 sv_catpv(sv, s ? s : nullstr);
8958 else if (svix < svmax) {
8959 sv_catsv(sv, *svargs);
8963 if (args && patlen == 3 && pat[0] == '%' &&
8964 pat[1] == '-' && pat[2] == 'p') {
8965 argsv = (SV*)va_arg(*args, void*);
8966 sv_catsv(sv, argsv);
8970 #ifndef USE_LONG_DOUBLE
8971 /* special-case "%.<number>[gf]" */
8972 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8973 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8974 unsigned digits = 0;
8978 while (*pp >= '0' && *pp <= '9')
8979 digits = 10 * digits + (*pp++ - '0');
8980 if (pp - pat == (int)patlen - 1) {
8988 /* Add check for digits != 0 because it seems that some
8989 gconverts are buggy in this case, and we don't yet have
8990 a Configure test for this. */
8991 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8992 /* 0, point, slack */
8993 Gconvert(nv, (int)digits, 0, ebuf);
8995 if (*ebuf) /* May return an empty string for digits==0 */
8998 } else if (!digits) {
9001 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9002 sv_catpvn(sv, p, l);
9008 #endif /* !USE_LONG_DOUBLE */
9010 if (!args && svix < svmax && DO_UTF8(*svargs))
9013 patend = (char*)pat + patlen;
9014 for (p = (char*)pat; p < patend; p = q) {
9017 bool vectorize = FALSE;
9018 bool vectorarg = FALSE;
9019 bool vec_utf8 = FALSE;
9025 bool has_precis = FALSE;
9027 const I32 osvix = svix;
9028 bool is_utf8 = FALSE; /* is this item utf8? */
9029 #ifdef HAS_LDBL_SPRINTF_BUG
9030 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9031 with sfio - Allen <allens@cpan.org> */
9032 bool fix_ldbl_sprintf_bug = FALSE;
9036 U8 utf8buf[UTF8_MAXBYTES+1];
9037 STRLEN esignlen = 0;
9039 const char *eptr = NULL;
9042 const U8 *vecstr = NULL;
9049 /* we need a long double target in case HAS_LONG_DOUBLE but
9052 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9060 const char *dotstr = ".";
9061 STRLEN dotstrlen = 1;
9062 I32 efix = 0; /* explicit format parameter index */
9063 I32 ewix = 0; /* explicit width index */
9064 I32 epix = 0; /* explicit precision index */
9065 I32 evix = 0; /* explicit vector index */
9066 bool asterisk = FALSE;
9068 /* echo everything up to the next format specification */
9069 for (q = p; q < patend && *q != '%'; ++q) ;
9071 if (has_utf8 && !pat_utf8)
9072 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9074 sv_catpvn(sv, p, q - p);
9081 We allow format specification elements in this order:
9082 \d+\$ explicit format parameter index
9084 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9085 0 flag (as above): repeated to allow "v02"
9086 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9087 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9089 [%bcdefginopsuxDFOUX] format (mandatory)
9094 As of perl5.9.3, printf format checking is on by default.
9095 Internally, perl uses %p formats to provide an escape to
9096 some extended formatting. This block deals with those
9097 extensions: if it does not match, (char*)q is reset and
9098 the normal format processing code is used.
9100 Currently defined extensions are:
9101 %p include pointer address (standard)
9102 %-p (SVf) include an SV (previously %_)
9103 %-<num>p include an SV with precision <num>
9104 %<num>p reserved for future extensions
9106 Robin Barker 2005-07-14
9108 %1p (VDf) removed. RMB 2007-10-19
9115 n = expect_number(&q);
9122 argsv = (SV*)va_arg(*args, void*);
9123 eptr = SvPV_const(argsv, elen);
9129 if (ckWARN_d(WARN_INTERNAL))
9130 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9131 "internal %%<num>p might conflict with future printf extensions");
9137 if ( (width = expect_number(&q)) ) {
9152 if (plus == '+' && *q == ' ') /* '+' over ' ' */
9181 if ( (ewix = expect_number(&q)) )
9190 if ((vectorarg = asterisk)) {
9203 width = expect_number(&q);
9209 vecsv = va_arg(*args, SV*);
9211 vecsv = (evix > 0 && evix <= svmax)
9212 ? svargs[evix-1] : &PL_sv_undef;
9214 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
9216 dotstr = SvPV_const(vecsv, dotstrlen);
9217 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
9218 bad with tied or overloaded values that return UTF8. */
9221 else if (has_utf8) {
9222 vecsv = sv_mortalcopy(vecsv);
9223 sv_utf8_upgrade(vecsv);
9224 dotstr = SvPV_const(vecsv, dotstrlen);
9231 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
9232 vecsv = svargs[efix ? efix-1 : svix++];
9233 vecstr = (U8*)SvPV_const(vecsv,veclen);
9234 vec_utf8 = DO_UTF8(vecsv);
9236 /* if this is a version object, we need to convert
9237 * back into v-string notation and then let the
9238 * vectorize happen normally
9240 if (sv_derived_from(vecsv, "version")) {
9241 char *version = savesvpv(vecsv);
9242 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
9243 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
9244 "vector argument not supported with alpha versions");
9247 vecsv = sv_newmortal();
9248 scan_vstring(version, version + veclen, vecsv);
9249 vecstr = (U8*)SvPV_const(vecsv, veclen);
9250 vec_utf8 = DO_UTF8(vecsv);
9262 i = va_arg(*args, int);
9264 i = (ewix ? ewix <= svmax : svix < svmax) ?
9265 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9267 width = (i < 0) ? -i : i;
9277 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
9279 /* XXX: todo, support specified precision parameter */
9283 i = va_arg(*args, int);
9285 i = (ewix ? ewix <= svmax : svix < svmax)
9286 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9288 has_precis = !(i < 0);
9293 precis = precis * 10 + (*q++ - '0');
9302 case 'I': /* Ix, I32x, and I64x */
9304 if (q[1] == '6' && q[2] == '4') {
9310 if (q[1] == '3' && q[2] == '2') {
9320 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9331 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9332 if (*(q + 1) == 'l') { /* lld, llf */
9358 if (!vectorize && !args) {
9360 const I32 i = efix-1;
9361 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9363 argsv = (svix >= 0 && svix < svmax)
9364 ? svargs[svix++] : &PL_sv_undef;
9375 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9377 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9379 eptr = (char*)utf8buf;
9380 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9394 eptr = va_arg(*args, char*);
9396 #ifdef MACOS_TRADITIONAL
9397 /* On MacOS, %#s format is used for Pascal strings */
9402 elen = strlen(eptr);
9404 eptr = (char *)nullstr;
9405 elen = sizeof nullstr - 1;
9409 eptr = SvPV_const(argsv, elen);
9410 if (DO_UTF8(argsv)) {
9411 I32 old_precis = precis;
9412 if (has_precis && precis < elen) {
9414 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9417 if (width) { /* fudge width (can't fudge elen) */
9418 if (has_precis && precis < elen)
9419 width += precis - old_precis;
9421 width += elen - sv_len_utf8(argsv);
9428 if (has_precis && elen > precis)
9435 if (alt || vectorize)
9437 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9458 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9467 esignbuf[esignlen++] = plus;
9471 case 'h': iv = (short)va_arg(*args, int); break;
9472 case 'l': iv = va_arg(*args, long); break;
9473 case 'V': iv = va_arg(*args, IV); break;
9474 default: iv = va_arg(*args, int); break;
9476 case 'q': iv = va_arg(*args, Quad_t); break;
9481 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9483 case 'h': iv = (short)tiv; break;
9484 case 'l': iv = (long)tiv; break;
9486 default: iv = tiv; break;
9488 case 'q': iv = (Quad_t)tiv; break;
9492 if ( !vectorize ) /* we already set uv above */
9497 esignbuf[esignlen++] = plus;
9501 esignbuf[esignlen++] = '-';
9545 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9556 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9557 case 'l': uv = va_arg(*args, unsigned long); break;
9558 case 'V': uv = va_arg(*args, UV); break;
9559 default: uv = va_arg(*args, unsigned); break;
9561 case 'q': uv = va_arg(*args, Uquad_t); break;
9566 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9568 case 'h': uv = (unsigned short)tuv; break;
9569 case 'l': uv = (unsigned long)tuv; break;
9571 default: uv = tuv; break;
9573 case 'q': uv = (Uquad_t)tuv; break;
9580 char *ptr = ebuf + sizeof ebuf;
9581 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9587 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9593 esignbuf[esignlen++] = '0';
9594 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9602 if (alt && *ptr != '0')
9611 esignbuf[esignlen++] = '0';
9612 esignbuf[esignlen++] = c;
9615 default: /* it had better be ten or less */
9619 } while (uv /= base);
9622 elen = (ebuf + sizeof ebuf) - ptr;
9626 zeros = precis - elen;
9627 else if (precis == 0 && elen == 1 && *eptr == '0'
9628 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9631 /* a precision nullifies the 0 flag. */
9638 /* FLOATING POINT */
9641 c = 'f'; /* maybe %F isn't supported here */
9649 /* This is evil, but floating point is even more evil */
9651 /* for SV-style calling, we can only get NV
9652 for C-style calling, we assume %f is double;
9653 for simplicity we allow any of %Lf, %llf, %qf for long double
9657 #if defined(USE_LONG_DOUBLE)
9661 /* [perl #20339] - we should accept and ignore %lf rather than die */
9665 #if defined(USE_LONG_DOUBLE)
9666 intsize = args ? 0 : 'q';
9670 #if defined(HAS_LONG_DOUBLE)
9679 /* now we need (long double) if intsize == 'q', else (double) */
9681 #if LONG_DOUBLESIZE > DOUBLESIZE
9683 va_arg(*args, long double) :
9684 va_arg(*args, double)
9686 va_arg(*args, double)
9691 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9692 else. frexp() has some unspecified behaviour for those three */
9693 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9695 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9696 will cast our (long double) to (double) */
9697 (void)Perl_frexp(nv, &i);
9698 if (i == PERL_INT_MIN)
9699 Perl_die(aTHX_ "panic: frexp");
9701 need = BIT_DIGITS(i);
9703 need += has_precis ? precis : 6; /* known default */
9708 #ifdef HAS_LDBL_SPRINTF_BUG
9709 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9710 with sfio - Allen <allens@cpan.org> */
9713 # define MY_DBL_MAX DBL_MAX
9714 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9715 # if DOUBLESIZE >= 8
9716 # define MY_DBL_MAX 1.7976931348623157E+308L
9718 # define MY_DBL_MAX 3.40282347E+38L
9722 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9723 # define MY_DBL_MAX_BUG 1L
9725 # define MY_DBL_MAX_BUG MY_DBL_MAX
9729 # define MY_DBL_MIN DBL_MIN
9730 # else /* XXX guessing! -Allen */
9731 # if DOUBLESIZE >= 8
9732 # define MY_DBL_MIN 2.2250738585072014E-308L
9734 # define MY_DBL_MIN 1.17549435E-38L
9738 if ((intsize == 'q') && (c == 'f') &&
9739 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9741 /* it's going to be short enough that
9742 * long double precision is not needed */
9744 if ((nv <= 0L) && (nv >= -0L))
9745 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9747 /* would use Perl_fp_class as a double-check but not
9748 * functional on IRIX - see perl.h comments */
9750 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9751 /* It's within the range that a double can represent */
9752 #if defined(DBL_MAX) && !defined(DBL_MIN)
9753 if ((nv >= ((long double)1/DBL_MAX)) ||
9754 (nv <= (-(long double)1/DBL_MAX)))
9756 fix_ldbl_sprintf_bug = TRUE;
9759 if (fix_ldbl_sprintf_bug == TRUE) {
9769 # undef MY_DBL_MAX_BUG
9772 #endif /* HAS_LDBL_SPRINTF_BUG */
9774 need += 20; /* fudge factor */
9775 if (PL_efloatsize < need) {
9776 Safefree(PL_efloatbuf);
9777 PL_efloatsize = need + 20; /* more fudge */
9778 Newx(PL_efloatbuf, PL_efloatsize, char);
9779 PL_efloatbuf[0] = '\0';
9782 if ( !(width || left || plus || alt) && fill != '0'
9783 && has_precis && intsize != 'q' ) { /* Shortcuts */
9784 /* See earlier comment about buggy Gconvert when digits,
9786 if ( c == 'g' && precis) {
9787 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9788 /* May return an empty string for digits==0 */
9789 if (*PL_efloatbuf) {
9790 elen = strlen(PL_efloatbuf);
9791 goto float_converted;
9793 } else if ( c == 'f' && !precis) {
9794 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9799 char *ptr = ebuf + sizeof ebuf;
9802 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9803 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9804 if (intsize == 'q') {
9805 /* Copy the one or more characters in a long double
9806 * format before the 'base' ([efgEFG]) character to
9807 * the format string. */
9808 static char const prifldbl[] = PERL_PRIfldbl;
9809 char const *p = prifldbl + sizeof(prifldbl) - 3;
9810 while (p >= prifldbl) { *--ptr = *p--; }
9815 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9820 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9832 /* No taint. Otherwise we are in the strange situation
9833 * where printf() taints but print($float) doesn't.
9835 #if defined(HAS_LONG_DOUBLE)
9836 elen = ((intsize == 'q')
9837 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9838 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9840 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9844 eptr = PL_efloatbuf;
9852 i = SvCUR(sv) - origlen;
9855 case 'h': *(va_arg(*args, short*)) = i; break;
9856 default: *(va_arg(*args, int*)) = i; break;
9857 case 'l': *(va_arg(*args, long*)) = i; break;
9858 case 'V': *(va_arg(*args, IV*)) = i; break;
9860 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9865 sv_setuv_mg(argsv, (UV)i);
9866 continue; /* not "break" */
9873 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9874 && ckWARN(WARN_PRINTF))
9876 SV * const msg = sv_newmortal();
9877 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9878 (PL_op->op_type == OP_PRTF) ? "" : "s");
9881 Perl_sv_catpvf(aTHX_ msg,
9882 "\"%%%c\"", c & 0xFF);
9884 Perl_sv_catpvf(aTHX_ msg,
9885 "\"%%\\%03"UVof"\"",
9888 sv_catpvs(msg, "end of string");
9889 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9892 /* output mangled stuff ... */
9898 /* ... right here, because formatting flags should not apply */
9899 SvGROW(sv, SvCUR(sv) + elen + 1);
9901 Copy(eptr, p, elen, char);
9904 SvCUR_set(sv, p - SvPVX_const(sv));
9906 continue; /* not "break" */
9909 if (is_utf8 != has_utf8) {
9912 sv_utf8_upgrade(sv);
9915 const STRLEN old_elen = elen;
9916 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9917 sv_utf8_upgrade(nsv);
9918 eptr = SvPVX_const(nsv);
9921 if (width) { /* fudge width (can't fudge elen) */
9922 width += elen - old_elen;
9928 have = esignlen + zeros + elen;
9930 Perl_croak_nocontext(PL_memory_wrap);
9932 need = (have > width ? have : width);
9935 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9936 Perl_croak_nocontext(PL_memory_wrap);
9937 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9939 if (esignlen && fill == '0') {
9941 for (i = 0; i < (int)esignlen; i++)
9945 memset(p, fill, gap);
9948 if (esignlen && fill != '0') {
9950 for (i = 0; i < (int)esignlen; i++)
9955 for (i = zeros; i; i--)
9959 Copy(eptr, p, elen, char);
9963 memset(p, ' ', gap);
9968 Copy(dotstr, p, dotstrlen, char);
9972 vectorize = FALSE; /* done iterating over vecstr */
9979 SvCUR_set(sv, p - SvPVX_const(sv));
9987 /* =========================================================================
9989 =head1 Cloning an interpreter
9991 All the macros and functions in this section are for the private use of
9992 the main function, perl_clone().
9994 The foo_dup() functions make an exact copy of an existing foo thingy.
9995 During the course of a cloning, a hash table is used to map old addresses
9996 to new addresses. The table is created and manipulated with the
9997 ptr_table_* functions.
10001 ============================================================================*/
10004 #if defined(USE_ITHREADS)
10006 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
10007 #ifndef GpREFCNT_inc
10008 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10012 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
10013 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
10014 If this changes, please unmerge ss_dup. */
10015 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10016 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
10017 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10018 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10019 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10020 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10021 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10022 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10023 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10024 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10025 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10026 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10027 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
10028 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
10030 /* clone a parser */
10033 Perl_parser_dup(pTHX_ const yy_parser *const proto, CLONE_PARAMS *const param)
10037 PERL_ARGS_ASSERT_PARSER_DUP;
10042 /* look for it in the table first */
10043 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
10047 /* create anew and remember what it is */
10048 Newxz(parser, 1, yy_parser);
10049 ptr_table_store(PL_ptr_table, proto, parser);
10051 parser->yyerrstatus = 0;
10052 parser->yychar = YYEMPTY; /* Cause a token to be read. */
10054 /* XXX these not yet duped */
10055 parser->old_parser = NULL;
10056 parser->stack = NULL;
10058 parser->stack_size = 0;
10059 /* XXX parser->stack->state = 0; */
10061 /* XXX eventually, just Copy() most of the parser struct ? */
10063 parser->lex_brackets = proto->lex_brackets;
10064 parser->lex_casemods = proto->lex_casemods;
10065 parser->lex_brackstack = savepvn(proto->lex_brackstack,
10066 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
10067 parser->lex_casestack = savepvn(proto->lex_casestack,
10068 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
10069 parser->lex_defer = proto->lex_defer;
10070 parser->lex_dojoin = proto->lex_dojoin;
10071 parser->lex_expect = proto->lex_expect;
10072 parser->lex_formbrack = proto->lex_formbrack;
10073 parser->lex_inpat = proto->lex_inpat;
10074 parser->lex_inwhat = proto->lex_inwhat;
10075 parser->lex_op = proto->lex_op;
10076 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
10077 parser->lex_starts = proto->lex_starts;
10078 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
10079 parser->multi_close = proto->multi_close;
10080 parser->multi_open = proto->multi_open;
10081 parser->multi_start = proto->multi_start;
10082 parser->multi_end = proto->multi_end;
10083 parser->pending_ident = proto->pending_ident;
10084 parser->preambled = proto->preambled;
10085 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
10086 parser->linestr = sv_dup_inc(proto->linestr, param);
10087 parser->expect = proto->expect;
10088 parser->copline = proto->copline;
10089 parser->last_lop_op = proto->last_lop_op;
10090 parser->lex_state = proto->lex_state;
10091 parser->rsfp = fp_dup(proto->rsfp, '<', param);
10092 /* rsfp_filters entries have fake IoDIRP() */
10093 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
10094 parser->in_my = proto->in_my;
10095 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
10096 parser->error_count = proto->error_count;
10099 parser->linestr = sv_dup_inc(proto->linestr, param);
10102 char * const ols = SvPVX(proto->linestr);
10103 char * const ls = SvPVX(parser->linestr);
10105 parser->bufptr = ls + (proto->bufptr >= ols ?
10106 proto->bufptr - ols : 0);
10107 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
10108 proto->oldbufptr - ols : 0);
10109 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
10110 proto->oldoldbufptr - ols : 0);
10111 parser->linestart = ls + (proto->linestart >= ols ?
10112 proto->linestart - ols : 0);
10113 parser->last_uni = ls + (proto->last_uni >= ols ?
10114 proto->last_uni - ols : 0);
10115 parser->last_lop = ls + (proto->last_lop >= ols ?
10116 proto->last_lop - ols : 0);
10118 parser->bufend = ls + SvCUR(parser->linestr);
10121 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
10125 parser->endwhite = proto->endwhite;
10126 parser->faketokens = proto->faketokens;
10127 parser->lasttoke = proto->lasttoke;
10128 parser->nextwhite = proto->nextwhite;
10129 parser->realtokenstart = proto->realtokenstart;
10130 parser->skipwhite = proto->skipwhite;
10131 parser->thisclose = proto->thisclose;
10132 parser->thismad = proto->thismad;
10133 parser->thisopen = proto->thisopen;
10134 parser->thisstuff = proto->thisstuff;
10135 parser->thistoken = proto->thistoken;
10136 parser->thiswhite = proto->thiswhite;
10138 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
10139 parser->curforce = proto->curforce;
10141 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
10142 Copy(proto->nexttype, parser->nexttype, 5, I32);
10143 parser->nexttoke = proto->nexttoke;
10149 /* duplicate a file handle */
10152 Perl_fp_dup(pTHX_ PerlIO *const fp, const char type, CLONE_PARAMS *const param)
10156 PERL_ARGS_ASSERT_FP_DUP;
10157 PERL_UNUSED_ARG(type);
10160 return (PerlIO*)NULL;
10162 /* look for it in the table first */
10163 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10167 /* create anew and remember what it is */
10168 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10169 ptr_table_store(PL_ptr_table, fp, ret);
10173 /* duplicate a directory handle */
10176 Perl_dirp_dup(pTHX_ DIR *const dp)
10178 PERL_UNUSED_CONTEXT;
10185 /* duplicate a typeglob */
10188 Perl_gp_dup(pTHX_ GP *const gp, CLONE_PARAMS *const param)
10192 PERL_ARGS_ASSERT_GP_DUP;
10196 /* look for it in the table first */
10197 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10201 /* create anew and remember what it is */
10203 ptr_table_store(PL_ptr_table, gp, ret);
10206 ret->gp_refcnt = 0; /* must be before any other dups! */
10207 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10208 ret->gp_io = io_dup_inc(gp->gp_io, param);
10209 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10210 ret->gp_av = av_dup_inc(gp->gp_av, param);
10211 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10212 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10213 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10214 ret->gp_cvgen = gp->gp_cvgen;
10215 ret->gp_line = gp->gp_line;
10216 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
10220 /* duplicate a chain of magic */
10223 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *const param)
10225 MAGIC *mgprev = (MAGIC*)NULL;
10228 PERL_ARGS_ASSERT_MG_DUP;
10231 return (MAGIC*)NULL;
10232 /* look for it in the table first */
10233 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10237 for (; mg; mg = mg->mg_moremagic) {
10239 Newxz(nmg, 1, MAGIC);
10241 mgprev->mg_moremagic = nmg;
10244 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10245 nmg->mg_private = mg->mg_private;
10246 nmg->mg_type = mg->mg_type;
10247 nmg->mg_flags = mg->mg_flags;
10248 /* FIXME for plugins
10249 if (mg->mg_type == PERL_MAGIC_qr) {
10250 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
10254 if(mg->mg_type == PERL_MAGIC_backref) {
10255 /* The backref AV has its reference count deliberately bumped by
10257 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
10260 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10261 ? sv_dup_inc(mg->mg_obj, param)
10262 : sv_dup(mg->mg_obj, param);
10264 nmg->mg_len = mg->mg_len;
10265 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10266 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10267 if (mg->mg_len > 0) {
10268 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10269 if (mg->mg_type == PERL_MAGIC_overload_table &&
10270 AMT_AMAGIC((AMT*)mg->mg_ptr))
10272 const AMT * const amtp = (AMT*)mg->mg_ptr;
10273 AMT * const namtp = (AMT*)nmg->mg_ptr;
10275 for (i = 1; i < NofAMmeth; i++) {
10276 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10280 else if (mg->mg_len == HEf_SVKEY)
10281 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10283 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10284 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10291 #endif /* USE_ITHREADS */
10293 /* create a new pointer-mapping table */
10296 Perl_ptr_table_new(pTHX)
10299 PERL_UNUSED_CONTEXT;
10301 Newxz(tbl, 1, PTR_TBL_t);
10302 tbl->tbl_max = 511;
10303 tbl->tbl_items = 0;
10304 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10308 #define PTR_TABLE_HASH(ptr) \
10309 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10312 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10313 following define) and at call to new_body_inline made below in
10314 Perl_ptr_table_store()
10317 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10319 /* map an existing pointer using a table */
10321 STATIC PTR_TBL_ENT_t *
10322 S_ptr_table_find(PTR_TBL_t *const tbl, const void *const sv)
10324 PTR_TBL_ENT_t *tblent;
10325 const UV hash = PTR_TABLE_HASH(sv);
10327 PERL_ARGS_ASSERT_PTR_TABLE_FIND;
10329 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10330 for (; tblent; tblent = tblent->next) {
10331 if (tblent->oldval == sv)
10338 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *const tbl, const void *const sv)
10340 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10342 PERL_ARGS_ASSERT_PTR_TABLE_FETCH;
10343 PERL_UNUSED_CONTEXT;
10345 return tblent ? tblent->newval : NULL;
10348 /* add a new entry to a pointer-mapping table */
10351 Perl_ptr_table_store(pTHX_ PTR_TBL_t *const tbl, const void *const oldsv, void *const newsv)
10353 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10355 PERL_ARGS_ASSERT_PTR_TABLE_STORE;
10356 PERL_UNUSED_CONTEXT;
10359 tblent->newval = newsv;
10361 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10363 new_body_inline(tblent, PTE_SVSLOT);
10365 tblent->oldval = oldsv;
10366 tblent->newval = newsv;
10367 tblent->next = tbl->tbl_ary[entry];
10368 tbl->tbl_ary[entry] = tblent;
10370 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10371 ptr_table_split(tbl);
10375 /* double the hash bucket size of an existing ptr table */
10378 Perl_ptr_table_split(pTHX_ PTR_TBL_t *const tbl)
10380 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10381 const UV oldsize = tbl->tbl_max + 1;
10382 UV newsize = oldsize * 2;
10385 PERL_ARGS_ASSERT_PTR_TABLE_SPLIT;
10386 PERL_UNUSED_CONTEXT;
10388 Renew(ary, newsize, PTR_TBL_ENT_t*);
10389 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10390 tbl->tbl_max = --newsize;
10391 tbl->tbl_ary = ary;
10392 for (i=0; i < oldsize; i++, ary++) {
10393 PTR_TBL_ENT_t **curentp, **entp, *ent;
10396 curentp = ary + oldsize;
10397 for (entp = ary, ent = *ary; ent; ent = *entp) {
10398 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10400 ent->next = *curentp;
10410 /* remove all the entries from a ptr table */
10413 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *const tbl)
10415 if (tbl && tbl->tbl_items) {
10416 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10417 UV riter = tbl->tbl_max;
10420 PTR_TBL_ENT_t *entry = array[riter];
10423 PTR_TBL_ENT_t * const oentry = entry;
10424 entry = entry->next;
10429 tbl->tbl_items = 0;
10433 /* clear and free a ptr table */
10436 Perl_ptr_table_free(pTHX_ PTR_TBL_t *const tbl)
10441 ptr_table_clear(tbl);
10442 Safefree(tbl->tbl_ary);
10446 #if defined(USE_ITHREADS)
10449 Perl_rvpv_dup(pTHX_ SV *const dstr, const SV *const sstr, CLONE_PARAMS *const param)
10451 PERL_ARGS_ASSERT_RVPV_DUP;
10454 SvRV_set(dstr, SvWEAKREF(sstr)
10455 ? sv_dup(SvRV(sstr), param)
10456 : sv_dup_inc(SvRV(sstr), param));
10459 else if (SvPVX_const(sstr)) {
10460 /* Has something there */
10462 /* Normal PV - clone whole allocated space */
10463 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10464 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10465 /* Not that normal - actually sstr is copy on write.
10466 But we are a true, independant SV, so: */
10467 SvREADONLY_off(dstr);
10472 /* Special case - not normally malloced for some reason */
10473 if (isGV_with_GP(sstr)) {
10474 /* Don't need to do anything here. */
10476 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10477 /* A "shared" PV - clone it as "shared" PV */
10479 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10483 /* Some other special case - random pointer */
10484 SvPV_set(dstr, SvPVX(sstr));
10489 /* Copy the NULL */
10490 SvPV_set(dstr, NULL);
10494 /* duplicate an SV of any type (including AV, HV etc) */
10497 Perl_sv_dup(pTHX_ const SV *const sstr, CLONE_PARAMS *const param)
10502 PERL_ARGS_ASSERT_SV_DUP;
10506 if (SvTYPE(sstr) == SVTYPEMASK) {
10507 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10512 /* look for it in the table first */
10513 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10517 if(param->flags & CLONEf_JOIN_IN) {
10518 /** We are joining here so we don't want do clone
10519 something that is bad **/
10520 if (SvTYPE(sstr) == SVt_PVHV) {
10521 const HEK * const hvname = HvNAME_HEK(sstr);
10523 /** don't clone stashes if they already exist **/
10524 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10528 /* create anew and remember what it is */
10531 #ifdef DEBUG_LEAKING_SCALARS
10532 dstr->sv_debug_optype = sstr->sv_debug_optype;
10533 dstr->sv_debug_line = sstr->sv_debug_line;
10534 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10535 dstr->sv_debug_cloned = 1;
10536 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10539 ptr_table_store(PL_ptr_table, sstr, dstr);
10542 SvFLAGS(dstr) = SvFLAGS(sstr);
10543 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10544 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10547 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10548 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10549 (void*)PL_watch_pvx, SvPVX_const(sstr));
10552 /* don't clone objects whose class has asked us not to */
10553 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10558 switch (SvTYPE(sstr)) {
10560 SvANY(dstr) = NULL;
10563 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10565 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10567 SvIV_set(dstr, SvIVX(sstr));
10571 SvANY(dstr) = new_XNV();
10572 SvNV_set(dstr, SvNVX(sstr));
10574 /* case SVt_BIND: */
10577 /* These are all the types that need complex bodies allocating. */
10579 const svtype sv_type = SvTYPE(sstr);
10580 const struct body_details *const sv_type_details
10581 = bodies_by_type + sv_type;
10585 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10589 if (GvUNIQUE((GV*)sstr)) {
10590 NOOP; /* Do sharing here, and fall through */
10603 assert(sv_type_details->body_size);
10604 if (sv_type_details->arena) {
10605 new_body_inline(new_body, sv_type);
10607 = (void*)((char*)new_body - sv_type_details->offset);
10609 new_body = new_NOARENA(sv_type_details);
10613 SvANY(dstr) = new_body;
10616 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10617 ((char*)SvANY(dstr)) + sv_type_details->offset,
10618 sv_type_details->copy, char);
10620 Copy(((char*)SvANY(sstr)),
10621 ((char*)SvANY(dstr)),
10622 sv_type_details->body_size + sv_type_details->offset, char);
10625 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10626 && !isGV_with_GP(dstr))
10627 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10629 /* The Copy above means that all the source (unduplicated) pointers
10630 are now in the destination. We can check the flags and the
10631 pointers in either, but it's possible that there's less cache
10632 missing by always going for the destination.
10633 FIXME - instrument and check that assumption */
10634 if (sv_type >= SVt_PVMG) {
10635 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10636 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10637 } else if (SvMAGIC(dstr))
10638 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10640 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10643 /* The cast silences a GCC warning about unhandled types. */
10644 switch ((int)sv_type) {
10654 /* FIXME for plugins */
10655 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10658 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10659 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10660 LvTARG(dstr) = dstr;
10661 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10662 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10664 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10666 if(isGV_with_GP(sstr)) {
10667 if (GvNAME_HEK(dstr))
10668 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10669 /* Don't call sv_add_backref here as it's going to be
10670 created as part of the magic cloning of the symbol
10672 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10673 at the point of this comment. */
10674 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10675 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10676 (void)GpREFCNT_inc(GvGP(dstr));
10678 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10681 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10682 if (IoOFP(dstr) == IoIFP(sstr))
10683 IoOFP(dstr) = IoIFP(dstr);
10685 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10686 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10687 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10688 /* I have no idea why fake dirp (rsfps)
10689 should be treated differently but otherwise
10690 we end up with leaks -- sky*/
10691 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10692 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10693 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10695 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10696 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10697 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10698 if (IoDIRP(dstr)) {
10699 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10702 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10705 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10706 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10707 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10710 if (AvARRAY((AV*)sstr)) {
10711 SV **dst_ary, **src_ary;
10712 SSize_t items = AvFILLp((AV*)sstr) + 1;
10714 src_ary = AvARRAY((AV*)sstr);
10715 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10716 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10717 AvARRAY((AV*)dstr) = dst_ary;
10718 AvALLOC((AV*)dstr) = dst_ary;
10719 if (AvREAL((AV*)sstr)) {
10720 while (items-- > 0)
10721 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10724 while (items-- > 0)
10725 *dst_ary++ = sv_dup(*src_ary++, param);
10727 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10728 while (items-- > 0) {
10729 *dst_ary++ = &PL_sv_undef;
10733 AvARRAY((AV*)dstr) = NULL;
10734 AvALLOC((AV*)dstr) = (SV**)NULL;
10738 if (HvARRAY((HV*)sstr)) {
10740 const bool sharekeys = !!HvSHAREKEYS(sstr);
10741 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10742 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10744 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10745 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10747 HvARRAY(dstr) = (HE**)darray;
10748 while (i <= sxhv->xhv_max) {
10749 const HE * const source = HvARRAY(sstr)[i];
10750 HvARRAY(dstr)[i] = source
10751 ? he_dup(source, sharekeys, param) : 0;
10756 const struct xpvhv_aux * const saux = HvAUX(sstr);
10757 struct xpvhv_aux * const daux = HvAUX(dstr);
10758 /* This flag isn't copied. */
10759 /* SvOOK_on(hv) attacks the IV flags. */
10760 SvFLAGS(dstr) |= SVf_OOK;
10762 hvname = saux->xhv_name;
10763 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10765 daux->xhv_riter = saux->xhv_riter;
10766 daux->xhv_eiter = saux->xhv_eiter
10767 ? he_dup(saux->xhv_eiter,
10768 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10769 daux->xhv_backreferences =
10770 saux->xhv_backreferences
10771 ? (AV*) SvREFCNT_inc(
10772 sv_dup((SV*)saux->xhv_backreferences, param))
10775 daux->xhv_mro_meta = saux->xhv_mro_meta
10776 ? mro_meta_dup(saux->xhv_mro_meta, param)
10779 /* Record stashes for possible cloning in Perl_clone(). */
10781 av_push(param->stashes, dstr);
10785 HvARRAY((HV*)dstr) = NULL;
10788 if (!(param->flags & CLONEf_COPY_STACKS)) {
10792 /* NOTE: not refcounted */
10793 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10795 if (!CvISXSUB(dstr))
10796 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10798 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10799 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10800 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10801 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10803 /* don't dup if copying back - CvGV isn't refcounted, so the
10804 * duped GV may never be freed. A bit of a hack! DAPM */
10805 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10806 NULL : gv_dup(CvGV(dstr), param) ;
10807 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10809 CvWEAKOUTSIDE(sstr)
10810 ? cv_dup( CvOUTSIDE(dstr), param)
10811 : cv_dup_inc(CvOUTSIDE(dstr), param);
10812 if (!CvISXSUB(dstr))
10813 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10819 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10825 /* duplicate a context */
10828 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10830 PERL_CONTEXT *ncxs;
10832 PERL_ARGS_ASSERT_CX_DUP;
10835 return (PERL_CONTEXT*)NULL;
10837 /* look for it in the table first */
10838 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10842 /* create anew and remember what it is */
10843 Newx(ncxs, max + 1, PERL_CONTEXT);
10844 ptr_table_store(PL_ptr_table, cxs, ncxs);
10845 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10848 PERL_CONTEXT * const ncx = &ncxs[ix];
10849 if (CxTYPE(ncx) == CXt_SUBST) {
10850 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10853 switch (CxTYPE(ncx)) {
10855 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10856 ? cv_dup_inc(ncx->blk_sub.cv, param)
10857 : cv_dup(ncx->blk_sub.cv,param));
10858 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10859 ? av_dup_inc(ncx->blk_sub.argarray,
10862 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10864 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10865 ncx->blk_sub.oldcomppad);
10868 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10870 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10872 case CXt_LOOP_LAZYSV:
10873 ncx->blk_loop.state_u.lazysv.end
10874 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10875 /* We are taking advantage of av_dup_inc and sv_dup_inc
10876 actually being the same function, and order equivalance of
10878 We can assert the later [but only at run time :-(] */
10879 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10880 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10882 ncx->blk_loop.state_u.ary.ary
10883 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10884 case CXt_LOOP_LAZYIV:
10885 case CXt_LOOP_PLAIN:
10886 if (CxPADLOOP(ncx)) {
10887 ncx->blk_loop.oldcomppad
10888 = (PAD*)ptr_table_fetch(PL_ptr_table,
10889 ncx->blk_loop.oldcomppad);
10891 ncx->blk_loop.oldcomppad
10892 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10896 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10897 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10898 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10911 /* duplicate a stack info structure */
10914 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10918 PERL_ARGS_ASSERT_SI_DUP;
10921 return (PERL_SI*)NULL;
10923 /* look for it in the table first */
10924 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10928 /* create anew and remember what it is */
10929 Newxz(nsi, 1, PERL_SI);
10930 ptr_table_store(PL_ptr_table, si, nsi);
10932 nsi->si_stack = av_dup_inc(si->si_stack, param);
10933 nsi->si_cxix = si->si_cxix;
10934 nsi->si_cxmax = si->si_cxmax;
10935 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10936 nsi->si_type = si->si_type;
10937 nsi->si_prev = si_dup(si->si_prev, param);
10938 nsi->si_next = si_dup(si->si_next, param);
10939 nsi->si_markoff = si->si_markoff;
10944 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10945 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10946 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10947 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10948 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10949 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10950 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10951 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10952 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10953 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10954 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10955 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10956 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10957 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10960 #define pv_dup_inc(p) SAVEPV(p)
10961 #define pv_dup(p) SAVEPV(p)
10962 #define svp_dup_inc(p,pp) any_dup(p,pp)
10964 /* map any object to the new equivent - either something in the
10965 * ptr table, or something in the interpreter structure
10969 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10973 PERL_ARGS_ASSERT_ANY_DUP;
10976 return (void*)NULL;
10978 /* look for it in the table first */
10979 ret = ptr_table_fetch(PL_ptr_table, v);
10983 /* see if it is part of the interpreter structure */
10984 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10985 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10993 /* duplicate the save stack */
10996 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10999 ANY * const ss = proto_perl->Isavestack;
11000 const I32 max = proto_perl->Isavestack_max;
11001 I32 ix = proto_perl->Isavestack_ix;
11014 void (*dptr) (void*);
11015 void (*dxptr) (pTHX_ void*);
11017 PERL_ARGS_ASSERT_SS_DUP;
11019 Newxz(nss, max, ANY);
11022 const I32 type = POPINT(ss,ix);
11023 TOPINT(nss,ix) = type;
11025 case SAVEt_HELEM: /* hash element */
11026 sv = (SV*)POPPTR(ss,ix);
11027 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11029 case SAVEt_ITEM: /* normal string */
11030 case SAVEt_SV: /* scalar reference */
11031 sv = (SV*)POPPTR(ss,ix);
11032 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11035 case SAVEt_MORTALIZESV:
11036 sv = (SV*)POPPTR(ss,ix);
11037 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11039 case SAVEt_SHARED_PVREF: /* char* in shared space */
11040 c = (char*)POPPTR(ss,ix);
11041 TOPPTR(nss,ix) = savesharedpv(c);
11042 ptr = POPPTR(ss,ix);
11043 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11045 case SAVEt_GENERIC_SVREF: /* generic sv */
11046 case SAVEt_SVREF: /* scalar reference */
11047 sv = (SV*)POPPTR(ss,ix);
11048 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11049 ptr = POPPTR(ss,ix);
11050 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11052 case SAVEt_HV: /* hash reference */
11053 case SAVEt_AV: /* array reference */
11054 sv = (SV*) POPPTR(ss,ix);
11055 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11057 case SAVEt_COMPPAD:
11059 sv = (SV*) POPPTR(ss,ix);
11060 TOPPTR(nss,ix) = sv_dup(sv, param);
11062 case SAVEt_INT: /* int reference */
11063 ptr = POPPTR(ss,ix);
11064 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11065 intval = (int)POPINT(ss,ix);
11066 TOPINT(nss,ix) = intval;
11068 case SAVEt_LONG: /* long reference */
11069 ptr = POPPTR(ss,ix);
11070 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11072 case SAVEt_CLEARSV:
11073 longval = (long)POPLONG(ss,ix);
11074 TOPLONG(nss,ix) = longval;
11076 case SAVEt_I32: /* I32 reference */
11077 case SAVEt_I16: /* I16 reference */
11078 case SAVEt_I8: /* I8 reference */
11079 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
11080 ptr = POPPTR(ss,ix);
11081 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11083 TOPINT(nss,ix) = i;
11085 case SAVEt_IV: /* IV reference */
11086 ptr = POPPTR(ss,ix);
11087 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11089 TOPIV(nss,ix) = iv;
11091 case SAVEt_HPTR: /* HV* reference */
11092 case SAVEt_APTR: /* AV* reference */
11093 case SAVEt_SPTR: /* SV* reference */
11094 ptr = POPPTR(ss,ix);
11095 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11096 sv = (SV*)POPPTR(ss,ix);
11097 TOPPTR(nss,ix) = sv_dup(sv, param);
11099 case SAVEt_VPTR: /* random* reference */
11100 ptr = POPPTR(ss,ix);
11101 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11102 ptr = POPPTR(ss,ix);
11103 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11105 case SAVEt_GENERIC_PVREF: /* generic char* */
11106 case SAVEt_PPTR: /* char* reference */
11107 ptr = POPPTR(ss,ix);
11108 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11109 c = (char*)POPPTR(ss,ix);
11110 TOPPTR(nss,ix) = pv_dup(c);
11112 case SAVEt_GP: /* scalar reference */
11113 gp = (GP*)POPPTR(ss,ix);
11114 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11115 (void)GpREFCNT_inc(gp);
11116 gv = (GV*)POPPTR(ss,ix);
11117 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11120 ptr = POPPTR(ss,ix);
11121 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11122 /* these are assumed to be refcounted properly */
11124 switch (((OP*)ptr)->op_type) {
11126 case OP_LEAVESUBLV:
11130 case OP_LEAVEWRITE:
11131 TOPPTR(nss,ix) = ptr;
11134 (void) OpREFCNT_inc(o);
11138 TOPPTR(nss,ix) = NULL;
11143 TOPPTR(nss,ix) = NULL;
11146 c = (char*)POPPTR(ss,ix);
11147 TOPPTR(nss,ix) = pv_dup_inc(c);
11150 hv = (HV*)POPPTR(ss,ix);
11151 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11152 c = (char*)POPPTR(ss,ix);
11153 TOPPTR(nss,ix) = pv_dup_inc(c);
11155 case SAVEt_STACK_POS: /* Position on Perl stack */
11157 TOPINT(nss,ix) = i;
11159 case SAVEt_DESTRUCTOR:
11160 ptr = POPPTR(ss,ix);
11161 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11162 dptr = POPDPTR(ss,ix);
11163 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
11164 any_dup(FPTR2DPTR(void *, dptr),
11167 case SAVEt_DESTRUCTOR_X:
11168 ptr = POPPTR(ss,ix);
11169 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11170 dxptr = POPDXPTR(ss,ix);
11171 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
11172 any_dup(FPTR2DPTR(void *, dxptr),
11175 case SAVEt_REGCONTEXT:
11178 TOPINT(nss,ix) = i;
11181 case SAVEt_AELEM: /* array element */
11182 sv = (SV*)POPPTR(ss,ix);
11183 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11185 TOPINT(nss,ix) = i;
11186 av = (AV*)POPPTR(ss,ix);
11187 TOPPTR(nss,ix) = av_dup_inc(av, param);
11190 ptr = POPPTR(ss,ix);
11191 TOPPTR(nss,ix) = ptr;
11195 TOPINT(nss,ix) = i;
11196 ptr = POPPTR(ss,ix);
11199 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
11200 HINTS_REFCNT_UNLOCK;
11202 TOPPTR(nss,ix) = ptr;
11203 if (i & HINT_LOCALIZE_HH) {
11204 hv = (HV*)POPPTR(ss,ix);
11205 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11208 case SAVEt_PADSV_AND_MORTALIZE:
11209 longval = (long)POPLONG(ss,ix);
11210 TOPLONG(nss,ix) = longval;
11211 ptr = POPPTR(ss,ix);
11212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11213 sv = (SV*)POPPTR(ss,ix);
11214 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11217 ptr = POPPTR(ss,ix);
11218 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11219 longval = (long)POPBOOL(ss,ix);
11220 TOPBOOL(nss,ix) = (bool)longval;
11222 case SAVEt_SET_SVFLAGS:
11224 TOPINT(nss,ix) = i;
11226 TOPINT(nss,ix) = i;
11227 sv = (SV*)POPPTR(ss,ix);
11228 TOPPTR(nss,ix) = sv_dup(sv, param);
11230 case SAVEt_RE_STATE:
11232 const struct re_save_state *const old_state
11233 = (struct re_save_state *)
11234 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11235 struct re_save_state *const new_state
11236 = (struct re_save_state *)
11237 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
11239 Copy(old_state, new_state, 1, struct re_save_state);
11240 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
11242 new_state->re_state_bostr
11243 = pv_dup(old_state->re_state_bostr);
11244 new_state->re_state_reginput
11245 = pv_dup(old_state->re_state_reginput);
11246 new_state->re_state_regeol
11247 = pv_dup(old_state->re_state_regeol);
11248 new_state->re_state_regoffs
11249 = (regexp_paren_pair*)
11250 any_dup(old_state->re_state_regoffs, proto_perl);
11251 new_state->re_state_reglastparen
11252 = (U32*) any_dup(old_state->re_state_reglastparen,
11254 new_state->re_state_reglastcloseparen
11255 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
11257 /* XXX This just has to be broken. The old save_re_context
11258 code did SAVEGENERICPV(PL_reg_start_tmp);
11259 PL_reg_start_tmp is char **.
11260 Look above to what the dup code does for
11261 SAVEt_GENERIC_PVREF
11262 It can never have worked.
11263 So this is merely a faithful copy of the exiting bug: */
11264 new_state->re_state_reg_start_tmp
11265 = (char **) pv_dup((char *)
11266 old_state->re_state_reg_start_tmp);
11267 /* I assume that it only ever "worked" because no-one called
11268 (pseudo)fork while the regexp engine had re-entered itself.
11270 #ifdef PERL_OLD_COPY_ON_WRITE
11271 new_state->re_state_nrs
11272 = sv_dup(old_state->re_state_nrs, param);
11274 new_state->re_state_reg_magic
11275 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
11277 new_state->re_state_reg_oldcurpm
11278 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
11280 new_state->re_state_reg_curpm
11281 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
11283 new_state->re_state_reg_oldsaved
11284 = pv_dup(old_state->re_state_reg_oldsaved);
11285 new_state->re_state_reg_poscache
11286 = pv_dup(old_state->re_state_reg_poscache);
11287 new_state->re_state_reg_starttry
11288 = pv_dup(old_state->re_state_reg_starttry);
11291 case SAVEt_COMPILE_WARNINGS:
11292 ptr = POPPTR(ss,ix);
11293 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
11296 ptr = POPPTR(ss,ix);
11297 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
11301 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
11309 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11310 * flag to the result. This is done for each stash before cloning starts,
11311 * so we know which stashes want their objects cloned */
11314 do_mark_cloneable_stash(pTHX_ SV *const sv)
11316 const HEK * const hvname = HvNAME_HEK((HV*)sv);
11318 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11319 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11320 if (cloner && GvCV(cloner)) {
11327 mXPUSHs(newSVhek(hvname));
11329 call_sv((SV*)GvCV(cloner), G_SCALAR);
11336 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11344 =for apidoc perl_clone
11346 Create and return a new interpreter by cloning the current one.
11348 perl_clone takes these flags as parameters:
11350 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11351 without it we only clone the data and zero the stacks,
11352 with it we copy the stacks and the new perl interpreter is
11353 ready to run at the exact same point as the previous one.
11354 The pseudo-fork code uses COPY_STACKS while the
11355 threads->create doesn't.
11357 CLONEf_KEEP_PTR_TABLE
11358 perl_clone keeps a ptr_table with the pointer of the old
11359 variable as a key and the new variable as a value,
11360 this allows it to check if something has been cloned and not
11361 clone it again but rather just use the value and increase the
11362 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11363 the ptr_table using the function
11364 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11365 reason to keep it around is if you want to dup some of your own
11366 variable who are outside the graph perl scans, example of this
11367 code is in threads.xs create
11370 This is a win32 thing, it is ignored on unix, it tells perls
11371 win32host code (which is c++) to clone itself, this is needed on
11372 win32 if you want to run two threads at the same time,
11373 if you just want to do some stuff in a separate perl interpreter
11374 and then throw it away and return to the original one,
11375 you don't need to do anything.
11380 /* XXX the above needs expanding by someone who actually understands it ! */
11381 EXTERN_C PerlInterpreter *
11382 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11385 perl_clone(PerlInterpreter *proto_perl, UV flags)
11388 #ifdef PERL_IMPLICIT_SYS
11390 PERL_ARGS_ASSERT_PERL_CLONE;
11392 /* perlhost.h so we need to call into it
11393 to clone the host, CPerlHost should have a c interface, sky */
11395 if (flags & CLONEf_CLONE_HOST) {
11396 return perl_clone_host(proto_perl,flags);
11398 return perl_clone_using(proto_perl, flags,
11400 proto_perl->IMemShared,
11401 proto_perl->IMemParse,
11403 proto_perl->IStdIO,
11407 proto_perl->IProc);
11411 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11412 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11413 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11414 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11415 struct IPerlDir* ipD, struct IPerlSock* ipS,
11416 struct IPerlProc* ipP)
11418 /* XXX many of the string copies here can be optimized if they're
11419 * constants; they need to be allocated as common memory and just
11420 * their pointers copied. */
11423 CLONE_PARAMS clone_params;
11424 CLONE_PARAMS* const param = &clone_params;
11426 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11428 PERL_ARGS_ASSERT_PERL_CLONE_USING;
11430 /* for each stash, determine whether its objects should be cloned */
11431 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11432 PERL_SET_THX(my_perl);
11435 PoisonNew(my_perl, 1, PerlInterpreter);
11441 PL_savestack_ix = 0;
11442 PL_savestack_max = -1;
11443 PL_sig_pending = 0;
11445 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11446 # else /* !DEBUGGING */
11447 Zero(my_perl, 1, PerlInterpreter);
11448 # endif /* DEBUGGING */
11450 /* host pointers */
11452 PL_MemShared = ipMS;
11453 PL_MemParse = ipMP;
11460 #else /* !PERL_IMPLICIT_SYS */
11462 CLONE_PARAMS clone_params;
11463 CLONE_PARAMS* param = &clone_params;
11464 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11466 PERL_ARGS_ASSERT_PERL_CLONE;
11468 /* for each stash, determine whether its objects should be cloned */
11469 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11470 PERL_SET_THX(my_perl);
11473 PoisonNew(my_perl, 1, PerlInterpreter);
11479 PL_savestack_ix = 0;
11480 PL_savestack_max = -1;
11481 PL_sig_pending = 0;
11483 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11484 # else /* !DEBUGGING */
11485 Zero(my_perl, 1, PerlInterpreter);
11486 # endif /* DEBUGGING */
11487 #endif /* PERL_IMPLICIT_SYS */
11488 param->flags = flags;
11489 param->proto_perl = proto_perl;
11491 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11493 PL_body_arenas = NULL;
11494 Zero(&PL_body_roots, 1, PL_body_roots);
11496 PL_nice_chunk = NULL;
11497 PL_nice_chunk_size = 0;
11499 PL_sv_objcount = 0;
11501 PL_sv_arenaroot = NULL;
11503 PL_debug = proto_perl->Idebug;
11505 PL_hash_seed = proto_perl->Ihash_seed;
11506 PL_rehash_seed = proto_perl->Irehash_seed;
11508 #ifdef USE_REENTRANT_API
11509 /* XXX: things like -Dm will segfault here in perlio, but doing
11510 * PERL_SET_CONTEXT(proto_perl);
11511 * breaks too many other things
11513 Perl_reentrant_init(aTHX);
11516 /* create SV map for pointer relocation */
11517 PL_ptr_table = ptr_table_new();
11519 /* initialize these special pointers as early as possible */
11520 SvANY(&PL_sv_undef) = NULL;
11521 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11522 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11523 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11525 SvANY(&PL_sv_no) = new_XPVNV();
11526 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11527 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11528 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11529 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11530 SvCUR_set(&PL_sv_no, 0);
11531 SvLEN_set(&PL_sv_no, 1);
11532 SvIV_set(&PL_sv_no, 0);
11533 SvNV_set(&PL_sv_no, 0);
11534 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11536 SvANY(&PL_sv_yes) = new_XPVNV();
11537 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11538 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11539 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11540 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11541 SvCUR_set(&PL_sv_yes, 1);
11542 SvLEN_set(&PL_sv_yes, 2);
11543 SvIV_set(&PL_sv_yes, 1);
11544 SvNV_set(&PL_sv_yes, 1);
11545 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11547 /* create (a non-shared!) shared string table */
11548 PL_strtab = newHV();
11549 HvSHAREKEYS_off(PL_strtab);
11550 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11551 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11553 PL_compiling = proto_perl->Icompiling;
11555 /* These two PVs will be free'd special way so must set them same way op.c does */
11556 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11557 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11559 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11560 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11562 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11563 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11564 if (PL_compiling.cop_hints_hash) {
11566 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11567 HINTS_REFCNT_UNLOCK;
11569 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11570 #ifdef PERL_DEBUG_READONLY_OPS
11575 /* pseudo environmental stuff */
11576 PL_origargc = proto_perl->Iorigargc;
11577 PL_origargv = proto_perl->Iorigargv;
11579 param->stashes = newAV(); /* Setup array of objects to call clone on */
11581 /* Set tainting stuff before PerlIO_debug can possibly get called */
11582 PL_tainting = proto_perl->Itainting;
11583 PL_taint_warn = proto_perl->Itaint_warn;
11585 #ifdef PERLIO_LAYERS
11586 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11587 PerlIO_clone(aTHX_ proto_perl, param);
11590 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11591 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11592 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11593 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11594 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11595 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11598 PL_minus_c = proto_perl->Iminus_c;
11599 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11600 PL_localpatches = proto_perl->Ilocalpatches;
11601 PL_splitstr = proto_perl->Isplitstr;
11602 PL_minus_n = proto_perl->Iminus_n;
11603 PL_minus_p = proto_perl->Iminus_p;
11604 PL_minus_l = proto_perl->Iminus_l;
11605 PL_minus_a = proto_perl->Iminus_a;
11606 PL_minus_E = proto_perl->Iminus_E;
11607 PL_minus_F = proto_perl->Iminus_F;
11608 PL_doswitches = proto_perl->Idoswitches;
11609 PL_dowarn = proto_perl->Idowarn;
11610 PL_doextract = proto_perl->Idoextract;
11611 PL_sawampersand = proto_perl->Isawampersand;
11612 PL_unsafe = proto_perl->Iunsafe;
11613 PL_inplace = SAVEPV(proto_perl->Iinplace);
11614 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11615 PL_perldb = proto_perl->Iperldb;
11616 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11617 PL_exit_flags = proto_perl->Iexit_flags;
11619 /* magical thingies */
11620 /* XXX time(&PL_basetime) when asked for? */
11621 PL_basetime = proto_perl->Ibasetime;
11622 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11624 PL_maxsysfd = proto_perl->Imaxsysfd;
11625 PL_statusvalue = proto_perl->Istatusvalue;
11627 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11629 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11631 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11633 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11634 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11635 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11638 /* RE engine related */
11639 Zero(&PL_reg_state, 1, struct re_save_state);
11640 PL_reginterp_cnt = 0;
11641 PL_regmatch_slab = NULL;
11643 /* Clone the regex array */
11644 /* ORANGE FIXME for plugins, probably in the SV dup code.
11645 newSViv(PTR2IV(CALLREGDUPE(
11646 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11648 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11649 PL_regex_pad = AvARRAY(PL_regex_padav);
11651 /* shortcuts to various I/O objects */
11652 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11653 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11654 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11655 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11656 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11657 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11659 /* shortcuts to regexp stuff */
11660 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11662 /* shortcuts to misc objects */
11663 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11665 /* shortcuts to debugging objects */
11666 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11667 PL_DBline = gv_dup(proto_perl->IDBline, param);
11668 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11669 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11670 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11671 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11672 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11674 /* symbol tables */
11675 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11676 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11677 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11678 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11679 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11681 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11682 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11683 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11684 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11685 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11686 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11687 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11688 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11690 PL_sub_generation = proto_perl->Isub_generation;
11691 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11693 /* funky return mechanisms */
11694 PL_forkprocess = proto_perl->Iforkprocess;
11696 /* subprocess state */
11697 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11699 /* internal state */
11700 PL_maxo = proto_perl->Imaxo;
11701 if (proto_perl->Iop_mask)
11702 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11705 /* PL_asserting = proto_perl->Iasserting; */
11707 /* current interpreter roots */
11708 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11710 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11712 PL_main_start = proto_perl->Imain_start;
11713 PL_eval_root = proto_perl->Ieval_root;
11714 PL_eval_start = proto_perl->Ieval_start;
11716 /* runtime control stuff */
11717 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11719 PL_filemode = proto_perl->Ifilemode;
11720 PL_lastfd = proto_perl->Ilastfd;
11721 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11724 PL_gensym = proto_perl->Igensym;
11725 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11726 PL_laststatval = proto_perl->Ilaststatval;
11727 PL_laststype = proto_perl->Ilaststype;
11730 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11732 /* interpreter atexit processing */
11733 PL_exitlistlen = proto_perl->Iexitlistlen;
11734 if (PL_exitlistlen) {
11735 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11736 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11739 PL_exitlist = (PerlExitListEntry*)NULL;
11741 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11742 if (PL_my_cxt_size) {
11743 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11744 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11745 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11746 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11747 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11751 PL_my_cxt_list = (void**)NULL;
11752 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11753 PL_my_cxt_keys = (const char**)NULL;
11756 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11757 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11758 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11760 PL_profiledata = NULL;
11762 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11764 PAD_CLONE_VARS(proto_perl, param);
11766 #ifdef HAVE_INTERP_INTERN
11767 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11770 /* more statics moved here */
11771 PL_generation = proto_perl->Igeneration;
11772 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11774 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11775 PL_in_clean_all = proto_perl->Iin_clean_all;
11777 PL_uid = proto_perl->Iuid;
11778 PL_euid = proto_perl->Ieuid;
11779 PL_gid = proto_perl->Igid;
11780 PL_egid = proto_perl->Iegid;
11781 PL_nomemok = proto_perl->Inomemok;
11782 PL_an = proto_perl->Ian;
11783 PL_evalseq = proto_perl->Ievalseq;
11784 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11785 PL_origalen = proto_perl->Iorigalen;
11786 #ifdef PERL_USES_PL_PIDSTATUS
11787 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11789 PL_osname = SAVEPV(proto_perl->Iosname);
11790 PL_sighandlerp = proto_perl->Isighandlerp;
11792 PL_runops = proto_perl->Irunops;
11794 PL_parser = parser_dup(proto_perl->Iparser, param);
11796 PL_subline = proto_perl->Isubline;
11797 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11800 PL_cryptseen = proto_perl->Icryptseen;
11803 PL_hints = proto_perl->Ihints;
11805 PL_amagic_generation = proto_perl->Iamagic_generation;
11807 #ifdef USE_LOCALE_COLLATE
11808 PL_collation_ix = proto_perl->Icollation_ix;
11809 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11810 PL_collation_standard = proto_perl->Icollation_standard;
11811 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11812 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11813 #endif /* USE_LOCALE_COLLATE */
11815 #ifdef USE_LOCALE_NUMERIC
11816 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11817 PL_numeric_standard = proto_perl->Inumeric_standard;
11818 PL_numeric_local = proto_perl->Inumeric_local;
11819 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11820 #endif /* !USE_LOCALE_NUMERIC */
11822 /* utf8 character classes */
11823 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11824 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11825 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11826 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11827 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11828 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11829 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11830 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11831 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11832 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11833 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11834 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11835 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11836 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11837 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11838 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11839 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11840 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11841 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11842 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11844 /* Did the locale setup indicate UTF-8? */
11845 PL_utf8locale = proto_perl->Iutf8locale;
11846 /* Unicode features (see perlrun/-C) */
11847 PL_unicode = proto_perl->Iunicode;
11849 /* Pre-5.8 signals control */
11850 PL_signals = proto_perl->Isignals;
11852 /* times() ticks per second */
11853 PL_clocktick = proto_perl->Iclocktick;
11855 /* Recursion stopper for PerlIO_find_layer */
11856 PL_in_load_module = proto_perl->Iin_load_module;
11858 /* sort() routine */
11859 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11861 /* Not really needed/useful since the reenrant_retint is "volatile",
11862 * but do it for consistency's sake. */
11863 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11865 /* Hooks to shared SVs and locks. */
11866 PL_sharehook = proto_perl->Isharehook;
11867 PL_lockhook = proto_perl->Ilockhook;
11868 PL_unlockhook = proto_perl->Iunlockhook;
11869 PL_threadhook = proto_perl->Ithreadhook;
11870 PL_destroyhook = proto_perl->Idestroyhook;
11872 #ifdef THREADS_HAVE_PIDS
11873 PL_ppid = proto_perl->Ippid;
11877 PL_last_swash_hv = NULL; /* reinits on demand */
11878 PL_last_swash_klen = 0;
11879 PL_last_swash_key[0]= '\0';
11880 PL_last_swash_tmps = (U8*)NULL;
11881 PL_last_swash_slen = 0;
11883 PL_glob_index = proto_perl->Iglob_index;
11884 PL_srand_called = proto_perl->Isrand_called;
11885 PL_bitcount = NULL; /* reinits on demand */
11887 if (proto_perl->Ipsig_pend) {
11888 Newxz(PL_psig_pend, SIG_SIZE, int);
11891 PL_psig_pend = (int*)NULL;
11894 if (proto_perl->Ipsig_ptr) {
11895 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11896 Newxz(PL_psig_name, SIG_SIZE, SV*);
11897 for (i = 1; i < SIG_SIZE; i++) {
11898 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11899 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11903 PL_psig_ptr = (SV**)NULL;
11904 PL_psig_name = (SV**)NULL;
11907 /* intrpvar.h stuff */
11909 if (flags & CLONEf_COPY_STACKS) {
11910 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11911 PL_tmps_ix = proto_perl->Itmps_ix;
11912 PL_tmps_max = proto_perl->Itmps_max;
11913 PL_tmps_floor = proto_perl->Itmps_floor;
11914 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11916 while (i <= PL_tmps_ix) {
11917 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11921 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11922 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11923 Newxz(PL_markstack, i, I32);
11924 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11925 - proto_perl->Imarkstack);
11926 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11927 - proto_perl->Imarkstack);
11928 Copy(proto_perl->Imarkstack, PL_markstack,
11929 PL_markstack_ptr - PL_markstack + 1, I32);
11931 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11932 * NOTE: unlike the others! */
11933 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11934 PL_scopestack_max = proto_perl->Iscopestack_max;
11935 Newxz(PL_scopestack, PL_scopestack_max, I32);
11936 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11938 /* NOTE: si_dup() looks at PL_markstack */
11939 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11941 /* PL_curstack = PL_curstackinfo->si_stack; */
11942 PL_curstack = av_dup(proto_perl->Icurstack, param);
11943 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11945 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11946 PL_stack_base = AvARRAY(PL_curstack);
11947 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11948 - proto_perl->Istack_base);
11949 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11951 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11952 * NOTE: unlike the others! */
11953 PL_savestack_ix = proto_perl->Isavestack_ix;
11954 PL_savestack_max = proto_perl->Isavestack_max;
11955 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11956 PL_savestack = ss_dup(proto_perl, param);
11960 ENTER; /* perl_destruct() wants to LEAVE; */
11962 /* although we're not duplicating the tmps stack, we should still
11963 * add entries for any SVs on the tmps stack that got cloned by a
11964 * non-refcount means (eg a temp in @_); otherwise they will be
11967 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11968 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11969 proto_perl->Itmps_stack[i]);
11970 if (nsv && !SvREFCNT(nsv)) {
11972 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11977 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11978 PL_top_env = &PL_start_env;
11980 PL_op = proto_perl->Iop;
11983 PL_Xpv = (XPV*)NULL;
11984 my_perl->Ina = proto_perl->Ina;
11986 PL_statbuf = proto_perl->Istatbuf;
11987 PL_statcache = proto_perl->Istatcache;
11988 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11989 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11991 PL_timesbuf = proto_perl->Itimesbuf;
11994 PL_tainted = proto_perl->Itainted;
11995 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11996 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11997 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11998 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11999 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
12000 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
12001 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
12002 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
12003 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
12005 PL_restartop = proto_perl->Irestartop;
12006 PL_in_eval = proto_perl->Iin_eval;
12007 PL_delaymagic = proto_perl->Idelaymagic;
12008 PL_dirty = proto_perl->Idirty;
12009 PL_localizing = proto_perl->Ilocalizing;
12011 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
12012 PL_hv_fetch_ent_mh = NULL;
12013 PL_modcount = proto_perl->Imodcount;
12014 PL_lastgotoprobe = NULL;
12015 PL_dumpindent = proto_perl->Idumpindent;
12017 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
12018 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
12019 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
12020 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
12021 PL_efloatbuf = NULL; /* reinits on demand */
12022 PL_efloatsize = 0; /* reinits on demand */
12026 PL_screamfirst = NULL;
12027 PL_screamnext = NULL;
12028 PL_maxscream = -1; /* reinits on demand */
12029 PL_lastscream = NULL;
12032 PL_regdummy = proto_perl->Iregdummy;
12033 PL_colorset = 0; /* reinits PL_colors[] */
12034 /*PL_colors[6] = {0,0,0,0,0,0};*/
12038 /* Pluggable optimizer */
12039 PL_peepp = proto_perl->Ipeepp;
12041 PL_stashcache = newHV();
12043 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
12044 proto_perl->Iwatchaddr);
12045 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
12046 if (PL_debug && PL_watchaddr) {
12047 PerlIO_printf(Perl_debug_log,
12048 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
12049 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
12050 PTR2UV(PL_watchok));
12053 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12054 ptr_table_free(PL_ptr_table);
12055 PL_ptr_table = NULL;
12058 /* Call the ->CLONE method, if it exists, for each of the stashes
12059 identified by sv_dup() above.
12061 while(av_len(param->stashes) != -1) {
12062 HV* const stash = (HV*) av_shift(param->stashes);
12063 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12064 if (cloner && GvCV(cloner)) {
12069 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
12071 call_sv((SV*)GvCV(cloner), G_DISCARD);
12077 SvREFCNT_dec(param->stashes);
12079 /* orphaned? eg threads->new inside BEGIN or use */
12080 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
12081 SvREFCNT_inc_simple_void(PL_compcv);
12082 SAVEFREESV(PL_compcv);
12088 #endif /* USE_ITHREADS */
12091 =head1 Unicode Support
12093 =for apidoc sv_recode_to_utf8
12095 The encoding is assumed to be an Encode object, on entry the PV
12096 of the sv is assumed to be octets in that encoding, and the sv
12097 will be converted into Unicode (and UTF-8).
12099 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12100 is not a reference, nothing is done to the sv. If the encoding is not
12101 an C<Encode::XS> Encoding object, bad things will happen.
12102 (See F<lib/encoding.pm> and L<Encode>).
12104 The PV of the sv is returned.
12109 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12113 PERL_ARGS_ASSERT_SV_RECODE_TO_UTF8;
12115 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12129 Passing sv_yes is wrong - it needs to be or'ed set of constants
12130 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12131 remove converted chars from source.
12133 Both will default the value - let them.
12135 XPUSHs(&PL_sv_yes);
12138 call_method("decode", G_SCALAR);
12142 s = SvPV_const(uni, len);
12143 if (s != SvPVX_const(sv)) {
12144 SvGROW(sv, len + 1);
12145 Move(s, SvPVX(sv), len + 1, char);
12146 SvCUR_set(sv, len);
12153 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12157 =for apidoc sv_cat_decode
12159 The encoding is assumed to be an Encode object, the PV of the ssv is
12160 assumed to be octets in that encoding and decoding the input starts
12161 from the position which (PV + *offset) pointed to. The dsv will be
12162 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12163 when the string tstr appears in decoding output or the input ends on
12164 the PV of the ssv. The value which the offset points will be modified
12165 to the last input position on the ssv.
12167 Returns TRUE if the terminator was found, else returns FALSE.
12172 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12173 SV *ssv, int *offset, char *tstr, int tlen)
12178 PERL_ARGS_ASSERT_SV_CAT_DECODE;
12180 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12191 offsv = newSViv(*offset);
12193 mXPUSHp(tstr, tlen);
12195 call_method("cat_decode", G_SCALAR);
12197 ret = SvTRUE(TOPs);
12198 *offset = SvIV(offsv);
12204 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12209 /* ---------------------------------------------------------------------
12211 * support functions for report_uninit()
12214 /* the maxiumum size of array or hash where we will scan looking
12215 * for the undefined element that triggered the warning */
12217 #define FUV_MAX_SEARCH_SIZE 1000
12219 /* Look for an entry in the hash whose value has the same SV as val;
12220 * If so, return a mortal copy of the key. */
12223 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
12226 register HE **array;
12229 PERL_ARGS_ASSERT_FIND_HASH_SUBSCRIPT;
12231 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
12232 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
12235 array = HvARRAY(hv);
12237 for (i=HvMAX(hv); i>0; i--) {
12238 register HE *entry;
12239 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
12240 if (HeVAL(entry) != val)
12242 if ( HeVAL(entry) == &PL_sv_undef ||
12243 HeVAL(entry) == &PL_sv_placeholder)
12247 if (HeKLEN(entry) == HEf_SVKEY)
12248 return sv_mortalcopy(HeKEY_sv(entry));
12249 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
12255 /* Look for an entry in the array whose value has the same SV as val;
12256 * If so, return the index, otherwise return -1. */
12259 S_find_array_subscript(pTHX_ AV *av, SV* val)
12263 PERL_ARGS_ASSERT_FIND_ARRAY_SUBSCRIPT;
12265 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
12266 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
12269 if (val != &PL_sv_undef) {
12270 SV ** const svp = AvARRAY(av);
12273 for (i=AvFILLp(av); i>=0; i--)
12280 /* S_varname(): return the name of a variable, optionally with a subscript.
12281 * If gv is non-zero, use the name of that global, along with gvtype (one
12282 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
12283 * targ. Depending on the value of the subscript_type flag, return:
12286 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
12287 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
12288 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
12289 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
12292 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
12293 SV* keyname, I32 aindex, int subscript_type)
12296 SV * const name = sv_newmortal();
12299 buffer[0] = gvtype;
12302 /* as gv_fullname4(), but add literal '^' for $^FOO names */
12304 gv_fullname4(name, gv, buffer, 0);
12306 if ((unsigned int)SvPVX(name)[1] <= 26) {
12308 buffer[1] = SvPVX(name)[1] + 'A' - 1;
12310 /* Swap the 1 unprintable control character for the 2 byte pretty
12311 version - ie substr($name, 1, 1) = $buffer; */
12312 sv_insert(name, 1, 1, buffer, 2);
12316 CV * const cv = find_runcv(NULL);
12320 if (!cv || !CvPADLIST(cv))
12322 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
12323 sv = *av_fetch(av, targ, FALSE);
12324 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
12327 if (subscript_type == FUV_SUBSCRIPT_HASH) {
12328 SV * const sv = newSV(0);
12329 *SvPVX(name) = '$';
12330 Perl_sv_catpvf(aTHX_ name, "{%s}",
12331 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
12334 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
12335 *SvPVX(name) = '$';
12336 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
12338 else if (subscript_type == FUV_SUBSCRIPT_WITHIN) {
12339 /* We know that name has no magic, so can use 0 instead of SV_GMAGIC */
12340 Perl_sv_insert_flags(aTHX_ name, 0, 0, STR_WITH_LEN("within "), 0);
12348 =for apidoc find_uninit_var
12350 Find the name of the undefined variable (if any) that caused the operator o
12351 to issue a "Use of uninitialized value" warning.
12352 If match is true, only return a name if it's value matches uninit_sv.
12353 So roughly speaking, if a unary operator (such as OP_COS) generates a
12354 warning, then following the direct child of the op may yield an
12355 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12356 other hand, with OP_ADD there are two branches to follow, so we only print
12357 the variable name if we get an exact match.
12359 The name is returned as a mortal SV.
12361 Assumes that PL_op is the op that originally triggered the error, and that
12362 PL_comppad/PL_curpad points to the currently executing pad.
12368 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12376 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12377 uninit_sv == &PL_sv_placeholder)))
12380 switch (obase->op_type) {
12387 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12388 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12391 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12393 if (pad) { /* @lex, %lex */
12394 sv = PAD_SVl(obase->op_targ);
12398 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12399 /* @global, %global */
12400 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12403 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12405 else /* @{expr}, %{expr} */
12406 return find_uninit_var(cUNOPx(obase)->op_first,
12410 /* attempt to find a match within the aggregate */
12412 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12414 subscript_type = FUV_SUBSCRIPT_HASH;
12417 index = find_array_subscript((AV*)sv, uninit_sv);
12419 subscript_type = FUV_SUBSCRIPT_ARRAY;
12422 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12425 return varname(gv, hash ? '%' : '@', obase->op_targ,
12426 keysv, index, subscript_type);
12430 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12432 return varname(NULL, '$', obase->op_targ,
12433 NULL, 0, FUV_SUBSCRIPT_NONE);
12436 gv = cGVOPx_gv(obase);
12437 if (!gv || (match && GvSV(gv) != uninit_sv))
12439 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12442 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12445 av = (AV*)PAD_SV(obase->op_targ);
12446 if (!av || SvRMAGICAL(av))
12448 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12449 if (!svp || *svp != uninit_sv)
12452 return varname(NULL, '$', obase->op_targ,
12453 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12456 gv = cGVOPx_gv(obase);
12462 if (!av || SvRMAGICAL(av))
12464 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12465 if (!svp || *svp != uninit_sv)
12468 return varname(gv, '$', 0,
12469 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12474 o = cUNOPx(obase)->op_first;
12475 if (!o || o->op_type != OP_NULL ||
12476 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12478 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12482 if (PL_op == obase)
12483 /* $a[uninit_expr] or $h{uninit_expr} */
12484 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12487 o = cBINOPx(obase)->op_first;
12488 kid = cBINOPx(obase)->op_last;
12490 /* get the av or hv, and optionally the gv */
12492 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12493 sv = PAD_SV(o->op_targ);
12495 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12496 && cUNOPo->op_first->op_type == OP_GV)
12498 gv = cGVOPx_gv(cUNOPo->op_first);
12501 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12506 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12507 /* index is constant */
12511 if (obase->op_type == OP_HELEM) {
12512 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12513 if (!he || HeVAL(he) != uninit_sv)
12517 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12518 if (!svp || *svp != uninit_sv)
12522 if (obase->op_type == OP_HELEM)
12523 return varname(gv, '%', o->op_targ,
12524 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12526 return varname(gv, '@', o->op_targ, NULL,
12527 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12530 /* index is an expression;
12531 * attempt to find a match within the aggregate */
12532 if (obase->op_type == OP_HELEM) {
12533 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12535 return varname(gv, '%', o->op_targ,
12536 keysv, 0, FUV_SUBSCRIPT_HASH);
12539 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12541 return varname(gv, '@', o->op_targ,
12542 NULL, index, FUV_SUBSCRIPT_ARRAY);
12547 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12549 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12554 /* only examine RHS */
12555 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12558 o = cUNOPx(obase)->op_first;
12559 if (o->op_type == OP_PUSHMARK)
12562 if (!o->op_sibling) {
12563 /* one-arg version of open is highly magical */
12565 if (o->op_type == OP_GV) { /* open FOO; */
12567 if (match && GvSV(gv) != uninit_sv)
12569 return varname(gv, '$', 0,
12570 NULL, 0, FUV_SUBSCRIPT_NONE);
12572 /* other possibilities not handled are:
12573 * open $x; or open my $x; should return '${*$x}'
12574 * open expr; should return '$'.expr ideally
12580 /* ops where $_ may be an implicit arg */
12584 if ( !(obase->op_flags & OPf_STACKED)) {
12585 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12586 ? PAD_SVl(obase->op_targ)
12589 sv = sv_newmortal();
12590 sv_setpvn(sv, "$_", 2);
12599 match = 1; /* print etc can return undef on defined args */
12600 /* skip filehandle as it can't produce 'undef' warning */
12601 o = cUNOPx(obase)->op_first;
12602 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12603 o = o->op_sibling->op_sibling;
12607 case OP_ENTEREVAL: /* could be eval $undef or $x='$undef'; eval $x */
12609 case OP_CUSTOM: /* XS or custom code could trigger random warnings */
12611 /* the following ops are capable of returning PL_sv_undef even for
12612 * defined arg(s) */
12631 case OP_GETPEERNAME:
12679 case OP_SMARTMATCH:
12688 /* XXX tmp hack: these two may call an XS sub, and currently
12689 XS subs don't have a SUB entry on the context stack, so CV and
12690 pad determination goes wrong, and BAD things happen. So, just
12691 don't try to determine the value under those circumstances.
12692 Need a better fix at dome point. DAPM 11/2007 */
12697 /* def-ness of rval pos() is independent of the def-ness of its arg */
12698 if ( !(obase->op_flags & OPf_MOD))
12703 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12704 return newSVpvs_flags("${$/}", SVs_TEMP);
12709 if (!(obase->op_flags & OPf_KIDS))
12711 o = cUNOPx(obase)->op_first;
12717 /* if all except one arg are constant, or have no side-effects,
12718 * or are optimized away, then it's unambiguous */
12720 for (kid=o; kid; kid = kid->op_sibling) {
12722 const OPCODE type = kid->op_type;
12723 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12724 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12725 || (type == OP_PUSHMARK)
12729 if (o2) { /* more than one found */
12736 return find_uninit_var(o2, uninit_sv, match);
12738 /* scan all args */
12740 sv = find_uninit_var(o, uninit_sv, 1);
12752 =for apidoc report_uninit
12754 Print appropriate "Use of uninitialized variable" warning
12760 Perl_report_uninit(pTHX_ SV* uninit_sv)
12764 SV* varname = NULL;
12766 varname = find_uninit_var(PL_op, uninit_sv,0);
12768 sv_insert(varname, 0, 0, " ", 1);
12770 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12771 varname ? SvPV_nolen_const(varname) : "",
12772 " in ", OP_DESC(PL_op));
12775 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12781 * c-indentation-style: bsd
12782 * c-basic-offset: 4
12783 * indent-tabs-mode: t
12786 * ex: set ts=8 sts=4 sw=4 noet: