3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 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 Manipulation of any of the PL_*root pointers is protected by enclosing
108 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
109 if threads are enabled.
111 The function visit() scans the SV arenas list, and calls a specified
112 function for each SV it finds which is still live - ie which has an SvTYPE
113 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
114 following functions (specified as [function that calls visit()] / [function
115 called by visit() for each SV]):
117 sv_report_used() / do_report_used()
118 dump all remaining SVs (debugging aid)
120 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
121 Attempt to free all objects pointed to by RVs,
122 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
123 try to do the same for all objects indirectly
124 referenced by typeglobs too. Called once from
125 perl_destruct(), prior to calling sv_clean_all()
128 sv_clean_all() / do_clean_all()
129 SvREFCNT_dec(sv) each remaining SV, possibly
130 triggering an sv_free(). It also sets the
131 SVf_BREAK flag on the SV to indicate that the
132 refcnt has been artificially lowered, and thus
133 stopping sv_free() from giving spurious warnings
134 about SVs which unexpectedly have a refcnt
135 of zero. called repeatedly from perl_destruct()
136 until there are no SVs left.
138 =head2 Arena allocator API Summary
140 Private API to rest of sv.c
144 new_XIV(), del_XIV(),
145 new_XNV(), del_XNV(),
150 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
154 ============================================================================ */
157 * "A time to plant, and a time to uproot what was planted..."
161 * nice_chunk and nice_chunk size need to be set
162 * and queried under the protection of sv_mutex
165 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
171 new_chunk = (void *)(chunk);
172 new_chunk_size = (chunk_size);
173 if (new_chunk_size > PL_nice_chunk_size) {
174 Safefree(PL_nice_chunk);
175 PL_nice_chunk = (char *) new_chunk;
176 PL_nice_chunk_size = new_chunk_size;
183 #ifdef DEBUG_LEAKING_SCALARS
184 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
186 # define FREE_SV_DEBUG_FILE(sv)
190 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
191 /* Whilst I'd love to do this, it seems that things like to check on
193 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
195 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
196 PoisonNew(&SvREFCNT(sv), 1, U32)
198 # define SvARENA_CHAIN(sv) SvANY(sv)
199 # define POSION_SV_HEAD(sv)
202 #define plant_SV(p) \
204 FREE_SV_DEBUG_FILE(p); \
206 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
207 SvFLAGS(p) = SVTYPEMASK; \
212 /* sv_mutex must be held while calling uproot_SV() */
213 #define uproot_SV(p) \
216 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
221 /* make some more SVs by adding another arena */
223 /* sv_mutex must be held while calling more_sv() */
231 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
232 PL_nice_chunk = NULL;
233 PL_nice_chunk_size = 0;
236 char *chunk; /* must use New here to match call to */
237 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
238 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
244 /* new_SV(): return a new, empty SV head */
246 #ifdef DEBUG_LEAKING_SCALARS
247 /* provide a real function for a debugger to play with */
257 sv = S_more_sv(aTHX);
262 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
263 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
264 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
265 sv->sv_debug_inpad = 0;
266 sv->sv_debug_cloned = 0;
267 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
271 # define new_SV(p) (p)=S_new_SV(aTHX)
280 (p) = S_more_sv(aTHX); \
289 /* del_SV(): return an empty SV head to the free list */
304 S_del_sv(pTHX_ SV *p)
310 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
311 const SV * const sv = sva + 1;
312 const SV * const svend = &sva[SvREFCNT(sva)];
313 if (p >= sv && p < svend) {
319 if (ckWARN_d(WARN_INTERNAL))
320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
321 "Attempt to free non-arena SV: 0x%"UVxf
322 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
329 #else /* ! DEBUGGING */
331 #define del_SV(p) plant_SV(p)
333 #endif /* DEBUGGING */
337 =head1 SV Manipulation Functions
339 =for apidoc sv_add_arena
341 Given a chunk of memory, link it to the head of the list of arenas,
342 and split it into a list of free SVs.
348 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
351 SV* const sva = (SV*)ptr;
355 /* The first SV in an arena isn't an SV. */
356 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
357 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
358 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
360 PL_sv_arenaroot = sva;
361 PL_sv_root = sva + 1;
363 svend = &sva[SvREFCNT(sva) - 1];
366 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
370 /* Must always set typemask because it's awlays checked in on cleanup
371 when the arenas are walked looking for objects. */
372 SvFLAGS(sv) = SVTYPEMASK;
375 SvARENA_CHAIN(sv) = 0;
379 SvFLAGS(sv) = SVTYPEMASK;
382 /* visit(): call the named function for each non-free SV in the arenas
383 * whose flags field matches the flags/mask args. */
386 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
392 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
393 register const SV * const svend = &sva[SvREFCNT(sva)];
395 for (sv = sva + 1; sv < svend; ++sv) {
396 if (SvTYPE(sv) != SVTYPEMASK
397 && (sv->sv_flags & mask) == flags
410 /* called by sv_report_used() for each live SV */
413 do_report_used(pTHX_ SV *sv)
415 if (SvTYPE(sv) != SVTYPEMASK) {
416 PerlIO_printf(Perl_debug_log, "****\n");
423 =for apidoc sv_report_used
425 Dump the contents of all SVs not yet freed. (Debugging aid).
431 Perl_sv_report_used(pTHX)
434 visit(do_report_used, 0, 0);
440 /* called by sv_clean_objs() for each live SV */
443 do_clean_objs(pTHX_ SV *ref)
447 SV * const target = SvRV(ref);
448 if (SvOBJECT(target)) {
449 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
450 if (SvWEAKREF(ref)) {
451 sv_del_backref(target, ref);
457 SvREFCNT_dec(target);
462 /* XXX Might want to check arrays, etc. */
465 /* called by sv_clean_objs() for each live SV */
467 #ifndef DISABLE_DESTRUCTOR_KLUDGE
469 do_clean_named_objs(pTHX_ SV *sv)
472 if (SvTYPE(sv) == SVt_PVGV && isGV_with_GP(sv) && GvGP(sv)) {
474 #ifdef PERL_DONT_CREATE_GVSV
477 SvOBJECT(GvSV(sv))) ||
478 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
479 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
480 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
481 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
484 SvFLAGS(sv) |= SVf_BREAK;
492 =for apidoc sv_clean_objs
494 Attempt to destroy all objects not yet freed
500 Perl_sv_clean_objs(pTHX)
503 PL_in_clean_objs = TRUE;
504 visit(do_clean_objs, SVf_ROK, SVf_ROK);
505 #ifndef DISABLE_DESTRUCTOR_KLUDGE
506 /* some barnacles may yet remain, clinging to typeglobs */
507 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
509 PL_in_clean_objs = FALSE;
512 /* called by sv_clean_all() for each live SV */
515 do_clean_all(pTHX_ SV *sv)
518 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
519 SvFLAGS(sv) |= SVf_BREAK;
520 if (PL_comppad == (AV*)sv) {
528 =for apidoc sv_clean_all
530 Decrement the refcnt of each remaining SV, possibly triggering a
531 cleanup. This function may have to be called multiple times to free
532 SVs which are in complex self-referential hierarchies.
538 Perl_sv_clean_all(pTHX)
542 PL_in_clean_all = TRUE;
543 cleaned = visit(do_clean_all, 0,0);
544 PL_in_clean_all = FALSE;
549 ARENASETS: a meta-arena implementation which separates arena-info
550 into struct arena_set, which contains an array of struct
551 arena_descs, each holding info for a single arena. By separating
552 the meta-info from the arena, we recover the 1st slot, formerly
553 borrowed for list management. The arena_set is about the size of an
554 arena, avoiding the needless malloc overhead of a naive linked-list
556 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
557 memory in the last arena-set (1/2 on average). In trade, we get
558 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
559 smaller types). The recovery of the wasted space allows use of
560 small arenas for large, rare body types,
563 char *arena; /* the raw storage, allocated aligned */
564 size_t size; /* its size ~4k typ */
565 int unit_type; /* useful for arena audits */
566 /* info for sv-heads (eventually)
573 /* Get the maximum number of elements in set[] such that struct arena_set
574 will fit within PERL_ARENA_SIZE, which is probabably just under 4K, and
575 therefore likely to be 1 aligned memory page. */
577 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
578 - 2 * sizeof(int)) / sizeof (struct arena_desc))
581 struct arena_set* next;
582 int set_size; /* ie ARENAS_PER_SET */
583 int curr; /* index of next available arena-desc */
584 struct arena_desc set[ARENAS_PER_SET];
588 =for apidoc sv_free_arenas
590 Deallocate the memory used by all arenas. Note that all the individual SV
591 heads and bodies within the arenas must already have been freed.
596 Perl_sv_free_arenas(pTHX)
603 /* Free arenas here, but be careful about fake ones. (We assume
604 contiguity of the fake ones with the corresponding real ones.) */
606 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
607 svanext = (SV*) SvANY(sva);
608 while (svanext && SvFAKE(svanext))
609 svanext = (SV*) SvANY(svanext);
616 struct arena_set *next, *aroot = (struct arena_set*) PL_body_arenas;
618 for (; aroot; aroot = next) {
619 const int max = aroot->curr;
620 for (i=0; i<max; i++) {
621 assert(aroot->set[i].arena);
622 Safefree(aroot->set[i].arena);
630 for (i=0; i<PERL_ARENA_ROOTS_SIZE; i++)
631 PL_body_roots[i] = 0;
633 Safefree(PL_nice_chunk);
634 PL_nice_chunk = NULL;
635 PL_nice_chunk_size = 0;
641 Here are mid-level routines that manage the allocation of bodies out
642 of the various arenas. There are 5 kinds of arenas:
644 1. SV-head arenas, which are discussed and handled above
645 2. regular body arenas
646 3. arenas for reduced-size bodies
648 5. pte arenas (thread related)
650 Arena types 2 & 3 are chained by body-type off an array of
651 arena-root pointers, which is indexed by svtype. Some of the
652 larger/less used body types are malloced singly, since a large
653 unused block of them is wasteful. Also, several svtypes dont have
654 bodies; the data fits into the sv-head itself. The arena-root
655 pointer thus has a few unused root-pointers (which may be hijacked
656 later for arena types 4,5)
658 3 differs from 2 as an optimization; some body types have several
659 unused fields in the front of the structure (which are kept in-place
660 for consistency). These bodies can be allocated in smaller chunks,
661 because the leading fields arent accessed. Pointers to such bodies
662 are decremented to point at the unused 'ghost' memory, knowing that
663 the pointers are used with offsets to the real memory.
665 HE, HEK arenas are managed separately, with separate code, but may
666 be merge-able later..
668 PTE arenas are not sv-bodies, but they share these mid-level
669 mechanics, so are considered here. The new mid-level mechanics rely
670 on the sv_type of the body being allocated, so we just reserve one
671 of the unused body-slots for PTEs, then use it in those (2) PTE
672 contexts below (line ~10k)
675 /* get_arena(size): this creates custom-sized arenas
676 TBD: export properly for hv.c: S_more_he().
679 Perl_get_arena(pTHX_ int arena_size)
682 struct arena_desc* adesc;
683 struct arena_set *newroot, **aroot = (struct arena_set**) &PL_body_arenas;
686 /* shouldnt need this
687 if (!arena_size) arena_size = PERL_ARENA_SIZE;
690 /* may need new arena-set to hold new arena */
691 if (!*aroot || (*aroot)->curr >= (*aroot)->set_size) {
692 Newxz(newroot, 1, struct arena_set);
693 newroot->set_size = ARENAS_PER_SET;
694 newroot->next = *aroot;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)*aroot));
699 /* ok, now have arena-set with at least 1 empty/available arena-desc */
700 curr = (*aroot)->curr++;
701 adesc = &((*aroot)->set[curr]);
702 assert(!adesc->arena);
704 Newxz(adesc->arena, arena_size, char);
705 adesc->size = arena_size;
706 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %d\n",
707 curr, adesc->arena, arena_size));
713 /* return a thing to the free list */
715 #define del_body(thing, root) \
717 void ** const thing_copy = (void **)thing;\
719 *thing_copy = *root; \
720 *root = (void*)thing_copy; \
726 =head1 SV-Body Allocation
728 Allocation of SV-bodies is similar to SV-heads, differing as follows;
729 the allocation mechanism is used for many body types, so is somewhat
730 more complicated, it uses arena-sets, and has no need for still-live
733 At the outermost level, (new|del)_X*V macros return bodies of the
734 appropriate type. These macros call either (new|del)_body_type or
735 (new|del)_body_allocated macro pairs, depending on specifics of the
736 type. Most body types use the former pair, the latter pair is used to
737 allocate body types with "ghost fields".
739 "ghost fields" are fields that are unused in certain types, and
740 consequently dont need to actually exist. They are declared because
741 they're part of a "base type", which allows use of functions as
742 methods. The simplest examples are AVs and HVs, 2 aggregate types
743 which don't use the fields which support SCALAR semantics.
745 For these types, the arenas are carved up into *_allocated size
746 chunks, we thus avoid wasted memory for those unaccessed members.
747 When bodies are allocated, we adjust the pointer back in memory by the
748 size of the bit not allocated, so it's as if we allocated the full
749 structure. (But things will all go boom if you write to the part that
750 is "not there", because you'll be overwriting the last members of the
751 preceding structure in memory.)
753 We calculate the correction using the STRUCT_OFFSET macro. For
754 example, if xpv_allocated is the same structure as XPV then the two
755 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
756 structure is smaller (no initial NV actually allocated) then the net
757 effect is to subtract the size of the NV from the pointer, to return a
758 new pointer as if an initial NV were actually allocated.
760 This is the same trick as was used for NV and IV bodies. Ironically it
761 doesn't need to be used for NV bodies any more, because NV is now at
762 the start of the structure. IV bodies don't need it either, because
763 they are no longer allocated.
765 In turn, the new_body_* allocators call S_new_body(), which invokes
766 new_body_inline macro, which takes a lock, and takes a body off the
767 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
768 necessary to refresh an empty list. Then the lock is released, and
769 the body is returned.
771 S_more_bodies calls get_arena(), and carves it up into an array of N
772 bodies, which it strings into a linked list. It looks up arena-size
773 and body-size from the body_details table described below, thus
774 supporting the multiple body-types.
776 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
777 the (new|del)_X*V macros are mapped directly to malloc/free.
783 For each sv-type, struct body_details bodies_by_type[] carries
784 parameters which control these aspects of SV handling:
786 Arena_size determines whether arenas are used for this body type, and if
787 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
788 zero, forcing individual mallocs and frees.
790 Body_size determines how big a body is, and therefore how many fit into
791 each arena. Offset carries the body-pointer adjustment needed for
792 *_allocated body types, and is used in *_allocated macros.
794 But its main purpose is to parameterize info needed in
795 Perl_sv_upgrade(). The info here dramatically simplifies the function
796 vs the implementation in 5.8.7, making it table-driven. All fields
797 are used for this, except for arena_size.
799 For the sv-types that have no bodies, arenas are not used, so those
800 PL_body_roots[sv_type] are unused, and can be overloaded. In
801 something of a special case, SVt_NULL is borrowed for HE arenas;
802 PL_body_roots[SVt_NULL] is filled by S_more_he, but the
803 bodies_by_type[SVt_NULL] slot is not used, as the table is not
806 PTEs also use arenas, but are never seen in Perl_sv_upgrade.
807 Nonetheless, they get their own slot in bodies_by_type[SVt_NULL], so
808 they can just use the same allocation semantics. At first, PTEs were
809 also overloaded to a non-body sv-type, but this yielded hard-to-find
810 malloc bugs, so was simplified by claiming a new slot. This choice
811 has no consequence at this time.
815 struct body_details {
816 U8 body_size; /* Size to allocate */
817 U8 copy; /* Size of structure to copy (may be shorter) */
819 unsigned int type : 4; /* We have space for a sanity check. */
820 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
821 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
822 unsigned int arena : 1; /* Allocated from an arena */
823 size_t arena_size; /* Size of arena to allocate */
831 /* With -DPURFIY we allocate everything directly, and don't use arenas.
832 This seems a rather elegant way to simplify some of the code below. */
833 #define HASARENA FALSE
835 #define HASARENA TRUE
837 #define NOARENA FALSE
839 /* Size the arenas to exactly fit a given number of bodies. A count
840 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
841 simplifying the default. If count > 0, the arena is sized to fit
842 only that many bodies, allowing arenas to be used for large, rare
843 bodies (XPVFM, XPVIO) without undue waste. The arena size is
844 limited by PERL_ARENA_SIZE, so we can safely oversize the
847 #define FIT_ARENA0(body_size) \
848 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
849 #define FIT_ARENAn(count,body_size) \
850 ( count * body_size <= PERL_ARENA_SIZE) \
851 ? count * body_size \
852 : FIT_ARENA0 (body_size)
853 #define FIT_ARENA(count,body_size) \
855 ? FIT_ARENAn (count, body_size) \
856 : FIT_ARENA0 (body_size)
858 /* A macro to work out the offset needed to subtract from a pointer to (say)
865 to make its members accessible via a pointer to (say)
875 #define relative_STRUCT_OFFSET(longer, shorter, member) \
876 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
878 /* Calculate the length to copy. Specifically work out the length less any
879 final padding the compiler needed to add. See the comment in sv_upgrade
880 for why copying the padding proved to be a bug. */
882 #define copy_length(type, last_member) \
883 STRUCT_OFFSET(type, last_member) \
884 + sizeof (((type*)SvANY((SV*)0))->last_member)
886 static const struct body_details bodies_by_type[] = {
887 { sizeof(HE), 0, 0, SVt_NULL,
888 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
890 /* IVs are in the head, so the allocation size is 0.
891 However, the slot is overloaded for PTEs. */
892 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
893 sizeof(IV), /* This is used to copy out the IV body. */
894 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
895 NOARENA /* IVS don't need an arena */,
896 /* But PTEs need to know the size of their arena */
897 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
902 FIT_ARENA(0, sizeof(NV)) },
904 /* RVs are in the head now. */
905 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
907 /* 8 bytes on most ILP32 with IEEE doubles */
908 { sizeof(xpv_allocated),
909 copy_length(XPV, xpv_len)
910 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
912 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
915 { sizeof(xpviv_allocated),
916 copy_length(XPVIV, xiv_u)
917 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
918 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
919 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
922 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
923 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
926 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
927 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
930 { sizeof(XPVBM), sizeof(XPVBM), 0, SVt_PVBM, TRUE, HADNV,
931 HASARENA, FIT_ARENA(0, sizeof(XPVBM)) },
934 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
935 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
938 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
939 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
941 { sizeof(xpvav_allocated),
942 copy_length(XPVAV, xmg_stash)
943 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
944 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
945 SVt_PVAV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
947 { sizeof(xpvhv_allocated),
948 copy_length(XPVHV, xmg_stash)
949 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
950 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
951 SVt_PVHV, TRUE, HADNV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
954 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
955 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
956 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
958 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
959 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
960 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
962 /* XPVIO is 84 bytes, fits 48x */
963 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
964 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
967 #define new_body_type(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type))
970 #define del_body_type(p, sv_type) \
971 del_body(p, &PL_body_roots[sv_type])
974 #define new_body_allocated(sv_type) \
975 (void *)((char *)S_new_body(aTHX_ sv_type) \
976 - bodies_by_type[sv_type].offset)
978 #define del_body_allocated(p, sv_type) \
979 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
982 #define my_safemalloc(s) (void*)safemalloc(s)
983 #define my_safecalloc(s) (void*)safecalloc(s, 1)
984 #define my_safefree(p) safefree((char*)p)
988 #define new_XNV() my_safemalloc(sizeof(XPVNV))
989 #define del_XNV(p) my_safefree(p)
991 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
992 #define del_XPVNV(p) my_safefree(p)
994 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
995 #define del_XPVAV(p) my_safefree(p)
997 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
998 #define del_XPVHV(p) my_safefree(p)
1000 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1001 #define del_XPVMG(p) my_safefree(p)
1003 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1004 #define del_XPVGV(p) my_safefree(p)
1008 #define new_XNV() new_body_type(SVt_NV)
1009 #define del_XNV(p) del_body_type(p, SVt_NV)
1011 #define new_XPVNV() new_body_type(SVt_PVNV)
1012 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1014 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1015 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1017 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1018 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1020 #define new_XPVMG() new_body_type(SVt_PVMG)
1021 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1023 #define new_XPVGV() new_body_type(SVt_PVGV)
1024 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1028 /* no arena for you! */
1030 #define new_NOARENA(details) \
1031 my_safemalloc((details)->body_size + (details)->offset)
1032 #define new_NOARENAZ(details) \
1033 my_safecalloc((details)->body_size + (details)->offset)
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1040 S_more_bodies (pTHX_ svtype sv_type)
1043 void ** const root = &PL_body_roots[sv_type];
1044 const struct body_details * const bdp = &bodies_by_type[sv_type];
1045 const size_t body_size = bdp->body_size;
1049 assert(bdp->arena_size);
1051 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1052 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1053 * variables like done_sanity_check. */
1054 if (!done_sanity_check) {
1055 unsigned int i = SVt_LAST;
1057 done_sanity_check = TRUE;
1060 assert (bodies_by_type[i].type == i);
1064 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size);
1066 end = start + bdp->arena_size - body_size;
1068 /* computed count doesnt reflect the 1st slot reservation */
1069 DEBUG_m(PerlIO_printf(Perl_debug_log,
1070 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1072 (int)bdp->arena_size, sv_type, (int)body_size,
1073 (int)bdp->arena_size / (int)body_size));
1075 *root = (void *)start;
1077 while (start < end) {
1078 char * const next = start + body_size;
1079 *(void**) start = (void *)next;
1082 *(void **)start = 0;
1087 /* grab a new thing from the free list, allocating more if necessary.
1088 The inline version is used for speed in hot routines, and the
1089 function using it serves the rest (unless PURIFY).
1091 #define new_body_inline(xpv, sv_type) \
1093 void ** const r3wt = &PL_body_roots[sv_type]; \
1095 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1096 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1097 *(r3wt) = *(void**)(xpv); \
1104 S_new_body(pTHX_ svtype sv_type)
1108 new_body_inline(xpv, sv_type);
1115 =for apidoc sv_upgrade
1117 Upgrade an SV to a more complex form. Generally adds a new body type to the
1118 SV, then copies across as much information as possible from the old body.
1119 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1125 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1130 const svtype old_type = SvTYPE(sv);
1131 const struct body_details *new_type_details;
1132 const struct body_details *const old_type_details
1133 = bodies_by_type + old_type;
1135 if (new_type != SVt_PV && SvIsCOW(sv)) {
1136 sv_force_normal_flags(sv, 0);
1139 if (old_type == new_type)
1142 if (old_type > new_type)
1143 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1144 (int)old_type, (int)new_type);
1147 old_body = SvANY(sv);
1149 /* Copying structures onto other structures that have been neatly zeroed
1150 has a subtle gotcha. Consider XPVMG
1152 +------+------+------+------+------+-------+-------+
1153 | NV | CUR | LEN | IV | MAGIC | STASH |
1154 +------+------+------+------+------+-------+-------+
1155 0 4 8 12 16 20 24 28
1157 where NVs are aligned to 8 bytes, so that sizeof that structure is
1158 actually 32 bytes long, with 4 bytes of padding at the end:
1160 +------+------+------+------+------+-------+-------+------+
1161 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1162 +------+------+------+------+------+-------+-------+------+
1163 0 4 8 12 16 20 24 28 32
1165 so what happens if you allocate memory for this structure:
1167 +------+------+------+------+------+-------+-------+------+------+...
1168 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1169 +------+------+------+------+------+-------+-------+------+------+...
1170 0 4 8 12 16 20 24 28 32 36
1172 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1173 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1174 started out as zero once, but it's quite possible that it isn't. So now,
1175 rather than a nicely zeroed GP, you have it pointing somewhere random.
1178 (In fact, GP ends up pointing at a previous GP structure, because the
1179 principle cause of the padding in XPVMG getting garbage is a copy of
1180 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob)
1182 So we are careful and work out the size of used parts of all the
1189 if (new_type < SVt_PVIV) {
1190 new_type = (new_type == SVt_NV)
1191 ? SVt_PVNV : SVt_PVIV;
1195 if (new_type < SVt_PVNV) {
1196 new_type = SVt_PVNV;
1202 assert(new_type > SVt_PV);
1203 assert(SVt_IV < SVt_PV);
1204 assert(SVt_NV < SVt_PV);
1211 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1212 there's no way that it can be safely upgraded, because perl.c
1213 expects to Safefree(SvANY(PL_mess_sv)) */
1214 assert(sv != PL_mess_sv);
1215 /* This flag bit is used to mean other things in other scalar types.
1216 Given that it only has meaning inside the pad, it shouldn't be set
1217 on anything that can get upgraded. */
1218 assert(!SvPAD_TYPED(sv));
1221 if (old_type_details->cant_upgrade)
1222 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1223 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1245 assert(old_type == SVt_NULL);
1246 SvANY(sv) = &sv->sv_u.svu_rv;
1251 assert(new_type_details->body_size);
1254 assert(new_type_details->arena);
1255 assert(new_type_details->arena_size);
1256 /* This points to the start of the allocated area. */
1257 new_body_inline(new_body, new_type);
1258 Zero(new_body, new_type_details->body_size, char);
1259 new_body = ((char *)new_body) - new_type_details->offset;
1261 /* We always allocated the full length item with PURIFY. To do this
1262 we fake things so that arena is false for all 16 types.. */
1263 new_body = new_NOARENAZ(new_type_details);
1265 SvANY(sv) = new_body;
1266 if (new_type == SVt_PVAV) {
1272 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1273 The target created by newSVrv also is, and it can have magic.
1274 However, it never has SvPVX set.
1276 if (old_type >= SVt_RV) {
1277 assert(SvPVX_const(sv) == 0);
1280 /* Could put this in the else clause below, as PVMG must have SvPVX
1281 0 already (the assertion above) */
1284 if (old_type >= SVt_PVMG) {
1285 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1286 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1292 /* XXX Is this still needed? Was it ever needed? Surely as there is
1293 no route from NV to PVIV, NOK can never be true */
1294 assert(!SvNOKp(sv));
1306 assert(new_type_details->body_size);
1307 /* We always allocated the full length item with PURIFY. To do this
1308 we fake things so that arena is false for all 16 types.. */
1309 if(new_type_details->arena) {
1310 /* This points to the start of the allocated area. */
1311 new_body_inline(new_body, new_type);
1312 Zero(new_body, new_type_details->body_size, char);
1313 new_body = ((char *)new_body) - new_type_details->offset;
1315 new_body = new_NOARENAZ(new_type_details);
1317 SvANY(sv) = new_body;
1319 if (old_type_details->copy) {
1320 /* There is now the potential for an upgrade from something without
1321 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1322 int offset = old_type_details->offset;
1323 int length = old_type_details->copy;
1325 if (new_type_details->offset > old_type_details->offset) {
1326 const int difference
1327 = new_type_details->offset - old_type_details->offset;
1328 offset += difference;
1329 length -= difference;
1331 assert (length >= 0);
1333 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1337 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1338 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1339 * correct 0.0 for us. Otherwise, if the old body didn't have an
1340 * NV slot, but the new one does, then we need to initialise the
1341 * freshly created NV slot with whatever the correct bit pattern is
1343 if (old_type_details->zero_nv && !new_type_details->zero_nv)
1347 if (new_type == SVt_PVIO)
1348 IoPAGE_LEN(sv) = 60;
1349 if (old_type < SVt_RV)
1353 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1354 (unsigned long)new_type);
1357 if (old_type_details->arena) {
1358 /* If there was an old body, then we need to free it.
1359 Note that there is an assumption that all bodies of types that
1360 can be upgraded came from arenas. Only the more complex non-
1361 upgradable types are allowed to be directly malloc()ed. */
1363 my_safefree(old_body);
1365 del_body((void*)((char*)old_body + old_type_details->offset),
1366 &PL_body_roots[old_type]);
1372 =for apidoc sv_backoff
1374 Remove any string offset. You should normally use the C<SvOOK_off> macro
1381 Perl_sv_backoff(pTHX_ register SV *sv)
1383 PERL_UNUSED_CONTEXT;
1385 assert(SvTYPE(sv) != SVt_PVHV);
1386 assert(SvTYPE(sv) != SVt_PVAV);
1388 const char * const s = SvPVX_const(sv);
1389 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1390 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1392 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1394 SvFLAGS(sv) &= ~SVf_OOK;
1401 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1402 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1403 Use the C<SvGROW> wrapper instead.
1409 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1413 if (PL_madskills && newlen >= 0x100000) {
1414 PerlIO_printf(Perl_debug_log,
1415 "Allocation too large: %"UVxf"\n", (UV)newlen);
1417 #ifdef HAS_64K_LIMIT
1418 if (newlen >= 0x10000) {
1419 PerlIO_printf(Perl_debug_log,
1420 "Allocation too large: %"UVxf"\n", (UV)newlen);
1423 #endif /* HAS_64K_LIMIT */
1426 if (SvTYPE(sv) < SVt_PV) {
1427 sv_upgrade(sv, SVt_PV);
1428 s = SvPVX_mutable(sv);
1430 else if (SvOOK(sv)) { /* pv is offset? */
1432 s = SvPVX_mutable(sv);
1433 if (newlen > SvLEN(sv))
1434 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000)
1441 s = SvPVX_mutable(sv);
1443 if (newlen > SvLEN(sv)) { /* need more room? */
1444 newlen = PERL_STRLEN_ROUNDUP(newlen);
1445 if (SvLEN(sv) && s) {
1447 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1453 s = (char*)saferealloc(s, newlen);
1456 s = (char*)safemalloc(newlen);
1457 if (SvPVX_const(sv) && SvCUR(sv)) {
1458 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1462 SvLEN_set(sv, newlen);
1468 =for apidoc sv_setiv
1470 Copies an integer into the given SV, upgrading first if necessary.
1471 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1477 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1480 SV_CHECK_THINKFIRST_COW_DROP(sv);
1481 switch (SvTYPE(sv)) {
1483 sv_upgrade(sv, SVt_IV);
1486 sv_upgrade(sv, SVt_PVNV);
1490 sv_upgrade(sv, SVt_PVIV);
1499 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1503 (void)SvIOK_only(sv); /* validate number */
1509 =for apidoc sv_setiv_mg
1511 Like C<sv_setiv>, but also handles 'set' magic.
1517 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1524 =for apidoc sv_setuv
1526 Copies an unsigned integer into the given SV, upgrading first if necessary.
1527 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1533 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1535 /* With these two if statements:
1536 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1539 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1541 If you wish to remove them, please benchmark to see what the effect is
1543 if (u <= (UV)IV_MAX) {
1544 sv_setiv(sv, (IV)u);
1553 =for apidoc sv_setuv_mg
1555 Like C<sv_setuv>, but also handles 'set' magic.
1561 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1570 =for apidoc sv_setnv
1572 Copies a double into the given SV, upgrading first if necessary.
1573 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1579 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1582 SV_CHECK_THINKFIRST_COW_DROP(sv);
1583 switch (SvTYPE(sv)) {
1586 sv_upgrade(sv, SVt_NV);
1591 sv_upgrade(sv, SVt_PVNV);
1600 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1605 (void)SvNOK_only(sv); /* validate number */
1610 =for apidoc sv_setnv_mg
1612 Like C<sv_setnv>, but also handles 'set' magic.
1618 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1624 /* Print an "isn't numeric" warning, using a cleaned-up,
1625 * printable version of the offending string
1629 S_not_a_number(pTHX_ SV *sv)
1637 dsv = sv_2mortal(newSVpvs(""));
1638 pv = sv_uni_display(dsv, sv, 10, 0);
1641 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1642 /* each *s can expand to 4 chars + "...\0",
1643 i.e. need room for 8 chars */
1645 const char *s = SvPVX_const(sv);
1646 const char * const end = s + SvCUR(sv);
1647 for ( ; s < end && d < limit; s++ ) {
1649 if (ch & 128 && !isPRINT_LC(ch)) {
1658 else if (ch == '\r') {
1662 else if (ch == '\f') {
1666 else if (ch == '\\') {
1670 else if (ch == '\0') {
1674 else if (isPRINT_LC(ch))
1691 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1692 "Argument \"%s\" isn't numeric in %s", pv,
1695 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1696 "Argument \"%s\" isn't numeric", pv);
1700 =for apidoc looks_like_number
1702 Test if the content of an SV looks like a number (or is a number).
1703 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1704 non-numeric warning), even if your atof() doesn't grok them.
1710 Perl_looks_like_number(pTHX_ SV *sv)
1712 register const char *sbegin;
1716 sbegin = SvPVX_const(sv);
1719 else if (SvPOKp(sv))
1720 sbegin = SvPV_const(sv, len);
1722 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1723 return grok_number(sbegin, len, NULL);
1727 S_glob_2number(pTHX_ GV * const gv)
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 /* We know that all GVs stringify to something that is not-a-number,
1739 so no need to test that. */
1740 if (ckWARN(WARN_NUMERIC))
1741 not_a_number(buffer);
1742 /* We just want something true to return, so that S_sv_2iuv_common
1743 can tail call us and return true. */
1748 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 assert(SvPOK(buffer));
1761 *len = SvCUR(buffer);
1763 return SvPVX(buffer);
1766 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1767 until proven guilty, assume that things are not that bad... */
1772 As 64 bit platforms often have an NV that doesn't preserve all bits of
1773 an IV (an assumption perl has been based on to date) it becomes necessary
1774 to remove the assumption that the NV always carries enough precision to
1775 recreate the IV whenever needed, and that the NV is the canonical form.
1776 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1777 precision as a side effect of conversion (which would lead to insanity
1778 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1779 1) to distinguish between IV/UV/NV slots that have cached a valid
1780 conversion where precision was lost and IV/UV/NV slots that have a
1781 valid conversion which has lost no precision
1782 2) to ensure that if a numeric conversion to one form is requested that
1783 would lose precision, the precise conversion (or differently
1784 imprecise conversion) is also performed and cached, to prevent
1785 requests for different numeric formats on the same SV causing
1786 lossy conversion chains. (lossless conversion chains are perfectly
1791 SvIOKp is true if the IV slot contains a valid value
1792 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1793 SvNOKp is true if the NV slot contains a valid value
1794 SvNOK is true only if the NV value is accurate
1797 while converting from PV to NV, check to see if converting that NV to an
1798 IV(or UV) would lose accuracy over a direct conversion from PV to
1799 IV(or UV). If it would, cache both conversions, return NV, but mark
1800 SV as IOK NOKp (ie not NOK).
1802 While converting from PV to IV, check to see if converting that IV to an
1803 NV would lose accuracy over a direct conversion from PV to NV. If it
1804 would, cache both conversions, flag similarly.
1806 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1807 correctly because if IV & NV were set NV *always* overruled.
1808 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1809 changes - now IV and NV together means that the two are interchangeable:
1810 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1812 The benefit of this is that operations such as pp_add know that if
1813 SvIOK is true for both left and right operands, then integer addition
1814 can be used instead of floating point (for cases where the result won't
1815 overflow). Before, floating point was always used, which could lead to
1816 loss of precision compared with integer addition.
1818 * making IV and NV equal status should make maths accurate on 64 bit
1820 * may speed up maths somewhat if pp_add and friends start to use
1821 integers when possible instead of fp. (Hopefully the overhead in
1822 looking for SvIOK and checking for overflow will not outweigh the
1823 fp to integer speedup)
1824 * will slow down integer operations (callers of SvIV) on "inaccurate"
1825 values, as the change from SvIOK to SvIOKp will cause a call into
1826 sv_2iv each time rather than a macro access direct to the IV slot
1827 * should speed up number->string conversion on integers as IV is
1828 favoured when IV and NV are equally accurate
1830 ####################################################################
1831 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1832 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1833 On the other hand, SvUOK is true iff UV.
1834 ####################################################################
1836 Your mileage will vary depending your CPU's relative fp to integer
1840 #ifndef NV_PRESERVES_UV
1841 # define IS_NUMBER_UNDERFLOW_IV 1
1842 # define IS_NUMBER_UNDERFLOW_UV 2
1843 # define IS_NUMBER_IV_AND_UV 2
1844 # define IS_NUMBER_OVERFLOW_IV 4
1845 # define IS_NUMBER_OVERFLOW_UV 5
1847 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1849 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1851 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1854 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1855 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));
1856 if (SvNVX(sv) < (NV)IV_MIN) {
1857 (void)SvIOKp_on(sv);
1859 SvIV_set(sv, IV_MIN);
1860 return IS_NUMBER_UNDERFLOW_IV;
1862 if (SvNVX(sv) > (NV)UV_MAX) {
1863 (void)SvIOKp_on(sv);
1866 SvUV_set(sv, UV_MAX);
1867 return IS_NUMBER_OVERFLOW_UV;
1869 (void)SvIOKp_on(sv);
1871 /* Can't use strtol etc to convert this string. (See truth table in
1873 if (SvNVX(sv) <= (UV)IV_MAX) {
1874 SvIV_set(sv, I_V(SvNVX(sv)));
1875 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1876 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1878 /* Integer is imprecise. NOK, IOKp */
1880 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1883 SvUV_set(sv, U_V(SvNVX(sv)));
1884 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1885 if (SvUVX(sv) == UV_MAX) {
1886 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1887 possibly be preserved by NV. Hence, it must be overflow.
1889 return IS_NUMBER_OVERFLOW_UV;
1891 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1893 /* Integer is imprecise. NOK, IOKp */
1895 return IS_NUMBER_OVERFLOW_IV;
1897 #endif /* !NV_PRESERVES_UV*/
1900 S_sv_2iuv_common(pTHX_ SV *sv) {
1903 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1904 * without also getting a cached IV/UV from it at the same time
1905 * (ie PV->NV conversion should detect loss of accuracy and cache
1906 * IV or UV at same time to avoid this. */
1907 /* IV-over-UV optimisation - choose to cache IV if possible */
1909 if (SvTYPE(sv) == SVt_NV)
1910 sv_upgrade(sv, SVt_PVNV);
1912 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1913 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1914 certainly cast into the IV range at IV_MAX, whereas the correct
1915 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1917 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1918 if (Perl_isnan(SvNVX(sv))) {
1924 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1925 SvIV_set(sv, I_V(SvNVX(sv)));
1926 if (SvNVX(sv) == (NV) SvIVX(sv)
1927 #ifndef NV_PRESERVES_UV
1928 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1929 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1930 /* Don't flag it as "accurately an integer" if the number
1931 came from a (by definition imprecise) NV operation, and
1932 we're outside the range of NV integer precision */
1935 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1943 /* IV not precise. No need to convert from PV, as NV
1944 conversion would already have cached IV if it detected
1945 that PV->IV would be better than PV->NV->IV
1946 flags already correct - don't set public IOK. */
1947 DEBUG_c(PerlIO_printf(Perl_debug_log,
1948 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1953 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1954 but the cast (NV)IV_MIN rounds to a the value less (more
1955 negative) than IV_MIN which happens to be equal to SvNVX ??
1956 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1957 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1958 (NV)UVX == NVX are both true, but the values differ. :-(
1959 Hopefully for 2s complement IV_MIN is something like
1960 0x8000000000000000 which will be exact. NWC */
1963 SvUV_set(sv, U_V(SvNVX(sv)));
1965 (SvNVX(sv) == (NV) SvUVX(sv))
1966 #ifndef NV_PRESERVES_UV
1967 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1968 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1969 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1970 /* Don't flag it as "accurately an integer" if the number
1971 came from a (by definition imprecise) NV operation, and
1972 we're outside the range of NV integer precision */
1977 DEBUG_c(PerlIO_printf(Perl_debug_log,
1978 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1984 else if (SvPOKp(sv) && SvLEN(sv)) {
1986 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1987 /* We want to avoid a possible problem when we cache an IV/ a UV which
1988 may be later translated to an NV, and the resulting NV is not
1989 the same as the direct translation of the initial string
1990 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1991 be careful to ensure that the value with the .456 is around if the
1992 NV value is requested in the future).
1994 This means that if we cache such an IV/a UV, we need to cache the
1995 NV as well. Moreover, we trade speed for space, and do not
1996 cache the NV if we are sure it's not needed.
1999 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2000 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2001 == IS_NUMBER_IN_UV) {
2002 /* It's definitely an integer, only upgrade to PVIV */
2003 if (SvTYPE(sv) < SVt_PVIV)
2004 sv_upgrade(sv, SVt_PVIV);
2006 } else if (SvTYPE(sv) < SVt_PVNV)
2007 sv_upgrade(sv, SVt_PVNV);
2009 /* If NVs preserve UVs then we only use the UV value if we know that
2010 we aren't going to call atof() below. If NVs don't preserve UVs
2011 then the value returned may have more precision than atof() will
2012 return, even though value isn't perfectly accurate. */
2013 if ((numtype & (IS_NUMBER_IN_UV
2014 #ifdef NV_PRESERVES_UV
2017 )) == IS_NUMBER_IN_UV) {
2018 /* This won't turn off the public IOK flag if it was set above */
2019 (void)SvIOKp_on(sv);
2021 if (!(numtype & IS_NUMBER_NEG)) {
2023 if (value <= (UV)IV_MAX) {
2024 SvIV_set(sv, (IV)value);
2026 /* it didn't overflow, and it was positive. */
2027 SvUV_set(sv, value);
2031 /* 2s complement assumption */
2032 if (value <= (UV)IV_MIN) {
2033 SvIV_set(sv, -(IV)value);
2035 /* Too negative for an IV. This is a double upgrade, but
2036 I'm assuming it will be rare. */
2037 if (SvTYPE(sv) < SVt_PVNV)
2038 sv_upgrade(sv, SVt_PVNV);
2042 SvNV_set(sv, -(NV)value);
2043 SvIV_set(sv, IV_MIN);
2047 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2048 will be in the previous block to set the IV slot, and the next
2049 block to set the NV slot. So no else here. */
2051 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2052 != IS_NUMBER_IN_UV) {
2053 /* It wasn't an (integer that doesn't overflow the UV). */
2054 SvNV_set(sv, Atof(SvPVX_const(sv)));
2056 if (! numtype && ckWARN(WARN_NUMERIC))
2059 #if defined(USE_LONG_DOUBLE)
2060 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2061 PTR2UV(sv), SvNVX(sv)));
2063 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2064 PTR2UV(sv), SvNVX(sv)));
2067 #ifdef NV_PRESERVES_UV
2068 (void)SvIOKp_on(sv);
2070 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2071 SvIV_set(sv, I_V(SvNVX(sv)));
2072 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2075 NOOP; /* Integer is imprecise. NOK, IOKp */
2077 /* UV will not work better than IV */
2079 if (SvNVX(sv) > (NV)UV_MAX) {
2081 /* Integer is inaccurate. NOK, IOKp, is UV */
2082 SvUV_set(sv, UV_MAX);
2084 SvUV_set(sv, U_V(SvNVX(sv)));
2085 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2086 NV preservse UV so can do correct comparison. */
2087 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2090 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2095 #else /* NV_PRESERVES_UV */
2096 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2097 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2098 /* The IV/UV slot will have been set from value returned by
2099 grok_number above. The NV slot has just been set using
2102 assert (SvIOKp(sv));
2104 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2105 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2106 /* Small enough to preserve all bits. */
2107 (void)SvIOKp_on(sv);
2109 SvIV_set(sv, I_V(SvNVX(sv)));
2110 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2112 /* Assumption: first non-preserved integer is < IV_MAX,
2113 this NV is in the preserved range, therefore: */
2114 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2116 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);
2120 0 0 already failed to read UV.
2121 0 1 already failed to read UV.
2122 1 0 you won't get here in this case. IV/UV
2123 slot set, public IOK, Atof() unneeded.
2124 1 1 already read UV.
2125 so there's no point in sv_2iuv_non_preserve() attempting
2126 to use atol, strtol, strtoul etc. */
2127 sv_2iuv_non_preserve (sv, numtype);
2130 #endif /* NV_PRESERVES_UV */
2134 if (isGV_with_GP(sv))
2135 return glob_2number((GV *)sv);
2137 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2138 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2141 if (SvTYPE(sv) < SVt_IV)
2142 /* Typically the caller expects that sv_any is not NULL now. */
2143 sv_upgrade(sv, SVt_IV);
2144 /* Return 0 from the caller. */
2151 =for apidoc sv_2iv_flags
2153 Return the integer value of an SV, doing any necessary string
2154 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2155 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2161 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2166 if (SvGMAGICAL(sv)) {
2167 if (flags & SV_GMAGIC)
2172 return I_V(SvNVX(sv));
2174 if (SvPOKp(sv) && SvLEN(sv)) {
2177 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2179 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2180 == IS_NUMBER_IN_UV) {
2181 /* It's definitely an integer */
2182 if (numtype & IS_NUMBER_NEG) {
2183 if (value < (UV)IV_MIN)
2186 if (value < (UV)IV_MAX)
2191 if (ckWARN(WARN_NUMERIC))
2194 return I_V(Atof(SvPVX_const(sv)));
2199 assert(SvTYPE(sv) >= SVt_PVMG);
2200 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2201 } else if (SvTHINKFIRST(sv)) {
2205 SV * const tmpstr=AMG_CALLun(sv,numer);
2206 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2207 return SvIV(tmpstr);
2210 return PTR2IV(SvRV(sv));
2213 sv_force_normal_flags(sv, 0);
2215 if (SvREADONLY(sv) && !SvOK(sv)) {
2216 if (ckWARN(WARN_UNINITIALIZED))
2222 if (S_sv_2iuv_common(aTHX_ sv))
2225 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2226 PTR2UV(sv),SvIVX(sv)));
2227 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2231 =for apidoc sv_2uv_flags
2233 Return the unsigned integer value of an SV, doing any necessary string
2234 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2235 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2241 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2246 if (SvGMAGICAL(sv)) {
2247 if (flags & SV_GMAGIC)
2252 return U_V(SvNVX(sv));
2253 if (SvPOKp(sv) && SvLEN(sv)) {
2256 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2258 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2259 == IS_NUMBER_IN_UV) {
2260 /* It's definitely an integer */
2261 if (!(numtype & IS_NUMBER_NEG))
2265 if (ckWARN(WARN_NUMERIC))
2268 return U_V(Atof(SvPVX_const(sv)));
2273 assert(SvTYPE(sv) >= SVt_PVMG);
2274 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2275 } else if (SvTHINKFIRST(sv)) {
2279 SV *const tmpstr = AMG_CALLun(sv,numer);
2280 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2281 return SvUV(tmpstr);
2284 return PTR2UV(SvRV(sv));
2287 sv_force_normal_flags(sv, 0);
2289 if (SvREADONLY(sv) && !SvOK(sv)) {
2290 if (ckWARN(WARN_UNINITIALIZED))
2296 if (S_sv_2iuv_common(aTHX_ sv))
2300 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2301 PTR2UV(sv),SvUVX(sv)));
2302 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2308 Return the num value of an SV, doing any necessary string or integer
2309 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2316 Perl_sv_2nv(pTHX_ register SV *sv)
2321 if (SvGMAGICAL(sv)) {
2325 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2326 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2327 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2329 return Atof(SvPVX_const(sv));
2333 return (NV)SvUVX(sv);
2335 return (NV)SvIVX(sv);
2340 assert(SvTYPE(sv) >= SVt_PVMG);
2341 /* This falls through to the report_uninit near the end of the
2343 } else if (SvTHINKFIRST(sv)) {
2347 SV *const tmpstr = AMG_CALLun(sv,numer);
2348 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2349 return SvNV(tmpstr);
2352 return PTR2NV(SvRV(sv));
2355 sv_force_normal_flags(sv, 0);
2357 if (SvREADONLY(sv) && !SvOK(sv)) {
2358 if (ckWARN(WARN_UNINITIALIZED))
2363 if (SvTYPE(sv) < SVt_NV) {
2364 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2365 sv_upgrade(sv, SVt_NV);
2366 #ifdef USE_LONG_DOUBLE
2368 STORE_NUMERIC_LOCAL_SET_STANDARD();
2369 PerlIO_printf(Perl_debug_log,
2370 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2371 PTR2UV(sv), SvNVX(sv));
2372 RESTORE_NUMERIC_LOCAL();
2376 STORE_NUMERIC_LOCAL_SET_STANDARD();
2377 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2378 PTR2UV(sv), SvNVX(sv));
2379 RESTORE_NUMERIC_LOCAL();
2383 else if (SvTYPE(sv) < SVt_PVNV)
2384 sv_upgrade(sv, SVt_PVNV);
2389 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2390 #ifdef NV_PRESERVES_UV
2393 /* Only set the public NV OK flag if this NV preserves the IV */
2394 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2395 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2396 : (SvIVX(sv) == I_V(SvNVX(sv))))
2402 else if (SvPOKp(sv) && SvLEN(sv)) {
2404 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2405 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2407 #ifdef NV_PRESERVES_UV
2408 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2409 == IS_NUMBER_IN_UV) {
2410 /* It's definitely an integer */
2411 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2416 SvNV_set(sv, Atof(SvPVX_const(sv)));
2417 /* Only set the public NV OK flag if this NV preserves the value in
2418 the PV at least as well as an IV/UV would.
2419 Not sure how to do this 100% reliably. */
2420 /* if that shift count is out of range then Configure's test is
2421 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2423 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2424 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2425 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2426 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2427 /* Can't use strtol etc to convert this string, so don't try.
2428 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2431 /* value has been set. It may not be precise. */
2432 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2433 /* 2s complement assumption for (UV)IV_MIN */
2434 SvNOK_on(sv); /* Integer is too negative. */
2439 if (numtype & IS_NUMBER_NEG) {
2440 SvIV_set(sv, -(IV)value);
2441 } else if (value <= (UV)IV_MAX) {
2442 SvIV_set(sv, (IV)value);
2444 SvUV_set(sv, value);
2448 if (numtype & IS_NUMBER_NOT_INT) {
2449 /* I believe that even if the original PV had decimals,
2450 they are lost beyond the limit of the FP precision.
2451 However, neither is canonical, so both only get p
2452 flags. NWC, 2000/11/25 */
2453 /* Both already have p flags, so do nothing */
2455 const NV nv = SvNVX(sv);
2456 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2457 if (SvIVX(sv) == I_V(nv)) {
2460 /* It had no "." so it must be integer. */
2464 /* between IV_MAX and NV(UV_MAX).
2465 Could be slightly > UV_MAX */
2467 if (numtype & IS_NUMBER_NOT_INT) {
2468 /* UV and NV both imprecise. */
2470 const UV nv_as_uv = U_V(nv);
2472 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2481 #endif /* NV_PRESERVES_UV */
2484 if (isGV_with_GP(sv)) {
2485 glob_2number((GV *)sv);
2489 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2491 assert (SvTYPE(sv) >= SVt_NV);
2492 /* Typically the caller expects that sv_any is not NULL now. */
2493 /* XXX Ilya implies that this is a bug in callers that assume this
2494 and ideally should be fixed. */
2497 #if defined(USE_LONG_DOUBLE)
2499 STORE_NUMERIC_LOCAL_SET_STANDARD();
2500 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2501 PTR2UV(sv), SvNVX(sv));
2502 RESTORE_NUMERIC_LOCAL();
2506 STORE_NUMERIC_LOCAL_SET_STANDARD();
2507 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2508 PTR2UV(sv), SvNVX(sv));
2509 RESTORE_NUMERIC_LOCAL();
2515 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2516 * UV as a string towards the end of buf, and return pointers to start and
2519 * We assume that buf is at least TYPE_CHARS(UV) long.
2523 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2525 char *ptr = buf + TYPE_CHARS(UV);
2526 char * const ebuf = ptr;
2539 *--ptr = '0' + (char)(uv % 10);
2547 /* stringify_regexp(): private routine for use by sv_2pv_flags(): converts
2548 * a regexp to its stringified form.
2552 S_stringify_regexp(pTHX_ SV *sv, MAGIC *mg, STRLEN *lp) {
2554 const regexp * const re = (regexp *)mg->mg_obj;
2557 const char *fptr = "msix";
2562 bool need_newline = 0;
2563 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
2565 while((ch = *fptr++)) {
2567 reflags[left++] = ch;
2570 reflags[right--] = ch;
2575 reflags[left] = '-';
2579 mg->mg_len = re->prelen + 4 + left;
2581 * If /x was used, we have to worry about a regex ending with a
2582 * comment later being embedded within another regex. If so, we don't
2583 * want this regex's "commentization" to leak out to the right part of
2584 * the enclosing regex, we must cap it with a newline.
2586 * So, if /x was used, we scan backwards from the end of the regex. If
2587 * we find a '#' before we find a newline, we need to add a newline
2588 * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
2589 * we don't need to add anything. -jfriedl
2591 if (PMf_EXTENDED & re->reganch) {
2592 const char *endptr = re->precomp + re->prelen;
2593 while (endptr >= re->precomp) {
2594 const char c = *(endptr--);
2596 break; /* don't need another */
2598 /* we end while in a comment, so we need a newline */
2599 mg->mg_len++; /* save space for it */
2600 need_newline = 1; /* note to add it */
2606 Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
2607 mg->mg_ptr[0] = '(';
2608 mg->mg_ptr[1] = '?';
2609 Copy(reflags, mg->mg_ptr+2, left, char);
2610 *(mg->mg_ptr+left+2) = ':';
2611 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
2613 mg->mg_ptr[mg->mg_len - 2] = '\n';
2614 mg->mg_ptr[mg->mg_len - 1] = ')';
2615 mg->mg_ptr[mg->mg_len] = 0;
2617 PL_reginterp_cnt += re->program[0].next_off;
2619 if (re->reganch & ROPT_UTF8)
2629 =for apidoc sv_2pv_flags
2631 Returns a pointer to the string value of an SV, and sets *lp to its length.
2632 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2634 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2635 usually end up here too.
2641 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2651 if (SvGMAGICAL(sv)) {
2652 if (flags & SV_GMAGIC)
2657 if (flags & SV_MUTABLE_RETURN)
2658 return SvPVX_mutable(sv);
2659 if (flags & SV_CONST_RETURN)
2660 return (char *)SvPVX_const(sv);
2663 if (SvIOKp(sv) || SvNOKp(sv)) {
2664 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2669 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2670 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2672 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2679 #ifdef FIXNEGATIVEZERO
2680 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2686 SvUPGRADE(sv, SVt_PV);
2689 s = SvGROW_mutable(sv, len + 1);
2692 return (char*)memcpy(s, tbuf, len + 1);
2698 assert(SvTYPE(sv) >= SVt_PVMG);
2699 /* This falls through to the report_uninit near the end of the
2701 } else if (SvTHINKFIRST(sv)) {
2705 SV *const tmpstr = AMG_CALLun(sv,string);
2706 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2708 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2712 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2713 if (flags & SV_CONST_RETURN) {
2714 pv = (char *) SvPVX_const(tmpstr);
2716 pv = (flags & SV_MUTABLE_RETURN)
2717 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2720 *lp = SvCUR(tmpstr);
2722 pv = sv_2pv_flags(tmpstr, lp, flags);
2736 const SV *const referent = (SV*)SvRV(sv);
2740 retval = buffer = savepvn("NULLREF", len);
2741 } else if (SvTYPE(referent) == SVt_PVMG
2742 && ((SvFLAGS(referent) &
2743 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2744 == (SVs_OBJECT|SVs_SMG))
2745 && (mg = mg_find(referent, PERL_MAGIC_qr))) {
2746 return stringify_regexp(sv, mg, lp);
2748 const char *const typestr = sv_reftype(referent, 0);
2749 const STRLEN typelen = strlen(typestr);
2750 UV addr = PTR2UV(referent);
2751 const char *stashname = NULL;
2752 STRLEN stashnamelen = 0; /* hush, gcc */
2753 const char *buffer_end;
2755 if (SvOBJECT(referent)) {
2756 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2759 stashname = HEK_KEY(name);
2760 stashnamelen = HEK_LEN(name);
2762 if (HEK_UTF8(name)) {
2768 stashname = "__ANON__";
2771 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2772 + 2 * sizeof(UV) + 2 /* )\0 */;
2774 len = typelen + 3 /* (0x */
2775 + 2 * sizeof(UV) + 2 /* )\0 */;
2778 Newx(buffer, len, char);
2779 buffer_end = retval = buffer + len;
2781 /* Working backwards */
2785 *--retval = PL_hexdigit[addr & 15];
2786 } while (addr >>= 4);
2792 memcpy(retval, typestr, typelen);
2796 retval -= stashnamelen;
2797 memcpy(retval, stashname, stashnamelen);
2799 /* retval may not neccesarily have reached the start of the
2801 assert (retval >= buffer);
2803 len = buffer_end - retval - 1; /* -1 for that \0 */
2811 if (SvREADONLY(sv) && !SvOK(sv)) {
2812 if (ckWARN(WARN_UNINITIALIZED))
2819 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2820 /* I'm assuming that if both IV and NV are equally valid then
2821 converting the IV is going to be more efficient */
2822 const U32 isIOK = SvIOK(sv);
2823 const U32 isUIOK = SvIsUV(sv);
2824 char buf[TYPE_CHARS(UV)];
2827 if (SvTYPE(sv) < SVt_PVIV)
2828 sv_upgrade(sv, SVt_PVIV);
2829 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2830 /* inlined from sv_setpvn */
2831 SvGROW_mutable(sv, (STRLEN)(ebuf - ptr + 1));
2832 Move(ptr,SvPVX_mutable(sv),ebuf - ptr,char);
2833 SvCUR_set(sv, ebuf - ptr);
2843 else if (SvNOKp(sv)) {
2844 const int olderrno = errno;
2845 if (SvTYPE(sv) < SVt_PVNV)
2846 sv_upgrade(sv, SVt_PVNV);
2847 /* The +20 is pure guesswork. Configure test needed. --jhi */
2848 s = SvGROW_mutable(sv, NV_DIG + 20);
2849 /* some Xenix systems wipe out errno here */
2851 if (SvNVX(sv) == 0.0)
2852 my_strlcpy(s, "0", SvLEN(sv));
2856 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2859 #ifdef FIXNEGATIVEZERO
2860 if (*s == '-' && s[1] == '0' && !s[2])
2861 my_strlcpy(s, "0", SvLEN(s));
2870 if (isGV_with_GP(sv))
2871 return glob_2pv((GV *)sv, lp);
2873 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2877 if (SvTYPE(sv) < SVt_PV)
2878 /* Typically the caller expects that sv_any is not NULL now. */
2879 sv_upgrade(sv, SVt_PV);
2883 const STRLEN len = s - SvPVX_const(sv);
2889 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2890 PTR2UV(sv),SvPVX_const(sv)));
2891 if (flags & SV_CONST_RETURN)
2892 return (char *)SvPVX_const(sv);
2893 if (flags & SV_MUTABLE_RETURN)
2894 return SvPVX_mutable(sv);
2899 =for apidoc sv_copypv
2901 Copies a stringified representation of the source SV into the
2902 destination SV. Automatically performs any necessary mg_get and
2903 coercion of numeric values into strings. Guaranteed to preserve
2904 UTF-8 flag even from overloaded objects. Similar in nature to
2905 sv_2pv[_flags] but operates directly on an SV instead of just the
2906 string. Mostly uses sv_2pv_flags to do its work, except when that
2907 would lose the UTF-8'ness of the PV.
2913 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2916 const char * const s = SvPV_const(ssv,len);
2917 sv_setpvn(dsv,s,len);
2925 =for apidoc sv_2pvbyte
2927 Return a pointer to the byte-encoded representation of the SV, and set *lp
2928 to its length. May cause the SV to be downgraded from UTF-8 as a
2931 Usually accessed via the C<SvPVbyte> macro.
2937 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2939 sv_utf8_downgrade(sv,0);
2940 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2944 =for apidoc sv_2pvutf8
2946 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2947 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2949 Usually accessed via the C<SvPVutf8> macro.
2955 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2957 sv_utf8_upgrade(sv);
2958 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2963 =for apidoc sv_2bool
2965 This function is only called on magical items, and is only used by
2966 sv_true() or its macro equivalent.
2972 Perl_sv_2bool(pTHX_ register SV *sv)
2981 SV * const tmpsv = AMG_CALLun(sv,bool_);
2982 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2983 return (bool)SvTRUE(tmpsv);
2985 return SvRV(sv) != 0;
2988 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2990 (*sv->sv_u.svu_pv > '0' ||
2991 Xpvtmp->xpv_cur > 1 ||
2992 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2999 return SvIVX(sv) != 0;
3002 return SvNVX(sv) != 0.0;
3004 if (isGV_with_GP(sv))
3014 =for apidoc sv_utf8_upgrade
3016 Converts the PV of an SV to its UTF-8-encoded form.
3017 Forces the SV to string form if it is not already.
3018 Always sets the SvUTF8 flag to avoid future validity checks even
3019 if all the bytes have hibit clear.
3021 This is not as a general purpose byte encoding to Unicode interface:
3022 use the Encode extension for that.
3024 =for apidoc sv_utf8_upgrade_flags
3026 Converts the PV of an SV to its UTF-8-encoded form.
3027 Forces the SV to string form if it is not already.
3028 Always sets the SvUTF8 flag to avoid future validity checks even
3029 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3030 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3031 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3033 This is not as a general purpose byte encoding to Unicode interface:
3034 use the Encode extension for that.
3040 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3043 if (sv == &PL_sv_undef)
3047 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3048 (void) sv_2pv_flags(sv,&len, flags);
3052 (void) SvPV_force(sv,len);
3061 sv_force_normal_flags(sv, 0);
3064 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3065 sv_recode_to_utf8(sv, PL_encoding);
3066 else { /* Assume Latin-1/EBCDIC */
3067 /* This function could be much more efficient if we
3068 * had a FLAG in SVs to signal if there are any hibit
3069 * chars in the PV. Given that there isn't such a flag
3070 * make the loop as fast as possible. */
3071 const U8 * const s = (U8 *) SvPVX_const(sv);
3072 const U8 * const e = (U8 *) SvEND(sv);
3077 /* Check for hi bit */
3078 if (!NATIVE_IS_INVARIANT(ch)) {
3079 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3080 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3082 SvPV_free(sv); /* No longer using what was there before. */
3083 SvPV_set(sv, (char*)recoded);
3084 SvCUR_set(sv, len - 1);
3085 SvLEN_set(sv, len); /* No longer know the real size. */
3089 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3096 =for apidoc sv_utf8_downgrade
3098 Attempts to convert the PV of an SV from characters to bytes.
3099 If the PV contains a character beyond byte, this conversion will fail;
3100 in this case, either returns false or, if C<fail_ok> is not
3103 This is not as a general purpose Unicode to byte encoding interface:
3104 use the Encode extension for that.
3110 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3113 if (SvPOKp(sv) && SvUTF8(sv)) {
3119 sv_force_normal_flags(sv, 0);
3121 s = (U8 *) SvPV(sv, len);
3122 if (!utf8_to_bytes(s, &len)) {
3127 Perl_croak(aTHX_ "Wide character in %s",
3130 Perl_croak(aTHX_ "Wide character");
3141 =for apidoc sv_utf8_encode
3143 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3144 flag off so that it looks like octets again.
3150 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3153 sv_force_normal_flags(sv, 0);
3155 if (SvREADONLY(sv)) {
3156 Perl_croak(aTHX_ PL_no_modify);
3158 (void) sv_utf8_upgrade(sv);
3163 =for apidoc sv_utf8_decode
3165 If the PV of the SV is an octet sequence in UTF-8
3166 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3167 so that it looks like a character. If the PV contains only single-byte
3168 characters, the C<SvUTF8> flag stays being off.
3169 Scans PV for validity and returns false if the PV is invalid UTF-8.
3175 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3181 /* The octets may have got themselves encoded - get them back as
3184 if (!sv_utf8_downgrade(sv, TRUE))
3187 /* it is actually just a matter of turning the utf8 flag on, but
3188 * we want to make sure everything inside is valid utf8 first.
3190 c = (const U8 *) SvPVX_const(sv);
3191 if (!is_utf8_string(c, SvCUR(sv)+1))
3193 e = (const U8 *) SvEND(sv);
3196 if (!UTF8_IS_INVARIANT(ch)) {
3206 =for apidoc sv_setsv
3208 Copies the contents of the source SV C<ssv> into the destination SV
3209 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3210 function if the source SV needs to be reused. Does not handle 'set' magic.
3211 Loosely speaking, it performs a copy-by-value, obliterating any previous
3212 content of the destination.
3214 You probably want to use one of the assortment of wrappers, such as
3215 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3216 C<SvSetMagicSV_nosteal>.
3218 =for apidoc sv_setsv_flags
3220 Copies the contents of the source SV C<ssv> into the destination SV
3221 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3222 function if the source SV needs to be reused. Does not handle 'set' magic.
3223 Loosely speaking, it performs a copy-by-value, obliterating any previous
3224 content of the destination.
3225 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3226 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3227 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3228 and C<sv_setsv_nomg> are implemented in terms of this function.
3230 You probably want to use one of the assortment of wrappers, such as
3231 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3232 C<SvSetMagicSV_nosteal>.
3234 This is the primary function for copying scalars, and most other
3235 copy-ish functions and macros use this underneath.
3241 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3243 if (dtype != SVt_PVGV) {
3244 const char * const name = GvNAME(sstr);
3245 const STRLEN len = GvNAMELEN(sstr);
3246 /* don't upgrade SVt_PVLV: it can hold a glob */
3247 if (dtype != SVt_PVLV) {
3248 if (dtype >= SVt_PV) {
3254 sv_upgrade(dstr, SVt_PVGV);
3255 (void)SvOK_off(dstr);
3258 GvSTASH(dstr) = GvSTASH(sstr);
3260 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3261 gv_name_set((GV *)dstr, name, len, GV_ADD);
3262 SvFAKE_on(dstr); /* can coerce to non-glob */
3265 #ifdef GV_UNIQUE_CHECK
3266 if (GvUNIQUE((GV*)dstr)) {
3267 Perl_croak(aTHX_ PL_no_modify);
3273 (void)SvOK_off(dstr);
3275 GvINTRO_off(dstr); /* one-shot flag */
3276 GvGP(dstr) = gp_ref(GvGP(sstr));
3277 if (SvTAINTED(sstr))
3279 if (GvIMPORTED(dstr) != GVf_IMPORTED
3280 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3282 GvIMPORTED_on(dstr);
3289 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3290 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3292 const int intro = GvINTRO(dstr);
3295 const U32 stype = SvTYPE(sref);
3298 #ifdef GV_UNIQUE_CHECK
3299 if (GvUNIQUE((GV*)dstr)) {
3300 Perl_croak(aTHX_ PL_no_modify);
3305 GvINTRO_off(dstr); /* one-shot flag */
3306 GvLINE(dstr) = CopLINE(PL_curcop);
3307 GvEGV(dstr) = (GV*)dstr;
3312 location = (SV **) &GvCV(dstr);
3313 import_flag = GVf_IMPORTED_CV;
3316 location = (SV **) &GvHV(dstr);
3317 import_flag = GVf_IMPORTED_HV;
3320 location = (SV **) &GvAV(dstr);
3321 import_flag = GVf_IMPORTED_AV;
3324 location = (SV **) &GvIOp(dstr);
3327 location = (SV **) &GvFORM(dstr);
3329 location = &GvSV(dstr);
3330 import_flag = GVf_IMPORTED_SV;
3333 if (stype == SVt_PVCV) {
3334 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3335 SvREFCNT_dec(GvCV(dstr));
3337 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3338 PL_sub_generation++;
3341 SAVEGENERICSV(*location);
3345 if (stype == SVt_PVCV && *location != sref) {
3346 CV* const cv = (CV*)*location;
3348 if (!GvCVGEN((GV*)dstr) &&
3349 (CvROOT(cv) || CvXSUB(cv)))
3351 /* Redefining a sub - warning is mandatory if
3352 it was a const and its value changed. */
3353 if (CvCONST(cv) && CvCONST((CV*)sref)
3354 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3356 /* They are 2 constant subroutines generated from
3357 the same constant. This probably means that
3358 they are really the "same" proxy subroutine
3359 instantiated in 2 places. Most likely this is
3360 when a constant is exported twice. Don't warn.
3363 else if (ckWARN(WARN_REDEFINE)
3365 && (!CvCONST((CV*)sref)
3366 || sv_cmp(cv_const_sv(cv),
3367 cv_const_sv((CV*)sref))))) {
3368 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3371 ? "Constant subroutine %s::%s redefined"
3372 : "Subroutine %s::%s redefined"),
3373 HvNAME_get(GvSTASH((GV*)dstr)),
3374 GvENAME((GV*)dstr));
3378 cv_ckproto_len(cv, (GV*)dstr,
3379 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3380 SvPOK(sref) ? SvCUR(sref) : 0);
3382 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3383 GvASSUMECV_on(dstr);
3384 PL_sub_generation++;
3387 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3388 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3389 GvFLAGS(dstr) |= import_flag;
3394 if (SvTAINTED(sstr))
3400 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3403 register U32 sflags;
3405 register svtype stype;
3409 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3411 sstr = &PL_sv_undef;
3412 stype = SvTYPE(sstr);
3413 dtype = SvTYPE(dstr);
3418 /* need to nuke the magic */
3420 SvRMAGICAL_off(dstr);
3423 /* There's a lot of redundancy below but we're going for speed here */
3428 if (dtype != SVt_PVGV) {
3429 (void)SvOK_off(dstr);
3437 sv_upgrade(dstr, SVt_IV);
3442 sv_upgrade(dstr, SVt_PVIV);
3445 (void)SvIOK_only(dstr);
3446 SvIV_set(dstr, SvIVX(sstr));
3449 /* SvTAINTED can only be true if the SV has taint magic, which in
3450 turn means that the SV type is PVMG (or greater). This is the
3451 case statement for SVt_IV, so this cannot be true (whatever gcov
3453 assert(!SvTAINTED(sstr));
3463 sv_upgrade(dstr, SVt_NV);
3468 sv_upgrade(dstr, SVt_PVNV);
3471 SvNV_set(dstr, SvNVX(sstr));
3472 (void)SvNOK_only(dstr);
3473 /* SvTAINTED can only be true if the SV has taint magic, which in
3474 turn means that the SV type is PVMG (or greater). This is the
3475 case statement for SVt_NV, so this cannot be true (whatever gcov
3477 assert(!SvTAINTED(sstr));
3484 sv_upgrade(dstr, SVt_RV);
3487 #ifdef PERL_OLD_COPY_ON_WRITE
3488 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3489 if (dtype < SVt_PVIV)
3490 sv_upgrade(dstr, SVt_PVIV);
3497 sv_upgrade(dstr, SVt_PV);
3500 if (dtype < SVt_PVIV)
3501 sv_upgrade(dstr, SVt_PVIV);
3504 if (dtype < SVt_PVNV)
3505 sv_upgrade(dstr, SVt_PVNV);
3509 const char * const type = sv_reftype(sstr,0);
3511 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3513 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3518 if (dtype <= SVt_PVGV) {
3519 glob_assign_glob(dstr, sstr, dtype);
3527 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3529 if (SvTYPE(sstr) != stype) {
3530 stype = SvTYPE(sstr);
3531 if (stype == SVt_PVGV && dtype <= SVt_PVGV) {
3532 glob_assign_glob(dstr, sstr, dtype);
3537 if (stype == SVt_PVLV)
3538 SvUPGRADE(dstr, SVt_PVNV);
3540 SvUPGRADE(dstr, (svtype)stype);
3543 /* dstr may have been upgraded. */
3544 dtype = SvTYPE(dstr);
3545 sflags = SvFLAGS(sstr);
3547 if (sflags & SVf_ROK) {
3548 if (dtype == SVt_PVGV &&
3549 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3552 if (GvIMPORTED(dstr) != GVf_IMPORTED
3553 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3555 GvIMPORTED_on(dstr);
3560 glob_assign_glob(dstr, sstr, dtype);
3564 if (dtype >= SVt_PV) {
3565 if (dtype == SVt_PVGV) {
3566 glob_assign_ref(dstr, sstr);
3569 if (SvPVX_const(dstr)) {
3575 (void)SvOK_off(dstr);
3576 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3577 SvFLAGS(dstr) |= sflags & (SVf_ROK|SVf_AMAGIC);
3578 assert(!(sflags & SVp_NOK));
3579 assert(!(sflags & SVp_IOK));
3580 assert(!(sflags & SVf_NOK));
3581 assert(!(sflags & SVf_IOK));
3583 else if (dtype == SVt_PVGV) {
3584 if (!(sflags & SVf_OK)) {
3585 if (ckWARN(WARN_MISC))
3586 Perl_warner(aTHX_ packWARN(WARN_MISC),
3587 "Undefined value assigned to typeglob");
3590 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3591 if (dstr != (SV*)gv) {
3594 GvGP(dstr) = gp_ref(GvGP(gv));
3598 else if (sflags & SVp_POK) {
3602 * Check to see if we can just swipe the string. If so, it's a
3603 * possible small lose on short strings, but a big win on long ones.
3604 * It might even be a win on short strings if SvPVX_const(dstr)
3605 * has to be allocated and SvPVX_const(sstr) has to be freed.
3608 /* Whichever path we take through the next code, we want this true,
3609 and doing it now facilitates the COW check. */
3610 (void)SvPOK_only(dstr);
3613 /* We're not already COW */
3614 ((sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3615 #ifndef PERL_OLD_COPY_ON_WRITE
3616 /* or we are, but dstr isn't a suitable target. */
3617 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3622 (sflags & SVs_TEMP) && /* slated for free anyway? */
3623 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3624 (!(flags & SV_NOSTEAL)) &&
3625 /* and we're allowed to steal temps */
3626 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3627 SvLEN(sstr) && /* and really is a string */
3628 /* and won't be needed again, potentially */
3629 !(PL_op && PL_op->op_type == OP_AASSIGN))
3630 #ifdef PERL_OLD_COPY_ON_WRITE
3631 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3632 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3633 && SvTYPE(sstr) >= SVt_PVIV)
3636 /* Failed the swipe test, and it's not a shared hash key either.
3637 Have to copy the string. */
3638 STRLEN len = SvCUR(sstr);
3639 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3640 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3641 SvCUR_set(dstr, len);
3642 *SvEND(dstr) = '\0';
3644 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3646 /* Either it's a shared hash key, or it's suitable for
3647 copy-on-write or we can swipe the string. */
3649 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3653 #ifdef PERL_OLD_COPY_ON_WRITE
3655 /* I believe I should acquire a global SV mutex if
3656 it's a COW sv (not a shared hash key) to stop
3657 it going un copy-on-write.
3658 If the source SV has gone un copy on write between up there
3659 and down here, then (assert() that) it is of the correct
3660 form to make it copy on write again */
3661 if ((sflags & (SVf_FAKE | SVf_READONLY))
3662 != (SVf_FAKE | SVf_READONLY)) {
3663 SvREADONLY_on(sstr);
3665 /* Make the source SV into a loop of 1.
3666 (about to become 2) */
3667 SV_COW_NEXT_SV_SET(sstr, sstr);
3671 /* Initial code is common. */
3672 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3677 /* making another shared SV. */
3678 STRLEN cur = SvCUR(sstr);
3679 STRLEN len = SvLEN(sstr);
3680 #ifdef PERL_OLD_COPY_ON_WRITE
3682 assert (SvTYPE(dstr) >= SVt_PVIV);
3683 /* SvIsCOW_normal */
3684 /* splice us in between source and next-after-source. */
3685 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3686 SV_COW_NEXT_SV_SET(sstr, dstr);
3687 SvPV_set(dstr, SvPVX_mutable(sstr));
3691 /* SvIsCOW_shared_hash */
3692 DEBUG_C(PerlIO_printf(Perl_debug_log,
3693 "Copy on write: Sharing hash\n"));
3695 assert (SvTYPE(dstr) >= SVt_PV);
3697 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3699 SvLEN_set(dstr, len);
3700 SvCUR_set(dstr, cur);
3701 SvREADONLY_on(dstr);
3703 /* Relesase a global SV mutex. */
3706 { /* Passes the swipe test. */
3707 SvPV_set(dstr, SvPVX_mutable(sstr));
3708 SvLEN_set(dstr, SvLEN(sstr));
3709 SvCUR_set(dstr, SvCUR(sstr));
3712 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3713 SvPV_set(sstr, NULL);
3719 if (sflags & SVp_NOK) {
3720 SvNV_set(dstr, SvNVX(sstr));
3722 if (sflags & SVp_IOK) {
3723 SvRELEASE_IVX(dstr);
3724 SvIV_set(dstr, SvIVX(sstr));
3725 /* Must do this otherwise some other overloaded use of 0x80000000
3726 gets confused. I guess SVpbm_VALID */
3727 if (sflags & SVf_IVisUV)
3730 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8
3733 const MAGIC * const smg = SvVSTRING_mg(sstr);
3735 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3736 smg->mg_ptr, smg->mg_len);
3737 SvRMAGICAL_on(dstr);
3741 else if (sflags & (SVp_IOK|SVp_NOK)) {
3742 (void)SvOK_off(dstr);
3743 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK
3745 if (sflags & SVp_IOK) {
3746 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3747 SvIV_set(dstr, SvIVX(sstr));
3749 if (sflags & SVp_NOK) {
3750 SvNV_set(dstr, SvNVX(sstr));
3754 if (isGV_with_GP(sstr)) {
3755 /* This stringification rule for globs is spread in 3 places.
3756 This feels bad. FIXME. */
3757 const U32 wasfake = sflags & SVf_FAKE;
3759 /* FAKE globs can get coerced, so need to turn this off
3760 temporarily if it is on. */
3762 gv_efullname3(dstr, (GV *)sstr, "*");
3763 SvFLAGS(sstr) |= wasfake;
3764 SvFLAGS(dstr) |= sflags & SVf_AMAGIC;
3767 (void)SvOK_off(dstr);
3769 if (SvTAINTED(sstr))
3774 =for apidoc sv_setsv_mg
3776 Like C<sv_setsv>, but also handles 'set' magic.
3782 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3784 sv_setsv(dstr,sstr);
3788 #ifdef PERL_OLD_COPY_ON_WRITE
3790 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3792 STRLEN cur = SvCUR(sstr);
3793 STRLEN len = SvLEN(sstr);
3794 register char *new_pv;
3797 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3805 if (SvTHINKFIRST(dstr))
3806 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3807 else if (SvPVX_const(dstr))
3808 Safefree(SvPVX_const(dstr));
3812 SvUPGRADE(dstr, SVt_PVIV);
3814 assert (SvPOK(sstr));
3815 assert (SvPOKp(sstr));
3816 assert (!SvIOK(sstr));
3817 assert (!SvIOKp(sstr));
3818 assert (!SvNOK(sstr));
3819 assert (!SvNOKp(sstr));
3821 if (SvIsCOW(sstr)) {
3823 if (SvLEN(sstr) == 0) {
3824 /* source is a COW shared hash key. */
3825 DEBUG_C(PerlIO_printf(Perl_debug_log,
3826 "Fast copy on write: Sharing hash\n"));
3827 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3830 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3832 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3833 SvUPGRADE(sstr, SVt_PVIV);
3834 SvREADONLY_on(sstr);
3836 DEBUG_C(PerlIO_printf(Perl_debug_log,
3837 "Fast copy on write: Converting sstr to COW\n"));
3838 SV_COW_NEXT_SV_SET(dstr, sstr);
3840 SV_COW_NEXT_SV_SET(sstr, dstr);
3841 new_pv = SvPVX_mutable(sstr);
3844 SvPV_set(dstr, new_pv);
3845 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3848 SvLEN_set(dstr, len);
3849 SvCUR_set(dstr, cur);
3858 =for apidoc sv_setpvn
3860 Copies a string into an SV. The C<len> parameter indicates the number of
3861 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3862 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3868 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3871 register char *dptr;
3873 SV_CHECK_THINKFIRST_COW_DROP(sv);
3879 /* len is STRLEN which is unsigned, need to copy to signed */
3882 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3884 SvUPGRADE(sv, SVt_PV);
3886 dptr = SvGROW(sv, len + 1);
3887 Move(ptr,dptr,len,char);
3890 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3895 =for apidoc sv_setpvn_mg
3897 Like C<sv_setpvn>, but also handles 'set' magic.
3903 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3905 sv_setpvn(sv,ptr,len);
3910 =for apidoc sv_setpv
3912 Copies a string into an SV. The string must be null-terminated. Does not
3913 handle 'set' magic. See C<sv_setpv_mg>.
3919 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3922 register STRLEN len;
3924 SV_CHECK_THINKFIRST_COW_DROP(sv);
3930 SvUPGRADE(sv, SVt_PV);
3932 SvGROW(sv, len + 1);
3933 Move(ptr,SvPVX(sv),len+1,char);
3935 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3940 =for apidoc sv_setpv_mg
3942 Like C<sv_setpv>, but also handles 'set' magic.
3948 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3955 =for apidoc sv_usepvn_flags
3957 Tells an SV to use C<ptr> to find its string value. Normally the
3958 string is stored inside the SV but sv_usepvn allows the SV to use an
3959 outside string. The C<ptr> should point to memory that was allocated
3960 by C<malloc>. The string length, C<len>, must be supplied. By default
3961 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3962 so that pointer should not be freed or used by the programmer after
3963 giving it to sv_usepvn, and neither should any pointers from "behind"
3964 that pointer (e.g. ptr + 1) be used.
3966 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3967 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3968 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3969 C<len>, and already meets the requirements for storing in C<SvPVX>)
3975 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3979 SV_CHECK_THINKFIRST_COW_DROP(sv);
3980 SvUPGRADE(sv, SVt_PV);
3983 if (flags & SV_SMAGIC)
3987 if (SvPVX_const(sv))
3991 if (flags & SV_HAS_TRAILING_NUL)
3992 assert(ptr[len] == '\0');
3995 allocate = (flags & SV_HAS_TRAILING_NUL)
3996 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
3997 if (flags & SV_HAS_TRAILING_NUL) {
3998 /* It's long enough - do nothing.
3999 Specfically Perl_newCONSTSUB is relying on this. */
4002 /* Force a move to shake out bugs in callers. */
4003 char *new_ptr = (char*)safemalloc(allocate);
4004 Copy(ptr, new_ptr, len, char);
4005 PoisonFree(ptr,len,char);
4009 ptr = (char*) saferealloc (ptr, allocate);
4014 SvLEN_set(sv, allocate);
4015 if (!(flags & SV_HAS_TRAILING_NUL)) {
4018 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4020 if (flags & SV_SMAGIC)
4024 #ifdef PERL_OLD_COPY_ON_WRITE
4025 /* Need to do this *after* making the SV normal, as we need the buffer
4026 pointer to remain valid until after we've copied it. If we let go too early,
4027 another thread could invalidate it by unsharing last of the same hash key
4028 (which it can do by means other than releasing copy-on-write Svs)
4029 or by changing the other copy-on-write SVs in the loop. */
4031 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN len, SV *after)
4033 if (len) { /* this SV was SvIsCOW_normal(sv) */
4034 /* we need to find the SV pointing to us. */
4035 SV *current = SV_COW_NEXT_SV(after);
4037 if (current == sv) {
4038 /* The SV we point to points back to us (there were only two of us
4040 Hence other SV is no longer copy on write either. */
4042 SvREADONLY_off(after);
4044 /* We need to follow the pointers around the loop. */
4046 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4049 /* don't loop forever if the structure is bust, and we have
4050 a pointer into a closed loop. */
4051 assert (current != after);
4052 assert (SvPVX_const(current) == pvx);
4054 /* Make the SV before us point to the SV after us. */
4055 SV_COW_NEXT_SV_SET(current, after);
4058 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4063 Perl_sv_release_IVX(pTHX_ register SV *sv)
4066 sv_force_normal_flags(sv, 0);
4072 =for apidoc sv_force_normal_flags
4074 Undo various types of fakery on an SV: if the PV is a shared string, make
4075 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4076 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4077 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4078 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4079 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4080 set to some other value.) In addition, the C<flags> parameter gets passed to
4081 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4082 with flags set to 0.
4088 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4091 #ifdef PERL_OLD_COPY_ON_WRITE
4092 if (SvREADONLY(sv)) {
4093 /* At this point I believe I should acquire a global SV mutex. */
4095 const char * const pvx = SvPVX_const(sv);
4096 const STRLEN len = SvLEN(sv);
4097 const STRLEN cur = SvCUR(sv);
4098 SV * const next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4100 PerlIO_printf(Perl_debug_log,
4101 "Copy on write: Force normal %ld\n",
4107 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4110 if (flags & SV_COW_DROP_PV) {
4111 /* OK, so we don't need to copy our buffer. */
4114 SvGROW(sv, cur + 1);
4115 Move(pvx,SvPVX(sv),cur,char);
4119 sv_release_COW(sv, pvx, len, next);
4124 else if (IN_PERL_RUNTIME)
4125 Perl_croak(aTHX_ PL_no_modify);
4126 /* At this point I believe that I can drop the global SV mutex. */
4129 if (SvREADONLY(sv)) {
4131 const char * const pvx = SvPVX_const(sv);
4132 const STRLEN len = SvCUR(sv);
4137 SvGROW(sv, len + 1);
4138 Move(pvx,SvPVX(sv),len,char);
4140 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4142 else if (IN_PERL_RUNTIME)
4143 Perl_croak(aTHX_ PL_no_modify);
4147 sv_unref_flags(sv, flags);
4148 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4155 Efficient removal of characters from the beginning of the string buffer.
4156 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4157 the string buffer. The C<ptr> becomes the first character of the adjusted
4158 string. Uses the "OOK hack".
4159 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4160 refer to the same chunk of data.
4166 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4168 register STRLEN delta;
4169 if (!ptr || !SvPOKp(sv))
4171 delta = ptr - SvPVX_const(sv);
4172 SV_CHECK_THINKFIRST(sv);
4173 if (SvTYPE(sv) < SVt_PVIV)
4174 sv_upgrade(sv,SVt_PVIV);
4177 if (!SvLEN(sv)) { /* make copy of shared string */
4178 const char *pvx = SvPVX_const(sv);
4179 const STRLEN len = SvCUR(sv);
4180 SvGROW(sv, len + 1);
4181 Move(pvx,SvPVX(sv),len,char);
4185 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4186 and we do that anyway inside the SvNIOK_off
4188 SvFLAGS(sv) |= SVf_OOK;
4191 SvLEN_set(sv, SvLEN(sv) - delta);
4192 SvCUR_set(sv, SvCUR(sv) - delta);
4193 SvPV_set(sv, SvPVX(sv) + delta);
4194 SvIV_set(sv, SvIVX(sv) + delta);
4198 =for apidoc sv_catpvn
4200 Concatenates the string onto the end of the string which is in the SV. The
4201 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4202 status set, then the bytes appended should be valid UTF-8.
4203 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4205 =for apidoc sv_catpvn_flags
4207 Concatenates the string onto the end of the string which is in the SV. The
4208 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4209 status set, then the bytes appended should be valid UTF-8.
4210 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4211 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4212 in terms of this function.
4218 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4222 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4224 SvGROW(dsv, dlen + slen + 1);
4226 sstr = SvPVX_const(dsv);
4227 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4228 SvCUR_set(dsv, SvCUR(dsv) + slen);
4230 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4232 if (flags & SV_SMAGIC)
4237 =for apidoc sv_catsv
4239 Concatenates the string from SV C<ssv> onto the end of the string in
4240 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4241 not 'set' magic. See C<sv_catsv_mg>.
4243 =for apidoc sv_catsv_flags
4245 Concatenates the string from SV C<ssv> onto the end of the string in
4246 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4247 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4248 and C<sv_catsv_nomg> are implemented in terms of this function.
4253 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4258 const char *spv = SvPV_const(ssv, slen);
4260 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4261 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4262 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4263 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4264 dsv->sv_flags doesn't have that bit set.
4265 Andy Dougherty 12 Oct 2001
4267 const I32 sutf8 = DO_UTF8(ssv);
4270 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4272 dutf8 = DO_UTF8(dsv);
4274 if (dutf8 != sutf8) {
4276 /* Not modifying source SV, so taking a temporary copy. */
4277 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4279 sv_utf8_upgrade(csv);
4280 spv = SvPV_const(csv, slen);
4283 sv_utf8_upgrade_nomg(dsv);
4285 sv_catpvn_nomg(dsv, spv, slen);
4288 if (flags & SV_SMAGIC)
4293 =for apidoc sv_catpv
4295 Concatenates the string onto the end of the string which is in the SV.
4296 If the SV has the UTF-8 status set, then the bytes appended should be
4297 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4302 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4305 register STRLEN len;
4311 junk = SvPV_force(sv, tlen);
4313 SvGROW(sv, tlen + len + 1);
4315 ptr = SvPVX_const(sv);
4316 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4317 SvCUR_set(sv, SvCUR(sv) + len);
4318 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4323 =for apidoc sv_catpv_mg
4325 Like C<sv_catpv>, but also handles 'set' magic.
4331 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4340 Creates a new SV. A non-zero C<len> parameter indicates the number of
4341 bytes of preallocated string space the SV should have. An extra byte for a
4342 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4343 space is allocated.) The reference count for the new SV is set to 1.
4345 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4346 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4347 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4348 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4349 modules supporting older perls.
4355 Perl_newSV(pTHX_ STRLEN len)
4362 sv_upgrade(sv, SVt_PV);
4363 SvGROW(sv, len + 1);
4368 =for apidoc sv_magicext
4370 Adds magic to an SV, upgrading it if necessary. Applies the
4371 supplied vtable and returns a pointer to the magic added.
4373 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4374 In particular, you can add magic to SvREADONLY SVs, and add more than
4375 one instance of the same 'how'.
4377 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4378 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4379 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4380 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4382 (This is now used as a subroutine by C<sv_magic>.)
4387 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4388 const char* name, I32 namlen)
4393 if (SvTYPE(sv) < SVt_PVMG) {
4394 SvUPGRADE(sv, SVt_PVMG);
4396 Newxz(mg, 1, MAGIC);
4397 mg->mg_moremagic = SvMAGIC(sv);
4398 SvMAGIC_set(sv, mg);
4400 /* Sometimes a magic contains a reference loop, where the sv and
4401 object refer to each other. To prevent a reference loop that
4402 would prevent such objects being freed, we look for such loops
4403 and if we find one we avoid incrementing the object refcount.
4405 Note we cannot do this to avoid self-tie loops as intervening RV must
4406 have its REFCNT incremented to keep it in existence.
4409 if (!obj || obj == sv ||
4410 how == PERL_MAGIC_arylen ||
4411 how == PERL_MAGIC_qr ||
4412 how == PERL_MAGIC_symtab ||
4413 (SvTYPE(obj) == SVt_PVGV &&
4414 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4415 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4416 GvFORM(obj) == (CV*)sv)))
4421 mg->mg_obj = SvREFCNT_inc_simple(obj);
4422 mg->mg_flags |= MGf_REFCOUNTED;
4425 /* Normal self-ties simply pass a null object, and instead of
4426 using mg_obj directly, use the SvTIED_obj macro to produce a
4427 new RV as needed. For glob "self-ties", we are tieing the PVIO
4428 with an RV obj pointing to the glob containing the PVIO. In
4429 this case, to avoid a reference loop, we need to weaken the
4433 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4434 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4440 mg->mg_len = namlen;
4443 mg->mg_ptr = savepvn(name, namlen);
4444 else if (namlen == HEf_SVKEY)
4445 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4447 mg->mg_ptr = (char *) name;
4449 mg->mg_virtual = vtable;
4453 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4458 =for apidoc sv_magic
4460 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4461 then adds a new magic item of type C<how> to the head of the magic list.
4463 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4464 handling of the C<name> and C<namlen> arguments.
4466 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4467 to add more than one instance of the same 'how'.
4473 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4479 #ifdef PERL_OLD_COPY_ON_WRITE
4481 sv_force_normal_flags(sv, 0);
4483 if (SvREADONLY(sv)) {
4485 /* its okay to attach magic to shared strings; the subsequent
4486 * upgrade to PVMG will unshare the string */
4487 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4490 && how != PERL_MAGIC_regex_global
4491 && how != PERL_MAGIC_bm
4492 && how != PERL_MAGIC_fm
4493 && how != PERL_MAGIC_sv
4494 && how != PERL_MAGIC_backref
4497 Perl_croak(aTHX_ PL_no_modify);
4500 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4501 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4502 /* sv_magic() refuses to add a magic of the same 'how' as an
4505 if (how == PERL_MAGIC_taint) {
4507 /* Any scalar which already had taint magic on which someone
4508 (erroneously?) did SvIOK_on() or similar will now be
4509 incorrectly sporting public "OK" flags. */
4510 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4518 vtable = &PL_vtbl_sv;
4520 case PERL_MAGIC_overload:
4521 vtable = &PL_vtbl_amagic;
4523 case PERL_MAGIC_overload_elem:
4524 vtable = &PL_vtbl_amagicelem;
4526 case PERL_MAGIC_overload_table:
4527 vtable = &PL_vtbl_ovrld;
4530 vtable = &PL_vtbl_bm;
4532 case PERL_MAGIC_regdata:
4533 vtable = &PL_vtbl_regdata;
4535 case PERL_MAGIC_regdata_names:
4536 vtable = &PL_vtbl_regdata_names;
4538 case PERL_MAGIC_regdatum:
4539 vtable = &PL_vtbl_regdatum;
4541 case PERL_MAGIC_env:
4542 vtable = &PL_vtbl_env;
4545 vtable = &PL_vtbl_fm;
4547 case PERL_MAGIC_envelem:
4548 vtable = &PL_vtbl_envelem;
4550 case PERL_MAGIC_regex_global:
4551 vtable = &PL_vtbl_mglob;
4553 case PERL_MAGIC_isa:
4554 vtable = &PL_vtbl_isa;
4556 case PERL_MAGIC_isaelem:
4557 vtable = &PL_vtbl_isaelem;
4559 case PERL_MAGIC_nkeys:
4560 vtable = &PL_vtbl_nkeys;
4562 case PERL_MAGIC_dbfile:
4565 case PERL_MAGIC_dbline:
4566 vtable = &PL_vtbl_dbline;
4568 #ifdef USE_LOCALE_COLLATE
4569 case PERL_MAGIC_collxfrm:
4570 vtable = &PL_vtbl_collxfrm;
4572 #endif /* USE_LOCALE_COLLATE */
4573 case PERL_MAGIC_tied:
4574 vtable = &PL_vtbl_pack;
4576 case PERL_MAGIC_tiedelem:
4577 case PERL_MAGIC_tiedscalar:
4578 vtable = &PL_vtbl_packelem;
4581 vtable = &PL_vtbl_regexp;
4583 case PERL_MAGIC_hints:
4584 /* As this vtable is all NULL, we can reuse it. */
4585 case PERL_MAGIC_sig:
4586 vtable = &PL_vtbl_sig;
4588 case PERL_MAGIC_sigelem:
4589 vtable = &PL_vtbl_sigelem;
4591 case PERL_MAGIC_taint:
4592 vtable = &PL_vtbl_taint;
4594 case PERL_MAGIC_uvar:
4595 vtable = &PL_vtbl_uvar;
4597 case PERL_MAGIC_vec:
4598 vtable = &PL_vtbl_vec;
4600 case PERL_MAGIC_arylen_p:
4601 case PERL_MAGIC_rhash:
4602 case PERL_MAGIC_symtab:
4603 case PERL_MAGIC_vstring:
4606 case PERL_MAGIC_utf8:
4607 vtable = &PL_vtbl_utf8;
4609 case PERL_MAGIC_substr:
4610 vtable = &PL_vtbl_substr;
4612 case PERL_MAGIC_defelem:
4613 vtable = &PL_vtbl_defelem;
4615 case PERL_MAGIC_arylen:
4616 vtable = &PL_vtbl_arylen;
4618 case PERL_MAGIC_pos:
4619 vtable = &PL_vtbl_pos;
4621 case PERL_MAGIC_backref:
4622 vtable = &PL_vtbl_backref;
4624 case PERL_MAGIC_hintselem:
4625 vtable = &PL_vtbl_hintselem;
4627 case PERL_MAGIC_ext:
4628 /* Reserved for use by extensions not perl internals. */
4629 /* Useful for attaching extension internal data to perl vars. */
4630 /* Note that multiple extensions may clash if magical scalars */
4631 /* etc holding private data from one are passed to another. */
4635 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4638 /* Rest of work is done else where */
4639 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4642 case PERL_MAGIC_taint:
4645 case PERL_MAGIC_ext:
4646 case PERL_MAGIC_dbfile:
4653 =for apidoc sv_unmagic
4655 Removes all magic of type C<type> from an SV.
4661 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4665 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4667 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4668 for (mg = *mgp; mg; mg = *mgp) {
4669 if (mg->mg_type == type) {
4670 const MGVTBL* const vtbl = mg->mg_virtual;
4671 *mgp = mg->mg_moremagic;
4672 if (vtbl && vtbl->svt_free)
4673 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4674 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4676 Safefree(mg->mg_ptr);
4677 else if (mg->mg_len == HEf_SVKEY)
4678 SvREFCNT_dec((SV*)mg->mg_ptr);
4679 else if (mg->mg_type == PERL_MAGIC_utf8)
4680 Safefree(mg->mg_ptr);
4682 if (mg->mg_flags & MGf_REFCOUNTED)
4683 SvREFCNT_dec(mg->mg_obj);
4687 mgp = &mg->mg_moremagic;
4691 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4692 SvMAGIC_set(sv, NULL);
4699 =for apidoc sv_rvweaken
4701 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4702 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4703 push a back-reference to this RV onto the array of backreferences
4704 associated with that magic. If the RV is magical, set magic will be
4705 called after the RV is cleared.
4711 Perl_sv_rvweaken(pTHX_ SV *sv)
4714 if (!SvOK(sv)) /* let undefs pass */
4717 Perl_croak(aTHX_ "Can't weaken a nonreference");
4718 else if (SvWEAKREF(sv)) {
4719 if (ckWARN(WARN_MISC))
4720 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4724 Perl_sv_add_backref(aTHX_ tsv, sv);
4730 /* Give tsv backref magic if it hasn't already got it, then push a
4731 * back-reference to sv onto the array associated with the backref magic.
4735 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4740 if (SvTYPE(tsv) == SVt_PVHV) {
4741 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4745 /* There is no AV in the offical place - try a fixup. */
4746 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4749 /* Aha. They've got it stowed in magic. Bring it back. */
4750 av = (AV*)mg->mg_obj;
4751 /* Stop mg_free decreasing the refernce count. */
4753 /* Stop mg_free even calling the destructor, given that
4754 there's no AV to free up. */
4756 sv_unmagic(tsv, PERL_MAGIC_backref);
4760 SvREFCNT_inc_simple_void(av);
4765 const MAGIC *const mg
4766 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4768 av = (AV*)mg->mg_obj;
4772 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4773 /* av now has a refcnt of 2, which avoids it getting freed
4774 * before us during global cleanup. The extra ref is removed
4775 * by magic_killbackrefs() when tsv is being freed */
4778 if (AvFILLp(av) >= AvMAX(av)) {
4779 av_extend(av, AvFILLp(av)+1);
4781 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4784 /* delete a back-reference to ourselves from the backref magic associated
4785 * with the SV we point to.
4789 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4796 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4797 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4798 /* We mustn't attempt to "fix up" the hash here by moving the
4799 backreference array back to the hv_aux structure, as that is stored
4800 in the main HvARRAY(), and hfreentries assumes that no-one
4801 reallocates HvARRAY() while it is running. */
4804 const MAGIC *const mg
4805 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4807 av = (AV *)mg->mg_obj;
4810 if (PL_in_clean_all)
4812 Perl_croak(aTHX_ "panic: del_backref");
4819 /* We shouldn't be in here more than once, but for paranoia reasons lets
4821 for (i = AvFILLp(av); i >= 0; i--) {
4823 const SSize_t fill = AvFILLp(av);
4825 /* We weren't the last entry.
4826 An unordered list has this property that you can take the
4827 last element off the end to fill the hole, and it's still
4828 an unordered list :-)
4833 AvFILLp(av) = fill - 1;
4839 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4841 SV **svp = AvARRAY(av);
4843 PERL_UNUSED_ARG(sv);
4845 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4846 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4847 if (svp && !SvIS_FREED(av)) {
4848 SV *const *const last = svp + AvFILLp(av);
4850 while (svp <= last) {
4852 SV *const referrer = *svp;
4853 if (SvWEAKREF(referrer)) {
4854 /* XXX Should we check that it hasn't changed? */
4855 SvRV_set(referrer, 0);
4857 SvWEAKREF_off(referrer);
4858 SvSETMAGIC(referrer);
4859 } else if (SvTYPE(referrer) == SVt_PVGV ||
4860 SvTYPE(referrer) == SVt_PVLV) {
4861 /* You lookin' at me? */
4862 assert(GvSTASH(referrer));
4863 assert(GvSTASH(referrer) == (HV*)sv);
4864 GvSTASH(referrer) = 0;
4867 "panic: magic_killbackrefs (flags=%"UVxf")",
4868 (UV)SvFLAGS(referrer));
4876 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4881 =for apidoc sv_insert
4883 Inserts a string at the specified offset/length within the SV. Similar to
4884 the Perl substr() function.
4890 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4895 register char *midend;
4896 register char *bigend;
4902 Perl_croak(aTHX_ "Can't modify non-existent substring");
4903 SvPV_force(bigstr, curlen);
4904 (void)SvPOK_only_UTF8(bigstr);
4905 if (offset + len > curlen) {
4906 SvGROW(bigstr, offset+len+1);
4907 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4908 SvCUR_set(bigstr, offset+len);
4912 i = littlelen - len;
4913 if (i > 0) { /* string might grow */
4914 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4915 mid = big + offset + len;
4916 midend = bigend = big + SvCUR(bigstr);
4919 while (midend > mid) /* shove everything down */
4920 *--bigend = *--midend;
4921 Move(little,big+offset,littlelen,char);
4922 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4927 Move(little,SvPVX(bigstr)+offset,len,char);
4932 big = SvPVX(bigstr);
4935 bigend = big + SvCUR(bigstr);
4937 if (midend > bigend)
4938 Perl_croak(aTHX_ "panic: sv_insert");
4940 if (mid - big > bigend - midend) { /* faster to shorten from end */
4942 Move(little, mid, littlelen,char);
4945 i = bigend - midend;
4947 Move(midend, mid, i,char);
4951 SvCUR_set(bigstr, mid - big);
4953 else if ((i = mid - big)) { /* faster from front */
4954 midend -= littlelen;
4956 sv_chop(bigstr,midend-i);
4961 Move(little, mid, littlelen,char);
4963 else if (littlelen) {
4964 midend -= littlelen;
4965 sv_chop(bigstr,midend);
4966 Move(little,midend,littlelen,char);
4969 sv_chop(bigstr,midend);
4975 =for apidoc sv_replace
4977 Make the first argument a copy of the second, then delete the original.
4978 The target SV physically takes over ownership of the body of the source SV
4979 and inherits its flags; however, the target keeps any magic it owns,
4980 and any magic in the source is discarded.
4981 Note that this is a rather specialist SV copying operation; most of the
4982 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4988 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
4991 const U32 refcnt = SvREFCNT(sv);
4992 SV_CHECK_THINKFIRST_COW_DROP(sv);
4993 if (SvREFCNT(nsv) != 1) {
4994 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
4995 UVuf " != 1)", (UV) SvREFCNT(nsv));
4997 if (SvMAGICAL(sv)) {
5001 sv_upgrade(nsv, SVt_PVMG);
5002 SvMAGIC_set(nsv, SvMAGIC(sv));
5003 SvFLAGS(nsv) |= SvMAGICAL(sv);
5005 SvMAGIC_set(sv, NULL);
5009 assert(!SvREFCNT(sv));
5010 #ifdef DEBUG_LEAKING_SCALARS
5011 sv->sv_flags = nsv->sv_flags;
5012 sv->sv_any = nsv->sv_any;
5013 sv->sv_refcnt = nsv->sv_refcnt;
5014 sv->sv_u = nsv->sv_u;
5016 StructCopy(nsv,sv,SV);
5018 /* Currently could join these into one piece of pointer arithmetic, but
5019 it would be unclear. */
5020 if(SvTYPE(sv) == SVt_IV)
5022 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5023 else if (SvTYPE(sv) == SVt_RV) {
5024 SvANY(sv) = &sv->sv_u.svu_rv;
5028 #ifdef PERL_OLD_COPY_ON_WRITE
5029 if (SvIsCOW_normal(nsv)) {
5030 /* We need to follow the pointers around the loop to make the
5031 previous SV point to sv, rather than nsv. */
5034 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5037 assert(SvPVX_const(current) == SvPVX_const(nsv));
5039 /* Make the SV before us point to the SV after us. */
5041 PerlIO_printf(Perl_debug_log, "previous is\n");
5043 PerlIO_printf(Perl_debug_log,
5044 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5045 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5047 SV_COW_NEXT_SV_SET(current, sv);
5050 SvREFCNT(sv) = refcnt;
5051 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5057 =for apidoc sv_clear
5059 Clear an SV: call any destructors, free up any memory used by the body,
5060 and free the body itself. The SV's head is I<not> freed, although
5061 its type is set to all 1's so that it won't inadvertently be assumed
5062 to be live during global destruction etc.
5063 This function should only be called when REFCNT is zero. Most of the time
5064 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5071 Perl_sv_clear(pTHX_ register SV *sv)
5074 const U32 type = SvTYPE(sv);
5075 const struct body_details *const sv_type_details
5076 = bodies_by_type + type;
5079 assert(SvREFCNT(sv) == 0);
5081 if (type <= SVt_IV) {
5082 /* See the comment in sv.h about the collusion between this early
5083 return and the overloading of the NULL and IV slots in the size
5089 if (PL_defstash) { /* Still have a symbol table? */
5094 stash = SvSTASH(sv);
5095 destructor = StashHANDLER(stash,DESTROY);
5097 SV* const tmpref = newRV(sv);
5098 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5100 PUSHSTACKi(PERLSI_DESTROY);
5105 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5111 if(SvREFCNT(tmpref) < 2) {
5112 /* tmpref is not kept alive! */
5114 SvRV_set(tmpref, NULL);
5117 SvREFCNT_dec(tmpref);
5119 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5123 if (PL_in_clean_objs)
5124 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5126 /* DESTROY gave object new lease on life */
5132 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5133 SvOBJECT_off(sv); /* Curse the object. */
5134 if (type != SVt_PVIO)
5135 --PL_sv_objcount; /* XXX Might want something more general */
5138 if (type >= SVt_PVMG) {
5139 if ((type == SVt_PVMG || type == SVt_PVGV) && SvPAD_OUR(sv)) {
5140 SvREFCNT_dec(OURSTASH(sv));
5141 } else if (SvMAGIC(sv))
5143 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5144 SvREFCNT_dec(SvSTASH(sv));
5149 IoIFP(sv) != PerlIO_stdin() &&
5150 IoIFP(sv) != PerlIO_stdout() &&
5151 IoIFP(sv) != PerlIO_stderr())
5153 io_close((IO*)sv, FALSE);
5155 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5156 PerlDir_close(IoDIRP(sv));
5157 IoDIRP(sv) = (DIR*)NULL;
5158 Safefree(IoTOP_NAME(sv));
5159 Safefree(IoFMT_NAME(sv));
5160 Safefree(IoBOTTOM_NAME(sv));
5169 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5176 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5177 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5178 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5179 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5181 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5182 SvREFCNT_dec(LvTARG(sv));
5186 if (GvNAME_HEK(sv)) {
5187 unshare_hek(GvNAME_HEK(sv));
5189 /* If we're in a stash, we don't own a reference to it. However it does
5190 have a back reference to us, which needs to be cleared. */
5192 sv_del_backref((SV*)GvSTASH(sv), sv);
5197 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5199 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5200 /* Don't even bother with turning off the OOK flag. */
5205 SV * const target = SvRV(sv);
5207 sv_del_backref(target, sv);
5209 SvREFCNT_dec(target);
5211 #ifdef PERL_OLD_COPY_ON_WRITE
5212 else if (SvPVX_const(sv)) {
5214 /* I believe I need to grab the global SV mutex here and
5215 then recheck the COW status. */
5217 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5220 sv_release_COW(sv, SvPVX_const(sv), SvLEN(sv),
5221 SV_COW_NEXT_SV(sv));
5222 /* And drop it here. */
5224 } else if (SvLEN(sv)) {
5225 Safefree(SvPVX_const(sv));
5229 else if (SvPVX_const(sv) && SvLEN(sv))
5230 Safefree(SvPVX_mutable(sv));
5231 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5232 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5241 SvFLAGS(sv) &= SVf_BREAK;
5242 SvFLAGS(sv) |= SVTYPEMASK;
5244 if (sv_type_details->arena) {
5245 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5246 &PL_body_roots[type]);
5248 else if (sv_type_details->body_size) {
5249 my_safefree(SvANY(sv));
5254 =for apidoc sv_newref
5256 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5263 Perl_sv_newref(pTHX_ SV *sv)
5265 PERL_UNUSED_CONTEXT;
5274 Decrement an SV's reference count, and if it drops to zero, call
5275 C<sv_clear> to invoke destructors and free up any memory used by
5276 the body; finally, deallocate the SV's head itself.
5277 Normally called via a wrapper macro C<SvREFCNT_dec>.
5283 Perl_sv_free(pTHX_ SV *sv)
5288 if (SvREFCNT(sv) == 0) {
5289 if (SvFLAGS(sv) & SVf_BREAK)
5290 /* this SV's refcnt has been artificially decremented to
5291 * trigger cleanup */
5293 if (PL_in_clean_all) /* All is fair */
5295 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5296 /* make sure SvREFCNT(sv)==0 happens very seldom */
5297 SvREFCNT(sv) = (~(U32)0)/2;
5300 if (ckWARN_d(WARN_INTERNAL)) {
5301 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5302 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5303 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5304 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5305 Perl_dump_sv_child(aTHX_ sv);
5310 if (--(SvREFCNT(sv)) > 0)
5312 Perl_sv_free2(aTHX_ sv);
5316 Perl_sv_free2(pTHX_ SV *sv)
5321 if (ckWARN_d(WARN_DEBUGGING))
5322 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5323 "Attempt to free temp prematurely: SV 0x%"UVxf
5324 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5328 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5329 /* make sure SvREFCNT(sv)==0 happens very seldom */
5330 SvREFCNT(sv) = (~(U32)0)/2;
5341 Returns the length of the string in the SV. Handles magic and type
5342 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5348 Perl_sv_len(pTHX_ register SV *sv)
5356 len = mg_length(sv);
5358 (void)SvPV_const(sv, len);
5363 =for apidoc sv_len_utf8
5365 Returns the number of characters in the string in an SV, counting wide
5366 UTF-8 bytes as a single character. Handles magic and type coercion.
5372 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5373 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5374 * (Note that the mg_len is not the length of the mg_ptr field.
5375 * This allows the cache to store the character length of the string without
5376 * needing to malloc() extra storage to attach to the mg_ptr.)
5381 Perl_sv_len_utf8(pTHX_ register SV *sv)
5387 return mg_length(sv);
5391 const U8 *s = (U8*)SvPV_const(sv, len);
5395 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5397 if (mg && mg->mg_len != -1) {
5399 if (PL_utf8cache < 0) {
5400 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5402 /* Need to turn the assertions off otherwise we may
5403 recurse infinitely while printing error messages.
5405 SAVEI8(PL_utf8cache);
5407 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5408 " real %"UVuf" for %"SVf,
5409 (UV) ulen, (UV) real, (void*)sv);
5414 ulen = Perl_utf8_length(aTHX_ s, s + len);
5415 if (!SvREADONLY(sv)) {
5417 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5418 &PL_vtbl_utf8, 0, 0);
5426 return Perl_utf8_length(aTHX_ s, s + len);
5430 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5433 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5436 const U8 *s = start;
5438 while (s < send && uoffset--)
5441 /* This is the existing behaviour. Possibly it should be a croak, as
5442 it's actually a bounds error */
5448 /* Given the length of the string in both bytes and UTF-8 characters, decide
5449 whether to walk forwards or backwards to find the byte corresponding to
5450 the passed in UTF-8 offset. */
5452 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5453 STRLEN uoffset, STRLEN uend)
5455 STRLEN backw = uend - uoffset;
5456 if (uoffset < 2 * backw) {
5457 /* The assumption is that going forwards is twice the speed of going
5458 forward (that's where the 2 * backw comes from).
5459 (The real figure of course depends on the UTF-8 data.) */
5460 return sv_pos_u2b_forwards(start, send, uoffset);
5465 while (UTF8_IS_CONTINUATION(*send))
5468 return send - start;
5471 /* For the string representation of the given scalar, find the byte
5472 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5473 give another position in the string, *before* the sought offset, which
5474 (which is always true, as 0, 0 is a valid pair of positions), which should
5475 help reduce the amount of linear searching.
5476 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5477 will be used to reduce the amount of linear searching. The cache will be
5478 created if necessary, and the found value offered to it for update. */
5480 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5481 const U8 *const send, STRLEN uoffset,
5482 STRLEN uoffset0, STRLEN boffset0) {
5483 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5486 assert (uoffset >= uoffset0);
5488 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5489 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5490 if ((*mgp)->mg_ptr) {
5491 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5492 if (cache[0] == uoffset) {
5493 /* An exact match. */
5496 if (cache[2] == uoffset) {
5497 /* An exact match. */
5501 if (cache[0] < uoffset) {
5502 /* The cache already knows part of the way. */
5503 if (cache[0] > uoffset0) {
5504 /* The cache knows more than the passed in pair */
5505 uoffset0 = cache[0];
5506 boffset0 = cache[1];
5508 if ((*mgp)->mg_len != -1) {
5509 /* And we know the end too. */
5511 + sv_pos_u2b_midway(start + boffset0, send,
5513 (*mgp)->mg_len - uoffset0);
5516 + sv_pos_u2b_forwards(start + boffset0,
5517 send, uoffset - uoffset0);
5520 else if (cache[2] < uoffset) {
5521 /* We're between the two cache entries. */
5522 if (cache[2] > uoffset0) {
5523 /* and the cache knows more than the passed in pair */
5524 uoffset0 = cache[2];
5525 boffset0 = cache[3];
5529 + sv_pos_u2b_midway(start + boffset0,
5532 cache[0] - uoffset0);
5535 + sv_pos_u2b_midway(start + boffset0,
5538 cache[2] - uoffset0);
5542 else if ((*mgp)->mg_len != -1) {
5543 /* If we can take advantage of a passed in offset, do so. */
5544 /* In fact, offset0 is either 0, or less than offset, so don't
5545 need to worry about the other possibility. */
5547 + sv_pos_u2b_midway(start + boffset0, send,
5549 (*mgp)->mg_len - uoffset0);
5554 if (!found || PL_utf8cache < 0) {
5555 const STRLEN real_boffset
5556 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5557 send, uoffset - uoffset0);
5559 if (found && PL_utf8cache < 0) {
5560 if (real_boffset != boffset) {
5561 /* Need to turn the assertions off otherwise we may recurse
5562 infinitely while printing error messages. */
5563 SAVEI8(PL_utf8cache);
5565 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5566 " real %"UVuf" for %"SVf,
5567 (UV) boffset, (UV) real_boffset, (void*)sv);
5570 boffset = real_boffset;
5573 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5579 =for apidoc sv_pos_u2b
5581 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5582 the start of the string, to a count of the equivalent number of bytes; if
5583 lenp is non-zero, it does the same to lenp, but this time starting from
5584 the offset, rather than from the start of the string. Handles magic and
5591 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5592 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5593 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5598 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5606 start = (U8*)SvPV_const(sv, len);
5608 STRLEN uoffset = (STRLEN) *offsetp;
5609 const U8 * const send = start + len;
5611 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5614 *offsetp = (I32) boffset;
5617 /* Convert the relative offset to absolute. */
5618 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5619 const STRLEN boffset2
5620 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5621 uoffset, boffset) - boffset;
5635 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5636 byte length pairing. The (byte) length of the total SV is passed in too,
5637 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5638 may not have updated SvCUR, so we can't rely on reading it directly.
5640 The proffered utf8/byte length pairing isn't used if the cache already has
5641 two pairs, and swapping either for the proffered pair would increase the
5642 RMS of the intervals between known byte offsets.
5644 The cache itself consists of 4 STRLEN values
5645 0: larger UTF-8 offset
5646 1: corresponding byte offset
5647 2: smaller UTF-8 offset
5648 3: corresponding byte offset
5650 Unused cache pairs have the value 0, 0.
5651 Keeping the cache "backwards" means that the invariant of
5652 cache[0] >= cache[2] is maintained even with empty slots, which means that
5653 the code that uses it doesn't need to worry if only 1 entry has actually
5654 been set to non-zero. It also makes the "position beyond the end of the
5655 cache" logic much simpler, as the first slot is always the one to start
5659 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5667 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5669 (*mgp)->mg_len = -1;
5673 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5674 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5675 (*mgp)->mg_ptr = (char *) cache;
5679 if (PL_utf8cache < 0) {
5680 const U8 *start = (const U8 *) SvPVX_const(sv);
5681 const U8 *const end = start + byte;
5682 STRLEN realutf8 = 0;
5684 while (start < end) {
5685 start += UTF8SKIP(start);
5689 /* Can't use S_sv_pos_b2u_forwards as it will scream warnings on
5690 surrogates. FIXME - is it inconsistent that b2u warns, but u2b
5691 doesn't? I don't know whether this difference was introduced with
5692 the caching code in 5.8.1. */
5694 if (realutf8 != utf8) {
5695 /* Need to turn the assertions off otherwise we may recurse
5696 infinitely while printing error messages. */
5697 SAVEI8(PL_utf8cache);
5699 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5700 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, (void*)sv);
5704 /* Cache is held with the later position first, to simplify the code
5705 that deals with unbounded ends. */
5707 ASSERT_UTF8_CACHE(cache);
5708 if (cache[1] == 0) {
5709 /* Cache is totally empty */
5712 } else if (cache[3] == 0) {
5713 if (byte > cache[1]) {
5714 /* New one is larger, so goes first. */
5715 cache[2] = cache[0];
5716 cache[3] = cache[1];
5724 #define THREEWAY_SQUARE(a,b,c,d) \
5725 ((float)((d) - (c))) * ((float)((d) - (c))) \
5726 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5727 + ((float)((b) - (a))) * ((float)((b) - (a)))
5729 /* Cache has 2 slots in use, and we know three potential pairs.
5730 Keep the two that give the lowest RMS distance. Do the
5731 calcualation in bytes simply because we always know the byte
5732 length. squareroot has the same ordering as the positive value,
5733 so don't bother with the actual square root. */
5734 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5735 if (byte > cache[1]) {
5736 /* New position is after the existing pair of pairs. */
5737 const float keep_earlier
5738 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5739 const float keep_later
5740 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5742 if (keep_later < keep_earlier) {
5743 if (keep_later < existing) {
5744 cache[2] = cache[0];
5745 cache[3] = cache[1];
5751 if (keep_earlier < existing) {
5757 else if (byte > cache[3]) {
5758 /* New position is between the existing pair of pairs. */
5759 const float keep_earlier
5760 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5761 const float keep_later
5762 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5764 if (keep_later < keep_earlier) {
5765 if (keep_later < existing) {
5771 if (keep_earlier < existing) {
5778 /* New position is before the existing pair of pairs. */
5779 const float keep_earlier
5780 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5781 const float keep_later
5782 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5784 if (keep_later < keep_earlier) {
5785 if (keep_later < existing) {
5791 if (keep_earlier < existing) {
5792 cache[0] = cache[2];
5793 cache[1] = cache[3];
5800 ASSERT_UTF8_CACHE(cache);
5803 /* If we don't know the character offset of the end of a region, our only
5804 option is to walk forwards to the target byte offset. */
5806 S_sv_pos_b2u_forwards(pTHX_ const U8 *s, const U8 *const target)
5809 while (s < target) {
5812 /* Call utf8n_to_uvchr() to validate the sequence
5813 * (unless a simple non-UTF character) */
5814 if (!UTF8_IS_INVARIANT(*s))
5815 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5826 /* We already know all of the way, now we may be able to walk back. The same
5827 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5828 backward is half the speed of walking forward. */
5830 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5833 const STRLEN forw = target - s;
5834 STRLEN backw = end - target;
5836 if (forw < 2 * backw) {
5837 return S_sv_pos_b2u_forwards(aTHX_ s, target);
5840 while (end > target) {
5842 while (UTF8_IS_CONTINUATION(*end)) {
5851 =for apidoc sv_pos_b2u
5853 Converts the value pointed to by offsetp from a count of bytes from the
5854 start of the string, to a count of the equivalent number of UTF-8 chars.
5855 Handles magic and type coercion.
5861 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5862 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5867 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5870 const STRLEN byte = *offsetp;
5871 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5880 s = (const U8*)SvPV_const(sv, blen);
5883 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5887 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5888 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5890 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5891 if (cache[1] == byte) {
5892 /* An exact match. */
5893 *offsetp = cache[0];
5896 if (cache[3] == byte) {
5897 /* An exact match. */
5898 *offsetp = cache[2];
5902 if (cache[1] < byte) {
5903 /* We already know part of the way. */
5904 if (mg->mg_len != -1) {
5905 /* Actually, we know the end too. */
5907 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5908 s + blen, mg->mg_len - cache[0]);
5911 + S_sv_pos_b2u_forwards(aTHX_ s + cache[1], send);
5914 else if (cache[3] < byte) {
5915 /* We're between the two cached pairs, so we do the calculation
5916 offset by the byte/utf-8 positions for the earlier pair,
5917 then add the utf-8 characters from the string start to
5919 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5920 s + cache[1], cache[0] - cache[2])
5924 else { /* cache[3] > byte */
5925 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5929 ASSERT_UTF8_CACHE(cache);
5931 } else if (mg->mg_len != -1) {
5932 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5936 if (!found || PL_utf8cache < 0) {
5937 const STRLEN real_len = S_sv_pos_b2u_forwards(aTHX_ s, send);
5939 if (found && PL_utf8cache < 0) {
5940 if (len != real_len) {
5941 /* Need to turn the assertions off otherwise we may recurse
5942 infinitely while printing error messages. */
5943 SAVEI8(PL_utf8cache);
5945 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5946 " real %"UVuf" for %"SVf,
5947 (UV) len, (UV) real_len, (void*)sv);
5954 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5960 Returns a boolean indicating whether the strings in the two SVs are
5961 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5962 coerce its args to strings if necessary.
5968 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5977 SV* svrecode = NULL;
5984 /* if pv1 and pv2 are the same, second SvPV_const call may
5985 * invalidate pv1, so we may need to make a copy */
5986 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5987 pv1 = SvPV_const(sv1, cur1);
5988 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5989 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5991 pv1 = SvPV_const(sv1, cur1);
5999 pv2 = SvPV_const(sv2, cur2);
6001 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6002 /* Differing utf8ness.
6003 * Do not UTF8size the comparands as a side-effect. */
6006 svrecode = newSVpvn(pv2, cur2);
6007 sv_recode_to_utf8(svrecode, PL_encoding);
6008 pv2 = SvPV_const(svrecode, cur2);
6011 svrecode = newSVpvn(pv1, cur1);
6012 sv_recode_to_utf8(svrecode, PL_encoding);
6013 pv1 = SvPV_const(svrecode, cur1);
6015 /* Now both are in UTF-8. */
6017 SvREFCNT_dec(svrecode);
6022 bool is_utf8 = TRUE;
6025 /* sv1 is the UTF-8 one,
6026 * if is equal it must be downgrade-able */
6027 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6033 /* sv2 is the UTF-8 one,
6034 * if is equal it must be downgrade-able */
6035 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6041 /* Downgrade not possible - cannot be eq */
6049 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6051 SvREFCNT_dec(svrecode);
6061 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6062 string in C<sv1> is less than, equal to, or greater than the string in
6063 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6064 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6070 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6074 const char *pv1, *pv2;
6077 SV *svrecode = NULL;
6084 pv1 = SvPV_const(sv1, cur1);
6091 pv2 = SvPV_const(sv2, cur2);
6093 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6094 /* Differing utf8ness.
6095 * Do not UTF8size the comparands as a side-effect. */
6098 svrecode = newSVpvn(pv2, cur2);
6099 sv_recode_to_utf8(svrecode, PL_encoding);
6100 pv2 = SvPV_const(svrecode, cur2);
6103 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6108 svrecode = newSVpvn(pv1, cur1);
6109 sv_recode_to_utf8(svrecode, PL_encoding);
6110 pv1 = SvPV_const(svrecode, cur1);
6113 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6119 cmp = cur2 ? -1 : 0;
6123 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6126 cmp = retval < 0 ? -1 : 1;
6127 } else if (cur1 == cur2) {
6130 cmp = cur1 < cur2 ? -1 : 1;
6134 SvREFCNT_dec(svrecode);
6142 =for apidoc sv_cmp_locale
6144 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6145 'use bytes' aware, handles get magic, and will coerce its args to strings
6146 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6152 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6155 #ifdef USE_LOCALE_COLLATE
6161 if (PL_collation_standard)
6165 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6167 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6169 if (!pv1 || !len1) {
6180 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6183 return retval < 0 ? -1 : 1;
6186 * When the result of collation is equality, that doesn't mean
6187 * that there are no differences -- some locales exclude some
6188 * characters from consideration. So to avoid false equalities,
6189 * we use the raw string as a tiebreaker.
6195 #endif /* USE_LOCALE_COLLATE */
6197 return sv_cmp(sv1, sv2);
6201 #ifdef USE_LOCALE_COLLATE
6204 =for apidoc sv_collxfrm
6206 Add Collate Transform magic to an SV if it doesn't already have it.
6208 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6209 scalar data of the variable, but transformed to such a format that a normal
6210 memory comparison can be used to compare the data according to the locale
6217 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6222 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6223 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6229 Safefree(mg->mg_ptr);
6230 s = SvPV_const(sv, len);
6231 if ((xf = mem_collxfrm(s, len, &xlen))) {
6232 if (SvREADONLY(sv)) {
6235 return xf + sizeof(PL_collation_ix);
6238 #ifdef PERL_OLD_COPY_ON_WRITE
6240 sv_force_normal_flags(sv, 0);
6242 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6256 if (mg && mg->mg_ptr) {
6258 return mg->mg_ptr + sizeof(PL_collation_ix);
6266 #endif /* USE_LOCALE_COLLATE */
6271 Get a line from the filehandle and store it into the SV, optionally
6272 appending to the currently-stored string.
6278 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6283 register STDCHAR rslast;
6284 register STDCHAR *bp;
6289 if (SvTHINKFIRST(sv))
6290 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6291 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6293 However, perlbench says it's slower, because the existing swipe code
6294 is faster than copy on write.
6295 Swings and roundabouts. */
6296 SvUPGRADE(sv, SVt_PV);
6301 if (PerlIO_isutf8(fp)) {
6303 sv_utf8_upgrade_nomg(sv);
6304 sv_pos_u2b(sv,&append,0);
6306 } else if (SvUTF8(sv)) {
6307 SV * const tsv = newSV(0);
6308 sv_gets(tsv, fp, 0);
6309 sv_utf8_upgrade_nomg(tsv);
6310 SvCUR_set(sv,append);
6313 goto return_string_or_null;
6318 if (PerlIO_isutf8(fp))
6321 if (IN_PERL_COMPILETIME) {
6322 /* we always read code in line mode */
6326 else if (RsSNARF(PL_rs)) {
6327 /* If it is a regular disk file use size from stat() as estimate
6328 of amount we are going to read -- may result in mallocing
6329 more memory than we really need if the layers below reduce
6330 the size we read (e.g. CRLF or a gzip layer).
6333 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6334 const Off_t offset = PerlIO_tell(fp);
6335 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6336 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6342 else if (RsRECORD(PL_rs)) {
6347 /* Grab the size of the record we're getting */
6348 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6349 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6352 /* VMS wants read instead of fread, because fread doesn't respect */
6353 /* RMS record boundaries. This is not necessarily a good thing to be */
6354 /* doing, but we've got no other real choice - except avoid stdio
6355 as implementation - perhaps write a :vms layer ?
6357 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6359 bytesread = PerlIO_read(fp, buffer, recsize);
6363 SvCUR_set(sv, bytesread += append);
6364 buffer[bytesread] = '\0';
6365 goto return_string_or_null;
6367 else if (RsPARA(PL_rs)) {
6373 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6374 if (PerlIO_isutf8(fp)) {
6375 rsptr = SvPVutf8(PL_rs, rslen);
6378 if (SvUTF8(PL_rs)) {
6379 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6380 Perl_croak(aTHX_ "Wide character in $/");
6383 rsptr = SvPV_const(PL_rs, rslen);
6387 rslast = rslen ? rsptr[rslen - 1] : '\0';
6389 if (rspara) { /* have to do this both before and after */
6390 do { /* to make sure file boundaries work right */
6393 i = PerlIO_getc(fp);
6397 PerlIO_ungetc(fp,i);
6403 /* See if we know enough about I/O mechanism to cheat it ! */
6405 /* This used to be #ifdef test - it is made run-time test for ease
6406 of abstracting out stdio interface. One call should be cheap
6407 enough here - and may even be a macro allowing compile
6411 if (PerlIO_fast_gets(fp)) {
6414 * We're going to steal some values from the stdio struct
6415 * and put EVERYTHING in the innermost loop into registers.
6417 register STDCHAR *ptr;
6421 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6422 /* An ungetc()d char is handled separately from the regular
6423 * buffer, so we getc() it back out and stuff it in the buffer.
6425 i = PerlIO_getc(fp);
6426 if (i == EOF) return 0;
6427 *(--((*fp)->_ptr)) = (unsigned char) i;
6431 /* Here is some breathtakingly efficient cheating */
6433 cnt = PerlIO_get_cnt(fp); /* get count into register */
6434 /* make sure we have the room */
6435 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6436 /* Not room for all of it
6437 if we are looking for a separator and room for some
6439 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6440 /* just process what we have room for */
6441 shortbuffered = cnt - SvLEN(sv) + append + 1;
6442 cnt -= shortbuffered;
6446 /* remember that cnt can be negative */
6447 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6452 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6453 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6454 DEBUG_P(PerlIO_printf(Perl_debug_log,
6455 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6456 DEBUG_P(PerlIO_printf(Perl_debug_log,
6457 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6458 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6459 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6464 while (cnt > 0) { /* this | eat */
6466 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6467 goto thats_all_folks; /* screams | sed :-) */
6471 Copy(ptr, bp, cnt, char); /* this | eat */
6472 bp += cnt; /* screams | dust */
6473 ptr += cnt; /* louder | sed :-) */
6478 if (shortbuffered) { /* oh well, must extend */
6479 cnt = shortbuffered;
6481 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6483 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6484 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6488 DEBUG_P(PerlIO_printf(Perl_debug_log,
6489 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6490 PTR2UV(ptr),(long)cnt));
6491 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6493 DEBUG_P(PerlIO_printf(Perl_debug_log,
6494 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6495 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6496 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6498 /* This used to call 'filbuf' in stdio form, but as that behaves like
6499 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6500 another abstraction. */
6501 i = PerlIO_getc(fp); /* get more characters */
6503 DEBUG_P(PerlIO_printf(Perl_debug_log,
6504 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6505 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6506 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6508 cnt = PerlIO_get_cnt(fp);
6509 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6510 DEBUG_P(PerlIO_printf(Perl_debug_log,
6511 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6513 if (i == EOF) /* all done for ever? */
6514 goto thats_really_all_folks;
6516 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6518 SvGROW(sv, bpx + cnt + 2);
6519 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6521 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6523 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6524 goto thats_all_folks;
6528 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6529 memNE((char*)bp - rslen, rsptr, rslen))
6530 goto screamer; /* go back to the fray */
6531 thats_really_all_folks:
6533 cnt += shortbuffered;
6534 DEBUG_P(PerlIO_printf(Perl_debug_log,
6535 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6536 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6537 DEBUG_P(PerlIO_printf(Perl_debug_log,
6538 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6539 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6540 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6542 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6543 DEBUG_P(PerlIO_printf(Perl_debug_log,
6544 "Screamer: done, len=%ld, string=|%.*s|\n",
6545 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6549 /*The big, slow, and stupid way. */
6550 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6551 STDCHAR *buf = NULL;
6552 Newx(buf, 8192, STDCHAR);
6560 register const STDCHAR * const bpe = buf + sizeof(buf);
6562 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6563 ; /* keep reading */
6567 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6568 /* Accomodate broken VAXC compiler, which applies U8 cast to
6569 * both args of ?: operator, causing EOF to change into 255
6572 i = (U8)buf[cnt - 1];
6578 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6580 sv_catpvn(sv, (char *) buf, cnt);
6582 sv_setpvn(sv, (char *) buf, cnt);
6584 if (i != EOF && /* joy */
6586 SvCUR(sv) < rslen ||
6587 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6591 * If we're reading from a TTY and we get a short read,
6592 * indicating that the user hit his EOF character, we need
6593 * to notice it now, because if we try to read from the TTY
6594 * again, the EOF condition will disappear.
6596 * The comparison of cnt to sizeof(buf) is an optimization
6597 * that prevents unnecessary calls to feof().
6601 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6605 #ifdef USE_HEAP_INSTEAD_OF_STACK
6610 if (rspara) { /* have to do this both before and after */
6611 while (i != EOF) { /* to make sure file boundaries work right */
6612 i = PerlIO_getc(fp);
6614 PerlIO_ungetc(fp,i);
6620 return_string_or_null:
6621 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6627 Auto-increment of the value in the SV, doing string to numeric conversion
6628 if necessary. Handles 'get' magic.
6634 Perl_sv_inc(pTHX_ register SV *sv)
6643 if (SvTHINKFIRST(sv)) {
6645 sv_force_normal_flags(sv, 0);
6646 if (SvREADONLY(sv)) {
6647 if (IN_PERL_RUNTIME)
6648 Perl_croak(aTHX_ PL_no_modify);
6652 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6654 i = PTR2IV(SvRV(sv));
6659 flags = SvFLAGS(sv);
6660 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6661 /* It's (privately or publicly) a float, but not tested as an
6662 integer, so test it to see. */
6664 flags = SvFLAGS(sv);
6666 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6667 /* It's publicly an integer, or privately an integer-not-float */
6668 #ifdef PERL_PRESERVE_IVUV
6672 if (SvUVX(sv) == UV_MAX)
6673 sv_setnv(sv, UV_MAX_P1);
6675 (void)SvIOK_only_UV(sv);
6676 SvUV_set(sv, SvUVX(sv) + 1);
6678 if (SvIVX(sv) == IV_MAX)
6679 sv_setuv(sv, (UV)IV_MAX + 1);
6681 (void)SvIOK_only(sv);
6682 SvIV_set(sv, SvIVX(sv) + 1);
6687 if (flags & SVp_NOK) {
6688 (void)SvNOK_only(sv);
6689 SvNV_set(sv, SvNVX(sv) + 1.0);
6693 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6694 if ((flags & SVTYPEMASK) < SVt_PVIV)
6695 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6696 (void)SvIOK_only(sv);
6701 while (isALPHA(*d)) d++;
6702 while (isDIGIT(*d)) d++;
6704 #ifdef PERL_PRESERVE_IVUV
6705 /* Got to punt this as an integer if needs be, but we don't issue
6706 warnings. Probably ought to make the sv_iv_please() that does
6707 the conversion if possible, and silently. */
6708 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6709 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6710 /* Need to try really hard to see if it's an integer.
6711 9.22337203685478e+18 is an integer.
6712 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6713 so $a="9.22337203685478e+18"; $a+0; $a++
6714 needs to be the same as $a="9.22337203685478e+18"; $a++
6721 /* sv_2iv *should* have made this an NV */
6722 if (flags & SVp_NOK) {
6723 (void)SvNOK_only(sv);
6724 SvNV_set(sv, SvNVX(sv) + 1.0);
6727 /* I don't think we can get here. Maybe I should assert this
6728 And if we do get here I suspect that sv_setnv will croak. NWC
6730 #if defined(USE_LONG_DOUBLE)
6731 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",
6732 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6734 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6735 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6738 #endif /* PERL_PRESERVE_IVUV */
6739 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6743 while (d >= SvPVX_const(sv)) {
6751 /* MKS: The original code here died if letters weren't consecutive.
6752 * at least it didn't have to worry about non-C locales. The
6753 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6754 * arranged in order (although not consecutively) and that only
6755 * [A-Za-z] are accepted by isALPHA in the C locale.
6757 if (*d != 'z' && *d != 'Z') {
6758 do { ++*d; } while (!isALPHA(*d));
6761 *(d--) -= 'z' - 'a';
6766 *(d--) -= 'z' - 'a' + 1;
6770 /* oh,oh, the number grew */
6771 SvGROW(sv, SvCUR(sv) + 2);
6772 SvCUR_set(sv, SvCUR(sv) + 1);
6773 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6784 Auto-decrement of the value in the SV, doing string to numeric conversion
6785 if necessary. Handles 'get' magic.
6791 Perl_sv_dec(pTHX_ register SV *sv)
6799 if (SvTHINKFIRST(sv)) {
6801 sv_force_normal_flags(sv, 0);
6802 if (SvREADONLY(sv)) {
6803 if (IN_PERL_RUNTIME)
6804 Perl_croak(aTHX_ PL_no_modify);
6808 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6810 i = PTR2IV(SvRV(sv));
6815 /* Unlike sv_inc we don't have to worry about string-never-numbers
6816 and keeping them magic. But we mustn't warn on punting */
6817 flags = SvFLAGS(sv);
6818 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6819 /* It's publicly an integer, or privately an integer-not-float */
6820 #ifdef PERL_PRESERVE_IVUV
6824 if (SvUVX(sv) == 0) {
6825 (void)SvIOK_only(sv);
6829 (void)SvIOK_only_UV(sv);
6830 SvUV_set(sv, SvUVX(sv) - 1);
6833 if (SvIVX(sv) == IV_MIN)
6834 sv_setnv(sv, (NV)IV_MIN - 1.0);
6836 (void)SvIOK_only(sv);
6837 SvIV_set(sv, SvIVX(sv) - 1);
6842 if (flags & SVp_NOK) {
6843 SvNV_set(sv, SvNVX(sv) - 1.0);
6844 (void)SvNOK_only(sv);
6847 if (!(flags & SVp_POK)) {
6848 if ((flags & SVTYPEMASK) < SVt_PVIV)
6849 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6851 (void)SvIOK_only(sv);
6854 #ifdef PERL_PRESERVE_IVUV
6856 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6857 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6858 /* Need to try really hard to see if it's an integer.
6859 9.22337203685478e+18 is an integer.
6860 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6861 so $a="9.22337203685478e+18"; $a+0; $a--
6862 needs to be the same as $a="9.22337203685478e+18"; $a--
6869 /* sv_2iv *should* have made this an NV */
6870 if (flags & SVp_NOK) {
6871 (void)SvNOK_only(sv);
6872 SvNV_set(sv, SvNVX(sv) - 1.0);
6875 /* I don't think we can get here. Maybe I should assert this
6876 And if we do get here I suspect that sv_setnv will croak. NWC
6878 #if defined(USE_LONG_DOUBLE)
6879 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",
6880 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6882 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6883 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6887 #endif /* PERL_PRESERVE_IVUV */
6888 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6892 =for apidoc sv_mortalcopy
6894 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6895 The new SV is marked as mortal. It will be destroyed "soon", either by an
6896 explicit call to FREETMPS, or by an implicit call at places such as
6897 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6902 /* Make a string that will exist for the duration of the expression
6903 * evaluation. Actually, it may have to last longer than that, but
6904 * hopefully we won't free it until it has been assigned to a
6905 * permanent location. */
6908 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6914 sv_setsv(sv,oldstr);
6916 PL_tmps_stack[++PL_tmps_ix] = sv;
6922 =for apidoc sv_newmortal
6924 Creates a new null SV which is mortal. The reference count of the SV is
6925 set to 1. It will be destroyed "soon", either by an explicit call to
6926 FREETMPS, or by an implicit call at places such as statement boundaries.
6927 See also C<sv_mortalcopy> and C<sv_2mortal>.
6933 Perl_sv_newmortal(pTHX)
6939 SvFLAGS(sv) = SVs_TEMP;
6941 PL_tmps_stack[++PL_tmps_ix] = sv;
6946 =for apidoc sv_2mortal
6948 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6949 by an explicit call to FREETMPS, or by an implicit call at places such as
6950 statement boundaries. SvTEMP() is turned on which means that the SV's
6951 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6952 and C<sv_mortalcopy>.
6958 Perl_sv_2mortal(pTHX_ register SV *sv)
6963 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6966 PL_tmps_stack[++PL_tmps_ix] = sv;
6974 Creates a new SV and copies a string into it. The reference count for the
6975 SV is set to 1. If C<len> is zero, Perl will compute the length using
6976 strlen(). For efficiency, consider using C<newSVpvn> instead.
6982 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6988 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6993 =for apidoc newSVpvn
6995 Creates a new SV and copies a string into it. The reference count for the
6996 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6997 string. You are responsible for ensuring that the source string is at least
6998 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7004 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7010 sv_setpvn(sv,s,len);
7016 =for apidoc newSVhek
7018 Creates a new SV from the hash key structure. It will generate scalars that
7019 point to the shared string table where possible. Returns a new (undefined)
7020 SV if the hek is NULL.
7026 Perl_newSVhek(pTHX_ const HEK *hek)
7036 if (HEK_LEN(hek) == HEf_SVKEY) {
7037 return newSVsv(*(SV**)HEK_KEY(hek));
7039 const int flags = HEK_FLAGS(hek);
7040 if (flags & HVhek_WASUTF8) {
7042 Andreas would like keys he put in as utf8 to come back as utf8
7044 STRLEN utf8_len = HEK_LEN(hek);
7045 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7046 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7049 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7051 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7052 /* We don't have a pointer to the hv, so we have to replicate the
7053 flag into every HEK. This hv is using custom a hasing
7054 algorithm. Hence we can't return a shared string scalar, as
7055 that would contain the (wrong) hash value, and might get passed
7056 into an hv routine with a regular hash.
7057 Similarly, a hash that isn't using shared hash keys has to have
7058 the flag in every key so that we know not to try to call
7059 share_hek_kek on it. */
7061 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7066 /* This will be overwhelminly the most common case. */
7068 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7069 more efficient than sharepvn(). */
7073 sv_upgrade(sv, SVt_PV);
7074 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7075 SvCUR_set(sv, HEK_LEN(hek));
7088 =for apidoc newSVpvn_share
7090 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7091 table. If the string does not already exist in the table, it is created
7092 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7093 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7094 otherwise the hash is computed. The idea here is that as the string table
7095 is used for shared hash keys these strings will have SvPVX_const == HeKEY and
7096 hash lookup will avoid string compare.
7102 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7106 bool is_utf8 = FALSE;
7107 const char *const orig_src = src;
7110 STRLEN tmplen = -len;
7112 /* See the note in hv.c:hv_fetch() --jhi */
7113 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7117 PERL_HASH(hash, src, len);
7119 sv_upgrade(sv, SVt_PV);
7120 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7128 if (src != orig_src)
7134 #if defined(PERL_IMPLICIT_CONTEXT)
7136 /* pTHX_ magic can't cope with varargs, so this is a no-context
7137 * version of the main function, (which may itself be aliased to us).
7138 * Don't access this version directly.
7142 Perl_newSVpvf_nocontext(const char* pat, ...)
7147 va_start(args, pat);
7148 sv = vnewSVpvf(pat, &args);
7155 =for apidoc newSVpvf
7157 Creates a new SV and initializes it with the string formatted like
7164 Perl_newSVpvf(pTHX_ const char* pat, ...)
7168 va_start(args, pat);
7169 sv = vnewSVpvf(pat, &args);
7174 /* backend for newSVpvf() and newSVpvf_nocontext() */
7177 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7182 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7189 Creates a new SV and copies a floating point value into it.
7190 The reference count for the SV is set to 1.
7196 Perl_newSVnv(pTHX_ NV n)
7209 Creates a new SV and copies an integer into it. The reference count for the
7216 Perl_newSViv(pTHX_ IV i)
7229 Creates a new SV and copies an unsigned integer into it.
7230 The reference count for the SV is set to 1.
7236 Perl_newSVuv(pTHX_ UV u)
7247 =for apidoc newRV_noinc
7249 Creates an RV wrapper for an SV. The reference count for the original
7250 SV is B<not> incremented.
7256 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7262 sv_upgrade(sv, SVt_RV);
7264 SvRV_set(sv, tmpRef);
7269 /* newRV_inc is the official function name to use now.
7270 * newRV_inc is in fact #defined to newRV in sv.h
7274 Perl_newRV(pTHX_ SV *sv)
7277 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7283 Creates a new SV which is an exact duplicate of the original SV.
7290 Perl_newSVsv(pTHX_ register SV *old)
7297 if (SvTYPE(old) == SVTYPEMASK) {
7298 if (ckWARN_d(WARN_INTERNAL))
7299 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7303 /* SV_GMAGIC is the default for sv_setv()
7304 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7305 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7306 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7311 =for apidoc sv_reset
7313 Underlying implementation for the C<reset> Perl function.
7314 Note that the perl-level function is vaguely deprecated.
7320 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7323 char todo[PERL_UCHAR_MAX+1];
7328 if (!*s) { /* reset ?? searches */
7329 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7331 PMOP *pm = (PMOP *) mg->mg_obj;
7333 pm->op_pmdynflags &= ~PMdf_USED;
7340 /* reset variables */
7342 if (!HvARRAY(stash))
7345 Zero(todo, 256, char);
7348 I32 i = (unsigned char)*s;
7352 max = (unsigned char)*s++;
7353 for ( ; i <= max; i++) {
7356 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7358 for (entry = HvARRAY(stash)[i];
7360 entry = HeNEXT(entry))
7365 if (!todo[(U8)*HeKEY(entry)])
7367 gv = (GV*)HeVAL(entry);
7370 if (SvTHINKFIRST(sv)) {
7371 if (!SvREADONLY(sv) && SvROK(sv))
7373 /* XXX Is this continue a bug? Why should THINKFIRST
7374 exempt us from resetting arrays and hashes? */
7378 if (SvTYPE(sv) >= SVt_PV) {
7380 if (SvPVX_const(sv) != NULL)
7388 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7390 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7393 # if defined(USE_ENVIRON_ARRAY)
7396 # endif /* USE_ENVIRON_ARRAY */
7407 Using various gambits, try to get an IO from an SV: the IO slot if its a
7408 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7409 named after the PV if we're a string.
7415 Perl_sv_2io(pTHX_ SV *sv)
7420 switch (SvTYPE(sv)) {
7428 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7432 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7434 return sv_2io(SvRV(sv));
7435 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7441 Perl_croak(aTHX_ "Bad filehandle: %"SVf, (void*)sv);
7450 Using various gambits, try to get a CV from an SV; in addition, try if
7451 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7452 The flags in C<lref> are passed to sv_fetchsv.
7458 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7469 switch (SvTYPE(sv)) {
7488 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7489 tryAMAGICunDEREF(to_cv);
7492 if (SvTYPE(sv) == SVt_PVCV) {
7501 Perl_croak(aTHX_ "Not a subroutine reference");
7506 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7512 /* Some flags to gv_fetchsv mean don't really create the GV */
7513 if (SvTYPE(gv) != SVt_PVGV) {
7519 if (lref && !GvCVu(gv)) {
7523 gv_efullname3(tmpsv, gv, NULL);
7524 /* XXX this is probably not what they think they're getting.
7525 * It has the same effect as "sub name;", i.e. just a forward
7527 newSUB(start_subparse(FALSE, 0),
7528 newSVOP(OP_CONST, 0, tmpsv),
7532 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7542 Returns true if the SV has a true value by Perl's rules.
7543 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7544 instead use an in-line version.
7550 Perl_sv_true(pTHX_ register SV *sv)
7555 register const XPV* const tXpv = (XPV*)SvANY(sv);
7557 (tXpv->xpv_cur > 1 ||
7558 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7565 return SvIVX(sv) != 0;
7568 return SvNVX(sv) != 0.0;
7570 return sv_2bool(sv);
7576 =for apidoc sv_pvn_force
7578 Get a sensible string out of the SV somehow.
7579 A private implementation of the C<SvPV_force> macro for compilers which
7580 can't cope with complex macro expressions. Always use the macro instead.
7582 =for apidoc sv_pvn_force_flags
7584 Get a sensible string out of the SV somehow.
7585 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7586 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7587 implemented in terms of this function.
7588 You normally want to use the various wrapper macros instead: see
7589 C<SvPV_force> and C<SvPV_force_nomg>
7595 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7598 if (SvTHINKFIRST(sv) && !SvROK(sv))
7599 sv_force_normal_flags(sv, 0);
7609 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7610 const char * const ref = sv_reftype(sv,0);
7612 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7613 ref, OP_NAME(PL_op));
7615 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7617 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7618 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7620 s = sv_2pv_flags(sv, &len, flags);
7624 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7627 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7628 SvGROW(sv, len + 1);
7629 Move(s,SvPVX(sv),len,char);
7634 SvPOK_on(sv); /* validate pointer */
7636 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7637 PTR2UV(sv),SvPVX_const(sv)));
7640 return SvPVX_mutable(sv);
7644 =for apidoc sv_pvbyten_force
7646 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7652 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7654 sv_pvn_force(sv,lp);
7655 sv_utf8_downgrade(sv,0);
7661 =for apidoc sv_pvutf8n_force
7663 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7669 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7671 sv_pvn_force(sv,lp);
7672 sv_utf8_upgrade(sv);
7678 =for apidoc sv_reftype
7680 Returns a string describing what the SV is a reference to.
7686 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7688 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7689 inside return suggests a const propagation bug in g++. */
7690 if (ob && SvOBJECT(sv)) {
7691 char * const name = HvNAME_get(SvSTASH(sv));
7692 return name ? name : (char *) "__ANON__";
7695 switch (SvTYPE(sv)) {
7712 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7713 /* tied lvalues should appear to be
7714 * scalars for backwards compatitbility */
7715 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7716 ? "SCALAR" : "LVALUE");
7717 case SVt_PVAV: return "ARRAY";
7718 case SVt_PVHV: return "HASH";
7719 case SVt_PVCV: return "CODE";
7720 case SVt_PVGV: return "GLOB";
7721 case SVt_PVFM: return "FORMAT";
7722 case SVt_PVIO: return "IO";
7723 default: return "UNKNOWN";
7729 =for apidoc sv_isobject
7731 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7732 object. If the SV is not an RV, or if the object is not blessed, then this
7739 Perl_sv_isobject(pTHX_ SV *sv)
7755 Returns a boolean indicating whether the SV is blessed into the specified
7756 class. This does not check for subtypes; use C<sv_derived_from> to verify
7757 an inheritance relationship.
7763 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7774 hvname = HvNAME_get(SvSTASH(sv));
7778 return strEQ(hvname, name);
7784 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7785 it will be upgraded to one. If C<classname> is non-null then the new SV will
7786 be blessed in the specified package. The new SV is returned and its
7787 reference count is 1.
7793 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7800 SV_CHECK_THINKFIRST_COW_DROP(rv);
7803 if (SvTYPE(rv) >= SVt_PVMG) {
7804 const U32 refcnt = SvREFCNT(rv);
7808 SvREFCNT(rv) = refcnt;
7810 sv_upgrade(rv, SVt_RV);
7811 } else if (SvROK(rv)) {
7812 SvREFCNT_dec(SvRV(rv));
7813 } else if (SvTYPE(rv) < SVt_RV)
7814 sv_upgrade(rv, SVt_RV);
7815 else if (SvTYPE(rv) > SVt_RV) {
7826 HV* const stash = gv_stashpv(classname, TRUE);
7827 (void)sv_bless(rv, stash);
7833 =for apidoc sv_setref_pv
7835 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7836 argument will be upgraded to an RV. That RV will be modified to point to
7837 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7838 into the 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.
7842 Do not use with other Perl types such as HV, AV, SV, CV, because those
7843 objects will become corrupted by the pointer copy process.
7845 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7851 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7855 sv_setsv(rv, &PL_sv_undef);
7859 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7864 =for apidoc sv_setref_iv
7866 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7867 argument will be upgraded to an RV. That RV will be modified to point to
7868 the new SV. The C<classname> argument indicates the package for the
7869 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7870 will have a reference count of 1, and the RV will be returned.
7876 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7878 sv_setiv(newSVrv(rv,classname), iv);
7883 =for apidoc sv_setref_uv
7885 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7886 argument will be upgraded to an RV. That RV will be modified to point to
7887 the new SV. The C<classname> argument indicates the package for the
7888 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7889 will have a reference count of 1, and the RV will be returned.
7895 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7897 sv_setuv(newSVrv(rv,classname), uv);
7902 =for apidoc sv_setref_nv
7904 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7905 argument will be upgraded to an RV. That RV will be modified to point to
7906 the new SV. The C<classname> argument indicates the package for the
7907 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7908 will have a reference count of 1, and the RV will be returned.
7914 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7916 sv_setnv(newSVrv(rv,classname), nv);
7921 =for apidoc sv_setref_pvn
7923 Copies a string into a new SV, optionally blessing the SV. The length of the
7924 string must be specified with C<n>. The C<rv> argument will be upgraded to
7925 an RV. That RV will be modified to point to the new SV. The C<classname>
7926 argument indicates the package for the blessing. Set C<classname> to
7927 C<NULL> to avoid the blessing. The new SV will have a reference count
7928 of 1, and the RV will be returned.
7930 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7936 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7938 sv_setpvn(newSVrv(rv,classname), pv, n);
7943 =for apidoc sv_bless
7945 Blesses an SV into a specified package. The SV must be an RV. The package
7946 must be designated by its stash (see C<gv_stashpv()>). The reference count
7947 of the SV is unaffected.
7953 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7958 Perl_croak(aTHX_ "Can't bless non-reference value");
7960 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7961 if (SvREADONLY(tmpRef))
7962 Perl_croak(aTHX_ PL_no_modify);
7963 if (SvOBJECT(tmpRef)) {
7964 if (SvTYPE(tmpRef) != SVt_PVIO)
7966 SvREFCNT_dec(SvSTASH(tmpRef));
7969 SvOBJECT_on(tmpRef);
7970 if (SvTYPE(tmpRef) != SVt_PVIO)
7972 SvUPGRADE(tmpRef, SVt_PVMG);
7973 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
7980 if(SvSMAGICAL(tmpRef))
7981 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7989 /* Downgrades a PVGV to a PVMG.
7993 S_sv_unglob(pTHX_ SV *sv)
7997 SV * const temp = sv_newmortal();
7999 assert(SvTYPE(sv) == SVt_PVGV);
8001 gv_efullname3(temp, (GV *) sv, "*");
8007 sv_del_backref((SV*)GvSTASH(sv), sv);
8011 if (GvNAME_HEK(sv)) {
8012 unshare_hek(GvNAME_HEK(sv));
8016 /* need to keep SvANY(sv) in the right arena */
8017 xpvmg = new_XPVMG();
8018 StructCopy(SvANY(sv), xpvmg, XPVMG);
8019 del_XPVGV(SvANY(sv));
8022 SvFLAGS(sv) &= ~SVTYPEMASK;
8023 SvFLAGS(sv) |= SVt_PVMG;
8025 /* Intentionally not calling any local SET magic, as this isn't so much a
8026 set operation as merely an internal storage change. */
8027 sv_setsv_flags(sv, temp, 0);
8031 =for apidoc sv_unref_flags
8033 Unsets the RV status of the SV, and decrements the reference count of
8034 whatever was being referenced by the RV. This can almost be thought of
8035 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8036 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8037 (otherwise the decrementing is conditional on the reference count being
8038 different from one or the reference being a readonly SV).
8045 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8047 SV* const target = SvRV(ref);
8049 if (SvWEAKREF(ref)) {
8050 sv_del_backref(target, ref);
8052 SvRV_set(ref, NULL);
8055 SvRV_set(ref, NULL);
8057 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8058 assigned to as BEGIN {$a = \"Foo"} will fail. */
8059 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8060 SvREFCNT_dec(target);
8061 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8062 sv_2mortal(target); /* Schedule for freeing later */
8066 =for apidoc sv_untaint
8068 Untaint an SV. Use C<SvTAINTED_off> instead.
8073 Perl_sv_untaint(pTHX_ SV *sv)
8075 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8076 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8083 =for apidoc sv_tainted
8085 Test an SV for taintedness. Use C<SvTAINTED> instead.
8090 Perl_sv_tainted(pTHX_ SV *sv)
8092 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8093 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8094 if (mg && (mg->mg_len & 1) )
8101 =for apidoc sv_setpviv
8103 Copies an integer into the given SV, also updating its string value.
8104 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8110 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8112 char buf[TYPE_CHARS(UV)];
8114 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8116 sv_setpvn(sv, ptr, ebuf - ptr);
8120 =for apidoc sv_setpviv_mg
8122 Like C<sv_setpviv>, but also handles 'set' magic.
8128 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8134 #if defined(PERL_IMPLICIT_CONTEXT)
8136 /* pTHX_ magic can't cope with varargs, so this is a no-context
8137 * version of the main function, (which may itself be aliased to us).
8138 * Don't access this version directly.
8142 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8146 va_start(args, pat);
8147 sv_vsetpvf(sv, pat, &args);
8151 /* pTHX_ magic can't cope with varargs, so this is a no-context
8152 * version of the main function, (which may itself be aliased to us).
8153 * Don't access this version directly.
8157 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8161 va_start(args, pat);
8162 sv_vsetpvf_mg(sv, pat, &args);
8168 =for apidoc sv_setpvf
8170 Works like C<sv_catpvf> but copies the text into the SV instead of
8171 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8177 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8180 va_start(args, pat);
8181 sv_vsetpvf(sv, pat, &args);
8186 =for apidoc sv_vsetpvf
8188 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8189 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8191 Usually used via its frontend C<sv_setpvf>.
8197 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8199 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8203 =for apidoc sv_setpvf_mg
8205 Like C<sv_setpvf>, but also handles 'set' magic.
8211 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8214 va_start(args, pat);
8215 sv_vsetpvf_mg(sv, pat, &args);
8220 =for apidoc sv_vsetpvf_mg
8222 Like C<sv_vsetpvf>, but also handles 'set' magic.
8224 Usually used via its frontend C<sv_setpvf_mg>.
8230 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8232 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8236 #if defined(PERL_IMPLICIT_CONTEXT)
8238 /* pTHX_ magic can't cope with varargs, so this is a no-context
8239 * version of the main function, (which may itself be aliased to us).
8240 * Don't access this version directly.
8244 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8248 va_start(args, pat);
8249 sv_vcatpvf(sv, pat, &args);
8253 /* pTHX_ magic can't cope with varargs, so this is a no-context
8254 * version of the main function, (which may itself be aliased to us).
8255 * Don't access this version directly.
8259 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8263 va_start(args, pat);
8264 sv_vcatpvf_mg(sv, pat, &args);
8270 =for apidoc sv_catpvf
8272 Processes its arguments like C<sprintf> and appends the formatted
8273 output to an SV. If the appended data contains "wide" characters
8274 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8275 and characters >255 formatted with %c), the original SV might get
8276 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8277 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8278 valid UTF-8; if the original SV was bytes, the pattern should be too.
8283 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8286 va_start(args, pat);
8287 sv_vcatpvf(sv, pat, &args);
8292 =for apidoc sv_vcatpvf
8294 Processes its arguments like C<vsprintf> and appends the formatted output
8295 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8297 Usually used via its frontend C<sv_catpvf>.
8303 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8305 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8309 =for apidoc sv_catpvf_mg
8311 Like C<sv_catpvf>, but also handles 'set' magic.
8317 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8320 va_start(args, pat);
8321 sv_vcatpvf_mg(sv, pat, &args);
8326 =for apidoc sv_vcatpvf_mg
8328 Like C<sv_vcatpvf>, but also handles 'set' magic.
8330 Usually used via its frontend C<sv_catpvf_mg>.
8336 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8338 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8343 =for apidoc sv_vsetpvfn
8345 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8348 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8354 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8356 sv_setpvn(sv, "", 0);
8357 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8361 S_expect_number(pTHX_ char** pattern)
8365 switch (**pattern) {
8366 case '1': case '2': case '3':
8367 case '4': case '5': case '6':
8368 case '7': case '8': case '9':
8369 var = *(*pattern)++ - '0';
8370 while (isDIGIT(**pattern)) {
8371 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8373 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8381 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8383 const int neg = nv < 0;
8392 if (uv & 1 && uv == nv)
8393 uv--; /* Round to even */
8395 const unsigned dig = uv % 10;
8408 =for apidoc sv_vcatpvfn
8410 Processes its arguments like C<vsprintf> and appends the formatted output
8411 to an SV. Uses an array of SVs if the C style variable argument list is
8412 missing (NULL). When running with taint checks enabled, indicates via
8413 C<maybe_tainted> if results are untrustworthy (often due to the use of
8416 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8422 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8423 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8424 vec_utf8 = DO_UTF8(vecsv);
8426 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8429 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8437 static const char nullstr[] = "(null)";
8439 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8440 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8442 /* Times 4: a decimal digit takes more than 3 binary digits.
8443 * NV_DIG: mantissa takes than many decimal digits.
8444 * Plus 32: Playing safe. */
8445 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8446 /* large enough for "%#.#f" --chip */
8447 /* what about long double NVs? --jhi */
8449 PERL_UNUSED_ARG(maybe_tainted);
8451 /* no matter what, this is a string now */
8452 (void)SvPV_force(sv, origlen);
8454 /* special-case "", "%s", and "%-p" (SVf - see below) */
8457 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8459 const char * const s = va_arg(*args, char*);
8460 sv_catpv(sv, s ? s : nullstr);
8462 else if (svix < svmax) {
8463 sv_catsv(sv, *svargs);
8467 if (args && patlen == 3 && pat[0] == '%' &&
8468 pat[1] == '-' && pat[2] == 'p') {
8469 argsv = va_arg(*args, SV*);
8470 sv_catsv(sv, argsv);
8474 #ifndef USE_LONG_DOUBLE
8475 /* special-case "%.<number>[gf]" */
8476 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8477 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8478 unsigned digits = 0;
8482 while (*pp >= '0' && *pp <= '9')
8483 digits = 10 * digits + (*pp++ - '0');
8484 if (pp - pat == (int)patlen - 1) {
8492 /* Add check for digits != 0 because it seems that some
8493 gconverts are buggy in this case, and we don't yet have
8494 a Configure test for this. */
8495 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8496 /* 0, point, slack */
8497 Gconvert(nv, (int)digits, 0, ebuf);
8499 if (*ebuf) /* May return an empty string for digits==0 */
8502 } else if (!digits) {
8505 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8506 sv_catpvn(sv, p, l);
8512 #endif /* !USE_LONG_DOUBLE */
8514 if (!args && svix < svmax && DO_UTF8(*svargs))
8517 patend = (char*)pat + patlen;
8518 for (p = (char*)pat; p < patend; p = q) {
8521 bool vectorize = FALSE;
8522 bool vectorarg = FALSE;
8523 bool vec_utf8 = FALSE;
8529 bool has_precis = FALSE;
8531 const I32 osvix = svix;
8532 bool is_utf8 = FALSE; /* is this item utf8? */
8533 #ifdef HAS_LDBL_SPRINTF_BUG
8534 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8535 with sfio - Allen <allens@cpan.org> */
8536 bool fix_ldbl_sprintf_bug = FALSE;
8540 U8 utf8buf[UTF8_MAXBYTES+1];
8541 STRLEN esignlen = 0;
8543 const char *eptr = NULL;
8546 const U8 *vecstr = NULL;
8553 /* we need a long double target in case HAS_LONG_DOUBLE but
8556 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8564 const char *dotstr = ".";
8565 STRLEN dotstrlen = 1;
8566 I32 efix = 0; /* explicit format parameter index */
8567 I32 ewix = 0; /* explicit width index */
8568 I32 epix = 0; /* explicit precision index */
8569 I32 evix = 0; /* explicit vector index */
8570 bool asterisk = FALSE;
8572 /* echo everything up to the next format specification */
8573 for (q = p; q < patend && *q != '%'; ++q) ;
8575 if (has_utf8 && !pat_utf8)
8576 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8578 sv_catpvn(sv, p, q - p);
8585 We allow format specification elements in this order:
8586 \d+\$ explicit format parameter index
8588 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8589 0 flag (as above): repeated to allow "v02"
8590 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8591 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8593 [%bcdefginopsuxDFOUX] format (mandatory)
8598 As of perl5.9.3, printf format checking is on by default.
8599 Internally, perl uses %p formats to provide an escape to
8600 some extended formatting. This block deals with those
8601 extensions: if it does not match, (char*)q is reset and
8602 the normal format processing code is used.
8604 Currently defined extensions are:
8605 %p include pointer address (standard)
8606 %-p (SVf) include an SV (previously %_)
8607 %-<num>p include an SV with precision <num>
8608 %1p (VDf) include a v-string (as %vd)
8609 %<num>p reserved for future extensions
8611 Robin Barker 2005-07-14
8618 n = expect_number(&q);
8625 argsv = va_arg(*args, SV*);
8626 eptr = SvPVx_const(argsv, elen);
8632 else if (n == vdNUMBER) { /* VDf */
8639 if (ckWARN_d(WARN_INTERNAL))
8640 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8641 "internal %%<num>p might conflict with future printf extensions");
8647 if ( (width = expect_number(&q)) ) {
8688 if ( (ewix = expect_number(&q)) )
8697 if ((vectorarg = asterisk)) {
8710 width = expect_number(&q);
8716 vecsv = va_arg(*args, SV*);
8718 vecsv = (evix > 0 && evix <= svmax)
8719 ? svargs[evix-1] : &PL_sv_undef;
8721 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8723 dotstr = SvPV_const(vecsv, dotstrlen);
8724 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8725 bad with tied or overloaded values that return UTF8. */
8728 else if (has_utf8) {
8729 vecsv = sv_mortalcopy(vecsv);
8730 sv_utf8_upgrade(vecsv);
8731 dotstr = SvPV_const(vecsv, dotstrlen);
8738 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8739 vecsv = svargs[efix ? efix-1 : svix++];
8740 vecstr = (U8*)SvPV_const(vecsv,veclen);
8741 vec_utf8 = DO_UTF8(vecsv);
8743 /* if this is a version object, we need to convert
8744 * back into v-string notation and then let the
8745 * vectorize happen normally
8747 if (sv_derived_from(vecsv, "version")) {
8748 char *version = savesvpv(vecsv);
8749 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8750 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8751 "vector argument not supported with alpha versions");
8754 vecsv = sv_newmortal();
8755 /* scan_vstring is expected to be called during
8756 * tokenization, so we need to fake up the end
8757 * of the buffer for it
8759 PL_bufend = version + veclen;
8760 scan_vstring(version, vecsv);
8761 vecstr = (U8*)SvPV_const(vecsv, veclen);
8762 vec_utf8 = DO_UTF8(vecsv);
8774 i = va_arg(*args, int);
8776 i = (ewix ? ewix <= svmax : svix < svmax) ?
8777 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8779 width = (i < 0) ? -i : i;
8789 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8791 /* XXX: todo, support specified precision parameter */
8795 i = va_arg(*args, int);
8797 i = (ewix ? ewix <= svmax : svix < svmax)
8798 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8799 precis = (i < 0) ? 0 : i;
8804 precis = precis * 10 + (*q++ - '0');
8813 case 'I': /* Ix, I32x, and I64x */
8815 if (q[1] == '6' && q[2] == '4') {
8821 if (q[1] == '3' && q[2] == '2') {
8831 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8842 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8843 if (*(q + 1) == 'l') { /* lld, llf */
8869 if (!vectorize && !args) {
8871 const I32 i = efix-1;
8872 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8874 argsv = (svix >= 0 && svix < svmax)
8875 ? svargs[svix++] : &PL_sv_undef;
8886 uv = (args) ? va_arg(*args, int) : SvIVx(argsv);
8888 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8890 eptr = (char*)utf8buf;
8891 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8905 eptr = va_arg(*args, char*);
8907 #ifdef MACOS_TRADITIONAL
8908 /* On MacOS, %#s format is used for Pascal strings */
8913 elen = strlen(eptr);
8915 eptr = (char *)nullstr;
8916 elen = sizeof nullstr - 1;
8920 eptr = SvPVx_const(argsv, elen);
8921 if (DO_UTF8(argsv)) {
8922 if (has_precis && precis < elen) {
8924 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8927 if (width) { /* fudge width (can't fudge elen) */
8928 width += elen - sv_len_utf8(argsv);
8935 if (has_precis && elen > precis)
8942 if (alt || vectorize)
8944 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8965 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8974 esignbuf[esignlen++] = plus;
8978 case 'h': iv = (short)va_arg(*args, int); break;
8979 case 'l': iv = va_arg(*args, long); break;
8980 case 'V': iv = va_arg(*args, IV); break;
8981 default: iv = va_arg(*args, int); break;
8983 case 'q': iv = va_arg(*args, Quad_t); break;
8988 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
8990 case 'h': iv = (short)tiv; break;
8991 case 'l': iv = (long)tiv; break;
8993 default: iv = tiv; break;
8995 case 'q': iv = (Quad_t)tiv; break;
8999 if ( !vectorize ) /* we already set uv above */
9004 esignbuf[esignlen++] = plus;
9008 esignbuf[esignlen++] = '-';
9051 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9062 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9063 case 'l': uv = va_arg(*args, unsigned long); break;
9064 case 'V': uv = va_arg(*args, UV); break;
9065 default: uv = va_arg(*args, unsigned); break;
9067 case 'q': uv = va_arg(*args, Uquad_t); break;
9072 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9074 case 'h': uv = (unsigned short)tuv; break;
9075 case 'l': uv = (unsigned long)tuv; break;
9077 default: uv = tuv; break;
9079 case 'q': uv = (Uquad_t)tuv; break;
9086 char *ptr = ebuf + sizeof ebuf;
9087 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9093 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9099 esignbuf[esignlen++] = '0';
9100 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9108 if (alt && *ptr != '0')
9117 esignbuf[esignlen++] = '0';
9118 esignbuf[esignlen++] = 'b';
9121 default: /* it had better be ten or less */
9125 } while (uv /= base);
9128 elen = (ebuf + sizeof ebuf) - ptr;
9132 zeros = precis - elen;
9133 else if (precis == 0 && elen == 1 && *eptr == '0')
9139 /* FLOATING POINT */
9142 c = 'f'; /* maybe %F isn't supported here */
9150 /* This is evil, but floating point is even more evil */
9152 /* for SV-style calling, we can only get NV
9153 for C-style calling, we assume %f is double;
9154 for simplicity we allow any of %Lf, %llf, %qf for long double
9158 #if defined(USE_LONG_DOUBLE)
9162 /* [perl #20339] - we should accept and ignore %lf rather than die */
9166 #if defined(USE_LONG_DOUBLE)
9167 intsize = args ? 0 : 'q';
9171 #if defined(HAS_LONG_DOUBLE)
9180 /* now we need (long double) if intsize == 'q', else (double) */
9182 #if LONG_DOUBLESIZE > DOUBLESIZE
9184 va_arg(*args, long double) :
9185 va_arg(*args, double)
9187 va_arg(*args, double)
9192 if (c != 'e' && c != 'E') {
9194 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9195 will cast our (long double) to (double) */
9196 (void)Perl_frexp(nv, &i);
9197 if (i == PERL_INT_MIN)
9198 Perl_die(aTHX_ "panic: frexp");
9200 need = BIT_DIGITS(i);
9202 need += has_precis ? precis : 6; /* known default */
9207 #ifdef HAS_LDBL_SPRINTF_BUG
9208 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9209 with sfio - Allen <allens@cpan.org> */
9212 # define MY_DBL_MAX DBL_MAX
9213 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9214 # if DOUBLESIZE >= 8
9215 # define MY_DBL_MAX 1.7976931348623157E+308L
9217 # define MY_DBL_MAX 3.40282347E+38L
9221 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9222 # define MY_DBL_MAX_BUG 1L
9224 # define MY_DBL_MAX_BUG MY_DBL_MAX
9228 # define MY_DBL_MIN DBL_MIN
9229 # else /* XXX guessing! -Allen */
9230 # if DOUBLESIZE >= 8
9231 # define MY_DBL_MIN 2.2250738585072014E-308L
9233 # define MY_DBL_MIN 1.17549435E-38L
9237 if ((intsize == 'q') && (c == 'f') &&
9238 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9240 /* it's going to be short enough that
9241 * long double precision is not needed */
9243 if ((nv <= 0L) && (nv >= -0L))
9244 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9246 /* would use Perl_fp_class as a double-check but not
9247 * functional on IRIX - see perl.h comments */
9249 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9250 /* It's within the range that a double can represent */
9251 #if defined(DBL_MAX) && !defined(DBL_MIN)
9252 if ((nv >= ((long double)1/DBL_MAX)) ||
9253 (nv <= (-(long double)1/DBL_MAX)))
9255 fix_ldbl_sprintf_bug = TRUE;
9258 if (fix_ldbl_sprintf_bug == TRUE) {
9268 # undef MY_DBL_MAX_BUG
9271 #endif /* HAS_LDBL_SPRINTF_BUG */
9273 need += 20; /* fudge factor */
9274 if (PL_efloatsize < need) {
9275 Safefree(PL_efloatbuf);
9276 PL_efloatsize = need + 20; /* more fudge */
9277 Newx(PL_efloatbuf, PL_efloatsize, char);
9278 PL_efloatbuf[0] = '\0';
9281 if ( !(width || left || plus || alt) && fill != '0'
9282 && has_precis && intsize != 'q' ) { /* Shortcuts */
9283 /* See earlier comment about buggy Gconvert when digits,
9285 if ( c == 'g' && precis) {
9286 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9287 /* May return an empty string for digits==0 */
9288 if (*PL_efloatbuf) {
9289 elen = strlen(PL_efloatbuf);
9290 goto float_converted;
9292 } else if ( c == 'f' && !precis) {
9293 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9298 char *ptr = ebuf + sizeof ebuf;
9301 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9302 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9303 if (intsize == 'q') {
9304 /* Copy the one or more characters in a long double
9305 * format before the 'base' ([efgEFG]) character to
9306 * the format string. */
9307 static char const prifldbl[] = PERL_PRIfldbl;
9308 char const *p = prifldbl + sizeof(prifldbl) - 3;
9309 while (p >= prifldbl) { *--ptr = *p--; }
9314 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9319 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9331 /* No taint. Otherwise we are in the strange situation
9332 * where printf() taints but print($float) doesn't.
9334 #if defined(HAS_LONG_DOUBLE)
9335 elen = ((intsize == 'q')
9336 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9337 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9339 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9343 eptr = PL_efloatbuf;
9351 i = SvCUR(sv) - origlen;
9354 case 'h': *(va_arg(*args, short*)) = i; break;
9355 default: *(va_arg(*args, int*)) = i; break;
9356 case 'l': *(va_arg(*args, long*)) = i; break;
9357 case 'V': *(va_arg(*args, IV*)) = i; break;
9359 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9364 sv_setuv_mg(argsv, (UV)i);
9365 continue; /* not "break" */
9372 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9373 && ckWARN(WARN_PRINTF))
9375 SV * const msg = sv_newmortal();
9376 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9377 (PL_op->op_type == OP_PRTF) ? "" : "s");
9380 Perl_sv_catpvf(aTHX_ msg,
9381 "\"%%%c\"", c & 0xFF);
9383 Perl_sv_catpvf(aTHX_ msg,
9384 "\"%%\\%03"UVof"\"",
9387 sv_catpvs(msg, "end of string");
9388 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, (void*)msg); /* yes, this is reentrant */
9391 /* output mangled stuff ... */
9397 /* ... right here, because formatting flags should not apply */
9398 SvGROW(sv, SvCUR(sv) + elen + 1);
9400 Copy(eptr, p, elen, char);
9403 SvCUR_set(sv, p - SvPVX_const(sv));
9405 continue; /* not "break" */
9408 if (is_utf8 != has_utf8) {
9411 sv_utf8_upgrade(sv);
9414 const STRLEN old_elen = elen;
9415 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9416 sv_utf8_upgrade(nsv);
9417 eptr = SvPVX_const(nsv);
9420 if (width) { /* fudge width (can't fudge elen) */
9421 width += elen - old_elen;
9427 have = esignlen + zeros + elen;
9429 Perl_croak_nocontext(PL_memory_wrap);
9431 need = (have > width ? have : width);
9434 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9435 Perl_croak_nocontext(PL_memory_wrap);
9436 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9438 if (esignlen && fill == '0') {
9440 for (i = 0; i < (int)esignlen; i++)
9444 memset(p, fill, gap);
9447 if (esignlen && fill != '0') {
9449 for (i = 0; i < (int)esignlen; i++)
9454 for (i = zeros; i; i--)
9458 Copy(eptr, p, elen, char);
9462 memset(p, ' ', gap);
9467 Copy(dotstr, p, dotstrlen, char);
9471 vectorize = FALSE; /* done iterating over vecstr */
9478 SvCUR_set(sv, p - SvPVX_const(sv));
9486 /* =========================================================================
9488 =head1 Cloning an interpreter
9490 All the macros and functions in this section are for the private use of
9491 the main function, perl_clone().
9493 The foo_dup() functions make an exact copy of an existing foo thinngy.
9494 During the course of a cloning, a hash table is used to map old addresses
9495 to new addresses. The table is created and manipulated with the
9496 ptr_table_* functions.
9500 ============================================================================*/
9503 #if defined(USE_ITHREADS)
9505 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9506 #ifndef GpREFCNT_inc
9507 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9511 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9512 that currently av_dup and hv_dup are the same as sv_dup. If this changes,
9513 please unmerge ss_dup. */
9514 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9515 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9516 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9517 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9518 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9519 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9520 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9521 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9522 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9523 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9524 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9525 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9526 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9527 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9530 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9531 regcomp.c. AMS 20010712 */
9534 Perl_re_dup(pTHX_ const REGEXP *r, CLONE_PARAMS *param)
9536 return CALLREGDUPE(r,param);
9539 /* duplicate a file handle */
9542 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9546 PERL_UNUSED_ARG(type);
9549 return (PerlIO*)NULL;
9551 /* look for it in the table first */
9552 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9556 /* create anew and remember what it is */
9557 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9558 ptr_table_store(PL_ptr_table, fp, ret);
9562 /* duplicate a directory handle */
9565 Perl_dirp_dup(pTHX_ DIR *dp)
9567 PERL_UNUSED_CONTEXT;
9574 /* duplicate a typeglob */
9577 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9583 /* look for it in the table first */
9584 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9588 /* create anew and remember what it is */
9590 ptr_table_store(PL_ptr_table, gp, ret);
9593 ret->gp_refcnt = 0; /* must be before any other dups! */
9594 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9595 ret->gp_io = io_dup_inc(gp->gp_io, param);
9596 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9597 ret->gp_av = av_dup_inc(gp->gp_av, param);
9598 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9599 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9600 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9601 ret->gp_cvgen = gp->gp_cvgen;
9602 ret->gp_line = gp->gp_line;
9603 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9607 /* duplicate a chain of magic */
9610 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9612 MAGIC *mgprev = (MAGIC*)NULL;
9615 return (MAGIC*)NULL;
9616 /* look for it in the table first */
9617 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9621 for (; mg; mg = mg->mg_moremagic) {
9623 Newxz(nmg, 1, MAGIC);
9625 mgprev->mg_moremagic = nmg;
9628 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9629 nmg->mg_private = mg->mg_private;
9630 nmg->mg_type = mg->mg_type;
9631 nmg->mg_flags = mg->mg_flags;
9632 if (mg->mg_type == PERL_MAGIC_qr) {
9633 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
9635 else if(mg->mg_type == PERL_MAGIC_backref) {
9636 /* The backref AV has its reference count deliberately bumped by
9638 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9640 else if (mg->mg_type == PERL_MAGIC_symtab) {
9641 nmg->mg_obj = mg->mg_obj;
9644 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9645 ? sv_dup_inc(mg->mg_obj, param)
9646 : sv_dup(mg->mg_obj, param);
9648 nmg->mg_len = mg->mg_len;
9649 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9650 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9651 if (mg->mg_len > 0) {
9652 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9653 if (mg->mg_type == PERL_MAGIC_overload_table &&
9654 AMT_AMAGIC((AMT*)mg->mg_ptr))
9656 const AMT * const amtp = (AMT*)mg->mg_ptr;
9657 AMT * const namtp = (AMT*)nmg->mg_ptr;
9659 for (i = 1; i < NofAMmeth; i++) {
9660 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9664 else if (mg->mg_len == HEf_SVKEY)
9665 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9667 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9668 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9675 /* create a new pointer-mapping table */
9678 Perl_ptr_table_new(pTHX)
9681 PERL_UNUSED_CONTEXT;
9683 Newxz(tbl, 1, PTR_TBL_t);
9686 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9690 #define PTR_TABLE_HASH(ptr) \
9691 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9694 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9695 following define) and at call to new_body_inline made below in
9696 Perl_ptr_table_store()
9699 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9701 /* map an existing pointer using a table */
9703 STATIC PTR_TBL_ENT_t *
9704 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9705 PTR_TBL_ENT_t *tblent;
9706 const UV hash = PTR_TABLE_HASH(sv);
9708 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9709 for (; tblent; tblent = tblent->next) {
9710 if (tblent->oldval == sv)
9717 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9719 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9720 PERL_UNUSED_CONTEXT;
9721 return tblent ? tblent->newval : NULL;
9724 /* add a new entry to a pointer-mapping table */
9727 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9729 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9730 PERL_UNUSED_CONTEXT;
9733 tblent->newval = newsv;
9735 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9737 new_body_inline(tblent, PTE_SVSLOT);
9739 tblent->oldval = oldsv;
9740 tblent->newval = newsv;
9741 tblent->next = tbl->tbl_ary[entry];
9742 tbl->tbl_ary[entry] = tblent;
9744 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9745 ptr_table_split(tbl);
9749 /* double the hash bucket size of an existing ptr table */
9752 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9754 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9755 const UV oldsize = tbl->tbl_max + 1;
9756 UV newsize = oldsize * 2;
9758 PERL_UNUSED_CONTEXT;
9760 Renew(ary, newsize, PTR_TBL_ENT_t*);
9761 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9762 tbl->tbl_max = --newsize;
9764 for (i=0; i < oldsize; i++, ary++) {
9765 PTR_TBL_ENT_t **curentp, **entp, *ent;
9768 curentp = ary + oldsize;
9769 for (entp = ary, ent = *ary; ent; ent = *entp) {
9770 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9772 ent->next = *curentp;
9782 /* remove all the entries from a ptr table */
9785 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9787 if (tbl && tbl->tbl_items) {
9788 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9789 UV riter = tbl->tbl_max;
9792 PTR_TBL_ENT_t *entry = array[riter];
9795 PTR_TBL_ENT_t * const oentry = entry;
9796 entry = entry->next;
9805 /* clear and free a ptr table */
9808 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9813 ptr_table_clear(tbl);
9814 Safefree(tbl->tbl_ary);
9820 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9823 SvRV_set(dstr, SvWEAKREF(sstr)
9824 ? sv_dup(SvRV(sstr), param)
9825 : sv_dup_inc(SvRV(sstr), param));
9828 else if (SvPVX_const(sstr)) {
9829 /* Has something there */
9831 /* Normal PV - clone whole allocated space */
9832 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9833 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9834 /* Not that normal - actually sstr is copy on write.
9835 But we are a true, independant SV, so: */
9836 SvREADONLY_off(dstr);
9841 /* Special case - not normally malloced for some reason */
9842 if (isGV_with_GP(sstr)) {
9843 /* Don't need to do anything here. */
9845 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9846 /* A "shared" PV - clone it as "shared" PV */
9848 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9852 /* Some other special case - random pointer */
9853 SvPV_set(dstr, SvPVX(sstr));
9859 if (SvTYPE(dstr) == SVt_RV)
9860 SvRV_set(dstr, NULL);
9862 SvPV_set(dstr, NULL);
9866 /* duplicate an SV of any type (including AV, HV etc) */
9869 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
9874 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9876 /* look for it in the table first */
9877 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9881 if(param->flags & CLONEf_JOIN_IN) {
9882 /** We are joining here so we don't want do clone
9883 something that is bad **/
9884 if (SvTYPE(sstr) == SVt_PVHV) {
9885 const char * const hvname = HvNAME_get(sstr);
9887 /** don't clone stashes if they already exist **/
9888 return (SV*)gv_stashpv(hvname,0);
9892 /* create anew and remember what it is */
9895 #ifdef DEBUG_LEAKING_SCALARS
9896 dstr->sv_debug_optype = sstr->sv_debug_optype;
9897 dstr->sv_debug_line = sstr->sv_debug_line;
9898 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
9899 dstr->sv_debug_cloned = 1;
9900 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
9903 ptr_table_store(PL_ptr_table, sstr, dstr);
9906 SvFLAGS(dstr) = SvFLAGS(sstr);
9907 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9908 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9911 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
9912 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9913 PL_watch_pvx, SvPVX_const(sstr));
9916 /* don't clone objects whose class has asked us not to */
9917 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
9918 SvFLAGS(dstr) &= ~SVTYPEMASK;
9923 switch (SvTYPE(sstr)) {
9928 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
9929 SvIV_set(dstr, SvIVX(sstr));
9932 SvANY(dstr) = new_XNV();
9933 SvNV_set(dstr, SvNVX(sstr));
9936 SvANY(dstr) = &(dstr->sv_u.svu_rv);
9937 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9941 /* These are all the types that need complex bodies allocating. */
9943 const svtype sv_type = SvTYPE(sstr);
9944 const struct body_details *const sv_type_details
9945 = bodies_by_type + sv_type;
9949 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
9953 if (GvUNIQUE((GV*)sstr)) {
9954 NOOP; /* Do sharing here, and fall through */
9967 assert(sv_type_details->body_size);
9968 if (sv_type_details->arena) {
9969 new_body_inline(new_body, sv_type);
9971 = (void*)((char*)new_body - sv_type_details->offset);
9973 new_body = new_NOARENA(sv_type_details);
9977 SvANY(dstr) = new_body;
9980 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
9981 ((char*)SvANY(dstr)) + sv_type_details->offset,
9982 sv_type_details->copy, char);
9984 Copy(((char*)SvANY(sstr)),
9985 ((char*)SvANY(dstr)),
9986 sv_type_details->body_size + sv_type_details->offset, char);
9989 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
9990 && !isGV_with_GP(dstr))
9991 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
9993 /* The Copy above means that all the source (unduplicated) pointers
9994 are now in the destination. We can check the flags and the
9995 pointers in either, but it's possible that there's less cache
9996 missing by always going for the destination.
9997 FIXME - instrument and check that assumption */
9998 if (sv_type >= SVt_PVMG) {
9999 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10000 OURSTASH_set(dstr, hv_dup_inc(OURSTASH(dstr), param));
10001 } else if (SvMAGIC(dstr))
10002 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10004 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10007 /* The cast silences a GCC warning about unhandled types. */
10008 switch ((int)sv_type) {
10020 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10021 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10022 LvTARG(dstr) = dstr;
10023 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10024 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10026 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10029 if (GvNAME_HEK(dstr))
10030 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10032 /* Don't call sv_add_backref here as it's going to be created
10033 as part of the magic cloning of the symbol table. */
10034 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10035 if(isGV_with_GP(sstr)) {
10036 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10037 at the point of this comment. */
10038 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10039 (void)GpREFCNT_inc(GvGP(dstr));
10041 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10044 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10045 if (IoOFP(dstr) == IoIFP(sstr))
10046 IoOFP(dstr) = IoIFP(dstr);
10048 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10049 /* PL_rsfp_filters entries have fake IoDIRP() */
10050 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10051 /* I have no idea why fake dirp (rsfps)
10052 should be treated differently but otherwise
10053 we end up with leaks -- sky*/
10054 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10055 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10056 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10058 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10059 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10060 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10061 if (IoDIRP(dstr)) {
10062 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10065 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10068 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10069 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10070 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10073 if (AvARRAY((AV*)sstr)) {
10074 SV **dst_ary, **src_ary;
10075 SSize_t items = AvFILLp((AV*)sstr) + 1;
10077 src_ary = AvARRAY((AV*)sstr);
10078 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10079 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10080 SvPV_set(dstr, (char*)dst_ary);
10081 AvALLOC((AV*)dstr) = dst_ary;
10082 if (AvREAL((AV*)sstr)) {
10083 while (items-- > 0)
10084 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10087 while (items-- > 0)
10088 *dst_ary++ = sv_dup(*src_ary++, param);
10090 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10091 while (items-- > 0) {
10092 *dst_ary++ = &PL_sv_undef;
10096 SvPV_set(dstr, NULL);
10097 AvALLOC((AV*)dstr) = (SV**)NULL;
10101 if (HvARRAY((HV*)sstr)) {
10103 const bool sharekeys = !!HvSHAREKEYS(sstr);
10104 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10105 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10107 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10108 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10110 HvARRAY(dstr) = (HE**)darray;
10111 while (i <= sxhv->xhv_max) {
10112 const HE * const source = HvARRAY(sstr)[i];
10113 HvARRAY(dstr)[i] = source
10114 ? he_dup(source, sharekeys, param) : 0;
10119 const struct xpvhv_aux * const saux = HvAUX(sstr);
10120 struct xpvhv_aux * const daux = HvAUX(dstr);
10121 /* This flag isn't copied. */
10122 /* SvOOK_on(hv) attacks the IV flags. */
10123 SvFLAGS(dstr) |= SVf_OOK;
10125 hvname = saux->xhv_name;
10126 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10128 daux->xhv_riter = saux->xhv_riter;
10129 daux->xhv_eiter = saux->xhv_eiter
10130 ? he_dup(saux->xhv_eiter,
10131 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10132 daux->xhv_backreferences =
10133 saux->xhv_backreferences
10134 ? (AV*) SvREFCNT_inc(
10135 sv_dup((SV*)saux->xhv_backreferences, param))
10137 /* Record stashes for possible cloning in Perl_clone(). */
10139 av_push(param->stashes, dstr);
10143 SvPV_set(dstr, NULL);
10146 if (!(param->flags & CLONEf_COPY_STACKS)) {
10150 /* NOTE: not refcounted */
10151 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10153 if (!CvISXSUB(dstr))
10154 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10156 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10157 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10158 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10159 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10161 /* don't dup if copying back - CvGV isn't refcounted, so the
10162 * duped GV may never be freed. A bit of a hack! DAPM */
10163 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10164 NULL : gv_dup(CvGV(dstr), param) ;
10165 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10167 CvWEAKOUTSIDE(sstr)
10168 ? cv_dup( CvOUTSIDE(dstr), param)
10169 : cv_dup_inc(CvOUTSIDE(dstr), param);
10170 if (!CvISXSUB(dstr))
10171 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10177 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10183 /* duplicate a context */
10186 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10188 PERL_CONTEXT *ncxs;
10191 return (PERL_CONTEXT*)NULL;
10193 /* look for it in the table first */
10194 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10198 /* create anew and remember what it is */
10199 Newxz(ncxs, max + 1, PERL_CONTEXT);
10200 ptr_table_store(PL_ptr_table, cxs, ncxs);
10203 PERL_CONTEXT * const cx = &cxs[ix];
10204 PERL_CONTEXT * const ncx = &ncxs[ix];
10205 ncx->cx_type = cx->cx_type;
10206 if (CxTYPE(cx) == CXt_SUBST) {
10207 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10210 ncx->blk_oldsp = cx->blk_oldsp;
10211 ncx->blk_oldcop = cx->blk_oldcop;
10212 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10213 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10214 ncx->blk_oldpm = cx->blk_oldpm;
10215 ncx->blk_gimme = cx->blk_gimme;
10216 switch (CxTYPE(cx)) {
10218 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10219 ? cv_dup_inc(cx->blk_sub.cv, param)
10220 : cv_dup(cx->blk_sub.cv,param));
10221 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10222 ? av_dup_inc(cx->blk_sub.argarray, param)
10224 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10225 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10226 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10227 ncx->blk_sub.lval = cx->blk_sub.lval;
10228 ncx->blk_sub.retop = cx->blk_sub.retop;
10229 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10230 cx->blk_sub.oldcomppad);
10233 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10234 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10235 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10236 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10237 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10238 ncx->blk_eval.retop = cx->blk_eval.retop;
10241 ncx->blk_loop.label = cx->blk_loop.label;
10242 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10243 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10244 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10245 ? cx->blk_loop.iterdata
10246 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10247 ncx->blk_loop.oldcomppad
10248 = (PAD*)ptr_table_fetch(PL_ptr_table,
10249 cx->blk_loop.oldcomppad);
10250 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10251 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10252 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10253 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10254 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10257 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10258 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10259 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10260 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10261 ncx->blk_sub.retop = cx->blk_sub.retop;
10273 /* duplicate a stack info structure */
10276 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10281 return (PERL_SI*)NULL;
10283 /* look for it in the table first */
10284 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10288 /* create anew and remember what it is */
10289 Newxz(nsi, 1, PERL_SI);
10290 ptr_table_store(PL_ptr_table, si, nsi);
10292 nsi->si_stack = av_dup_inc(si->si_stack, param);
10293 nsi->si_cxix = si->si_cxix;
10294 nsi->si_cxmax = si->si_cxmax;
10295 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10296 nsi->si_type = si->si_type;
10297 nsi->si_prev = si_dup(si->si_prev, param);
10298 nsi->si_next = si_dup(si->si_next, param);
10299 nsi->si_markoff = si->si_markoff;
10304 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10305 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10306 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10307 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10308 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10309 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10310 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10311 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10312 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10313 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10314 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10315 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10316 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10317 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10320 #define pv_dup_inc(p) SAVEPV(p)
10321 #define pv_dup(p) SAVEPV(p)
10322 #define svp_dup_inc(p,pp) any_dup(p,pp)
10324 /* map any object to the new equivent - either something in the
10325 * ptr table, or something in the interpreter structure
10329 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10334 return (void*)NULL;
10336 /* look for it in the table first */
10337 ret = ptr_table_fetch(PL_ptr_table, v);
10341 /* see if it is part of the interpreter structure */
10342 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10343 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10351 /* duplicate the save stack */
10354 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10356 ANY * const ss = proto_perl->Tsavestack;
10357 const I32 max = proto_perl->Tsavestack_max;
10358 I32 ix = proto_perl->Tsavestack_ix;
10370 void (*dptr) (void*);
10371 void (*dxptr) (pTHX_ void*);
10373 Newxz(nss, max, ANY);
10376 I32 i = POPINT(ss,ix);
10377 TOPINT(nss,ix) = i;
10379 case SAVEt_ITEM: /* normal string */
10380 case SAVEt_SV: /* scalar reference */
10381 sv = (SV*)POPPTR(ss,ix);
10382 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10383 sv = (SV*)POPPTR(ss,ix);
10384 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10386 case SAVEt_SHARED_PVREF: /* char* in shared space */
10387 c = (char*)POPPTR(ss,ix);
10388 TOPPTR(nss,ix) = savesharedpv(c);
10389 ptr = POPPTR(ss,ix);
10390 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10392 case SAVEt_GENERIC_SVREF: /* generic sv */
10393 case SAVEt_SVREF: /* scalar reference */
10394 sv = (SV*)POPPTR(ss,ix);
10395 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10396 ptr = POPPTR(ss,ix);
10397 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10399 case SAVEt_HV: /* hash reference */
10400 case SAVEt_AV: /* array reference */
10401 sv = (SV*) POPPTR(ss,ix);
10402 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10403 gv = (GV*)POPPTR(ss,ix);
10404 TOPPTR(nss,ix) = gv_dup(gv, param);
10406 case SAVEt_INT: /* int reference */
10407 ptr = POPPTR(ss,ix);
10408 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10409 intval = (int)POPINT(ss,ix);
10410 TOPINT(nss,ix) = intval;
10412 case SAVEt_LONG: /* long reference */
10413 ptr = POPPTR(ss,ix);
10414 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10415 longval = (long)POPLONG(ss,ix);
10416 TOPLONG(nss,ix) = longval;
10418 case SAVEt_I32: /* I32 reference */
10419 case SAVEt_I16: /* I16 reference */
10420 case SAVEt_I8: /* I8 reference */
10421 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10422 ptr = POPPTR(ss,ix);
10423 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10425 TOPINT(nss,ix) = i;
10427 case SAVEt_IV: /* IV reference */
10428 ptr = POPPTR(ss,ix);
10429 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10431 TOPIV(nss,ix) = iv;
10433 case SAVEt_HPTR: /* HV* reference */
10434 case SAVEt_APTR: /* AV* reference */
10435 case SAVEt_SPTR: /* SV* reference */
10436 ptr = POPPTR(ss,ix);
10437 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10438 sv = (SV*)POPPTR(ss,ix);
10439 TOPPTR(nss,ix) = sv_dup(sv, param);
10441 case SAVEt_VPTR: /* random* reference */
10442 ptr = POPPTR(ss,ix);
10443 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10444 ptr = POPPTR(ss,ix);
10445 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10447 case SAVEt_GENERIC_PVREF: /* generic char* */
10448 case SAVEt_PPTR: /* char* reference */
10449 ptr = POPPTR(ss,ix);
10450 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10451 c = (char*)POPPTR(ss,ix);
10452 TOPPTR(nss,ix) = pv_dup(c);
10455 gv = (GV*)POPPTR(ss,ix);
10456 TOPPTR(nss,ix) = gv_dup(gv, param);
10458 case SAVEt_GP: /* scalar reference */
10459 gp = (GP*)POPPTR(ss,ix);
10460 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10461 (void)GpREFCNT_inc(gp);
10462 gv = (GV*)POPPTR(ss,ix);
10463 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10464 c = (char*)POPPTR(ss,ix);
10465 TOPPTR(nss,ix) = pv_dup(c);
10467 TOPIV(nss,ix) = iv;
10469 TOPIV(nss,ix) = iv;
10472 case SAVEt_MORTALIZESV:
10473 sv = (SV*)POPPTR(ss,ix);
10474 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10477 ptr = POPPTR(ss,ix);
10478 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10479 /* these are assumed to be refcounted properly */
10481 switch (((OP*)ptr)->op_type) {
10483 case OP_LEAVESUBLV:
10487 case OP_LEAVEWRITE:
10488 TOPPTR(nss,ix) = ptr;
10493 TOPPTR(nss,ix) = NULL;
10498 TOPPTR(nss,ix) = NULL;
10501 c = (char*)POPPTR(ss,ix);
10502 TOPPTR(nss,ix) = pv_dup_inc(c);
10504 case SAVEt_CLEARSV:
10505 longval = POPLONG(ss,ix);
10506 TOPLONG(nss,ix) = longval;
10509 hv = (HV*)POPPTR(ss,ix);
10510 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10511 c = (char*)POPPTR(ss,ix);
10512 TOPPTR(nss,ix) = pv_dup_inc(c);
10514 TOPINT(nss,ix) = i;
10516 case SAVEt_DESTRUCTOR:
10517 ptr = POPPTR(ss,ix);
10518 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10519 dptr = POPDPTR(ss,ix);
10520 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10521 any_dup(FPTR2DPTR(void *, dptr),
10524 case SAVEt_DESTRUCTOR_X:
10525 ptr = POPPTR(ss,ix);
10526 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10527 dxptr = POPDXPTR(ss,ix);
10528 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10529 any_dup(FPTR2DPTR(void *, dxptr),
10532 case SAVEt_REGCONTEXT:
10535 TOPINT(nss,ix) = i;
10538 case SAVEt_STACK_POS: /* Position on Perl stack */
10540 TOPINT(nss,ix) = i;
10542 case SAVEt_AELEM: /* array element */
10543 sv = (SV*)POPPTR(ss,ix);
10544 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10546 TOPINT(nss,ix) = i;
10547 av = (AV*)POPPTR(ss,ix);
10548 TOPPTR(nss,ix) = av_dup_inc(av, param);
10550 case SAVEt_HELEM: /* hash element */
10551 sv = (SV*)POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10553 sv = (SV*)POPPTR(ss,ix);
10554 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10555 hv = (HV*)POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10559 ptr = POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = ptr;
10564 TOPINT(nss,ix) = i;
10565 ptr = POPPTR(ss,ix);
10568 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10569 HINTS_REFCNT_UNLOCK;
10571 TOPPTR(nss,ix) = ptr;
10572 if (i & HINT_LOCALIZE_HH) {
10573 hv = (HV*)POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10577 case SAVEt_COMPPAD:
10578 av = (AV*)POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = av_dup(av, param);
10582 longval = (long)POPLONG(ss,ix);
10583 TOPLONG(nss,ix) = longval;
10584 ptr = POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10586 sv = (SV*)POPPTR(ss,ix);
10587 TOPPTR(nss,ix) = sv_dup(sv, param);
10590 ptr = POPPTR(ss,ix);
10591 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10592 longval = (long)POPBOOL(ss,ix);
10593 TOPBOOL(nss,ix) = (bool)longval;
10595 case SAVEt_SET_SVFLAGS:
10597 TOPINT(nss,ix) = i;
10599 TOPINT(nss,ix) = i;
10600 sv = (SV*)POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = sv_dup(sv, param);
10603 case SAVEt_RE_STATE:
10605 const struct re_save_state *const old_state
10606 = (struct re_save_state *)
10607 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10608 struct re_save_state *const new_state
10609 = (struct re_save_state *)
10610 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10612 Copy(old_state, new_state, 1, struct re_save_state);
10613 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10615 new_state->re_state_bostr
10616 = pv_dup(old_state->re_state_bostr);
10617 new_state->re_state_reginput
10618 = pv_dup(old_state->re_state_reginput);
10619 new_state->re_state_regeol
10620 = pv_dup(old_state->re_state_regeol);
10621 new_state->re_state_regstartp
10622 = (I32*) any_dup(old_state->re_state_regstartp, proto_perl);
10623 new_state->re_state_regendp
10624 = (I32*) any_dup(old_state->re_state_regendp, proto_perl);
10625 new_state->re_state_reglastparen
10626 = (U32*) any_dup(old_state->re_state_reglastparen,
10628 new_state->re_state_reglastcloseparen
10629 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10631 /* XXX This just has to be broken. The old save_re_context
10632 code did SAVEGENERICPV(PL_reg_start_tmp);
10633 PL_reg_start_tmp is char **.
10634 Look above to what the dup code does for
10635 SAVEt_GENERIC_PVREF
10636 It can never have worked.
10637 So this is merely a faithful copy of the exiting bug: */
10638 new_state->re_state_reg_start_tmp
10639 = (char **) pv_dup((char *)
10640 old_state->re_state_reg_start_tmp);
10641 /* I assume that it only ever "worked" because no-one called
10642 (pseudo)fork while the regexp engine had re-entered itself.
10644 #ifdef PERL_OLD_COPY_ON_WRITE
10645 new_state->re_state_nrs
10646 = sv_dup(old_state->re_state_nrs, param);
10648 new_state->re_state_reg_magic
10649 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10651 new_state->re_state_reg_oldcurpm
10652 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10654 new_state->re_state_reg_curpm
10655 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10657 new_state->re_state_reg_oldsaved
10658 = pv_dup(old_state->re_state_reg_oldsaved);
10659 new_state->re_state_reg_poscache
10660 = pv_dup(old_state->re_state_reg_poscache);
10661 new_state->re_state_reg_starttry
10662 = pv_dup(old_state->re_state_reg_starttry);
10665 case SAVEt_COMPILE_WARNINGS:
10666 ptr = POPPTR(ss,ix);
10667 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10670 Perl_croak(aTHX_ "panic: ss_dup inconsistency (%"IVdf")", (IV) i);
10678 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10679 * flag to the result. This is done for each stash before cloning starts,
10680 * so we know which stashes want their objects cloned */
10683 do_mark_cloneable_stash(pTHX_ SV *sv)
10685 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10687 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10688 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10689 if (cloner && GvCV(cloner)) {
10696 XPUSHs(sv_2mortal(newSVhek(hvname)));
10698 call_sv((SV*)GvCV(cloner), G_SCALAR);
10705 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10713 =for apidoc perl_clone
10715 Create and return a new interpreter by cloning the current one.
10717 perl_clone takes these flags as parameters:
10719 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10720 without it we only clone the data and zero the stacks,
10721 with it we copy the stacks and the new perl interpreter is
10722 ready to run at the exact same point as the previous one.
10723 The pseudo-fork code uses COPY_STACKS while the
10724 threads->new doesn't.
10726 CLONEf_KEEP_PTR_TABLE
10727 perl_clone keeps a ptr_table with the pointer of the old
10728 variable as a key and the new variable as a value,
10729 this allows it to check if something has been cloned and not
10730 clone it again but rather just use the value and increase the
10731 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10732 the ptr_table using the function
10733 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10734 reason to keep it around is if you want to dup some of your own
10735 variable who are outside the graph perl scans, example of this
10736 code is in threads.xs create
10739 This is a win32 thing, it is ignored on unix, it tells perls
10740 win32host code (which is c++) to clone itself, this is needed on
10741 win32 if you want to run two threads at the same time,
10742 if you just want to do some stuff in a separate perl interpreter
10743 and then throw it away and return to the original one,
10744 you don't need to do anything.
10749 /* XXX the above needs expanding by someone who actually understands it ! */
10750 EXTERN_C PerlInterpreter *
10751 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10754 perl_clone(PerlInterpreter *proto_perl, UV flags)
10757 #ifdef PERL_IMPLICIT_SYS
10759 /* perlhost.h so we need to call into it
10760 to clone the host, CPerlHost should have a c interface, sky */
10762 if (flags & CLONEf_CLONE_HOST) {
10763 return perl_clone_host(proto_perl,flags);
10765 return perl_clone_using(proto_perl, flags,
10767 proto_perl->IMemShared,
10768 proto_perl->IMemParse,
10770 proto_perl->IStdIO,
10774 proto_perl->IProc);
10778 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10779 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10780 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10781 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10782 struct IPerlDir* ipD, struct IPerlSock* ipS,
10783 struct IPerlProc* ipP)
10785 /* XXX many of the string copies here can be optimized if they're
10786 * constants; they need to be allocated as common memory and just
10787 * their pointers copied. */
10790 CLONE_PARAMS clone_params;
10791 CLONE_PARAMS* const param = &clone_params;
10793 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10794 /* for each stash, determine whether its objects should be cloned */
10795 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10796 PERL_SET_THX(my_perl);
10799 PoisonNew(my_perl, 1, PerlInterpreter);
10805 PL_savestack_ix = 0;
10806 PL_savestack_max = -1;
10807 PL_sig_pending = 0;
10808 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10809 # else /* !DEBUGGING */
10810 Zero(my_perl, 1, PerlInterpreter);
10811 # endif /* DEBUGGING */
10813 /* host pointers */
10815 PL_MemShared = ipMS;
10816 PL_MemParse = ipMP;
10823 #else /* !PERL_IMPLICIT_SYS */
10825 CLONE_PARAMS clone_params;
10826 CLONE_PARAMS* param = &clone_params;
10827 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10828 /* for each stash, determine whether its objects should be cloned */
10829 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10830 PERL_SET_THX(my_perl);
10833 PoisonNew(my_perl, 1, PerlInterpreter);
10839 PL_savestack_ix = 0;
10840 PL_savestack_max = -1;
10841 PL_sig_pending = 0;
10842 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10843 # else /* !DEBUGGING */
10844 Zero(my_perl, 1, PerlInterpreter);
10845 # endif /* DEBUGGING */
10846 #endif /* PERL_IMPLICIT_SYS */
10847 param->flags = flags;
10848 param->proto_perl = proto_perl;
10850 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10852 PL_body_arenas = NULL;
10853 Zero(&PL_body_roots, 1, PL_body_roots);
10855 PL_nice_chunk = NULL;
10856 PL_nice_chunk_size = 0;
10858 PL_sv_objcount = 0;
10860 PL_sv_arenaroot = NULL;
10862 PL_debug = proto_perl->Idebug;
10864 PL_hash_seed = proto_perl->Ihash_seed;
10865 PL_rehash_seed = proto_perl->Irehash_seed;
10867 #ifdef USE_REENTRANT_API
10868 /* XXX: things like -Dm will segfault here in perlio, but doing
10869 * PERL_SET_CONTEXT(proto_perl);
10870 * breaks too many other things
10872 Perl_reentrant_init(aTHX);
10875 /* create SV map for pointer relocation */
10876 PL_ptr_table = ptr_table_new();
10878 /* initialize these special pointers as early as possible */
10879 SvANY(&PL_sv_undef) = NULL;
10880 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10881 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10882 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10884 SvANY(&PL_sv_no) = new_XPVNV();
10885 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10886 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10887 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10888 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
10889 SvCUR_set(&PL_sv_no, 0);
10890 SvLEN_set(&PL_sv_no, 1);
10891 SvIV_set(&PL_sv_no, 0);
10892 SvNV_set(&PL_sv_no, 0);
10893 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10895 SvANY(&PL_sv_yes) = new_XPVNV();
10896 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10897 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
10898 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10899 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
10900 SvCUR_set(&PL_sv_yes, 1);
10901 SvLEN_set(&PL_sv_yes, 2);
10902 SvIV_set(&PL_sv_yes, 1);
10903 SvNV_set(&PL_sv_yes, 1);
10904 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10906 /* create (a non-shared!) shared string table */
10907 PL_strtab = newHV();
10908 HvSHAREKEYS_off(PL_strtab);
10909 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
10910 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10912 PL_compiling = proto_perl->Icompiling;
10914 /* These two PVs will be free'd special way so must set them same way op.c does */
10915 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10916 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10918 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10919 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10921 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10922 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
10923 if (PL_compiling.cop_hints_hash) {
10925 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
10926 HINTS_REFCNT_UNLOCK;
10928 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10930 /* pseudo environmental stuff */
10931 PL_origargc = proto_perl->Iorigargc;
10932 PL_origargv = proto_perl->Iorigargv;
10934 param->stashes = newAV(); /* Setup array of objects to call clone on */
10936 /* Set tainting stuff before PerlIO_debug can possibly get called */
10937 PL_tainting = proto_perl->Itainting;
10938 PL_taint_warn = proto_perl->Itaint_warn;
10940 #ifdef PERLIO_LAYERS
10941 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10942 PerlIO_clone(aTHX_ proto_perl, param);
10945 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10946 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10947 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
10948 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
10949 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10950 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
10953 PL_minus_c = proto_perl->Iminus_c;
10954 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
10955 PL_localpatches = proto_perl->Ilocalpatches;
10956 PL_splitstr = proto_perl->Isplitstr;
10957 PL_preprocess = proto_perl->Ipreprocess;
10958 PL_minus_n = proto_perl->Iminus_n;
10959 PL_minus_p = proto_perl->Iminus_p;
10960 PL_minus_l = proto_perl->Iminus_l;
10961 PL_minus_a = proto_perl->Iminus_a;
10962 PL_minus_E = proto_perl->Iminus_E;
10963 PL_minus_F = proto_perl->Iminus_F;
10964 PL_doswitches = proto_perl->Idoswitches;
10965 PL_dowarn = proto_perl->Idowarn;
10966 PL_doextract = proto_perl->Idoextract;
10967 PL_sawampersand = proto_perl->Isawampersand;
10968 PL_unsafe = proto_perl->Iunsafe;
10969 PL_inplace = SAVEPV(proto_perl->Iinplace);
10970 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
10971 PL_perldb = proto_perl->Iperldb;
10972 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
10973 PL_exit_flags = proto_perl->Iexit_flags;
10975 /* magical thingies */
10976 /* XXX time(&PL_basetime) when asked for? */
10977 PL_basetime = proto_perl->Ibasetime;
10978 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
10980 PL_maxsysfd = proto_perl->Imaxsysfd;
10981 PL_statusvalue = proto_perl->Istatusvalue;
10983 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10985 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
10987 PL_encoding = sv_dup(proto_perl->Iencoding, param);
10989 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
10990 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10991 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
10994 /* RE engine related */
10995 Zero(&PL_reg_state, 1, struct re_save_state);
10996 PL_reginterp_cnt = 0;
10997 PL_regmatch_slab = NULL;
10999 /* Clone the regex array */
11000 PL_regex_padav = newAV();
11002 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11003 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11005 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11006 for(i = 1; i <= len; i++) {
11007 const SV * const regex = regexen[i];
11010 ? sv_dup_inc(regex, param)
11012 newSViv(PTR2IV(re_dup(
11013 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11015 av_push(PL_regex_padav, sv);
11018 PL_regex_pad = AvARRAY(PL_regex_padav);
11020 /* shortcuts to various I/O objects */
11021 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11022 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11023 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11024 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11025 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11026 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11028 /* shortcuts to regexp stuff */
11029 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11031 /* shortcuts to misc objects */
11032 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11034 /* shortcuts to debugging objects */
11035 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11036 PL_DBline = gv_dup(proto_perl->IDBline, param);
11037 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11038 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11039 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11040 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11041 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11042 PL_lineary = av_dup(proto_perl->Ilineary, param);
11043 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11045 /* symbol tables */
11046 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11047 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11048 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11049 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11050 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11052 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11053 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11054 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11055 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11056 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11057 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11059 PL_sub_generation = proto_perl->Isub_generation;
11061 /* funky return mechanisms */
11062 PL_forkprocess = proto_perl->Iforkprocess;
11064 /* subprocess state */
11065 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11067 /* internal state */
11068 PL_maxo = proto_perl->Imaxo;
11069 if (proto_perl->Iop_mask)
11070 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11073 /* PL_asserting = proto_perl->Iasserting; */
11075 /* current interpreter roots */
11076 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11077 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11078 PL_main_start = proto_perl->Imain_start;
11079 PL_eval_root = proto_perl->Ieval_root;
11080 PL_eval_start = proto_perl->Ieval_start;
11082 /* runtime control stuff */
11083 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11084 PL_copline = proto_perl->Icopline;
11086 PL_filemode = proto_perl->Ifilemode;
11087 PL_lastfd = proto_perl->Ilastfd;
11088 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11091 PL_gensym = proto_perl->Igensym;
11092 PL_preambled = proto_perl->Ipreambled;
11093 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11094 PL_laststatval = proto_perl->Ilaststatval;
11095 PL_laststype = proto_perl->Ilaststype;
11098 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11100 /* interpreter atexit processing */
11101 PL_exitlistlen = proto_perl->Iexitlistlen;
11102 if (PL_exitlistlen) {
11103 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11104 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11107 PL_exitlist = (PerlExitListEntry*)NULL;
11109 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11110 if (PL_my_cxt_size) {
11111 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11112 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11115 PL_my_cxt_list = (void**)NULL;
11116 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11117 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11118 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11120 PL_profiledata = NULL;
11121 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11122 /* PL_rsfp_filters entries have fake IoDIRP() */
11123 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11125 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11127 PAD_CLONE_VARS(proto_perl, param);
11129 #ifdef HAVE_INTERP_INTERN
11130 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11133 /* more statics moved here */
11134 PL_generation = proto_perl->Igeneration;
11135 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11137 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11138 PL_in_clean_all = proto_perl->Iin_clean_all;
11140 PL_uid = proto_perl->Iuid;
11141 PL_euid = proto_perl->Ieuid;
11142 PL_gid = proto_perl->Igid;
11143 PL_egid = proto_perl->Iegid;
11144 PL_nomemok = proto_perl->Inomemok;
11145 PL_an = proto_perl->Ian;
11146 PL_evalseq = proto_perl->Ievalseq;
11147 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11148 PL_origalen = proto_perl->Iorigalen;
11149 #ifdef PERL_USES_PL_PIDSTATUS
11150 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11152 PL_osname = SAVEPV(proto_perl->Iosname);
11153 PL_sighandlerp = proto_perl->Isighandlerp;
11155 PL_runops = proto_perl->Irunops;
11157 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11160 PL_cshlen = proto_perl->Icshlen;
11161 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11164 PL_lex_state = proto_perl->Ilex_state;
11165 PL_lex_defer = proto_perl->Ilex_defer;
11166 PL_lex_expect = proto_perl->Ilex_expect;
11167 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11168 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11169 PL_lex_starts = proto_perl->Ilex_starts;
11170 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11171 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11172 PL_lex_op = proto_perl->Ilex_op;
11173 PL_lex_inpat = proto_perl->Ilex_inpat;
11174 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11175 PL_lex_brackets = proto_perl->Ilex_brackets;
11176 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11177 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11178 PL_lex_casemods = proto_perl->Ilex_casemods;
11179 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11180 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11183 Copy(proto_perl->Inexttoke, PL_nexttoke, 5, NEXTTOKE);
11184 PL_lasttoke = proto_perl->Ilasttoke;
11185 PL_realtokenstart = proto_perl->Irealtokenstart;
11186 PL_faketokens = proto_perl->Ifaketokens;
11187 PL_thismad = proto_perl->Ithismad;
11188 PL_thistoken = proto_perl->Ithistoken;
11189 PL_thisopen = proto_perl->Ithisopen;
11190 PL_thisstuff = proto_perl->Ithisstuff;
11191 PL_thisclose = proto_perl->Ithisclose;
11192 PL_thiswhite = proto_perl->Ithiswhite;
11193 PL_nextwhite = proto_perl->Inextwhite;
11194 PL_skipwhite = proto_perl->Iskipwhite;
11195 PL_endwhite = proto_perl->Iendwhite;
11196 PL_curforce = proto_perl->Icurforce;
11198 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11199 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11200 PL_nexttoke = proto_perl->Inexttoke;
11203 /* XXX This is probably masking the deeper issue of why
11204 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11205 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11206 * (A little debugging with a watchpoint on it may help.)
11208 if (SvANY(proto_perl->Ilinestr)) {
11209 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11210 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
11211 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11212 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
11213 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11214 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
11215 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11216 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
11217 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11220 PL_linestr = newSV(79);
11221 sv_upgrade(PL_linestr,SVt_PVIV);
11222 sv_setpvn(PL_linestr,"",0);
11223 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11225 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11226 PL_pending_ident = proto_perl->Ipending_ident;
11227 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11229 PL_expect = proto_perl->Iexpect;
11231 PL_multi_start = proto_perl->Imulti_start;
11232 PL_multi_end = proto_perl->Imulti_end;
11233 PL_multi_open = proto_perl->Imulti_open;
11234 PL_multi_close = proto_perl->Imulti_close;
11236 PL_error_count = proto_perl->Ierror_count;
11237 PL_subline = proto_perl->Isubline;
11238 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11240 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11241 if (SvANY(proto_perl->Ilinestr)) {
11242 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
11243 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11244 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
11245 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11246 PL_last_lop_op = proto_perl->Ilast_lop_op;
11249 PL_last_uni = SvPVX(PL_linestr);
11250 PL_last_lop = SvPVX(PL_linestr);
11251 PL_last_lop_op = 0;
11253 PL_in_my = proto_perl->Iin_my;
11254 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11256 PL_cryptseen = proto_perl->Icryptseen;
11259 PL_hints = proto_perl->Ihints;
11261 PL_amagic_generation = proto_perl->Iamagic_generation;
11263 #ifdef USE_LOCALE_COLLATE
11264 PL_collation_ix = proto_perl->Icollation_ix;
11265 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11266 PL_collation_standard = proto_perl->Icollation_standard;
11267 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11268 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11269 #endif /* USE_LOCALE_COLLATE */
11271 #ifdef USE_LOCALE_NUMERIC
11272 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11273 PL_numeric_standard = proto_perl->Inumeric_standard;
11274 PL_numeric_local = proto_perl->Inumeric_local;
11275 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11276 #endif /* !USE_LOCALE_NUMERIC */
11278 /* utf8 character classes */
11279 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11280 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11281 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11282 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11283 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11284 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11285 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11286 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11287 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11288 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11289 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11290 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11291 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11292 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11293 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11294 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11295 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11296 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11297 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11298 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11300 /* Did the locale setup indicate UTF-8? */
11301 PL_utf8locale = proto_perl->Iutf8locale;
11302 /* Unicode features (see perlrun/-C) */
11303 PL_unicode = proto_perl->Iunicode;
11305 /* Pre-5.8 signals control */
11306 PL_signals = proto_perl->Isignals;
11308 /* times() ticks per second */
11309 PL_clocktick = proto_perl->Iclocktick;
11311 /* Recursion stopper for PerlIO_find_layer */
11312 PL_in_load_module = proto_perl->Iin_load_module;
11314 /* sort() routine */
11315 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11317 /* Not really needed/useful since the reenrant_retint is "volatile",
11318 * but do it for consistency's sake. */
11319 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11321 /* Hooks to shared SVs and locks. */
11322 PL_sharehook = proto_perl->Isharehook;
11323 PL_lockhook = proto_perl->Ilockhook;
11324 PL_unlockhook = proto_perl->Iunlockhook;
11325 PL_threadhook = proto_perl->Ithreadhook;
11327 PL_runops_std = proto_perl->Irunops_std;
11328 PL_runops_dbg = proto_perl->Irunops_dbg;
11330 #ifdef THREADS_HAVE_PIDS
11331 PL_ppid = proto_perl->Ippid;
11335 PL_last_swash_hv = NULL; /* reinits on demand */
11336 PL_last_swash_klen = 0;
11337 PL_last_swash_key[0]= '\0';
11338 PL_last_swash_tmps = (U8*)NULL;
11339 PL_last_swash_slen = 0;
11341 PL_glob_index = proto_perl->Iglob_index;
11342 PL_srand_called = proto_perl->Isrand_called;
11343 PL_uudmap[(U32) 'M'] = 0; /* reinits on demand */
11344 PL_bitcount = NULL; /* reinits on demand */
11346 if (proto_perl->Ipsig_pend) {
11347 Newxz(PL_psig_pend, SIG_SIZE, int);
11350 PL_psig_pend = (int*)NULL;
11353 if (proto_perl->Ipsig_ptr) {
11354 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11355 Newxz(PL_psig_name, SIG_SIZE, SV*);
11356 for (i = 1; i < SIG_SIZE; i++) {
11357 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11358 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11362 PL_psig_ptr = (SV**)NULL;
11363 PL_psig_name = (SV**)NULL;
11366 /* thrdvar.h stuff */
11368 if (flags & CLONEf_COPY_STACKS) {
11369 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11370 PL_tmps_ix = proto_perl->Ttmps_ix;
11371 PL_tmps_max = proto_perl->Ttmps_max;
11372 PL_tmps_floor = proto_perl->Ttmps_floor;
11373 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11375 while (i <= PL_tmps_ix) {
11376 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
11380 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11381 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
11382 Newxz(PL_markstack, i, I32);
11383 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
11384 - proto_perl->Tmarkstack);
11385 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
11386 - proto_perl->Tmarkstack);
11387 Copy(proto_perl->Tmarkstack, PL_markstack,
11388 PL_markstack_ptr - PL_markstack + 1, I32);
11390 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11391 * NOTE: unlike the others! */
11392 PL_scopestack_ix = proto_perl->Tscopestack_ix;
11393 PL_scopestack_max = proto_perl->Tscopestack_max;
11394 Newxz(PL_scopestack, PL_scopestack_max, I32);
11395 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
11397 /* NOTE: si_dup() looks at PL_markstack */
11398 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
11400 /* PL_curstack = PL_curstackinfo->si_stack; */
11401 PL_curstack = av_dup(proto_perl->Tcurstack, param);
11402 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
11404 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11405 PL_stack_base = AvARRAY(PL_curstack);
11406 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
11407 - proto_perl->Tstack_base);
11408 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11410 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11411 * NOTE: unlike the others! */
11412 PL_savestack_ix = proto_perl->Tsavestack_ix;
11413 PL_savestack_max = proto_perl->Tsavestack_max;
11414 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11415 PL_savestack = ss_dup(proto_perl, param);
11419 ENTER; /* perl_destruct() wants to LEAVE; */
11421 /* although we're not duplicating the tmps stack, we should still
11422 * add entries for any SVs on the tmps stack that got cloned by a
11423 * non-refcount means (eg a temp in @_); otherwise they will be
11426 for (i = 0; i<= proto_perl->Ttmps_ix; i++) {
11427 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11428 proto_perl->Ttmps_stack[i]);
11429 if (nsv && !SvREFCNT(nsv)) {
11431 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11436 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11437 PL_top_env = &PL_start_env;
11439 PL_op = proto_perl->Top;
11442 PL_Xpv = (XPV*)NULL;
11443 PL_na = proto_perl->Tna;
11445 PL_statbuf = proto_perl->Tstatbuf;
11446 PL_statcache = proto_perl->Tstatcache;
11447 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11448 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
11450 PL_timesbuf = proto_perl->Ttimesbuf;
11453 PL_tainted = proto_perl->Ttainted;
11454 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
11455 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11456 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11457 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11458 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
11459 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
11460 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11461 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11462 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
11464 PL_restartop = proto_perl->Trestartop;
11465 PL_in_eval = proto_perl->Tin_eval;
11466 PL_delaymagic = proto_perl->Tdelaymagic;
11467 PL_dirty = proto_perl->Tdirty;
11468 PL_localizing = proto_perl->Tlocalizing;
11470 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
11471 PL_hv_fetch_ent_mh = NULL;
11472 PL_modcount = proto_perl->Tmodcount;
11473 PL_lastgotoprobe = NULL;
11474 PL_dumpindent = proto_perl->Tdumpindent;
11476 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
11477 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11478 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11479 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
11480 PL_efloatbuf = NULL; /* reinits on demand */
11481 PL_efloatsize = 0; /* reinits on demand */
11485 PL_screamfirst = NULL;
11486 PL_screamnext = NULL;
11487 PL_maxscream = -1; /* reinits on demand */
11488 PL_lastscream = NULL;
11490 PL_watchaddr = NULL;
11493 PL_regdummy = proto_perl->Tregdummy;
11494 PL_colorset = 0; /* reinits PL_colors[] */
11495 /*PL_colors[6] = {0,0,0,0,0,0};*/
11499 /* Pluggable optimizer */
11500 PL_peepp = proto_perl->Tpeepp;
11502 PL_stashcache = newHV();
11504 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11505 ptr_table_free(PL_ptr_table);
11506 PL_ptr_table = NULL;
11509 /* Call the ->CLONE method, if it exists, for each of the stashes
11510 identified by sv_dup() above.
11512 while(av_len(param->stashes) != -1) {
11513 HV* const stash = (HV*) av_shift(param->stashes);
11514 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11515 if (cloner && GvCV(cloner)) {
11520 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11522 call_sv((SV*)GvCV(cloner), G_DISCARD);
11528 SvREFCNT_dec(param->stashes);
11530 /* orphaned? eg threads->new inside BEGIN or use */
11531 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11532 SvREFCNT_inc_simple_void(PL_compcv);
11533 SAVEFREESV(PL_compcv);
11539 #endif /* USE_ITHREADS */
11542 =head1 Unicode Support
11544 =for apidoc sv_recode_to_utf8
11546 The encoding is assumed to be an Encode object, on entry the PV
11547 of the sv is assumed to be octets in that encoding, and the sv
11548 will be converted into Unicode (and UTF-8).
11550 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11551 is not a reference, nothing is done to the sv. If the encoding is not
11552 an C<Encode::XS> Encoding object, bad things will happen.
11553 (See F<lib/encoding.pm> and L<Encode>).
11555 The PV of the sv is returned.
11560 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11563 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11577 Passing sv_yes is wrong - it needs to be or'ed set of constants
11578 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11579 remove converted chars from source.
11581 Both will default the value - let them.
11583 XPUSHs(&PL_sv_yes);
11586 call_method("decode", G_SCALAR);
11590 s = SvPV_const(uni, len);
11591 if (s != SvPVX_const(sv)) {
11592 SvGROW(sv, len + 1);
11593 Move(s, SvPVX(sv), len + 1, char);
11594 SvCUR_set(sv, len);
11601 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11605 =for apidoc sv_cat_decode
11607 The encoding is assumed to be an Encode object, the PV of the ssv is
11608 assumed to be octets in that encoding and decoding the input starts
11609 from the position which (PV + *offset) pointed to. The dsv will be
11610 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11611 when the string tstr appears in decoding output or the input ends on
11612 the PV of the ssv. The value which the offset points will be modified
11613 to the last input position on the ssv.
11615 Returns TRUE if the terminator was found, else returns FALSE.
11620 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11621 SV *ssv, int *offset, char *tstr, int tlen)
11625 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11636 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11637 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11639 call_method("cat_decode", G_SCALAR);
11641 ret = SvTRUE(TOPs);
11642 *offset = SvIV(offsv);
11648 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11653 /* ---------------------------------------------------------------------
11655 * support functions for report_uninit()
11658 /* the maxiumum size of array or hash where we will scan looking
11659 * for the undefined element that triggered the warning */
11661 #define FUV_MAX_SEARCH_SIZE 1000
11663 /* Look for an entry in the hash whose value has the same SV as val;
11664 * If so, return a mortal copy of the key. */
11667 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11670 register HE **array;
11673 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11674 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11677 array = HvARRAY(hv);
11679 for (i=HvMAX(hv); i>0; i--) {
11680 register HE *entry;
11681 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11682 if (HeVAL(entry) != val)
11684 if ( HeVAL(entry) == &PL_sv_undef ||
11685 HeVAL(entry) == &PL_sv_placeholder)
11689 if (HeKLEN(entry) == HEf_SVKEY)
11690 return sv_mortalcopy(HeKEY_sv(entry));
11691 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11697 /* Look for an entry in the array whose value has the same SV as val;
11698 * If so, return the index, otherwise return -1. */
11701 S_find_array_subscript(pTHX_ AV *av, SV* val)
11704 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11705 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11708 if (val != &PL_sv_undef) {
11709 SV ** const svp = AvARRAY(av);
11712 for (i=AvFILLp(av); i>=0; i--)
11719 /* S_varname(): return the name of a variable, optionally with a subscript.
11720 * If gv is non-zero, use the name of that global, along with gvtype (one
11721 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11722 * targ. Depending on the value of the subscript_type flag, return:
11725 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11726 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11727 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11728 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11731 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11732 SV* keyname, I32 aindex, int subscript_type)
11735 SV * const name = sv_newmortal();
11738 buffer[0] = gvtype;
11741 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11743 gv_fullname4(name, gv, buffer, 0);
11745 if ((unsigned int)SvPVX(name)[1] <= 26) {
11747 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11749 /* Swap the 1 unprintable control character for the 2 byte pretty
11750 version - ie substr($name, 1, 1) = $buffer; */
11751 sv_insert(name, 1, 1, buffer, 2);
11756 CV * const cv = find_runcv(&unused);
11760 if (!cv || !CvPADLIST(cv))
11762 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11763 sv = *av_fetch(av, targ, FALSE);
11764 /* SvLEN in a pad name is not to be trusted */
11765 sv_setpv(name, SvPV_nolen_const(sv));
11768 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11769 SV * const sv = newSV(0);
11770 *SvPVX(name) = '$';
11771 Perl_sv_catpvf(aTHX_ name, "{%s}",
11772 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11775 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11776 *SvPVX(name) = '$';
11777 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11779 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11780 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11787 =for apidoc find_uninit_var
11789 Find the name of the undefined variable (if any) that caused the operator o
11790 to issue a "Use of uninitialized value" warning.
11791 If match is true, only return a name if it's value matches uninit_sv.
11792 So roughly speaking, if a unary operator (such as OP_COS) generates a
11793 warning, then following the direct child of the op may yield an
11794 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11795 other hand, with OP_ADD there are two branches to follow, so we only print
11796 the variable name if we get an exact match.
11798 The name is returned as a mortal SV.
11800 Assumes that PL_op is the op that originally triggered the error, and that
11801 PL_comppad/PL_curpad points to the currently executing pad.
11807 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11815 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11816 uninit_sv == &PL_sv_placeholder)))
11819 switch (obase->op_type) {
11826 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11827 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11830 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11832 if (pad) { /* @lex, %lex */
11833 sv = PAD_SVl(obase->op_targ);
11837 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11838 /* @global, %global */
11839 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11842 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11844 else /* @{expr}, %{expr} */
11845 return find_uninit_var(cUNOPx(obase)->op_first,
11849 /* attempt to find a match within the aggregate */
11851 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11853 subscript_type = FUV_SUBSCRIPT_HASH;
11856 index = find_array_subscript((AV*)sv, uninit_sv);
11858 subscript_type = FUV_SUBSCRIPT_ARRAY;
11861 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11864 return varname(gv, hash ? '%' : '@', obase->op_targ,
11865 keysv, index, subscript_type);
11869 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11871 return varname(NULL, '$', obase->op_targ,
11872 NULL, 0, FUV_SUBSCRIPT_NONE);
11875 gv = cGVOPx_gv(obase);
11876 if (!gv || (match && GvSV(gv) != uninit_sv))
11878 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11881 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11884 av = (AV*)PAD_SV(obase->op_targ);
11885 if (!av || SvRMAGICAL(av))
11887 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11888 if (!svp || *svp != uninit_sv)
11891 return varname(NULL, '$', obase->op_targ,
11892 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11895 gv = cGVOPx_gv(obase);
11901 if (!av || SvRMAGICAL(av))
11903 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11904 if (!svp || *svp != uninit_sv)
11907 return varname(gv, '$', 0,
11908 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11913 o = cUNOPx(obase)->op_first;
11914 if (!o || o->op_type != OP_NULL ||
11915 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11917 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11921 if (PL_op == obase)
11922 /* $a[uninit_expr] or $h{uninit_expr} */
11923 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11926 o = cBINOPx(obase)->op_first;
11927 kid = cBINOPx(obase)->op_last;
11929 /* get the av or hv, and optionally the gv */
11931 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11932 sv = PAD_SV(o->op_targ);
11934 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11935 && cUNOPo->op_first->op_type == OP_GV)
11937 gv = cGVOPx_gv(cUNOPo->op_first);
11940 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11945 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11946 /* index is constant */
11950 if (obase->op_type == OP_HELEM) {
11951 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
11952 if (!he || HeVAL(he) != uninit_sv)
11956 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
11957 if (!svp || *svp != uninit_sv)
11961 if (obase->op_type == OP_HELEM)
11962 return varname(gv, '%', o->op_targ,
11963 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
11965 return varname(gv, '@', o->op_targ, NULL,
11966 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
11969 /* index is an expression;
11970 * attempt to find a match within the aggregate */
11971 if (obase->op_type == OP_HELEM) {
11972 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
11974 return varname(gv, '%', o->op_targ,
11975 keysv, 0, FUV_SUBSCRIPT_HASH);
11978 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
11980 return varname(gv, '@', o->op_targ,
11981 NULL, index, FUV_SUBSCRIPT_ARRAY);
11986 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
11988 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
11993 /* only examine RHS */
11994 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
11997 o = cUNOPx(obase)->op_first;
11998 if (o->op_type == OP_PUSHMARK)
12001 if (!o->op_sibling) {
12002 /* one-arg version of open is highly magical */
12004 if (o->op_type == OP_GV) { /* open FOO; */
12006 if (match && GvSV(gv) != uninit_sv)
12008 return varname(gv, '$', 0,
12009 NULL, 0, FUV_SUBSCRIPT_NONE);
12011 /* other possibilities not handled are:
12012 * open $x; or open my $x; should return '${*$x}'
12013 * open expr; should return '$'.expr ideally
12019 /* ops where $_ may be an implicit arg */
12023 if ( !(obase->op_flags & OPf_STACKED)) {
12024 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12025 ? PAD_SVl(obase->op_targ)
12028 sv = sv_newmortal();
12029 sv_setpvn(sv, "$_", 2);
12037 /* skip filehandle as it can't produce 'undef' warning */
12038 o = cUNOPx(obase)->op_first;
12039 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12040 o = o->op_sibling->op_sibling;
12047 match = 1; /* XS or custom code could trigger random warnings */
12052 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12053 return sv_2mortal(newSVpvs("${$/}"));
12058 if (!(obase->op_flags & OPf_KIDS))
12060 o = cUNOPx(obase)->op_first;
12066 /* if all except one arg are constant, or have no side-effects,
12067 * or are optimized away, then it's unambiguous */
12069 for (kid=o; kid; kid = kid->op_sibling) {
12071 const OPCODE type = kid->op_type;
12072 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12073 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12074 || (type == OP_PUSHMARK)
12078 if (o2) { /* more than one found */
12085 return find_uninit_var(o2, uninit_sv, match);
12087 /* scan all args */
12089 sv = find_uninit_var(o, uninit_sv, 1);
12101 =for apidoc report_uninit
12103 Print appropriate "Use of uninitialized variable" warning
12109 Perl_report_uninit(pTHX_ SV* uninit_sv)
12113 SV* varname = NULL;
12115 varname = find_uninit_var(PL_op, uninit_sv,0);
12117 sv_insert(varname, 0, 0, " ", 1);
12119 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12120 varname ? SvPV_nolen_const(varname) : "",
12121 " in ", OP_DESC(PL_op));
12124 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12130 * c-indentation-style: bsd
12131 * c-basic-offset: 4
12132 * indent-tabs-mode: t
12135 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob