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 *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
250 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
251 sv->sv_debug_inpad = 0;
252 sv->sv_debug_cloned = 0;
253 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
257 # define new_SV(p) (p)=S_new_SV(aTHX)
265 (p) = S_more_sv(aTHX); \
273 /* del_SV(): return an empty SV head to the free list */
286 S_del_sv(pTHX_ SV *p)
292 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
293 const SV * const sv = sva + 1;
294 const SV * const svend = &sva[SvREFCNT(sva)];
295 if (p >= sv && p < svend) {
301 if (ckWARN_d(WARN_INTERNAL))
302 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
303 "Attempt to free non-arena SV: 0x%"UVxf
304 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
311 #else /* ! DEBUGGING */
313 #define del_SV(p) plant_SV(p)
315 #endif /* DEBUGGING */
319 =head1 SV Manipulation Functions
321 =for apidoc sv_add_arena
323 Given a chunk of memory, link it to the head of the list of arenas,
324 and split it into a list of free SVs.
330 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
333 SV* const sva = (SV*)ptr;
337 /* The first SV in an arena isn't an SV. */
338 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
339 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
340 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
342 PL_sv_arenaroot = sva;
343 PL_sv_root = sva + 1;
345 svend = &sva[SvREFCNT(sva) - 1];
348 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
352 /* Must always set typemask because it's awlays checked in on cleanup
353 when the arenas are walked looking for objects. */
354 SvFLAGS(sv) = SVTYPEMASK;
357 SvARENA_CHAIN(sv) = 0;
361 SvFLAGS(sv) = SVTYPEMASK;
364 /* visit(): call the named function for each non-free SV in the arenas
365 * whose flags field matches the flags/mask args. */
368 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
374 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
375 register const SV * const svend = &sva[SvREFCNT(sva)];
377 for (sv = sva + 1; sv < svend; ++sv) {
378 if (SvTYPE(sv) != SVTYPEMASK
379 && (sv->sv_flags & mask) == flags
392 /* called by sv_report_used() for each live SV */
395 do_report_used(pTHX_ SV *sv)
397 if (SvTYPE(sv) != SVTYPEMASK) {
398 PerlIO_printf(Perl_debug_log, "****\n");
405 =for apidoc sv_report_used
407 Dump the contents of all SVs not yet freed. (Debugging aid).
413 Perl_sv_report_used(pTHX)
416 visit(do_report_used, 0, 0);
422 /* called by sv_clean_objs() for each live SV */
425 do_clean_objs(pTHX_ SV *ref)
430 SV * const target = SvRV(ref);
431 if (SvOBJECT(target)) {
432 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
433 if (SvWEAKREF(ref)) {
434 sv_del_backref(target, ref);
440 SvREFCNT_dec(target);
445 /* XXX Might want to check arrays, etc. */
448 /* called by sv_clean_objs() for each live SV */
450 #ifndef DISABLE_DESTRUCTOR_KLUDGE
452 do_clean_named_objs(pTHX_ SV *sv)
455 assert(SvTYPE(sv) == SVt_PVGV);
456 assert(isGV_with_GP(sv));
459 #ifdef PERL_DONT_CREATE_GVSV
462 SvOBJECT(GvSV(sv))) ||
463 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
464 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
465 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
466 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
468 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
469 SvFLAGS(sv) |= SVf_BREAK;
477 =for apidoc sv_clean_objs
479 Attempt to destroy all objects not yet freed
485 Perl_sv_clean_objs(pTHX)
488 PL_in_clean_objs = TRUE;
489 visit(do_clean_objs, SVf_ROK, SVf_ROK);
490 #ifndef DISABLE_DESTRUCTOR_KLUDGE
491 /* some barnacles may yet remain, clinging to typeglobs */
492 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
494 PL_in_clean_objs = FALSE;
497 /* called by sv_clean_all() for each live SV */
500 do_clean_all(pTHX_ SV *sv)
503 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
504 SvFLAGS(sv) |= SVf_BREAK;
505 if (PL_comppad == (AV*)sv) {
513 =for apidoc sv_clean_all
515 Decrement the refcnt of each remaining SV, possibly triggering a
516 cleanup. This function may have to be called multiple times to free
517 SVs which are in complex self-referential hierarchies.
523 Perl_sv_clean_all(pTHX)
527 PL_in_clean_all = TRUE;
528 cleaned = visit(do_clean_all, 0,0);
529 PL_in_clean_all = FALSE;
534 ARENASETS: a meta-arena implementation which separates arena-info
535 into struct arena_set, which contains an array of struct
536 arena_descs, each holding info for a single arena. By separating
537 the meta-info from the arena, we recover the 1st slot, formerly
538 borrowed for list management. The arena_set is about the size of an
539 arena, avoiding the needless malloc overhead of a naive linked-list.
541 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
542 memory in the last arena-set (1/2 on average). In trade, we get
543 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
544 smaller types). The recovery of the wasted space allows use of
545 small arenas for large, rare body types,
548 char *arena; /* the raw storage, allocated aligned */
549 size_t size; /* its size ~4k typ */
550 U32 misc; /* type, and in future other things. */
555 /* Get the maximum number of elements in set[] such that struct arena_set
556 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
557 therefore likely to be 1 aligned memory page. */
559 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
560 - 2 * sizeof(int)) / sizeof (struct arena_desc))
563 struct arena_set* next;
564 unsigned int set_size; /* ie ARENAS_PER_SET */
565 unsigned int curr; /* index of next available arena-desc */
566 struct arena_desc set[ARENAS_PER_SET];
570 =for apidoc sv_free_arenas
572 Deallocate the memory used by all arenas. Note that all the individual SV
573 heads and bodies within the arenas must already have been freed.
578 Perl_sv_free_arenas(pTHX)
585 /* Free arenas here, but be careful about fake ones. (We assume
586 contiguity of the fake ones with the corresponding real ones.) */
588 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
589 svanext = (SV*) SvANY(sva);
590 while (svanext && SvFAKE(svanext))
591 svanext = (SV*) SvANY(svanext);
598 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
601 struct arena_set *current = aroot;
604 assert(aroot->set[i].arena);
605 Safefree(aroot->set[i].arena);
613 i = PERL_ARENA_ROOTS_SIZE;
615 PL_body_roots[i] = 0;
617 Safefree(PL_nice_chunk);
618 PL_nice_chunk = NULL;
619 PL_nice_chunk_size = 0;
625 Here are mid-level routines that manage the allocation of bodies out
626 of the various arenas. There are 5 kinds of arenas:
628 1. SV-head arenas, which are discussed and handled above
629 2. regular body arenas
630 3. arenas for reduced-size bodies
632 5. pte arenas (thread related)
634 Arena types 2 & 3 are chained by body-type off an array of
635 arena-root pointers, which is indexed by svtype. Some of the
636 larger/less used body types are malloced singly, since a large
637 unused block of them is wasteful. Also, several svtypes dont have
638 bodies; the data fits into the sv-head itself. The arena-root
639 pointer thus has a few unused root-pointers (which may be hijacked
640 later for arena types 4,5)
642 3 differs from 2 as an optimization; some body types have several
643 unused fields in the front of the structure (which are kept in-place
644 for consistency). These bodies can be allocated in smaller chunks,
645 because the leading fields arent accessed. Pointers to such bodies
646 are decremented to point at the unused 'ghost' memory, knowing that
647 the pointers are used with offsets to the real memory.
649 HE, HEK arenas are managed separately, with separate code, but may
650 be merge-able later..
652 PTE arenas are not sv-bodies, but they share these mid-level
653 mechanics, so are considered here. The new mid-level mechanics rely
654 on the sv_type of the body being allocated, so we just reserve one
655 of the unused body-slots for PTEs, then use it in those (2) PTE
656 contexts below (line ~10k)
659 /* get_arena(size): this creates custom-sized arenas
660 TBD: export properly for hv.c: S_more_he().
663 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
666 struct arena_desc* adesc;
667 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
670 /* shouldnt need this
671 if (!arena_size) arena_size = PERL_ARENA_SIZE;
674 /* may need new arena-set to hold new arena */
675 if (!aroot || aroot->curr >= aroot->set_size) {
676 struct arena_set *newroot;
677 Newxz(newroot, 1, struct arena_set);
678 newroot->set_size = ARENAS_PER_SET;
679 newroot->next = aroot;
681 PL_body_arenas = (void *) newroot;
682 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
685 /* ok, now have arena-set with at least 1 empty/available arena-desc */
686 curr = aroot->curr++;
687 adesc = &(aroot->set[curr]);
688 assert(!adesc->arena);
690 Newx(adesc->arena, arena_size, char);
691 adesc->size = arena_size;
693 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
694 curr, (void*)adesc->arena, arena_size));
700 /* return a thing to the free list */
702 #define del_body(thing, root) \
704 void ** const thing_copy = (void **)thing;\
705 *thing_copy = *root; \
706 *root = (void*)thing_copy; \
711 =head1 SV-Body Allocation
713 Allocation of SV-bodies is similar to SV-heads, differing as follows;
714 the allocation mechanism is used for many body types, so is somewhat
715 more complicated, it uses arena-sets, and has no need for still-live
718 At the outermost level, (new|del)_X*V macros return bodies of the
719 appropriate type. These macros call either (new|del)_body_type or
720 (new|del)_body_allocated macro pairs, depending on specifics of the
721 type. Most body types use the former pair, the latter pair is used to
722 allocate body types with "ghost fields".
724 "ghost fields" are fields that are unused in certain types, and
725 consequently dont need to actually exist. They are declared because
726 they're part of a "base type", which allows use of functions as
727 methods. The simplest examples are AVs and HVs, 2 aggregate types
728 which don't use the fields which support SCALAR semantics.
730 For these types, the arenas are carved up into *_allocated size
731 chunks, we thus avoid wasted memory for those unaccessed members.
732 When bodies are allocated, we adjust the pointer back in memory by the
733 size of the bit not allocated, so it's as if we allocated the full
734 structure. (But things will all go boom if you write to the part that
735 is "not there", because you'll be overwriting the last members of the
736 preceding structure in memory.)
738 We calculate the correction using the STRUCT_OFFSET macro. For
739 example, if xpv_allocated is the same structure as XPV then the two
740 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
741 structure is smaller (no initial NV actually allocated) then the net
742 effect is to subtract the size of the NV from the pointer, to return a
743 new pointer as if an initial NV were actually allocated.
745 This is the same trick as was used for NV and IV bodies. Ironically it
746 doesn't need to be used for NV bodies any more, because NV is now at
747 the start of the structure. IV bodies don't need it either, because
748 they are no longer allocated.
750 In turn, the new_body_* allocators call S_new_body(), which invokes
751 new_body_inline macro, which takes a lock, and takes a body off the
752 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
753 necessary to refresh an empty list. Then the lock is released, and
754 the body is returned.
756 S_more_bodies calls get_arena(), and carves it up into an array of N
757 bodies, which it strings into a linked list. It looks up arena-size
758 and body-size from the body_details table described below, thus
759 supporting the multiple body-types.
761 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
762 the (new|del)_X*V macros are mapped directly to malloc/free.
768 For each sv-type, struct body_details bodies_by_type[] carries
769 parameters which control these aspects of SV handling:
771 Arena_size determines whether arenas are used for this body type, and if
772 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
773 zero, forcing individual mallocs and frees.
775 Body_size determines how big a body is, and therefore how many fit into
776 each arena. Offset carries the body-pointer adjustment needed for
777 *_allocated body types, and is used in *_allocated macros.
779 But its main purpose is to parameterize info needed in
780 Perl_sv_upgrade(). The info here dramatically simplifies the function
781 vs the implementation in 5.8.7, making it table-driven. All fields
782 are used for this, except for arena_size.
784 For the sv-types that have no bodies, arenas are not used, so those
785 PL_body_roots[sv_type] are unused, and can be overloaded. In
786 something of a special case, SVt_NULL is borrowed for HE arenas;
787 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
788 bodies_by_type[SVt_NULL] slot is not used, as the table is not
791 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
792 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
793 they can just use the same allocation semantics. At first, PTEs were
794 also overloaded to a non-body sv-type, but this yielded hard-to-find
795 malloc bugs, so was simplified by claiming a new slot. This choice
796 has no consequence at this time.
800 struct body_details {
801 U8 body_size; /* Size to allocate */
802 U8 copy; /* Size of structure to copy (may be shorter) */
804 unsigned int type : 4; /* We have space for a sanity check. */
805 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
806 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
807 unsigned int arena : 1; /* Allocated from an arena */
808 size_t arena_size; /* Size of arena to allocate */
816 /* With -DPURFIY we allocate everything directly, and don't use arenas.
817 This seems a rather elegant way to simplify some of the code below. */
818 #define HASARENA FALSE
820 #define HASARENA TRUE
822 #define NOARENA FALSE
824 /* Size the arenas to exactly fit a given number of bodies. A count
825 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
826 simplifying the default. If count > 0, the arena is sized to fit
827 only that many bodies, allowing arenas to be used for large, rare
828 bodies (XPVFM, XPVIO) without undue waste. The arena size is
829 limited by PERL_ARENA_SIZE, so we can safely oversize the
832 #define FIT_ARENA0(body_size) \
833 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
834 #define FIT_ARENAn(count,body_size) \
835 ( count * body_size <= PERL_ARENA_SIZE) \
836 ? count * body_size \
837 : FIT_ARENA0 (body_size)
838 #define FIT_ARENA(count,body_size) \
840 ? FIT_ARENAn (count, body_size) \
841 : FIT_ARENA0 (body_size)
843 /* A macro to work out the offset needed to subtract from a pointer to (say)
850 to make its members accessible via a pointer to (say)
860 #define relative_STRUCT_OFFSET(longer, shorter, member) \
861 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
863 /* Calculate the length to copy. Specifically work out the length less any
864 final padding the compiler needed to add. See the comment in sv_upgrade
865 for why copying the padding proved to be a bug. */
867 #define copy_length(type, last_member) \
868 STRUCT_OFFSET(type, last_member) \
869 + sizeof (((type*)SvANY((SV*)0))->last_member)
871 static const struct body_details bodies_by_type[] = {
872 { sizeof(HE), 0, 0, SVt_NULL,
873 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
875 /* The bind placeholder pretends to be an RV for now.
876 Also it's marked as "can't upgrade" top stop anyone using it before it's
878 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
880 /* IVs are in the head, so the allocation size is 0.
881 However, the slot is overloaded for PTEs. */
882 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
883 sizeof(IV), /* This is used to copy out the IV body. */
884 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
885 NOARENA /* IVS don't need an arena */,
886 /* But PTEs need to know the size of their arena */
887 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
890 /* 8 bytes on most ILP32 with IEEE doubles */
891 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
892 FIT_ARENA(0, sizeof(NV)) },
894 /* RVs are in the head now. */
895 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
921 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
924 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
925 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
927 { sizeof(xpvav_allocated),
928 copy_length(XPVAV, xmg_stash)
929 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
930 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
931 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
933 { sizeof(xpvhv_allocated),
934 copy_length(XPVHV, xmg_stash)
935 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
936 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
937 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
940 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
941 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
942 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
944 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
945 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
946 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
948 /* XPVIO is 84 bytes, fits 48x */
949 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
950 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
953 #define new_body_type(sv_type) \
954 (void *)((char *)S_new_body(aTHX_ sv_type))
956 #define del_body_type(p, sv_type) \
957 del_body(p, &PL_body_roots[sv_type])
960 #define new_body_allocated(sv_type) \
961 (void *)((char *)S_new_body(aTHX_ sv_type) \
962 - bodies_by_type[sv_type].offset)
964 #define del_body_allocated(p, sv_type) \
965 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
968 #define my_safemalloc(s) (void*)safemalloc(s)
969 #define my_safecalloc(s) (void*)safecalloc(s, 1)
970 #define my_safefree(p) safefree((char*)p)
974 #define new_XNV() my_safemalloc(sizeof(XPVNV))
975 #define del_XNV(p) my_safefree(p)
977 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
978 #define del_XPVNV(p) my_safefree(p)
980 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
981 #define del_XPVAV(p) my_safefree(p)
983 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
984 #define del_XPVHV(p) my_safefree(p)
986 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
987 #define del_XPVMG(p) my_safefree(p)
989 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
990 #define del_XPVGV(p) my_safefree(p)
994 #define new_XNV() new_body_type(SVt_NV)
995 #define del_XNV(p) del_body_type(p, SVt_NV)
997 #define new_XPVNV() new_body_type(SVt_PVNV)
998 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1000 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1001 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1003 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1004 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1006 #define new_XPVMG() new_body_type(SVt_PVMG)
1007 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1009 #define new_XPVGV() new_body_type(SVt_PVGV)
1010 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1014 /* no arena for you! */
1016 #define new_NOARENA(details) \
1017 my_safemalloc((details)->body_size + (details)->offset)
1018 #define new_NOARENAZ(details) \
1019 my_safecalloc((details)->body_size + (details)->offset)
1022 S_more_bodies (pTHX_ svtype sv_type)
1025 void ** const root = &PL_body_roots[sv_type];
1026 const struct body_details * const bdp = &bodies_by_type[sv_type];
1027 const size_t body_size = bdp->body_size;
1030 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1031 static bool done_sanity_check;
1033 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1034 * variables like done_sanity_check. */
1035 if (!done_sanity_check) {
1036 unsigned int i = SVt_LAST;
1038 done_sanity_check = TRUE;
1041 assert (bodies_by_type[i].type == i);
1045 assert(bdp->arena_size);
1047 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1049 end = start + bdp->arena_size - body_size;
1051 /* computed count doesnt reflect the 1st slot reservation */
1052 DEBUG_m(PerlIO_printf(Perl_debug_log,
1053 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1054 (void*)start, (void*)end,
1055 (int)bdp->arena_size, sv_type, (int)body_size,
1056 (int)bdp->arena_size / (int)body_size));
1058 *root = (void *)start;
1060 while (start < end) {
1061 char * const next = start + body_size;
1062 *(void**) start = (void *)next;
1065 *(void **)start = 0;
1070 /* grab a new thing from the free list, allocating more if necessary.
1071 The inline version is used for speed in hot routines, and the
1072 function using it serves the rest (unless PURIFY).
1074 #define new_body_inline(xpv, sv_type) \
1076 void ** const r3wt = &PL_body_roots[sv_type]; \
1077 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1078 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1079 *(r3wt) = *(void**)(xpv); \
1085 S_new_body(pTHX_ svtype sv_type)
1089 new_body_inline(xpv, sv_type);
1096 =for apidoc sv_upgrade
1098 Upgrade an SV to a more complex form. Generally adds a new body type to the
1099 SV, then copies across as much information as possible from the old body.
1100 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1106 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1111 const svtype old_type = SvTYPE(sv);
1112 const struct body_details *new_type_details;
1113 const struct body_details *const old_type_details
1114 = bodies_by_type + old_type;
1116 if (new_type != SVt_PV && SvIsCOW(sv)) {
1117 sv_force_normal_flags(sv, 0);
1120 if (old_type == new_type)
1123 if (old_type > new_type)
1124 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1125 (int)old_type, (int)new_type);
1128 old_body = SvANY(sv);
1130 /* Copying structures onto other structures that have been neatly zeroed
1131 has a subtle gotcha. Consider XPVMG
1133 +------+------+------+------+------+-------+-------+
1134 | NV | CUR | LEN | IV | MAGIC | STASH |
1135 +------+------+------+------+------+-------+-------+
1136 0 4 8 12 16 20 24 28
1138 where NVs are aligned to 8 bytes, so that sizeof that structure is
1139 actually 32 bytes long, with 4 bytes of padding at the end:
1141 +------+------+------+------+------+-------+-------+------+
1142 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1143 +------+------+------+------+------+-------+-------+------+
1144 0 4 8 12 16 20 24 28 32
1146 so what happens if you allocate memory for this structure:
1148 +------+------+------+------+------+-------+-------+------+------+...
1149 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1150 +------+------+------+------+------+-------+-------+------+------+...
1151 0 4 8 12 16 20 24 28 32 36
1153 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1154 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1155 started out as zero once, but it's quite possible that it isn't. So now,
1156 rather than a nicely zeroed GP, you have it pointing somewhere random.
1159 (In fact, GP ends up pointing at a previous GP structure, because the
1160 principle cause of the padding in XPVMG getting garbage is a copy of
1161 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1162 this happens to be moot because XPVGV has been re-ordered, with GP
1163 no longer after STASH)
1165 So we are careful and work out the size of used parts of all the
1172 if (new_type < SVt_PVIV) {
1173 new_type = (new_type == SVt_NV)
1174 ? SVt_PVNV : SVt_PVIV;
1178 if (new_type < SVt_PVNV) {
1179 new_type = SVt_PVNV;
1185 assert(new_type > SVt_PV);
1186 assert(SVt_IV < SVt_PV);
1187 assert(SVt_NV < SVt_PV);
1194 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1195 there's no way that it can be safely upgraded, because perl.c
1196 expects to Safefree(SvANY(PL_mess_sv)) */
1197 assert(sv != PL_mess_sv);
1198 /* This flag bit is used to mean other things in other scalar types.
1199 Given that it only has meaning inside the pad, it shouldn't be set
1200 on anything that can get upgraded. */
1201 assert(!SvPAD_TYPED(sv));
1204 if (old_type_details->cant_upgrade)
1205 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1206 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1208 new_type_details = bodies_by_type + new_type;
1210 SvFLAGS(sv) &= ~SVTYPEMASK;
1211 SvFLAGS(sv) |= new_type;
1213 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1214 the return statements above will have triggered. */
1215 assert (new_type != SVt_NULL);
1218 assert(old_type == SVt_NULL);
1219 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1223 assert(old_type == SVt_NULL);
1224 SvANY(sv) = new_XNV();
1228 assert(old_type == SVt_NULL);
1229 SvANY(sv) = &sv->sv_u.svu_rv;
1234 assert(new_type_details->body_size);
1237 assert(new_type_details->arena);
1238 assert(new_type_details->arena_size);
1239 /* This points to the start of the allocated area. */
1240 new_body_inline(new_body, new_type);
1241 Zero(new_body, new_type_details->body_size, char);
1242 new_body = ((char *)new_body) - new_type_details->offset;
1244 /* We always allocated the full length item with PURIFY. To do this
1245 we fake things so that arena is false for all 16 types.. */
1246 new_body = new_NOARENAZ(new_type_details);
1248 SvANY(sv) = new_body;
1249 if (new_type == SVt_PVAV) {
1255 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1256 The target created by newSVrv also is, and it can have magic.
1257 However, it never has SvPVX set.
1259 if (old_type >= SVt_RV) {
1260 assert(SvPVX_const(sv) == 0);
1263 if (old_type >= SVt_PVMG) {
1264 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1265 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1267 sv->sv_u.svu_array = NULL; /* or svu_hash */
1273 /* XXX Is this still needed? Was it ever needed? Surely as there is
1274 no route from NV to PVIV, NOK can never be true */
1275 assert(!SvNOKp(sv));
1286 assert(new_type_details->body_size);
1287 /* We always allocated the full length item with PURIFY. To do this
1288 we fake things so that arena is false for all 16 types.. */
1289 if(new_type_details->arena) {
1290 /* This points to the start of the allocated area. */
1291 new_body_inline(new_body, new_type);
1292 Zero(new_body, new_type_details->body_size, char);
1293 new_body = ((char *)new_body) - new_type_details->offset;
1295 new_body = new_NOARENAZ(new_type_details);
1297 SvANY(sv) = new_body;
1299 if (old_type_details->copy) {
1300 /* There is now the potential for an upgrade from something without
1301 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1302 int offset = old_type_details->offset;
1303 int length = old_type_details->copy;
1305 if (new_type_details->offset > old_type_details->offset) {
1306 const int difference
1307 = new_type_details->offset - old_type_details->offset;
1308 offset += difference;
1309 length -= difference;
1311 assert (length >= 0);
1313 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1317 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1318 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1319 * correct 0.0 for us. Otherwise, if the old body didn't have an
1320 * NV slot, but the new one does, then we need to initialise the
1321 * freshly created NV slot with whatever the correct bit pattern is
1323 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1327 if (new_type == SVt_PVIO)
1328 IoPAGE_LEN(sv) = 60;
1329 if (old_type < SVt_RV)
1333 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1334 (unsigned long)new_type);
1337 if (old_type_details->arena) {
1338 /* If there was an old body, then we need to free it.
1339 Note that there is an assumption that all bodies of types that
1340 can be upgraded came from arenas. Only the more complex non-
1341 upgradable types are allowed to be directly malloc()ed. */
1343 my_safefree(old_body);
1345 del_body((void*)((char*)old_body + old_type_details->offset),
1346 &PL_body_roots[old_type]);
1352 =for apidoc sv_backoff
1354 Remove any string offset. You should normally use the C<SvOOK_off> macro
1361 Perl_sv_backoff(pTHX_ register SV *sv)
1363 PERL_UNUSED_CONTEXT;
1365 assert(SvTYPE(sv) != SVt_PVHV);
1366 assert(SvTYPE(sv) != SVt_PVAV);
1368 const char * const s = SvPVX_const(sv);
1369 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1370 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1372 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1374 SvFLAGS(sv) &= ~SVf_OOK;
1381 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1382 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1383 Use the C<SvGROW> wrapper instead.
1389 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1393 if (PL_madskills && newlen >= 0x100000) {
1394 PerlIO_printf(Perl_debug_log,
1395 "Allocation too large: %"UVxf"\n", (UV)newlen);
1397 #ifdef HAS_64K_LIMIT
1398 if (newlen >= 0x10000) {
1399 PerlIO_printf(Perl_debug_log,
1400 "Allocation too large: %"UVxf"\n", (UV)newlen);
1403 #endif /* HAS_64K_LIMIT */
1406 if (SvTYPE(sv) < SVt_PV) {
1407 sv_upgrade(sv, SVt_PV);
1408 s = SvPVX_mutable(sv);
1410 else if (SvOOK(sv)) { /* pv is offset? */
1412 s = SvPVX_mutable(sv);
1413 if (newlen > SvLEN(sv))
1414 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1415 #ifdef HAS_64K_LIMIT
1416 if (newlen >= 0x10000)
1421 s = SvPVX_mutable(sv);
1423 if (newlen > SvLEN(sv)) { /* need more room? */
1424 newlen = PERL_STRLEN_ROUNDUP(newlen);
1425 if (SvLEN(sv) && s) {
1427 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1433 s = (char*)saferealloc(s, newlen);
1436 s = (char*)safemalloc(newlen);
1437 if (SvPVX_const(sv) && SvCUR(sv)) {
1438 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1442 SvLEN_set(sv, newlen);
1448 =for apidoc sv_setiv
1450 Copies an integer into the given SV, upgrading first if necessary.
1451 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1457 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1460 SV_CHECK_THINKFIRST_COW_DROP(sv);
1461 switch (SvTYPE(sv)) {
1463 sv_upgrade(sv, SVt_IV);
1466 sv_upgrade(sv, SVt_PVNV);
1470 sv_upgrade(sv, SVt_PVIV);
1479 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1483 (void)SvIOK_only(sv); /* validate number */
1489 =for apidoc sv_setiv_mg
1491 Like C<sv_setiv>, but also handles 'set' magic.
1497 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1504 =for apidoc sv_setuv
1506 Copies an unsigned integer into the given SV, upgrading first if necessary.
1507 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1513 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1515 /* With these two if statements:
1516 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1519 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1521 If you wish to remove them, please benchmark to see what the effect is
1523 if (u <= (UV)IV_MAX) {
1524 sv_setiv(sv, (IV)u);
1533 =for apidoc sv_setuv_mg
1535 Like C<sv_setuv>, but also handles 'set' magic.
1541 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1548 =for apidoc sv_setnv
1550 Copies a double into the given SV, upgrading first if necessary.
1551 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1557 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1560 SV_CHECK_THINKFIRST_COW_DROP(sv);
1561 switch (SvTYPE(sv)) {
1564 sv_upgrade(sv, SVt_NV);
1569 sv_upgrade(sv, SVt_PVNV);
1578 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1583 (void)SvNOK_only(sv); /* validate number */
1588 =for apidoc sv_setnv_mg
1590 Like C<sv_setnv>, but also handles 'set' magic.
1596 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1602 /* Print an "isn't numeric" warning, using a cleaned-up,
1603 * printable version of the offending string
1607 S_not_a_number(pTHX_ SV *sv)
1615 dsv = sv_2mortal(newSVpvs(""));
1616 pv = sv_uni_display(dsv, sv, 10, 0);
1619 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1620 /* each *s can expand to 4 chars + "...\0",
1621 i.e. need room for 8 chars */
1623 const char *s = SvPVX_const(sv);
1624 const char * const end = s + SvCUR(sv);
1625 for ( ; s < end && d < limit; s++ ) {
1627 if (ch & 128 && !isPRINT_LC(ch)) {
1636 else if (ch == '\r') {
1640 else if (ch == '\f') {
1644 else if (ch == '\\') {
1648 else if (ch == '\0') {
1652 else if (isPRINT_LC(ch))
1669 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1670 "Argument \"%s\" isn't numeric in %s", pv,
1673 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1674 "Argument \"%s\" isn't numeric", pv);
1678 =for apidoc looks_like_number
1680 Test if the content of an SV looks like a number (or is a number).
1681 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1682 non-numeric warning), even if your atof() doesn't grok them.
1688 Perl_looks_like_number(pTHX_ SV *sv)
1690 register const char *sbegin;
1694 sbegin = SvPVX_const(sv);
1697 else if (SvPOKp(sv))
1698 sbegin = SvPV_const(sv, len);
1700 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1701 return grok_number(sbegin, len, NULL);
1705 S_glob_2number(pTHX_ GV * const gv)
1707 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1708 SV *const buffer = sv_newmortal();
1710 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1713 gv_efullname3(buffer, gv, "*");
1714 SvFLAGS(gv) |= wasfake;
1716 /* We know that all GVs stringify to something that is not-a-number,
1717 so no need to test that. */
1718 if (ckWARN(WARN_NUMERIC))
1719 not_a_number(buffer);
1720 /* We just want something true to return, so that S_sv_2iuv_common
1721 can tail call us and return true. */
1726 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1728 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1729 SV *const buffer = sv_newmortal();
1731 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1734 gv_efullname3(buffer, gv, "*");
1735 SvFLAGS(gv) |= wasfake;
1737 assert(SvPOK(buffer));
1739 *len = SvCUR(buffer);
1741 return SvPVX(buffer);
1744 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1745 until proven guilty, assume that things are not that bad... */
1750 As 64 bit platforms often have an NV that doesn't preserve all bits of
1751 an IV (an assumption perl has been based on to date) it becomes necessary
1752 to remove the assumption that the NV always carries enough precision to
1753 recreate the IV whenever needed, and that the NV is the canonical form.
1754 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1755 precision as a side effect of conversion (which would lead to insanity
1756 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1757 1) to distinguish between IV/UV/NV slots that have cached a valid
1758 conversion where precision was lost and IV/UV/NV slots that have a
1759 valid conversion which has lost no precision
1760 2) to ensure that if a numeric conversion to one form is requested that
1761 would lose precision, the precise conversion (or differently
1762 imprecise conversion) is also performed and cached, to prevent
1763 requests for different numeric formats on the same SV causing
1764 lossy conversion chains. (lossless conversion chains are perfectly
1769 SvIOKp is true if the IV slot contains a valid value
1770 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1771 SvNOKp is true if the NV slot contains a valid value
1772 SvNOK is true only if the NV value is accurate
1775 while converting from PV to NV, check to see if converting that NV to an
1776 IV(or UV) would lose accuracy over a direct conversion from PV to
1777 IV(or UV). If it would, cache both conversions, return NV, but mark
1778 SV as IOK NOKp (ie not NOK).
1780 While converting from PV to IV, check to see if converting that IV to an
1781 NV would lose accuracy over a direct conversion from PV to NV. If it
1782 would, cache both conversions, flag similarly.
1784 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1785 correctly because if IV & NV were set NV *always* overruled.
1786 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1787 changes - now IV and NV together means that the two are interchangeable:
1788 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1790 The benefit of this is that operations such as pp_add know that if
1791 SvIOK is true for both left and right operands, then integer addition
1792 can be used instead of floating point (for cases where the result won't
1793 overflow). Before, floating point was always used, which could lead to
1794 loss of precision compared with integer addition.
1796 * making IV and NV equal status should make maths accurate on 64 bit
1798 * may speed up maths somewhat if pp_add and friends start to use
1799 integers when possible instead of fp. (Hopefully the overhead in
1800 looking for SvIOK and checking for overflow will not outweigh the
1801 fp to integer speedup)
1802 * will slow down integer operations (callers of SvIV) on "inaccurate"
1803 values, as the change from SvIOK to SvIOKp will cause a call into
1804 sv_2iv each time rather than a macro access direct to the IV slot
1805 * should speed up number->string conversion on integers as IV is
1806 favoured when IV and NV are equally accurate
1808 ####################################################################
1809 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1810 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1811 On the other hand, SvUOK is true iff UV.
1812 ####################################################################
1814 Your mileage will vary depending your CPU's relative fp to integer
1818 #ifndef NV_PRESERVES_UV
1819 # define IS_NUMBER_UNDERFLOW_IV 1
1820 # define IS_NUMBER_UNDERFLOW_UV 2
1821 # define IS_NUMBER_IV_AND_UV 2
1822 # define IS_NUMBER_OVERFLOW_IV 4
1823 # define IS_NUMBER_OVERFLOW_UV 5
1825 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1827 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1829 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1832 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1833 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));
1834 if (SvNVX(sv) < (NV)IV_MIN) {
1835 (void)SvIOKp_on(sv);
1837 SvIV_set(sv, IV_MIN);
1838 return IS_NUMBER_UNDERFLOW_IV;
1840 if (SvNVX(sv) > (NV)UV_MAX) {
1841 (void)SvIOKp_on(sv);
1844 SvUV_set(sv, UV_MAX);
1845 return IS_NUMBER_OVERFLOW_UV;
1847 (void)SvIOKp_on(sv);
1849 /* Can't use strtol etc to convert this string. (See truth table in
1851 if (SvNVX(sv) <= (UV)IV_MAX) {
1852 SvIV_set(sv, I_V(SvNVX(sv)));
1853 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1854 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1856 /* Integer is imprecise. NOK, IOKp */
1858 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1861 SvUV_set(sv, U_V(SvNVX(sv)));
1862 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1863 if (SvUVX(sv) == UV_MAX) {
1864 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1865 possibly be preserved by NV. Hence, it must be overflow.
1867 return IS_NUMBER_OVERFLOW_UV;
1869 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1871 /* Integer is imprecise. NOK, IOKp */
1873 return IS_NUMBER_OVERFLOW_IV;
1875 #endif /* !NV_PRESERVES_UV*/
1878 S_sv_2iuv_common(pTHX_ SV *sv) {
1881 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1882 * without also getting a cached IV/UV from it at the same time
1883 * (ie PV->NV conversion should detect loss of accuracy and cache
1884 * IV or UV at same time to avoid this. */
1885 /* IV-over-UV optimisation - choose to cache IV if possible */
1887 if (SvTYPE(sv) == SVt_NV)
1888 sv_upgrade(sv, SVt_PVNV);
1890 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1891 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1892 certainly cast into the IV range at IV_MAX, whereas the correct
1893 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1895 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1896 if (Perl_isnan(SvNVX(sv))) {
1902 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1903 SvIV_set(sv, I_V(SvNVX(sv)));
1904 if (SvNVX(sv) == (NV) SvIVX(sv)
1905 #ifndef NV_PRESERVES_UV
1906 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1907 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1908 /* Don't flag it as "accurately an integer" if the number
1909 came from a (by definition imprecise) NV operation, and
1910 we're outside the range of NV integer precision */
1913 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1914 DEBUG_c(PerlIO_printf(Perl_debug_log,
1915 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1921 /* IV not precise. No need to convert from PV, as NV
1922 conversion would already have cached IV if it detected
1923 that PV->IV would be better than PV->NV->IV
1924 flags already correct - don't set public IOK. */
1925 DEBUG_c(PerlIO_printf(Perl_debug_log,
1926 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1931 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1932 but the cast (NV)IV_MIN rounds to a the value less (more
1933 negative) than IV_MIN which happens to be equal to SvNVX ??
1934 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1935 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1936 (NV)UVX == NVX are both true, but the values differ. :-(
1937 Hopefully for 2s complement IV_MIN is something like
1938 0x8000000000000000 which will be exact. NWC */
1941 SvUV_set(sv, U_V(SvNVX(sv)));
1943 (SvNVX(sv) == (NV) SvUVX(sv))
1944 #ifndef NV_PRESERVES_UV
1945 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1946 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1947 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1948 /* Don't flag it as "accurately an integer" if the number
1949 came from a (by definition imprecise) NV operation, and
1950 we're outside the range of NV integer precision */
1955 DEBUG_c(PerlIO_printf(Perl_debug_log,
1956 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1962 else if (SvPOKp(sv) && SvLEN(sv)) {
1964 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1965 /* We want to avoid a possible problem when we cache an IV/ a UV which
1966 may be later translated to an NV, and the resulting NV is not
1967 the same as the direct translation of the initial string
1968 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1969 be careful to ensure that the value with the .456 is around if the
1970 NV value is requested in the future).
1972 This means that if we cache such an IV/a UV, we need to cache the
1973 NV as well. Moreover, we trade speed for space, and do not
1974 cache the NV if we are sure it's not needed.
1977 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1978 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1979 == IS_NUMBER_IN_UV) {
1980 /* It's definitely an integer, only upgrade to PVIV */
1981 if (SvTYPE(sv) < SVt_PVIV)
1982 sv_upgrade(sv, SVt_PVIV);
1984 } else if (SvTYPE(sv) < SVt_PVNV)
1985 sv_upgrade(sv, SVt_PVNV);
1987 /* If NVs preserve UVs then we only use the UV value if we know that
1988 we aren't going to call atof() below. If NVs don't preserve UVs
1989 then the value returned may have more precision than atof() will
1990 return, even though value isn't perfectly accurate. */
1991 if ((numtype & (IS_NUMBER_IN_UV
1992 #ifdef NV_PRESERVES_UV
1995 )) == IS_NUMBER_IN_UV) {
1996 /* This won't turn off the public IOK flag if it was set above */
1997 (void)SvIOKp_on(sv);
1999 if (!(numtype & IS_NUMBER_NEG)) {
2001 if (value <= (UV)IV_MAX) {
2002 SvIV_set(sv, (IV)value);
2004 /* it didn't overflow, and it was positive. */
2005 SvUV_set(sv, value);
2009 /* 2s complement assumption */
2010 if (value <= (UV)IV_MIN) {
2011 SvIV_set(sv, -(IV)value);
2013 /* Too negative for an IV. This is a double upgrade, but
2014 I'm assuming it will be rare. */
2015 if (SvTYPE(sv) < SVt_PVNV)
2016 sv_upgrade(sv, SVt_PVNV);
2020 SvNV_set(sv, -(NV)value);
2021 SvIV_set(sv, IV_MIN);
2025 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2026 will be in the previous block to set the IV slot, and the next
2027 block to set the NV slot. So no else here. */
2029 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2030 != IS_NUMBER_IN_UV) {
2031 /* It wasn't an (integer that doesn't overflow the UV). */
2032 SvNV_set(sv, Atof(SvPVX_const(sv)));
2034 if (! numtype && ckWARN(WARN_NUMERIC))
2037 #if defined(USE_LONG_DOUBLE)
2038 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2039 PTR2UV(sv), SvNVX(sv)));
2041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2042 PTR2UV(sv), SvNVX(sv)));
2045 #ifdef NV_PRESERVES_UV
2046 (void)SvIOKp_on(sv);
2048 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2049 SvIV_set(sv, I_V(SvNVX(sv)));
2050 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2053 NOOP; /* Integer is imprecise. NOK, IOKp */
2055 /* UV will not work better than IV */
2057 if (SvNVX(sv) > (NV)UV_MAX) {
2059 /* Integer is inaccurate. NOK, IOKp, is UV */
2060 SvUV_set(sv, UV_MAX);
2062 SvUV_set(sv, U_V(SvNVX(sv)));
2063 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2064 NV preservse UV so can do correct comparison. */
2065 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2068 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2073 #else /* NV_PRESERVES_UV */
2074 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2075 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2076 /* The IV/UV slot will have been set from value returned by
2077 grok_number above. The NV slot has just been set using
2080 assert (SvIOKp(sv));
2082 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2083 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2084 /* Small enough to preserve all bits. */
2085 (void)SvIOKp_on(sv);
2087 SvIV_set(sv, I_V(SvNVX(sv)));
2088 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2090 /* Assumption: first non-preserved integer is < IV_MAX,
2091 this NV is in the preserved range, therefore: */
2092 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2094 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);
2098 0 0 already failed to read UV.
2099 0 1 already failed to read UV.
2100 1 0 you won't get here in this case. IV/UV
2101 slot set, public IOK, Atof() unneeded.
2102 1 1 already read UV.
2103 so there's no point in sv_2iuv_non_preserve() attempting
2104 to use atol, strtol, strtoul etc. */
2105 sv_2iuv_non_preserve (sv, numtype);
2108 #endif /* NV_PRESERVES_UV */
2112 if (isGV_with_GP(sv))
2113 return glob_2number((GV *)sv);
2115 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2116 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2119 if (SvTYPE(sv) < SVt_IV)
2120 /* Typically the caller expects that sv_any is not NULL now. */
2121 sv_upgrade(sv, SVt_IV);
2122 /* Return 0 from the caller. */
2129 =for apidoc sv_2iv_flags
2131 Return the integer value of an SV, doing any necessary string
2132 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2133 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2139 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2144 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2145 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2146 cache IVs just in case. In practice it seems that they never
2147 actually anywhere accessible by user Perl code, let alone get used
2148 in anything other than a string context. */
2149 if (flags & SV_GMAGIC)
2154 return I_V(SvNVX(sv));
2156 if (SvPOKp(sv) && SvLEN(sv)) {
2159 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2161 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2162 == IS_NUMBER_IN_UV) {
2163 /* It's definitely an integer */
2164 if (numtype & IS_NUMBER_NEG) {
2165 if (value < (UV)IV_MIN)
2168 if (value < (UV)IV_MAX)
2173 if (ckWARN(WARN_NUMERIC))
2176 return I_V(Atof(SvPVX_const(sv)));
2181 assert(SvTYPE(sv) >= SVt_PVMG);
2182 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2183 } else if (SvTHINKFIRST(sv)) {
2187 SV * const tmpstr=AMG_CALLun(sv,numer);
2188 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2189 return SvIV(tmpstr);
2192 return PTR2IV(SvRV(sv));
2195 sv_force_normal_flags(sv, 0);
2197 if (SvREADONLY(sv) && !SvOK(sv)) {
2198 if (ckWARN(WARN_UNINITIALIZED))
2204 if (S_sv_2iuv_common(aTHX_ sv))
2207 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2208 PTR2UV(sv),SvIVX(sv)));
2209 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2213 =for apidoc sv_2uv_flags
2215 Return the unsigned integer value of an SV, doing any necessary string
2216 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2217 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2223 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2228 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2229 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2230 cache IVs just in case. */
2231 if (flags & SV_GMAGIC)
2236 return U_V(SvNVX(sv));
2237 if (SvPOKp(sv) && SvLEN(sv)) {
2240 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2242 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2243 == IS_NUMBER_IN_UV) {
2244 /* It's definitely an integer */
2245 if (!(numtype & IS_NUMBER_NEG))
2249 if (ckWARN(WARN_NUMERIC))
2252 return U_V(Atof(SvPVX_const(sv)));
2257 assert(SvTYPE(sv) >= SVt_PVMG);
2258 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2259 } else if (SvTHINKFIRST(sv)) {
2263 SV *const tmpstr = AMG_CALLun(sv,numer);
2264 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2265 return SvUV(tmpstr);
2268 return PTR2UV(SvRV(sv));
2271 sv_force_normal_flags(sv, 0);
2273 if (SvREADONLY(sv) && !SvOK(sv)) {
2274 if (ckWARN(WARN_UNINITIALIZED))
2280 if (S_sv_2iuv_common(aTHX_ sv))
2284 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2285 PTR2UV(sv),SvUVX(sv)));
2286 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2292 Return the num value of an SV, doing any necessary string or integer
2293 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2300 Perl_sv_2nv(pTHX_ register SV *sv)
2305 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2306 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2307 cache IVs just in case. */
2311 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2312 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2313 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2315 return Atof(SvPVX_const(sv));
2319 return (NV)SvUVX(sv);
2321 return (NV)SvIVX(sv);
2326 assert(SvTYPE(sv) >= SVt_PVMG);
2327 /* This falls through to the report_uninit near the end of the
2329 } else if (SvTHINKFIRST(sv)) {
2333 SV *const tmpstr = AMG_CALLun(sv,numer);
2334 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2335 return SvNV(tmpstr);
2338 return PTR2NV(SvRV(sv));
2341 sv_force_normal_flags(sv, 0);
2343 if (SvREADONLY(sv) && !SvOK(sv)) {
2344 if (ckWARN(WARN_UNINITIALIZED))
2349 if (SvTYPE(sv) < SVt_NV) {
2350 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2351 sv_upgrade(sv, SVt_NV);
2352 #ifdef USE_LONG_DOUBLE
2354 STORE_NUMERIC_LOCAL_SET_STANDARD();
2355 PerlIO_printf(Perl_debug_log,
2356 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2357 PTR2UV(sv), SvNVX(sv));
2358 RESTORE_NUMERIC_LOCAL();
2362 STORE_NUMERIC_LOCAL_SET_STANDARD();
2363 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2364 PTR2UV(sv), SvNVX(sv));
2365 RESTORE_NUMERIC_LOCAL();
2369 else if (SvTYPE(sv) < SVt_PVNV)
2370 sv_upgrade(sv, SVt_PVNV);
2375 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2376 #ifdef NV_PRESERVES_UV
2379 /* Only set the public NV OK flag if this NV preserves the IV */
2380 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2381 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2382 : (SvIVX(sv) == I_V(SvNVX(sv))))
2388 else if (SvPOKp(sv) && SvLEN(sv)) {
2390 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2391 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2393 #ifdef NV_PRESERVES_UV
2394 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2395 == IS_NUMBER_IN_UV) {
2396 /* It's definitely an integer */
2397 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2399 SvNV_set(sv, Atof(SvPVX_const(sv)));
2402 SvNV_set(sv, Atof(SvPVX_const(sv)));
2403 /* Only set the public NV OK flag if this NV preserves the value in
2404 the PV at least as well as an IV/UV would.
2405 Not sure how to do this 100% reliably. */
2406 /* if that shift count is out of range then Configure's test is
2407 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2409 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2410 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2411 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2412 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2413 /* Can't use strtol etc to convert this string, so don't try.
2414 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2417 /* value has been set. It may not be precise. */
2418 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2419 /* 2s complement assumption for (UV)IV_MIN */
2420 SvNOK_on(sv); /* Integer is too negative. */
2425 if (numtype & IS_NUMBER_NEG) {
2426 SvIV_set(sv, -(IV)value);
2427 } else if (value <= (UV)IV_MAX) {
2428 SvIV_set(sv, (IV)value);
2430 SvUV_set(sv, value);
2434 if (numtype & IS_NUMBER_NOT_INT) {
2435 /* I believe that even if the original PV had decimals,
2436 they are lost beyond the limit of the FP precision.
2437 However, neither is canonical, so both only get p
2438 flags. NWC, 2000/11/25 */
2439 /* Both already have p flags, so do nothing */
2441 const NV nv = SvNVX(sv);
2442 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2443 if (SvIVX(sv) == I_V(nv)) {
2446 /* It had no "." so it must be integer. */
2450 /* between IV_MAX and NV(UV_MAX).
2451 Could be slightly > UV_MAX */
2453 if (numtype & IS_NUMBER_NOT_INT) {
2454 /* UV and NV both imprecise. */
2456 const UV nv_as_uv = U_V(nv);
2458 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2467 #endif /* NV_PRESERVES_UV */
2470 if (isGV_with_GP(sv)) {
2471 glob_2number((GV *)sv);
2475 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2477 assert (SvTYPE(sv) >= SVt_NV);
2478 /* Typically the caller expects that sv_any is not NULL now. */
2479 /* XXX Ilya implies that this is a bug in callers that assume this
2480 and ideally should be fixed. */
2483 #if defined(USE_LONG_DOUBLE)
2485 STORE_NUMERIC_LOCAL_SET_STANDARD();
2486 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2487 PTR2UV(sv), SvNVX(sv));
2488 RESTORE_NUMERIC_LOCAL();
2492 STORE_NUMERIC_LOCAL_SET_STANDARD();
2493 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2494 PTR2UV(sv), SvNVX(sv));
2495 RESTORE_NUMERIC_LOCAL();
2501 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2502 * UV as a string towards the end of buf, and return pointers to start and
2505 * We assume that buf is at least TYPE_CHARS(UV) long.
2509 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2511 char *ptr = buf + TYPE_CHARS(UV);
2512 char * const ebuf = ptr;
2525 *--ptr = '0' + (char)(uv % 10);
2534 =for apidoc sv_2pv_flags
2536 Returns a pointer to the string value of an SV, and sets *lp to its length.
2537 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2539 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2540 usually end up here too.
2546 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2556 if (SvGMAGICAL(sv)) {
2557 if (flags & SV_GMAGIC)
2562 if (flags & SV_MUTABLE_RETURN)
2563 return SvPVX_mutable(sv);
2564 if (flags & SV_CONST_RETURN)
2565 return (char *)SvPVX_const(sv);
2568 if (SvIOKp(sv) || SvNOKp(sv)) {
2569 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2574 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2575 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2577 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2584 #ifdef FIXNEGATIVEZERO
2585 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2591 SvUPGRADE(sv, SVt_PV);
2594 s = SvGROW_mutable(sv, len + 1);
2597 return (char*)memcpy(s, tbuf, len + 1);
2603 assert(SvTYPE(sv) >= SVt_PVMG);
2604 /* This falls through to the report_uninit near the end of the
2606 } else if (SvTHINKFIRST(sv)) {
2610 SV *const tmpstr = AMG_CALLun(sv,string);
2611 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2613 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2617 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2618 if (flags & SV_CONST_RETURN) {
2619 pv = (char *) SvPVX_const(tmpstr);
2621 pv = (flags & SV_MUTABLE_RETURN)
2622 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2625 *lp = SvCUR(tmpstr);
2627 pv = sv_2pv_flags(tmpstr, lp, flags);
2641 const SV *const referent = (SV*)SvRV(sv);
2645 retval = buffer = savepvn("NULLREF", len);
2646 } else if (SvTYPE(referent) == SVt_PVMG
2647 && ((SvFLAGS(referent) &
2648 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2649 == (SVs_OBJECT|SVs_SMG))
2650 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2655 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2660 PL_reginterp_cnt += haseval;
2663 const char *const typestr = sv_reftype(referent, 0);
2664 const STRLEN typelen = strlen(typestr);
2665 UV addr = PTR2UV(referent);
2666 const char *stashname = NULL;
2667 STRLEN stashnamelen = 0; /* hush, gcc */
2668 const char *buffer_end;
2670 if (SvOBJECT(referent)) {
2671 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2674 stashname = HEK_KEY(name);
2675 stashnamelen = HEK_LEN(name);
2677 if (HEK_UTF8(name)) {
2683 stashname = "__ANON__";
2686 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2687 + 2 * sizeof(UV) + 2 /* )\0 */;
2689 len = typelen + 3 /* (0x */
2690 + 2 * sizeof(UV) + 2 /* )\0 */;
2693 Newx(buffer, len, char);
2694 buffer_end = retval = buffer + len;
2696 /* Working backwards */
2700 *--retval = PL_hexdigit[addr & 15];
2701 } while (addr >>= 4);
2707 memcpy(retval, typestr, typelen);
2711 retval -= stashnamelen;
2712 memcpy(retval, stashname, stashnamelen);
2714 /* retval may not neccesarily have reached the start of the
2716 assert (retval >= buffer);
2718 len = buffer_end - retval - 1; /* -1 for that \0 */
2726 if (SvREADONLY(sv) && !SvOK(sv)) {
2727 if (ckWARN(WARN_UNINITIALIZED))
2734 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2735 /* I'm assuming that if both IV and NV are equally valid then
2736 converting the IV is going to be more efficient */
2737 const U32 isUIOK = SvIsUV(sv);
2738 char buf[TYPE_CHARS(UV)];
2741 if (SvTYPE(sv) < SVt_PVIV)
2742 sv_upgrade(sv, SVt_PVIV);
2743 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2744 /* inlined from sv_setpvn */
2745 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2746 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2747 SvCUR_set(sv, ebuf - ptr);
2751 else if (SvNOKp(sv)) {
2752 const int olderrno = errno;
2753 if (SvTYPE(sv) < SVt_PVNV)
2754 sv_upgrade(sv, SVt_PVNV);
2755 /* The +20 is pure guesswork. Configure test needed. --jhi */
2756 s = SvGROW_mutable(sv, NV_DIG + 20);
2757 /* some Xenix systems wipe out errno here */
2759 if (SvNVX(sv) == 0.0)
2760 my_strlcpy(s, "0", SvLEN(sv));
2764 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2767 #ifdef FIXNEGATIVEZERO
2768 if (*s == '-' && s[1] == '0' && !s[2])
2769 my_strlcpy(s, "0", SvLEN(s));
2778 if (isGV_with_GP(sv))
2779 return glob_2pv((GV *)sv, lp);
2781 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2785 if (SvTYPE(sv) < SVt_PV)
2786 /* Typically the caller expects that sv_any is not NULL now. */
2787 sv_upgrade(sv, SVt_PV);
2791 const STRLEN len = s - SvPVX_const(sv);
2797 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2798 PTR2UV(sv),SvPVX_const(sv)));
2799 if (flags & SV_CONST_RETURN)
2800 return (char *)SvPVX_const(sv);
2801 if (flags & SV_MUTABLE_RETURN)
2802 return SvPVX_mutable(sv);
2807 =for apidoc sv_copypv
2809 Copies a stringified representation of the source SV into the
2810 destination SV. Automatically performs any necessary mg_get and
2811 coercion of numeric values into strings. Guaranteed to preserve
2812 UTF-8 flag even from overloaded objects. Similar in nature to
2813 sv_2pv[_flags] but operates directly on an SV instead of just the
2814 string. Mostly uses sv_2pv_flags to do its work, except when that
2815 would lose the UTF-8'ness of the PV.
2821 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2824 const char * const s = SvPV_const(ssv,len);
2825 sv_setpvn(dsv,s,len);
2833 =for apidoc sv_2pvbyte
2835 Return a pointer to the byte-encoded representation of the SV, and set *lp
2836 to its length. May cause the SV to be downgraded from UTF-8 as a
2839 Usually accessed via the C<SvPVbyte> macro.
2845 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2847 sv_utf8_downgrade(sv,0);
2848 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2852 =for apidoc sv_2pvutf8
2854 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2855 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2857 Usually accessed via the C<SvPVutf8> macro.
2863 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2865 sv_utf8_upgrade(sv);
2866 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2871 =for apidoc sv_2bool
2873 This function is only called on magical items, and is only used by
2874 sv_true() or its macro equivalent.
2880 Perl_sv_2bool(pTHX_ register SV *sv)
2889 SV * const tmpsv = AMG_CALLun(sv,bool_);
2890 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2891 return (bool)SvTRUE(tmpsv);
2893 return SvRV(sv) != 0;
2896 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2898 (*sv->sv_u.svu_pv > '0' ||
2899 Xpvtmp->xpv_cur > 1 ||
2900 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2907 return SvIVX(sv) != 0;
2910 return SvNVX(sv) != 0.0;
2912 if (isGV_with_GP(sv))
2922 =for apidoc sv_utf8_upgrade
2924 Converts the PV of an SV to its UTF-8-encoded form.
2925 Forces the SV to string form if it is not already.
2926 Always sets the SvUTF8 flag to avoid future validity checks even
2927 if all the bytes have hibit clear.
2929 This is not as a general purpose byte encoding to Unicode interface:
2930 use the Encode extension for that.
2932 =for apidoc sv_utf8_upgrade_flags
2934 Converts the PV of an SV to its UTF-8-encoded form.
2935 Forces the SV to string form if it is not already.
2936 Always sets the SvUTF8 flag to avoid future validity checks even
2937 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2938 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2939 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2941 This is not as a general purpose byte encoding to Unicode interface:
2942 use the Encode extension for that.
2948 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2951 if (sv == &PL_sv_undef)
2955 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2956 (void) sv_2pv_flags(sv,&len, flags);
2960 (void) SvPV_force(sv,len);
2969 sv_force_normal_flags(sv, 0);
2972 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2973 sv_recode_to_utf8(sv, PL_encoding);
2974 else { /* Assume Latin-1/EBCDIC */
2975 /* This function could be much more efficient if we
2976 * had a FLAG in SVs to signal if there are any hibit
2977 * chars in the PV. Given that there isn't such a flag
2978 * make the loop as fast as possible. */
2979 const U8 * const s = (U8 *) SvPVX_const(sv);
2980 const U8 * const e = (U8 *) SvEND(sv);
2985 /* Check for hi bit */
2986 if (!NATIVE_IS_INVARIANT(ch)) {
2987 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2988 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2990 SvPV_free(sv); /* No longer using what was there before. */
2991 SvPV_set(sv, (char*)recoded);
2992 SvCUR_set(sv, len - 1);
2993 SvLEN_set(sv, len); /* No longer know the real size. */
2997 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3004 =for apidoc sv_utf8_downgrade
3006 Attempts to convert the PV of an SV from characters to bytes.
3007 If the PV contains a character beyond byte, this conversion will fail;
3008 in this case, either returns false or, if C<fail_ok> is not
3011 This is not as a general purpose Unicode to byte encoding interface:
3012 use the Encode extension for that.
3018 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3021 if (SvPOKp(sv) && SvUTF8(sv)) {
3027 sv_force_normal_flags(sv, 0);
3029 s = (U8 *) SvPV(sv, len);
3030 if (!utf8_to_bytes(s, &len)) {
3035 Perl_croak(aTHX_ "Wide character in %s",
3038 Perl_croak(aTHX_ "Wide character");
3049 =for apidoc sv_utf8_encode
3051 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3052 flag off so that it looks like octets again.
3058 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3061 sv_force_normal_flags(sv, 0);
3063 if (SvREADONLY(sv)) {
3064 Perl_croak(aTHX_ PL_no_modify);
3066 (void) sv_utf8_upgrade(sv);
3071 =for apidoc sv_utf8_decode
3073 If the PV of the SV is an octet sequence in UTF-8
3074 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3075 so that it looks like a character. If the PV contains only single-byte
3076 characters, the C<SvUTF8> flag stays being off.
3077 Scans PV for validity and returns false if the PV is invalid UTF-8.
3083 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3089 /* The octets may have got themselves encoded - get them back as
3092 if (!sv_utf8_downgrade(sv, TRUE))
3095 /* it is actually just a matter of turning the utf8 flag on, but
3096 * we want to make sure everything inside is valid utf8 first.
3098 c = (const U8 *) SvPVX_const(sv);
3099 if (!is_utf8_string(c, SvCUR(sv)+1))
3101 e = (const U8 *) SvEND(sv);
3104 if (!UTF8_IS_INVARIANT(ch)) {
3114 =for apidoc sv_setsv
3116 Copies the contents of the source SV C<ssv> into the destination SV
3117 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3118 function if the source SV needs to be reused. Does not handle 'set' magic.
3119 Loosely speaking, it performs a copy-by-value, obliterating any previous
3120 content of the destination.
3122 You probably want to use one of the assortment of wrappers, such as
3123 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3124 C<SvSetMagicSV_nosteal>.
3126 =for apidoc sv_setsv_flags
3128 Copies the contents of the source SV C<ssv> into the destination SV
3129 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3130 function if the source SV needs to be reused. Does not handle 'set' magic.
3131 Loosely speaking, it performs a copy-by-value, obliterating any previous
3132 content of the destination.
3133 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3134 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3135 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3136 and C<sv_setsv_nomg> are implemented in terms of this function.
3138 You probably want to use one of the assortment of wrappers, such as
3139 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3140 C<SvSetMagicSV_nosteal>.
3142 This is the primary function for copying scalars, and most other
3143 copy-ish functions and macros use this underneath.
3149 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3151 if (dtype != SVt_PVGV) {
3152 const char * const name = GvNAME(sstr);
3153 const STRLEN len = GvNAMELEN(sstr);
3155 if (dtype >= SVt_PV) {
3161 SvUPGRADE(dstr, SVt_PVGV);
3162 (void)SvOK_off(dstr);
3163 /* FIXME - why are we doing this, then turning it off and on again
3165 isGV_with_GP_on(dstr);
3167 GvSTASH(dstr) = GvSTASH(sstr);
3169 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3170 gv_name_set((GV *)dstr, name, len, GV_ADD);
3171 SvFAKE_on(dstr); /* can coerce to non-glob */
3174 #ifdef GV_UNIQUE_CHECK
3175 if (GvUNIQUE((GV*)dstr)) {
3176 Perl_croak(aTHX_ PL_no_modify);
3181 isGV_with_GP_off(dstr);
3182 (void)SvOK_off(dstr);
3183 isGV_with_GP_on(dstr);
3184 GvINTRO_off(dstr); /* one-shot flag */
3185 GvGP(dstr) = gp_ref(GvGP(sstr));
3186 if (SvTAINTED(sstr))
3188 if (GvIMPORTED(dstr) != GVf_IMPORTED
3189 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3191 GvIMPORTED_on(dstr);
3198 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3199 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3201 const int intro = GvINTRO(dstr);
3204 const U32 stype = SvTYPE(sref);
3207 #ifdef GV_UNIQUE_CHECK
3208 if (GvUNIQUE((GV*)dstr)) {
3209 Perl_croak(aTHX_ PL_no_modify);
3214 GvINTRO_off(dstr); /* one-shot flag */
3215 GvLINE(dstr) = CopLINE(PL_curcop);
3216 GvEGV(dstr) = (GV*)dstr;
3221 location = (SV **) &GvCV(dstr);
3222 import_flag = GVf_IMPORTED_CV;
3225 location = (SV **) &GvHV(dstr);
3226 import_flag = GVf_IMPORTED_HV;
3229 location = (SV **) &GvAV(dstr);
3230 import_flag = GVf_IMPORTED_AV;
3233 location = (SV **) &GvIOp(dstr);
3236 location = (SV **) &GvFORM(dstr);
3238 location = &GvSV(dstr);
3239 import_flag = GVf_IMPORTED_SV;
3242 if (stype == SVt_PVCV) {
3243 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3244 SvREFCNT_dec(GvCV(dstr));
3246 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3247 PL_sub_generation++;
3250 SAVEGENERICSV(*location);
3254 if (stype == SVt_PVCV && *location != sref) {
3255 CV* const cv = (CV*)*location;
3257 if (!GvCVGEN((GV*)dstr) &&
3258 (CvROOT(cv) || CvXSUB(cv)))
3260 /* Redefining a sub - warning is mandatory if
3261 it was a const and its value changed. */
3262 if (CvCONST(cv) && CvCONST((CV*)sref)
3263 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3265 /* They are 2 constant subroutines generated from
3266 the same constant. This probably means that
3267 they are really the "same" proxy subroutine
3268 instantiated in 2 places. Most likely this is
3269 when a constant is exported twice. Don't warn.
3272 else if (ckWARN(WARN_REDEFINE)
3274 && (!CvCONST((CV*)sref)
3275 || sv_cmp(cv_const_sv(cv),
3276 cv_const_sv((CV*)sref))))) {
3277 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3280 ? "Constant subroutine %s::%s redefined"
3281 : "Subroutine %s::%s redefined"),
3282 HvNAME_get(GvSTASH((GV*)dstr)),
3283 GvENAME((GV*)dstr));
3287 cv_ckproto_len(cv, (GV*)dstr,
3288 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3289 SvPOK(sref) ? SvCUR(sref) : 0);
3291 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3292 GvASSUMECV_on(dstr);
3293 PL_sub_generation++;
3296 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3297 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3298 GvFLAGS(dstr) |= import_flag;
3303 if (SvTAINTED(sstr))
3309 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3312 register U32 sflags;
3314 register svtype stype;
3319 if (SvIS_FREED(dstr)) {
3320 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3321 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3323 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3325 sstr = &PL_sv_undef;
3326 if (SvIS_FREED(sstr)) {
3327 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3328 (void*)sstr, (void*)dstr);
3330 stype = SvTYPE(sstr);
3331 dtype = SvTYPE(dstr);
3333 (void)SvAMAGIC_off(dstr);
3336 /* need to nuke the magic */
3338 SvRMAGICAL_off(dstr);
3341 /* There's a lot of redundancy below but we're going for speed here */
3346 if (dtype != SVt_PVGV) {
3347 (void)SvOK_off(dstr);
3355 sv_upgrade(dstr, SVt_IV);
3360 sv_upgrade(dstr, SVt_PVIV);
3363 goto end_of_first_switch;
3365 (void)SvIOK_only(dstr);
3366 SvIV_set(dstr, SvIVX(sstr));
3369 /* SvTAINTED can only be true if the SV has taint magic, which in
3370 turn means that the SV type is PVMG (or greater). This is the
3371 case statement for SVt_IV, so this cannot be true (whatever gcov
3373 assert(!SvTAINTED(sstr));
3383 sv_upgrade(dstr, SVt_NV);
3388 sv_upgrade(dstr, SVt_PVNV);
3391 goto end_of_first_switch;
3393 SvNV_set(dstr, SvNVX(sstr));
3394 (void)SvNOK_only(dstr);
3395 /* SvTAINTED can only be true if the SV has taint magic, which in
3396 turn means that the SV type is PVMG (or greater). This is the
3397 case statement for SVt_NV, so this cannot be true (whatever gcov
3399 assert(!SvTAINTED(sstr));
3406 sv_upgrade(dstr, SVt_RV);
3409 #ifdef PERL_OLD_COPY_ON_WRITE
3410 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3411 if (dtype < SVt_PVIV)
3412 sv_upgrade(dstr, SVt_PVIV);
3419 sv_upgrade(dstr, SVt_PV);
3422 if (dtype < SVt_PVIV)
3423 sv_upgrade(dstr, SVt_PVIV);
3426 if (dtype < SVt_PVNV)
3427 sv_upgrade(dstr, SVt_PVNV);
3431 const char * const type = sv_reftype(sstr,0);
3433 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3435 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3439 /* case SVt_BIND: */
3442 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3443 glob_assign_glob(dstr, sstr, dtype);
3446 /* SvVALID means that this PVGV is playing at being an FBM. */
3450 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3452 if (SvTYPE(sstr) != stype) {
3453 stype = SvTYPE(sstr);
3454 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3455 glob_assign_glob(dstr, sstr, dtype);
3460 if (stype == SVt_PVLV)
3461 SvUPGRADE(dstr, SVt_PVNV);
3463 SvUPGRADE(dstr, (svtype)stype);
3465 end_of_first_switch:
3467 /* dstr may have been upgraded. */
3468 dtype = SvTYPE(dstr);
3469 sflags = SvFLAGS(sstr);
3471 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3472 /* Assigning to a subroutine sets the prototype. */
3475 const char *const ptr = SvPV_const(sstr, len);
3477 SvGROW(dstr, len + 1);
3478 Copy(ptr, SvPVX(dstr), len + 1, char);
3479 SvCUR_set(dstr, len);
3481 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3485 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3486 const char * const type = sv_reftype(dstr,0);
3488 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3490 Perl_croak(aTHX_ "Cannot copy to %s", type);
3491 } else if (sflags & SVf_ROK) {
3492 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3493 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3496 if (GvIMPORTED(dstr) != GVf_IMPORTED
3497 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3499 GvIMPORTED_on(dstr);
3504 glob_assign_glob(dstr, sstr, dtype);
3508 if (dtype >= SVt_PV) {
3509 if (dtype == SVt_PVGV) {
3510 glob_assign_ref(dstr, sstr);
3513 if (SvPVX_const(dstr)) {
3519 (void)SvOK_off(dstr);
3520 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3521 SvFLAGS(dstr) |= sflags & SVf_ROK;
3522 assert(!(sflags & SVp_NOK));
3523 assert(!(sflags & SVp_IOK));
3524 assert(!(sflags & SVf_NOK));
3525 assert(!(sflags & SVf_IOK));
3527 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3528 if (!(sflags & SVf_OK)) {
3529 if (ckWARN(WARN_MISC))
3530 Perl_warner(aTHX_ packWARN(WARN_MISC),
3531 "Undefined value assigned to typeglob");
3534 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3535 if (dstr != (SV*)gv) {
3538 GvGP(dstr) = gp_ref(GvGP(gv));
3542 else if (sflags & SVp_POK) {
3546 * Check to see if we can just swipe the string. If so, it's a
3547 * possible small lose on short strings, but a big win on long ones.
3548 * It might even be a win on short strings if SvPVX_const(dstr)
3549 * has to be allocated and SvPVX_const(sstr) has to be freed.
3550 * Likewise if we can set up COW rather than doing an actual copy, we
3551 * drop to the else clause, as the swipe code and the COW setup code
3552 * have much in common.
3555 /* Whichever path we take through the next code, we want this true,
3556 and doing it now facilitates the COW check. */
3557 (void)SvPOK_only(dstr);
3560 /* If we're already COW then this clause is not true, and if COW
3561 is allowed then we drop down to the else and make dest COW
3562 with us. If caller hasn't said that we're allowed to COW
3563 shared hash keys then we don't do the COW setup, even if the
3564 source scalar is a shared hash key scalar. */
3565 (((flags & SV_COW_SHARED_HASH_KEYS)
3566 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3567 : 1 /* If making a COW copy is forbidden then the behaviour we
3568 desire is as if the source SV isn't actually already
3569 COW, even if it is. So we act as if the source flags
3570 are not COW, rather than actually testing them. */
3572 #ifndef PERL_OLD_COPY_ON_WRITE
3573 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3574 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3575 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3576 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3577 but in turn, it's somewhat dead code, never expected to go
3578 live, but more kept as a placeholder on how to do it better
3579 in a newer implementation. */
3580 /* If we are COW and dstr is a suitable target then we drop down
3581 into the else and make dest a COW of us. */
3582 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3587 (sflags & SVs_TEMP) && /* slated for free anyway? */
3588 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3589 (!(flags & SV_NOSTEAL)) &&
3590 /* and we're allowed to steal temps */
3591 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3592 SvLEN(sstr) && /* and really is a string */
3593 /* and won't be needed again, potentially */
3594 !(PL_op && PL_op->op_type == OP_AASSIGN))
3595 #ifdef PERL_OLD_COPY_ON_WRITE
3596 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3597 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3598 && SvTYPE(sstr) >= SVt_PVIV)
3601 /* Failed the swipe test, and it's not a shared hash key either.
3602 Have to copy the string. */
3603 STRLEN len = SvCUR(sstr);
3604 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3605 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3606 SvCUR_set(dstr, len);
3607 *SvEND(dstr) = '\0';
3609 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3611 /* Either it's a shared hash key, or it's suitable for
3612 copy-on-write or we can swipe the string. */
3614 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3618 #ifdef PERL_OLD_COPY_ON_WRITE
3620 /* I believe I should acquire a global SV mutex if
3621 it's a COW sv (not a shared hash key) to stop
3622 it going un copy-on-write.
3623 If the source SV has gone un copy on write between up there
3624 and down here, then (assert() that) it is of the correct
3625 form to make it copy on write again */
3626 if ((sflags & (SVf_FAKE | SVf_READONLY))
3627 != (SVf_FAKE | SVf_READONLY)) {
3628 SvREADONLY_on(sstr);
3630 /* Make the source SV into a loop of 1.
3631 (about to become 2) */
3632 SV_COW_NEXT_SV_SET(sstr, sstr);
3636 /* Initial code is common. */
3637 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3642 /* making another shared SV. */
3643 STRLEN cur = SvCUR(sstr);
3644 STRLEN len = SvLEN(sstr);
3645 #ifdef PERL_OLD_COPY_ON_WRITE
3647 assert (SvTYPE(dstr) >= SVt_PVIV);
3648 /* SvIsCOW_normal */
3649 /* splice us in between source and next-after-source. */
3650 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3651 SV_COW_NEXT_SV_SET(sstr, dstr);
3652 SvPV_set(dstr, SvPVX_mutable(sstr));
3656 /* SvIsCOW_shared_hash */
3657 DEBUG_C(PerlIO_printf(Perl_debug_log,
3658 "Copy on write: Sharing hash\n"));
3660 assert (SvTYPE(dstr) >= SVt_PV);
3662 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3664 SvLEN_set(dstr, len);
3665 SvCUR_set(dstr, cur);
3666 SvREADONLY_on(dstr);
3668 /* Relesase a global SV mutex. */
3671 { /* Passes the swipe test. */
3672 SvPV_set(dstr, SvPVX_mutable(sstr));
3673 SvLEN_set(dstr, SvLEN(sstr));
3674 SvCUR_set(dstr, SvCUR(sstr));
3677 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3678 SvPV_set(sstr, NULL);
3684 if (sflags & SVp_NOK) {
3685 SvNV_set(dstr, SvNVX(sstr));
3687 if (sflags & SVp_IOK) {
3689 SvIV_set(dstr, SvIVX(sstr));
3690 /* Must do this otherwise some other overloaded use of 0x80000000
3691 gets confused. I guess SVpbm_VALID */
3692 if (sflags & SVf_IVisUV)
3695 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3697 const MAGIC * const smg = SvVSTRING_mg(sstr);
3699 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3700 smg->mg_ptr, smg->mg_len);
3701 SvRMAGICAL_on(dstr);
3705 else if (sflags & (SVp_IOK|SVp_NOK)) {
3706 (void)SvOK_off(dstr);
3707 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3708 if (sflags & SVp_IOK) {
3709 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3710 SvIV_set(dstr, SvIVX(sstr));
3712 if (sflags & SVp_NOK) {
3713 SvNV_set(dstr, SvNVX(sstr));
3717 if (isGV_with_GP(sstr)) {
3718 /* This stringification rule for globs is spread in 3 places.
3719 This feels bad. FIXME. */
3720 const U32 wasfake = sflags & SVf_FAKE;
3722 /* FAKE globs can get coerced, so need to turn this off
3723 temporarily if it is on. */
3725 gv_efullname3(dstr, (GV *)sstr, "*");
3726 SvFLAGS(sstr) |= wasfake;
3729 (void)SvOK_off(dstr);
3731 if (SvTAINTED(sstr))
3736 =for apidoc sv_setsv_mg
3738 Like C<sv_setsv>, but also handles 'set' magic.
3744 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3746 sv_setsv(dstr,sstr);
3750 #ifdef PERL_OLD_COPY_ON_WRITE
3752 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3754 STRLEN cur = SvCUR(sstr);
3755 STRLEN len = SvLEN(sstr);
3756 register char *new_pv;
3759 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3760 (void*)sstr, (void*)dstr);
3767 if (SvTHINKFIRST(dstr))
3768 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3769 else if (SvPVX_const(dstr))
3770 Safefree(SvPVX_const(dstr));
3774 SvUPGRADE(dstr, SVt_PVIV);
3776 assert (SvPOK(sstr));
3777 assert (SvPOKp(sstr));
3778 assert (!SvIOK(sstr));
3779 assert (!SvIOKp(sstr));
3780 assert (!SvNOK(sstr));
3781 assert (!SvNOKp(sstr));
3783 if (SvIsCOW(sstr)) {
3785 if (SvLEN(sstr) == 0) {
3786 /* source is a COW shared hash key. */
3787 DEBUG_C(PerlIO_printf(Perl_debug_log,
3788 "Fast copy on write: Sharing hash\n"));
3789 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3792 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3794 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3795 SvUPGRADE(sstr, SVt_PVIV);
3796 SvREADONLY_on(sstr);
3798 DEBUG_C(PerlIO_printf(Perl_debug_log,
3799 "Fast copy on write: Converting sstr to COW\n"));
3800 SV_COW_NEXT_SV_SET(dstr, sstr);
3802 SV_COW_NEXT_SV_SET(sstr, dstr);
3803 new_pv = SvPVX_mutable(sstr);
3806 SvPV_set(dstr, new_pv);
3807 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3810 SvLEN_set(dstr, len);
3811 SvCUR_set(dstr, cur);
3820 =for apidoc sv_setpvn
3822 Copies a string into an SV. The C<len> parameter indicates the number of
3823 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3824 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3830 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3833 register char *dptr;
3835 SV_CHECK_THINKFIRST_COW_DROP(sv);
3841 /* len is STRLEN which is unsigned, need to copy to signed */
3844 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3846 SvUPGRADE(sv, SVt_PV);
3848 dptr = SvGROW(sv, len + 1);
3849 Move(ptr,dptr,len,char);
3852 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3857 =for apidoc sv_setpvn_mg
3859 Like C<sv_setpvn>, but also handles 'set' magic.
3865 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3867 sv_setpvn(sv,ptr,len);
3872 =for apidoc sv_setpv
3874 Copies a string into an SV. The string must be null-terminated. Does not
3875 handle 'set' magic. See C<sv_setpv_mg>.
3881 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3884 register STRLEN len;
3886 SV_CHECK_THINKFIRST_COW_DROP(sv);
3892 SvUPGRADE(sv, SVt_PV);
3894 SvGROW(sv, len + 1);
3895 Move(ptr,SvPVX(sv),len+1,char);
3897 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3902 =for apidoc sv_setpv_mg
3904 Like C<sv_setpv>, but also handles 'set' magic.
3910 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3917 =for apidoc sv_usepvn_flags
3919 Tells an SV to use C<ptr> to find its string value. Normally the
3920 string is stored inside the SV but sv_usepvn allows the SV to use an
3921 outside string. The C<ptr> should point to memory that was allocated
3922 by C<malloc>. The string length, C<len>, must be supplied. By default
3923 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3924 so that pointer should not be freed or used by the programmer after
3925 giving it to sv_usepvn, and neither should any pointers from "behind"
3926 that pointer (e.g. ptr + 1) be used.
3928 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3929 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3930 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3931 C<len>, and already meets the requirements for storing in C<SvPVX>)
3937 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3941 SV_CHECK_THINKFIRST_COW_DROP(sv);
3942 SvUPGRADE(sv, SVt_PV);
3945 if (flags & SV_SMAGIC)
3949 if (SvPVX_const(sv))
3953 if (flags & SV_HAS_TRAILING_NUL)
3954 assert(ptr[len] == '\0');
3957 allocate = (flags & SV_HAS_TRAILING_NUL)
3958 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3959 if (flags & SV_HAS_TRAILING_NUL) {
3960 /* It's long enough - do nothing.
3961 Specfically Perl_newCONSTSUB is relying on this. */
3964 /* Force a move to shake out bugs in callers. */
3965 char *new_ptr = (char*)safemalloc(allocate);
3966 Copy(ptr, new_ptr, len, char);
3967 PoisonFree(ptr,len,char);
3971 ptr = (char*) saferealloc (ptr, allocate);
3976 SvLEN_set(sv, allocate);
3977 if (!(flags & SV_HAS_TRAILING_NUL)) {
3980 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3982 if (flags & SV_SMAGIC)
3986 #ifdef PERL_OLD_COPY_ON_WRITE
3987 /* Need to do this *after* making the SV normal, as we need the buffer
3988 pointer to remain valid until after we've copied it. If we let go too early,
3989 another thread could invalidate it by unsharing last of the same hash key
3990 (which it can do by means other than releasing copy-on-write Svs)
3991 or by changing the other copy-on-write SVs in the loop. */
3993 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
3995 { /* this SV was SvIsCOW_normal(sv) */
3996 /* we need to find the SV pointing to us. */
3997 SV *current = SV_COW_NEXT_SV(after);
3999 if (current == sv) {
4000 /* The SV we point to points back to us (there were only two of us
4002 Hence other SV is no longer copy on write either. */
4004 SvREADONLY_off(after);
4006 /* We need to follow the pointers around the loop. */
4008 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4011 /* don't loop forever if the structure is bust, and we have
4012 a pointer into a closed loop. */
4013 assert (current != after);
4014 assert (SvPVX_const(current) == pvx);
4016 /* Make the SV before us point to the SV after us. */
4017 SV_COW_NEXT_SV_SET(current, after);
4023 =for apidoc sv_force_normal_flags
4025 Undo various types of fakery on an SV: if the PV is a shared string, make
4026 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4027 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4028 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4029 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4030 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4031 set to some other value.) In addition, the C<flags> parameter gets passed to
4032 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4033 with flags set to 0.
4039 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4042 #ifdef PERL_OLD_COPY_ON_WRITE
4043 if (SvREADONLY(sv)) {
4044 /* At this point I believe I should acquire a global SV mutex. */
4046 const char * const pvx = SvPVX_const(sv);
4047 const STRLEN len = SvLEN(sv);
4048 const STRLEN cur = SvCUR(sv);
4049 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4050 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4051 we'll fail an assertion. */
4052 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4055 PerlIO_printf(Perl_debug_log,
4056 "Copy on write: Force normal %ld\n",
4062 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4065 if (flags & SV_COW_DROP_PV) {
4066 /* OK, so we don't need to copy our buffer. */
4069 SvGROW(sv, cur + 1);
4070 Move(pvx,SvPVX(sv),cur,char);
4075 sv_release_COW(sv, pvx, next);
4077 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4083 else if (IN_PERL_RUNTIME)
4084 Perl_croak(aTHX_ PL_no_modify);
4085 /* At this point I believe that I can drop the global SV mutex. */
4088 if (SvREADONLY(sv)) {
4090 const char * const pvx = SvPVX_const(sv);
4091 const STRLEN len = SvCUR(sv);
4096 SvGROW(sv, len + 1);
4097 Move(pvx,SvPVX(sv),len,char);
4099 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4101 else if (IN_PERL_RUNTIME)
4102 Perl_croak(aTHX_ PL_no_modify);
4106 sv_unref_flags(sv, flags);
4107 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4114 Efficient removal of characters from the beginning of the string buffer.
4115 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4116 the string buffer. The C<ptr> becomes the first character of the adjusted
4117 string. Uses the "OOK hack".
4118 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4119 refer to the same chunk of data.
4125 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4127 register STRLEN delta;
4128 if (!ptr || !SvPOKp(sv))
4130 delta = ptr - SvPVX_const(sv);
4131 SV_CHECK_THINKFIRST(sv);
4132 if (SvTYPE(sv) < SVt_PVIV)
4133 sv_upgrade(sv,SVt_PVIV);
4136 if (!SvLEN(sv)) { /* make copy of shared string */
4137 const char *pvx = SvPVX_const(sv);
4138 const STRLEN len = SvCUR(sv);
4139 SvGROW(sv, len + 1);
4140 Move(pvx,SvPVX(sv),len,char);
4144 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4145 and we do that anyway inside the SvNIOK_off
4147 SvFLAGS(sv) |= SVf_OOK;
4150 SvLEN_set(sv, SvLEN(sv) - delta);
4151 SvCUR_set(sv, SvCUR(sv) - delta);
4152 SvPV_set(sv, SvPVX(sv) + delta);
4153 SvIV_set(sv, SvIVX(sv) + delta);
4157 =for apidoc sv_catpvn
4159 Concatenates the string onto the end of the string which is in the SV. The
4160 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4161 status set, then the bytes appended should be valid UTF-8.
4162 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4164 =for apidoc sv_catpvn_flags
4166 Concatenates the string onto the end of the string which is in the SV. The
4167 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4168 status set, then the bytes appended should be valid UTF-8.
4169 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4170 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4171 in terms of this function.
4177 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4181 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4183 SvGROW(dsv, dlen + slen + 1);
4185 sstr = SvPVX_const(dsv);
4186 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4187 SvCUR_set(dsv, SvCUR(dsv) + slen);
4189 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4191 if (flags & SV_SMAGIC)
4196 =for apidoc sv_catsv
4198 Concatenates the string from SV C<ssv> onto the end of the string in
4199 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4200 not 'set' magic. See C<sv_catsv_mg>.
4202 =for apidoc sv_catsv_flags
4204 Concatenates the string from SV C<ssv> onto the end of the string in
4205 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4206 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4207 and C<sv_catsv_nomg> are implemented in terms of this function.
4212 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4217 const char *spv = SvPV_const(ssv, slen);
4219 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4220 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4221 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4222 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4223 dsv->sv_flags doesn't have that bit set.
4224 Andy Dougherty 12 Oct 2001
4226 const I32 sutf8 = DO_UTF8(ssv);
4229 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4231 dutf8 = DO_UTF8(dsv);
4233 if (dutf8 != sutf8) {
4235 /* Not modifying source SV, so taking a temporary copy. */
4236 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4238 sv_utf8_upgrade(csv);
4239 spv = SvPV_const(csv, slen);
4242 sv_utf8_upgrade_nomg(dsv);
4244 sv_catpvn_nomg(dsv, spv, slen);
4247 if (flags & SV_SMAGIC)
4252 =for apidoc sv_catpv
4254 Concatenates the string onto the end of the string which is in the SV.
4255 If the SV has the UTF-8 status set, then the bytes appended should be
4256 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4261 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4264 register STRLEN len;
4270 junk = SvPV_force(sv, tlen);
4272 SvGROW(sv, tlen + len + 1);
4274 ptr = SvPVX_const(sv);
4275 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4276 SvCUR_set(sv, SvCUR(sv) + len);
4277 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4282 =for apidoc sv_catpv_mg
4284 Like C<sv_catpv>, but also handles 'set' magic.
4290 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4299 Creates a new SV. A non-zero C<len> parameter indicates the number of
4300 bytes of preallocated string space the SV should have. An extra byte for a
4301 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4302 space is allocated.) The reference count for the new SV is set to 1.
4304 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4305 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4306 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4307 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4308 modules supporting older perls.
4314 Perl_newSV(pTHX_ STRLEN len)
4321 sv_upgrade(sv, SVt_PV);
4322 SvGROW(sv, len + 1);
4327 =for apidoc sv_magicext
4329 Adds magic to an SV, upgrading it if necessary. Applies the
4330 supplied vtable and returns a pointer to the magic added.
4332 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4333 In particular, you can add magic to SvREADONLY SVs, and add more than
4334 one instance of the same 'how'.
4336 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4337 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4338 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4339 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4341 (This is now used as a subroutine by C<sv_magic>.)
4346 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4347 const char* name, I32 namlen)
4352 if (SvTYPE(sv) < SVt_PVMG) {
4353 SvUPGRADE(sv, SVt_PVMG);
4355 Newxz(mg, 1, MAGIC);
4356 mg->mg_moremagic = SvMAGIC(sv);
4357 SvMAGIC_set(sv, mg);
4359 /* Sometimes a magic contains a reference loop, where the sv and
4360 object refer to each other. To prevent a reference loop that
4361 would prevent such objects being freed, we look for such loops
4362 and if we find one we avoid incrementing the object refcount.
4364 Note we cannot do this to avoid self-tie loops as intervening RV must
4365 have its REFCNT incremented to keep it in existence.
4368 if (!obj || obj == sv ||
4369 how == PERL_MAGIC_arylen ||
4370 how == PERL_MAGIC_qr ||
4371 how == PERL_MAGIC_symtab ||
4372 (SvTYPE(obj) == SVt_PVGV &&
4373 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4374 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4375 GvFORM(obj) == (CV*)sv)))
4380 mg->mg_obj = SvREFCNT_inc_simple(obj);
4381 mg->mg_flags |= MGf_REFCOUNTED;
4384 /* Normal self-ties simply pass a null object, and instead of
4385 using mg_obj directly, use the SvTIED_obj macro to produce a
4386 new RV as needed. For glob "self-ties", we are tieing the PVIO
4387 with an RV obj pointing to the glob containing the PVIO. In
4388 this case, to avoid a reference loop, we need to weaken the
4392 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4393 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4399 mg->mg_len = namlen;
4402 mg->mg_ptr = savepvn(name, namlen);
4403 else if (namlen == HEf_SVKEY)
4404 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4406 mg->mg_ptr = (char *) name;
4408 mg->mg_virtual = (MGVTBL *) vtable;
4412 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4417 =for apidoc sv_magic
4419 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4420 then adds a new magic item of type C<how> to the head of the magic list.
4422 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4423 handling of the C<name> and C<namlen> arguments.
4425 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4426 to add more than one instance of the same 'how'.
4432 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4435 const MGVTBL *vtable;
4438 #ifdef PERL_OLD_COPY_ON_WRITE
4440 sv_force_normal_flags(sv, 0);
4442 if (SvREADONLY(sv)) {
4444 /* its okay to attach magic to shared strings; the subsequent
4445 * upgrade to PVMG will unshare the string */
4446 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4449 && how != PERL_MAGIC_regex_global
4450 && how != PERL_MAGIC_bm
4451 && how != PERL_MAGIC_fm
4452 && how != PERL_MAGIC_sv
4453 && how != PERL_MAGIC_backref
4456 Perl_croak(aTHX_ PL_no_modify);
4459 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4460 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4461 /* sv_magic() refuses to add a magic of the same 'how' as an
4464 if (how == PERL_MAGIC_taint) {
4466 /* Any scalar which already had taint magic on which someone
4467 (erroneously?) did SvIOK_on() or similar will now be
4468 incorrectly sporting public "OK" flags. */
4469 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4477 vtable = &PL_vtbl_sv;
4479 case PERL_MAGIC_overload:
4480 vtable = &PL_vtbl_amagic;
4482 case PERL_MAGIC_overload_elem:
4483 vtable = &PL_vtbl_amagicelem;
4485 case PERL_MAGIC_overload_table:
4486 vtable = &PL_vtbl_ovrld;
4489 vtable = &PL_vtbl_bm;
4491 case PERL_MAGIC_regdata:
4492 vtable = &PL_vtbl_regdata;
4494 case PERL_MAGIC_regdatum:
4495 vtable = &PL_vtbl_regdatum;
4497 case PERL_MAGIC_env:
4498 vtable = &PL_vtbl_env;
4501 vtable = &PL_vtbl_fm;
4503 case PERL_MAGIC_envelem:
4504 vtable = &PL_vtbl_envelem;
4506 case PERL_MAGIC_regex_global:
4507 vtable = &PL_vtbl_mglob;
4509 case PERL_MAGIC_isa:
4510 vtable = &PL_vtbl_isa;
4512 case PERL_MAGIC_isaelem:
4513 vtable = &PL_vtbl_isaelem;
4515 case PERL_MAGIC_nkeys:
4516 vtable = &PL_vtbl_nkeys;
4518 case PERL_MAGIC_dbfile:
4521 case PERL_MAGIC_dbline:
4522 vtable = &PL_vtbl_dbline;
4524 #ifdef USE_LOCALE_COLLATE
4525 case PERL_MAGIC_collxfrm:
4526 vtable = &PL_vtbl_collxfrm;
4528 #endif /* USE_LOCALE_COLLATE */
4529 case PERL_MAGIC_tied:
4530 vtable = &PL_vtbl_pack;
4532 case PERL_MAGIC_tiedelem:
4533 case PERL_MAGIC_tiedscalar:
4534 vtable = &PL_vtbl_packelem;
4537 vtable = &PL_vtbl_regexp;
4539 case PERL_MAGIC_hints:
4540 /* As this vtable is all NULL, we can reuse it. */
4541 case PERL_MAGIC_sig:
4542 vtable = &PL_vtbl_sig;
4544 case PERL_MAGIC_sigelem:
4545 vtable = &PL_vtbl_sigelem;
4547 case PERL_MAGIC_taint:
4548 vtable = &PL_vtbl_taint;
4550 case PERL_MAGIC_uvar:
4551 vtable = &PL_vtbl_uvar;
4553 case PERL_MAGIC_vec:
4554 vtable = &PL_vtbl_vec;
4556 case PERL_MAGIC_arylen_p:
4557 case PERL_MAGIC_rhash:
4558 case PERL_MAGIC_symtab:
4559 case PERL_MAGIC_vstring:
4562 case PERL_MAGIC_utf8:
4563 vtable = &PL_vtbl_utf8;
4565 case PERL_MAGIC_substr:
4566 vtable = &PL_vtbl_substr;
4568 case PERL_MAGIC_defelem:
4569 vtable = &PL_vtbl_defelem;
4571 case PERL_MAGIC_arylen:
4572 vtable = &PL_vtbl_arylen;
4574 case PERL_MAGIC_pos:
4575 vtable = &PL_vtbl_pos;
4577 case PERL_MAGIC_backref:
4578 vtable = &PL_vtbl_backref;
4580 case PERL_MAGIC_hintselem:
4581 vtable = &PL_vtbl_hintselem;
4583 case PERL_MAGIC_ext:
4584 /* Reserved for use by extensions not perl internals. */
4585 /* Useful for attaching extension internal data to perl vars. */
4586 /* Note that multiple extensions may clash if magical scalars */
4587 /* etc holding private data from one are passed to another. */
4591 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4594 /* Rest of work is done else where */
4595 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4598 case PERL_MAGIC_taint:
4601 case PERL_MAGIC_ext:
4602 case PERL_MAGIC_dbfile:
4609 =for apidoc sv_unmagic
4611 Removes all magic of type C<type> from an SV.
4617 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4621 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4623 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4624 for (mg = *mgp; mg; mg = *mgp) {
4625 if (mg->mg_type == type) {
4626 const MGVTBL* const vtbl = mg->mg_virtual;
4627 *mgp = mg->mg_moremagic;
4628 if (vtbl && vtbl->svt_free)
4629 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4630 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4632 Safefree(mg->mg_ptr);
4633 else if (mg->mg_len == HEf_SVKEY)
4634 SvREFCNT_dec((SV*)mg->mg_ptr);
4635 else if (mg->mg_type == PERL_MAGIC_utf8)
4636 Safefree(mg->mg_ptr);
4638 if (mg->mg_flags & MGf_REFCOUNTED)
4639 SvREFCNT_dec(mg->mg_obj);
4643 mgp = &mg->mg_moremagic;
4647 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4648 SvMAGIC_set(sv, NULL);
4655 =for apidoc sv_rvweaken
4657 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4658 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4659 push a back-reference to this RV onto the array of backreferences
4660 associated with that magic. If the RV is magical, set magic will be
4661 called after the RV is cleared.
4667 Perl_sv_rvweaken(pTHX_ SV *sv)
4670 if (!SvOK(sv)) /* let undefs pass */
4673 Perl_croak(aTHX_ "Can't weaken a nonreference");
4674 else if (SvWEAKREF(sv)) {
4675 if (ckWARN(WARN_MISC))
4676 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4680 Perl_sv_add_backref(aTHX_ tsv, sv);
4686 /* Give tsv backref magic if it hasn't already got it, then push a
4687 * back-reference to sv onto the array associated with the backref magic.
4691 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4696 if (SvTYPE(tsv) == SVt_PVHV) {
4697 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4701 /* There is no AV in the offical place - try a fixup. */
4702 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4705 /* Aha. They've got it stowed in magic. Bring it back. */
4706 av = (AV*)mg->mg_obj;
4707 /* Stop mg_free decreasing the refernce count. */
4709 /* Stop mg_free even calling the destructor, given that
4710 there's no AV to free up. */
4712 sv_unmagic(tsv, PERL_MAGIC_backref);
4716 SvREFCNT_inc_simple_void(av);
4721 const MAGIC *const mg
4722 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4724 av = (AV*)mg->mg_obj;
4728 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4729 /* av now has a refcnt of 2, which avoids it getting freed
4730 * before us during global cleanup. The extra ref is removed
4731 * by magic_killbackrefs() when tsv is being freed */
4734 if (AvFILLp(av) >= AvMAX(av)) {
4735 av_extend(av, AvFILLp(av)+1);
4737 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4740 /* delete a back-reference to ourselves from the backref magic associated
4741 * with the SV we point to.
4745 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4752 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4753 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4754 /* We mustn't attempt to "fix up" the hash here by moving the
4755 backreference array back to the hv_aux structure, as that is stored
4756 in the main HvARRAY(), and hfreentries assumes that no-one
4757 reallocates HvARRAY() while it is running. */
4760 const MAGIC *const mg
4761 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4763 av = (AV *)mg->mg_obj;
4766 if (PL_in_clean_all)
4768 Perl_croak(aTHX_ "panic: del_backref");
4775 /* We shouldn't be in here more than once, but for paranoia reasons lets
4777 for (i = AvFILLp(av); i >= 0; i--) {
4779 const SSize_t fill = AvFILLp(av);
4781 /* We weren't the last entry.
4782 An unordered list has this property that you can take the
4783 last element off the end to fill the hole, and it's still
4784 an unordered list :-)
4789 AvFILLp(av) = fill - 1;
4795 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4797 SV **svp = AvARRAY(av);
4799 PERL_UNUSED_ARG(sv);
4801 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4802 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4803 if (svp && !SvIS_FREED(av)) {
4804 SV *const *const last = svp + AvFILLp(av);
4806 while (svp <= last) {
4808 SV *const referrer = *svp;
4809 if (SvWEAKREF(referrer)) {
4810 /* XXX Should we check that it hasn't changed? */
4811 SvRV_set(referrer, 0);
4813 SvWEAKREF_off(referrer);
4814 SvSETMAGIC(referrer);
4815 } else if (SvTYPE(referrer) == SVt_PVGV ||
4816 SvTYPE(referrer) == SVt_PVLV) {
4817 /* You lookin' at me? */
4818 assert(GvSTASH(referrer));
4819 assert(GvSTASH(referrer) == (HV*)sv);
4820 GvSTASH(referrer) = 0;
4823 "panic: magic_killbackrefs (flags=%"UVxf")",
4824 (UV)SvFLAGS(referrer));
4832 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4837 =for apidoc sv_insert
4839 Inserts a string at the specified offset/length within the SV. Similar to
4840 the Perl substr() function.
4846 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4851 register char *midend;
4852 register char *bigend;
4858 Perl_croak(aTHX_ "Can't modify non-existent substring");
4859 SvPV_force(bigstr, curlen);
4860 (void)SvPOK_only_UTF8(bigstr);
4861 if (offset + len > curlen) {
4862 SvGROW(bigstr, offset+len+1);
4863 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4864 SvCUR_set(bigstr, offset+len);
4868 i = littlelen - len;
4869 if (i > 0) { /* string might grow */
4870 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4871 mid = big + offset + len;
4872 midend = bigend = big + SvCUR(bigstr);
4875 while (midend > mid) /* shove everything down */
4876 *--bigend = *--midend;
4877 Move(little,big+offset,littlelen,char);
4878 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4883 Move(little,SvPVX(bigstr)+offset,len,char);
4888 big = SvPVX(bigstr);
4891 bigend = big + SvCUR(bigstr);
4893 if (midend > bigend)
4894 Perl_croak(aTHX_ "panic: sv_insert");
4896 if (mid - big > bigend - midend) { /* faster to shorten from end */
4898 Move(little, mid, littlelen,char);
4901 i = bigend - midend;
4903 Move(midend, mid, i,char);
4907 SvCUR_set(bigstr, mid - big);
4909 else if ((i = mid - big)) { /* faster from front */
4910 midend -= littlelen;
4912 sv_chop(bigstr,midend-i);
4917 Move(little, mid, littlelen,char);
4919 else if (littlelen) {
4920 midend -= littlelen;
4921 sv_chop(bigstr,midend);
4922 Move(little,midend,littlelen,char);
4925 sv_chop(bigstr,midend);
4931 =for apidoc sv_replace
4933 Make the first argument a copy of the second, then delete the original.
4934 The target SV physically takes over ownership of the body of the source SV
4935 and inherits its flags; however, the target keeps any magic it owns,
4936 and any magic in the source is discarded.
4937 Note that this is a rather specialist SV copying operation; most of the
4938 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4944 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4947 const U32 refcnt = SvREFCNT(sv);
4948 SV_CHECK_THINKFIRST_COW_DROP(sv);
4949 if (SvREFCNT(nsv) != 1) {
4950 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4951 UVuf " != 1)", (UV) SvREFCNT(nsv));
4953 if (SvMAGICAL(sv)) {
4957 sv_upgrade(nsv, SVt_PVMG);
4958 SvMAGIC_set(nsv, SvMAGIC(sv));
4959 SvFLAGS(nsv) |= SvMAGICAL(sv);
4961 SvMAGIC_set(sv, NULL);
4965 assert(!SvREFCNT(sv));
4966 #ifdef DEBUG_LEAKING_SCALARS
4967 sv->sv_flags = nsv->sv_flags;
4968 sv->sv_any = nsv->sv_any;
4969 sv->sv_refcnt = nsv->sv_refcnt;
4970 sv->sv_u = nsv->sv_u;
4972 StructCopy(nsv,sv,SV);
4974 /* Currently could join these into one piece of pointer arithmetic, but
4975 it would be unclear. */
4976 if(SvTYPE(sv) == SVt_IV)
4978 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4979 else if (SvTYPE(sv) == SVt_RV) {
4980 SvANY(sv) = &sv->sv_u.svu_rv;
4984 #ifdef PERL_OLD_COPY_ON_WRITE
4985 if (SvIsCOW_normal(nsv)) {
4986 /* We need to follow the pointers around the loop to make the
4987 previous SV point to sv, rather than nsv. */
4990 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4993 assert(SvPVX_const(current) == SvPVX_const(nsv));
4995 /* Make the SV before us point to the SV after us. */
4997 PerlIO_printf(Perl_debug_log, "previous is\n");
4999 PerlIO_printf(Perl_debug_log,
5000 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5001 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5003 SV_COW_NEXT_SV_SET(current, sv);
5006 SvREFCNT(sv) = refcnt;
5007 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5013 =for apidoc sv_clear
5015 Clear an SV: call any destructors, free up any memory used by the body,
5016 and free the body itself. The SV's head is I<not> freed, although
5017 its type is set to all 1's so that it won't inadvertently be assumed
5018 to be live during global destruction etc.
5019 This function should only be called when REFCNT is zero. Most of the time
5020 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5027 Perl_sv_clear(pTHX_ register SV *sv)
5030 const U32 type = SvTYPE(sv);
5031 const struct body_details *const sv_type_details
5032 = bodies_by_type + type;
5035 assert(SvREFCNT(sv) == 0);
5037 if (type <= SVt_IV) {
5038 /* See the comment in sv.h about the collusion between this early
5039 return and the overloading of the NULL and IV slots in the size
5045 if (PL_defstash) { /* Still have a symbol table? */
5050 stash = SvSTASH(sv);
5051 destructor = StashHANDLER(stash,DESTROY);
5053 SV* const tmpref = newRV(sv);
5054 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5056 PUSHSTACKi(PERLSI_DESTROY);
5061 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5067 if(SvREFCNT(tmpref) < 2) {
5068 /* tmpref is not kept alive! */
5070 SvRV_set(tmpref, NULL);
5073 SvREFCNT_dec(tmpref);
5075 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5079 if (PL_in_clean_objs)
5080 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5082 /* DESTROY gave object new lease on life */
5088 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5089 SvOBJECT_off(sv); /* Curse the object. */
5090 if (type != SVt_PVIO)
5091 --PL_sv_objcount; /* XXX Might want something more general */
5094 if (type >= SVt_PVMG) {
5095 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5096 SvREFCNT_dec(SvOURSTASH(sv));
5097 } else if (SvMAGIC(sv))
5099 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5100 SvREFCNT_dec(SvSTASH(sv));
5103 /* case SVt_BIND: */
5106 IoIFP(sv) != PerlIO_stdin() &&
5107 IoIFP(sv) != PerlIO_stdout() &&
5108 IoIFP(sv) != PerlIO_stderr())
5110 io_close((IO*)sv, FALSE);
5112 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5113 PerlDir_close(IoDIRP(sv));
5114 IoDIRP(sv) = (DIR*)NULL;
5115 Safefree(IoTOP_NAME(sv));
5116 Safefree(IoFMT_NAME(sv));
5117 Safefree(IoBOTTOM_NAME(sv));
5124 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5131 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5132 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5133 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5134 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5136 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5137 SvREFCNT_dec(LvTARG(sv));
5139 if (isGV_with_GP(sv)) {
5142 unshare_hek(GvNAME_HEK(sv));
5143 /* If we're in a stash, we don't own a reference to it. However it does
5144 have a back reference to us, which needs to be cleared. */
5145 if (!SvVALID(sv) && GvSTASH(sv))
5146 sv_del_backref((SV*)GvSTASH(sv), sv);
5152 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5154 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5155 /* Don't even bother with turning off the OOK flag. */
5160 SV * const target = SvRV(sv);
5162 sv_del_backref(target, sv);
5164 SvREFCNT_dec(target);
5166 #ifdef PERL_OLD_COPY_ON_WRITE
5167 else if (SvPVX_const(sv)) {
5169 /* I believe I need to grab the global SV mutex here and
5170 then recheck the COW status. */
5172 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5176 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5178 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5181 /* And drop it here. */
5183 } else if (SvLEN(sv)) {
5184 Safefree(SvPVX_const(sv));
5188 else if (SvPVX_const(sv) && SvLEN(sv))
5189 Safefree(SvPVX_mutable(sv));
5190 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5191 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5200 SvFLAGS(sv) &= SVf_BREAK;
5201 SvFLAGS(sv) |= SVTYPEMASK;
5203 if (sv_type_details->arena) {
5204 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5205 &PL_body_roots[type]);
5207 else if (sv_type_details->body_size) {
5208 my_safefree(SvANY(sv));
5213 =for apidoc sv_newref
5215 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5222 Perl_sv_newref(pTHX_ SV *sv)
5224 PERL_UNUSED_CONTEXT;
5233 Decrement an SV's reference count, and if it drops to zero, call
5234 C<sv_clear> to invoke destructors and free up any memory used by
5235 the body; finally, deallocate the SV's head itself.
5236 Normally called via a wrapper macro C<SvREFCNT_dec>.
5242 Perl_sv_free(pTHX_ SV *sv)
5247 if (SvREFCNT(sv) == 0) {
5248 if (SvFLAGS(sv) & SVf_BREAK)
5249 /* this SV's refcnt has been artificially decremented to
5250 * trigger cleanup */
5252 if (PL_in_clean_all) /* All is fair */
5254 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5255 /* make sure SvREFCNT(sv)==0 happens very seldom */
5256 SvREFCNT(sv) = (~(U32)0)/2;
5259 if (ckWARN_d(WARN_INTERNAL)) {
5260 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5261 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5262 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5263 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5264 Perl_dump_sv_child(aTHX_ sv);
5269 if (--(SvREFCNT(sv)) > 0)
5271 Perl_sv_free2(aTHX_ sv);
5275 Perl_sv_free2(pTHX_ SV *sv)
5280 if (ckWARN_d(WARN_DEBUGGING))
5281 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5282 "Attempt to free temp prematurely: SV 0x%"UVxf
5283 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5287 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5288 /* make sure SvREFCNT(sv)==0 happens very seldom */
5289 SvREFCNT(sv) = (~(U32)0)/2;
5300 Returns the length of the string in the SV. Handles magic and type
5301 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5307 Perl_sv_len(pTHX_ register SV *sv)
5315 len = mg_length(sv);
5317 (void)SvPV_const(sv, len);
5322 =for apidoc sv_len_utf8
5324 Returns the number of characters in the string in an SV, counting wide
5325 UTF-8 bytes as a single character. Handles magic and type coercion.
5331 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5332 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5333 * (Note that the mg_len is not the length of the mg_ptr field.
5334 * This allows the cache to store the character length of the string without
5335 * needing to malloc() extra storage to attach to the mg_ptr.)
5340 Perl_sv_len_utf8(pTHX_ register SV *sv)
5346 return mg_length(sv);
5350 const U8 *s = (U8*)SvPV_const(sv, len);
5354 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5356 if (mg && mg->mg_len != -1) {
5358 if (PL_utf8cache < 0) {
5359 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5361 /* Need to turn the assertions off otherwise we may
5362 recurse infinitely while printing error messages.
5364 SAVEI8(PL_utf8cache);
5366 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5367 " real %"UVuf" for %"SVf,
5368 (UV) ulen, (UV) real, SVfARG(sv));
5373 ulen = Perl_utf8_length(aTHX_ s, s + len);
5374 if (!SvREADONLY(sv)) {
5376 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5377 &PL_vtbl_utf8, 0, 0);
5385 return Perl_utf8_length(aTHX_ s, s + len);
5389 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5392 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5395 const U8 *s = start;
5397 while (s < send && uoffset--)
5400 /* This is the existing behaviour. Possibly it should be a croak, as
5401 it's actually a bounds error */
5407 /* Given the length of the string in both bytes and UTF-8 characters, decide
5408 whether to walk forwards or backwards to find the byte corresponding to
5409 the passed in UTF-8 offset. */
5411 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5412 STRLEN uoffset, STRLEN uend)
5414 STRLEN backw = uend - uoffset;
5415 if (uoffset < 2 * backw) {
5416 /* The assumption is that going forwards is twice the speed of going
5417 forward (that's where the 2 * backw comes from).
5418 (The real figure of course depends on the UTF-8 data.) */
5419 return sv_pos_u2b_forwards(start, send, uoffset);
5424 while (UTF8_IS_CONTINUATION(*send))
5427 return send - start;
5430 /* For the string representation of the given scalar, find the byte
5431 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5432 give another position in the string, *before* the sought offset, which
5433 (which is always true, as 0, 0 is a valid pair of positions), which should
5434 help reduce the amount of linear searching.
5435 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5436 will be used to reduce the amount of linear searching. The cache will be
5437 created if necessary, and the found value offered to it for update. */
5439 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5440 const U8 *const send, STRLEN uoffset,
5441 STRLEN uoffset0, STRLEN boffset0) {
5442 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5445 assert (uoffset >= uoffset0);
5447 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5448 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5449 if ((*mgp)->mg_ptr) {
5450 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5451 if (cache[0] == uoffset) {
5452 /* An exact match. */
5455 if (cache[2] == uoffset) {
5456 /* An exact match. */
5460 if (cache[0] < uoffset) {
5461 /* The cache already knows part of the way. */
5462 if (cache[0] > uoffset0) {
5463 /* The cache knows more than the passed in pair */
5464 uoffset0 = cache[0];
5465 boffset0 = cache[1];
5467 if ((*mgp)->mg_len != -1) {
5468 /* And we know the end too. */
5470 + sv_pos_u2b_midway(start + boffset0, send,
5472 (*mgp)->mg_len - uoffset0);
5475 + sv_pos_u2b_forwards(start + boffset0,
5476 send, uoffset - uoffset0);
5479 else if (cache[2] < uoffset) {
5480 /* We're between the two cache entries. */
5481 if (cache[2] > uoffset0) {
5482 /* and the cache knows more than the passed in pair */
5483 uoffset0 = cache[2];
5484 boffset0 = cache[3];
5488 + sv_pos_u2b_midway(start + boffset0,
5491 cache[0] - uoffset0);
5494 + sv_pos_u2b_midway(start + boffset0,
5497 cache[2] - uoffset0);
5501 else if ((*mgp)->mg_len != -1) {
5502 /* If we can take advantage of a passed in offset, do so. */
5503 /* In fact, offset0 is either 0, or less than offset, so don't
5504 need to worry about the other possibility. */
5506 + sv_pos_u2b_midway(start + boffset0, send,
5508 (*mgp)->mg_len - uoffset0);
5513 if (!found || PL_utf8cache < 0) {
5514 const STRLEN real_boffset
5515 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5516 send, uoffset - uoffset0);
5518 if (found && PL_utf8cache < 0) {
5519 if (real_boffset != boffset) {
5520 /* Need to turn the assertions off otherwise we may recurse
5521 infinitely while printing error messages. */
5522 SAVEI8(PL_utf8cache);
5524 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5525 " real %"UVuf" for %"SVf,
5526 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5529 boffset = real_boffset;
5532 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5538 =for apidoc sv_pos_u2b
5540 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5541 the start of the string, to a count of the equivalent number of bytes; if
5542 lenp is non-zero, it does the same to lenp, but this time starting from
5543 the offset, rather than from the start of the string. Handles magic and
5550 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5551 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5552 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5557 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5565 start = (U8*)SvPV_const(sv, len);
5567 STRLEN uoffset = (STRLEN) *offsetp;
5568 const U8 * const send = start + len;
5570 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5573 *offsetp = (I32) boffset;
5576 /* Convert the relative offset to absolute. */
5577 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5578 const STRLEN boffset2
5579 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5580 uoffset, boffset) - boffset;
5594 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5595 byte length pairing. The (byte) length of the total SV is passed in too,
5596 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5597 may not have updated SvCUR, so we can't rely on reading it directly.
5599 The proffered utf8/byte length pairing isn't used if the cache already has
5600 two pairs, and swapping either for the proffered pair would increase the
5601 RMS of the intervals between known byte offsets.
5603 The cache itself consists of 4 STRLEN values
5604 0: larger UTF-8 offset
5605 1: corresponding byte offset
5606 2: smaller UTF-8 offset
5607 3: corresponding byte offset
5609 Unused cache pairs have the value 0, 0.
5610 Keeping the cache "backwards" means that the invariant of
5611 cache[0] >= cache[2] is maintained even with empty slots, which means that
5612 the code that uses it doesn't need to worry if only 1 entry has actually
5613 been set to non-zero. It also makes the "position beyond the end of the
5614 cache" logic much simpler, as the first slot is always the one to start
5618 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5626 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5628 (*mgp)->mg_len = -1;
5632 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5633 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5634 (*mgp)->mg_ptr = (char *) cache;
5638 if (PL_utf8cache < 0) {
5639 const U8 *start = (const U8 *) SvPVX_const(sv);
5640 const STRLEN realutf8 = utf8_length(start, start + byte);
5642 if (realutf8 != utf8) {
5643 /* Need to turn the assertions off otherwise we may recurse
5644 infinitely while printing error messages. */
5645 SAVEI8(PL_utf8cache);
5647 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5648 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5652 /* Cache is held with the later position first, to simplify the code
5653 that deals with unbounded ends. */
5655 ASSERT_UTF8_CACHE(cache);
5656 if (cache[1] == 0) {
5657 /* Cache is totally empty */
5660 } else if (cache[3] == 0) {
5661 if (byte > cache[1]) {
5662 /* New one is larger, so goes first. */
5663 cache[2] = cache[0];
5664 cache[3] = cache[1];
5672 #define THREEWAY_SQUARE(a,b,c,d) \
5673 ((float)((d) - (c))) * ((float)((d) - (c))) \
5674 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5675 + ((float)((b) - (a))) * ((float)((b) - (a)))
5677 /* Cache has 2 slots in use, and we know three potential pairs.
5678 Keep the two that give the lowest RMS distance. Do the
5679 calcualation in bytes simply because we always know the byte
5680 length. squareroot has the same ordering as the positive value,
5681 so don't bother with the actual square root. */
5682 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5683 if (byte > cache[1]) {
5684 /* New position is after the existing pair of pairs. */
5685 const float keep_earlier
5686 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5687 const float keep_later
5688 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5690 if (keep_later < keep_earlier) {
5691 if (keep_later < existing) {
5692 cache[2] = cache[0];
5693 cache[3] = cache[1];
5699 if (keep_earlier < existing) {
5705 else if (byte > cache[3]) {
5706 /* New position is between the existing pair of pairs. */
5707 const float keep_earlier
5708 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5709 const float keep_later
5710 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5712 if (keep_later < keep_earlier) {
5713 if (keep_later < existing) {
5719 if (keep_earlier < existing) {
5726 /* New position is before the existing pair of pairs. */
5727 const float keep_earlier
5728 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5729 const float keep_later
5730 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5732 if (keep_later < keep_earlier) {
5733 if (keep_later < existing) {
5739 if (keep_earlier < existing) {
5740 cache[0] = cache[2];
5741 cache[1] = cache[3];
5748 ASSERT_UTF8_CACHE(cache);
5751 /* We already know all of the way, now we may be able to walk back. The same
5752 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5753 backward is half the speed of walking forward. */
5755 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5758 const STRLEN forw = target - s;
5759 STRLEN backw = end - target;
5761 if (forw < 2 * backw) {
5762 return utf8_length(s, target);
5765 while (end > target) {
5767 while (UTF8_IS_CONTINUATION(*end)) {
5776 =for apidoc sv_pos_b2u
5778 Converts the value pointed to by offsetp from a count of bytes from the
5779 start of the string, to a count of the equivalent number of UTF-8 chars.
5780 Handles magic and type coercion.
5786 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5787 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5792 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5795 const STRLEN byte = *offsetp;
5796 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5805 s = (const U8*)SvPV_const(sv, blen);
5808 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5812 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5813 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5815 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5816 if (cache[1] == byte) {
5817 /* An exact match. */
5818 *offsetp = cache[0];
5821 if (cache[3] == byte) {
5822 /* An exact match. */
5823 *offsetp = cache[2];
5827 if (cache[1] < byte) {
5828 /* We already know part of the way. */
5829 if (mg->mg_len != -1) {
5830 /* Actually, we know the end too. */
5832 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5833 s + blen, mg->mg_len - cache[0]);
5835 len = cache[0] + utf8_length(s + cache[1], send);
5838 else if (cache[3] < byte) {
5839 /* We're between the two cached pairs, so we do the calculation
5840 offset by the byte/utf-8 positions for the earlier pair,
5841 then add the utf-8 characters from the string start to
5843 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5844 s + cache[1], cache[0] - cache[2])
5848 else { /* cache[3] > byte */
5849 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5853 ASSERT_UTF8_CACHE(cache);
5855 } else if (mg->mg_len != -1) {
5856 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5860 if (!found || PL_utf8cache < 0) {
5861 const STRLEN real_len = utf8_length(s, send);
5863 if (found && PL_utf8cache < 0) {
5864 if (len != real_len) {
5865 /* Need to turn the assertions off otherwise we may recurse
5866 infinitely while printing error messages. */
5867 SAVEI8(PL_utf8cache);
5869 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5870 " real %"UVuf" for %"SVf,
5871 (UV) len, (UV) real_len, SVfARG(sv));
5878 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5884 Returns a boolean indicating whether the strings in the two SVs are
5885 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5886 coerce its args to strings if necessary.
5892 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5901 SV* svrecode = NULL;
5908 /* if pv1 and pv2 are the same, second SvPV_const call may
5909 * invalidate pv1, so we may need to make a copy */
5910 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5911 pv1 = SvPV_const(sv1, cur1);
5912 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5913 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5915 pv1 = SvPV_const(sv1, cur1);
5923 pv2 = SvPV_const(sv2, cur2);
5925 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5926 /* Differing utf8ness.
5927 * Do not UTF8size the comparands as a side-effect. */
5930 svrecode = newSVpvn(pv2, cur2);
5931 sv_recode_to_utf8(svrecode, PL_encoding);
5932 pv2 = SvPV_const(svrecode, cur2);
5935 svrecode = newSVpvn(pv1, cur1);
5936 sv_recode_to_utf8(svrecode, PL_encoding);
5937 pv1 = SvPV_const(svrecode, cur1);
5939 /* Now both are in UTF-8. */
5941 SvREFCNT_dec(svrecode);
5946 bool is_utf8 = TRUE;
5949 /* sv1 is the UTF-8 one,
5950 * if is equal it must be downgrade-able */
5951 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5957 /* sv2 is the UTF-8 one,
5958 * if is equal it must be downgrade-able */
5959 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5965 /* Downgrade not possible - cannot be eq */
5973 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5975 SvREFCNT_dec(svrecode);
5985 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5986 string in C<sv1> is less than, equal to, or greater than the string in
5987 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5988 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5994 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
5998 const char *pv1, *pv2;
6001 SV *svrecode = NULL;
6008 pv1 = SvPV_const(sv1, cur1);
6015 pv2 = SvPV_const(sv2, cur2);
6017 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6018 /* Differing utf8ness.
6019 * Do not UTF8size the comparands as a side-effect. */
6022 svrecode = newSVpvn(pv2, cur2);
6023 sv_recode_to_utf8(svrecode, PL_encoding);
6024 pv2 = SvPV_const(svrecode, cur2);
6027 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6032 svrecode = newSVpvn(pv1, cur1);
6033 sv_recode_to_utf8(svrecode, PL_encoding);
6034 pv1 = SvPV_const(svrecode, cur1);
6037 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6043 cmp = cur2 ? -1 : 0;
6047 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6050 cmp = retval < 0 ? -1 : 1;
6051 } else if (cur1 == cur2) {
6054 cmp = cur1 < cur2 ? -1 : 1;
6058 SvREFCNT_dec(svrecode);
6066 =for apidoc sv_cmp_locale
6068 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6069 'use bytes' aware, handles get magic, and will coerce its args to strings
6070 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6076 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6079 #ifdef USE_LOCALE_COLLATE
6085 if (PL_collation_standard)
6089 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6091 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6093 if (!pv1 || !len1) {
6104 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6107 return retval < 0 ? -1 : 1;
6110 * When the result of collation is equality, that doesn't mean
6111 * that there are no differences -- some locales exclude some
6112 * characters from consideration. So to avoid false equalities,
6113 * we use the raw string as a tiebreaker.
6119 #endif /* USE_LOCALE_COLLATE */
6121 return sv_cmp(sv1, sv2);
6125 #ifdef USE_LOCALE_COLLATE
6128 =for apidoc sv_collxfrm
6130 Add Collate Transform magic to an SV if it doesn't already have it.
6132 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6133 scalar data of the variable, but transformed to such a format that a normal
6134 memory comparison can be used to compare the data according to the locale
6141 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6146 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6147 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6153 Safefree(mg->mg_ptr);
6154 s = SvPV_const(sv, len);
6155 if ((xf = mem_collxfrm(s, len, &xlen))) {
6156 if (SvREADONLY(sv)) {
6159 return xf + sizeof(PL_collation_ix);
6162 #ifdef PERL_OLD_COPY_ON_WRITE
6164 sv_force_normal_flags(sv, 0);
6166 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6180 if (mg && mg->mg_ptr) {
6182 return mg->mg_ptr + sizeof(PL_collation_ix);
6190 #endif /* USE_LOCALE_COLLATE */
6195 Get a line from the filehandle and store it into the SV, optionally
6196 appending to the currently-stored string.
6202 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6207 register STDCHAR rslast;
6208 register STDCHAR *bp;
6213 if (SvTHINKFIRST(sv))
6214 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6215 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6217 However, perlbench says it's slower, because the existing swipe code
6218 is faster than copy on write.
6219 Swings and roundabouts. */
6220 SvUPGRADE(sv, SVt_PV);
6225 if (PerlIO_isutf8(fp)) {
6227 sv_utf8_upgrade_nomg(sv);
6228 sv_pos_u2b(sv,&append,0);
6230 } else if (SvUTF8(sv)) {
6231 SV * const tsv = newSV(0);
6232 sv_gets(tsv, fp, 0);
6233 sv_utf8_upgrade_nomg(tsv);
6234 SvCUR_set(sv,append);
6237 goto return_string_or_null;
6242 if (PerlIO_isutf8(fp))
6245 if (IN_PERL_COMPILETIME) {
6246 /* we always read code in line mode */
6250 else if (RsSNARF(PL_rs)) {
6251 /* If it is a regular disk file use size from stat() as estimate
6252 of amount we are going to read -- may result in mallocing
6253 more memory than we really need if the layers below reduce
6254 the size we read (e.g. CRLF or a gzip layer).
6257 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6258 const Off_t offset = PerlIO_tell(fp);
6259 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6260 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6266 else if (RsRECORD(PL_rs)) {
6271 /* Grab the size of the record we're getting */
6272 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6273 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6276 /* VMS wants read instead of fread, because fread doesn't respect */
6277 /* RMS record boundaries. This is not necessarily a good thing to be */
6278 /* doing, but we've got no other real choice - except avoid stdio
6279 as implementation - perhaps write a :vms layer ?
6281 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6283 bytesread = PerlIO_read(fp, buffer, recsize);
6287 SvCUR_set(sv, bytesread += append);
6288 buffer[bytesread] = '\0';
6289 goto return_string_or_null;
6291 else if (RsPARA(PL_rs)) {
6297 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6298 if (PerlIO_isutf8(fp)) {
6299 rsptr = SvPVutf8(PL_rs, rslen);
6302 if (SvUTF8(PL_rs)) {
6303 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6304 Perl_croak(aTHX_ "Wide character in $/");
6307 rsptr = SvPV_const(PL_rs, rslen);
6311 rslast = rslen ? rsptr[rslen - 1] : '\0';
6313 if (rspara) { /* have to do this both before and after */
6314 do { /* to make sure file boundaries work right */
6317 i = PerlIO_getc(fp);
6321 PerlIO_ungetc(fp,i);
6327 /* See if we know enough about I/O mechanism to cheat it ! */
6329 /* This used to be #ifdef test - it is made run-time test for ease
6330 of abstracting out stdio interface. One call should be cheap
6331 enough here - and may even be a macro allowing compile
6335 if (PerlIO_fast_gets(fp)) {
6338 * We're going to steal some values from the stdio struct
6339 * and put EVERYTHING in the innermost loop into registers.
6341 register STDCHAR *ptr;
6345 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6346 /* An ungetc()d char is handled separately from the regular
6347 * buffer, so we getc() it back out and stuff it in the buffer.
6349 i = PerlIO_getc(fp);
6350 if (i == EOF) return 0;
6351 *(--((*fp)->_ptr)) = (unsigned char) i;
6355 /* Here is some breathtakingly efficient cheating */
6357 cnt = PerlIO_get_cnt(fp); /* get count into register */
6358 /* make sure we have the room */
6359 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6360 /* Not room for all of it
6361 if we are looking for a separator and room for some
6363 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6364 /* just process what we have room for */
6365 shortbuffered = cnt - SvLEN(sv) + append + 1;
6366 cnt -= shortbuffered;
6370 /* remember that cnt can be negative */
6371 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6376 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6377 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6378 DEBUG_P(PerlIO_printf(Perl_debug_log,
6379 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6380 DEBUG_P(PerlIO_printf(Perl_debug_log,
6381 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6382 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6383 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6388 while (cnt > 0) { /* this | eat */
6390 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6391 goto thats_all_folks; /* screams | sed :-) */
6395 Copy(ptr, bp, cnt, char); /* this | eat */
6396 bp += cnt; /* screams | dust */
6397 ptr += cnt; /* louder | sed :-) */
6402 if (shortbuffered) { /* oh well, must extend */
6403 cnt = shortbuffered;
6405 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6407 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6408 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6412 DEBUG_P(PerlIO_printf(Perl_debug_log,
6413 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6414 PTR2UV(ptr),(long)cnt));
6415 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6417 DEBUG_P(PerlIO_printf(Perl_debug_log,
6418 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6419 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6420 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6422 /* This used to call 'filbuf' in stdio form, but as that behaves like
6423 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6424 another abstraction. */
6425 i = PerlIO_getc(fp); /* get more characters */
6427 DEBUG_P(PerlIO_printf(Perl_debug_log,
6428 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6429 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6430 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6432 cnt = PerlIO_get_cnt(fp);
6433 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6434 DEBUG_P(PerlIO_printf(Perl_debug_log,
6435 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6437 if (i == EOF) /* all done for ever? */
6438 goto thats_really_all_folks;
6440 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6442 SvGROW(sv, bpx + cnt + 2);
6443 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6445 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6447 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6448 goto thats_all_folks;
6452 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6453 memNE((char*)bp - rslen, rsptr, rslen))
6454 goto screamer; /* go back to the fray */
6455 thats_really_all_folks:
6457 cnt += shortbuffered;
6458 DEBUG_P(PerlIO_printf(Perl_debug_log,
6459 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6460 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6461 DEBUG_P(PerlIO_printf(Perl_debug_log,
6462 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6463 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6464 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6466 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6467 DEBUG_P(PerlIO_printf(Perl_debug_log,
6468 "Screamer: done, len=%ld, string=|%.*s|\n",
6469 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6473 /*The big, slow, and stupid way. */
6474 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6475 STDCHAR *buf = NULL;
6476 Newx(buf, 8192, STDCHAR);
6484 register const STDCHAR * const bpe = buf + sizeof(buf);
6486 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6487 ; /* keep reading */
6491 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6492 /* Accomodate broken VAXC compiler, which applies U8 cast to
6493 * both args of ?: operator, causing EOF to change into 255
6496 i = (U8)buf[cnt - 1];
6502 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6504 sv_catpvn(sv, (char *) buf, cnt);
6506 sv_setpvn(sv, (char *) buf, cnt);
6508 if (i != EOF && /* joy */
6510 SvCUR(sv) < rslen ||
6511 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6515 * If we're reading from a TTY and we get a short read,
6516 * indicating that the user hit his EOF character, we need
6517 * to notice it now, because if we try to read from the TTY
6518 * again, the EOF condition will disappear.
6520 * The comparison of cnt to sizeof(buf) is an optimization
6521 * that prevents unnecessary calls to feof().
6525 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6529 #ifdef USE_HEAP_INSTEAD_OF_STACK
6534 if (rspara) { /* have to do this both before and after */
6535 while (i != EOF) { /* to make sure file boundaries work right */
6536 i = PerlIO_getc(fp);
6538 PerlIO_ungetc(fp,i);
6544 return_string_or_null:
6545 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6551 Auto-increment of the value in the SV, doing string to numeric conversion
6552 if necessary. Handles 'get' magic.
6558 Perl_sv_inc(pTHX_ register SV *sv)
6567 if (SvTHINKFIRST(sv)) {
6569 sv_force_normal_flags(sv, 0);
6570 if (SvREADONLY(sv)) {
6571 if (IN_PERL_RUNTIME)
6572 Perl_croak(aTHX_ PL_no_modify);
6576 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6578 i = PTR2IV(SvRV(sv));
6583 flags = SvFLAGS(sv);
6584 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6585 /* It's (privately or publicly) a float, but not tested as an
6586 integer, so test it to see. */
6588 flags = SvFLAGS(sv);
6590 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6591 /* It's publicly an integer, or privately an integer-not-float */
6592 #ifdef PERL_PRESERVE_IVUV
6596 if (SvUVX(sv) == UV_MAX)
6597 sv_setnv(sv, UV_MAX_P1);
6599 (void)SvIOK_only_UV(sv);
6600 SvUV_set(sv, SvUVX(sv) + 1);
6602 if (SvIVX(sv) == IV_MAX)
6603 sv_setuv(sv, (UV)IV_MAX + 1);
6605 (void)SvIOK_only(sv);
6606 SvIV_set(sv, SvIVX(sv) + 1);
6611 if (flags & SVp_NOK) {
6612 (void)SvNOK_only(sv);
6613 SvNV_set(sv, SvNVX(sv) + 1.0);
6617 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6618 if ((flags & SVTYPEMASK) < SVt_PVIV)
6619 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6620 (void)SvIOK_only(sv);
6625 while (isALPHA(*d)) d++;
6626 while (isDIGIT(*d)) d++;
6628 #ifdef PERL_PRESERVE_IVUV
6629 /* Got to punt this as an integer if needs be, but we don't issue
6630 warnings. Probably ought to make the sv_iv_please() that does
6631 the conversion if possible, and silently. */
6632 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6633 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6634 /* Need to try really hard to see if it's an integer.
6635 9.22337203685478e+18 is an integer.
6636 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6637 so $a="9.22337203685478e+18"; $a+0; $a++
6638 needs to be the same as $a="9.22337203685478e+18"; $a++
6645 /* sv_2iv *should* have made this an NV */
6646 if (flags & SVp_NOK) {
6647 (void)SvNOK_only(sv);
6648 SvNV_set(sv, SvNVX(sv) + 1.0);
6651 /* I don't think we can get here. Maybe I should assert this
6652 And if we do get here I suspect that sv_setnv will croak. NWC
6654 #if defined(USE_LONG_DOUBLE)
6655 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",
6656 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6658 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6659 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6662 #endif /* PERL_PRESERVE_IVUV */
6663 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6667 while (d >= SvPVX_const(sv)) {
6675 /* MKS: The original code here died if letters weren't consecutive.
6676 * at least it didn't have to worry about non-C locales. The
6677 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6678 * arranged in order (although not consecutively) and that only
6679 * [A-Za-z] are accepted by isALPHA in the C locale.
6681 if (*d != 'z' && *d != 'Z') {
6682 do { ++*d; } while (!isALPHA(*d));
6685 *(d--) -= 'z' - 'a';
6690 *(d--) -= 'z' - 'a' + 1;
6694 /* oh,oh, the number grew */
6695 SvGROW(sv, SvCUR(sv) + 2);
6696 SvCUR_set(sv, SvCUR(sv) + 1);
6697 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6708 Auto-decrement of the value in the SV, doing string to numeric conversion
6709 if necessary. Handles 'get' magic.
6715 Perl_sv_dec(pTHX_ register SV *sv)
6723 if (SvTHINKFIRST(sv)) {
6725 sv_force_normal_flags(sv, 0);
6726 if (SvREADONLY(sv)) {
6727 if (IN_PERL_RUNTIME)
6728 Perl_croak(aTHX_ PL_no_modify);
6732 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6734 i = PTR2IV(SvRV(sv));
6739 /* Unlike sv_inc we don't have to worry about string-never-numbers
6740 and keeping them magic. But we mustn't warn on punting */
6741 flags = SvFLAGS(sv);
6742 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6743 /* It's publicly an integer, or privately an integer-not-float */
6744 #ifdef PERL_PRESERVE_IVUV
6748 if (SvUVX(sv) == 0) {
6749 (void)SvIOK_only(sv);
6753 (void)SvIOK_only_UV(sv);
6754 SvUV_set(sv, SvUVX(sv) - 1);
6757 if (SvIVX(sv) == IV_MIN)
6758 sv_setnv(sv, (NV)IV_MIN - 1.0);
6760 (void)SvIOK_only(sv);
6761 SvIV_set(sv, SvIVX(sv) - 1);
6766 if (flags & SVp_NOK) {
6767 SvNV_set(sv, SvNVX(sv) - 1.0);
6768 (void)SvNOK_only(sv);
6771 if (!(flags & SVp_POK)) {
6772 if ((flags & SVTYPEMASK) < SVt_PVIV)
6773 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6775 (void)SvIOK_only(sv);
6778 #ifdef PERL_PRESERVE_IVUV
6780 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6781 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6782 /* Need to try really hard to see if it's an integer.
6783 9.22337203685478e+18 is an integer.
6784 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6785 so $a="9.22337203685478e+18"; $a+0; $a--
6786 needs to be the same as $a="9.22337203685478e+18"; $a--
6793 /* sv_2iv *should* have made this an NV */
6794 if (flags & SVp_NOK) {
6795 (void)SvNOK_only(sv);
6796 SvNV_set(sv, SvNVX(sv) - 1.0);
6799 /* I don't think we can get here. Maybe I should assert this
6800 And if we do get here I suspect that sv_setnv will croak. NWC
6802 #if defined(USE_LONG_DOUBLE)
6803 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",
6804 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6806 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6807 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6811 #endif /* PERL_PRESERVE_IVUV */
6812 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6816 =for apidoc sv_mortalcopy
6818 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6819 The new SV is marked as mortal. It will be destroyed "soon", either by an
6820 explicit call to FREETMPS, or by an implicit call at places such as
6821 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6826 /* Make a string that will exist for the duration of the expression
6827 * evaluation. Actually, it may have to last longer than that, but
6828 * hopefully we won't free it until it has been assigned to a
6829 * permanent location. */
6832 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6838 sv_setsv(sv,oldstr);
6840 PL_tmps_stack[++PL_tmps_ix] = sv;
6846 =for apidoc sv_newmortal
6848 Creates a new null SV which is mortal. The reference count of the SV is
6849 set to 1. It will be destroyed "soon", either by an explicit call to
6850 FREETMPS, or by an implicit call at places such as statement boundaries.
6851 See also C<sv_mortalcopy> and C<sv_2mortal>.
6857 Perl_sv_newmortal(pTHX)
6863 SvFLAGS(sv) = SVs_TEMP;
6865 PL_tmps_stack[++PL_tmps_ix] = sv;
6870 =for apidoc sv_2mortal
6872 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6873 by an explicit call to FREETMPS, or by an implicit call at places such as
6874 statement boundaries. SvTEMP() is turned on which means that the SV's
6875 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6876 and C<sv_mortalcopy>.
6882 Perl_sv_2mortal(pTHX_ register SV *sv)
6887 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6890 PL_tmps_stack[++PL_tmps_ix] = sv;
6898 Creates a new SV and copies a string into it. The reference count for the
6899 SV is set to 1. If C<len> is zero, Perl will compute the length using
6900 strlen(). For efficiency, consider using C<newSVpvn> instead.
6906 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6912 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6917 =for apidoc newSVpvn
6919 Creates a new SV and copies a string into it. The reference count for the
6920 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6921 string. You are responsible for ensuring that the source string is at least
6922 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6928 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6934 sv_setpvn(sv,s,len);
6940 =for apidoc newSVhek
6942 Creates a new SV from the hash key structure. It will generate scalars that
6943 point to the shared string table where possible. Returns a new (undefined)
6944 SV if the hek is NULL.
6950 Perl_newSVhek(pTHX_ const HEK *hek)
6960 if (HEK_LEN(hek) == HEf_SVKEY) {
6961 return newSVsv(*(SV**)HEK_KEY(hek));
6963 const int flags = HEK_FLAGS(hek);
6964 if (flags & HVhek_WASUTF8) {
6966 Andreas would like keys he put in as utf8 to come back as utf8
6968 STRLEN utf8_len = HEK_LEN(hek);
6969 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6970 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6973 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6975 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6976 /* We don't have a pointer to the hv, so we have to replicate the
6977 flag into every HEK. This hv is using custom a hasing
6978 algorithm. Hence we can't return a shared string scalar, as
6979 that would contain the (wrong) hash value, and might get passed
6980 into an hv routine with a regular hash.
6981 Similarly, a hash that isn't using shared hash keys has to have
6982 the flag in every key so that we know not to try to call
6983 share_hek_kek on it. */
6985 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6990 /* This will be overwhelminly the most common case. */
6992 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6993 more efficient than sharepvn(). */
6997 sv_upgrade(sv, SVt_PV);
6998 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
6999 SvCUR_set(sv, HEK_LEN(hek));
7012 =for apidoc newSVpvn_share
7014 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7015 table. If the string does not already exist in the table, it is created
7016 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7017 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7018 otherwise the hash is computed. The idea here is that as the string table
7019 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7020 hash lookup will avoid string compare.
7026 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7030 bool is_utf8 = FALSE;
7031 const char *const orig_src = src;
7034 STRLEN tmplen = -len;
7036 /* See the note in hv.c:hv_fetch() --jhi */
7037 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7041 PERL_HASH(hash, src, len);
7043 sv_upgrade(sv, SVt_PV);
7044 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7052 if (src != orig_src)
7058 #if defined(PERL_IMPLICIT_CONTEXT)
7060 /* pTHX_ magic can't cope with varargs, so this is a no-context
7061 * version of the main function, (which may itself be aliased to us).
7062 * Don't access this version directly.
7066 Perl_newSVpvf_nocontext(const char* pat, ...)
7071 va_start(args, pat);
7072 sv = vnewSVpvf(pat, &args);
7079 =for apidoc newSVpvf
7081 Creates a new SV and initializes it with the string formatted like
7088 Perl_newSVpvf(pTHX_ const char* pat, ...)
7092 va_start(args, pat);
7093 sv = vnewSVpvf(pat, &args);
7098 /* backend for newSVpvf() and newSVpvf_nocontext() */
7101 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7106 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7113 Creates a new SV and copies a floating point value into it.
7114 The reference count for the SV is set to 1.
7120 Perl_newSVnv(pTHX_ NV n)
7133 Creates a new SV and copies an integer into it. The reference count for the
7140 Perl_newSViv(pTHX_ IV i)
7153 Creates a new SV and copies an unsigned integer into it.
7154 The reference count for the SV is set to 1.
7160 Perl_newSVuv(pTHX_ UV u)
7171 =for apidoc newRV_noinc
7173 Creates an RV wrapper for an SV. The reference count for the original
7174 SV is B<not> incremented.
7180 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7186 sv_upgrade(sv, SVt_RV);
7188 SvRV_set(sv, tmpRef);
7193 /* newRV_inc is the official function name to use now.
7194 * newRV_inc is in fact #defined to newRV in sv.h
7198 Perl_newRV(pTHX_ SV *sv)
7201 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7207 Creates a new SV which is an exact duplicate of the original SV.
7214 Perl_newSVsv(pTHX_ register SV *old)
7221 if (SvTYPE(old) == SVTYPEMASK) {
7222 if (ckWARN_d(WARN_INTERNAL))
7223 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7227 /* SV_GMAGIC is the default for sv_setv()
7228 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7229 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7230 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7235 =for apidoc sv_reset
7237 Underlying implementation for the C<reset> Perl function.
7238 Note that the perl-level function is vaguely deprecated.
7244 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7247 char todo[PERL_UCHAR_MAX+1];
7252 if (!*s) { /* reset ?? searches */
7253 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7255 PMOP *pm = (PMOP *) mg->mg_obj;
7257 pm->op_pmdynflags &= ~PMdf_USED;
7264 /* reset variables */
7266 if (!HvARRAY(stash))
7269 Zero(todo, 256, char);
7272 I32 i = (unsigned char)*s;
7276 max = (unsigned char)*s++;
7277 for ( ; i <= max; i++) {
7280 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7282 for (entry = HvARRAY(stash)[i];
7284 entry = HeNEXT(entry))
7289 if (!todo[(U8)*HeKEY(entry)])
7291 gv = (GV*)HeVAL(entry);
7294 if (SvTHINKFIRST(sv)) {
7295 if (!SvREADONLY(sv) && SvROK(sv))
7297 /* XXX Is this continue a bug? Why should THINKFIRST
7298 exempt us from resetting arrays and hashes? */
7302 if (SvTYPE(sv) >= SVt_PV) {
7304 if (SvPVX_const(sv) != NULL)
7312 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7314 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7317 # if defined(USE_ENVIRON_ARRAY)
7320 # endif /* USE_ENVIRON_ARRAY */
7331 Using various gambits, try to get an IO from an SV: the IO slot if its a
7332 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7333 named after the PV if we're a string.
7339 Perl_sv_2io(pTHX_ SV *sv)
7344 switch (SvTYPE(sv)) {
7352 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7356 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7358 return sv_2io(SvRV(sv));
7359 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7365 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7374 Using various gambits, try to get a CV from an SV; in addition, try if
7375 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7376 The flags in C<lref> are passed to sv_fetchsv.
7382 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7393 switch (SvTYPE(sv)) {
7412 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7413 tryAMAGICunDEREF(to_cv);
7416 if (SvTYPE(sv) == SVt_PVCV) {
7425 Perl_croak(aTHX_ "Not a subroutine reference");
7430 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7436 /* Some flags to gv_fetchsv mean don't really create the GV */
7437 if (SvTYPE(gv) != SVt_PVGV) {
7443 if (lref && !GvCVu(gv)) {
7447 gv_efullname3(tmpsv, gv, NULL);
7448 /* XXX this is probably not what they think they're getting.
7449 * It has the same effect as "sub name;", i.e. just a forward
7451 newSUB(start_subparse(FALSE, 0),
7452 newSVOP(OP_CONST, 0, tmpsv),
7456 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7466 Returns true if the SV has a true value by Perl's rules.
7467 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7468 instead use an in-line version.
7474 Perl_sv_true(pTHX_ register SV *sv)
7479 register const XPV* const tXpv = (XPV*)SvANY(sv);
7481 (tXpv->xpv_cur > 1 ||
7482 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7489 return SvIVX(sv) != 0;
7492 return SvNVX(sv) != 0.0;
7494 return sv_2bool(sv);
7500 =for apidoc sv_pvn_force
7502 Get a sensible string out of the SV somehow.
7503 A private implementation of the C<SvPV_force> macro for compilers which
7504 can't cope with complex macro expressions. Always use the macro instead.
7506 =for apidoc sv_pvn_force_flags
7508 Get a sensible string out of the SV somehow.
7509 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7510 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7511 implemented in terms of this function.
7512 You normally want to use the various wrapper macros instead: see
7513 C<SvPV_force> and C<SvPV_force_nomg>
7519 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7522 if (SvTHINKFIRST(sv) && !SvROK(sv))
7523 sv_force_normal_flags(sv, 0);
7533 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7534 const char * const ref = sv_reftype(sv,0);
7536 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7537 ref, OP_NAME(PL_op));
7539 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7541 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7542 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7544 s = sv_2pv_flags(sv, &len, flags);
7548 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7551 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7552 SvGROW(sv, len + 1);
7553 Move(s,SvPVX(sv),len,char);
7558 SvPOK_on(sv); /* validate pointer */
7560 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7561 PTR2UV(sv),SvPVX_const(sv)));
7564 return SvPVX_mutable(sv);
7568 =for apidoc sv_pvbyten_force
7570 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7576 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7578 sv_pvn_force(sv,lp);
7579 sv_utf8_downgrade(sv,0);
7585 =for apidoc sv_pvutf8n_force
7587 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7593 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7595 sv_pvn_force(sv,lp);
7596 sv_utf8_upgrade(sv);
7602 =for apidoc sv_reftype
7604 Returns a string describing what the SV is a reference to.
7610 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7612 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7613 inside return suggests a const propagation bug in g++. */
7614 if (ob && SvOBJECT(sv)) {
7615 char * const name = HvNAME_get(SvSTASH(sv));
7616 return name ? name : (char *) "__ANON__";
7619 switch (SvTYPE(sv)) {
7635 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7636 /* tied lvalues should appear to be
7637 * scalars for backwards compatitbility */
7638 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7639 ? "SCALAR" : "LVALUE");
7640 case SVt_PVAV: return "ARRAY";
7641 case SVt_PVHV: return "HASH";
7642 case SVt_PVCV: return "CODE";
7643 case SVt_PVGV: return "GLOB";
7644 case SVt_PVFM: return "FORMAT";
7645 case SVt_PVIO: return "IO";
7646 case SVt_BIND: return "BIND";
7647 default: return "UNKNOWN";
7653 =for apidoc sv_isobject
7655 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7656 object. If the SV is not an RV, or if the object is not blessed, then this
7663 Perl_sv_isobject(pTHX_ SV *sv)
7679 Returns a boolean indicating whether the SV is blessed into the specified
7680 class. This does not check for subtypes; use C<sv_derived_from> to verify
7681 an inheritance relationship.
7687 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7698 hvname = HvNAME_get(SvSTASH(sv));
7702 return strEQ(hvname, name);
7708 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7709 it will be upgraded to one. If C<classname> is non-null then the new SV will
7710 be blessed in the specified package. The new SV is returned and its
7711 reference count is 1.
7717 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7724 SV_CHECK_THINKFIRST_COW_DROP(rv);
7725 (void)SvAMAGIC_off(rv);
7727 if (SvTYPE(rv) >= SVt_PVMG) {
7728 const U32 refcnt = SvREFCNT(rv);
7732 SvREFCNT(rv) = refcnt;
7734 sv_upgrade(rv, SVt_RV);
7735 } else if (SvROK(rv)) {
7736 SvREFCNT_dec(SvRV(rv));
7737 } else if (SvTYPE(rv) < SVt_RV)
7738 sv_upgrade(rv, SVt_RV);
7739 else if (SvTYPE(rv) > SVt_RV) {
7750 HV* const stash = gv_stashpv(classname, GV_ADD);
7751 (void)sv_bless(rv, stash);
7757 =for apidoc sv_setref_pv
7759 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7760 argument will be upgraded to an RV. That RV will be modified to point to
7761 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7762 into the SV. The C<classname> argument indicates the package for the
7763 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7764 will have a reference count of 1, and the RV will be returned.
7766 Do not use with other Perl types such as HV, AV, SV, CV, because those
7767 objects will become corrupted by the pointer copy process.
7769 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7775 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7779 sv_setsv(rv, &PL_sv_undef);
7783 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7788 =for apidoc sv_setref_iv
7790 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7791 argument will be upgraded to an RV. That RV will be modified to point to
7792 the new SV. The C<classname> argument indicates the package for the
7793 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7794 will have a reference count of 1, and the RV will be returned.
7800 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7802 sv_setiv(newSVrv(rv,classname), iv);
7807 =for apidoc sv_setref_uv
7809 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7810 argument will be upgraded to an RV. That RV will be modified to point to
7811 the new SV. The C<classname> argument indicates the package for the
7812 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7813 will have a reference count of 1, and the RV will be returned.
7819 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7821 sv_setuv(newSVrv(rv,classname), uv);
7826 =for apidoc sv_setref_nv
7828 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7829 argument will be upgraded to an RV. That RV will be modified to point to
7830 the new SV. The C<classname> argument indicates the package for the
7831 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7832 will have a reference count of 1, and the RV will be returned.
7838 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7840 sv_setnv(newSVrv(rv,classname), nv);
7845 =for apidoc sv_setref_pvn
7847 Copies a string into a new SV, optionally blessing the SV. The length of the
7848 string must be specified with C<n>. The C<rv> argument will be upgraded to
7849 an RV. That RV will be modified to point to the new SV. The C<classname>
7850 argument indicates the package for the blessing. Set C<classname> to
7851 C<NULL> to avoid the blessing. The new SV will have a reference count
7852 of 1, and the RV will be returned.
7854 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7860 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7862 sv_setpvn(newSVrv(rv,classname), pv, n);
7867 =for apidoc sv_bless
7869 Blesses an SV into a specified package. The SV must be an RV. The package
7870 must be designated by its stash (see C<gv_stashpv()>). The reference count
7871 of the SV is unaffected.
7877 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7882 Perl_croak(aTHX_ "Can't bless non-reference value");
7884 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7885 if (SvREADONLY(tmpRef))
7886 Perl_croak(aTHX_ PL_no_modify);
7887 if (SvOBJECT(tmpRef)) {
7888 if (SvTYPE(tmpRef) != SVt_PVIO)
7890 SvREFCNT_dec(SvSTASH(tmpRef));
7893 SvOBJECT_on(tmpRef);
7894 if (SvTYPE(tmpRef) != SVt_PVIO)
7896 SvUPGRADE(tmpRef, SVt_PVMG);
7897 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7902 (void)SvAMAGIC_off(sv);
7904 if(SvSMAGICAL(tmpRef))
7905 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7913 /* Downgrades a PVGV to a PVMG.
7917 S_sv_unglob(pTHX_ SV *sv)
7921 SV * const temp = sv_newmortal();
7923 assert(SvTYPE(sv) == SVt_PVGV);
7925 gv_efullname3(temp, (GV *) sv, "*");
7931 sv_del_backref((SV*)GvSTASH(sv), sv);
7935 if (GvNAME_HEK(sv)) {
7936 unshare_hek(GvNAME_HEK(sv));
7938 isGV_with_GP_off(sv);
7940 /* need to keep SvANY(sv) in the right arena */
7941 xpvmg = new_XPVMG();
7942 StructCopy(SvANY(sv), xpvmg, XPVMG);
7943 del_XPVGV(SvANY(sv));
7946 SvFLAGS(sv) &= ~SVTYPEMASK;
7947 SvFLAGS(sv) |= SVt_PVMG;
7949 /* Intentionally not calling any local SET magic, as this isn't so much a
7950 set operation as merely an internal storage change. */
7951 sv_setsv_flags(sv, temp, 0);
7955 =for apidoc sv_unref_flags
7957 Unsets the RV status of the SV, and decrements the reference count of
7958 whatever was being referenced by the RV. This can almost be thought of
7959 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7960 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7961 (otherwise the decrementing is conditional on the reference count being
7962 different from one or the reference being a readonly SV).
7969 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7971 SV* const target = SvRV(ref);
7973 if (SvWEAKREF(ref)) {
7974 sv_del_backref(target, ref);
7976 SvRV_set(ref, NULL);
7979 SvRV_set(ref, NULL);
7981 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
7982 assigned to as BEGIN {$a = \"Foo"} will fail. */
7983 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
7984 SvREFCNT_dec(target);
7985 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
7986 sv_2mortal(target); /* Schedule for freeing later */
7990 =for apidoc sv_untaint
7992 Untaint an SV. Use C<SvTAINTED_off> instead.
7997 Perl_sv_untaint(pTHX_ SV *sv)
7999 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8000 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8007 =for apidoc sv_tainted
8009 Test an SV for taintedness. Use C<SvTAINTED> instead.
8014 Perl_sv_tainted(pTHX_ SV *sv)
8016 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8017 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8018 if (mg && (mg->mg_len & 1) )
8025 =for apidoc sv_setpviv
8027 Copies an integer into the given SV, also updating its string value.
8028 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8034 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8036 char buf[TYPE_CHARS(UV)];
8038 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8040 sv_setpvn(sv, ptr, ebuf - ptr);
8044 =for apidoc sv_setpviv_mg
8046 Like C<sv_setpviv>, but also handles 'set' magic.
8052 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8058 #if defined(PERL_IMPLICIT_CONTEXT)
8060 /* pTHX_ magic can't cope with varargs, so this is a no-context
8061 * version of the main function, (which may itself be aliased to us).
8062 * Don't access this version directly.
8066 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8070 va_start(args, pat);
8071 sv_vsetpvf(sv, pat, &args);
8075 /* pTHX_ magic can't cope with varargs, so this is a no-context
8076 * version of the main function, (which may itself be aliased to us).
8077 * Don't access this version directly.
8081 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8085 va_start(args, pat);
8086 sv_vsetpvf_mg(sv, pat, &args);
8092 =for apidoc sv_setpvf
8094 Works like C<sv_catpvf> but copies the text into the SV instead of
8095 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8101 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8104 va_start(args, pat);
8105 sv_vsetpvf(sv, pat, &args);
8110 =for apidoc sv_vsetpvf
8112 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8113 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8115 Usually used via its frontend C<sv_setpvf>.
8121 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8123 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8127 =for apidoc sv_setpvf_mg
8129 Like C<sv_setpvf>, but also handles 'set' magic.
8135 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8138 va_start(args, pat);
8139 sv_vsetpvf_mg(sv, pat, &args);
8144 =for apidoc sv_vsetpvf_mg
8146 Like C<sv_vsetpvf>, but also handles 'set' magic.
8148 Usually used via its frontend C<sv_setpvf_mg>.
8154 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8156 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8160 #if defined(PERL_IMPLICIT_CONTEXT)
8162 /* pTHX_ magic can't cope with varargs, so this is a no-context
8163 * version of the main function, (which may itself be aliased to us).
8164 * Don't access this version directly.
8168 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8172 va_start(args, pat);
8173 sv_vcatpvf(sv, pat, &args);
8177 /* pTHX_ magic can't cope with varargs, so this is a no-context
8178 * version of the main function, (which may itself be aliased to us).
8179 * Don't access this version directly.
8183 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8187 va_start(args, pat);
8188 sv_vcatpvf_mg(sv, pat, &args);
8194 =for apidoc sv_catpvf
8196 Processes its arguments like C<sprintf> and appends the formatted
8197 output to an SV. If the appended data contains "wide" characters
8198 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8199 and characters >255 formatted with %c), the original SV might get
8200 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8201 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8202 valid UTF-8; if the original SV was bytes, the pattern should be too.
8207 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8210 va_start(args, pat);
8211 sv_vcatpvf(sv, pat, &args);
8216 =for apidoc sv_vcatpvf
8218 Processes its arguments like C<vsprintf> and appends the formatted output
8219 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8221 Usually used via its frontend C<sv_catpvf>.
8227 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8229 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8233 =for apidoc sv_catpvf_mg
8235 Like C<sv_catpvf>, but also handles 'set' magic.
8241 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8244 va_start(args, pat);
8245 sv_vcatpvf_mg(sv, pat, &args);
8250 =for apidoc sv_vcatpvf_mg
8252 Like C<sv_vcatpvf>, but also handles 'set' magic.
8254 Usually used via its frontend C<sv_catpvf_mg>.
8260 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8262 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8267 =for apidoc sv_vsetpvfn
8269 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8272 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8278 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8280 sv_setpvn(sv, "", 0);
8281 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8285 S_expect_number(pTHX_ char** pattern)
8289 switch (**pattern) {
8290 case '1': case '2': case '3':
8291 case '4': case '5': case '6':
8292 case '7': case '8': case '9':
8293 var = *(*pattern)++ - '0';
8294 while (isDIGIT(**pattern)) {
8295 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8297 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8305 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8307 const int neg = nv < 0;
8316 if (uv & 1 && uv == nv)
8317 uv--; /* Round to even */
8319 const unsigned dig = uv % 10;
8332 =for apidoc sv_vcatpvfn
8334 Processes its arguments like C<vsprintf> and appends the formatted output
8335 to an SV. Uses an array of SVs if the C style variable argument list is
8336 missing (NULL). When running with taint checks enabled, indicates via
8337 C<maybe_tainted> if results are untrustworthy (often due to the use of
8340 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8346 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8347 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8348 vec_utf8 = DO_UTF8(vecsv);
8350 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8353 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8361 static const char nullstr[] = "(null)";
8363 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8364 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8366 /* Times 4: a decimal digit takes more than 3 binary digits.
8367 * NV_DIG: mantissa takes than many decimal digits.
8368 * Plus 32: Playing safe. */
8369 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8370 /* large enough for "%#.#f" --chip */
8371 /* what about long double NVs? --jhi */
8373 PERL_UNUSED_ARG(maybe_tainted);
8375 /* no matter what, this is a string now */
8376 (void)SvPV_force(sv, origlen);
8378 /* special-case "", "%s", and "%-p" (SVf - see below) */
8381 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8383 const char * const s = va_arg(*args, char*);
8384 sv_catpv(sv, s ? s : nullstr);
8386 else if (svix < svmax) {
8387 sv_catsv(sv, *svargs);
8391 if (args && patlen == 3 && pat[0] == '%' &&
8392 pat[1] == '-' && pat[2] == 'p') {
8393 argsv = (SV*)va_arg(*args, void*);
8394 sv_catsv(sv, argsv);
8398 #ifndef USE_LONG_DOUBLE
8399 /* special-case "%.<number>[gf]" */
8400 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8401 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8402 unsigned digits = 0;
8406 while (*pp >= '0' && *pp <= '9')
8407 digits = 10 * digits + (*pp++ - '0');
8408 if (pp - pat == (int)patlen - 1) {
8416 /* Add check for digits != 0 because it seems that some
8417 gconverts are buggy in this case, and we don't yet have
8418 a Configure test for this. */
8419 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8420 /* 0, point, slack */
8421 Gconvert(nv, (int)digits, 0, ebuf);
8423 if (*ebuf) /* May return an empty string for digits==0 */
8426 } else if (!digits) {
8429 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8430 sv_catpvn(sv, p, l);
8436 #endif /* !USE_LONG_DOUBLE */
8438 if (!args && svix < svmax && DO_UTF8(*svargs))
8441 patend = (char*)pat + patlen;
8442 for (p = (char*)pat; p < patend; p = q) {
8445 bool vectorize = FALSE;
8446 bool vectorarg = FALSE;
8447 bool vec_utf8 = FALSE;
8453 bool has_precis = FALSE;
8455 const I32 osvix = svix;
8456 bool is_utf8 = FALSE; /* is this item utf8? */
8457 #ifdef HAS_LDBL_SPRINTF_BUG
8458 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8459 with sfio - Allen <allens@cpan.org> */
8460 bool fix_ldbl_sprintf_bug = FALSE;
8464 U8 utf8buf[UTF8_MAXBYTES+1];
8465 STRLEN esignlen = 0;
8467 const char *eptr = NULL;
8470 const U8 *vecstr = NULL;
8477 /* we need a long double target in case HAS_LONG_DOUBLE but
8480 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8488 const char *dotstr = ".";
8489 STRLEN dotstrlen = 1;
8490 I32 efix = 0; /* explicit format parameter index */
8491 I32 ewix = 0; /* explicit width index */
8492 I32 epix = 0; /* explicit precision index */
8493 I32 evix = 0; /* explicit vector index */
8494 bool asterisk = FALSE;
8496 /* echo everything up to the next format specification */
8497 for (q = p; q < patend && *q != '%'; ++q) ;
8499 if (has_utf8 && !pat_utf8)
8500 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8502 sv_catpvn(sv, p, q - p);
8509 We allow format specification elements in this order:
8510 \d+\$ explicit format parameter index
8512 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8513 0 flag (as above): repeated to allow "v02"
8514 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8515 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8517 [%bcdefginopsuxDFOUX] format (mandatory)
8522 As of perl5.9.3, printf format checking is on by default.
8523 Internally, perl uses %p formats to provide an escape to
8524 some extended formatting. This block deals with those
8525 extensions: if it does not match, (char*)q is reset and
8526 the normal format processing code is used.
8528 Currently defined extensions are:
8529 %p include pointer address (standard)
8530 %-p (SVf) include an SV (previously %_)
8531 %-<num>p include an SV with precision <num>
8532 %1p (VDf) include a v-string (as %vd)
8533 %<num>p reserved for future extensions
8535 Robin Barker 2005-07-14
8542 n = expect_number(&q);
8549 argsv = (SV*)va_arg(*args, void*);
8550 eptr = SvPVx_const(argsv, elen);
8556 else if (n == vdNUMBER) { /* VDf */
8563 if (ckWARN_d(WARN_INTERNAL))
8564 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8565 "internal %%<num>p might conflict with future printf extensions");
8571 if ( (width = expect_number(&q)) ) {
8586 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8615 if ( (ewix = expect_number(&q)) )
8624 if ((vectorarg = asterisk)) {
8637 width = expect_number(&q);
8643 vecsv = va_arg(*args, SV*);
8645 vecsv = (evix > 0 && evix <= svmax)
8646 ? svargs[evix-1] : &PL_sv_undef;
8648 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8650 dotstr = SvPV_const(vecsv, dotstrlen);
8651 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8652 bad with tied or overloaded values that return UTF8. */
8655 else if (has_utf8) {
8656 vecsv = sv_mortalcopy(vecsv);
8657 sv_utf8_upgrade(vecsv);
8658 dotstr = SvPV_const(vecsv, dotstrlen);
8665 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8666 vecsv = svargs[efix ? efix-1 : svix++];
8667 vecstr = (U8*)SvPV_const(vecsv,veclen);
8668 vec_utf8 = DO_UTF8(vecsv);
8670 /* if this is a version object, we need to convert
8671 * back into v-string notation and then let the
8672 * vectorize happen normally
8674 if (sv_derived_from(vecsv, "version")) {
8675 char *version = savesvpv(vecsv);
8676 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8677 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8678 "vector argument not supported with alpha versions");
8681 vecsv = sv_newmortal();
8682 /* scan_vstring is expected to be called during
8683 * tokenization, so we need to fake up the end
8684 * of the buffer for it
8686 PL_bufend = version + veclen;
8687 scan_vstring(version, vecsv);
8688 vecstr = (U8*)SvPV_const(vecsv, veclen);
8689 vec_utf8 = DO_UTF8(vecsv);
8701 i = va_arg(*args, int);
8703 i = (ewix ? ewix <= svmax : svix < svmax) ?
8704 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8706 width = (i < 0) ? -i : i;
8716 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8718 /* XXX: todo, support specified precision parameter */
8722 i = va_arg(*args, int);
8724 i = (ewix ? ewix <= svmax : svix < svmax)
8725 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8727 has_precis = !(i < 0);
8732 precis = precis * 10 + (*q++ - '0');
8741 case 'I': /* Ix, I32x, and I64x */
8743 if (q[1] == '6' && q[2] == '4') {
8749 if (q[1] == '3' && q[2] == '2') {
8759 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8770 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8771 if (*(q + 1) == 'l') { /* lld, llf */
8797 if (!vectorize && !args) {
8799 const I32 i = efix-1;
8800 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8802 argsv = (svix >= 0 && svix < svmax)
8803 ? svargs[svix++] : &PL_sv_undef;
8814 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8816 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8818 eptr = (char*)utf8buf;
8819 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8833 eptr = va_arg(*args, char*);
8835 #ifdef MACOS_TRADITIONAL
8836 /* On MacOS, %#s format is used for Pascal strings */
8841 elen = strlen(eptr);
8843 eptr = (char *)nullstr;
8844 elen = sizeof nullstr - 1;
8848 eptr = SvPVx_const(argsv, elen);
8849 if (DO_UTF8(argsv)) {
8850 I32 old_precis = precis;
8851 if (has_precis && precis < elen) {
8853 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8856 if (width) { /* fudge width (can't fudge elen) */
8857 if (has_precis && precis < elen)
8858 width += precis - old_precis;
8860 width += elen - sv_len_utf8(argsv);
8867 if (has_precis && elen > precis)
8874 if (alt || vectorize)
8876 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8897 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8906 esignbuf[esignlen++] = plus;
8910 case 'h': iv = (short)va_arg(*args, int); break;
8911 case 'l': iv = va_arg(*args, long); break;
8912 case 'V': iv = va_arg(*args, IV); break;
8913 default: iv = va_arg(*args, int); break;
8915 case 'q': iv = va_arg(*args, Quad_t); break;
8920 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8922 case 'h': iv = (short)tiv; break;
8923 case 'l': iv = (long)tiv; break;
8925 default: iv = tiv; break;
8927 case 'q': iv = (Quad_t)tiv; break;
8931 if ( !vectorize ) /* we already set uv above */
8936 esignbuf[esignlen++] = plus;
8940 esignbuf[esignlen++] = '-';
8984 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8995 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8996 case 'l': uv = va_arg(*args, unsigned long); break;
8997 case 'V': uv = va_arg(*args, UV); break;
8998 default: uv = va_arg(*args, unsigned); break;
9000 case 'q': uv = va_arg(*args, Uquad_t); break;
9005 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9007 case 'h': uv = (unsigned short)tuv; break;
9008 case 'l': uv = (unsigned long)tuv; break;
9010 default: uv = tuv; break;
9012 case 'q': uv = (Uquad_t)tuv; break;
9019 char *ptr = ebuf + sizeof ebuf;
9020 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9026 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9032 esignbuf[esignlen++] = '0';
9033 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9041 if (alt && *ptr != '0')
9050 esignbuf[esignlen++] = '0';
9051 esignbuf[esignlen++] = c;
9054 default: /* it had better be ten or less */
9058 } while (uv /= base);
9061 elen = (ebuf + sizeof ebuf) - ptr;
9065 zeros = precis - elen;
9066 else if (precis == 0 && elen == 1 && *eptr == '0'
9067 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9070 /* a precision nullifies the 0 flag. */
9077 /* FLOATING POINT */
9080 c = 'f'; /* maybe %F isn't supported here */
9088 /* This is evil, but floating point is even more evil */
9090 /* for SV-style calling, we can only get NV
9091 for C-style calling, we assume %f is double;
9092 for simplicity we allow any of %Lf, %llf, %qf for long double
9096 #if defined(USE_LONG_DOUBLE)
9100 /* [perl #20339] - we should accept and ignore %lf rather than die */
9104 #if defined(USE_LONG_DOUBLE)
9105 intsize = args ? 0 : 'q';
9109 #if defined(HAS_LONG_DOUBLE)
9118 /* now we need (long double) if intsize == 'q', else (double) */
9120 #if LONG_DOUBLESIZE > DOUBLESIZE
9122 va_arg(*args, long double) :
9123 va_arg(*args, double)
9125 va_arg(*args, double)
9130 if (c != 'e' && c != 'E') {
9132 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9133 will cast our (long double) to (double) */
9134 (void)Perl_frexp(nv, &i);
9135 if (i == PERL_INT_MIN)
9136 Perl_die(aTHX_ "panic: frexp");
9138 need = BIT_DIGITS(i);
9140 need += has_precis ? precis : 6; /* known default */
9145 #ifdef HAS_LDBL_SPRINTF_BUG
9146 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9147 with sfio - Allen <allens@cpan.org> */
9150 # define MY_DBL_MAX DBL_MAX
9151 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9152 # if DOUBLESIZE >= 8
9153 # define MY_DBL_MAX 1.7976931348623157E+308L
9155 # define MY_DBL_MAX 3.40282347E+38L
9159 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9160 # define MY_DBL_MAX_BUG 1L
9162 # define MY_DBL_MAX_BUG MY_DBL_MAX
9166 # define MY_DBL_MIN DBL_MIN
9167 # else /* XXX guessing! -Allen */
9168 # if DOUBLESIZE >= 8
9169 # define MY_DBL_MIN 2.2250738585072014E-308L
9171 # define MY_DBL_MIN 1.17549435E-38L
9175 if ((intsize == 'q') && (c == 'f') &&
9176 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9178 /* it's going to be short enough that
9179 * long double precision is not needed */
9181 if ((nv <= 0L) && (nv >= -0L))
9182 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9184 /* would use Perl_fp_class as a double-check but not
9185 * functional on IRIX - see perl.h comments */
9187 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9188 /* It's within the range that a double can represent */
9189 #if defined(DBL_MAX) && !defined(DBL_MIN)
9190 if ((nv >= ((long double)1/DBL_MAX)) ||
9191 (nv <= (-(long double)1/DBL_MAX)))
9193 fix_ldbl_sprintf_bug = TRUE;
9196 if (fix_ldbl_sprintf_bug == TRUE) {
9206 # undef MY_DBL_MAX_BUG
9209 #endif /* HAS_LDBL_SPRINTF_BUG */
9211 need += 20; /* fudge factor */
9212 if (PL_efloatsize < need) {
9213 Safefree(PL_efloatbuf);
9214 PL_efloatsize = need + 20; /* more fudge */
9215 Newx(PL_efloatbuf, PL_efloatsize, char);
9216 PL_efloatbuf[0] = '\0';
9219 if ( !(width || left || plus || alt) && fill != '0'
9220 && has_precis && intsize != 'q' ) { /* Shortcuts */
9221 /* See earlier comment about buggy Gconvert when digits,
9223 if ( c == 'g' && precis) {
9224 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9225 /* May return an empty string for digits==0 */
9226 if (*PL_efloatbuf) {
9227 elen = strlen(PL_efloatbuf);
9228 goto float_converted;
9230 } else if ( c == 'f' && !precis) {
9231 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9236 char *ptr = ebuf + sizeof ebuf;
9239 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9240 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9241 if (intsize == 'q') {
9242 /* Copy the one or more characters in a long double
9243 * format before the 'base' ([efgEFG]) character to
9244 * the format string. */
9245 static char const prifldbl[] = PERL_PRIfldbl;
9246 char const *p = prifldbl + sizeof(prifldbl) - 3;
9247 while (p >= prifldbl) { *--ptr = *p--; }
9252 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9257 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9269 /* No taint. Otherwise we are in the strange situation
9270 * where printf() taints but print($float) doesn't.
9272 #if defined(HAS_LONG_DOUBLE)
9273 elen = ((intsize == 'q')
9274 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9275 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9277 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9281 eptr = PL_efloatbuf;
9289 i = SvCUR(sv) - origlen;
9292 case 'h': *(va_arg(*args, short*)) = i; break;
9293 default: *(va_arg(*args, int*)) = i; break;
9294 case 'l': *(va_arg(*args, long*)) = i; break;
9295 case 'V': *(va_arg(*args, IV*)) = i; break;
9297 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9302 sv_setuv_mg(argsv, (UV)i);
9303 continue; /* not "break" */
9310 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9311 && ckWARN(WARN_PRINTF))
9313 SV * const msg = sv_newmortal();
9314 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9315 (PL_op->op_type == OP_PRTF) ? "" : "s");
9318 Perl_sv_catpvf(aTHX_ msg,
9319 "\"%%%c\"", c & 0xFF);
9321 Perl_sv_catpvf(aTHX_ msg,
9322 "\"%%\\%03"UVof"\"",
9325 sv_catpvs(msg, "end of string");
9326 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9329 /* output mangled stuff ... */
9335 /* ... right here, because formatting flags should not apply */
9336 SvGROW(sv, SvCUR(sv) + elen + 1);
9338 Copy(eptr, p, elen, char);
9341 SvCUR_set(sv, p - SvPVX_const(sv));
9343 continue; /* not "break" */
9346 if (is_utf8 != has_utf8) {
9349 sv_utf8_upgrade(sv);
9352 const STRLEN old_elen = elen;
9353 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9354 sv_utf8_upgrade(nsv);
9355 eptr = SvPVX_const(nsv);
9358 if (width) { /* fudge width (can't fudge elen) */
9359 width += elen - old_elen;
9365 have = esignlen + zeros + elen;
9367 Perl_croak_nocontext(PL_memory_wrap);
9369 need = (have > width ? have : width);
9372 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9373 Perl_croak_nocontext(PL_memory_wrap);
9374 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9376 if (esignlen && fill == '0') {
9378 for (i = 0; i < (int)esignlen; i++)
9382 memset(p, fill, gap);
9385 if (esignlen && fill != '0') {
9387 for (i = 0; i < (int)esignlen; i++)
9392 for (i = zeros; i; i--)
9396 Copy(eptr, p, elen, char);
9400 memset(p, ' ', gap);
9405 Copy(dotstr, p, dotstrlen, char);
9409 vectorize = FALSE; /* done iterating over vecstr */
9416 SvCUR_set(sv, p - SvPVX_const(sv));
9424 /* =========================================================================
9426 =head1 Cloning an interpreter
9428 All the macros and functions in this section are for the private use of
9429 the main function, perl_clone().
9431 The foo_dup() functions make an exact copy of an existing foo thinngy.
9432 During the course of a cloning, a hash table is used to map old addresses
9433 to new addresses. The table is created and manipulated with the
9434 ptr_table_* functions.
9438 ============================================================================*/
9441 #if defined(USE_ITHREADS)
9443 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9444 #ifndef GpREFCNT_inc
9445 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9449 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9450 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9451 If this changes, please unmerge ss_dup. */
9452 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9453 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9454 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9455 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9456 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9457 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9458 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9459 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9460 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9461 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9462 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9463 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9464 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9465 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9467 /* clone a parser */
9470 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9477 /* look for it in the table first */
9478 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9482 /* create anew and remember what it is */
9483 Newxz(parser, 1, yy_parser);
9484 ptr_table_store(PL_ptr_table, proto, parser);
9486 parser->yyerrstatus = 0;
9487 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9489 /* XXX these not yet duped */
9490 parser->old_parser = NULL;
9491 parser->stack = NULL;
9493 parser->stack_size = 0;
9494 /* XXX parser->stack->state = 0; */
9496 /* XXX eventually, just Copy() most of the parser struct ? */
9498 parser->lex_brackets = proto->lex_brackets;
9499 parser->lex_casemods = proto->lex_casemods;
9500 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9501 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9502 parser->lex_casestack = savepvn(proto->lex_casestack,
9503 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9504 parser->lex_defer = proto->lex_defer;
9505 parser->lex_dojoin = proto->lex_dojoin;
9506 parser->lex_expect = proto->lex_expect;
9507 parser->lex_formbrack = proto->lex_formbrack;
9508 parser->lex_inpat = proto->lex_inpat;
9509 parser->lex_inwhat = proto->lex_inwhat;
9510 parser->lex_op = proto->lex_op;
9511 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9512 parser->lex_starts = proto->lex_starts;
9513 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9514 parser->multi_close = proto->multi_close;
9515 parser->multi_open = proto->multi_open;
9516 parser->multi_start = proto->multi_start;
9517 parser->pending_ident = proto->pending_ident;
9518 parser->preambled = proto->preambled;
9519 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9522 parser->endwhite = proto->endwhite;
9523 parser->faketokens = proto->faketokens;
9524 parser->lasttoke = proto->lasttoke;
9525 parser->nextwhite = proto->nextwhite;
9526 parser->realtokenstart = proto->realtokenstart;
9527 parser->skipwhite = proto->skipwhite;
9528 parser->thisclose = proto->thisclose;
9529 parser->thismad = proto->thismad;
9530 parser->thisopen = proto->thisopen;
9531 parser->thisstuff = proto->thisstuff;
9532 parser->thistoken = proto->thistoken;
9533 parser->thiswhite = proto->thiswhite;
9539 /* duplicate a file handle */
9542 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9546 PERL_UNUSED_ARG(type);
9549 return (PerlIO*)NULL;
9551 /* look for it in the table first */
9552 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9556 /* create anew and remember what it is */
9557 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9558 ptr_table_store(PL_ptr_table, fp, ret);
9562 /* duplicate a directory handle */
9565 Perl_dirp_dup(pTHX_ DIR *dp)
9567 PERL_UNUSED_CONTEXT;
9574 /* duplicate a typeglob */
9577 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9583 /* look for it in the table first */
9584 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9588 /* create anew and remember what it is */
9590 ptr_table_store(PL_ptr_table, gp, ret);
9593 ret->gp_refcnt = 0; /* must be before any other dups! */
9594 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9595 ret->gp_io = io_dup_inc(gp->gp_io, param);
9596 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9597 ret->gp_av = av_dup_inc(gp->gp_av, param);
9598 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9599 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9600 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9601 ret->gp_cvgen = gp->gp_cvgen;
9602 ret->gp_line = gp->gp_line;
9603 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9607 /* duplicate a chain of magic */
9610 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9612 MAGIC *mgprev = (MAGIC*)NULL;
9615 return (MAGIC*)NULL;
9616 /* look for it in the table first */
9617 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9621 for (; mg; mg = mg->mg_moremagic) {
9623 Newxz(nmg, 1, MAGIC);
9625 mgprev->mg_moremagic = nmg;
9628 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9629 nmg->mg_private = mg->mg_private;
9630 nmg->mg_type = mg->mg_type;
9631 nmg->mg_flags = mg->mg_flags;
9632 if (mg->mg_type == PERL_MAGIC_qr) {
9633 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9635 else if(mg->mg_type == PERL_MAGIC_backref) {
9636 /* The backref AV has its reference count deliberately bumped by
9638 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9640 else if (mg->mg_type == PERL_MAGIC_symtab) {
9641 nmg->mg_obj = mg->mg_obj;
9644 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9645 ? sv_dup_inc(mg->mg_obj, param)
9646 : sv_dup(mg->mg_obj, param);
9648 nmg->mg_len = mg->mg_len;
9649 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9650 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9651 if (mg->mg_len > 0) {
9652 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9653 if (mg->mg_type == PERL_MAGIC_overload_table &&
9654 AMT_AMAGIC((AMT*)mg->mg_ptr))
9656 const AMT * const amtp = (AMT*)mg->mg_ptr;
9657 AMT * const namtp = (AMT*)nmg->mg_ptr;
9659 for (i = 1; i < NofAMmeth; i++) {
9660 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9664 else if (mg->mg_len == HEf_SVKEY)
9665 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9667 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9668 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9675 #endif /* USE_ITHREADS */
9677 /* create a new pointer-mapping table */
9680 Perl_ptr_table_new(pTHX)
9683 PERL_UNUSED_CONTEXT;
9685 Newxz(tbl, 1, PTR_TBL_t);
9688 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9692 #define PTR_TABLE_HASH(ptr) \
9693 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9696 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9697 following define) and at call to new_body_inline made below in
9698 Perl_ptr_table_store()
9701 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9703 /* map an existing pointer using a table */
9705 STATIC PTR_TBL_ENT_t *
9706 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9707 PTR_TBL_ENT_t *tblent;
9708 const UV hash = PTR_TABLE_HASH(sv);
9710 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9711 for (; tblent; tblent = tblent->next) {
9712 if (tblent->oldval == sv)
9719 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9721 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9722 PERL_UNUSED_CONTEXT;
9723 return tblent ? tblent->newval : NULL;
9726 /* add a new entry to a pointer-mapping table */
9729 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9731 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9732 PERL_UNUSED_CONTEXT;
9735 tblent->newval = newsv;
9737 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9739 new_body_inline(tblent, PTE_SVSLOT);
9741 tblent->oldval = oldsv;
9742 tblent->newval = newsv;
9743 tblent->next = tbl->tbl_ary[entry];
9744 tbl->tbl_ary[entry] = tblent;
9746 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9747 ptr_table_split(tbl);
9751 /* double the hash bucket size of an existing ptr table */
9754 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9756 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9757 const UV oldsize = tbl->tbl_max + 1;
9758 UV newsize = oldsize * 2;
9760 PERL_UNUSED_CONTEXT;
9762 Renew(ary, newsize, PTR_TBL_ENT_t*);
9763 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9764 tbl->tbl_max = --newsize;
9766 for (i=0; i < oldsize; i++, ary++) {
9767 PTR_TBL_ENT_t **curentp, **entp, *ent;
9770 curentp = ary + oldsize;
9771 for (entp = ary, ent = *ary; ent; ent = *entp) {
9772 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9774 ent->next = *curentp;
9784 /* remove all the entries from a ptr table */
9787 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9789 if (tbl && tbl->tbl_items) {
9790 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9791 UV riter = tbl->tbl_max;
9794 PTR_TBL_ENT_t *entry = array[riter];
9797 PTR_TBL_ENT_t * const oentry = entry;
9798 entry = entry->next;
9807 /* clear and free a ptr table */
9810 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9815 ptr_table_clear(tbl);
9816 Safefree(tbl->tbl_ary);
9820 #if defined(USE_ITHREADS)
9823 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9826 SvRV_set(dstr, SvWEAKREF(sstr)
9827 ? sv_dup(SvRV(sstr), param)
9828 : sv_dup_inc(SvRV(sstr), param));
9831 else if (SvPVX_const(sstr)) {
9832 /* Has something there */
9834 /* Normal PV - clone whole allocated space */
9835 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9836 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9837 /* Not that normal - actually sstr is copy on write.
9838 But we are a true, independant SV, so: */
9839 SvREADONLY_off(dstr);
9844 /* Special case - not normally malloced for some reason */
9845 if (isGV_with_GP(sstr)) {
9846 /* Don't need to do anything here. */
9848 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9849 /* A "shared" PV - clone it as "shared" PV */
9851 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9855 /* Some other special case - random pointer */
9856 SvPV_set(dstr, SvPVX(sstr));
9862 if (SvTYPE(dstr) == SVt_RV)
9863 SvRV_set(dstr, NULL);
9865 SvPV_set(dstr, NULL);
9869 /* duplicate an SV of any type (including AV, HV etc) */
9872 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9877 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9879 /* look for it in the table first */
9880 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9884 if(param->flags & CLONEf_JOIN_IN) {
9885 /** We are joining here so we don't want do clone
9886 something that is bad **/
9887 if (SvTYPE(sstr) == SVt_PVHV) {
9888 const char * const hvname = HvNAME_get(sstr);
9890 /** don't clone stashes if they already exist **/
9891 return (SV*)gv_stashpv(hvname,0);
9895 /* create anew and remember what it is */
9898 #ifdef DEBUG_LEAKING_SCALARS
9899 dstr->sv_debug_optype = sstr->sv_debug_optype;
9900 dstr->sv_debug_line = sstr->sv_debug_line;
9901 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9902 dstr->sv_debug_cloned = 1;
9903 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9906 ptr_table_store(PL_ptr_table, sstr, dstr);
9909 SvFLAGS(dstr) = SvFLAGS(sstr);
9910 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9911 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9914 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9915 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9916 (void*)PL_watch_pvx, SvPVX_const(sstr));
9919 /* don't clone objects whose class has asked us not to */
9920 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9921 SvFLAGS(dstr) &= ~SVTYPEMASK;
9926 switch (SvTYPE(sstr)) {
9931 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9932 SvIV_set(dstr, SvIVX(sstr));
9935 SvANY(dstr) = new_XNV();
9936 SvNV_set(dstr, SvNVX(sstr));
9939 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9940 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9942 /* case SVt_BIND: */
9945 /* These are all the types that need complex bodies allocating. */
9947 const svtype sv_type = SvTYPE(sstr);
9948 const struct body_details *const sv_type_details
9949 = bodies_by_type + sv_type;
9953 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9957 if (GvUNIQUE((GV*)sstr)) {
9958 NOOP; /* Do sharing here, and fall through */
9970 assert(sv_type_details->body_size);
9971 if (sv_type_details->arena) {
9972 new_body_inline(new_body, sv_type);
9974 = (void*)((char*)new_body - sv_type_details->offset);
9976 new_body = new_NOARENA(sv_type_details);
9980 SvANY(dstr) = new_body;
9983 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9984 ((char*)SvANY(dstr)) + sv_type_details->offset,
9985 sv_type_details->copy, char);
9987 Copy(((char*)SvANY(sstr)),
9988 ((char*)SvANY(dstr)),
9989 sv_type_details->body_size + sv_type_details->offset, char);
9992 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9993 && !isGV_with_GP(dstr))
9994 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9996 /* The Copy above means that all the source (unduplicated) pointers
9997 are now in the destination. We can check the flags and the
9998 pointers in either, but it's possible that there's less cache
9999 missing by always going for the destination.
10000 FIXME - instrument and check that assumption */
10001 if (sv_type >= SVt_PVMG) {
10002 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10003 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10004 } else if (SvMAGIC(dstr))
10005 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10007 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10010 /* The cast silences a GCC warning about unhandled types. */
10011 switch ((int)sv_type) {
10021 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10022 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10023 LvTARG(dstr) = dstr;
10024 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10025 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10027 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10029 if(isGV_with_GP(sstr)) {
10030 if (GvNAME_HEK(dstr))
10031 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10032 /* Don't call sv_add_backref here as it's going to be
10033 created as part of the magic cloning of the symbol
10035 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10036 at the point of this comment. */
10037 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10038 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10039 (void)GpREFCNT_inc(GvGP(dstr));
10041 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10044 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10045 if (IoOFP(dstr) == IoIFP(sstr))
10046 IoOFP(dstr) = IoIFP(dstr);
10048 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10049 /* PL_rsfp_filters entries have fake IoDIRP() */
10050 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10051 /* I have no idea why fake dirp (rsfps)
10052 should be treated differently but otherwise
10053 we end up with leaks -- sky*/
10054 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10055 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10056 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10058 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10059 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10060 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10061 if (IoDIRP(dstr)) {
10062 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10065 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10068 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10069 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10070 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10073 if (AvARRAY((AV*)sstr)) {
10074 SV **dst_ary, **src_ary;
10075 SSize_t items = AvFILLp((AV*)sstr) + 1;
10077 src_ary = AvARRAY((AV*)sstr);
10078 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10079 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10080 AvARRAY((AV*)dstr) = dst_ary;
10081 AvALLOC((AV*)dstr) = dst_ary;
10082 if (AvREAL((AV*)sstr)) {
10083 while (items-- > 0)
10084 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10087 while (items-- > 0)
10088 *dst_ary++ = sv_dup(*src_ary++, param);
10090 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10091 while (items-- > 0) {
10092 *dst_ary++ = &PL_sv_undef;
10096 AvARRAY((AV*)dstr) = NULL;
10097 AvALLOC((AV*)dstr) = (SV**)NULL;
10101 if (HvARRAY((HV*)sstr)) {
10103 const bool sharekeys = !!HvSHAREKEYS(sstr);
10104 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10105 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10107 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10108 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10110 HvARRAY(dstr) = (HE**)darray;
10111 while (i <= sxhv->xhv_max) {
10112 const HE * const source = HvARRAY(sstr)[i];
10113 HvARRAY(dstr)[i] = source
10114 ? he_dup(source, sharekeys, param) : 0;
10119 const struct xpvhv_aux * const saux = HvAUX(sstr);
10120 struct xpvhv_aux * const daux = HvAUX(dstr);
10121 /* This flag isn't copied. */
10122 /* SvOOK_on(hv) attacks the IV flags. */
10123 SvFLAGS(dstr) |= SVf_OOK;
10125 hvname = saux->xhv_name;
10126 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10128 daux->xhv_riter = saux->xhv_riter;
10129 daux->xhv_eiter = saux->xhv_eiter
10130 ? he_dup(saux->xhv_eiter,
10131 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10132 daux->xhv_backreferences =
10133 saux->xhv_backreferences
10134 ? (AV*) SvREFCNT_inc(
10135 sv_dup((SV*)saux->xhv_backreferences, param))
10137 /* Record stashes for possible cloning in Perl_clone(). */
10139 av_push(param->stashes, dstr);
10143 HvARRAY((HV*)dstr) = NULL;
10146 if (!(param->flags & CLONEf_COPY_STACKS)) {
10150 /* NOTE: not refcounted */
10151 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10153 if (!CvISXSUB(dstr))
10154 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10156 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10157 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10158 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10159 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10161 /* don't dup if copying back - CvGV isn't refcounted, so the
10162 * duped GV may never be freed. A bit of a hack! DAPM */
10163 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10164 NULL : gv_dup(CvGV(dstr), param) ;
10165 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10167 CvWEAKOUTSIDE(sstr)
10168 ? cv_dup( CvOUTSIDE(dstr), param)
10169 : cv_dup_inc(CvOUTSIDE(dstr), param);
10170 if (!CvISXSUB(dstr))
10171 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10177 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10183 /* duplicate a context */
10186 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10188 PERL_CONTEXT *ncxs;
10191 return (PERL_CONTEXT*)NULL;
10193 /* look for it in the table first */
10194 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10198 /* create anew and remember what it is */
10199 Newxz(ncxs, max + 1, PERL_CONTEXT);
10200 ptr_table_store(PL_ptr_table, cxs, ncxs);
10203 PERL_CONTEXT * const cx = &cxs[ix];
10204 PERL_CONTEXT * const ncx = &ncxs[ix];
10205 ncx->cx_type = cx->cx_type;
10206 if (CxTYPE(cx) == CXt_SUBST) {
10207 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10210 ncx->blk_oldsp = cx->blk_oldsp;
10211 ncx->blk_oldcop = cx->blk_oldcop;
10212 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10213 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10214 ncx->blk_oldpm = cx->blk_oldpm;
10215 ncx->blk_gimme = cx->blk_gimme;
10216 switch (CxTYPE(cx)) {
10218 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10219 ? cv_dup_inc(cx->blk_sub.cv, param)
10220 : cv_dup(cx->blk_sub.cv,param));
10221 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10222 ? av_dup_inc(cx->blk_sub.argarray, param)
10224 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10225 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10226 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10227 ncx->blk_sub.lval = cx->blk_sub.lval;
10228 ncx->blk_sub.retop = cx->blk_sub.retop;
10229 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10230 cx->blk_sub.oldcomppad);
10233 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10234 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10235 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10236 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10237 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10238 ncx->blk_eval.retop = cx->blk_eval.retop;
10241 ncx->blk_loop.label = cx->blk_loop.label;
10242 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10243 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10244 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10245 ? cx->blk_loop.iterdata
10246 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10247 ncx->blk_loop.oldcomppad
10248 = (PAD*)ptr_table_fetch(PL_ptr_table,
10249 cx->blk_loop.oldcomppad);
10250 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10251 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10252 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10253 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10254 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10257 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10258 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10259 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10260 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10261 ncx->blk_sub.retop = cx->blk_sub.retop;
10273 /* duplicate a stack info structure */
10276 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10281 return (PERL_SI*)NULL;
10283 /* look for it in the table first */
10284 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10288 /* create anew and remember what it is */
10289 Newxz(nsi, 1, PERL_SI);
10290 ptr_table_store(PL_ptr_table, si, nsi);
10292 nsi->si_stack = av_dup_inc(si->si_stack, param);
10293 nsi->si_cxix = si->si_cxix;
10294 nsi->si_cxmax = si->si_cxmax;
10295 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10296 nsi->si_type = si->si_type;
10297 nsi->si_prev = si_dup(si->si_prev, param);
10298 nsi->si_next = si_dup(si->si_next, param);
10299 nsi->si_markoff = si->si_markoff;
10304 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10305 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10306 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10307 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10308 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10309 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10310 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10311 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10312 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10313 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10314 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10315 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10316 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10317 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10320 #define pv_dup_inc(p) SAVEPV(p)
10321 #define pv_dup(p) SAVEPV(p)
10322 #define svp_dup_inc(p,pp) any_dup(p,pp)
10324 /* map any object to the new equivent - either something in the
10325 * ptr table, or something in the interpreter structure
10329 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10334 return (void*)NULL;
10336 /* look for it in the table first */
10337 ret = ptr_table_fetch(PL_ptr_table, v);
10341 /* see if it is part of the interpreter structure */
10342 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10343 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10351 /* duplicate the save stack */
10354 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10357 ANY * const ss = proto_perl->Tsavestack;
10358 const I32 max = proto_perl->Tsavestack_max;
10359 I32 ix = proto_perl->Tsavestack_ix;
10372 void (*dptr) (void*);
10373 void (*dxptr) (pTHX_ void*);
10375 Newxz(nss, max, ANY);
10378 const I32 type = POPINT(ss,ix);
10379 TOPINT(nss,ix) = type;
10381 case SAVEt_HELEM: /* hash element */
10382 sv = (SV*)POPPTR(ss,ix);
10383 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10385 case SAVEt_ITEM: /* normal string */
10386 case SAVEt_SV: /* scalar reference */
10387 sv = (SV*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10391 case SAVEt_MORTALIZESV:
10392 sv = (SV*)POPPTR(ss,ix);
10393 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10395 case SAVEt_SHARED_PVREF: /* char* in shared space */
10396 c = (char*)POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = savesharedpv(c);
10398 ptr = POPPTR(ss,ix);
10399 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10401 case SAVEt_GENERIC_SVREF: /* generic sv */
10402 case SAVEt_SVREF: /* scalar reference */
10403 sv = (SV*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10405 ptr = POPPTR(ss,ix);
10406 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10408 case SAVEt_HV: /* hash reference */
10409 case SAVEt_AV: /* array reference */
10410 sv = (SV*) POPPTR(ss,ix);
10411 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10413 case SAVEt_COMPPAD:
10415 sv = (SV*) POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = sv_dup(sv, param);
10418 case SAVEt_INT: /* int reference */
10419 ptr = POPPTR(ss,ix);
10420 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10421 intval = (int)POPINT(ss,ix);
10422 TOPINT(nss,ix) = intval;
10424 case SAVEt_LONG: /* long reference */
10425 ptr = POPPTR(ss,ix);
10426 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10428 case SAVEt_CLEARSV:
10429 longval = (long)POPLONG(ss,ix);
10430 TOPLONG(nss,ix) = longval;
10432 case SAVEt_I32: /* I32 reference */
10433 case SAVEt_I16: /* I16 reference */
10434 case SAVEt_I8: /* I8 reference */
10435 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10436 ptr = POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10439 TOPINT(nss,ix) = i;
10441 case SAVEt_IV: /* IV reference */
10442 ptr = POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10445 TOPIV(nss,ix) = iv;
10447 case SAVEt_HPTR: /* HV* reference */
10448 case SAVEt_APTR: /* AV* reference */
10449 case SAVEt_SPTR: /* SV* reference */
10450 ptr = POPPTR(ss,ix);
10451 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10452 sv = (SV*)POPPTR(ss,ix);
10453 TOPPTR(nss,ix) = sv_dup(sv, param);
10455 case SAVEt_VPTR: /* random* reference */
10456 ptr = POPPTR(ss,ix);
10457 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10458 ptr = POPPTR(ss,ix);
10459 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10461 case SAVEt_GENERIC_PVREF: /* generic char* */
10462 case SAVEt_PPTR: /* char* reference */
10463 ptr = POPPTR(ss,ix);
10464 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10465 c = (char*)POPPTR(ss,ix);
10466 TOPPTR(nss,ix) = pv_dup(c);
10468 case SAVEt_GP: /* scalar reference */
10469 gp = (GP*)POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10471 (void)GpREFCNT_inc(gp);
10472 gv = (GV*)POPPTR(ss,ix);
10473 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10476 ptr = POPPTR(ss,ix);
10477 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10478 /* these are assumed to be refcounted properly */
10480 switch (((OP*)ptr)->op_type) {
10482 case OP_LEAVESUBLV:
10486 case OP_LEAVEWRITE:
10487 TOPPTR(nss,ix) = ptr;
10494 TOPPTR(nss,ix) = NULL;
10499 TOPPTR(nss,ix) = NULL;
10502 c = (char*)POPPTR(ss,ix);
10503 TOPPTR(nss,ix) = pv_dup_inc(c);
10506 hv = (HV*)POPPTR(ss,ix);
10507 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10508 c = (char*)POPPTR(ss,ix);
10509 TOPPTR(nss,ix) = pv_dup_inc(c);
10511 case SAVEt_STACK_POS: /* Position on Perl stack */
10513 TOPINT(nss,ix) = i;
10515 case SAVEt_DESTRUCTOR:
10516 ptr = POPPTR(ss,ix);
10517 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10518 dptr = POPDPTR(ss,ix);
10519 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10520 any_dup(FPTR2DPTR(void *, dptr),
10523 case SAVEt_DESTRUCTOR_X:
10524 ptr = POPPTR(ss,ix);
10525 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10526 dxptr = POPDXPTR(ss,ix);
10527 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10528 any_dup(FPTR2DPTR(void *, dxptr),
10531 case SAVEt_REGCONTEXT:
10534 TOPINT(nss,ix) = i;
10537 case SAVEt_AELEM: /* array element */
10538 sv = (SV*)POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10541 TOPINT(nss,ix) = i;
10542 av = (AV*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = av_dup_inc(av, param);
10546 ptr = POPPTR(ss,ix);
10547 TOPPTR(nss,ix) = ptr;
10551 TOPINT(nss,ix) = i;
10552 ptr = POPPTR(ss,ix);
10555 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10556 HINTS_REFCNT_UNLOCK;
10558 TOPPTR(nss,ix) = ptr;
10559 if (i & HINT_LOCALIZE_HH) {
10560 hv = (HV*)POPPTR(ss,ix);
10561 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10565 longval = (long)POPLONG(ss,ix);
10566 TOPLONG(nss,ix) = longval;
10567 ptr = POPPTR(ss,ix);
10568 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10569 sv = (SV*)POPPTR(ss,ix);
10570 TOPPTR(nss,ix) = sv_dup(sv, param);
10573 ptr = POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10575 longval = (long)POPBOOL(ss,ix);
10576 TOPBOOL(nss,ix) = (bool)longval;
10578 case SAVEt_SET_SVFLAGS:
10580 TOPINT(nss,ix) = i;
10582 TOPINT(nss,ix) = i;
10583 sv = (SV*)POPPTR(ss,ix);
10584 TOPPTR(nss,ix) = sv_dup(sv, param);
10586 case SAVEt_RE_STATE:
10588 const struct re_save_state *const old_state
10589 = (struct re_save_state *)
10590 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10591 struct re_save_state *const new_state
10592 = (struct re_save_state *)
10593 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10595 Copy(old_state, new_state, 1, struct re_save_state);
10596 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10598 new_state->re_state_bostr
10599 = pv_dup(old_state->re_state_bostr);
10600 new_state->re_state_reginput
10601 = pv_dup(old_state->re_state_reginput);
10602 new_state->re_state_regeol
10603 = pv_dup(old_state->re_state_regeol);
10604 new_state->re_state_regstartp
10605 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10606 new_state->re_state_regendp
10607 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10608 new_state->re_state_reglastparen
10609 = (U32*) any_dup(old_state->re_state_reglastparen,
10611 new_state->re_state_reglastcloseparen
10612 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10614 /* XXX This just has to be broken. The old save_re_context
10615 code did SAVEGENERICPV(PL_reg_start_tmp);
10616 PL_reg_start_tmp is char **.
10617 Look above to what the dup code does for
10618 SAVEt_GENERIC_PVREF
10619 It can never have worked.
10620 So this is merely a faithful copy of the exiting bug: */
10621 new_state->re_state_reg_start_tmp
10622 = (char **) pv_dup((char *)
10623 old_state->re_state_reg_start_tmp);
10624 /* I assume that it only ever "worked" because no-one called
10625 (pseudo)fork while the regexp engine had re-entered itself.
10627 #ifdef PERL_OLD_COPY_ON_WRITE
10628 new_state->re_state_nrs
10629 = sv_dup(old_state->re_state_nrs, param);
10631 new_state->re_state_reg_magic
10632 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10634 new_state->re_state_reg_oldcurpm
10635 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10637 new_state->re_state_reg_curpm
10638 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10640 new_state->re_state_reg_oldsaved
10641 = pv_dup(old_state->re_state_reg_oldsaved);
10642 new_state->re_state_reg_poscache
10643 = pv_dup(old_state->re_state_reg_poscache);
10644 new_state->re_state_reg_starttry
10645 = pv_dup(old_state->re_state_reg_starttry);
10648 case SAVEt_COMPILE_WARNINGS:
10649 ptr = POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10653 ptr = POPPTR(ss,ix);
10654 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10658 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10666 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10667 * flag to the result. This is done for each stash before cloning starts,
10668 * so we know which stashes want their objects cloned */
10671 do_mark_cloneable_stash(pTHX_ SV *sv)
10673 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10675 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10676 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10677 if (cloner && GvCV(cloner)) {
10684 XPUSHs(sv_2mortal(newSVhek(hvname)));
10686 call_sv((SV*)GvCV(cloner), G_SCALAR);
10693 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10701 =for apidoc perl_clone
10703 Create and return a new interpreter by cloning the current one.
10705 perl_clone takes these flags as parameters:
10707 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10708 without it we only clone the data and zero the stacks,
10709 with it we copy the stacks and the new perl interpreter is
10710 ready to run at the exact same point as the previous one.
10711 The pseudo-fork code uses COPY_STACKS while the
10712 threads->new doesn't.
10714 CLONEf_KEEP_PTR_TABLE
10715 perl_clone keeps a ptr_table with the pointer of the old
10716 variable as a key and the new variable as a value,
10717 this allows it to check if something has been cloned and not
10718 clone it again but rather just use the value and increase the
10719 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10720 the ptr_table using the function
10721 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10722 reason to keep it around is if you want to dup some of your own
10723 variable who are outside the graph perl scans, example of this
10724 code is in threads.xs create
10727 This is a win32 thing, it is ignored on unix, it tells perls
10728 win32host code (which is c++) to clone itself, this is needed on
10729 win32 if you want to run two threads at the same time,
10730 if you just want to do some stuff in a separate perl interpreter
10731 and then throw it away and return to the original one,
10732 you don't need to do anything.
10737 /* XXX the above needs expanding by someone who actually understands it ! */
10738 EXTERN_C PerlInterpreter *
10739 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10742 perl_clone(PerlInterpreter *proto_perl, UV flags)
10745 #ifdef PERL_IMPLICIT_SYS
10747 /* perlhost.h so we need to call into it
10748 to clone the host, CPerlHost should have a c interface, sky */
10750 if (flags & CLONEf_CLONE_HOST) {
10751 return perl_clone_host(proto_perl,flags);
10753 return perl_clone_using(proto_perl, flags,
10755 proto_perl->IMemShared,
10756 proto_perl->IMemParse,
10758 proto_perl->IStdIO,
10762 proto_perl->IProc);
10766 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10767 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10768 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10769 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10770 struct IPerlDir* ipD, struct IPerlSock* ipS,
10771 struct IPerlProc* ipP)
10773 /* XXX many of the string copies here can be optimized if they're
10774 * constants; they need to be allocated as common memory and just
10775 * their pointers copied. */
10778 CLONE_PARAMS clone_params;
10779 CLONE_PARAMS* const param = &clone_params;
10781 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10782 /* for each stash, determine whether its objects should be cloned */
10783 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10784 PERL_SET_THX(my_perl);
10787 PoisonNew(my_perl, 1, PerlInterpreter);
10793 PL_savestack_ix = 0;
10794 PL_savestack_max = -1;
10795 PL_sig_pending = 0;
10796 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10797 # else /* !DEBUGGING */
10798 Zero(my_perl, 1, PerlInterpreter);
10799 # endif /* DEBUGGING */
10801 /* host pointers */
10803 PL_MemShared = ipMS;
10804 PL_MemParse = ipMP;
10811 #else /* !PERL_IMPLICIT_SYS */
10813 CLONE_PARAMS clone_params;
10814 CLONE_PARAMS* param = &clone_params;
10815 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10816 /* for each stash, determine whether its objects should be cloned */
10817 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10818 PERL_SET_THX(my_perl);
10821 PoisonNew(my_perl, 1, PerlInterpreter);
10827 PL_savestack_ix = 0;
10828 PL_savestack_max = -1;
10829 PL_sig_pending = 0;
10830 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10831 # else /* !DEBUGGING */
10832 Zero(my_perl, 1, PerlInterpreter);
10833 # endif /* DEBUGGING */
10834 #endif /* PERL_IMPLICIT_SYS */
10835 param->flags = flags;
10836 param->proto_perl = proto_perl;
10838 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10840 PL_body_arenas = NULL;
10841 Zero(&PL_body_roots, 1, PL_body_roots);
10843 PL_nice_chunk = NULL;
10844 PL_nice_chunk_size = 0;
10846 PL_sv_objcount = 0;
10848 PL_sv_arenaroot = NULL;
10850 PL_debug = proto_perl->Idebug;
10852 PL_hash_seed = proto_perl->Ihash_seed;
10853 PL_rehash_seed = proto_perl->Irehash_seed;
10855 #ifdef USE_REENTRANT_API
10856 /* XXX: things like -Dm will segfault here in perlio, but doing
10857 * PERL_SET_CONTEXT(proto_perl);
10858 * breaks too many other things
10860 Perl_reentrant_init(aTHX);
10863 /* create SV map for pointer relocation */
10864 PL_ptr_table = ptr_table_new();
10866 /* initialize these special pointers as early as possible */
10867 SvANY(&PL_sv_undef) = NULL;
10868 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10869 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10870 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10872 SvANY(&PL_sv_no) = new_XPVNV();
10873 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10874 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10875 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10876 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10877 SvCUR_set(&PL_sv_no, 0);
10878 SvLEN_set(&PL_sv_no, 1);
10879 SvIV_set(&PL_sv_no, 0);
10880 SvNV_set(&PL_sv_no, 0);
10881 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10883 SvANY(&PL_sv_yes) = new_XPVNV();
10884 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10885 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10886 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10887 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10888 SvCUR_set(&PL_sv_yes, 1);
10889 SvLEN_set(&PL_sv_yes, 2);
10890 SvIV_set(&PL_sv_yes, 1);
10891 SvNV_set(&PL_sv_yes, 1);
10892 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10894 /* create (a non-shared!) shared string table */
10895 PL_strtab = newHV();
10896 HvSHAREKEYS_off(PL_strtab);
10897 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10898 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10900 PL_compiling = proto_perl->Icompiling;
10902 /* These two PVs will be free'd special way so must set them same way op.c does */
10903 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10904 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10906 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10907 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10909 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10910 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10911 if (PL_compiling.cop_hints_hash) {
10913 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10914 HINTS_REFCNT_UNLOCK;
10916 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10918 /* pseudo environmental stuff */
10919 PL_origargc = proto_perl->Iorigargc;
10920 PL_origargv = proto_perl->Iorigargv;
10922 param->stashes = newAV(); /* Setup array of objects to call clone on */
10924 /* Set tainting stuff before PerlIO_debug can possibly get called */
10925 PL_tainting = proto_perl->Itainting;
10926 PL_taint_warn = proto_perl->Itaint_warn;
10928 #ifdef PERLIO_LAYERS
10929 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10930 PerlIO_clone(aTHX_ proto_perl, param);
10933 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10934 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10935 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10936 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10937 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10938 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10941 PL_minus_c = proto_perl->Iminus_c;
10942 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10943 PL_localpatches = proto_perl->Ilocalpatches;
10944 PL_splitstr = proto_perl->Isplitstr;
10945 PL_preprocess = proto_perl->Ipreprocess;
10946 PL_minus_n = proto_perl->Iminus_n;
10947 PL_minus_p = proto_perl->Iminus_p;
10948 PL_minus_l = proto_perl->Iminus_l;
10949 PL_minus_a = proto_perl->Iminus_a;
10950 PL_minus_E = proto_perl->Iminus_E;
10951 PL_minus_F = proto_perl->Iminus_F;
10952 PL_doswitches = proto_perl->Idoswitches;
10953 PL_dowarn = proto_perl->Idowarn;
10954 PL_doextract = proto_perl->Idoextract;
10955 PL_sawampersand = proto_perl->Isawampersand;
10956 PL_unsafe = proto_perl->Iunsafe;
10957 PL_inplace = SAVEPV(proto_perl->Iinplace);
10958 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10959 PL_perldb = proto_perl->Iperldb;
10960 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10961 PL_exit_flags = proto_perl->Iexit_flags;
10963 /* magical thingies */
10964 /* XXX time(&PL_basetime) when asked for? */
10965 PL_basetime = proto_perl->Ibasetime;
10966 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10968 PL_maxsysfd = proto_perl->Imaxsysfd;
10969 PL_statusvalue = proto_perl->Istatusvalue;
10971 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10973 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10975 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10977 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10978 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10979 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10982 /* RE engine related */
10983 Zero(&PL_reg_state, 1, struct re_save_state);
10984 PL_reginterp_cnt = 0;
10985 PL_regmatch_slab = NULL;
10987 /* Clone the regex array */
10988 PL_regex_padav = newAV();
10990 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
10991 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
10993 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
10994 for(i = 1; i <= len; i++) {
10995 const SV * const regex = regexen[i];
10998 ? sv_dup_inc(regex, param)
11000 newSViv(PTR2IV(CALLREGDUPE(
11001 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11003 if (SvFLAGS(regex) & SVf_BREAK)
11004 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11005 av_push(PL_regex_padav, sv);
11008 PL_regex_pad = AvARRAY(PL_regex_padav);
11010 /* shortcuts to various I/O objects */
11011 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11012 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11013 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11014 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11015 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11016 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11018 /* shortcuts to regexp stuff */
11019 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11021 /* shortcuts to misc objects */
11022 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11024 /* shortcuts to debugging objects */
11025 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11026 PL_DBline = gv_dup(proto_perl->IDBline, param);
11027 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11028 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11029 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11030 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11031 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11032 PL_lineary = av_dup(proto_perl->Ilineary, param);
11033 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11035 /* symbol tables */
11036 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11037 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11038 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11039 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11040 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11042 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11043 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11044 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11045 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11046 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11047 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11048 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11049 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11051 PL_sub_generation = proto_perl->Isub_generation;
11053 /* funky return mechanisms */
11054 PL_forkprocess = proto_perl->Iforkprocess;
11056 /* subprocess state */
11057 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11059 /* internal state */
11060 PL_maxo = proto_perl->Imaxo;
11061 if (proto_perl->Iop_mask)
11062 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11065 /* PL_asserting = proto_perl->Iasserting; */
11067 /* current interpreter roots */
11068 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11070 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11072 PL_main_start = proto_perl->Imain_start;
11073 PL_eval_root = proto_perl->Ieval_root;
11074 PL_eval_start = proto_perl->Ieval_start;
11076 /* runtime control stuff */
11077 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11078 PL_copline = proto_perl->Icopline;
11080 PL_filemode = proto_perl->Ifilemode;
11081 PL_lastfd = proto_perl->Ilastfd;
11082 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11085 PL_gensym = proto_perl->Igensym;
11086 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11087 PL_laststatval = proto_perl->Ilaststatval;
11088 PL_laststype = proto_perl->Ilaststype;
11091 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11093 /* interpreter atexit processing */
11094 PL_exitlistlen = proto_perl->Iexitlistlen;
11095 if (PL_exitlistlen) {
11096 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11097 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11100 PL_exitlist = (PerlExitListEntry*)NULL;
11102 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11103 if (PL_my_cxt_size) {
11104 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11105 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11106 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11107 Newx(PL_my_cxt_keys, PL_my_cxt_size, char *);
11108 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11112 PL_my_cxt_list = (void**)NULL;
11113 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11114 PL_my_cxt_keys = (void**)NULL;
11117 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11118 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11119 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11121 PL_profiledata = NULL;
11122 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11123 /* PL_rsfp_filters entries have fake IoDIRP() */
11124 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11126 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11128 PAD_CLONE_VARS(proto_perl, param);
11130 #ifdef HAVE_INTERP_INTERN
11131 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11134 /* more statics moved here */
11135 PL_generation = proto_perl->Igeneration;
11136 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11138 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11139 PL_in_clean_all = proto_perl->Iin_clean_all;
11141 PL_uid = proto_perl->Iuid;
11142 PL_euid = proto_perl->Ieuid;
11143 PL_gid = proto_perl->Igid;
11144 PL_egid = proto_perl->Iegid;
11145 PL_nomemok = proto_perl->Inomemok;
11146 PL_an = proto_perl->Ian;
11147 PL_evalseq = proto_perl->Ievalseq;
11148 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11149 PL_origalen = proto_perl->Iorigalen;
11150 #ifdef PERL_USES_PL_PIDSTATUS
11151 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11153 PL_osname = SAVEPV(proto_perl->Iosname);
11154 PL_sighandlerp = proto_perl->Isighandlerp;
11156 PL_runops = proto_perl->Irunops;
11158 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11161 PL_cshlen = proto_perl->Icshlen;
11162 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11165 PL_parser = parser_dup(proto_perl->Iparser, param);
11167 PL_lex_state = proto_perl->Ilex_state;
11170 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11171 PL_curforce = proto_perl->Icurforce;
11173 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11174 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11175 PL_nexttoke = proto_perl->Inexttoke;
11178 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11179 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11180 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11181 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11182 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11183 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11184 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11185 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11186 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11187 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11189 PL_expect = proto_perl->Iexpect;
11191 PL_multi_end = proto_perl->Imulti_end;
11193 PL_error_count = proto_perl->Ierror_count;
11194 PL_subline = proto_perl->Isubline;
11195 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11197 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11198 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11199 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11200 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11201 PL_last_lop_op = proto_perl->Ilast_lop_op;
11202 PL_in_my = proto_perl->Iin_my;
11203 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11205 PL_cryptseen = proto_perl->Icryptseen;
11208 PL_hints = proto_perl->Ihints;
11210 PL_amagic_generation = proto_perl->Iamagic_generation;
11212 #ifdef USE_LOCALE_COLLATE
11213 PL_collation_ix = proto_perl->Icollation_ix;
11214 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11215 PL_collation_standard = proto_perl->Icollation_standard;
11216 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11217 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11218 #endif /* USE_LOCALE_COLLATE */
11220 #ifdef USE_LOCALE_NUMERIC
11221 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11222 PL_numeric_standard = proto_perl->Inumeric_standard;
11223 PL_numeric_local = proto_perl->Inumeric_local;
11224 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11225 #endif /* !USE_LOCALE_NUMERIC */
11227 /* utf8 character classes */
11228 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11229 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11230 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11231 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11232 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11233 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11234 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11235 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11236 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11237 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11238 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11239 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11240 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11241 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11242 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11243 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11244 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11245 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11246 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11247 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11249 /* Did the locale setup indicate UTF-8? */
11250 PL_utf8locale = proto_perl->Iutf8locale;
11251 /* Unicode features (see perlrun/-C) */
11252 PL_unicode = proto_perl->Iunicode;
11254 /* Pre-5.8 signals control */
11255 PL_signals = proto_perl->Isignals;
11257 /* times() ticks per second */
11258 PL_clocktick = proto_perl->Iclocktick;
11260 /* Recursion stopper for PerlIO_find_layer */
11261 PL_in_load_module = proto_perl->Iin_load_module;
11263 /* sort() routine */
11264 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11266 /* Not really needed/useful since the reenrant_retint is "volatile",
11267 * but do it for consistency's sake. */
11268 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11270 /* Hooks to shared SVs and locks. */
11271 PL_sharehook = proto_perl->Isharehook;
11272 PL_lockhook = proto_perl->Ilockhook;
11273 PL_unlockhook = proto_perl->Iunlockhook;
11274 PL_threadhook = proto_perl->Ithreadhook;
11276 PL_runops_std = proto_perl->Irunops_std;
11277 PL_runops_dbg = proto_perl->Irunops_dbg;
11279 #ifdef THREADS_HAVE_PIDS
11280 PL_ppid = proto_perl->Ippid;
11284 PL_last_swash_hv = NULL; /* reinits on demand */
11285 PL_last_swash_klen = 0;
11286 PL_last_swash_key[0]= '\0';
11287 PL_last_swash_tmps = (U8*)NULL;
11288 PL_last_swash_slen = 0;
11290 PL_glob_index = proto_perl->Iglob_index;
11291 PL_srand_called = proto_perl->Isrand_called;
11292 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11293 PL_bitcount = NULL; /* reinits on demand */
11295 if (proto_perl->Ipsig_pend) {
11296 Newxz(PL_psig_pend, SIG_SIZE, int);
11299 PL_psig_pend = (int*)NULL;
11302 if (proto_perl->Ipsig_ptr) {
11303 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11304 Newxz(PL_psig_name, SIG_SIZE, SV*);
11305 for (i = 1; i < SIG_SIZE; i++) {
11306 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11307 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11311 PL_psig_ptr = (SV**)NULL;
11312 PL_psig_name = (SV**)NULL;
11315 /* thrdvar.h stuff */
11317 if (flags & CLONEf_COPY_STACKS) {
11318 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11319 PL_tmps_ix = proto_perl->Ttmps_ix;
11320 PL_tmps_max = proto_perl->Ttmps_max;
11321 PL_tmps_floor = proto_perl->Ttmps_floor;
11322 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11324 while (i <= PL_tmps_ix) {
11325 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11329 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11330 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11331 Newxz(PL_markstack, i, I32);
11332 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11333 - proto_perl->Tmarkstack);
11334 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11335 - proto_perl->Tmarkstack);
11336 Copy(proto_perl->Tmarkstack, PL_markstack,
11337 PL_markstack_ptr - PL_markstack + 1, I32);
11339 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11340 * NOTE: unlike the others! */
11341 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11342 PL_scopestack_max = proto_perl->Tscopestack_max;
11343 Newxz(PL_scopestack, PL_scopestack_max, I32);
11344 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11346 /* NOTE: si_dup() looks at PL_markstack */
11347 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11349 /* PL_curstack = PL_curstackinfo->si_stack; */
11350 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11351 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11353 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11354 PL_stack_base = AvARRAY(PL_curstack);
11355 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11356 - proto_perl->Tstack_base);
11357 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11359 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11360 * NOTE: unlike the others! */
11361 PL_savestack_ix = proto_perl->Tsavestack_ix;
11362 PL_savestack_max = proto_perl->Tsavestack_max;
11363 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11364 PL_savestack = ss_dup(proto_perl, param);
11368 ENTER; /* perl_destruct() wants to LEAVE; */
11370 /* although we're not duplicating the tmps stack, we should still
11371 * add entries for any SVs on the tmps stack that got cloned by a
11372 * non-refcount means (eg a temp in @_); otherwise they will be
11375 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11376 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11377 proto_perl->Ttmps_stack[i]);
11378 if (nsv && !SvREFCNT(nsv)) {
11380 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11385 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11386 PL_top_env = &PL_start_env;
11388 PL_op = proto_perl->Top;
11391 PL_Xpv = (XPV*)NULL;
11392 PL_na = proto_perl->Tna;
11394 PL_statbuf = proto_perl->Tstatbuf;
11395 PL_statcache = proto_perl->Tstatcache;
11396 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11397 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11399 PL_timesbuf = proto_perl->Ttimesbuf;
11402 PL_tainted = proto_perl->Ttainted;
11403 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11404 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11405 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11406 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11407 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11408 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11409 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11410 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11411 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11413 PL_restartop = proto_perl->Trestartop;
11414 PL_in_eval = proto_perl->Tin_eval;
11415 PL_delaymagic = proto_perl->Tdelaymagic;
11416 PL_dirty = proto_perl->Tdirty;
11417 PL_localizing = proto_perl->Tlocalizing;
11419 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11420 PL_hv_fetch_ent_mh = NULL;
11421 PL_modcount = proto_perl->Tmodcount;
11422 PL_lastgotoprobe = NULL;
11423 PL_dumpindent = proto_perl->Tdumpindent;
11425 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11426 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11427 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11428 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11429 PL_efloatbuf = NULL; /* reinits on demand */
11430 PL_efloatsize = 0; /* reinits on demand */
11434 PL_screamfirst = NULL;
11435 PL_screamnext = NULL;
11436 PL_maxscream = -1; /* reinits on demand */
11437 PL_lastscream = NULL;
11439 PL_watchaddr = NULL;
11442 PL_regdummy = proto_perl->Tregdummy;
11443 PL_colorset = 0; /* reinits PL_colors[] */
11444 /*PL_colors[6] = {0,0,0,0,0,0};*/
11448 /* Pluggable optimizer */
11449 PL_peepp = proto_perl->Tpeepp;
11451 PL_stashcache = newHV();
11453 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11454 ptr_table_free(PL_ptr_table);
11455 PL_ptr_table = NULL;
11458 /* Call the ->CLONE method, if it exists, for each of the stashes
11459 identified by sv_dup() above.
11461 while(av_len(param->stashes) != -1) {
11462 HV* const stash = (HV*) av_shift(param->stashes);
11463 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11464 if (cloner && GvCV(cloner)) {
11469 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11471 call_sv((SV*)GvCV(cloner), G_DISCARD);
11477 SvREFCNT_dec(param->stashes);
11479 /* orphaned? eg threads->new inside BEGIN or use */
11480 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11481 SvREFCNT_inc_simple_void(PL_compcv);
11482 SAVEFREESV(PL_compcv);
11488 #endif /* USE_ITHREADS */
11491 =head1 Unicode Support
11493 =for apidoc sv_recode_to_utf8
11495 The encoding is assumed to be an Encode object, on entry the PV
11496 of the sv is assumed to be octets in that encoding, and the sv
11497 will be converted into Unicode (and UTF-8).
11499 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11500 is not a reference, nothing is done to the sv. If the encoding is not
11501 an C<Encode::XS> Encoding object, bad things will happen.
11502 (See F<lib/encoding.pm> and L<Encode>).
11504 The PV of the sv is returned.
11509 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11512 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11526 Passing sv_yes is wrong - it needs to be or'ed set of constants
11527 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11528 remove converted chars from source.
11530 Both will default the value - let them.
11532 XPUSHs(&PL_sv_yes);
11535 call_method("decode", G_SCALAR);
11539 s = SvPV_const(uni, len);
11540 if (s != SvPVX_const(sv)) {
11541 SvGROW(sv, len + 1);
11542 Move(s, SvPVX(sv), len + 1, char);
11543 SvCUR_set(sv, len);
11550 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11554 =for apidoc sv_cat_decode
11556 The encoding is assumed to be an Encode object, the PV of the ssv is
11557 assumed to be octets in that encoding and decoding the input starts
11558 from the position which (PV + *offset) pointed to. The dsv will be
11559 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11560 when the string tstr appears in decoding output or the input ends on
11561 the PV of the ssv. The value which the offset points will be modified
11562 to the last input position on the ssv.
11564 Returns TRUE if the terminator was found, else returns FALSE.
11569 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11570 SV *ssv, int *offset, char *tstr, int tlen)
11574 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11585 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11586 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11588 call_method("cat_decode", G_SCALAR);
11590 ret = SvTRUE(TOPs);
11591 *offset = SvIV(offsv);
11597 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11602 /* ---------------------------------------------------------------------
11604 * support functions for report_uninit()
11607 /* the maxiumum size of array or hash where we will scan looking
11608 * for the undefined element that triggered the warning */
11610 #define FUV_MAX_SEARCH_SIZE 1000
11612 /* Look for an entry in the hash whose value has the same SV as val;
11613 * If so, return a mortal copy of the key. */
11616 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11619 register HE **array;
11622 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11623 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11626 array = HvARRAY(hv);
11628 for (i=HvMAX(hv); i>0; i--) {
11629 register HE *entry;
11630 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11631 if (HeVAL(entry) != val)
11633 if ( HeVAL(entry) == &PL_sv_undef ||
11634 HeVAL(entry) == &PL_sv_placeholder)
11638 if (HeKLEN(entry) == HEf_SVKEY)
11639 return sv_mortalcopy(HeKEY_sv(entry));
11640 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11646 /* Look for an entry in the array whose value has the same SV as val;
11647 * If so, return the index, otherwise return -1. */
11650 S_find_array_subscript(pTHX_ AV *av, SV* val)
11653 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11654 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11657 if (val != &PL_sv_undef) {
11658 SV ** const svp = AvARRAY(av);
11661 for (i=AvFILLp(av); i>=0; i--)
11668 /* S_varname(): return the name of a variable, optionally with a subscript.
11669 * If gv is non-zero, use the name of that global, along with gvtype (one
11670 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11671 * targ. Depending on the value of the subscript_type flag, return:
11674 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11675 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11676 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11677 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11680 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11681 SV* keyname, I32 aindex, int subscript_type)
11684 SV * const name = sv_newmortal();
11687 buffer[0] = gvtype;
11690 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11692 gv_fullname4(name, gv, buffer, 0);
11694 if ((unsigned int)SvPVX(name)[1] <= 26) {
11696 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11698 /* Swap the 1 unprintable control character for the 2 byte pretty
11699 version - ie substr($name, 1, 1) = $buffer; */
11700 sv_insert(name, 1, 1, buffer, 2);
11705 CV * const cv = find_runcv(&unused);
11709 if (!cv || !CvPADLIST(cv))
11711 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11712 sv = *av_fetch(av, targ, FALSE);
11713 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11716 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11717 SV * const sv = newSV(0);
11718 *SvPVX(name) = '$';
11719 Perl_sv_catpvf(aTHX_ name, "{%s}",
11720 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11723 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11724 *SvPVX(name) = '$';
11725 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11727 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11728 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11735 =for apidoc find_uninit_var
11737 Find the name of the undefined variable (if any) that caused the operator o
11738 to issue a "Use of uninitialized value" warning.
11739 If match is true, only return a name if it's value matches uninit_sv.
11740 So roughly speaking, if a unary operator (such as OP_COS) generates a
11741 warning, then following the direct child of the op may yield an
11742 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11743 other hand, with OP_ADD there are two branches to follow, so we only print
11744 the variable name if we get an exact match.
11746 The name is returned as a mortal SV.
11748 Assumes that PL_op is the op that originally triggered the error, and that
11749 PL_comppad/PL_curpad points to the currently executing pad.
11755 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11763 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11764 uninit_sv == &PL_sv_placeholder)))
11767 switch (obase->op_type) {
11774 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11775 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11778 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11780 if (pad) { /* @lex, %lex */
11781 sv = PAD_SVl(obase->op_targ);
11785 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11786 /* @global, %global */
11787 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11790 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11792 else /* @{expr}, %{expr} */
11793 return find_uninit_var(cUNOPx(obase)->op_first,
11797 /* attempt to find a match within the aggregate */
11799 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11801 subscript_type = FUV_SUBSCRIPT_HASH;
11804 index = find_array_subscript((AV*)sv, uninit_sv);
11806 subscript_type = FUV_SUBSCRIPT_ARRAY;
11809 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11812 return varname(gv, hash ? '%' : '@', obase->op_targ,
11813 keysv, index, subscript_type);
11817 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11819 return varname(NULL, '$', obase->op_targ,
11820 NULL, 0, FUV_SUBSCRIPT_NONE);
11823 gv = cGVOPx_gv(obase);
11824 if (!gv || (match && GvSV(gv) != uninit_sv))
11826 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11829 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11832 av = (AV*)PAD_SV(obase->op_targ);
11833 if (!av || SvRMAGICAL(av))
11835 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11836 if (!svp || *svp != uninit_sv)
11839 return varname(NULL, '$', obase->op_targ,
11840 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11843 gv = cGVOPx_gv(obase);
11849 if (!av || SvRMAGICAL(av))
11851 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11852 if (!svp || *svp != uninit_sv)
11855 return varname(gv, '$', 0,
11856 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11861 o = cUNOPx(obase)->op_first;
11862 if (!o || o->op_type != OP_NULL ||
11863 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11865 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11869 if (PL_op == obase)
11870 /* $a[uninit_expr] or $h{uninit_expr} */
11871 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11874 o = cBINOPx(obase)->op_first;
11875 kid = cBINOPx(obase)->op_last;
11877 /* get the av or hv, and optionally the gv */
11879 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11880 sv = PAD_SV(o->op_targ);
11882 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11883 && cUNOPo->op_first->op_type == OP_GV)
11885 gv = cGVOPx_gv(cUNOPo->op_first);
11888 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11893 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11894 /* index is constant */
11898 if (obase->op_type == OP_HELEM) {
11899 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11900 if (!he || HeVAL(he) != uninit_sv)
11904 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11905 if (!svp || *svp != uninit_sv)
11909 if (obase->op_type == OP_HELEM)
11910 return varname(gv, '%', o->op_targ,
11911 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11913 return varname(gv, '@', o->op_targ, NULL,
11914 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11917 /* index is an expression;
11918 * attempt to find a match within the aggregate */
11919 if (obase->op_type == OP_HELEM) {
11920 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11922 return varname(gv, '%', o->op_targ,
11923 keysv, 0, FUV_SUBSCRIPT_HASH);
11926 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11928 return varname(gv, '@', o->op_targ,
11929 NULL, index, FUV_SUBSCRIPT_ARRAY);
11934 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11936 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11941 /* only examine RHS */
11942 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11945 o = cUNOPx(obase)->op_first;
11946 if (o->op_type == OP_PUSHMARK)
11949 if (!o->op_sibling) {
11950 /* one-arg version of open is highly magical */
11952 if (o->op_type == OP_GV) { /* open FOO; */
11954 if (match && GvSV(gv) != uninit_sv)
11956 return varname(gv, '$', 0,
11957 NULL, 0, FUV_SUBSCRIPT_NONE);
11959 /* other possibilities not handled are:
11960 * open $x; or open my $x; should return '${*$x}'
11961 * open expr; should return '$'.expr ideally
11967 /* ops where $_ may be an implicit arg */
11971 if ( !(obase->op_flags & OPf_STACKED)) {
11972 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11973 ? PAD_SVl(obase->op_targ)
11976 sv = sv_newmortal();
11977 sv_setpvn(sv, "$_", 2);
11985 /* skip filehandle as it can't produce 'undef' warning */
11986 o = cUNOPx(obase)->op_first;
11987 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
11988 o = o->op_sibling->op_sibling;
11995 match = 1; /* XS or custom code could trigger random warnings */
12000 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12001 return sv_2mortal(newSVpvs("${$/}"));
12006 if (!(obase->op_flags & OPf_KIDS))
12008 o = cUNOPx(obase)->op_first;
12014 /* if all except one arg are constant, or have no side-effects,
12015 * or are optimized away, then it's unambiguous */
12017 for (kid=o; kid; kid = kid->op_sibling) {
12019 const OPCODE type = kid->op_type;
12020 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12021 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12022 || (type == OP_PUSHMARK)
12026 if (o2) { /* more than one found */
12033 return find_uninit_var(o2, uninit_sv, match);
12035 /* scan all args */
12037 sv = find_uninit_var(o, uninit_sv, 1);
12049 =for apidoc report_uninit
12051 Print appropriate "Use of uninitialized variable" warning
12057 Perl_report_uninit(pTHX_ SV* uninit_sv)
12061 SV* varname = NULL;
12063 varname = find_uninit_var(PL_op, uninit_sv,0);
12065 sv_insert(varname, 0, 0, " ", 1);
12067 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12068 varname ? SvPV_nolen_const(varname) : "",
12069 " in ", OP_DESC(PL_op));
12072 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12078 * c-indentation-style: bsd
12079 * c-basic-offset: 4
12080 * indent-tabs-mode: t
12083 * ex: set ts=8 sts=4 sw=4 noet: