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, NONV, 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, NONV, 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
1324 && !isGV_with_GP(sv))
1328 if (new_type == SVt_PVIO)
1329 IoPAGE_LEN(sv) = 60;
1330 if (old_type < SVt_RV)
1334 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1335 (unsigned long)new_type);
1338 if (old_type_details->arena) {
1339 /* If there was an old body, then we need to free it.
1340 Note that there is an assumption that all bodies of types that
1341 can be upgraded came from arenas. Only the more complex non-
1342 upgradable types are allowed to be directly malloc()ed. */
1344 my_safefree(old_body);
1346 del_body((void*)((char*)old_body + old_type_details->offset),
1347 &PL_body_roots[old_type]);
1353 =for apidoc sv_backoff
1355 Remove any string offset. You should normally use the C<SvOOK_off> macro
1362 Perl_sv_backoff(pTHX_ register SV *sv)
1364 PERL_UNUSED_CONTEXT;
1366 assert(SvTYPE(sv) != SVt_PVHV);
1367 assert(SvTYPE(sv) != SVt_PVAV);
1369 const char * const s = SvPVX_const(sv);
1370 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1371 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1373 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1375 SvFLAGS(sv) &= ~SVf_OOK;
1382 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1383 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1384 Use the C<SvGROW> wrapper instead.
1390 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1394 if (PL_madskills && newlen >= 0x100000) {
1395 PerlIO_printf(Perl_debug_log,
1396 "Allocation too large: %"UVxf"\n", (UV)newlen);
1398 #ifdef HAS_64K_LIMIT
1399 if (newlen >= 0x10000) {
1400 PerlIO_printf(Perl_debug_log,
1401 "Allocation too large: %"UVxf"\n", (UV)newlen);
1404 #endif /* HAS_64K_LIMIT */
1407 if (SvTYPE(sv) < SVt_PV) {
1408 sv_upgrade(sv, SVt_PV);
1409 s = SvPVX_mutable(sv);
1411 else if (SvOOK(sv)) { /* pv is offset? */
1413 s = SvPVX_mutable(sv);
1414 if (newlen > SvLEN(sv))
1415 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1416 #ifdef HAS_64K_LIMIT
1417 if (newlen >= 0x10000)
1422 s = SvPVX_mutable(sv);
1424 if (newlen > SvLEN(sv)) { /* need more room? */
1425 newlen = PERL_STRLEN_ROUNDUP(newlen);
1426 if (SvLEN(sv) && s) {
1428 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1434 s = (char*)saferealloc(s, newlen);
1437 s = (char*)safemalloc(newlen);
1438 if (SvPVX_const(sv) && SvCUR(sv)) {
1439 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1443 SvLEN_set(sv, newlen);
1449 =for apidoc sv_setiv
1451 Copies an integer into the given SV, upgrading first if necessary.
1452 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1458 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1461 SV_CHECK_THINKFIRST_COW_DROP(sv);
1462 switch (SvTYPE(sv)) {
1464 sv_upgrade(sv, SVt_IV);
1467 sv_upgrade(sv, SVt_PVNV);
1471 sv_upgrade(sv, SVt_PVIV);
1480 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1484 (void)SvIOK_only(sv); /* validate number */
1490 =for apidoc sv_setiv_mg
1492 Like C<sv_setiv>, but also handles 'set' magic.
1498 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1505 =for apidoc sv_setuv
1507 Copies an unsigned integer into the given SV, upgrading first if necessary.
1508 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1514 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1516 /* With these two if statements:
1517 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1520 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1522 If you wish to remove them, please benchmark to see what the effect is
1524 if (u <= (UV)IV_MAX) {
1525 sv_setiv(sv, (IV)u);
1534 =for apidoc sv_setuv_mg
1536 Like C<sv_setuv>, but also handles 'set' magic.
1542 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1549 =for apidoc sv_setnv
1551 Copies a double into the given SV, upgrading first if necessary.
1552 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1558 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1561 SV_CHECK_THINKFIRST_COW_DROP(sv);
1562 switch (SvTYPE(sv)) {
1565 sv_upgrade(sv, SVt_NV);
1570 sv_upgrade(sv, SVt_PVNV);
1579 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1584 (void)SvNOK_only(sv); /* validate number */
1589 =for apidoc sv_setnv_mg
1591 Like C<sv_setnv>, but also handles 'set' magic.
1597 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1603 /* Print an "isn't numeric" warning, using a cleaned-up,
1604 * printable version of the offending string
1608 S_not_a_number(pTHX_ SV *sv)
1616 dsv = sv_2mortal(newSVpvs(""));
1617 pv = sv_uni_display(dsv, sv, 10, 0);
1620 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1621 /* each *s can expand to 4 chars + "...\0",
1622 i.e. need room for 8 chars */
1624 const char *s = SvPVX_const(sv);
1625 const char * const end = s + SvCUR(sv);
1626 for ( ; s < end && d < limit; s++ ) {
1628 if (ch & 128 && !isPRINT_LC(ch)) {
1637 else if (ch == '\r') {
1641 else if (ch == '\f') {
1645 else if (ch == '\\') {
1649 else if (ch == '\0') {
1653 else if (isPRINT_LC(ch))
1670 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1671 "Argument \"%s\" isn't numeric in %s", pv,
1674 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1675 "Argument \"%s\" isn't numeric", pv);
1679 =for apidoc looks_like_number
1681 Test if the content of an SV looks like a number (or is a number).
1682 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1683 non-numeric warning), even if your atof() doesn't grok them.
1689 Perl_looks_like_number(pTHX_ SV *sv)
1691 register const char *sbegin;
1695 sbegin = SvPVX_const(sv);
1698 else if (SvPOKp(sv))
1699 sbegin = SvPV_const(sv, len);
1701 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1702 return grok_number(sbegin, len, NULL);
1706 S_glob_2number(pTHX_ GV * const gv)
1708 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1709 SV *const buffer = sv_newmortal();
1711 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1714 gv_efullname3(buffer, gv, "*");
1715 SvFLAGS(gv) |= wasfake;
1717 /* We know that all GVs stringify to something that is not-a-number,
1718 so no need to test that. */
1719 if (ckWARN(WARN_NUMERIC))
1720 not_a_number(buffer);
1721 /* We just want something true to return, so that S_sv_2iuv_common
1722 can tail call us and return true. */
1727 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1729 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1730 SV *const buffer = sv_newmortal();
1732 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1735 gv_efullname3(buffer, gv, "*");
1736 SvFLAGS(gv) |= wasfake;
1738 assert(SvPOK(buffer));
1740 *len = SvCUR(buffer);
1742 return SvPVX(buffer);
1745 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1746 until proven guilty, assume that things are not that bad... */
1751 As 64 bit platforms often have an NV that doesn't preserve all bits of
1752 an IV (an assumption perl has been based on to date) it becomes necessary
1753 to remove the assumption that the NV always carries enough precision to
1754 recreate the IV whenever needed, and that the NV is the canonical form.
1755 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1756 precision as a side effect of conversion (which would lead to insanity
1757 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1758 1) to distinguish between IV/UV/NV slots that have cached a valid
1759 conversion where precision was lost and IV/UV/NV slots that have a
1760 valid conversion which has lost no precision
1761 2) to ensure that if a numeric conversion to one form is requested that
1762 would lose precision, the precise conversion (or differently
1763 imprecise conversion) is also performed and cached, to prevent
1764 requests for different numeric formats on the same SV causing
1765 lossy conversion chains. (lossless conversion chains are perfectly
1770 SvIOKp is true if the IV slot contains a valid value
1771 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1772 SvNOKp is true if the NV slot contains a valid value
1773 SvNOK is true only if the NV value is accurate
1776 while converting from PV to NV, check to see if converting that NV to an
1777 IV(or UV) would lose accuracy over a direct conversion from PV to
1778 IV(or UV). If it would, cache both conversions, return NV, but mark
1779 SV as IOK NOKp (ie not NOK).
1781 While converting from PV to IV, check to see if converting that IV to an
1782 NV would lose accuracy over a direct conversion from PV to NV. If it
1783 would, cache both conversions, flag similarly.
1785 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1786 correctly because if IV & NV were set NV *always* overruled.
1787 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1788 changes - now IV and NV together means that the two are interchangeable:
1789 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1791 The benefit of this is that operations such as pp_add know that if
1792 SvIOK is true for both left and right operands, then integer addition
1793 can be used instead of floating point (for cases where the result won't
1794 overflow). Before, floating point was always used, which could lead to
1795 loss of precision compared with integer addition.
1797 * making IV and NV equal status should make maths accurate on 64 bit
1799 * may speed up maths somewhat if pp_add and friends start to use
1800 integers when possible instead of fp. (Hopefully the overhead in
1801 looking for SvIOK and checking for overflow will not outweigh the
1802 fp to integer speedup)
1803 * will slow down integer operations (callers of SvIV) on "inaccurate"
1804 values, as the change from SvIOK to SvIOKp will cause a call into
1805 sv_2iv each time rather than a macro access direct to the IV slot
1806 * should speed up number->string conversion on integers as IV is
1807 favoured when IV and NV are equally accurate
1809 ####################################################################
1810 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1811 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1812 On the other hand, SvUOK is true iff UV.
1813 ####################################################################
1815 Your mileage will vary depending your CPU's relative fp to integer
1819 #ifndef NV_PRESERVES_UV
1820 # define IS_NUMBER_UNDERFLOW_IV 1
1821 # define IS_NUMBER_UNDERFLOW_UV 2
1822 # define IS_NUMBER_IV_AND_UV 2
1823 # define IS_NUMBER_OVERFLOW_IV 4
1824 # define IS_NUMBER_OVERFLOW_UV 5
1826 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1828 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1830 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1833 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1834 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));
1835 if (SvNVX(sv) < (NV)IV_MIN) {
1836 (void)SvIOKp_on(sv);
1838 SvIV_set(sv, IV_MIN);
1839 return IS_NUMBER_UNDERFLOW_IV;
1841 if (SvNVX(sv) > (NV)UV_MAX) {
1842 (void)SvIOKp_on(sv);
1845 SvUV_set(sv, UV_MAX);
1846 return IS_NUMBER_OVERFLOW_UV;
1848 (void)SvIOKp_on(sv);
1850 /* Can't use strtol etc to convert this string. (See truth table in
1852 if (SvNVX(sv) <= (UV)IV_MAX) {
1853 SvIV_set(sv, I_V(SvNVX(sv)));
1854 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1855 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1857 /* Integer is imprecise. NOK, IOKp */
1859 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1862 SvUV_set(sv, U_V(SvNVX(sv)));
1863 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1864 if (SvUVX(sv) == UV_MAX) {
1865 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1866 possibly be preserved by NV. Hence, it must be overflow.
1868 return IS_NUMBER_OVERFLOW_UV;
1870 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1872 /* Integer is imprecise. NOK, IOKp */
1874 return IS_NUMBER_OVERFLOW_IV;
1876 #endif /* !NV_PRESERVES_UV*/
1879 S_sv_2iuv_common(pTHX_ SV *sv) {
1882 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1883 * without also getting a cached IV/UV from it at the same time
1884 * (ie PV->NV conversion should detect loss of accuracy and cache
1885 * IV or UV at same time to avoid this. */
1886 /* IV-over-UV optimisation - choose to cache IV if possible */
1888 if (SvTYPE(sv) == SVt_NV)
1889 sv_upgrade(sv, SVt_PVNV);
1891 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1892 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1893 certainly cast into the IV range at IV_MAX, whereas the correct
1894 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1896 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1897 if (Perl_isnan(SvNVX(sv))) {
1903 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1904 SvIV_set(sv, I_V(SvNVX(sv)));
1905 if (SvNVX(sv) == (NV) SvIVX(sv)
1906 #ifndef NV_PRESERVES_UV
1907 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1908 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1909 /* Don't flag it as "accurately an integer" if the number
1910 came from a (by definition imprecise) NV operation, and
1911 we're outside the range of NV integer precision */
1914 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1915 DEBUG_c(PerlIO_printf(Perl_debug_log,
1916 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1922 /* IV not precise. No need to convert from PV, as NV
1923 conversion would already have cached IV if it detected
1924 that PV->IV would be better than PV->NV->IV
1925 flags already correct - don't set public IOK. */
1926 DEBUG_c(PerlIO_printf(Perl_debug_log,
1927 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1932 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1933 but the cast (NV)IV_MIN rounds to a the value less (more
1934 negative) than IV_MIN which happens to be equal to SvNVX ??
1935 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1936 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1937 (NV)UVX == NVX are both true, but the values differ. :-(
1938 Hopefully for 2s complement IV_MIN is something like
1939 0x8000000000000000 which will be exact. NWC */
1942 SvUV_set(sv, U_V(SvNVX(sv)));
1944 (SvNVX(sv) == (NV) SvUVX(sv))
1945 #ifndef NV_PRESERVES_UV
1946 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1947 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1948 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1949 /* Don't flag it as "accurately an integer" if the number
1950 came from a (by definition imprecise) NV operation, and
1951 we're outside the range of NV integer precision */
1956 DEBUG_c(PerlIO_printf(Perl_debug_log,
1957 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1963 else if (SvPOKp(sv) && SvLEN(sv)) {
1965 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1966 /* We want to avoid a possible problem when we cache an IV/ a UV which
1967 may be later translated to an NV, and the resulting NV is not
1968 the same as the direct translation of the initial string
1969 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1970 be careful to ensure that the value with the .456 is around if the
1971 NV value is requested in the future).
1973 This means that if we cache such an IV/a UV, we need to cache the
1974 NV as well. Moreover, we trade speed for space, and do not
1975 cache the NV if we are sure it's not needed.
1978 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1979 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1980 == IS_NUMBER_IN_UV) {
1981 /* It's definitely an integer, only upgrade to PVIV */
1982 if (SvTYPE(sv) < SVt_PVIV)
1983 sv_upgrade(sv, SVt_PVIV);
1985 } else if (SvTYPE(sv) < SVt_PVNV)
1986 sv_upgrade(sv, SVt_PVNV);
1988 /* If NVs preserve UVs then we only use the UV value if we know that
1989 we aren't going to call atof() below. If NVs don't preserve UVs
1990 then the value returned may have more precision than atof() will
1991 return, even though value isn't perfectly accurate. */
1992 if ((numtype & (IS_NUMBER_IN_UV
1993 #ifdef NV_PRESERVES_UV
1996 )) == IS_NUMBER_IN_UV) {
1997 /* This won't turn off the public IOK flag if it was set above */
1998 (void)SvIOKp_on(sv);
2000 if (!(numtype & IS_NUMBER_NEG)) {
2002 if (value <= (UV)IV_MAX) {
2003 SvIV_set(sv, (IV)value);
2005 /* it didn't overflow, and it was positive. */
2006 SvUV_set(sv, value);
2010 /* 2s complement assumption */
2011 if (value <= (UV)IV_MIN) {
2012 SvIV_set(sv, -(IV)value);
2014 /* Too negative for an IV. This is a double upgrade, but
2015 I'm assuming it will be rare. */
2016 if (SvTYPE(sv) < SVt_PVNV)
2017 sv_upgrade(sv, SVt_PVNV);
2021 SvNV_set(sv, -(NV)value);
2022 SvIV_set(sv, IV_MIN);
2026 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2027 will be in the previous block to set the IV slot, and the next
2028 block to set the NV slot. So no else here. */
2030 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2031 != IS_NUMBER_IN_UV) {
2032 /* It wasn't an (integer that doesn't overflow the UV). */
2033 SvNV_set(sv, Atof(SvPVX_const(sv)));
2035 if (! numtype && ckWARN(WARN_NUMERIC))
2038 #if defined(USE_LONG_DOUBLE)
2039 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2040 PTR2UV(sv), SvNVX(sv)));
2042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2043 PTR2UV(sv), SvNVX(sv)));
2046 #ifdef NV_PRESERVES_UV
2047 (void)SvIOKp_on(sv);
2049 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2050 SvIV_set(sv, I_V(SvNVX(sv)));
2051 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2054 NOOP; /* Integer is imprecise. NOK, IOKp */
2056 /* UV will not work better than IV */
2058 if (SvNVX(sv) > (NV)UV_MAX) {
2060 /* Integer is inaccurate. NOK, IOKp, is UV */
2061 SvUV_set(sv, UV_MAX);
2063 SvUV_set(sv, U_V(SvNVX(sv)));
2064 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2065 NV preservse UV so can do correct comparison. */
2066 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2069 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2074 #else /* NV_PRESERVES_UV */
2075 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2076 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2077 /* The IV/UV slot will have been set from value returned by
2078 grok_number above. The NV slot has just been set using
2081 assert (SvIOKp(sv));
2083 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2084 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2085 /* Small enough to preserve all bits. */
2086 (void)SvIOKp_on(sv);
2088 SvIV_set(sv, I_V(SvNVX(sv)));
2089 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2091 /* Assumption: first non-preserved integer is < IV_MAX,
2092 this NV is in the preserved range, therefore: */
2093 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2095 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);
2099 0 0 already failed to read UV.
2100 0 1 already failed to read UV.
2101 1 0 you won't get here in this case. IV/UV
2102 slot set, public IOK, Atof() unneeded.
2103 1 1 already read UV.
2104 so there's no point in sv_2iuv_non_preserve() attempting
2105 to use atol, strtol, strtoul etc. */
2106 sv_2iuv_non_preserve (sv, numtype);
2109 #endif /* NV_PRESERVES_UV */
2113 if (isGV_with_GP(sv))
2114 return glob_2number((GV *)sv);
2116 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2117 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2120 if (SvTYPE(sv) < SVt_IV)
2121 /* Typically the caller expects that sv_any is not NULL now. */
2122 sv_upgrade(sv, SVt_IV);
2123 /* Return 0 from the caller. */
2130 =for apidoc sv_2iv_flags
2132 Return the integer value of an SV, doing any necessary string
2133 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2134 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2140 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2145 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2146 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2147 cache IVs just in case. In practice it seems that they never
2148 actually anywhere accessible by user Perl code, let alone get used
2149 in anything other than a string context. */
2150 if (flags & SV_GMAGIC)
2155 return I_V(SvNVX(sv));
2157 if (SvPOKp(sv) && SvLEN(sv)) {
2160 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2162 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2163 == IS_NUMBER_IN_UV) {
2164 /* It's definitely an integer */
2165 if (numtype & IS_NUMBER_NEG) {
2166 if (value < (UV)IV_MIN)
2169 if (value < (UV)IV_MAX)
2174 if (ckWARN(WARN_NUMERIC))
2177 return I_V(Atof(SvPVX_const(sv)));
2182 assert(SvTYPE(sv) >= SVt_PVMG);
2183 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2184 } else if (SvTHINKFIRST(sv)) {
2188 SV * const tmpstr=AMG_CALLun(sv,numer);
2189 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2190 return SvIV(tmpstr);
2193 return PTR2IV(SvRV(sv));
2196 sv_force_normal_flags(sv, 0);
2198 if (SvREADONLY(sv) && !SvOK(sv)) {
2199 if (ckWARN(WARN_UNINITIALIZED))
2205 if (S_sv_2iuv_common(aTHX_ sv))
2208 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2209 PTR2UV(sv),SvIVX(sv)));
2210 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2214 =for apidoc sv_2uv_flags
2216 Return the unsigned integer value of an SV, doing any necessary string
2217 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2218 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2224 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2229 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2230 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2231 cache IVs just in case. */
2232 if (flags & SV_GMAGIC)
2237 return U_V(SvNVX(sv));
2238 if (SvPOKp(sv) && SvLEN(sv)) {
2241 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2243 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2244 == IS_NUMBER_IN_UV) {
2245 /* It's definitely an integer */
2246 if (!(numtype & IS_NUMBER_NEG))
2250 if (ckWARN(WARN_NUMERIC))
2253 return U_V(Atof(SvPVX_const(sv)));
2258 assert(SvTYPE(sv) >= SVt_PVMG);
2259 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2260 } else if (SvTHINKFIRST(sv)) {
2264 SV *const tmpstr = AMG_CALLun(sv,numer);
2265 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2266 return SvUV(tmpstr);
2269 return PTR2UV(SvRV(sv));
2272 sv_force_normal_flags(sv, 0);
2274 if (SvREADONLY(sv) && !SvOK(sv)) {
2275 if (ckWARN(WARN_UNINITIALIZED))
2281 if (S_sv_2iuv_common(aTHX_ sv))
2285 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2286 PTR2UV(sv),SvUVX(sv)));
2287 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2293 Return the num value of an SV, doing any necessary string or integer
2294 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2301 Perl_sv_2nv(pTHX_ register SV *sv)
2306 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2307 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2308 cache IVs just in case. */
2312 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2313 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2314 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2316 return Atof(SvPVX_const(sv));
2320 return (NV)SvUVX(sv);
2322 return (NV)SvIVX(sv);
2327 assert(SvTYPE(sv) >= SVt_PVMG);
2328 /* This falls through to the report_uninit near the end of the
2330 } else if (SvTHINKFIRST(sv)) {
2334 SV *const tmpstr = AMG_CALLun(sv,numer);
2335 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2336 return SvNV(tmpstr);
2339 return PTR2NV(SvRV(sv));
2342 sv_force_normal_flags(sv, 0);
2344 if (SvREADONLY(sv) && !SvOK(sv)) {
2345 if (ckWARN(WARN_UNINITIALIZED))
2350 if (SvTYPE(sv) < SVt_NV) {
2351 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2352 sv_upgrade(sv, SVt_NV);
2353 #ifdef USE_LONG_DOUBLE
2355 STORE_NUMERIC_LOCAL_SET_STANDARD();
2356 PerlIO_printf(Perl_debug_log,
2357 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2358 PTR2UV(sv), SvNVX(sv));
2359 RESTORE_NUMERIC_LOCAL();
2363 STORE_NUMERIC_LOCAL_SET_STANDARD();
2364 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2365 PTR2UV(sv), SvNVX(sv));
2366 RESTORE_NUMERIC_LOCAL();
2370 else if (SvTYPE(sv) < SVt_PVNV)
2371 sv_upgrade(sv, SVt_PVNV);
2376 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2377 #ifdef NV_PRESERVES_UV
2380 /* Only set the public NV OK flag if this NV preserves the IV */
2381 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2382 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2383 : (SvIVX(sv) == I_V(SvNVX(sv))))
2389 else if (SvPOKp(sv) && SvLEN(sv)) {
2391 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2392 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2394 #ifdef NV_PRESERVES_UV
2395 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2396 == IS_NUMBER_IN_UV) {
2397 /* It's definitely an integer */
2398 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2400 SvNV_set(sv, Atof(SvPVX_const(sv)));
2403 SvNV_set(sv, Atof(SvPVX_const(sv)));
2404 /* Only set the public NV OK flag if this NV preserves the value in
2405 the PV at least as well as an IV/UV would.
2406 Not sure how to do this 100% reliably. */
2407 /* if that shift count is out of range then Configure's test is
2408 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2410 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2411 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2412 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2413 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2414 /* Can't use strtol etc to convert this string, so don't try.
2415 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2418 /* value has been set. It may not be precise. */
2419 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2420 /* 2s complement assumption for (UV)IV_MIN */
2421 SvNOK_on(sv); /* Integer is too negative. */
2426 if (numtype & IS_NUMBER_NEG) {
2427 SvIV_set(sv, -(IV)value);
2428 } else if (value <= (UV)IV_MAX) {
2429 SvIV_set(sv, (IV)value);
2431 SvUV_set(sv, value);
2435 if (numtype & IS_NUMBER_NOT_INT) {
2436 /* I believe that even if the original PV had decimals,
2437 they are lost beyond the limit of the FP precision.
2438 However, neither is canonical, so both only get p
2439 flags. NWC, 2000/11/25 */
2440 /* Both already have p flags, so do nothing */
2442 const NV nv = SvNVX(sv);
2443 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2444 if (SvIVX(sv) == I_V(nv)) {
2447 /* It had no "." so it must be integer. */
2451 /* between IV_MAX and NV(UV_MAX).
2452 Could be slightly > UV_MAX */
2454 if (numtype & IS_NUMBER_NOT_INT) {
2455 /* UV and NV both imprecise. */
2457 const UV nv_as_uv = U_V(nv);
2459 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2468 #endif /* NV_PRESERVES_UV */
2471 if (isGV_with_GP(sv)) {
2472 glob_2number((GV *)sv);
2476 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2478 assert (SvTYPE(sv) >= SVt_NV);
2479 /* Typically the caller expects that sv_any is not NULL now. */
2480 /* XXX Ilya implies that this is a bug in callers that assume this
2481 and ideally should be fixed. */
2484 #if defined(USE_LONG_DOUBLE)
2486 STORE_NUMERIC_LOCAL_SET_STANDARD();
2487 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2488 PTR2UV(sv), SvNVX(sv));
2489 RESTORE_NUMERIC_LOCAL();
2493 STORE_NUMERIC_LOCAL_SET_STANDARD();
2494 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2495 PTR2UV(sv), SvNVX(sv));
2496 RESTORE_NUMERIC_LOCAL();
2502 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2503 * UV as a string towards the end of buf, and return pointers to start and
2506 * We assume that buf is at least TYPE_CHARS(UV) long.
2510 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2512 char *ptr = buf + TYPE_CHARS(UV);
2513 char * const ebuf = ptr;
2526 *--ptr = '0' + (char)(uv % 10);
2535 =for apidoc sv_2pv_flags
2537 Returns a pointer to the string value of an SV, and sets *lp to its length.
2538 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2540 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2541 usually end up here too.
2547 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2557 if (SvGMAGICAL(sv)) {
2558 if (flags & SV_GMAGIC)
2563 if (flags & SV_MUTABLE_RETURN)
2564 return SvPVX_mutable(sv);
2565 if (flags & SV_CONST_RETURN)
2566 return (char *)SvPVX_const(sv);
2569 if (SvIOKp(sv) || SvNOKp(sv)) {
2570 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2575 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2576 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2578 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2585 #ifdef FIXNEGATIVEZERO
2586 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2592 SvUPGRADE(sv, SVt_PV);
2595 s = SvGROW_mutable(sv, len + 1);
2598 return (char*)memcpy(s, tbuf, len + 1);
2604 assert(SvTYPE(sv) >= SVt_PVMG);
2605 /* This falls through to the report_uninit near the end of the
2607 } else if (SvTHINKFIRST(sv)) {
2611 SV *const tmpstr = AMG_CALLun(sv,string);
2612 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2614 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2618 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2619 if (flags & SV_CONST_RETURN) {
2620 pv = (char *) SvPVX_const(tmpstr);
2622 pv = (flags & SV_MUTABLE_RETURN)
2623 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2626 *lp = SvCUR(tmpstr);
2628 pv = sv_2pv_flags(tmpstr, lp, flags);
2642 const SV *const referent = (SV*)SvRV(sv);
2646 retval = buffer = savepvn("NULLREF", len);
2647 } else if (SvTYPE(referent) == SVt_PVMG
2648 && ((SvFLAGS(referent) &
2649 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2650 == (SVs_OBJECT|SVs_SMG))
2651 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2656 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2661 PL_reginterp_cnt += haseval;
2664 const char *const typestr = sv_reftype(referent, 0);
2665 const STRLEN typelen = strlen(typestr);
2666 UV addr = PTR2UV(referent);
2667 const char *stashname = NULL;
2668 STRLEN stashnamelen = 0; /* hush, gcc */
2669 const char *buffer_end;
2671 if (SvOBJECT(referent)) {
2672 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2675 stashname = HEK_KEY(name);
2676 stashnamelen = HEK_LEN(name);
2678 if (HEK_UTF8(name)) {
2684 stashname = "__ANON__";
2687 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2688 + 2 * sizeof(UV) + 2 /* )\0 */;
2690 len = typelen + 3 /* (0x */
2691 + 2 * sizeof(UV) + 2 /* )\0 */;
2694 Newx(buffer, len, char);
2695 buffer_end = retval = buffer + len;
2697 /* Working backwards */
2701 *--retval = PL_hexdigit[addr & 15];
2702 } while (addr >>= 4);
2708 memcpy(retval, typestr, typelen);
2712 retval -= stashnamelen;
2713 memcpy(retval, stashname, stashnamelen);
2715 /* retval may not neccesarily have reached the start of the
2717 assert (retval >= buffer);
2719 len = buffer_end - retval - 1; /* -1 for that \0 */
2727 if (SvREADONLY(sv) && !SvOK(sv)) {
2728 if (ckWARN(WARN_UNINITIALIZED))
2735 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2736 /* I'm assuming that if both IV and NV are equally valid then
2737 converting the IV is going to be more efficient */
2738 const U32 isUIOK = SvIsUV(sv);
2739 char buf[TYPE_CHARS(UV)];
2742 if (SvTYPE(sv) < SVt_PVIV)
2743 sv_upgrade(sv, SVt_PVIV);
2744 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2745 /* inlined from sv_setpvn */
2746 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2747 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2748 SvCUR_set(sv, ebuf - ptr);
2752 else if (SvNOKp(sv)) {
2753 const int olderrno = errno;
2754 if (SvTYPE(sv) < SVt_PVNV)
2755 sv_upgrade(sv, SVt_PVNV);
2756 /* The +20 is pure guesswork. Configure test needed. --jhi */
2757 s = SvGROW_mutable(sv, NV_DIG + 20);
2758 /* some Xenix systems wipe out errno here */
2760 if (SvNVX(sv) == 0.0)
2761 my_strlcpy(s, "0", SvLEN(sv));
2765 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2768 #ifdef FIXNEGATIVEZERO
2769 if (*s == '-' && s[1] == '0' && !s[2])
2770 my_strlcpy(s, "0", SvLEN(s));
2779 if (isGV_with_GP(sv))
2780 return glob_2pv((GV *)sv, lp);
2782 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2786 if (SvTYPE(sv) < SVt_PV)
2787 /* Typically the caller expects that sv_any is not NULL now. */
2788 sv_upgrade(sv, SVt_PV);
2792 const STRLEN len = s - SvPVX_const(sv);
2798 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2799 PTR2UV(sv),SvPVX_const(sv)));
2800 if (flags & SV_CONST_RETURN)
2801 return (char *)SvPVX_const(sv);
2802 if (flags & SV_MUTABLE_RETURN)
2803 return SvPVX_mutable(sv);
2808 =for apidoc sv_copypv
2810 Copies a stringified representation of the source SV into the
2811 destination SV. Automatically performs any necessary mg_get and
2812 coercion of numeric values into strings. Guaranteed to preserve
2813 UTF8 flag even from overloaded objects. Similar in nature to
2814 sv_2pv[_flags] but operates directly on an SV instead of just the
2815 string. Mostly uses sv_2pv_flags to do its work, except when that
2816 would lose the UTF-8'ness of the PV.
2822 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2825 const char * const s = SvPV_const(ssv,len);
2826 sv_setpvn(dsv,s,len);
2834 =for apidoc sv_2pvbyte
2836 Return a pointer to the byte-encoded representation of the SV, and set *lp
2837 to its length. May cause the SV to be downgraded from UTF-8 as a
2840 Usually accessed via the C<SvPVbyte> macro.
2846 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2848 sv_utf8_downgrade(sv,0);
2849 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2853 =for apidoc sv_2pvutf8
2855 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2856 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2858 Usually accessed via the C<SvPVutf8> macro.
2864 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2866 sv_utf8_upgrade(sv);
2867 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2872 =for apidoc sv_2bool
2874 This function is only called on magical items, and is only used by
2875 sv_true() or its macro equivalent.
2881 Perl_sv_2bool(pTHX_ register SV *sv)
2890 SV * const tmpsv = AMG_CALLun(sv,bool_);
2891 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2892 return (bool)SvTRUE(tmpsv);
2894 return SvRV(sv) != 0;
2897 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2899 (*sv->sv_u.svu_pv > '0' ||
2900 Xpvtmp->xpv_cur > 1 ||
2901 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2908 return SvIVX(sv) != 0;
2911 return SvNVX(sv) != 0.0;
2913 if (isGV_with_GP(sv))
2923 =for apidoc sv_utf8_upgrade
2925 Converts the PV of an SV to its UTF-8-encoded form.
2926 Forces the SV to string form if it is not already.
2927 Always sets the SvUTF8 flag to avoid future validity checks even
2928 if all the bytes have hibit clear.
2930 This is not as a general purpose byte encoding to Unicode interface:
2931 use the Encode extension for that.
2933 =for apidoc sv_utf8_upgrade_flags
2935 Converts the PV of an SV to its UTF-8-encoded form.
2936 Forces the SV to string form if it is not already.
2937 Always sets the SvUTF8 flag to avoid future validity checks even
2938 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2939 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2940 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2942 This is not as a general purpose byte encoding to Unicode interface:
2943 use the Encode extension for that.
2949 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2952 if (sv == &PL_sv_undef)
2956 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2957 (void) sv_2pv_flags(sv,&len, flags);
2961 (void) SvPV_force(sv,len);
2970 sv_force_normal_flags(sv, 0);
2973 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
2974 sv_recode_to_utf8(sv, PL_encoding);
2975 else { /* Assume Latin-1/EBCDIC */
2976 /* This function could be much more efficient if we
2977 * had a FLAG in SVs to signal if there are any hibit
2978 * chars in the PV. Given that there isn't such a flag
2979 * make the loop as fast as possible. */
2980 const U8 * const s = (U8 *) SvPVX_const(sv);
2981 const U8 * const e = (U8 *) SvEND(sv);
2986 /* Check for hi bit */
2987 if (!NATIVE_IS_INVARIANT(ch)) {
2988 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
2989 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
2991 SvPV_free(sv); /* No longer using what was there before. */
2992 SvPV_set(sv, (char*)recoded);
2993 SvCUR_set(sv, len - 1);
2994 SvLEN_set(sv, len); /* No longer know the real size. */
2998 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3005 =for apidoc sv_utf8_downgrade
3007 Attempts to convert the PV of an SV from characters to bytes.
3008 If the PV contains a character beyond byte, this conversion will fail;
3009 in this case, either returns false or, if C<fail_ok> is not
3012 This is not as a general purpose Unicode to byte encoding interface:
3013 use the Encode extension for that.
3019 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3022 if (SvPOKp(sv) && SvUTF8(sv)) {
3028 sv_force_normal_flags(sv, 0);
3030 s = (U8 *) SvPV(sv, len);
3031 if (!utf8_to_bytes(s, &len)) {
3036 Perl_croak(aTHX_ "Wide character in %s",
3039 Perl_croak(aTHX_ "Wide character");
3050 =for apidoc sv_utf8_encode
3052 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3053 flag off so that it looks like octets again.
3059 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3062 sv_force_normal_flags(sv, 0);
3064 if (SvREADONLY(sv)) {
3065 Perl_croak(aTHX_ PL_no_modify);
3067 (void) sv_utf8_upgrade(sv);
3072 =for apidoc sv_utf8_decode
3074 If the PV of the SV is an octet sequence in UTF-8
3075 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3076 so that it looks like a character. If the PV contains only single-byte
3077 characters, the C<SvUTF8> flag stays being off.
3078 Scans PV for validity and returns false if the PV is invalid UTF-8.
3084 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3090 /* The octets may have got themselves encoded - get them back as
3093 if (!sv_utf8_downgrade(sv, TRUE))
3096 /* it is actually just a matter of turning the utf8 flag on, but
3097 * we want to make sure everything inside is valid utf8 first.
3099 c = (const U8 *) SvPVX_const(sv);
3100 if (!is_utf8_string(c, SvCUR(sv)+1))
3102 e = (const U8 *) SvEND(sv);
3105 if (!UTF8_IS_INVARIANT(ch)) {
3115 =for apidoc sv_setsv
3117 Copies the contents of the source SV C<ssv> into the destination SV
3118 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3119 function if the source SV needs to be reused. Does not handle 'set' magic.
3120 Loosely speaking, it performs a copy-by-value, obliterating any previous
3121 content of the destination.
3123 You probably want to use one of the assortment of wrappers, such as
3124 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3125 C<SvSetMagicSV_nosteal>.
3127 =for apidoc sv_setsv_flags
3129 Copies the contents of the source SV C<ssv> into the destination SV
3130 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3131 function if the source SV needs to be reused. Does not handle 'set' magic.
3132 Loosely speaking, it performs a copy-by-value, obliterating any previous
3133 content of the destination.
3134 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3135 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3136 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3137 and C<sv_setsv_nomg> are implemented in terms of this function.
3139 You probably want to use one of the assortment of wrappers, such as
3140 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3141 C<SvSetMagicSV_nosteal>.
3143 This is the primary function for copying scalars, and most other
3144 copy-ish functions and macros use this underneath.
3150 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3152 if (dtype != SVt_PVGV) {
3153 const char * const name = GvNAME(sstr);
3154 const STRLEN len = GvNAMELEN(sstr);
3156 if (dtype >= SVt_PV) {
3162 SvUPGRADE(dstr, SVt_PVGV);
3163 (void)SvOK_off(dstr);
3164 /* FIXME - why are we doing this, then turning it off and on again
3166 isGV_with_GP_on(dstr);
3168 GvSTASH(dstr) = GvSTASH(sstr);
3170 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3171 gv_name_set((GV *)dstr, name, len, GV_ADD);
3172 SvFAKE_on(dstr); /* can coerce to non-glob */
3175 #ifdef GV_UNIQUE_CHECK
3176 if (GvUNIQUE((GV*)dstr)) {
3177 Perl_croak(aTHX_ PL_no_modify);
3182 isGV_with_GP_off(dstr);
3183 (void)SvOK_off(dstr);
3184 isGV_with_GP_on(dstr);
3185 GvINTRO_off(dstr); /* one-shot flag */
3186 GvGP(dstr) = gp_ref(GvGP(sstr));
3187 if (SvTAINTED(sstr))
3189 if (GvIMPORTED(dstr) != GVf_IMPORTED
3190 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3192 GvIMPORTED_on(dstr);
3199 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3200 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3202 const int intro = GvINTRO(dstr);
3205 const U32 stype = SvTYPE(sref);
3208 #ifdef GV_UNIQUE_CHECK
3209 if (GvUNIQUE((GV*)dstr)) {
3210 Perl_croak(aTHX_ PL_no_modify);
3215 GvINTRO_off(dstr); /* one-shot flag */
3216 GvLINE(dstr) = CopLINE(PL_curcop);
3217 GvEGV(dstr) = (GV*)dstr;
3222 location = (SV **) &GvCV(dstr);
3223 import_flag = GVf_IMPORTED_CV;
3226 location = (SV **) &GvHV(dstr);
3227 import_flag = GVf_IMPORTED_HV;
3230 location = (SV **) &GvAV(dstr);
3231 import_flag = GVf_IMPORTED_AV;
3234 location = (SV **) &GvIOp(dstr);
3237 location = (SV **) &GvFORM(dstr);
3239 location = &GvSV(dstr);
3240 import_flag = GVf_IMPORTED_SV;
3243 if (stype == SVt_PVCV) {
3244 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3245 SvREFCNT_dec(GvCV(dstr));
3247 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3248 PL_sub_generation++;
3251 SAVEGENERICSV(*location);
3255 if (stype == SVt_PVCV && *location != sref) {
3256 CV* const cv = (CV*)*location;
3258 if (!GvCVGEN((GV*)dstr) &&
3259 (CvROOT(cv) || CvXSUB(cv)))
3261 /* Redefining a sub - warning is mandatory if
3262 it was a const and its value changed. */
3263 if (CvCONST(cv) && CvCONST((CV*)sref)
3264 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3266 /* They are 2 constant subroutines generated from
3267 the same constant. This probably means that
3268 they are really the "same" proxy subroutine
3269 instantiated in 2 places. Most likely this is
3270 when a constant is exported twice. Don't warn.
3273 else if (ckWARN(WARN_REDEFINE)
3275 && (!CvCONST((CV*)sref)
3276 || sv_cmp(cv_const_sv(cv),
3277 cv_const_sv((CV*)sref))))) {
3278 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3281 ? "Constant subroutine %s::%s redefined"
3282 : "Subroutine %s::%s redefined"),
3283 HvNAME_get(GvSTASH((GV*)dstr)),
3284 GvENAME((GV*)dstr));
3288 cv_ckproto_len(cv, (GV*)dstr,
3289 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3290 SvPOK(sref) ? SvCUR(sref) : 0);
3292 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3293 GvASSUMECV_on(dstr);
3294 PL_sub_generation++;
3297 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3298 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3299 GvFLAGS(dstr) |= import_flag;
3304 if (SvTAINTED(sstr))
3310 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3313 register U32 sflags;
3315 register svtype stype;
3320 if (SvIS_FREED(dstr)) {
3321 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3322 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3324 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3326 sstr = &PL_sv_undef;
3327 if (SvIS_FREED(sstr)) {
3328 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3329 (void*)sstr, (void*)dstr);
3331 stype = SvTYPE(sstr);
3332 dtype = SvTYPE(dstr);
3334 (void)SvAMAGIC_off(dstr);
3337 /* need to nuke the magic */
3339 SvRMAGICAL_off(dstr);
3342 /* There's a lot of redundancy below but we're going for speed here */
3347 if (dtype != SVt_PVGV) {
3348 (void)SvOK_off(dstr);
3356 sv_upgrade(dstr, SVt_IV);
3361 sv_upgrade(dstr, SVt_PVIV);
3364 goto end_of_first_switch;
3366 (void)SvIOK_only(dstr);
3367 SvIV_set(dstr, SvIVX(sstr));
3370 /* SvTAINTED can only be true if the SV has taint magic, which in
3371 turn means that the SV type is PVMG (or greater). This is the
3372 case statement for SVt_IV, so this cannot be true (whatever gcov
3374 assert(!SvTAINTED(sstr));
3384 sv_upgrade(dstr, SVt_NV);
3389 sv_upgrade(dstr, SVt_PVNV);
3392 goto end_of_first_switch;
3394 SvNV_set(dstr, SvNVX(sstr));
3395 (void)SvNOK_only(dstr);
3396 /* SvTAINTED can only be true if the SV has taint magic, which in
3397 turn means that the SV type is PVMG (or greater). This is the
3398 case statement for SVt_NV, so this cannot be true (whatever gcov
3400 assert(!SvTAINTED(sstr));
3407 sv_upgrade(dstr, SVt_RV);
3410 #ifdef PERL_OLD_COPY_ON_WRITE
3411 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3412 if (dtype < SVt_PVIV)
3413 sv_upgrade(dstr, SVt_PVIV);
3420 sv_upgrade(dstr, SVt_PV);
3423 if (dtype < SVt_PVIV)
3424 sv_upgrade(dstr, SVt_PVIV);
3427 if (dtype < SVt_PVNV)
3428 sv_upgrade(dstr, SVt_PVNV);
3432 const char * const type = sv_reftype(sstr,0);
3434 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3436 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3440 /* case SVt_BIND: */
3443 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3444 glob_assign_glob(dstr, sstr, dtype);
3447 /* SvVALID means that this PVGV is playing at being an FBM. */
3451 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3453 if (SvTYPE(sstr) != stype) {
3454 stype = SvTYPE(sstr);
3455 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3456 glob_assign_glob(dstr, sstr, dtype);
3461 if (stype == SVt_PVLV)
3462 SvUPGRADE(dstr, SVt_PVNV);
3464 SvUPGRADE(dstr, (svtype)stype);
3466 end_of_first_switch:
3468 /* dstr may have been upgraded. */
3469 dtype = SvTYPE(dstr);
3470 sflags = SvFLAGS(sstr);
3472 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3473 /* Assigning to a subroutine sets the prototype. */
3476 const char *const ptr = SvPV_const(sstr, len);
3478 SvGROW(dstr, len + 1);
3479 Copy(ptr, SvPVX(dstr), len + 1, char);
3480 SvCUR_set(dstr, len);
3482 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3486 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3487 const char * const type = sv_reftype(dstr,0);
3489 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3491 Perl_croak(aTHX_ "Cannot copy to %s", type);
3492 } else if (sflags & SVf_ROK) {
3493 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3494 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3497 if (GvIMPORTED(dstr) != GVf_IMPORTED
3498 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3500 GvIMPORTED_on(dstr);
3505 glob_assign_glob(dstr, sstr, dtype);
3509 if (dtype >= SVt_PV) {
3510 if (dtype == SVt_PVGV) {
3511 glob_assign_ref(dstr, sstr);
3514 if (SvPVX_const(dstr)) {
3520 (void)SvOK_off(dstr);
3521 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3522 SvFLAGS(dstr) |= sflags & SVf_ROK;
3523 assert(!(sflags & SVp_NOK));
3524 assert(!(sflags & SVp_IOK));
3525 assert(!(sflags & SVf_NOK));
3526 assert(!(sflags & SVf_IOK));
3528 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3529 if (!(sflags & SVf_OK)) {
3530 if (ckWARN(WARN_MISC))
3531 Perl_warner(aTHX_ packWARN(WARN_MISC),
3532 "Undefined value assigned to typeglob");
3535 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3536 if (dstr != (SV*)gv) {
3539 GvGP(dstr) = gp_ref(GvGP(gv));
3543 else if (sflags & SVp_POK) {
3547 * Check to see if we can just swipe the string. If so, it's a
3548 * possible small lose on short strings, but a big win on long ones.
3549 * It might even be a win on short strings if SvPVX_const(dstr)
3550 * has to be allocated and SvPVX_const(sstr) has to be freed.
3551 * Likewise if we can set up COW rather than doing an actual copy, we
3552 * drop to the else clause, as the swipe code and the COW setup code
3553 * have much in common.
3556 /* Whichever path we take through the next code, we want this true,
3557 and doing it now facilitates the COW check. */
3558 (void)SvPOK_only(dstr);
3561 /* If we're already COW then this clause is not true, and if COW
3562 is allowed then we drop down to the else and make dest COW
3563 with us. If caller hasn't said that we're allowed to COW
3564 shared hash keys then we don't do the COW setup, even if the
3565 source scalar is a shared hash key scalar. */
3566 (((flags & SV_COW_SHARED_HASH_KEYS)
3567 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3568 : 1 /* If making a COW copy is forbidden then the behaviour we
3569 desire is as if the source SV isn't actually already
3570 COW, even if it is. So we act as if the source flags
3571 are not COW, rather than actually testing them. */
3573 #ifndef PERL_OLD_COPY_ON_WRITE
3574 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3575 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3576 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3577 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3578 but in turn, it's somewhat dead code, never expected to go
3579 live, but more kept as a placeholder on how to do it better
3580 in a newer implementation. */
3581 /* If we are COW and dstr is a suitable target then we drop down
3582 into the else and make dest a COW of us. */
3583 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3588 (sflags & SVs_TEMP) && /* slated for free anyway? */
3589 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3590 (!(flags & SV_NOSTEAL)) &&
3591 /* and we're allowed to steal temps */
3592 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3593 SvLEN(sstr) && /* and really is a string */
3594 /* and won't be needed again, potentially */
3595 !(PL_op && PL_op->op_type == OP_AASSIGN))
3596 #ifdef PERL_OLD_COPY_ON_WRITE
3597 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3598 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3599 && SvTYPE(sstr) >= SVt_PVIV)
3602 /* Failed the swipe test, and it's not a shared hash key either.
3603 Have to copy the string. */
3604 STRLEN len = SvCUR(sstr);
3605 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3606 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3607 SvCUR_set(dstr, len);
3608 *SvEND(dstr) = '\0';
3610 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3612 /* Either it's a shared hash key, or it's suitable for
3613 copy-on-write or we can swipe the string. */
3615 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3619 #ifdef PERL_OLD_COPY_ON_WRITE
3621 /* I believe I should acquire a global SV mutex if
3622 it's a COW sv (not a shared hash key) to stop
3623 it going un copy-on-write.
3624 If the source SV has gone un copy on write between up there
3625 and down here, then (assert() that) it is of the correct
3626 form to make it copy on write again */
3627 if ((sflags & (SVf_FAKE | SVf_READONLY))
3628 != (SVf_FAKE | SVf_READONLY)) {
3629 SvREADONLY_on(sstr);
3631 /* Make the source SV into a loop of 1.
3632 (about to become 2) */
3633 SV_COW_NEXT_SV_SET(sstr, sstr);
3637 /* Initial code is common. */
3638 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3643 /* making another shared SV. */
3644 STRLEN cur = SvCUR(sstr);
3645 STRLEN len = SvLEN(sstr);
3646 #ifdef PERL_OLD_COPY_ON_WRITE
3648 assert (SvTYPE(dstr) >= SVt_PVIV);
3649 /* SvIsCOW_normal */
3650 /* splice us in between source and next-after-source. */
3651 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3652 SV_COW_NEXT_SV_SET(sstr, dstr);
3653 SvPV_set(dstr, SvPVX_mutable(sstr));
3657 /* SvIsCOW_shared_hash */
3658 DEBUG_C(PerlIO_printf(Perl_debug_log,
3659 "Copy on write: Sharing hash\n"));
3661 assert (SvTYPE(dstr) >= SVt_PV);
3663 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3665 SvLEN_set(dstr, len);
3666 SvCUR_set(dstr, cur);
3667 SvREADONLY_on(dstr);
3669 /* Relesase a global SV mutex. */
3672 { /* Passes the swipe test. */
3673 SvPV_set(dstr, SvPVX_mutable(sstr));
3674 SvLEN_set(dstr, SvLEN(sstr));
3675 SvCUR_set(dstr, SvCUR(sstr));
3678 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3679 SvPV_set(sstr, NULL);
3685 if (sflags & SVp_NOK) {
3686 SvNV_set(dstr, SvNVX(sstr));
3688 if (sflags & SVp_IOK) {
3690 SvIV_set(dstr, SvIVX(sstr));
3691 /* Must do this otherwise some other overloaded use of 0x80000000
3692 gets confused. I guess SVpbm_VALID */
3693 if (sflags & SVf_IVisUV)
3696 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3698 const MAGIC * const smg = SvVSTRING_mg(sstr);
3700 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3701 smg->mg_ptr, smg->mg_len);
3702 SvRMAGICAL_on(dstr);
3706 else if (sflags & (SVp_IOK|SVp_NOK)) {
3707 (void)SvOK_off(dstr);
3708 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3709 if (sflags & SVp_IOK) {
3710 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3711 SvIV_set(dstr, SvIVX(sstr));
3713 if (sflags & SVp_NOK) {
3714 SvNV_set(dstr, SvNVX(sstr));
3718 if (isGV_with_GP(sstr)) {
3719 /* This stringification rule for globs is spread in 3 places.
3720 This feels bad. FIXME. */
3721 const U32 wasfake = sflags & SVf_FAKE;
3723 /* FAKE globs can get coerced, so need to turn this off
3724 temporarily if it is on. */
3726 gv_efullname3(dstr, (GV *)sstr, "*");
3727 SvFLAGS(sstr) |= wasfake;
3730 (void)SvOK_off(dstr);
3732 if (SvTAINTED(sstr))
3737 =for apidoc sv_setsv_mg
3739 Like C<sv_setsv>, but also handles 'set' magic.
3745 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3747 sv_setsv(dstr,sstr);
3751 #ifdef PERL_OLD_COPY_ON_WRITE
3753 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3755 STRLEN cur = SvCUR(sstr);
3756 STRLEN len = SvLEN(sstr);
3757 register char *new_pv;
3760 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3761 (void*)sstr, (void*)dstr);
3768 if (SvTHINKFIRST(dstr))
3769 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3770 else if (SvPVX_const(dstr))
3771 Safefree(SvPVX_const(dstr));
3775 SvUPGRADE(dstr, SVt_PVIV);
3777 assert (SvPOK(sstr));
3778 assert (SvPOKp(sstr));
3779 assert (!SvIOK(sstr));
3780 assert (!SvIOKp(sstr));
3781 assert (!SvNOK(sstr));
3782 assert (!SvNOKp(sstr));
3784 if (SvIsCOW(sstr)) {
3786 if (SvLEN(sstr) == 0) {
3787 /* source is a COW shared hash key. */
3788 DEBUG_C(PerlIO_printf(Perl_debug_log,
3789 "Fast copy on write: Sharing hash\n"));
3790 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3793 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3795 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3796 SvUPGRADE(sstr, SVt_PVIV);
3797 SvREADONLY_on(sstr);
3799 DEBUG_C(PerlIO_printf(Perl_debug_log,
3800 "Fast copy on write: Converting sstr to COW\n"));
3801 SV_COW_NEXT_SV_SET(dstr, sstr);
3803 SV_COW_NEXT_SV_SET(sstr, dstr);
3804 new_pv = SvPVX_mutable(sstr);
3807 SvPV_set(dstr, new_pv);
3808 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3811 SvLEN_set(dstr, len);
3812 SvCUR_set(dstr, cur);
3821 =for apidoc sv_setpvn
3823 Copies a string into an SV. The C<len> parameter indicates the number of
3824 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3825 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3831 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3834 register char *dptr;
3836 SV_CHECK_THINKFIRST_COW_DROP(sv);
3842 /* len is STRLEN which is unsigned, need to copy to signed */
3845 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3847 SvUPGRADE(sv, SVt_PV);
3849 dptr = SvGROW(sv, len + 1);
3850 Move(ptr,dptr,len,char);
3853 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3858 =for apidoc sv_setpvn_mg
3860 Like C<sv_setpvn>, but also handles 'set' magic.
3866 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3868 sv_setpvn(sv,ptr,len);
3873 =for apidoc sv_setpv
3875 Copies a string into an SV. The string must be null-terminated. Does not
3876 handle 'set' magic. See C<sv_setpv_mg>.
3882 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3885 register STRLEN len;
3887 SV_CHECK_THINKFIRST_COW_DROP(sv);
3893 SvUPGRADE(sv, SVt_PV);
3895 SvGROW(sv, len + 1);
3896 Move(ptr,SvPVX(sv),len+1,char);
3898 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3903 =for apidoc sv_setpv_mg
3905 Like C<sv_setpv>, but also handles 'set' magic.
3911 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3918 =for apidoc sv_usepvn_flags
3920 Tells an SV to use C<ptr> to find its string value. Normally the
3921 string is stored inside the SV but sv_usepvn allows the SV to use an
3922 outside string. The C<ptr> should point to memory that was allocated
3923 by C<malloc>. The string length, C<len>, must be supplied. By default
3924 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3925 so that pointer should not be freed or used by the programmer after
3926 giving it to sv_usepvn, and neither should any pointers from "behind"
3927 that pointer (e.g. ptr + 1) be used.
3929 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3930 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3931 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3932 C<len>, and already meets the requirements for storing in C<SvPVX>)
3938 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3942 SV_CHECK_THINKFIRST_COW_DROP(sv);
3943 SvUPGRADE(sv, SVt_PV);
3946 if (flags & SV_SMAGIC)
3950 if (SvPVX_const(sv))
3954 if (flags & SV_HAS_TRAILING_NUL)
3955 assert(ptr[len] == '\0');
3958 allocate = (flags & SV_HAS_TRAILING_NUL)
3959 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3960 if (flags & SV_HAS_TRAILING_NUL) {
3961 /* It's long enough - do nothing.
3962 Specfically Perl_newCONSTSUB is relying on this. */
3965 /* Force a move to shake out bugs in callers. */
3966 char *new_ptr = (char*)safemalloc(allocate);
3967 Copy(ptr, new_ptr, len, char);
3968 PoisonFree(ptr,len,char);
3972 ptr = (char*) saferealloc (ptr, allocate);
3977 SvLEN_set(sv, allocate);
3978 if (!(flags & SV_HAS_TRAILING_NUL)) {
3981 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3983 if (flags & SV_SMAGIC)
3987 #ifdef PERL_OLD_COPY_ON_WRITE
3988 /* Need to do this *after* making the SV normal, as we need the buffer
3989 pointer to remain valid until after we've copied it. If we let go too early,
3990 another thread could invalidate it by unsharing last of the same hash key
3991 (which it can do by means other than releasing copy-on-write Svs)
3992 or by changing the other copy-on-write SVs in the loop. */
3994 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
3996 { /* this SV was SvIsCOW_normal(sv) */
3997 /* we need to find the SV pointing to us. */
3998 SV *current = SV_COW_NEXT_SV(after);
4000 if (current == sv) {
4001 /* The SV we point to points back to us (there were only two of us
4003 Hence other SV is no longer copy on write either. */
4005 SvREADONLY_off(after);
4007 /* We need to follow the pointers around the loop. */
4009 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4012 /* don't loop forever if the structure is bust, and we have
4013 a pointer into a closed loop. */
4014 assert (current != after);
4015 assert (SvPVX_const(current) == pvx);
4017 /* Make the SV before us point to the SV after us. */
4018 SV_COW_NEXT_SV_SET(current, after);
4024 =for apidoc sv_force_normal_flags
4026 Undo various types of fakery on an SV: if the PV is a shared string, make
4027 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4028 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4029 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4030 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4031 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4032 set to some other value.) In addition, the C<flags> parameter gets passed to
4033 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4034 with flags set to 0.
4040 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4043 #ifdef PERL_OLD_COPY_ON_WRITE
4044 if (SvREADONLY(sv)) {
4045 /* At this point I believe I should acquire a global SV mutex. */
4047 const char * const pvx = SvPVX_const(sv);
4048 const STRLEN len = SvLEN(sv);
4049 const STRLEN cur = SvCUR(sv);
4050 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4051 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4052 we'll fail an assertion. */
4053 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4056 PerlIO_printf(Perl_debug_log,
4057 "Copy on write: Force normal %ld\n",
4063 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4066 if (flags & SV_COW_DROP_PV) {
4067 /* OK, so we don't need to copy our buffer. */
4070 SvGROW(sv, cur + 1);
4071 Move(pvx,SvPVX(sv),cur,char);
4076 sv_release_COW(sv, pvx, next);
4078 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4084 else if (IN_PERL_RUNTIME)
4085 Perl_croak(aTHX_ PL_no_modify);
4086 /* At this point I believe that I can drop the global SV mutex. */
4089 if (SvREADONLY(sv)) {
4091 const char * const pvx = SvPVX_const(sv);
4092 const STRLEN len = SvCUR(sv);
4097 SvGROW(sv, len + 1);
4098 Move(pvx,SvPVX(sv),len,char);
4100 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4102 else if (IN_PERL_RUNTIME)
4103 Perl_croak(aTHX_ PL_no_modify);
4107 sv_unref_flags(sv, flags);
4108 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4115 Efficient removal of characters from the beginning of the string buffer.
4116 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4117 the string buffer. The C<ptr> becomes the first character of the adjusted
4118 string. Uses the "OOK hack".
4119 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4120 refer to the same chunk of data.
4126 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4128 register STRLEN delta;
4129 if (!ptr || !SvPOKp(sv))
4131 delta = ptr - SvPVX_const(sv);
4132 SV_CHECK_THINKFIRST(sv);
4133 if (SvTYPE(sv) < SVt_PVIV)
4134 sv_upgrade(sv,SVt_PVIV);
4137 if (!SvLEN(sv)) { /* make copy of shared string */
4138 const char *pvx = SvPVX_const(sv);
4139 const STRLEN len = SvCUR(sv);
4140 SvGROW(sv, len + 1);
4141 Move(pvx,SvPVX(sv),len,char);
4145 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4146 and we do that anyway inside the SvNIOK_off
4148 SvFLAGS(sv) |= SVf_OOK;
4151 SvLEN_set(sv, SvLEN(sv) - delta);
4152 SvCUR_set(sv, SvCUR(sv) - delta);
4153 SvPV_set(sv, SvPVX(sv) + delta);
4154 SvIV_set(sv, SvIVX(sv) + delta);
4158 =for apidoc sv_catpvn
4160 Concatenates the string onto the end of the string which is in the SV. The
4161 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4162 status set, then the bytes appended should be valid UTF-8.
4163 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4165 =for apidoc sv_catpvn_flags
4167 Concatenates the string onto the end of the string which is in the SV. The
4168 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4169 status set, then the bytes appended should be valid UTF-8.
4170 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4171 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4172 in terms of this function.
4178 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4182 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4184 SvGROW(dsv, dlen + slen + 1);
4186 sstr = SvPVX_const(dsv);
4187 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4188 SvCUR_set(dsv, SvCUR(dsv) + slen);
4190 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4192 if (flags & SV_SMAGIC)
4197 =for apidoc sv_catsv
4199 Concatenates the string from SV C<ssv> onto the end of the string in
4200 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4201 not 'set' magic. See C<sv_catsv_mg>.
4203 =for apidoc sv_catsv_flags
4205 Concatenates the string from SV C<ssv> onto the end of the string in
4206 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4207 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4208 and C<sv_catsv_nomg> are implemented in terms of this function.
4213 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4218 const char *spv = SvPV_const(ssv, slen);
4220 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4221 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4222 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4223 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4224 dsv->sv_flags doesn't have that bit set.
4225 Andy Dougherty 12 Oct 2001
4227 const I32 sutf8 = DO_UTF8(ssv);
4230 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4232 dutf8 = DO_UTF8(dsv);
4234 if (dutf8 != sutf8) {
4236 /* Not modifying source SV, so taking a temporary copy. */
4237 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4239 sv_utf8_upgrade(csv);
4240 spv = SvPV_const(csv, slen);
4243 sv_utf8_upgrade_nomg(dsv);
4245 sv_catpvn_nomg(dsv, spv, slen);
4248 if (flags & SV_SMAGIC)
4253 =for apidoc sv_catpv
4255 Concatenates the string onto the end of the string which is in the SV.
4256 If the SV has the UTF-8 status set, then the bytes appended should be
4257 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4262 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4265 register STRLEN len;
4271 junk = SvPV_force(sv, tlen);
4273 SvGROW(sv, tlen + len + 1);
4275 ptr = SvPVX_const(sv);
4276 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4277 SvCUR_set(sv, SvCUR(sv) + len);
4278 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4283 =for apidoc sv_catpv_mg
4285 Like C<sv_catpv>, but also handles 'set' magic.
4291 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4300 Creates a new SV. A non-zero C<len> parameter indicates the number of
4301 bytes of preallocated string space the SV should have. An extra byte for a
4302 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4303 space is allocated.) The reference count for the new SV is set to 1.
4305 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4306 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4307 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4308 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4309 modules supporting older perls.
4315 Perl_newSV(pTHX_ STRLEN len)
4322 sv_upgrade(sv, SVt_PV);
4323 SvGROW(sv, len + 1);
4328 =for apidoc sv_magicext
4330 Adds magic to an SV, upgrading it if necessary. Applies the
4331 supplied vtable and returns a pointer to the magic added.
4333 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4334 In particular, you can add magic to SvREADONLY SVs, and add more than
4335 one instance of the same 'how'.
4337 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4338 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4339 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4340 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4342 (This is now used as a subroutine by C<sv_magic>.)
4347 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4348 const char* name, I32 namlen)
4353 SvUPGRADE(sv, SVt_PVMG);
4354 Newxz(mg, 1, MAGIC);
4355 mg->mg_moremagic = SvMAGIC(sv);
4356 SvMAGIC_set(sv, mg);
4358 /* Sometimes a magic contains a reference loop, where the sv and
4359 object refer to each other. To prevent a reference loop that
4360 would prevent such objects being freed, we look for such loops
4361 and if we find one we avoid incrementing the object refcount.
4363 Note we cannot do this to avoid self-tie loops as intervening RV must
4364 have its REFCNT incremented to keep it in existence.
4367 if (!obj || obj == sv ||
4368 how == PERL_MAGIC_arylen ||
4369 how == PERL_MAGIC_qr ||
4370 how == PERL_MAGIC_symtab ||
4371 (SvTYPE(obj) == SVt_PVGV &&
4372 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4373 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4374 GvFORM(obj) == (CV*)sv)))
4379 mg->mg_obj = SvREFCNT_inc_simple(obj);
4380 mg->mg_flags |= MGf_REFCOUNTED;
4383 /* Normal self-ties simply pass a null object, and instead of
4384 using mg_obj directly, use the SvTIED_obj macro to produce a
4385 new RV as needed. For glob "self-ties", we are tieing the PVIO
4386 with an RV obj pointing to the glob containing the PVIO. In
4387 this case, to avoid a reference loop, we need to weaken the
4391 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4392 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4398 mg->mg_len = namlen;
4401 mg->mg_ptr = savepvn(name, namlen);
4402 else if (namlen == HEf_SVKEY)
4403 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4405 mg->mg_ptr = (char *) name;
4407 mg->mg_virtual = (MGVTBL *) vtable;
4411 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4416 =for apidoc sv_magic
4418 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4419 then adds a new magic item of type C<how> to the head of the magic list.
4421 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4422 handling of the C<name> and C<namlen> arguments.
4424 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4425 to add more than one instance of the same 'how'.
4431 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4434 const MGVTBL *vtable;
4437 #ifdef PERL_OLD_COPY_ON_WRITE
4439 sv_force_normal_flags(sv, 0);
4441 if (SvREADONLY(sv)) {
4443 /* its okay to attach magic to shared strings; the subsequent
4444 * upgrade to PVMG will unshare the string */
4445 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4448 && how != PERL_MAGIC_regex_global
4449 && how != PERL_MAGIC_bm
4450 && how != PERL_MAGIC_fm
4451 && how != PERL_MAGIC_sv
4452 && how != PERL_MAGIC_backref
4455 Perl_croak(aTHX_ PL_no_modify);
4458 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4459 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4460 /* sv_magic() refuses to add a magic of the same 'how' as an
4463 if (how == PERL_MAGIC_taint) {
4465 /* Any scalar which already had taint magic on which someone
4466 (erroneously?) did SvIOK_on() or similar will now be
4467 incorrectly sporting public "OK" flags. */
4468 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4476 vtable = &PL_vtbl_sv;
4478 case PERL_MAGIC_overload:
4479 vtable = &PL_vtbl_amagic;
4481 case PERL_MAGIC_overload_elem:
4482 vtable = &PL_vtbl_amagicelem;
4484 case PERL_MAGIC_overload_table:
4485 vtable = &PL_vtbl_ovrld;
4488 vtable = &PL_vtbl_bm;
4490 case PERL_MAGIC_regdata:
4491 vtable = &PL_vtbl_regdata;
4493 case PERL_MAGIC_regdatum:
4494 vtable = &PL_vtbl_regdatum;
4496 case PERL_MAGIC_env:
4497 vtable = &PL_vtbl_env;
4500 vtable = &PL_vtbl_fm;
4502 case PERL_MAGIC_envelem:
4503 vtable = &PL_vtbl_envelem;
4505 case PERL_MAGIC_regex_global:
4506 vtable = &PL_vtbl_mglob;
4508 case PERL_MAGIC_isa:
4509 vtable = &PL_vtbl_isa;
4511 case PERL_MAGIC_isaelem:
4512 vtable = &PL_vtbl_isaelem;
4514 case PERL_MAGIC_nkeys:
4515 vtable = &PL_vtbl_nkeys;
4517 case PERL_MAGIC_dbfile:
4520 case PERL_MAGIC_dbline:
4521 vtable = &PL_vtbl_dbline;
4523 #ifdef USE_LOCALE_COLLATE
4524 case PERL_MAGIC_collxfrm:
4525 vtable = &PL_vtbl_collxfrm;
4527 #endif /* USE_LOCALE_COLLATE */
4528 case PERL_MAGIC_tied:
4529 vtable = &PL_vtbl_pack;
4531 case PERL_MAGIC_tiedelem:
4532 case PERL_MAGIC_tiedscalar:
4533 vtable = &PL_vtbl_packelem;
4536 vtable = &PL_vtbl_regexp;
4538 case PERL_MAGIC_hints:
4539 /* As this vtable is all NULL, we can reuse it. */
4540 case PERL_MAGIC_sig:
4541 vtable = &PL_vtbl_sig;
4543 case PERL_MAGIC_sigelem:
4544 vtable = &PL_vtbl_sigelem;
4546 case PERL_MAGIC_taint:
4547 vtable = &PL_vtbl_taint;
4549 case PERL_MAGIC_uvar:
4550 vtable = &PL_vtbl_uvar;
4552 case PERL_MAGIC_vec:
4553 vtable = &PL_vtbl_vec;
4555 case PERL_MAGIC_arylen_p:
4556 case PERL_MAGIC_rhash:
4557 case PERL_MAGIC_symtab:
4558 case PERL_MAGIC_vstring:
4561 case PERL_MAGIC_utf8:
4562 vtable = &PL_vtbl_utf8;
4564 case PERL_MAGIC_substr:
4565 vtable = &PL_vtbl_substr;
4567 case PERL_MAGIC_defelem:
4568 vtable = &PL_vtbl_defelem;
4570 case PERL_MAGIC_arylen:
4571 vtable = &PL_vtbl_arylen;
4573 case PERL_MAGIC_pos:
4574 vtable = &PL_vtbl_pos;
4576 case PERL_MAGIC_backref:
4577 vtable = &PL_vtbl_backref;
4579 case PERL_MAGIC_hintselem:
4580 vtable = &PL_vtbl_hintselem;
4582 case PERL_MAGIC_ext:
4583 /* Reserved for use by extensions not perl internals. */
4584 /* Useful for attaching extension internal data to perl vars. */
4585 /* Note that multiple extensions may clash if magical scalars */
4586 /* etc holding private data from one are passed to another. */
4590 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4593 /* Rest of work is done else where */
4594 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4597 case PERL_MAGIC_taint:
4600 case PERL_MAGIC_ext:
4601 case PERL_MAGIC_dbfile:
4608 =for apidoc sv_unmagic
4610 Removes all magic of type C<type> from an SV.
4616 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4620 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4622 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4623 for (mg = *mgp; mg; mg = *mgp) {
4624 if (mg->mg_type == type) {
4625 const MGVTBL* const vtbl = mg->mg_virtual;
4626 *mgp = mg->mg_moremagic;
4627 if (vtbl && vtbl->svt_free)
4628 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4629 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4631 Safefree(mg->mg_ptr);
4632 else if (mg->mg_len == HEf_SVKEY)
4633 SvREFCNT_dec((SV*)mg->mg_ptr);
4634 else if (mg->mg_type == PERL_MAGIC_utf8)
4635 Safefree(mg->mg_ptr);
4637 if (mg->mg_flags & MGf_REFCOUNTED)
4638 SvREFCNT_dec(mg->mg_obj);
4642 mgp = &mg->mg_moremagic;
4646 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4647 SvMAGIC_set(sv, NULL);
4654 =for apidoc sv_rvweaken
4656 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4657 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4658 push a back-reference to this RV onto the array of backreferences
4659 associated with that magic. If the RV is magical, set magic will be
4660 called after the RV is cleared.
4666 Perl_sv_rvweaken(pTHX_ SV *sv)
4669 if (!SvOK(sv)) /* let undefs pass */
4672 Perl_croak(aTHX_ "Can't weaken a nonreference");
4673 else if (SvWEAKREF(sv)) {
4674 if (ckWARN(WARN_MISC))
4675 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4679 Perl_sv_add_backref(aTHX_ tsv, sv);
4685 /* Give tsv backref magic if it hasn't already got it, then push a
4686 * back-reference to sv onto the array associated with the backref magic.
4690 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4695 if (SvTYPE(tsv) == SVt_PVHV) {
4696 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4700 /* There is no AV in the offical place - try a fixup. */
4701 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4704 /* Aha. They've got it stowed in magic. Bring it back. */
4705 av = (AV*)mg->mg_obj;
4706 /* Stop mg_free decreasing the refernce count. */
4708 /* Stop mg_free even calling the destructor, given that
4709 there's no AV to free up. */
4711 sv_unmagic(tsv, PERL_MAGIC_backref);
4715 SvREFCNT_inc_simple_void(av);
4720 const MAGIC *const mg
4721 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4723 av = (AV*)mg->mg_obj;
4727 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4728 /* av now has a refcnt of 2, which avoids it getting freed
4729 * before us during global cleanup. The extra ref is removed
4730 * by magic_killbackrefs() when tsv is being freed */
4733 if (AvFILLp(av) >= AvMAX(av)) {
4734 av_extend(av, AvFILLp(av)+1);
4736 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4739 /* delete a back-reference to ourselves from the backref magic associated
4740 * with the SV we point to.
4744 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4751 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4752 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4753 /* We mustn't attempt to "fix up" the hash here by moving the
4754 backreference array back to the hv_aux structure, as that is stored
4755 in the main HvARRAY(), and hfreentries assumes that no-one
4756 reallocates HvARRAY() while it is running. */
4759 const MAGIC *const mg
4760 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4762 av = (AV *)mg->mg_obj;
4765 if (PL_in_clean_all)
4767 Perl_croak(aTHX_ "panic: del_backref");
4774 /* We shouldn't be in here more than once, but for paranoia reasons lets
4776 for (i = AvFILLp(av); i >= 0; i--) {
4778 const SSize_t fill = AvFILLp(av);
4780 /* We weren't the last entry.
4781 An unordered list has this property that you can take the
4782 last element off the end to fill the hole, and it's still
4783 an unordered list :-)
4788 AvFILLp(av) = fill - 1;
4794 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4796 SV **svp = AvARRAY(av);
4798 PERL_UNUSED_ARG(sv);
4800 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4801 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4802 if (svp && !SvIS_FREED(av)) {
4803 SV *const *const last = svp + AvFILLp(av);
4805 while (svp <= last) {
4807 SV *const referrer = *svp;
4808 if (SvWEAKREF(referrer)) {
4809 /* XXX Should we check that it hasn't changed? */
4810 SvRV_set(referrer, 0);
4812 SvWEAKREF_off(referrer);
4813 SvSETMAGIC(referrer);
4814 } else if (SvTYPE(referrer) == SVt_PVGV ||
4815 SvTYPE(referrer) == SVt_PVLV) {
4816 /* You lookin' at me? */
4817 assert(GvSTASH(referrer));
4818 assert(GvSTASH(referrer) == (HV*)sv);
4819 GvSTASH(referrer) = 0;
4822 "panic: magic_killbackrefs (flags=%"UVxf")",
4823 (UV)SvFLAGS(referrer));
4831 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4836 =for apidoc sv_insert
4838 Inserts a string at the specified offset/length within the SV. Similar to
4839 the Perl substr() function.
4845 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4850 register char *midend;
4851 register char *bigend;
4857 Perl_croak(aTHX_ "Can't modify non-existent substring");
4858 SvPV_force(bigstr, curlen);
4859 (void)SvPOK_only_UTF8(bigstr);
4860 if (offset + len > curlen) {
4861 SvGROW(bigstr, offset+len+1);
4862 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4863 SvCUR_set(bigstr, offset+len);
4867 i = littlelen - len;
4868 if (i > 0) { /* string might grow */
4869 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4870 mid = big + offset + len;
4871 midend = bigend = big + SvCUR(bigstr);
4874 while (midend > mid) /* shove everything down */
4875 *--bigend = *--midend;
4876 Move(little,big+offset,littlelen,char);
4877 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4882 Move(little,SvPVX(bigstr)+offset,len,char);
4887 big = SvPVX(bigstr);
4890 bigend = big + SvCUR(bigstr);
4892 if (midend > bigend)
4893 Perl_croak(aTHX_ "panic: sv_insert");
4895 if (mid - big > bigend - midend) { /* faster to shorten from end */
4897 Move(little, mid, littlelen,char);
4900 i = bigend - midend;
4902 Move(midend, mid, i,char);
4906 SvCUR_set(bigstr, mid - big);
4908 else if ((i = mid - big)) { /* faster from front */
4909 midend -= littlelen;
4911 sv_chop(bigstr,midend-i);
4916 Move(little, mid, littlelen,char);
4918 else if (littlelen) {
4919 midend -= littlelen;
4920 sv_chop(bigstr,midend);
4921 Move(little,midend,littlelen,char);
4924 sv_chop(bigstr,midend);
4930 =for apidoc sv_replace
4932 Make the first argument a copy of the second, then delete the original.
4933 The target SV physically takes over ownership of the body of the source SV
4934 and inherits its flags; however, the target keeps any magic it owns,
4935 and any magic in the source is discarded.
4936 Note that this is a rather specialist SV copying operation; most of the
4937 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4943 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4946 const U32 refcnt = SvREFCNT(sv);
4947 SV_CHECK_THINKFIRST_COW_DROP(sv);
4948 if (SvREFCNT(nsv) != 1) {
4949 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4950 UVuf " != 1)", (UV) SvREFCNT(nsv));
4952 if (SvMAGICAL(sv)) {
4956 sv_upgrade(nsv, SVt_PVMG);
4957 SvMAGIC_set(nsv, SvMAGIC(sv));
4958 SvFLAGS(nsv) |= SvMAGICAL(sv);
4960 SvMAGIC_set(sv, NULL);
4964 assert(!SvREFCNT(sv));
4965 #ifdef DEBUG_LEAKING_SCALARS
4966 sv->sv_flags = nsv->sv_flags;
4967 sv->sv_any = nsv->sv_any;
4968 sv->sv_refcnt = nsv->sv_refcnt;
4969 sv->sv_u = nsv->sv_u;
4971 StructCopy(nsv,sv,SV);
4973 /* Currently could join these into one piece of pointer arithmetic, but
4974 it would be unclear. */
4975 if(SvTYPE(sv) == SVt_IV)
4977 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
4978 else if (SvTYPE(sv) == SVt_RV) {
4979 SvANY(sv) = &sv->sv_u.svu_rv;
4983 #ifdef PERL_OLD_COPY_ON_WRITE
4984 if (SvIsCOW_normal(nsv)) {
4985 /* We need to follow the pointers around the loop to make the
4986 previous SV point to sv, rather than nsv. */
4989 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
4992 assert(SvPVX_const(current) == SvPVX_const(nsv));
4994 /* Make the SV before us point to the SV after us. */
4996 PerlIO_printf(Perl_debug_log, "previous is\n");
4998 PerlIO_printf(Perl_debug_log,
4999 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5000 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5002 SV_COW_NEXT_SV_SET(current, sv);
5005 SvREFCNT(sv) = refcnt;
5006 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5012 =for apidoc sv_clear
5014 Clear an SV: call any destructors, free up any memory used by the body,
5015 and free the body itself. The SV's head is I<not> freed, although
5016 its type is set to all 1's so that it won't inadvertently be assumed
5017 to be live during global destruction etc.
5018 This function should only be called when REFCNT is zero. Most of the time
5019 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5026 Perl_sv_clear(pTHX_ register SV *sv)
5029 const U32 type = SvTYPE(sv);
5030 const struct body_details *const sv_type_details
5031 = bodies_by_type + type;
5034 assert(SvREFCNT(sv) == 0);
5036 if (type <= SVt_IV) {
5037 /* See the comment in sv.h about the collusion between this early
5038 return and the overloading of the NULL and IV slots in the size
5044 if (PL_defstash) { /* Still have a symbol table? */
5049 stash = SvSTASH(sv);
5050 destructor = StashHANDLER(stash,DESTROY);
5052 SV* const tmpref = newRV(sv);
5053 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5055 PUSHSTACKi(PERLSI_DESTROY);
5060 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5066 if(SvREFCNT(tmpref) < 2) {
5067 /* tmpref is not kept alive! */
5069 SvRV_set(tmpref, NULL);
5072 SvREFCNT_dec(tmpref);
5074 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5078 if (PL_in_clean_objs)
5079 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5081 /* DESTROY gave object new lease on life */
5087 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5088 SvOBJECT_off(sv); /* Curse the object. */
5089 if (type != SVt_PVIO)
5090 --PL_sv_objcount; /* XXX Might want something more general */
5093 if (type >= SVt_PVMG) {
5094 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5095 SvREFCNT_dec(SvOURSTASH(sv));
5096 } else if (SvMAGIC(sv))
5098 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5099 SvREFCNT_dec(SvSTASH(sv));
5102 /* case SVt_BIND: */
5105 IoIFP(sv) != PerlIO_stdin() &&
5106 IoIFP(sv) != PerlIO_stdout() &&
5107 IoIFP(sv) != PerlIO_stderr())
5109 io_close((IO*)sv, FALSE);
5111 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5112 PerlDir_close(IoDIRP(sv));
5113 IoDIRP(sv) = (DIR*)NULL;
5114 Safefree(IoTOP_NAME(sv));
5115 Safefree(IoFMT_NAME(sv));
5116 Safefree(IoBOTTOM_NAME(sv));
5123 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5130 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5131 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5132 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5133 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5135 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5136 SvREFCNT_dec(LvTARG(sv));
5138 if (isGV_with_GP(sv)) {
5141 unshare_hek(GvNAME_HEK(sv));
5142 /* If we're in a stash, we don't own a reference to it. However it does
5143 have a back reference to us, which needs to be cleared. */
5144 if (!SvVALID(sv) && GvSTASH(sv))
5145 sv_del_backref((SV*)GvSTASH(sv), sv);
5147 /* FIXME. There are probably more unreferenced pointers to SVs in the
5148 interpreter struct that we should check and tidy in a similar
5150 if ((GV*)sv == PL_last_in_gv)
5151 PL_last_in_gv = NULL;
5156 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5158 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5159 /* Don't even bother with turning off the OOK flag. */
5164 SV * const target = SvRV(sv);
5166 sv_del_backref(target, sv);
5168 SvREFCNT_dec(target);
5170 #ifdef PERL_OLD_COPY_ON_WRITE
5171 else if (SvPVX_const(sv)) {
5173 /* I believe I need to grab the global SV mutex here and
5174 then recheck the COW status. */
5176 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5180 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5182 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5185 /* And drop it here. */
5187 } else if (SvLEN(sv)) {
5188 Safefree(SvPVX_const(sv));
5192 else if (SvPVX_const(sv) && SvLEN(sv))
5193 Safefree(SvPVX_mutable(sv));
5194 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5195 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5204 SvFLAGS(sv) &= SVf_BREAK;
5205 SvFLAGS(sv) |= SVTYPEMASK;
5207 if (sv_type_details->arena) {
5208 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5209 &PL_body_roots[type]);
5211 else if (sv_type_details->body_size) {
5212 my_safefree(SvANY(sv));
5217 =for apidoc sv_newref
5219 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5226 Perl_sv_newref(pTHX_ SV *sv)
5228 PERL_UNUSED_CONTEXT;
5237 Decrement an SV's reference count, and if it drops to zero, call
5238 C<sv_clear> to invoke destructors and free up any memory used by
5239 the body; finally, deallocate the SV's head itself.
5240 Normally called via a wrapper macro C<SvREFCNT_dec>.
5246 Perl_sv_free(pTHX_ SV *sv)
5251 if (SvREFCNT(sv) == 0) {
5252 if (SvFLAGS(sv) & SVf_BREAK)
5253 /* this SV's refcnt has been artificially decremented to
5254 * trigger cleanup */
5256 if (PL_in_clean_all) /* All is fair */
5258 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5259 /* make sure SvREFCNT(sv)==0 happens very seldom */
5260 SvREFCNT(sv) = (~(U32)0)/2;
5263 if (ckWARN_d(WARN_INTERNAL)) {
5264 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5265 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5266 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5267 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5268 Perl_dump_sv_child(aTHX_ sv);
5273 if (--(SvREFCNT(sv)) > 0)
5275 Perl_sv_free2(aTHX_ sv);
5279 Perl_sv_free2(pTHX_ SV *sv)
5284 if (ckWARN_d(WARN_DEBUGGING))
5285 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5286 "Attempt to free temp prematurely: SV 0x%"UVxf
5287 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5291 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5292 /* make sure SvREFCNT(sv)==0 happens very seldom */
5293 SvREFCNT(sv) = (~(U32)0)/2;
5304 Returns the length of the string in the SV. Handles magic and type
5305 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5311 Perl_sv_len(pTHX_ register SV *sv)
5319 len = mg_length(sv);
5321 (void)SvPV_const(sv, len);
5326 =for apidoc sv_len_utf8
5328 Returns the number of characters in the string in an SV, counting wide
5329 UTF-8 bytes as a single character. Handles magic and type coercion.
5335 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5336 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5337 * (Note that the mg_len is not the length of the mg_ptr field.
5338 * This allows the cache to store the character length of the string without
5339 * needing to malloc() extra storage to attach to the mg_ptr.)
5344 Perl_sv_len_utf8(pTHX_ register SV *sv)
5350 return mg_length(sv);
5354 const U8 *s = (U8*)SvPV_const(sv, len);
5358 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5360 if (mg && mg->mg_len != -1) {
5362 if (PL_utf8cache < 0) {
5363 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5365 /* Need to turn the assertions off otherwise we may
5366 recurse infinitely while printing error messages.
5368 SAVEI8(PL_utf8cache);
5370 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5371 " real %"UVuf" for %"SVf,
5372 (UV) ulen, (UV) real, SVfARG(sv));
5377 ulen = Perl_utf8_length(aTHX_ s, s + len);
5378 if (!SvREADONLY(sv)) {
5380 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5381 &PL_vtbl_utf8, 0, 0);
5389 return Perl_utf8_length(aTHX_ s, s + len);
5393 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5396 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5399 const U8 *s = start;
5401 while (s < send && uoffset--)
5404 /* This is the existing behaviour. Possibly it should be a croak, as
5405 it's actually a bounds error */
5411 /* Given the length of the string in both bytes and UTF-8 characters, decide
5412 whether to walk forwards or backwards to find the byte corresponding to
5413 the passed in UTF-8 offset. */
5415 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5416 STRLEN uoffset, STRLEN uend)
5418 STRLEN backw = uend - uoffset;
5419 if (uoffset < 2 * backw) {
5420 /* The assumption is that going forwards is twice the speed of going
5421 forward (that's where the 2 * backw comes from).
5422 (The real figure of course depends on the UTF-8 data.) */
5423 return sv_pos_u2b_forwards(start, send, uoffset);
5428 while (UTF8_IS_CONTINUATION(*send))
5431 return send - start;
5434 /* For the string representation of the given scalar, find the byte
5435 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5436 give another position in the string, *before* the sought offset, which
5437 (which is always true, as 0, 0 is a valid pair of positions), which should
5438 help reduce the amount of linear searching.
5439 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5440 will be used to reduce the amount of linear searching. The cache will be
5441 created if necessary, and the found value offered to it for update. */
5443 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5444 const U8 *const send, STRLEN uoffset,
5445 STRLEN uoffset0, STRLEN boffset0) {
5446 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5449 assert (uoffset >= uoffset0);
5451 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5452 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5453 if ((*mgp)->mg_ptr) {
5454 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5455 if (cache[0] == uoffset) {
5456 /* An exact match. */
5459 if (cache[2] == uoffset) {
5460 /* An exact match. */
5464 if (cache[0] < uoffset) {
5465 /* The cache already knows part of the way. */
5466 if (cache[0] > uoffset0) {
5467 /* The cache knows more than the passed in pair */
5468 uoffset0 = cache[0];
5469 boffset0 = cache[1];
5471 if ((*mgp)->mg_len != -1) {
5472 /* And we know the end too. */
5474 + sv_pos_u2b_midway(start + boffset0, send,
5476 (*mgp)->mg_len - uoffset0);
5479 + sv_pos_u2b_forwards(start + boffset0,
5480 send, uoffset - uoffset0);
5483 else if (cache[2] < uoffset) {
5484 /* We're between the two cache entries. */
5485 if (cache[2] > uoffset0) {
5486 /* and the cache knows more than the passed in pair */
5487 uoffset0 = cache[2];
5488 boffset0 = cache[3];
5492 + sv_pos_u2b_midway(start + boffset0,
5495 cache[0] - uoffset0);
5498 + sv_pos_u2b_midway(start + boffset0,
5501 cache[2] - uoffset0);
5505 else if ((*mgp)->mg_len != -1) {
5506 /* If we can take advantage of a passed in offset, do so. */
5507 /* In fact, offset0 is either 0, or less than offset, so don't
5508 need to worry about the other possibility. */
5510 + sv_pos_u2b_midway(start + boffset0, send,
5512 (*mgp)->mg_len - uoffset0);
5517 if (!found || PL_utf8cache < 0) {
5518 const STRLEN real_boffset
5519 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5520 send, uoffset - uoffset0);
5522 if (found && PL_utf8cache < 0) {
5523 if (real_boffset != boffset) {
5524 /* Need to turn the assertions off otherwise we may recurse
5525 infinitely while printing error messages. */
5526 SAVEI8(PL_utf8cache);
5528 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5529 " real %"UVuf" for %"SVf,
5530 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5533 boffset = real_boffset;
5536 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5542 =for apidoc sv_pos_u2b
5544 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5545 the start of the string, to a count of the equivalent number of bytes; if
5546 lenp is non-zero, it does the same to lenp, but this time starting from
5547 the offset, rather than from the start of the string. Handles magic and
5554 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5555 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5556 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5561 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5569 start = (U8*)SvPV_const(sv, len);
5571 STRLEN uoffset = (STRLEN) *offsetp;
5572 const U8 * const send = start + len;
5574 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5577 *offsetp = (I32) boffset;
5580 /* Convert the relative offset to absolute. */
5581 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5582 const STRLEN boffset2
5583 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5584 uoffset, boffset) - boffset;
5598 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5599 byte length pairing. The (byte) length of the total SV is passed in too,
5600 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5601 may not have updated SvCUR, so we can't rely on reading it directly.
5603 The proffered utf8/byte length pairing isn't used if the cache already has
5604 two pairs, and swapping either for the proffered pair would increase the
5605 RMS of the intervals between known byte offsets.
5607 The cache itself consists of 4 STRLEN values
5608 0: larger UTF-8 offset
5609 1: corresponding byte offset
5610 2: smaller UTF-8 offset
5611 3: corresponding byte offset
5613 Unused cache pairs have the value 0, 0.
5614 Keeping the cache "backwards" means that the invariant of
5615 cache[0] >= cache[2] is maintained even with empty slots, which means that
5616 the code that uses it doesn't need to worry if only 1 entry has actually
5617 been set to non-zero. It also makes the "position beyond the end of the
5618 cache" logic much simpler, as the first slot is always the one to start
5622 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5630 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5632 (*mgp)->mg_len = -1;
5636 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5637 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5638 (*mgp)->mg_ptr = (char *) cache;
5642 if (PL_utf8cache < 0) {
5643 const U8 *start = (const U8 *) SvPVX_const(sv);
5644 const STRLEN realutf8 = utf8_length(start, start + byte);
5646 if (realutf8 != utf8) {
5647 /* Need to turn the assertions off otherwise we may recurse
5648 infinitely while printing error messages. */
5649 SAVEI8(PL_utf8cache);
5651 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5652 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5656 /* Cache is held with the later position first, to simplify the code
5657 that deals with unbounded ends. */
5659 ASSERT_UTF8_CACHE(cache);
5660 if (cache[1] == 0) {
5661 /* Cache is totally empty */
5664 } else if (cache[3] == 0) {
5665 if (byte > cache[1]) {
5666 /* New one is larger, so goes first. */
5667 cache[2] = cache[0];
5668 cache[3] = cache[1];
5676 #define THREEWAY_SQUARE(a,b,c,d) \
5677 ((float)((d) - (c))) * ((float)((d) - (c))) \
5678 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5679 + ((float)((b) - (a))) * ((float)((b) - (a)))
5681 /* Cache has 2 slots in use, and we know three potential pairs.
5682 Keep the two that give the lowest RMS distance. Do the
5683 calcualation in bytes simply because we always know the byte
5684 length. squareroot has the same ordering as the positive value,
5685 so don't bother with the actual square root. */
5686 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5687 if (byte > cache[1]) {
5688 /* New position is after the existing pair of pairs. */
5689 const float keep_earlier
5690 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5691 const float keep_later
5692 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5694 if (keep_later < keep_earlier) {
5695 if (keep_later < existing) {
5696 cache[2] = cache[0];
5697 cache[3] = cache[1];
5703 if (keep_earlier < existing) {
5709 else if (byte > cache[3]) {
5710 /* New position is between the existing pair of pairs. */
5711 const float keep_earlier
5712 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5713 const float keep_later
5714 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5716 if (keep_later < keep_earlier) {
5717 if (keep_later < existing) {
5723 if (keep_earlier < existing) {
5730 /* New position is before the existing pair of pairs. */
5731 const float keep_earlier
5732 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5733 const float keep_later
5734 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5736 if (keep_later < keep_earlier) {
5737 if (keep_later < existing) {
5743 if (keep_earlier < existing) {
5744 cache[0] = cache[2];
5745 cache[1] = cache[3];
5752 ASSERT_UTF8_CACHE(cache);
5755 /* We already know all of the way, now we may be able to walk back. The same
5756 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5757 backward is half the speed of walking forward. */
5759 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5762 const STRLEN forw = target - s;
5763 STRLEN backw = end - target;
5765 if (forw < 2 * backw) {
5766 return utf8_length(s, target);
5769 while (end > target) {
5771 while (UTF8_IS_CONTINUATION(*end)) {
5780 =for apidoc sv_pos_b2u
5782 Converts the value pointed to by offsetp from a count of bytes from the
5783 start of the string, to a count of the equivalent number of UTF-8 chars.
5784 Handles magic and type coercion.
5790 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5791 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5796 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5799 const STRLEN byte = *offsetp;
5800 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5809 s = (const U8*)SvPV_const(sv, blen);
5812 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5816 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5817 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5819 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5820 if (cache[1] == byte) {
5821 /* An exact match. */
5822 *offsetp = cache[0];
5825 if (cache[3] == byte) {
5826 /* An exact match. */
5827 *offsetp = cache[2];
5831 if (cache[1] < byte) {
5832 /* We already know part of the way. */
5833 if (mg->mg_len != -1) {
5834 /* Actually, we know the end too. */
5836 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5837 s + blen, mg->mg_len - cache[0]);
5839 len = cache[0] + utf8_length(s + cache[1], send);
5842 else if (cache[3] < byte) {
5843 /* We're between the two cached pairs, so we do the calculation
5844 offset by the byte/utf-8 positions for the earlier pair,
5845 then add the utf-8 characters from the string start to
5847 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5848 s + cache[1], cache[0] - cache[2])
5852 else { /* cache[3] > byte */
5853 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5857 ASSERT_UTF8_CACHE(cache);
5859 } else if (mg->mg_len != -1) {
5860 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5864 if (!found || PL_utf8cache < 0) {
5865 const STRLEN real_len = utf8_length(s, send);
5867 if (found && PL_utf8cache < 0) {
5868 if (len != real_len) {
5869 /* Need to turn the assertions off otherwise we may recurse
5870 infinitely while printing error messages. */
5871 SAVEI8(PL_utf8cache);
5873 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5874 " real %"UVuf" for %"SVf,
5875 (UV) len, (UV) real_len, SVfARG(sv));
5882 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5888 Returns a boolean indicating whether the strings in the two SVs are
5889 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5890 coerce its args to strings if necessary.
5896 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5905 SV* svrecode = NULL;
5912 /* if pv1 and pv2 are the same, second SvPV_const call may
5913 * invalidate pv1, so we may need to make a copy */
5914 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5915 pv1 = SvPV_const(sv1, cur1);
5916 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5917 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5919 pv1 = SvPV_const(sv1, cur1);
5927 pv2 = SvPV_const(sv2, cur2);
5929 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
5930 /* Differing utf8ness.
5931 * Do not UTF8size the comparands as a side-effect. */
5934 svrecode = newSVpvn(pv2, cur2);
5935 sv_recode_to_utf8(svrecode, PL_encoding);
5936 pv2 = SvPV_const(svrecode, cur2);
5939 svrecode = newSVpvn(pv1, cur1);
5940 sv_recode_to_utf8(svrecode, PL_encoding);
5941 pv1 = SvPV_const(svrecode, cur1);
5943 /* Now both are in UTF-8. */
5945 SvREFCNT_dec(svrecode);
5950 bool is_utf8 = TRUE;
5953 /* sv1 is the UTF-8 one,
5954 * if is equal it must be downgrade-able */
5955 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
5961 /* sv2 is the UTF-8 one,
5962 * if is equal it must be downgrade-able */
5963 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
5969 /* Downgrade not possible - cannot be eq */
5977 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
5979 SvREFCNT_dec(svrecode);
5989 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5990 string in C<sv1> is less than, equal to, or greater than the string in
5991 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5992 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
5998 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6002 const char *pv1, *pv2;
6005 SV *svrecode = NULL;
6012 pv1 = SvPV_const(sv1, cur1);
6019 pv2 = SvPV_const(sv2, cur2);
6021 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6022 /* Differing utf8ness.
6023 * Do not UTF8size the comparands as a side-effect. */
6026 svrecode = newSVpvn(pv2, cur2);
6027 sv_recode_to_utf8(svrecode, PL_encoding);
6028 pv2 = SvPV_const(svrecode, cur2);
6031 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6036 svrecode = newSVpvn(pv1, cur1);
6037 sv_recode_to_utf8(svrecode, PL_encoding);
6038 pv1 = SvPV_const(svrecode, cur1);
6041 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6047 cmp = cur2 ? -1 : 0;
6051 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6054 cmp = retval < 0 ? -1 : 1;
6055 } else if (cur1 == cur2) {
6058 cmp = cur1 < cur2 ? -1 : 1;
6062 SvREFCNT_dec(svrecode);
6070 =for apidoc sv_cmp_locale
6072 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6073 'use bytes' aware, handles get magic, and will coerce its args to strings
6074 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6080 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6083 #ifdef USE_LOCALE_COLLATE
6089 if (PL_collation_standard)
6093 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6095 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6097 if (!pv1 || !len1) {
6108 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6111 return retval < 0 ? -1 : 1;
6114 * When the result of collation is equality, that doesn't mean
6115 * that there are no differences -- some locales exclude some
6116 * characters from consideration. So to avoid false equalities,
6117 * we use the raw string as a tiebreaker.
6123 #endif /* USE_LOCALE_COLLATE */
6125 return sv_cmp(sv1, sv2);
6129 #ifdef USE_LOCALE_COLLATE
6132 =for apidoc sv_collxfrm
6134 Add Collate Transform magic to an SV if it doesn't already have it.
6136 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6137 scalar data of the variable, but transformed to such a format that a normal
6138 memory comparison can be used to compare the data according to the locale
6145 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6150 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6151 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6157 Safefree(mg->mg_ptr);
6158 s = SvPV_const(sv, len);
6159 if ((xf = mem_collxfrm(s, len, &xlen))) {
6160 if (SvREADONLY(sv)) {
6163 return xf + sizeof(PL_collation_ix);
6166 #ifdef PERL_OLD_COPY_ON_WRITE
6168 sv_force_normal_flags(sv, 0);
6170 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6184 if (mg && mg->mg_ptr) {
6186 return mg->mg_ptr + sizeof(PL_collation_ix);
6194 #endif /* USE_LOCALE_COLLATE */
6199 Get a line from the filehandle and store it into the SV, optionally
6200 appending to the currently-stored string.
6206 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6211 register STDCHAR rslast;
6212 register STDCHAR *bp;
6217 if (SvTHINKFIRST(sv))
6218 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6219 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6221 However, perlbench says it's slower, because the existing swipe code
6222 is faster than copy on write.
6223 Swings and roundabouts. */
6224 SvUPGRADE(sv, SVt_PV);
6229 if (PerlIO_isutf8(fp)) {
6231 sv_utf8_upgrade_nomg(sv);
6232 sv_pos_u2b(sv,&append,0);
6234 } else if (SvUTF8(sv)) {
6235 SV * const tsv = newSV(0);
6236 sv_gets(tsv, fp, 0);
6237 sv_utf8_upgrade_nomg(tsv);
6238 SvCUR_set(sv,append);
6241 goto return_string_or_null;
6246 if (PerlIO_isutf8(fp))
6249 if (IN_PERL_COMPILETIME) {
6250 /* we always read code in line mode */
6254 else if (RsSNARF(PL_rs)) {
6255 /* If it is a regular disk file use size from stat() as estimate
6256 of amount we are going to read -- may result in mallocing
6257 more memory than we really need if the layers below reduce
6258 the size we read (e.g. CRLF or a gzip layer).
6261 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6262 const Off_t offset = PerlIO_tell(fp);
6263 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6264 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6270 else if (RsRECORD(PL_rs)) {
6275 /* Grab the size of the record we're getting */
6276 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6277 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6280 /* VMS wants read instead of fread, because fread doesn't respect */
6281 /* RMS record boundaries. This is not necessarily a good thing to be */
6282 /* doing, but we've got no other real choice - except avoid stdio
6283 as implementation - perhaps write a :vms layer ?
6285 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6287 bytesread = PerlIO_read(fp, buffer, recsize);
6291 SvCUR_set(sv, bytesread += append);
6292 buffer[bytesread] = '\0';
6293 goto return_string_or_null;
6295 else if (RsPARA(PL_rs)) {
6301 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6302 if (PerlIO_isutf8(fp)) {
6303 rsptr = SvPVutf8(PL_rs, rslen);
6306 if (SvUTF8(PL_rs)) {
6307 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6308 Perl_croak(aTHX_ "Wide character in $/");
6311 rsptr = SvPV_const(PL_rs, rslen);
6315 rslast = rslen ? rsptr[rslen - 1] : '\0';
6317 if (rspara) { /* have to do this both before and after */
6318 do { /* to make sure file boundaries work right */
6321 i = PerlIO_getc(fp);
6325 PerlIO_ungetc(fp,i);
6331 /* See if we know enough about I/O mechanism to cheat it ! */
6333 /* This used to be #ifdef test - it is made run-time test for ease
6334 of abstracting out stdio interface. One call should be cheap
6335 enough here - and may even be a macro allowing compile
6339 if (PerlIO_fast_gets(fp)) {
6342 * We're going to steal some values from the stdio struct
6343 * and put EVERYTHING in the innermost loop into registers.
6345 register STDCHAR *ptr;
6349 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6350 /* An ungetc()d char is handled separately from the regular
6351 * buffer, so we getc() it back out and stuff it in the buffer.
6353 i = PerlIO_getc(fp);
6354 if (i == EOF) return 0;
6355 *(--((*fp)->_ptr)) = (unsigned char) i;
6359 /* Here is some breathtakingly efficient cheating */
6361 cnt = PerlIO_get_cnt(fp); /* get count into register */
6362 /* make sure we have the room */
6363 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6364 /* Not room for all of it
6365 if we are looking for a separator and room for some
6367 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6368 /* just process what we have room for */
6369 shortbuffered = cnt - SvLEN(sv) + append + 1;
6370 cnt -= shortbuffered;
6374 /* remember that cnt can be negative */
6375 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6380 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6381 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6382 DEBUG_P(PerlIO_printf(Perl_debug_log,
6383 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6384 DEBUG_P(PerlIO_printf(Perl_debug_log,
6385 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6386 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6387 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6392 while (cnt > 0) { /* this | eat */
6394 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6395 goto thats_all_folks; /* screams | sed :-) */
6399 Copy(ptr, bp, cnt, char); /* this | eat */
6400 bp += cnt; /* screams | dust */
6401 ptr += cnt; /* louder | sed :-) */
6406 if (shortbuffered) { /* oh well, must extend */
6407 cnt = shortbuffered;
6409 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6411 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6412 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6416 DEBUG_P(PerlIO_printf(Perl_debug_log,
6417 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6418 PTR2UV(ptr),(long)cnt));
6419 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6421 DEBUG_P(PerlIO_printf(Perl_debug_log,
6422 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6423 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6424 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6426 /* This used to call 'filbuf' in stdio form, but as that behaves like
6427 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6428 another abstraction. */
6429 i = PerlIO_getc(fp); /* get more characters */
6431 DEBUG_P(PerlIO_printf(Perl_debug_log,
6432 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6433 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6434 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6436 cnt = PerlIO_get_cnt(fp);
6437 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6438 DEBUG_P(PerlIO_printf(Perl_debug_log,
6439 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6441 if (i == EOF) /* all done for ever? */
6442 goto thats_really_all_folks;
6444 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6446 SvGROW(sv, bpx + cnt + 2);
6447 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6449 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6451 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6452 goto thats_all_folks;
6456 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6457 memNE((char*)bp - rslen, rsptr, rslen))
6458 goto screamer; /* go back to the fray */
6459 thats_really_all_folks:
6461 cnt += shortbuffered;
6462 DEBUG_P(PerlIO_printf(Perl_debug_log,
6463 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6464 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6465 DEBUG_P(PerlIO_printf(Perl_debug_log,
6466 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6467 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6468 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6470 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6471 DEBUG_P(PerlIO_printf(Perl_debug_log,
6472 "Screamer: done, len=%ld, string=|%.*s|\n",
6473 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6477 /*The big, slow, and stupid way. */
6478 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6479 STDCHAR *buf = NULL;
6480 Newx(buf, 8192, STDCHAR);
6488 register const STDCHAR * const bpe = buf + sizeof(buf);
6490 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6491 ; /* keep reading */
6495 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6496 /* Accomodate broken VAXC compiler, which applies U8 cast to
6497 * both args of ?: operator, causing EOF to change into 255
6500 i = (U8)buf[cnt - 1];
6506 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6508 sv_catpvn(sv, (char *) buf, cnt);
6510 sv_setpvn(sv, (char *) buf, cnt);
6512 if (i != EOF && /* joy */
6514 SvCUR(sv) < rslen ||
6515 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6519 * If we're reading from a TTY and we get a short read,
6520 * indicating that the user hit his EOF character, we need
6521 * to notice it now, because if we try to read from the TTY
6522 * again, the EOF condition will disappear.
6524 * The comparison of cnt to sizeof(buf) is an optimization
6525 * that prevents unnecessary calls to feof().
6529 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6533 #ifdef USE_HEAP_INSTEAD_OF_STACK
6538 if (rspara) { /* have to do this both before and after */
6539 while (i != EOF) { /* to make sure file boundaries work right */
6540 i = PerlIO_getc(fp);
6542 PerlIO_ungetc(fp,i);
6548 return_string_or_null:
6549 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6555 Auto-increment of the value in the SV, doing string to numeric conversion
6556 if necessary. Handles 'get' magic.
6562 Perl_sv_inc(pTHX_ register SV *sv)
6571 if (SvTHINKFIRST(sv)) {
6573 sv_force_normal_flags(sv, 0);
6574 if (SvREADONLY(sv)) {
6575 if (IN_PERL_RUNTIME)
6576 Perl_croak(aTHX_ PL_no_modify);
6580 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6582 i = PTR2IV(SvRV(sv));
6587 flags = SvFLAGS(sv);
6588 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6589 /* It's (privately or publicly) a float, but not tested as an
6590 integer, so test it to see. */
6592 flags = SvFLAGS(sv);
6594 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6595 /* It's publicly an integer, or privately an integer-not-float */
6596 #ifdef PERL_PRESERVE_IVUV
6600 if (SvUVX(sv) == UV_MAX)
6601 sv_setnv(sv, UV_MAX_P1);
6603 (void)SvIOK_only_UV(sv);
6604 SvUV_set(sv, SvUVX(sv) + 1);
6606 if (SvIVX(sv) == IV_MAX)
6607 sv_setuv(sv, (UV)IV_MAX + 1);
6609 (void)SvIOK_only(sv);
6610 SvIV_set(sv, SvIVX(sv) + 1);
6615 if (flags & SVp_NOK) {
6616 (void)SvNOK_only(sv);
6617 SvNV_set(sv, SvNVX(sv) + 1.0);
6621 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6622 if ((flags & SVTYPEMASK) < SVt_PVIV)
6623 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6624 (void)SvIOK_only(sv);
6629 while (isALPHA(*d)) d++;
6630 while (isDIGIT(*d)) d++;
6632 #ifdef PERL_PRESERVE_IVUV
6633 /* Got to punt this as an integer if needs be, but we don't issue
6634 warnings. Probably ought to make the sv_iv_please() that does
6635 the conversion if possible, and silently. */
6636 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6637 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6638 /* Need to try really hard to see if it's an integer.
6639 9.22337203685478e+18 is an integer.
6640 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6641 so $a="9.22337203685478e+18"; $a+0; $a++
6642 needs to be the same as $a="9.22337203685478e+18"; $a++
6649 /* sv_2iv *should* have made this an NV */
6650 if (flags & SVp_NOK) {
6651 (void)SvNOK_only(sv);
6652 SvNV_set(sv, SvNVX(sv) + 1.0);
6655 /* I don't think we can get here. Maybe I should assert this
6656 And if we do get here I suspect that sv_setnv will croak. NWC
6658 #if defined(USE_LONG_DOUBLE)
6659 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",
6660 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6662 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6663 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6666 #endif /* PERL_PRESERVE_IVUV */
6667 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6671 while (d >= SvPVX_const(sv)) {
6679 /* MKS: The original code here died if letters weren't consecutive.
6680 * at least it didn't have to worry about non-C locales. The
6681 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6682 * arranged in order (although not consecutively) and that only
6683 * [A-Za-z] are accepted by isALPHA in the C locale.
6685 if (*d != 'z' && *d != 'Z') {
6686 do { ++*d; } while (!isALPHA(*d));
6689 *(d--) -= 'z' - 'a';
6694 *(d--) -= 'z' - 'a' + 1;
6698 /* oh,oh, the number grew */
6699 SvGROW(sv, SvCUR(sv) + 2);
6700 SvCUR_set(sv, SvCUR(sv) + 1);
6701 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6712 Auto-decrement of the value in the SV, doing string to numeric conversion
6713 if necessary. Handles 'get' magic.
6719 Perl_sv_dec(pTHX_ register SV *sv)
6727 if (SvTHINKFIRST(sv)) {
6729 sv_force_normal_flags(sv, 0);
6730 if (SvREADONLY(sv)) {
6731 if (IN_PERL_RUNTIME)
6732 Perl_croak(aTHX_ PL_no_modify);
6736 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6738 i = PTR2IV(SvRV(sv));
6743 /* Unlike sv_inc we don't have to worry about string-never-numbers
6744 and keeping them magic. But we mustn't warn on punting */
6745 flags = SvFLAGS(sv);
6746 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6747 /* It's publicly an integer, or privately an integer-not-float */
6748 #ifdef PERL_PRESERVE_IVUV
6752 if (SvUVX(sv) == 0) {
6753 (void)SvIOK_only(sv);
6757 (void)SvIOK_only_UV(sv);
6758 SvUV_set(sv, SvUVX(sv) - 1);
6761 if (SvIVX(sv) == IV_MIN)
6762 sv_setnv(sv, (NV)IV_MIN - 1.0);
6764 (void)SvIOK_only(sv);
6765 SvIV_set(sv, SvIVX(sv) - 1);
6770 if (flags & SVp_NOK) {
6771 SvNV_set(sv, SvNVX(sv) - 1.0);
6772 (void)SvNOK_only(sv);
6775 if (!(flags & SVp_POK)) {
6776 if ((flags & SVTYPEMASK) < SVt_PVIV)
6777 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6779 (void)SvIOK_only(sv);
6782 #ifdef PERL_PRESERVE_IVUV
6784 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6785 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6786 /* Need to try really hard to see if it's an integer.
6787 9.22337203685478e+18 is an integer.
6788 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6789 so $a="9.22337203685478e+18"; $a+0; $a--
6790 needs to be the same as $a="9.22337203685478e+18"; $a--
6797 /* sv_2iv *should* have made this an NV */
6798 if (flags & SVp_NOK) {
6799 (void)SvNOK_only(sv);
6800 SvNV_set(sv, SvNVX(sv) - 1.0);
6803 /* I don't think we can get here. Maybe I should assert this
6804 And if we do get here I suspect that sv_setnv will croak. NWC
6806 #if defined(USE_LONG_DOUBLE)
6807 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",
6808 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6810 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6811 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6815 #endif /* PERL_PRESERVE_IVUV */
6816 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6820 =for apidoc sv_mortalcopy
6822 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6823 The new SV is marked as mortal. It will be destroyed "soon", either by an
6824 explicit call to FREETMPS, or by an implicit call at places such as
6825 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6830 /* Make a string that will exist for the duration of the expression
6831 * evaluation. Actually, it may have to last longer than that, but
6832 * hopefully we won't free it until it has been assigned to a
6833 * permanent location. */
6836 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6842 sv_setsv(sv,oldstr);
6844 PL_tmps_stack[++PL_tmps_ix] = sv;
6850 =for apidoc sv_newmortal
6852 Creates a new null SV which is mortal. The reference count of the SV is
6853 set to 1. It will be destroyed "soon", either by an explicit call to
6854 FREETMPS, or by an implicit call at places such as statement boundaries.
6855 See also C<sv_mortalcopy> and C<sv_2mortal>.
6861 Perl_sv_newmortal(pTHX)
6867 SvFLAGS(sv) = SVs_TEMP;
6869 PL_tmps_stack[++PL_tmps_ix] = sv;
6874 =for apidoc sv_2mortal
6876 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6877 by an explicit call to FREETMPS, or by an implicit call at places such as
6878 statement boundaries. SvTEMP() is turned on which means that the SV's
6879 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6880 and C<sv_mortalcopy>.
6886 Perl_sv_2mortal(pTHX_ register SV *sv)
6891 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6894 PL_tmps_stack[++PL_tmps_ix] = sv;
6902 Creates a new SV and copies a string into it. The reference count for the
6903 SV is set to 1. If C<len> is zero, Perl will compute the length using
6904 strlen(). For efficiency, consider using C<newSVpvn> instead.
6910 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6916 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6921 =for apidoc newSVpvn
6923 Creates a new SV and copies a string into it. The reference count for the
6924 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6925 string. You are responsible for ensuring that the source string is at least
6926 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
6932 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
6938 sv_setpvn(sv,s,len);
6944 =for apidoc newSVhek
6946 Creates a new SV from the hash key structure. It will generate scalars that
6947 point to the shared string table where possible. Returns a new (undefined)
6948 SV if the hek is NULL.
6954 Perl_newSVhek(pTHX_ const HEK *hek)
6964 if (HEK_LEN(hek) == HEf_SVKEY) {
6965 return newSVsv(*(SV**)HEK_KEY(hek));
6967 const int flags = HEK_FLAGS(hek);
6968 if (flags & HVhek_WASUTF8) {
6970 Andreas would like keys he put in as utf8 to come back as utf8
6972 STRLEN utf8_len = HEK_LEN(hek);
6973 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
6974 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
6977 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
6979 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
6980 /* We don't have a pointer to the hv, so we have to replicate the
6981 flag into every HEK. This hv is using custom a hasing
6982 algorithm. Hence we can't return a shared string scalar, as
6983 that would contain the (wrong) hash value, and might get passed
6984 into an hv routine with a regular hash.
6985 Similarly, a hash that isn't using shared hash keys has to have
6986 the flag in every key so that we know not to try to call
6987 share_hek_kek on it. */
6989 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
6994 /* This will be overwhelminly the most common case. */
6996 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
6997 more efficient than sharepvn(). */
7001 sv_upgrade(sv, SVt_PV);
7002 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7003 SvCUR_set(sv, HEK_LEN(hek));
7016 =for apidoc newSVpvn_share
7018 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7019 table. If the string does not already exist in the table, it is created
7020 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7021 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7022 otherwise the hash is computed. The idea here is that as the string table
7023 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7024 hash lookup will avoid string compare.
7030 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7034 bool is_utf8 = FALSE;
7035 const char *const orig_src = src;
7038 STRLEN tmplen = -len;
7040 /* See the note in hv.c:hv_fetch() --jhi */
7041 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7045 PERL_HASH(hash, src, len);
7047 sv_upgrade(sv, SVt_PV);
7048 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7056 if (src != orig_src)
7062 #if defined(PERL_IMPLICIT_CONTEXT)
7064 /* pTHX_ magic can't cope with varargs, so this is a no-context
7065 * version of the main function, (which may itself be aliased to us).
7066 * Don't access this version directly.
7070 Perl_newSVpvf_nocontext(const char* pat, ...)
7075 va_start(args, pat);
7076 sv = vnewSVpvf(pat, &args);
7083 =for apidoc newSVpvf
7085 Creates a new SV and initializes it with the string formatted like
7092 Perl_newSVpvf(pTHX_ const char* pat, ...)
7096 va_start(args, pat);
7097 sv = vnewSVpvf(pat, &args);
7102 /* backend for newSVpvf() and newSVpvf_nocontext() */
7105 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7110 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7117 Creates a new SV and copies a floating point value into it.
7118 The reference count for the SV is set to 1.
7124 Perl_newSVnv(pTHX_ NV n)
7137 Creates a new SV and copies an integer into it. The reference count for the
7144 Perl_newSViv(pTHX_ IV i)
7157 Creates a new SV and copies an unsigned integer into it.
7158 The reference count for the SV is set to 1.
7164 Perl_newSVuv(pTHX_ UV u)
7175 =for apidoc newSV_type
7177 Creates a new SV, of the type specificied. The reference count for the new SV
7184 Perl_newSV_type(pTHX_ svtype type)
7189 sv_upgrade(sv, type);
7194 =for apidoc newRV_noinc
7196 Creates an RV wrapper for an SV. The reference count for the original
7197 SV is B<not> incremented.
7203 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7206 register SV *sv = newSV_type(SVt_RV);
7208 SvRV_set(sv, tmpRef);
7213 /* newRV_inc is the official function name to use now.
7214 * newRV_inc is in fact #defined to newRV in sv.h
7218 Perl_newRV(pTHX_ SV *sv)
7221 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7227 Creates a new SV which is an exact duplicate of the original SV.
7234 Perl_newSVsv(pTHX_ register SV *old)
7241 if (SvTYPE(old) == SVTYPEMASK) {
7242 if (ckWARN_d(WARN_INTERNAL))
7243 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7247 /* SV_GMAGIC is the default for sv_setv()
7248 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7249 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7250 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7255 =for apidoc sv_reset
7257 Underlying implementation for the C<reset> Perl function.
7258 Note that the perl-level function is vaguely deprecated.
7264 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7267 char todo[PERL_UCHAR_MAX+1];
7272 if (!*s) { /* reset ?? searches */
7273 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7275 const U32 count = mg->mg_len / sizeof(PMOP**);
7276 PMOP **pmp = (PMOP**) mg->mg_ptr;
7277 PMOP *const *const end = pmp + count;
7281 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7283 (*pmp)->op_pmflags &= ~PMf_USED;
7291 /* reset variables */
7293 if (!HvARRAY(stash))
7296 Zero(todo, 256, char);
7299 I32 i = (unsigned char)*s;
7303 max = (unsigned char)*s++;
7304 for ( ; i <= max; i++) {
7307 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7309 for (entry = HvARRAY(stash)[i];
7311 entry = HeNEXT(entry))
7316 if (!todo[(U8)*HeKEY(entry)])
7318 gv = (GV*)HeVAL(entry);
7321 if (SvTHINKFIRST(sv)) {
7322 if (!SvREADONLY(sv) && SvROK(sv))
7324 /* XXX Is this continue a bug? Why should THINKFIRST
7325 exempt us from resetting arrays and hashes? */
7329 if (SvTYPE(sv) >= SVt_PV) {
7331 if (SvPVX_const(sv) != NULL)
7339 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7341 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7344 # if defined(USE_ENVIRON_ARRAY)
7347 # endif /* USE_ENVIRON_ARRAY */
7358 Using various gambits, try to get an IO from an SV: the IO slot if its a
7359 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7360 named after the PV if we're a string.
7366 Perl_sv_2io(pTHX_ SV *sv)
7371 switch (SvTYPE(sv)) {
7379 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7383 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7385 return sv_2io(SvRV(sv));
7386 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7392 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7401 Using various gambits, try to get a CV from an SV; in addition, try if
7402 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7403 The flags in C<lref> are passed to sv_fetchsv.
7409 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7420 switch (SvTYPE(sv)) {
7439 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7440 tryAMAGICunDEREF(to_cv);
7443 if (SvTYPE(sv) == SVt_PVCV) {
7452 Perl_croak(aTHX_ "Not a subroutine reference");
7457 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7463 /* Some flags to gv_fetchsv mean don't really create the GV */
7464 if (SvTYPE(gv) != SVt_PVGV) {
7470 if (lref && !GvCVu(gv)) {
7474 gv_efullname3(tmpsv, gv, NULL);
7475 /* XXX this is probably not what they think they're getting.
7476 * It has the same effect as "sub name;", i.e. just a forward
7478 newSUB(start_subparse(FALSE, 0),
7479 newSVOP(OP_CONST, 0, tmpsv),
7483 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7493 Returns true if the SV has a true value by Perl's rules.
7494 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7495 instead use an in-line version.
7501 Perl_sv_true(pTHX_ register SV *sv)
7506 register const XPV* const tXpv = (XPV*)SvANY(sv);
7508 (tXpv->xpv_cur > 1 ||
7509 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7516 return SvIVX(sv) != 0;
7519 return SvNVX(sv) != 0.0;
7521 return sv_2bool(sv);
7527 =for apidoc sv_pvn_force
7529 Get a sensible string out of the SV somehow.
7530 A private implementation of the C<SvPV_force> macro for compilers which
7531 can't cope with complex macro expressions. Always use the macro instead.
7533 =for apidoc sv_pvn_force_flags
7535 Get a sensible string out of the SV somehow.
7536 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7537 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7538 implemented in terms of this function.
7539 You normally want to use the various wrapper macros instead: see
7540 C<SvPV_force> and C<SvPV_force_nomg>
7546 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7549 if (SvTHINKFIRST(sv) && !SvROK(sv))
7550 sv_force_normal_flags(sv, 0);
7560 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7561 const char * const ref = sv_reftype(sv,0);
7563 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7564 ref, OP_NAME(PL_op));
7566 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7568 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7569 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7571 s = sv_2pv_flags(sv, &len, flags);
7575 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7578 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7579 SvGROW(sv, len + 1);
7580 Move(s,SvPVX(sv),len,char);
7585 SvPOK_on(sv); /* validate pointer */
7587 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7588 PTR2UV(sv),SvPVX_const(sv)));
7591 return SvPVX_mutable(sv);
7595 =for apidoc sv_pvbyten_force
7597 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7603 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7605 sv_pvn_force(sv,lp);
7606 sv_utf8_downgrade(sv,0);
7612 =for apidoc sv_pvutf8n_force
7614 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7620 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7622 sv_pvn_force(sv,lp);
7623 sv_utf8_upgrade(sv);
7629 =for apidoc sv_reftype
7631 Returns a string describing what the SV is a reference to.
7637 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7639 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7640 inside return suggests a const propagation bug in g++. */
7641 if (ob && SvOBJECT(sv)) {
7642 char * const name = HvNAME_get(SvSTASH(sv));
7643 return name ? name : (char *) "__ANON__";
7646 switch (SvTYPE(sv)) {
7662 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7663 /* tied lvalues should appear to be
7664 * scalars for backwards compatitbility */
7665 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7666 ? "SCALAR" : "LVALUE");
7667 case SVt_PVAV: return "ARRAY";
7668 case SVt_PVHV: return "HASH";
7669 case SVt_PVCV: return "CODE";
7670 case SVt_PVGV: return "GLOB";
7671 case SVt_PVFM: return "FORMAT";
7672 case SVt_PVIO: return "IO";
7673 case SVt_BIND: return "BIND";
7674 default: return "UNKNOWN";
7680 =for apidoc sv_isobject
7682 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7683 object. If the SV is not an RV, or if the object is not blessed, then this
7690 Perl_sv_isobject(pTHX_ SV *sv)
7706 Returns a boolean indicating whether the SV is blessed into the specified
7707 class. This does not check for subtypes; use C<sv_derived_from> to verify
7708 an inheritance relationship.
7714 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7725 hvname = HvNAME_get(SvSTASH(sv));
7729 return strEQ(hvname, name);
7735 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7736 it will be upgraded to one. If C<classname> is non-null then the new SV will
7737 be blessed in the specified package. The new SV is returned and its
7738 reference count is 1.
7744 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7751 SV_CHECK_THINKFIRST_COW_DROP(rv);
7752 (void)SvAMAGIC_off(rv);
7754 if (SvTYPE(rv) >= SVt_PVMG) {
7755 const U32 refcnt = SvREFCNT(rv);
7759 SvREFCNT(rv) = refcnt;
7761 sv_upgrade(rv, SVt_RV);
7762 } else if (SvROK(rv)) {
7763 SvREFCNT_dec(SvRV(rv));
7764 } else if (SvTYPE(rv) < SVt_RV)
7765 sv_upgrade(rv, SVt_RV);
7766 else if (SvTYPE(rv) > SVt_RV) {
7777 HV* const stash = gv_stashpv(classname, GV_ADD);
7778 (void)sv_bless(rv, stash);
7784 =for apidoc sv_setref_pv
7786 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7787 argument will be upgraded to an RV. That RV will be modified to point to
7788 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7789 into the SV. The C<classname> argument indicates the package for the
7790 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7791 will have a reference count of 1, and the RV will be returned.
7793 Do not use with other Perl types such as HV, AV, SV, CV, because those
7794 objects will become corrupted by the pointer copy process.
7796 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7802 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7806 sv_setsv(rv, &PL_sv_undef);
7810 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7815 =for apidoc sv_setref_iv
7817 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7818 argument will be upgraded to an RV. That RV will be modified to point to
7819 the new SV. The C<classname> argument indicates the package for the
7820 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7821 will have a reference count of 1, and the RV will be returned.
7827 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7829 sv_setiv(newSVrv(rv,classname), iv);
7834 =for apidoc sv_setref_uv
7836 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7837 argument will be upgraded to an RV. That RV will be modified to point to
7838 the new SV. The C<classname> argument indicates the package for the
7839 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7840 will have a reference count of 1, and the RV will be returned.
7846 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7848 sv_setuv(newSVrv(rv,classname), uv);
7853 =for apidoc sv_setref_nv
7855 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7856 argument will be upgraded to an RV. That RV will be modified to point to
7857 the new SV. The C<classname> argument indicates the package for the
7858 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7859 will have a reference count of 1, and the RV will be returned.
7865 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7867 sv_setnv(newSVrv(rv,classname), nv);
7872 =for apidoc sv_setref_pvn
7874 Copies a string into a new SV, optionally blessing the SV. The length of the
7875 string must be specified with C<n>. The C<rv> argument will be upgraded to
7876 an RV. That RV will be modified to point to the new SV. The C<classname>
7877 argument indicates the package for the blessing. Set C<classname> to
7878 C<NULL> to avoid the blessing. The new SV will have a reference count
7879 of 1, and the RV will be returned.
7881 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7887 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7889 sv_setpvn(newSVrv(rv,classname), pv, n);
7894 =for apidoc sv_bless
7896 Blesses an SV into a specified package. The SV must be an RV. The package
7897 must be designated by its stash (see C<gv_stashpv()>). The reference count
7898 of the SV is unaffected.
7904 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7909 Perl_croak(aTHX_ "Can't bless non-reference value");
7911 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7912 if (SvREADONLY(tmpRef))
7913 Perl_croak(aTHX_ PL_no_modify);
7914 if (SvOBJECT(tmpRef)) {
7915 if (SvTYPE(tmpRef) != SVt_PVIO)
7917 SvREFCNT_dec(SvSTASH(tmpRef));
7920 SvOBJECT_on(tmpRef);
7921 if (SvTYPE(tmpRef) != SVt_PVIO)
7923 SvUPGRADE(tmpRef, SVt_PVMG);
7924 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7929 (void)SvAMAGIC_off(sv);
7931 if(SvSMAGICAL(tmpRef))
7932 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7940 /* Downgrades a PVGV to a PVMG.
7944 S_sv_unglob(pTHX_ SV *sv)
7948 SV * const temp = sv_newmortal();
7950 assert(SvTYPE(sv) == SVt_PVGV);
7952 gv_efullname3(temp, (GV *) sv, "*");
7958 sv_del_backref((SV*)GvSTASH(sv), sv);
7962 if (GvNAME_HEK(sv)) {
7963 unshare_hek(GvNAME_HEK(sv));
7965 isGV_with_GP_off(sv);
7967 /* need to keep SvANY(sv) in the right arena */
7968 xpvmg = new_XPVMG();
7969 StructCopy(SvANY(sv), xpvmg, XPVMG);
7970 del_XPVGV(SvANY(sv));
7973 SvFLAGS(sv) &= ~SVTYPEMASK;
7974 SvFLAGS(sv) |= SVt_PVMG;
7976 /* Intentionally not calling any local SET magic, as this isn't so much a
7977 set operation as merely an internal storage change. */
7978 sv_setsv_flags(sv, temp, 0);
7982 =for apidoc sv_unref_flags
7984 Unsets the RV status of the SV, and decrements the reference count of
7985 whatever was being referenced by the RV. This can almost be thought of
7986 as a reversal of C<newSVrv>. The C<cflags> argument can contain
7987 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7988 (otherwise the decrementing is conditional on the reference count being
7989 different from one or the reference being a readonly SV).
7996 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
7998 SV* const target = SvRV(ref);
8000 if (SvWEAKREF(ref)) {
8001 sv_del_backref(target, ref);
8003 SvRV_set(ref, NULL);
8006 SvRV_set(ref, NULL);
8008 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8009 assigned to as BEGIN {$a = \"Foo"} will fail. */
8010 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8011 SvREFCNT_dec(target);
8012 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8013 sv_2mortal(target); /* Schedule for freeing later */
8017 =for apidoc sv_untaint
8019 Untaint an SV. Use C<SvTAINTED_off> instead.
8024 Perl_sv_untaint(pTHX_ SV *sv)
8026 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8027 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8034 =for apidoc sv_tainted
8036 Test an SV for taintedness. Use C<SvTAINTED> instead.
8041 Perl_sv_tainted(pTHX_ SV *sv)
8043 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8044 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8045 if (mg && (mg->mg_len & 1) )
8052 =for apidoc sv_setpviv
8054 Copies an integer into the given SV, also updating its string value.
8055 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8061 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8063 char buf[TYPE_CHARS(UV)];
8065 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8067 sv_setpvn(sv, ptr, ebuf - ptr);
8071 =for apidoc sv_setpviv_mg
8073 Like C<sv_setpviv>, but also handles 'set' magic.
8079 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8085 #if defined(PERL_IMPLICIT_CONTEXT)
8087 /* pTHX_ magic can't cope with varargs, so this is a no-context
8088 * version of the main function, (which may itself be aliased to us).
8089 * Don't access this version directly.
8093 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8097 va_start(args, pat);
8098 sv_vsetpvf(sv, pat, &args);
8102 /* pTHX_ magic can't cope with varargs, so this is a no-context
8103 * version of the main function, (which may itself be aliased to us).
8104 * Don't access this version directly.
8108 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8112 va_start(args, pat);
8113 sv_vsetpvf_mg(sv, pat, &args);
8119 =for apidoc sv_setpvf
8121 Works like C<sv_catpvf> but copies the text into the SV instead of
8122 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8128 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8131 va_start(args, pat);
8132 sv_vsetpvf(sv, pat, &args);
8137 =for apidoc sv_vsetpvf
8139 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8140 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8142 Usually used via its frontend C<sv_setpvf>.
8148 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8150 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8154 =for apidoc sv_setpvf_mg
8156 Like C<sv_setpvf>, but also handles 'set' magic.
8162 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8165 va_start(args, pat);
8166 sv_vsetpvf_mg(sv, pat, &args);
8171 =for apidoc sv_vsetpvf_mg
8173 Like C<sv_vsetpvf>, but also handles 'set' magic.
8175 Usually used via its frontend C<sv_setpvf_mg>.
8181 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8183 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8187 #if defined(PERL_IMPLICIT_CONTEXT)
8189 /* pTHX_ magic can't cope with varargs, so this is a no-context
8190 * version of the main function, (which may itself be aliased to us).
8191 * Don't access this version directly.
8195 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8199 va_start(args, pat);
8200 sv_vcatpvf(sv, pat, &args);
8204 /* pTHX_ magic can't cope with varargs, so this is a no-context
8205 * version of the main function, (which may itself be aliased to us).
8206 * Don't access this version directly.
8210 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8214 va_start(args, pat);
8215 sv_vcatpvf_mg(sv, pat, &args);
8221 =for apidoc sv_catpvf
8223 Processes its arguments like C<sprintf> and appends the formatted
8224 output to an SV. If the appended data contains "wide" characters
8225 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8226 and characters >255 formatted with %c), the original SV might get
8227 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8228 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8229 valid UTF-8; if the original SV was bytes, the pattern should be too.
8234 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8237 va_start(args, pat);
8238 sv_vcatpvf(sv, pat, &args);
8243 =for apidoc sv_vcatpvf
8245 Processes its arguments like C<vsprintf> and appends the formatted output
8246 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8248 Usually used via its frontend C<sv_catpvf>.
8254 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8256 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8260 =for apidoc sv_catpvf_mg
8262 Like C<sv_catpvf>, but also handles 'set' magic.
8268 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8271 va_start(args, pat);
8272 sv_vcatpvf_mg(sv, pat, &args);
8277 =for apidoc sv_vcatpvf_mg
8279 Like C<sv_vcatpvf>, but also handles 'set' magic.
8281 Usually used via its frontend C<sv_catpvf_mg>.
8287 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8289 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8294 =for apidoc sv_vsetpvfn
8296 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8299 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8305 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8307 sv_setpvn(sv, "", 0);
8308 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8312 S_expect_number(pTHX_ char** pattern)
8316 switch (**pattern) {
8317 case '1': case '2': case '3':
8318 case '4': case '5': case '6':
8319 case '7': case '8': case '9':
8320 var = *(*pattern)++ - '0';
8321 while (isDIGIT(**pattern)) {
8322 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8324 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8332 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8334 const int neg = nv < 0;
8343 if (uv & 1 && uv == nv)
8344 uv--; /* Round to even */
8346 const unsigned dig = uv % 10;
8359 =for apidoc sv_vcatpvfn
8361 Processes its arguments like C<vsprintf> and appends the formatted output
8362 to an SV. Uses an array of SVs if the C style variable argument list is
8363 missing (NULL). When running with taint checks enabled, indicates via
8364 C<maybe_tainted> if results are untrustworthy (often due to the use of
8367 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8373 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8374 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8375 vec_utf8 = DO_UTF8(vecsv);
8377 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8380 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8388 static const char nullstr[] = "(null)";
8390 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8391 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8393 /* Times 4: a decimal digit takes more than 3 binary digits.
8394 * NV_DIG: mantissa takes than many decimal digits.
8395 * Plus 32: Playing safe. */
8396 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8397 /* large enough for "%#.#f" --chip */
8398 /* what about long double NVs? --jhi */
8400 PERL_UNUSED_ARG(maybe_tainted);
8402 /* no matter what, this is a string now */
8403 (void)SvPV_force(sv, origlen);
8405 /* special-case "", "%s", and "%-p" (SVf - see below) */
8408 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8410 const char * const s = va_arg(*args, char*);
8411 sv_catpv(sv, s ? s : nullstr);
8413 else if (svix < svmax) {
8414 sv_catsv(sv, *svargs);
8418 if (args && patlen == 3 && pat[0] == '%' &&
8419 pat[1] == '-' && pat[2] == 'p') {
8420 argsv = (SV*)va_arg(*args, void*);
8421 sv_catsv(sv, argsv);
8425 #ifndef USE_LONG_DOUBLE
8426 /* special-case "%.<number>[gf]" */
8427 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8428 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8429 unsigned digits = 0;
8433 while (*pp >= '0' && *pp <= '9')
8434 digits = 10 * digits + (*pp++ - '0');
8435 if (pp - pat == (int)patlen - 1) {
8443 /* Add check for digits != 0 because it seems that some
8444 gconverts are buggy in this case, and we don't yet have
8445 a Configure test for this. */
8446 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8447 /* 0, point, slack */
8448 Gconvert(nv, (int)digits, 0, ebuf);
8450 if (*ebuf) /* May return an empty string for digits==0 */
8453 } else if (!digits) {
8456 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8457 sv_catpvn(sv, p, l);
8463 #endif /* !USE_LONG_DOUBLE */
8465 if (!args && svix < svmax && DO_UTF8(*svargs))
8468 patend = (char*)pat + patlen;
8469 for (p = (char*)pat; p < patend; p = q) {
8472 bool vectorize = FALSE;
8473 bool vectorarg = FALSE;
8474 bool vec_utf8 = FALSE;
8480 bool has_precis = FALSE;
8482 const I32 osvix = svix;
8483 bool is_utf8 = FALSE; /* is this item utf8? */
8484 #ifdef HAS_LDBL_SPRINTF_BUG
8485 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8486 with sfio - Allen <allens@cpan.org> */
8487 bool fix_ldbl_sprintf_bug = FALSE;
8491 U8 utf8buf[UTF8_MAXBYTES+1];
8492 STRLEN esignlen = 0;
8494 const char *eptr = NULL;
8497 const U8 *vecstr = NULL;
8504 /* we need a long double target in case HAS_LONG_DOUBLE but
8507 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8515 const char *dotstr = ".";
8516 STRLEN dotstrlen = 1;
8517 I32 efix = 0; /* explicit format parameter index */
8518 I32 ewix = 0; /* explicit width index */
8519 I32 epix = 0; /* explicit precision index */
8520 I32 evix = 0; /* explicit vector index */
8521 bool asterisk = FALSE;
8523 /* echo everything up to the next format specification */
8524 for (q = p; q < patend && *q != '%'; ++q) ;
8526 if (has_utf8 && !pat_utf8)
8527 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8529 sv_catpvn(sv, p, q - p);
8536 We allow format specification elements in this order:
8537 \d+\$ explicit format parameter index
8539 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8540 0 flag (as above): repeated to allow "v02"
8541 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8542 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8544 [%bcdefginopsuxDFOUX] format (mandatory)
8549 As of perl5.9.3, printf format checking is on by default.
8550 Internally, perl uses %p formats to provide an escape to
8551 some extended formatting. This block deals with those
8552 extensions: if it does not match, (char*)q is reset and
8553 the normal format processing code is used.
8555 Currently defined extensions are:
8556 %p include pointer address (standard)
8557 %-p (SVf) include an SV (previously %_)
8558 %-<num>p include an SV with precision <num>
8559 %1p (VDf) include a v-string (as %vd)
8560 %<num>p reserved for future extensions
8562 Robin Barker 2005-07-14
8569 n = expect_number(&q);
8576 argsv = (SV*)va_arg(*args, void*);
8577 eptr = SvPVx_const(argsv, elen);
8583 else if (n == vdNUMBER) { /* VDf */
8590 if (ckWARN_d(WARN_INTERNAL))
8591 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8592 "internal %%<num>p might conflict with future printf extensions");
8598 if ( (width = expect_number(&q)) ) {
8613 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8642 if ( (ewix = expect_number(&q)) )
8651 if ((vectorarg = asterisk)) {
8664 width = expect_number(&q);
8670 vecsv = va_arg(*args, SV*);
8672 vecsv = (evix > 0 && evix <= svmax)
8673 ? svargs[evix-1] : &PL_sv_undef;
8675 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8677 dotstr = SvPV_const(vecsv, dotstrlen);
8678 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8679 bad with tied or overloaded values that return UTF8. */
8682 else if (has_utf8) {
8683 vecsv = sv_mortalcopy(vecsv);
8684 sv_utf8_upgrade(vecsv);
8685 dotstr = SvPV_const(vecsv, dotstrlen);
8692 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8693 vecsv = svargs[efix ? efix-1 : svix++];
8694 vecstr = (U8*)SvPV_const(vecsv,veclen);
8695 vec_utf8 = DO_UTF8(vecsv);
8697 /* if this is a version object, we need to convert
8698 * back into v-string notation and then let the
8699 * vectorize happen normally
8701 if (sv_derived_from(vecsv, "version")) {
8702 char *version = savesvpv(vecsv);
8703 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8704 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8705 "vector argument not supported with alpha versions");
8708 vecsv = sv_newmortal();
8709 scan_vstring(version, version + veclen, vecsv);
8710 vecstr = (U8*)SvPV_const(vecsv, veclen);
8711 vec_utf8 = DO_UTF8(vecsv);
8723 i = va_arg(*args, int);
8725 i = (ewix ? ewix <= svmax : svix < svmax) ?
8726 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8728 width = (i < 0) ? -i : i;
8738 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8740 /* XXX: todo, support specified precision parameter */
8744 i = va_arg(*args, int);
8746 i = (ewix ? ewix <= svmax : svix < svmax)
8747 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8749 has_precis = !(i < 0);
8754 precis = precis * 10 + (*q++ - '0');
8763 case 'I': /* Ix, I32x, and I64x */
8765 if (q[1] == '6' && q[2] == '4') {
8771 if (q[1] == '3' && q[2] == '2') {
8781 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8792 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8793 if (*(q + 1) == 'l') { /* lld, llf */
8819 if (!vectorize && !args) {
8821 const I32 i = efix-1;
8822 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8824 argsv = (svix >= 0 && svix < svmax)
8825 ? svargs[svix++] : &PL_sv_undef;
8836 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8838 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8840 eptr = (char*)utf8buf;
8841 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8855 eptr = va_arg(*args, char*);
8857 #ifdef MACOS_TRADITIONAL
8858 /* On MacOS, %#s format is used for Pascal strings */
8863 elen = strlen(eptr);
8865 eptr = (char *)nullstr;
8866 elen = sizeof nullstr - 1;
8870 eptr = SvPVx_const(argsv, elen);
8871 if (DO_UTF8(argsv)) {
8872 I32 old_precis = precis;
8873 if (has_precis && precis < elen) {
8875 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8878 if (width) { /* fudge width (can't fudge elen) */
8879 if (has_precis && precis < elen)
8880 width += precis - old_precis;
8882 width += elen - sv_len_utf8(argsv);
8889 if (has_precis && elen > precis)
8896 if (alt || vectorize)
8898 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8919 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8928 esignbuf[esignlen++] = plus;
8932 case 'h': iv = (short)va_arg(*args, int); break;
8933 case 'l': iv = va_arg(*args, long); break;
8934 case 'V': iv = va_arg(*args, IV); break;
8935 default: iv = va_arg(*args, int); break;
8937 case 'q': iv = va_arg(*args, Quad_t); break;
8942 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8944 case 'h': iv = (short)tiv; break;
8945 case 'l': iv = (long)tiv; break;
8947 default: iv = tiv; break;
8949 case 'q': iv = (Quad_t)tiv; break;
8953 if ( !vectorize ) /* we already set uv above */
8958 esignbuf[esignlen++] = plus;
8962 esignbuf[esignlen++] = '-';
9006 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9017 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9018 case 'l': uv = va_arg(*args, unsigned long); break;
9019 case 'V': uv = va_arg(*args, UV); break;
9020 default: uv = va_arg(*args, unsigned); break;
9022 case 'q': uv = va_arg(*args, Uquad_t); break;
9027 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9029 case 'h': uv = (unsigned short)tuv; break;
9030 case 'l': uv = (unsigned long)tuv; break;
9032 default: uv = tuv; break;
9034 case 'q': uv = (Uquad_t)tuv; break;
9041 char *ptr = ebuf + sizeof ebuf;
9042 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9048 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9054 esignbuf[esignlen++] = '0';
9055 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9063 if (alt && *ptr != '0')
9072 esignbuf[esignlen++] = '0';
9073 esignbuf[esignlen++] = c;
9076 default: /* it had better be ten or less */
9080 } while (uv /= base);
9083 elen = (ebuf + sizeof ebuf) - ptr;
9087 zeros = precis - elen;
9088 else if (precis == 0 && elen == 1 && *eptr == '0'
9089 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9092 /* a precision nullifies the 0 flag. */
9099 /* FLOATING POINT */
9102 c = 'f'; /* maybe %F isn't supported here */
9110 /* This is evil, but floating point is even more evil */
9112 /* for SV-style calling, we can only get NV
9113 for C-style calling, we assume %f is double;
9114 for simplicity we allow any of %Lf, %llf, %qf for long double
9118 #if defined(USE_LONG_DOUBLE)
9122 /* [perl #20339] - we should accept and ignore %lf rather than die */
9126 #if defined(USE_LONG_DOUBLE)
9127 intsize = args ? 0 : 'q';
9131 #if defined(HAS_LONG_DOUBLE)
9140 /* now we need (long double) if intsize == 'q', else (double) */
9142 #if LONG_DOUBLESIZE > DOUBLESIZE
9144 va_arg(*args, long double) :
9145 va_arg(*args, double)
9147 va_arg(*args, double)
9152 if (c != 'e' && c != 'E') {
9154 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9155 will cast our (long double) to (double) */
9156 (void)Perl_frexp(nv, &i);
9157 if (i == PERL_INT_MIN)
9158 Perl_die(aTHX_ "panic: frexp");
9160 need = BIT_DIGITS(i);
9162 need += has_precis ? precis : 6; /* known default */
9167 #ifdef HAS_LDBL_SPRINTF_BUG
9168 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9169 with sfio - Allen <allens@cpan.org> */
9172 # define MY_DBL_MAX DBL_MAX
9173 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9174 # if DOUBLESIZE >= 8
9175 # define MY_DBL_MAX 1.7976931348623157E+308L
9177 # define MY_DBL_MAX 3.40282347E+38L
9181 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9182 # define MY_DBL_MAX_BUG 1L
9184 # define MY_DBL_MAX_BUG MY_DBL_MAX
9188 # define MY_DBL_MIN DBL_MIN
9189 # else /* XXX guessing! -Allen */
9190 # if DOUBLESIZE >= 8
9191 # define MY_DBL_MIN 2.2250738585072014E-308L
9193 # define MY_DBL_MIN 1.17549435E-38L
9197 if ((intsize == 'q') && (c == 'f') &&
9198 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9200 /* it's going to be short enough that
9201 * long double precision is not needed */
9203 if ((nv <= 0L) && (nv >= -0L))
9204 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9206 /* would use Perl_fp_class as a double-check but not
9207 * functional on IRIX - see perl.h comments */
9209 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9210 /* It's within the range that a double can represent */
9211 #if defined(DBL_MAX) && !defined(DBL_MIN)
9212 if ((nv >= ((long double)1/DBL_MAX)) ||
9213 (nv <= (-(long double)1/DBL_MAX)))
9215 fix_ldbl_sprintf_bug = TRUE;
9218 if (fix_ldbl_sprintf_bug == TRUE) {
9228 # undef MY_DBL_MAX_BUG
9231 #endif /* HAS_LDBL_SPRINTF_BUG */
9233 need += 20; /* fudge factor */
9234 if (PL_efloatsize < need) {
9235 Safefree(PL_efloatbuf);
9236 PL_efloatsize = need + 20; /* more fudge */
9237 Newx(PL_efloatbuf, PL_efloatsize, char);
9238 PL_efloatbuf[0] = '\0';
9241 if ( !(width || left || plus || alt) && fill != '0'
9242 && has_precis && intsize != 'q' ) { /* Shortcuts */
9243 /* See earlier comment about buggy Gconvert when digits,
9245 if ( c == 'g' && precis) {
9246 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9247 /* May return an empty string for digits==0 */
9248 if (*PL_efloatbuf) {
9249 elen = strlen(PL_efloatbuf);
9250 goto float_converted;
9252 } else if ( c == 'f' && !precis) {
9253 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9258 char *ptr = ebuf + sizeof ebuf;
9261 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9262 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9263 if (intsize == 'q') {
9264 /* Copy the one or more characters in a long double
9265 * format before the 'base' ([efgEFG]) character to
9266 * the format string. */
9267 static char const prifldbl[] = PERL_PRIfldbl;
9268 char const *p = prifldbl + sizeof(prifldbl) - 3;
9269 while (p >= prifldbl) { *--ptr = *p--; }
9274 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9279 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9291 /* No taint. Otherwise we are in the strange situation
9292 * where printf() taints but print($float) doesn't.
9294 #if defined(HAS_LONG_DOUBLE)
9295 elen = ((intsize == 'q')
9296 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9297 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9299 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9303 eptr = PL_efloatbuf;
9311 i = SvCUR(sv) - origlen;
9314 case 'h': *(va_arg(*args, short*)) = i; break;
9315 default: *(va_arg(*args, int*)) = i; break;
9316 case 'l': *(va_arg(*args, long*)) = i; break;
9317 case 'V': *(va_arg(*args, IV*)) = i; break;
9319 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9324 sv_setuv_mg(argsv, (UV)i);
9325 continue; /* not "break" */
9332 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9333 && ckWARN(WARN_PRINTF))
9335 SV * const msg = sv_newmortal();
9336 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9337 (PL_op->op_type == OP_PRTF) ? "" : "s");
9340 Perl_sv_catpvf(aTHX_ msg,
9341 "\"%%%c\"", c & 0xFF);
9343 Perl_sv_catpvf(aTHX_ msg,
9344 "\"%%\\%03"UVof"\"",
9347 sv_catpvs(msg, "end of string");
9348 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9351 /* output mangled stuff ... */
9357 /* ... right here, because formatting flags should not apply */
9358 SvGROW(sv, SvCUR(sv) + elen + 1);
9360 Copy(eptr, p, elen, char);
9363 SvCUR_set(sv, p - SvPVX_const(sv));
9365 continue; /* not "break" */
9368 if (is_utf8 != has_utf8) {
9371 sv_utf8_upgrade(sv);
9374 const STRLEN old_elen = elen;
9375 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9376 sv_utf8_upgrade(nsv);
9377 eptr = SvPVX_const(nsv);
9380 if (width) { /* fudge width (can't fudge elen) */
9381 width += elen - old_elen;
9387 have = esignlen + zeros + elen;
9389 Perl_croak_nocontext(PL_memory_wrap);
9391 need = (have > width ? have : width);
9394 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9395 Perl_croak_nocontext(PL_memory_wrap);
9396 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9398 if (esignlen && fill == '0') {
9400 for (i = 0; i < (int)esignlen; i++)
9404 memset(p, fill, gap);
9407 if (esignlen && fill != '0') {
9409 for (i = 0; i < (int)esignlen; i++)
9414 for (i = zeros; i; i--)
9418 Copy(eptr, p, elen, char);
9422 memset(p, ' ', gap);
9427 Copy(dotstr, p, dotstrlen, char);
9431 vectorize = FALSE; /* done iterating over vecstr */
9438 SvCUR_set(sv, p - SvPVX_const(sv));
9446 /* =========================================================================
9448 =head1 Cloning an interpreter
9450 All the macros and functions in this section are for the private use of
9451 the main function, perl_clone().
9453 The foo_dup() functions make an exact copy of an existing foo thinngy.
9454 During the course of a cloning, a hash table is used to map old addresses
9455 to new addresses. The table is created and manipulated with the
9456 ptr_table_* functions.
9460 ============================================================================*/
9463 #if defined(USE_ITHREADS)
9465 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9466 #ifndef GpREFCNT_inc
9467 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9471 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9472 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9473 If this changes, please unmerge ss_dup. */
9474 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9475 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9476 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9477 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9478 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9479 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9480 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9481 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9482 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9483 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9484 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9485 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9486 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9487 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9489 /* clone a parser */
9492 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9499 /* look for it in the table first */
9500 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9504 /* create anew and remember what it is */
9505 Newxz(parser, 1, yy_parser);
9506 ptr_table_store(PL_ptr_table, proto, parser);
9508 parser->yyerrstatus = 0;
9509 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9511 /* XXX these not yet duped */
9512 parser->old_parser = NULL;
9513 parser->stack = NULL;
9515 parser->stack_size = 0;
9516 /* XXX parser->stack->state = 0; */
9518 /* XXX eventually, just Copy() most of the parser struct ? */
9520 parser->lex_brackets = proto->lex_brackets;
9521 parser->lex_casemods = proto->lex_casemods;
9522 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9523 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9524 parser->lex_casestack = savepvn(proto->lex_casestack,
9525 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9526 parser->lex_defer = proto->lex_defer;
9527 parser->lex_dojoin = proto->lex_dojoin;
9528 parser->lex_expect = proto->lex_expect;
9529 parser->lex_formbrack = proto->lex_formbrack;
9530 parser->lex_inpat = proto->lex_inpat;
9531 parser->lex_inwhat = proto->lex_inwhat;
9532 parser->lex_op = proto->lex_op;
9533 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9534 parser->lex_starts = proto->lex_starts;
9535 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9536 parser->multi_close = proto->multi_close;
9537 parser->multi_open = proto->multi_open;
9538 parser->multi_start = proto->multi_start;
9539 parser->pending_ident = proto->pending_ident;
9540 parser->preambled = proto->preambled;
9541 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9544 parser->endwhite = proto->endwhite;
9545 parser->faketokens = proto->faketokens;
9546 parser->lasttoke = proto->lasttoke;
9547 parser->nextwhite = proto->nextwhite;
9548 parser->realtokenstart = proto->realtokenstart;
9549 parser->skipwhite = proto->skipwhite;
9550 parser->thisclose = proto->thisclose;
9551 parser->thismad = proto->thismad;
9552 parser->thisopen = proto->thisopen;
9553 parser->thisstuff = proto->thisstuff;
9554 parser->thistoken = proto->thistoken;
9555 parser->thiswhite = proto->thiswhite;
9561 /* duplicate a file handle */
9564 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9568 PERL_UNUSED_ARG(type);
9571 return (PerlIO*)NULL;
9573 /* look for it in the table first */
9574 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9578 /* create anew and remember what it is */
9579 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9580 ptr_table_store(PL_ptr_table, fp, ret);
9584 /* duplicate a directory handle */
9587 Perl_dirp_dup(pTHX_ DIR *dp)
9589 PERL_UNUSED_CONTEXT;
9596 /* duplicate a typeglob */
9599 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9605 /* look for it in the table first */
9606 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9610 /* create anew and remember what it is */
9612 ptr_table_store(PL_ptr_table, gp, ret);
9615 ret->gp_refcnt = 0; /* must be before any other dups! */
9616 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9617 ret->gp_io = io_dup_inc(gp->gp_io, param);
9618 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9619 ret->gp_av = av_dup_inc(gp->gp_av, param);
9620 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9621 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9622 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9623 ret->gp_cvgen = gp->gp_cvgen;
9624 ret->gp_line = gp->gp_line;
9625 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9629 /* duplicate a chain of magic */
9632 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9634 MAGIC *mgprev = (MAGIC*)NULL;
9637 return (MAGIC*)NULL;
9638 /* look for it in the table first */
9639 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9643 for (; mg; mg = mg->mg_moremagic) {
9645 Newxz(nmg, 1, MAGIC);
9647 mgprev->mg_moremagic = nmg;
9650 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9651 nmg->mg_private = mg->mg_private;
9652 nmg->mg_type = mg->mg_type;
9653 nmg->mg_flags = mg->mg_flags;
9654 if (mg->mg_type == PERL_MAGIC_qr) {
9655 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9657 else if(mg->mg_type == PERL_MAGIC_backref) {
9658 /* The backref AV has its reference count deliberately bumped by
9660 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9663 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9664 ? sv_dup_inc(mg->mg_obj, param)
9665 : sv_dup(mg->mg_obj, param);
9667 nmg->mg_len = mg->mg_len;
9668 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9669 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9670 if (mg->mg_len > 0) {
9671 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9672 if (mg->mg_type == PERL_MAGIC_overload_table &&
9673 AMT_AMAGIC((AMT*)mg->mg_ptr))
9675 const AMT * const amtp = (AMT*)mg->mg_ptr;
9676 AMT * const namtp = (AMT*)nmg->mg_ptr;
9678 for (i = 1; i < NofAMmeth; i++) {
9679 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9683 else if (mg->mg_len == HEf_SVKEY)
9684 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9686 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9687 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9694 #endif /* USE_ITHREADS */
9696 /* create a new pointer-mapping table */
9699 Perl_ptr_table_new(pTHX)
9702 PERL_UNUSED_CONTEXT;
9704 Newxz(tbl, 1, PTR_TBL_t);
9707 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9711 #define PTR_TABLE_HASH(ptr) \
9712 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9715 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9716 following define) and at call to new_body_inline made below in
9717 Perl_ptr_table_store()
9720 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9722 /* map an existing pointer using a table */
9724 STATIC PTR_TBL_ENT_t *
9725 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9726 PTR_TBL_ENT_t *tblent;
9727 const UV hash = PTR_TABLE_HASH(sv);
9729 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9730 for (; tblent; tblent = tblent->next) {
9731 if (tblent->oldval == sv)
9738 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9740 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9741 PERL_UNUSED_CONTEXT;
9742 return tblent ? tblent->newval : NULL;
9745 /* add a new entry to a pointer-mapping table */
9748 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9750 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9751 PERL_UNUSED_CONTEXT;
9754 tblent->newval = newsv;
9756 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9758 new_body_inline(tblent, PTE_SVSLOT);
9760 tblent->oldval = oldsv;
9761 tblent->newval = newsv;
9762 tblent->next = tbl->tbl_ary[entry];
9763 tbl->tbl_ary[entry] = tblent;
9765 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9766 ptr_table_split(tbl);
9770 /* double the hash bucket size of an existing ptr table */
9773 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9775 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9776 const UV oldsize = tbl->tbl_max + 1;
9777 UV newsize = oldsize * 2;
9779 PERL_UNUSED_CONTEXT;
9781 Renew(ary, newsize, PTR_TBL_ENT_t*);
9782 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9783 tbl->tbl_max = --newsize;
9785 for (i=0; i < oldsize; i++, ary++) {
9786 PTR_TBL_ENT_t **curentp, **entp, *ent;
9789 curentp = ary + oldsize;
9790 for (entp = ary, ent = *ary; ent; ent = *entp) {
9791 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9793 ent->next = *curentp;
9803 /* remove all the entries from a ptr table */
9806 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9808 if (tbl && tbl->tbl_items) {
9809 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9810 UV riter = tbl->tbl_max;
9813 PTR_TBL_ENT_t *entry = array[riter];
9816 PTR_TBL_ENT_t * const oentry = entry;
9817 entry = entry->next;
9826 /* clear and free a ptr table */
9829 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9834 ptr_table_clear(tbl);
9835 Safefree(tbl->tbl_ary);
9839 #if defined(USE_ITHREADS)
9842 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9845 SvRV_set(dstr, SvWEAKREF(sstr)
9846 ? sv_dup(SvRV(sstr), param)
9847 : sv_dup_inc(SvRV(sstr), param));
9850 else if (SvPVX_const(sstr)) {
9851 /* Has something there */
9853 /* Normal PV - clone whole allocated space */
9854 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9855 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9856 /* Not that normal - actually sstr is copy on write.
9857 But we are a true, independant SV, so: */
9858 SvREADONLY_off(dstr);
9863 /* Special case - not normally malloced for some reason */
9864 if (isGV_with_GP(sstr)) {
9865 /* Don't need to do anything here. */
9867 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9868 /* A "shared" PV - clone it as "shared" PV */
9870 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9874 /* Some other special case - random pointer */
9875 SvPV_set(dstr, SvPVX(sstr));
9881 if (SvTYPE(dstr) == SVt_RV)
9882 SvRV_set(dstr, NULL);
9884 SvPV_set(dstr, NULL);
9888 /* duplicate an SV of any type (including AV, HV etc) */
9891 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9896 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9898 /* look for it in the table first */
9899 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9903 if(param->flags & CLONEf_JOIN_IN) {
9904 /** We are joining here so we don't want do clone
9905 something that is bad **/
9906 if (SvTYPE(sstr) == SVt_PVHV) {
9907 const char * const hvname = HvNAME_get(sstr);
9909 /** don't clone stashes if they already exist **/
9910 return (SV*)gv_stashpv(hvname,0);
9914 /* create anew and remember what it is */
9917 #ifdef DEBUG_LEAKING_SCALARS
9918 dstr->sv_debug_optype = sstr->sv_debug_optype;
9919 dstr->sv_debug_line = sstr->sv_debug_line;
9920 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9921 dstr->sv_debug_cloned = 1;
9922 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9925 ptr_table_store(PL_ptr_table, sstr, dstr);
9928 SvFLAGS(dstr) = SvFLAGS(sstr);
9929 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9930 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9933 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9934 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9935 (void*)PL_watch_pvx, SvPVX_const(sstr));
9938 /* don't clone objects whose class has asked us not to */
9939 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9940 SvFLAGS(dstr) &= ~SVTYPEMASK;
9945 switch (SvTYPE(sstr)) {
9950 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9951 SvIV_set(dstr, SvIVX(sstr));
9954 SvANY(dstr) = new_XNV();
9955 SvNV_set(dstr, SvNVX(sstr));
9958 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9959 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9961 /* case SVt_BIND: */
9964 /* These are all the types that need complex bodies allocating. */
9966 const svtype sv_type = SvTYPE(sstr);
9967 const struct body_details *const sv_type_details
9968 = bodies_by_type + sv_type;
9972 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9976 if (GvUNIQUE((GV*)sstr)) {
9977 NOOP; /* Do sharing here, and fall through */
9989 assert(sv_type_details->body_size);
9990 if (sv_type_details->arena) {
9991 new_body_inline(new_body, sv_type);
9993 = (void*)((char*)new_body - sv_type_details->offset);
9995 new_body = new_NOARENA(sv_type_details);
9999 SvANY(dstr) = new_body;
10002 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10003 ((char*)SvANY(dstr)) + sv_type_details->offset,
10004 sv_type_details->copy, char);
10006 Copy(((char*)SvANY(sstr)),
10007 ((char*)SvANY(dstr)),
10008 sv_type_details->body_size + sv_type_details->offset, char);
10011 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10012 && !isGV_with_GP(dstr))
10013 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10015 /* The Copy above means that all the source (unduplicated) pointers
10016 are now in the destination. We can check the flags and the
10017 pointers in either, but it's possible that there's less cache
10018 missing by always going for the destination.
10019 FIXME - instrument and check that assumption */
10020 if (sv_type >= SVt_PVMG) {
10021 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10022 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10023 } else if (SvMAGIC(dstr))
10024 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10026 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10029 /* The cast silences a GCC warning about unhandled types. */
10030 switch ((int)sv_type) {
10040 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10041 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10042 LvTARG(dstr) = dstr;
10043 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10044 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10046 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10048 if(isGV_with_GP(sstr)) {
10049 if (GvNAME_HEK(dstr))
10050 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10051 /* Don't call sv_add_backref here as it's going to be
10052 created as part of the magic cloning of the symbol
10054 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10055 at the point of this comment. */
10056 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10057 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10058 (void)GpREFCNT_inc(GvGP(dstr));
10060 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10063 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10064 if (IoOFP(dstr) == IoIFP(sstr))
10065 IoOFP(dstr) = IoIFP(dstr);
10067 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10068 /* PL_rsfp_filters entries have fake IoDIRP() */
10069 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10070 /* I have no idea why fake dirp (rsfps)
10071 should be treated differently but otherwise
10072 we end up with leaks -- sky*/
10073 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10074 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10075 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10077 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10078 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10079 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10080 if (IoDIRP(dstr)) {
10081 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10084 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10087 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10088 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10089 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10092 if (AvARRAY((AV*)sstr)) {
10093 SV **dst_ary, **src_ary;
10094 SSize_t items = AvFILLp((AV*)sstr) + 1;
10096 src_ary = AvARRAY((AV*)sstr);
10097 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10098 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10099 AvARRAY((AV*)dstr) = dst_ary;
10100 AvALLOC((AV*)dstr) = dst_ary;
10101 if (AvREAL((AV*)sstr)) {
10102 while (items-- > 0)
10103 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10106 while (items-- > 0)
10107 *dst_ary++ = sv_dup(*src_ary++, param);
10109 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10110 while (items-- > 0) {
10111 *dst_ary++ = &PL_sv_undef;
10115 AvARRAY((AV*)dstr) = NULL;
10116 AvALLOC((AV*)dstr) = (SV**)NULL;
10120 if (HvARRAY((HV*)sstr)) {
10122 const bool sharekeys = !!HvSHAREKEYS(sstr);
10123 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10124 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10126 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10127 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10129 HvARRAY(dstr) = (HE**)darray;
10130 while (i <= sxhv->xhv_max) {
10131 const HE * const source = HvARRAY(sstr)[i];
10132 HvARRAY(dstr)[i] = source
10133 ? he_dup(source, sharekeys, param) : 0;
10138 const struct xpvhv_aux * const saux = HvAUX(sstr);
10139 struct xpvhv_aux * const daux = HvAUX(dstr);
10140 /* This flag isn't copied. */
10141 /* SvOOK_on(hv) attacks the IV flags. */
10142 SvFLAGS(dstr) |= SVf_OOK;
10144 hvname = saux->xhv_name;
10145 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10147 daux->xhv_riter = saux->xhv_riter;
10148 daux->xhv_eiter = saux->xhv_eiter
10149 ? he_dup(saux->xhv_eiter,
10150 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10151 daux->xhv_backreferences =
10152 saux->xhv_backreferences
10153 ? (AV*) SvREFCNT_inc(
10154 sv_dup((SV*)saux->xhv_backreferences, param))
10156 /* Record stashes for possible cloning in Perl_clone(). */
10158 av_push(param->stashes, dstr);
10162 HvARRAY((HV*)dstr) = NULL;
10165 if (!(param->flags & CLONEf_COPY_STACKS)) {
10169 /* NOTE: not refcounted */
10170 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10172 if (!CvISXSUB(dstr))
10173 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10175 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10176 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10177 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10178 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10180 /* don't dup if copying back - CvGV isn't refcounted, so the
10181 * duped GV may never be freed. A bit of a hack! DAPM */
10182 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10183 NULL : gv_dup(CvGV(dstr), param) ;
10184 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10186 CvWEAKOUTSIDE(sstr)
10187 ? cv_dup( CvOUTSIDE(dstr), param)
10188 : cv_dup_inc(CvOUTSIDE(dstr), param);
10189 if (!CvISXSUB(dstr))
10190 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10196 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10202 /* duplicate a context */
10205 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10207 PERL_CONTEXT *ncxs;
10210 return (PERL_CONTEXT*)NULL;
10212 /* look for it in the table first */
10213 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10217 /* create anew and remember what it is */
10218 Newxz(ncxs, max + 1, PERL_CONTEXT);
10219 ptr_table_store(PL_ptr_table, cxs, ncxs);
10222 PERL_CONTEXT * const cx = &cxs[ix];
10223 PERL_CONTEXT * const ncx = &ncxs[ix];
10224 ncx->cx_type = cx->cx_type;
10225 if (CxTYPE(cx) == CXt_SUBST) {
10226 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10229 ncx->blk_oldsp = cx->blk_oldsp;
10230 ncx->blk_oldcop = cx->blk_oldcop;
10231 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10232 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10233 ncx->blk_oldpm = cx->blk_oldpm;
10234 ncx->blk_gimme = cx->blk_gimme;
10235 switch (CxTYPE(cx)) {
10237 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10238 ? cv_dup_inc(cx->blk_sub.cv, param)
10239 : cv_dup(cx->blk_sub.cv,param));
10240 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10241 ? av_dup_inc(cx->blk_sub.argarray, param)
10243 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10244 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10245 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10246 ncx->blk_sub.lval = cx->blk_sub.lval;
10247 ncx->blk_sub.retop = cx->blk_sub.retop;
10248 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10249 cx->blk_sub.oldcomppad);
10252 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10253 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10254 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10255 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10256 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10257 ncx->blk_eval.retop = cx->blk_eval.retop;
10260 ncx->blk_loop.label = cx->blk_loop.label;
10261 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10262 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10263 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10264 ? cx->blk_loop.iterdata
10265 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10266 ncx->blk_loop.oldcomppad
10267 = (PAD*)ptr_table_fetch(PL_ptr_table,
10268 cx->blk_loop.oldcomppad);
10269 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10270 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10271 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10272 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10273 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10276 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10277 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10278 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10279 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10280 ncx->blk_sub.retop = cx->blk_sub.retop;
10292 /* duplicate a stack info structure */
10295 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10300 return (PERL_SI*)NULL;
10302 /* look for it in the table first */
10303 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10307 /* create anew and remember what it is */
10308 Newxz(nsi, 1, PERL_SI);
10309 ptr_table_store(PL_ptr_table, si, nsi);
10311 nsi->si_stack = av_dup_inc(si->si_stack, param);
10312 nsi->si_cxix = si->si_cxix;
10313 nsi->si_cxmax = si->si_cxmax;
10314 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10315 nsi->si_type = si->si_type;
10316 nsi->si_prev = si_dup(si->si_prev, param);
10317 nsi->si_next = si_dup(si->si_next, param);
10318 nsi->si_markoff = si->si_markoff;
10323 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10324 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10325 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10326 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10327 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10328 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10329 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10330 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10331 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10332 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10333 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10334 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10335 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10336 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10339 #define pv_dup_inc(p) SAVEPV(p)
10340 #define pv_dup(p) SAVEPV(p)
10341 #define svp_dup_inc(p,pp) any_dup(p,pp)
10343 /* map any object to the new equivent - either something in the
10344 * ptr table, or something in the interpreter structure
10348 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10353 return (void*)NULL;
10355 /* look for it in the table first */
10356 ret = ptr_table_fetch(PL_ptr_table, v);
10360 /* see if it is part of the interpreter structure */
10361 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10362 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10370 /* duplicate the save stack */
10373 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10376 ANY * const ss = proto_perl->Tsavestack;
10377 const I32 max = proto_perl->Tsavestack_max;
10378 I32 ix = proto_perl->Tsavestack_ix;
10391 void (*dptr) (void*);
10392 void (*dxptr) (pTHX_ void*);
10394 Newxz(nss, max, ANY);
10397 const I32 type = POPINT(ss,ix);
10398 TOPINT(nss,ix) = type;
10400 case SAVEt_HELEM: /* hash element */
10401 sv = (SV*)POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10404 case SAVEt_ITEM: /* normal string */
10405 case SAVEt_SV: /* scalar reference */
10406 sv = (SV*)POPPTR(ss,ix);
10407 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10410 case SAVEt_MORTALIZESV:
10411 sv = (SV*)POPPTR(ss,ix);
10412 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10414 case SAVEt_SHARED_PVREF: /* char* in shared space */
10415 c = (char*)POPPTR(ss,ix);
10416 TOPPTR(nss,ix) = savesharedpv(c);
10417 ptr = POPPTR(ss,ix);
10418 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10420 case SAVEt_GENERIC_SVREF: /* generic sv */
10421 case SAVEt_SVREF: /* scalar reference */
10422 sv = (SV*)POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10424 ptr = POPPTR(ss,ix);
10425 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10427 case SAVEt_HV: /* hash reference */
10428 case SAVEt_AV: /* array reference */
10429 sv = (SV*) POPPTR(ss,ix);
10430 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10432 case SAVEt_COMPPAD:
10434 sv = (SV*) POPPTR(ss,ix);
10435 TOPPTR(nss,ix) = sv_dup(sv, param);
10437 case SAVEt_INT: /* int reference */
10438 ptr = POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10440 intval = (int)POPINT(ss,ix);
10441 TOPINT(nss,ix) = intval;
10443 case SAVEt_LONG: /* long reference */
10444 ptr = POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10447 case SAVEt_CLEARSV:
10448 longval = (long)POPLONG(ss,ix);
10449 TOPLONG(nss,ix) = longval;
10451 case SAVEt_I32: /* I32 reference */
10452 case SAVEt_I16: /* I16 reference */
10453 case SAVEt_I8: /* I8 reference */
10454 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10455 ptr = POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10458 TOPINT(nss,ix) = i;
10460 case SAVEt_IV: /* IV reference */
10461 ptr = POPPTR(ss,ix);
10462 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10464 TOPIV(nss,ix) = iv;
10466 case SAVEt_HPTR: /* HV* reference */
10467 case SAVEt_APTR: /* AV* reference */
10468 case SAVEt_SPTR: /* SV* reference */
10469 ptr = POPPTR(ss,ix);
10470 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10471 sv = (SV*)POPPTR(ss,ix);
10472 TOPPTR(nss,ix) = sv_dup(sv, param);
10474 case SAVEt_VPTR: /* random* reference */
10475 ptr = POPPTR(ss,ix);
10476 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10477 ptr = POPPTR(ss,ix);
10478 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10480 case SAVEt_GENERIC_PVREF: /* generic char* */
10481 case SAVEt_PPTR: /* char* reference */
10482 ptr = POPPTR(ss,ix);
10483 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10484 c = (char*)POPPTR(ss,ix);
10485 TOPPTR(nss,ix) = pv_dup(c);
10487 case SAVEt_GP: /* scalar reference */
10488 gp = (GP*)POPPTR(ss,ix);
10489 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10490 (void)GpREFCNT_inc(gp);
10491 gv = (GV*)POPPTR(ss,ix);
10492 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10495 ptr = POPPTR(ss,ix);
10496 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10497 /* these are assumed to be refcounted properly */
10499 switch (((OP*)ptr)->op_type) {
10501 case OP_LEAVESUBLV:
10505 case OP_LEAVEWRITE:
10506 TOPPTR(nss,ix) = ptr;
10509 (void) OpREFCNT_inc(o);
10513 TOPPTR(nss,ix) = NULL;
10518 TOPPTR(nss,ix) = NULL;
10521 c = (char*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = pv_dup_inc(c);
10525 hv = (HV*)POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10527 c = (char*)POPPTR(ss,ix);
10528 TOPPTR(nss,ix) = pv_dup_inc(c);
10530 case SAVEt_STACK_POS: /* Position on Perl stack */
10532 TOPINT(nss,ix) = i;
10534 case SAVEt_DESTRUCTOR:
10535 ptr = POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10537 dptr = POPDPTR(ss,ix);
10538 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10539 any_dup(FPTR2DPTR(void *, dptr),
10542 case SAVEt_DESTRUCTOR_X:
10543 ptr = POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10545 dxptr = POPDXPTR(ss,ix);
10546 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10547 any_dup(FPTR2DPTR(void *, dxptr),
10550 case SAVEt_REGCONTEXT:
10553 TOPINT(nss,ix) = i;
10556 case SAVEt_AELEM: /* array element */
10557 sv = (SV*)POPPTR(ss,ix);
10558 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10560 TOPINT(nss,ix) = i;
10561 av = (AV*)POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = av_dup_inc(av, param);
10565 ptr = POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = ptr;
10570 TOPINT(nss,ix) = i;
10571 ptr = POPPTR(ss,ix);
10574 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10575 HINTS_REFCNT_UNLOCK;
10577 TOPPTR(nss,ix) = ptr;
10578 if (i & HINT_LOCALIZE_HH) {
10579 hv = (HV*)POPPTR(ss,ix);
10580 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10584 longval = (long)POPLONG(ss,ix);
10585 TOPLONG(nss,ix) = longval;
10586 ptr = POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10588 sv = (SV*)POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = sv_dup(sv, param);
10592 ptr = POPPTR(ss,ix);
10593 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10594 longval = (long)POPBOOL(ss,ix);
10595 TOPBOOL(nss,ix) = (bool)longval;
10597 case SAVEt_SET_SVFLAGS:
10599 TOPINT(nss,ix) = i;
10601 TOPINT(nss,ix) = i;
10602 sv = (SV*)POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = sv_dup(sv, param);
10605 case SAVEt_RE_STATE:
10607 const struct re_save_state *const old_state
10608 = (struct re_save_state *)
10609 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10610 struct re_save_state *const new_state
10611 = (struct re_save_state *)
10612 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10614 Copy(old_state, new_state, 1, struct re_save_state);
10615 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10617 new_state->re_state_bostr
10618 = pv_dup(old_state->re_state_bostr);
10619 new_state->re_state_reginput
10620 = pv_dup(old_state->re_state_reginput);
10621 new_state->re_state_regeol
10622 = pv_dup(old_state->re_state_regeol);
10623 new_state->re_state_regoffs
10624 = (regexp_paren_pair*)
10625 any_dup(old_state->re_state_regoffs, proto_perl);
10626 new_state->re_state_reglastparen
10627 = (U32*) any_dup(old_state->re_state_reglastparen,
10629 new_state->re_state_reglastcloseparen
10630 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10632 /* XXX This just has to be broken. The old save_re_context
10633 code did SAVEGENERICPV(PL_reg_start_tmp);
10634 PL_reg_start_tmp is char **.
10635 Look above to what the dup code does for
10636 SAVEt_GENERIC_PVREF
10637 It can never have worked.
10638 So this is merely a faithful copy of the exiting bug: */
10639 new_state->re_state_reg_start_tmp
10640 = (char **) pv_dup((char *)
10641 old_state->re_state_reg_start_tmp);
10642 /* I assume that it only ever "worked" because no-one called
10643 (pseudo)fork while the regexp engine had re-entered itself.
10645 #ifdef PERL_OLD_COPY_ON_WRITE
10646 new_state->re_state_nrs
10647 = sv_dup(old_state->re_state_nrs, param);
10649 new_state->re_state_reg_magic
10650 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10652 new_state->re_state_reg_oldcurpm
10653 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10655 new_state->re_state_reg_curpm
10656 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10658 new_state->re_state_reg_oldsaved
10659 = pv_dup(old_state->re_state_reg_oldsaved);
10660 new_state->re_state_reg_poscache
10661 = pv_dup(old_state->re_state_reg_poscache);
10662 new_state->re_state_reg_starttry
10663 = pv_dup(old_state->re_state_reg_starttry);
10666 case SAVEt_COMPILE_WARNINGS:
10667 ptr = POPPTR(ss,ix);
10668 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10671 ptr = POPPTR(ss,ix);
10672 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10676 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10684 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10685 * flag to the result. This is done for each stash before cloning starts,
10686 * so we know which stashes want their objects cloned */
10689 do_mark_cloneable_stash(pTHX_ SV *sv)
10691 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10693 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10694 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10695 if (cloner && GvCV(cloner)) {
10702 XPUSHs(sv_2mortal(newSVhek(hvname)));
10704 call_sv((SV*)GvCV(cloner), G_SCALAR);
10711 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10719 =for apidoc perl_clone
10721 Create and return a new interpreter by cloning the current one.
10723 perl_clone takes these flags as parameters:
10725 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10726 without it we only clone the data and zero the stacks,
10727 with it we copy the stacks and the new perl interpreter is
10728 ready to run at the exact same point as the previous one.
10729 The pseudo-fork code uses COPY_STACKS while the
10730 threads->create doesn't.
10732 CLONEf_KEEP_PTR_TABLE
10733 perl_clone keeps a ptr_table with the pointer of the old
10734 variable as a key and the new variable as a value,
10735 this allows it to check if something has been cloned and not
10736 clone it again but rather just use the value and increase the
10737 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10738 the ptr_table using the function
10739 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10740 reason to keep it around is if you want to dup some of your own
10741 variable who are outside the graph perl scans, example of this
10742 code is in threads.xs create
10745 This is a win32 thing, it is ignored on unix, it tells perls
10746 win32host code (which is c++) to clone itself, this is needed on
10747 win32 if you want to run two threads at the same time,
10748 if you just want to do some stuff in a separate perl interpreter
10749 and then throw it away and return to the original one,
10750 you don't need to do anything.
10755 /* XXX the above needs expanding by someone who actually understands it ! */
10756 EXTERN_C PerlInterpreter *
10757 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10760 perl_clone(PerlInterpreter *proto_perl, UV flags)
10763 #ifdef PERL_IMPLICIT_SYS
10765 /* perlhost.h so we need to call into it
10766 to clone the host, CPerlHost should have a c interface, sky */
10768 if (flags & CLONEf_CLONE_HOST) {
10769 return perl_clone_host(proto_perl,flags);
10771 return perl_clone_using(proto_perl, flags,
10773 proto_perl->IMemShared,
10774 proto_perl->IMemParse,
10776 proto_perl->IStdIO,
10780 proto_perl->IProc);
10784 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10785 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10786 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10787 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10788 struct IPerlDir* ipD, struct IPerlSock* ipS,
10789 struct IPerlProc* ipP)
10791 /* XXX many of the string copies here can be optimized if they're
10792 * constants; they need to be allocated as common memory and just
10793 * their pointers copied. */
10796 CLONE_PARAMS clone_params;
10797 CLONE_PARAMS* const param = &clone_params;
10799 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10800 /* for each stash, determine whether its objects should be cloned */
10801 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10802 PERL_SET_THX(my_perl);
10805 PoisonNew(my_perl, 1, PerlInterpreter);
10811 PL_savestack_ix = 0;
10812 PL_savestack_max = -1;
10813 PL_sig_pending = 0;
10814 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10815 # else /* !DEBUGGING */
10816 Zero(my_perl, 1, PerlInterpreter);
10817 # endif /* DEBUGGING */
10819 /* host pointers */
10821 PL_MemShared = ipMS;
10822 PL_MemParse = ipMP;
10829 #else /* !PERL_IMPLICIT_SYS */
10831 CLONE_PARAMS clone_params;
10832 CLONE_PARAMS* param = &clone_params;
10833 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10834 /* for each stash, determine whether its objects should be cloned */
10835 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10836 PERL_SET_THX(my_perl);
10839 PoisonNew(my_perl, 1, PerlInterpreter);
10845 PL_savestack_ix = 0;
10846 PL_savestack_max = -1;
10847 PL_sig_pending = 0;
10848 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10849 # else /* !DEBUGGING */
10850 Zero(my_perl, 1, PerlInterpreter);
10851 # endif /* DEBUGGING */
10852 #endif /* PERL_IMPLICIT_SYS */
10853 param->flags = flags;
10854 param->proto_perl = proto_perl;
10856 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10858 PL_body_arenas = NULL;
10859 Zero(&PL_body_roots, 1, PL_body_roots);
10861 PL_nice_chunk = NULL;
10862 PL_nice_chunk_size = 0;
10864 PL_sv_objcount = 0;
10866 PL_sv_arenaroot = NULL;
10868 PL_debug = proto_perl->Idebug;
10870 PL_hash_seed = proto_perl->Ihash_seed;
10871 PL_rehash_seed = proto_perl->Irehash_seed;
10873 #ifdef USE_REENTRANT_API
10874 /* XXX: things like -Dm will segfault here in perlio, but doing
10875 * PERL_SET_CONTEXT(proto_perl);
10876 * breaks too many other things
10878 Perl_reentrant_init(aTHX);
10881 /* create SV map for pointer relocation */
10882 PL_ptr_table = ptr_table_new();
10884 /* initialize these special pointers as early as possible */
10885 SvANY(&PL_sv_undef) = NULL;
10886 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10887 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10888 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10890 SvANY(&PL_sv_no) = new_XPVNV();
10891 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10892 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10893 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10894 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10895 SvCUR_set(&PL_sv_no, 0);
10896 SvLEN_set(&PL_sv_no, 1);
10897 SvIV_set(&PL_sv_no, 0);
10898 SvNV_set(&PL_sv_no, 0);
10899 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10901 SvANY(&PL_sv_yes) = new_XPVNV();
10902 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10903 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10904 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10905 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10906 SvCUR_set(&PL_sv_yes, 1);
10907 SvLEN_set(&PL_sv_yes, 2);
10908 SvIV_set(&PL_sv_yes, 1);
10909 SvNV_set(&PL_sv_yes, 1);
10910 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10912 /* create (a non-shared!) shared string table */
10913 PL_strtab = newHV();
10914 HvSHAREKEYS_off(PL_strtab);
10915 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10916 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10918 PL_compiling = proto_perl->Icompiling;
10920 /* These two PVs will be free'd special way so must set them same way op.c does */
10921 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10922 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10924 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10925 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10927 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10928 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10929 if (PL_compiling.cop_hints_hash) {
10931 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10932 HINTS_REFCNT_UNLOCK;
10934 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10935 #ifdef PERL_DEBUG_READONLY_OPS
10940 /* pseudo environmental stuff */
10941 PL_origargc = proto_perl->Iorigargc;
10942 PL_origargv = proto_perl->Iorigargv;
10944 param->stashes = newAV(); /* Setup array of objects to call clone on */
10946 /* Set tainting stuff before PerlIO_debug can possibly get called */
10947 PL_tainting = proto_perl->Itainting;
10948 PL_taint_warn = proto_perl->Itaint_warn;
10950 #ifdef PERLIO_LAYERS
10951 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10952 PerlIO_clone(aTHX_ proto_perl, param);
10955 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10956 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10957 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10958 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10959 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10960 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10963 PL_minus_c = proto_perl->Iminus_c;
10964 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10965 PL_localpatches = proto_perl->Ilocalpatches;
10966 PL_splitstr = proto_perl->Isplitstr;
10967 PL_preprocess = proto_perl->Ipreprocess;
10968 PL_minus_n = proto_perl->Iminus_n;
10969 PL_minus_p = proto_perl->Iminus_p;
10970 PL_minus_l = proto_perl->Iminus_l;
10971 PL_minus_a = proto_perl->Iminus_a;
10972 PL_minus_E = proto_perl->Iminus_E;
10973 PL_minus_F = proto_perl->Iminus_F;
10974 PL_doswitches = proto_perl->Idoswitches;
10975 PL_dowarn = proto_perl->Idowarn;
10976 PL_doextract = proto_perl->Idoextract;
10977 PL_sawampersand = proto_perl->Isawampersand;
10978 PL_unsafe = proto_perl->Iunsafe;
10979 PL_inplace = SAVEPV(proto_perl->Iinplace);
10980 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10981 PL_perldb = proto_perl->Iperldb;
10982 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10983 PL_exit_flags = proto_perl->Iexit_flags;
10985 /* magical thingies */
10986 /* XXX time(&PL_basetime) when asked for? */
10987 PL_basetime = proto_perl->Ibasetime;
10988 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10990 PL_maxsysfd = proto_perl->Imaxsysfd;
10991 PL_statusvalue = proto_perl->Istatusvalue;
10993 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10995 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10997 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10999 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11000 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11001 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11004 /* RE engine related */
11005 Zero(&PL_reg_state, 1, struct re_save_state);
11006 PL_reginterp_cnt = 0;
11007 PL_regmatch_slab = NULL;
11009 /* Clone the regex array */
11010 PL_regex_padav = newAV();
11012 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11013 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11015 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11016 for(i = 1; i <= len; i++) {
11017 const SV * const regex = regexen[i];
11020 ? sv_dup_inc(regex, param)
11022 newSViv(PTR2IV(CALLREGDUPE(
11023 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11025 if (SvFLAGS(regex) & SVf_BREAK)
11026 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11027 av_push(PL_regex_padav, sv);
11030 PL_regex_pad = AvARRAY(PL_regex_padav);
11032 /* shortcuts to various I/O objects */
11033 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11034 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11035 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11036 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11037 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11038 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11040 /* shortcuts to regexp stuff */
11041 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11043 /* shortcuts to misc objects */
11044 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11046 /* shortcuts to debugging objects */
11047 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11048 PL_DBline = gv_dup(proto_perl->IDBline, param);
11049 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11050 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11051 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11052 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11053 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11054 PL_lineary = av_dup(proto_perl->Ilineary, param);
11055 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11057 /* symbol tables */
11058 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11059 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11060 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11061 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11062 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11064 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11065 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11066 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11067 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11068 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11069 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11070 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11071 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11073 PL_sub_generation = proto_perl->Isub_generation;
11075 /* funky return mechanisms */
11076 PL_forkprocess = proto_perl->Iforkprocess;
11078 /* subprocess state */
11079 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11081 /* internal state */
11082 PL_maxo = proto_perl->Imaxo;
11083 if (proto_perl->Iop_mask)
11084 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11087 /* PL_asserting = proto_perl->Iasserting; */
11089 /* current interpreter roots */
11090 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11092 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11094 PL_main_start = proto_perl->Imain_start;
11095 PL_eval_root = proto_perl->Ieval_root;
11096 PL_eval_start = proto_perl->Ieval_start;
11098 /* runtime control stuff */
11099 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11100 PL_copline = proto_perl->Icopline;
11102 PL_filemode = proto_perl->Ifilemode;
11103 PL_lastfd = proto_perl->Ilastfd;
11104 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11107 PL_gensym = proto_perl->Igensym;
11108 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11109 PL_laststatval = proto_perl->Ilaststatval;
11110 PL_laststype = proto_perl->Ilaststype;
11113 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11115 /* interpreter atexit processing */
11116 PL_exitlistlen = proto_perl->Iexitlistlen;
11117 if (PL_exitlistlen) {
11118 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11119 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11122 PL_exitlist = (PerlExitListEntry*)NULL;
11124 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11125 if (PL_my_cxt_size) {
11126 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11127 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11128 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11129 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11130 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11134 PL_my_cxt_list = (void**)NULL;
11135 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11136 PL_my_cxt_keys = (const char**)NULL;
11139 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11140 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11141 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11143 PL_profiledata = NULL;
11144 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11145 /* PL_rsfp_filters entries have fake IoDIRP() */
11146 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11148 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11150 PAD_CLONE_VARS(proto_perl, param);
11152 #ifdef HAVE_INTERP_INTERN
11153 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11156 /* more statics moved here */
11157 PL_generation = proto_perl->Igeneration;
11158 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11160 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11161 PL_in_clean_all = proto_perl->Iin_clean_all;
11163 PL_uid = proto_perl->Iuid;
11164 PL_euid = proto_perl->Ieuid;
11165 PL_gid = proto_perl->Igid;
11166 PL_egid = proto_perl->Iegid;
11167 PL_nomemok = proto_perl->Inomemok;
11168 PL_an = proto_perl->Ian;
11169 PL_evalseq = proto_perl->Ievalseq;
11170 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11171 PL_origalen = proto_perl->Iorigalen;
11172 #ifdef PERL_USES_PL_PIDSTATUS
11173 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11175 PL_osname = SAVEPV(proto_perl->Iosname);
11176 PL_sighandlerp = proto_perl->Isighandlerp;
11178 PL_runops = proto_perl->Irunops;
11180 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11183 PL_cshlen = proto_perl->Icshlen;
11184 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11187 PL_parser = parser_dup(proto_perl->Iparser, param);
11189 PL_lex_state = proto_perl->Ilex_state;
11192 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11193 PL_curforce = proto_perl->Icurforce;
11195 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11196 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11197 PL_nexttoke = proto_perl->Inexttoke;
11200 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11201 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11202 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11203 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11204 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11205 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11206 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11207 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11208 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11209 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11211 PL_expect = proto_perl->Iexpect;
11213 PL_multi_end = proto_perl->Imulti_end;
11215 PL_error_count = proto_perl->Ierror_count;
11216 PL_subline = proto_perl->Isubline;
11217 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11219 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11220 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11221 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11222 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11223 PL_last_lop_op = proto_perl->Ilast_lop_op;
11224 PL_in_my = proto_perl->Iin_my;
11225 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11227 PL_cryptseen = proto_perl->Icryptseen;
11230 PL_hints = proto_perl->Ihints;
11232 PL_amagic_generation = proto_perl->Iamagic_generation;
11234 #ifdef USE_LOCALE_COLLATE
11235 PL_collation_ix = proto_perl->Icollation_ix;
11236 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11237 PL_collation_standard = proto_perl->Icollation_standard;
11238 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11239 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11240 #endif /* USE_LOCALE_COLLATE */
11242 #ifdef USE_LOCALE_NUMERIC
11243 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11244 PL_numeric_standard = proto_perl->Inumeric_standard;
11245 PL_numeric_local = proto_perl->Inumeric_local;
11246 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11247 #endif /* !USE_LOCALE_NUMERIC */
11249 /* utf8 character classes */
11250 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11251 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11252 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11253 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11254 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11255 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11256 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11257 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11258 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11259 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11260 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11261 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11262 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11263 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11264 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11265 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11266 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11267 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11268 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11269 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11271 /* Did the locale setup indicate UTF-8? */
11272 PL_utf8locale = proto_perl->Iutf8locale;
11273 /* Unicode features (see perlrun/-C) */
11274 PL_unicode = proto_perl->Iunicode;
11276 /* Pre-5.8 signals control */
11277 PL_signals = proto_perl->Isignals;
11279 /* times() ticks per second */
11280 PL_clocktick = proto_perl->Iclocktick;
11282 /* Recursion stopper for PerlIO_find_layer */
11283 PL_in_load_module = proto_perl->Iin_load_module;
11285 /* sort() routine */
11286 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11288 /* Not really needed/useful since the reenrant_retint is "volatile",
11289 * but do it for consistency's sake. */
11290 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11292 /* Hooks to shared SVs and locks. */
11293 PL_sharehook = proto_perl->Isharehook;
11294 PL_lockhook = proto_perl->Ilockhook;
11295 PL_unlockhook = proto_perl->Iunlockhook;
11296 PL_threadhook = proto_perl->Ithreadhook;
11298 PL_runops_std = proto_perl->Irunops_std;
11299 PL_runops_dbg = proto_perl->Irunops_dbg;
11301 #ifdef THREADS_HAVE_PIDS
11302 PL_ppid = proto_perl->Ippid;
11306 PL_last_swash_hv = NULL; /* reinits on demand */
11307 PL_last_swash_klen = 0;
11308 PL_last_swash_key[0]= '\0';
11309 PL_last_swash_tmps = (U8*)NULL;
11310 PL_last_swash_slen = 0;
11312 PL_glob_index = proto_perl->Iglob_index;
11313 PL_srand_called = proto_perl->Isrand_called;
11314 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11315 PL_bitcount = NULL; /* reinits on demand */
11317 if (proto_perl->Ipsig_pend) {
11318 Newxz(PL_psig_pend, SIG_SIZE, int);
11321 PL_psig_pend = (int*)NULL;
11324 if (proto_perl->Ipsig_ptr) {
11325 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11326 Newxz(PL_psig_name, SIG_SIZE, SV*);
11327 for (i = 1; i < SIG_SIZE; i++) {
11328 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11329 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11333 PL_psig_ptr = (SV**)NULL;
11334 PL_psig_name = (SV**)NULL;
11337 /* thrdvar.h stuff */
11339 if (flags & CLONEf_COPY_STACKS) {
11340 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11341 PL_tmps_ix = proto_perl->Ttmps_ix;
11342 PL_tmps_max = proto_perl->Ttmps_max;
11343 PL_tmps_floor = proto_perl->Ttmps_floor;
11344 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11346 while (i <= PL_tmps_ix) {
11347 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11351 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11352 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11353 Newxz(PL_markstack, i, I32);
11354 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11355 - proto_perl->Tmarkstack);
11356 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11357 - proto_perl->Tmarkstack);
11358 Copy(proto_perl->Tmarkstack, PL_markstack,
11359 PL_markstack_ptr - PL_markstack + 1, I32);
11361 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11362 * NOTE: unlike the others! */
11363 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11364 PL_scopestack_max = proto_perl->Tscopestack_max;
11365 Newxz(PL_scopestack, PL_scopestack_max, I32);
11366 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11368 /* NOTE: si_dup() looks at PL_markstack */
11369 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11371 /* PL_curstack = PL_curstackinfo->si_stack; */
11372 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11373 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11375 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11376 PL_stack_base = AvARRAY(PL_curstack);
11377 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11378 - proto_perl->Tstack_base);
11379 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11381 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11382 * NOTE: unlike the others! */
11383 PL_savestack_ix = proto_perl->Tsavestack_ix;
11384 PL_savestack_max = proto_perl->Tsavestack_max;
11385 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11386 PL_savestack = ss_dup(proto_perl, param);
11390 ENTER; /* perl_destruct() wants to LEAVE; */
11392 /* although we're not duplicating the tmps stack, we should still
11393 * add entries for any SVs on the tmps stack that got cloned by a
11394 * non-refcount means (eg a temp in @_); otherwise they will be
11397 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11398 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11399 proto_perl->Ttmps_stack[i]);
11400 if (nsv && !SvREFCNT(nsv)) {
11402 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11407 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11408 PL_top_env = &PL_start_env;
11410 PL_op = proto_perl->Top;
11413 PL_Xpv = (XPV*)NULL;
11414 PL_na = proto_perl->Tna;
11416 PL_statbuf = proto_perl->Tstatbuf;
11417 PL_statcache = proto_perl->Tstatcache;
11418 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11419 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11421 PL_timesbuf = proto_perl->Ttimesbuf;
11424 PL_tainted = proto_perl->Ttainted;
11425 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11426 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11427 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11428 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11429 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11430 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11431 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11432 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11433 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11435 PL_restartop = proto_perl->Trestartop;
11436 PL_in_eval = proto_perl->Tin_eval;
11437 PL_delaymagic = proto_perl->Tdelaymagic;
11438 PL_dirty = proto_perl->Tdirty;
11439 PL_localizing = proto_perl->Tlocalizing;
11441 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11442 PL_hv_fetch_ent_mh = NULL;
11443 PL_modcount = proto_perl->Tmodcount;
11444 PL_lastgotoprobe = NULL;
11445 PL_dumpindent = proto_perl->Tdumpindent;
11447 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11448 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11449 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11450 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11451 PL_efloatbuf = NULL; /* reinits on demand */
11452 PL_efloatsize = 0; /* reinits on demand */
11456 PL_screamfirst = NULL;
11457 PL_screamnext = NULL;
11458 PL_maxscream = -1; /* reinits on demand */
11459 PL_lastscream = NULL;
11461 PL_watchaddr = NULL;
11464 PL_regdummy = proto_perl->Tregdummy;
11465 PL_colorset = 0; /* reinits PL_colors[] */
11466 /*PL_colors[6] = {0,0,0,0,0,0};*/
11470 /* Pluggable optimizer */
11471 PL_peepp = proto_perl->Tpeepp;
11473 PL_stashcache = newHV();
11475 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11476 ptr_table_free(PL_ptr_table);
11477 PL_ptr_table = NULL;
11480 /* Call the ->CLONE method, if it exists, for each of the stashes
11481 identified by sv_dup() above.
11483 while(av_len(param->stashes) != -1) {
11484 HV* const stash = (HV*) av_shift(param->stashes);
11485 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11486 if (cloner && GvCV(cloner)) {
11491 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11493 call_sv((SV*)GvCV(cloner), G_DISCARD);
11499 SvREFCNT_dec(param->stashes);
11501 /* orphaned? eg threads->new inside BEGIN or use */
11502 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11503 SvREFCNT_inc_simple_void(PL_compcv);
11504 SAVEFREESV(PL_compcv);
11510 #endif /* USE_ITHREADS */
11513 =head1 Unicode Support
11515 =for apidoc sv_recode_to_utf8
11517 The encoding is assumed to be an Encode object, on entry the PV
11518 of the sv is assumed to be octets in that encoding, and the sv
11519 will be converted into Unicode (and UTF-8).
11521 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11522 is not a reference, nothing is done to the sv. If the encoding is not
11523 an C<Encode::XS> Encoding object, bad things will happen.
11524 (See F<lib/encoding.pm> and L<Encode>).
11526 The PV of the sv is returned.
11531 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11534 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11548 Passing sv_yes is wrong - it needs to be or'ed set of constants
11549 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11550 remove converted chars from source.
11552 Both will default the value - let them.
11554 XPUSHs(&PL_sv_yes);
11557 call_method("decode", G_SCALAR);
11561 s = SvPV_const(uni, len);
11562 if (s != SvPVX_const(sv)) {
11563 SvGROW(sv, len + 1);
11564 Move(s, SvPVX(sv), len + 1, char);
11565 SvCUR_set(sv, len);
11572 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11576 =for apidoc sv_cat_decode
11578 The encoding is assumed to be an Encode object, the PV of the ssv is
11579 assumed to be octets in that encoding and decoding the input starts
11580 from the position which (PV + *offset) pointed to. The dsv will be
11581 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11582 when the string tstr appears in decoding output or the input ends on
11583 the PV of the ssv. The value which the offset points will be modified
11584 to the last input position on the ssv.
11586 Returns TRUE if the terminator was found, else returns FALSE.
11591 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11592 SV *ssv, int *offset, char *tstr, int tlen)
11596 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11607 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11608 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11610 call_method("cat_decode", G_SCALAR);
11612 ret = SvTRUE(TOPs);
11613 *offset = SvIV(offsv);
11619 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11624 /* ---------------------------------------------------------------------
11626 * support functions for report_uninit()
11629 /* the maxiumum size of array or hash where we will scan looking
11630 * for the undefined element that triggered the warning */
11632 #define FUV_MAX_SEARCH_SIZE 1000
11634 /* Look for an entry in the hash whose value has the same SV as val;
11635 * If so, return a mortal copy of the key. */
11638 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11641 register HE **array;
11644 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11645 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11648 array = HvARRAY(hv);
11650 for (i=HvMAX(hv); i>0; i--) {
11651 register HE *entry;
11652 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11653 if (HeVAL(entry) != val)
11655 if ( HeVAL(entry) == &PL_sv_undef ||
11656 HeVAL(entry) == &PL_sv_placeholder)
11660 if (HeKLEN(entry) == HEf_SVKEY)
11661 return sv_mortalcopy(HeKEY_sv(entry));
11662 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11668 /* Look for an entry in the array whose value has the same SV as val;
11669 * If so, return the index, otherwise return -1. */
11672 S_find_array_subscript(pTHX_ AV *av, SV* val)
11675 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11676 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11679 if (val != &PL_sv_undef) {
11680 SV ** const svp = AvARRAY(av);
11683 for (i=AvFILLp(av); i>=0; i--)
11690 /* S_varname(): return the name of a variable, optionally with a subscript.
11691 * If gv is non-zero, use the name of that global, along with gvtype (one
11692 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11693 * targ. Depending on the value of the subscript_type flag, return:
11696 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11697 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11698 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11699 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11702 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11703 SV* keyname, I32 aindex, int subscript_type)
11706 SV * const name = sv_newmortal();
11709 buffer[0] = gvtype;
11712 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11714 gv_fullname4(name, gv, buffer, 0);
11716 if ((unsigned int)SvPVX(name)[1] <= 26) {
11718 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11720 /* Swap the 1 unprintable control character for the 2 byte pretty
11721 version - ie substr($name, 1, 1) = $buffer; */
11722 sv_insert(name, 1, 1, buffer, 2);
11727 CV * const cv = find_runcv(&unused);
11731 if (!cv || !CvPADLIST(cv))
11733 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11734 sv = *av_fetch(av, targ, FALSE);
11735 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11738 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11739 SV * const sv = newSV(0);
11740 *SvPVX(name) = '$';
11741 Perl_sv_catpvf(aTHX_ name, "{%s}",
11742 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11745 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11746 *SvPVX(name) = '$';
11747 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11749 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11750 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11757 =for apidoc find_uninit_var
11759 Find the name of the undefined variable (if any) that caused the operator o
11760 to issue a "Use of uninitialized value" warning.
11761 If match is true, only return a name if it's value matches uninit_sv.
11762 So roughly speaking, if a unary operator (such as OP_COS) generates a
11763 warning, then following the direct child of the op may yield an
11764 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11765 other hand, with OP_ADD there are two branches to follow, so we only print
11766 the variable name if we get an exact match.
11768 The name is returned as a mortal SV.
11770 Assumes that PL_op is the op that originally triggered the error, and that
11771 PL_comppad/PL_curpad points to the currently executing pad.
11777 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11785 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11786 uninit_sv == &PL_sv_placeholder)))
11789 switch (obase->op_type) {
11796 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11797 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11800 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11802 if (pad) { /* @lex, %lex */
11803 sv = PAD_SVl(obase->op_targ);
11807 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11808 /* @global, %global */
11809 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11812 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11814 else /* @{expr}, %{expr} */
11815 return find_uninit_var(cUNOPx(obase)->op_first,
11819 /* attempt to find a match within the aggregate */
11821 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11823 subscript_type = FUV_SUBSCRIPT_HASH;
11826 index = find_array_subscript((AV*)sv, uninit_sv);
11828 subscript_type = FUV_SUBSCRIPT_ARRAY;
11831 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11834 return varname(gv, hash ? '%' : '@', obase->op_targ,
11835 keysv, index, subscript_type);
11839 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11841 return varname(NULL, '$', obase->op_targ,
11842 NULL, 0, FUV_SUBSCRIPT_NONE);
11845 gv = cGVOPx_gv(obase);
11846 if (!gv || (match && GvSV(gv) != uninit_sv))
11848 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11851 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11854 av = (AV*)PAD_SV(obase->op_targ);
11855 if (!av || SvRMAGICAL(av))
11857 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11858 if (!svp || *svp != uninit_sv)
11861 return varname(NULL, '$', obase->op_targ,
11862 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11865 gv = cGVOPx_gv(obase);
11871 if (!av || SvRMAGICAL(av))
11873 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11874 if (!svp || *svp != uninit_sv)
11877 return varname(gv, '$', 0,
11878 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11883 o = cUNOPx(obase)->op_first;
11884 if (!o || o->op_type != OP_NULL ||
11885 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11887 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11891 if (PL_op == obase)
11892 /* $a[uninit_expr] or $h{uninit_expr} */
11893 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11896 o = cBINOPx(obase)->op_first;
11897 kid = cBINOPx(obase)->op_last;
11899 /* get the av or hv, and optionally the gv */
11901 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11902 sv = PAD_SV(o->op_targ);
11904 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11905 && cUNOPo->op_first->op_type == OP_GV)
11907 gv = cGVOPx_gv(cUNOPo->op_first);
11910 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11915 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11916 /* index is constant */
11920 if (obase->op_type == OP_HELEM) {
11921 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11922 if (!he || HeVAL(he) != uninit_sv)
11926 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11927 if (!svp || *svp != uninit_sv)
11931 if (obase->op_type == OP_HELEM)
11932 return varname(gv, '%', o->op_targ,
11933 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11935 return varname(gv, '@', o->op_targ, NULL,
11936 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11939 /* index is an expression;
11940 * attempt to find a match within the aggregate */
11941 if (obase->op_type == OP_HELEM) {
11942 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11944 return varname(gv, '%', o->op_targ,
11945 keysv, 0, FUV_SUBSCRIPT_HASH);
11948 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11950 return varname(gv, '@', o->op_targ,
11951 NULL, index, FUV_SUBSCRIPT_ARRAY);
11956 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11958 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11963 /* only examine RHS */
11964 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11967 o = cUNOPx(obase)->op_first;
11968 if (o->op_type == OP_PUSHMARK)
11971 if (!o->op_sibling) {
11972 /* one-arg version of open is highly magical */
11974 if (o->op_type == OP_GV) { /* open FOO; */
11976 if (match && GvSV(gv) != uninit_sv)
11978 return varname(gv, '$', 0,
11979 NULL, 0, FUV_SUBSCRIPT_NONE);
11981 /* other possibilities not handled are:
11982 * open $x; or open my $x; should return '${*$x}'
11983 * open expr; should return '$'.expr ideally
11989 /* ops where $_ may be an implicit arg */
11993 if ( !(obase->op_flags & OPf_STACKED)) {
11994 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
11995 ? PAD_SVl(obase->op_targ)
11998 sv = sv_newmortal();
11999 sv_setpvn(sv, "$_", 2);
12008 /* skip filehandle as it can't produce 'undef' warning */
12009 o = cUNOPx(obase)->op_first;
12010 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12011 o = o->op_sibling->op_sibling;
12018 match = 1; /* XS or custom code could trigger random warnings */
12023 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12024 return sv_2mortal(newSVpvs("${$/}"));
12029 if (!(obase->op_flags & OPf_KIDS))
12031 o = cUNOPx(obase)->op_first;
12037 /* if all except one arg are constant, or have no side-effects,
12038 * or are optimized away, then it's unambiguous */
12040 for (kid=o; kid; kid = kid->op_sibling) {
12042 const OPCODE type = kid->op_type;
12043 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12044 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12045 || (type == OP_PUSHMARK)
12049 if (o2) { /* more than one found */
12056 return find_uninit_var(o2, uninit_sv, match);
12058 /* scan all args */
12060 sv = find_uninit_var(o, uninit_sv, 1);
12072 =for apidoc report_uninit
12074 Print appropriate "Use of uninitialized variable" warning
12080 Perl_report_uninit(pTHX_ SV* uninit_sv)
12084 SV* varname = NULL;
12086 varname = find_uninit_var(PL_op, uninit_sv,0);
12088 sv_insert(varname, 0, 0, " ", 1);
12090 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12091 varname ? SvPV_nolen_const(varname) : "",
12092 " in ", OP_DESC(PL_op));
12095 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12101 * c-indentation-style: bsd
12102 * c-basic-offset: 4
12103 * indent-tabs-mode: t
12106 * ex: set ts=8 sts=4 sw=4 noet: