3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* RVs are in the head now. */
898 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(xpv_allocated),
902 copy_length(XPV, xpv_len)
903 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
905 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
908 { sizeof(xpviv_allocated),
909 copy_length(XPVIV, xiv_u)
910 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
912 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
915 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
916 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
919 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
920 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
923 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
924 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
927 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
930 { sizeof(xpvav_allocated),
931 copy_length(XPVAV, xmg_stash)
932 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
934 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
936 { sizeof(xpvhv_allocated),
937 copy_length(XPVHV, xmg_stash)
938 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
940 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
943 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
944 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
945 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
947 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
948 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
949 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
951 /* XPVIO is 84 bytes, fits 48x */
952 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
953 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
956 #define new_body_type(sv_type) \
957 (void *)((char *)S_new_body(aTHX_ sv_type))
959 #define del_body_type(p, sv_type) \
960 del_body(p, &PL_body_roots[sv_type])
963 #define new_body_allocated(sv_type) \
964 (void *)((char *)S_new_body(aTHX_ sv_type) \
965 - bodies_by_type[sv_type].offset)
967 #define del_body_allocated(p, sv_type) \
968 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
971 #define my_safemalloc(s) (void*)safemalloc(s)
972 #define my_safecalloc(s) (void*)safecalloc(s, 1)
973 #define my_safefree(p) safefree((char*)p)
977 #define new_XNV() my_safemalloc(sizeof(XPVNV))
978 #define del_XNV(p) my_safefree(p)
980 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
981 #define del_XPVNV(p) my_safefree(p)
983 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
984 #define del_XPVAV(p) my_safefree(p)
986 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
987 #define del_XPVHV(p) my_safefree(p)
989 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
990 #define del_XPVMG(p) my_safefree(p)
992 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
993 #define del_XPVGV(p) my_safefree(p)
997 #define new_XNV() new_body_type(SVt_NV)
998 #define del_XNV(p) del_body_type(p, SVt_NV)
1000 #define new_XPVNV() new_body_type(SVt_PVNV)
1001 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1003 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1004 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1006 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1007 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1009 #define new_XPVMG() new_body_type(SVt_PVMG)
1010 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1012 #define new_XPVGV() new_body_type(SVt_PVGV)
1013 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1017 /* no arena for you! */
1019 #define new_NOARENA(details) \
1020 my_safemalloc((details)->body_size + (details)->offset)
1021 #define new_NOARENAZ(details) \
1022 my_safecalloc((details)->body_size + (details)->offset)
1025 S_more_bodies (pTHX_ svtype sv_type)
1028 void ** const root = &PL_body_roots[sv_type];
1029 const struct body_details * const bdp = &bodies_by_type[sv_type];
1030 const size_t body_size = bdp->body_size;
1033 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1034 static bool done_sanity_check;
1036 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1037 * variables like done_sanity_check. */
1038 if (!done_sanity_check) {
1039 unsigned int i = SVt_LAST;
1041 done_sanity_check = TRUE;
1044 assert (bodies_by_type[i].type == i);
1048 assert(bdp->arena_size);
1050 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1052 end = start + bdp->arena_size - body_size;
1054 /* computed count doesnt reflect the 1st slot reservation */
1055 DEBUG_m(PerlIO_printf(Perl_debug_log,
1056 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1057 (void*)start, (void*)end,
1058 (int)bdp->arena_size, sv_type, (int)body_size,
1059 (int)bdp->arena_size / (int)body_size));
1061 *root = (void *)start;
1063 while (start < end) {
1064 char * const next = start + body_size;
1065 *(void**) start = (void *)next;
1068 *(void **)start = 0;
1073 /* grab a new thing from the free list, allocating more if necessary.
1074 The inline version is used for speed in hot routines, and the
1075 function using it serves the rest (unless PURIFY).
1077 #define new_body_inline(xpv, sv_type) \
1079 void ** const r3wt = &PL_body_roots[sv_type]; \
1080 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1081 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1082 *(r3wt) = *(void**)(xpv); \
1088 S_new_body(pTHX_ svtype sv_type)
1092 new_body_inline(xpv, sv_type);
1099 =for apidoc sv_upgrade
1101 Upgrade an SV to a more complex form. Generally adds a new body type to the
1102 SV, then copies across as much information as possible from the old body.
1103 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1109 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1114 const svtype old_type = SvTYPE(sv);
1115 const struct body_details *new_type_details;
1116 const struct body_details *const old_type_details
1117 = bodies_by_type + old_type;
1119 if (new_type != SVt_PV && SvIsCOW(sv)) {
1120 sv_force_normal_flags(sv, 0);
1123 if (old_type == new_type)
1126 if (old_type > new_type)
1127 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1128 (int)old_type, (int)new_type);
1131 old_body = SvANY(sv);
1133 /* Copying structures onto other structures that have been neatly zeroed
1134 has a subtle gotcha. Consider XPVMG
1136 +------+------+------+------+------+-------+-------+
1137 | NV | CUR | LEN | IV | MAGIC | STASH |
1138 +------+------+------+------+------+-------+-------+
1139 0 4 8 12 16 20 24 28
1141 where NVs are aligned to 8 bytes, so that sizeof that structure is
1142 actually 32 bytes long, with 4 bytes of padding at the end:
1144 +------+------+------+------+------+-------+-------+------+
1145 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1146 +------+------+------+------+------+-------+-------+------+
1147 0 4 8 12 16 20 24 28 32
1149 so what happens if you allocate memory for this structure:
1151 +------+------+------+------+------+-------+-------+------+------+...
1152 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1153 +------+------+------+------+------+-------+-------+------+------+...
1154 0 4 8 12 16 20 24 28 32 36
1156 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1157 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1158 started out as zero once, but it's quite possible that it isn't. So now,
1159 rather than a nicely zeroed GP, you have it pointing somewhere random.
1162 (In fact, GP ends up pointing at a previous GP structure, because the
1163 principle cause of the padding in XPVMG getting garbage is a copy of
1164 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1165 this happens to be moot because XPVGV has been re-ordered, with GP
1166 no longer after STASH)
1168 So we are careful and work out the size of used parts of all the
1175 if (new_type < SVt_PVIV) {
1176 new_type = (new_type == SVt_NV)
1177 ? SVt_PVNV : SVt_PVIV;
1181 if (new_type < SVt_PVNV) {
1182 new_type = SVt_PVNV;
1188 assert(new_type > SVt_PV);
1189 assert(SVt_IV < SVt_PV);
1190 assert(SVt_NV < SVt_PV);
1197 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1198 there's no way that it can be safely upgraded, because perl.c
1199 expects to Safefree(SvANY(PL_mess_sv)) */
1200 assert(sv != PL_mess_sv);
1201 /* This flag bit is used to mean other things in other scalar types.
1202 Given that it only has meaning inside the pad, it shouldn't be set
1203 on anything that can get upgraded. */
1204 assert(!SvPAD_TYPED(sv));
1207 if (old_type_details->cant_upgrade)
1208 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1209 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1211 new_type_details = bodies_by_type + new_type;
1213 SvFLAGS(sv) &= ~SVTYPEMASK;
1214 SvFLAGS(sv) |= new_type;
1216 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1217 the return statements above will have triggered. */
1218 assert (new_type != SVt_NULL);
1221 assert(old_type == SVt_NULL);
1222 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1226 assert(old_type == SVt_NULL);
1227 SvANY(sv) = new_XNV();
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = &sv->sv_u.svu_rv;
1237 assert(new_type_details->body_size);
1240 assert(new_type_details->arena);
1241 assert(new_type_details->arena_size);
1242 /* This points to the start of the allocated area. */
1243 new_body_inline(new_body, new_type);
1244 Zero(new_body, new_type_details->body_size, char);
1245 new_body = ((char *)new_body) - new_type_details->offset;
1247 /* We always allocated the full length item with PURIFY. To do this
1248 we fake things so that arena is false for all 16 types.. */
1249 new_body = new_NOARENAZ(new_type_details);
1251 SvANY(sv) = new_body;
1252 if (new_type == SVt_PVAV) {
1258 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1259 The target created by newSVrv also is, and it can have magic.
1260 However, it never has SvPVX set.
1262 if (old_type >= SVt_RV) {
1263 assert(SvPVX_const(sv) == 0);
1266 if (old_type >= SVt_PVMG) {
1267 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1268 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1270 sv->sv_u.svu_array = NULL; /* or svu_hash */
1276 /* XXX Is this still needed? Was it ever needed? Surely as there is
1277 no route from NV to PVIV, NOK can never be true */
1278 assert(!SvNOKp(sv));
1289 assert(new_type_details->body_size);
1290 /* We always allocated the full length item with PURIFY. To do this
1291 we fake things so that arena is false for all 16 types.. */
1292 if(new_type_details->arena) {
1293 /* This points to the start of the allocated area. */
1294 new_body_inline(new_body, new_type);
1295 Zero(new_body, new_type_details->body_size, char);
1296 new_body = ((char *)new_body) - new_type_details->offset;
1298 new_body = new_NOARENAZ(new_type_details);
1300 SvANY(sv) = new_body;
1302 if (old_type_details->copy) {
1303 /* There is now the potential for an upgrade from something without
1304 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1305 int offset = old_type_details->offset;
1306 int length = old_type_details->copy;
1308 if (new_type_details->offset > old_type_details->offset) {
1309 const int difference
1310 = new_type_details->offset - old_type_details->offset;
1311 offset += difference;
1312 length -= difference;
1314 assert (length >= 0);
1316 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1320 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1321 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1322 * correct 0.0 for us. Otherwise, if the old body didn't have an
1323 * NV slot, but the new one does, then we need to initialise the
1324 * freshly created NV slot with whatever the correct bit pattern is
1326 if (old_type_details->zero_nv && !new_type_details->zero_nv
1327 && !isGV_with_GP(sv))
1331 if (new_type == SVt_PVIO)
1332 IoPAGE_LEN(sv) = 60;
1333 if (old_type < SVt_RV)
1337 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1338 (unsigned long)new_type);
1341 if (old_type_details->arena) {
1342 /* If there was an old body, then we need to free it.
1343 Note that there is an assumption that all bodies of types that
1344 can be upgraded came from arenas. Only the more complex non-
1345 upgradable types are allowed to be directly malloc()ed. */
1347 my_safefree(old_body);
1349 del_body((void*)((char*)old_body + old_type_details->offset),
1350 &PL_body_roots[old_type]);
1356 =for apidoc sv_backoff
1358 Remove any string offset. You should normally use the C<SvOOK_off> macro
1365 Perl_sv_backoff(pTHX_ register SV *sv)
1367 PERL_UNUSED_CONTEXT;
1369 assert(SvTYPE(sv) != SVt_PVHV);
1370 assert(SvTYPE(sv) != SVt_PVAV);
1372 const char * const s = SvPVX_const(sv);
1373 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1374 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1376 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1378 SvFLAGS(sv) &= ~SVf_OOK;
1385 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1386 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1387 Use the C<SvGROW> wrapper instead.
1393 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1397 if (PL_madskills && newlen >= 0x100000) {
1398 PerlIO_printf(Perl_debug_log,
1399 "Allocation too large: %"UVxf"\n", (UV)newlen);
1401 #ifdef HAS_64K_LIMIT
1402 if (newlen >= 0x10000) {
1403 PerlIO_printf(Perl_debug_log,
1404 "Allocation too large: %"UVxf"\n", (UV)newlen);
1407 #endif /* HAS_64K_LIMIT */
1410 if (SvTYPE(sv) < SVt_PV) {
1411 sv_upgrade(sv, SVt_PV);
1412 s = SvPVX_mutable(sv);
1414 else if (SvOOK(sv)) { /* pv is offset? */
1416 s = SvPVX_mutable(sv);
1417 if (newlen > SvLEN(sv))
1418 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1419 #ifdef HAS_64K_LIMIT
1420 if (newlen >= 0x10000)
1425 s = SvPVX_mutable(sv);
1427 if (newlen > SvLEN(sv)) { /* need more room? */
1428 newlen = PERL_STRLEN_ROUNDUP(newlen);
1429 if (SvLEN(sv) && s) {
1431 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1437 s = (char*)saferealloc(s, newlen);
1440 s = (char*)safemalloc(newlen);
1441 if (SvPVX_const(sv) && SvCUR(sv)) {
1442 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1446 SvLEN_set(sv, newlen);
1452 =for apidoc sv_setiv
1454 Copies an integer into the given SV, upgrading first if necessary.
1455 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1461 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1464 SV_CHECK_THINKFIRST_COW_DROP(sv);
1465 switch (SvTYPE(sv)) {
1467 sv_upgrade(sv, SVt_IV);
1470 sv_upgrade(sv, SVt_PVNV);
1474 sv_upgrade(sv, SVt_PVIV);
1483 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1487 (void)SvIOK_only(sv); /* validate number */
1493 =for apidoc sv_setiv_mg
1495 Like C<sv_setiv>, but also handles 'set' magic.
1501 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1508 =for apidoc sv_setuv
1510 Copies an unsigned integer into the given SV, upgrading first if necessary.
1511 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1517 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1519 /* With these two if statements:
1520 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1523 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1525 If you wish to remove them, please benchmark to see what the effect is
1527 if (u <= (UV)IV_MAX) {
1528 sv_setiv(sv, (IV)u);
1537 =for apidoc sv_setuv_mg
1539 Like C<sv_setuv>, but also handles 'set' magic.
1545 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1552 =for apidoc sv_setnv
1554 Copies a double into the given SV, upgrading first if necessary.
1555 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1561 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1564 SV_CHECK_THINKFIRST_COW_DROP(sv);
1565 switch (SvTYPE(sv)) {
1568 sv_upgrade(sv, SVt_NV);
1573 sv_upgrade(sv, SVt_PVNV);
1582 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1587 (void)SvNOK_only(sv); /* validate number */
1592 =for apidoc sv_setnv_mg
1594 Like C<sv_setnv>, but also handles 'set' magic.
1600 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1606 /* Print an "isn't numeric" warning, using a cleaned-up,
1607 * printable version of the offending string
1611 S_not_a_number(pTHX_ SV *sv)
1619 dsv = sv_2mortal(newSVpvs(""));
1620 pv = sv_uni_display(dsv, sv, 10, 0);
1623 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1624 /* each *s can expand to 4 chars + "...\0",
1625 i.e. need room for 8 chars */
1627 const char *s = SvPVX_const(sv);
1628 const char * const end = s + SvCUR(sv);
1629 for ( ; s < end && d < limit; s++ ) {
1631 if (ch & 128 && !isPRINT_LC(ch)) {
1640 else if (ch == '\r') {
1644 else if (ch == '\f') {
1648 else if (ch == '\\') {
1652 else if (ch == '\0') {
1656 else if (isPRINT_LC(ch))
1673 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1674 "Argument \"%s\" isn't numeric in %s", pv,
1677 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1678 "Argument \"%s\" isn't numeric", pv);
1682 =for apidoc looks_like_number
1684 Test if the content of an SV looks like a number (or is a number).
1685 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1686 non-numeric warning), even if your atof() doesn't grok them.
1692 Perl_looks_like_number(pTHX_ SV *sv)
1694 register const char *sbegin;
1698 sbegin = SvPVX_const(sv);
1701 else if (SvPOKp(sv))
1702 sbegin = SvPV_const(sv, len);
1704 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1705 return grok_number(sbegin, len, NULL);
1709 S_glob_2number(pTHX_ GV * const gv)
1711 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1712 SV *const buffer = sv_newmortal();
1714 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1717 gv_efullname3(buffer, gv, "*");
1718 SvFLAGS(gv) |= wasfake;
1720 /* We know that all GVs stringify to something that is not-a-number,
1721 so no need to test that. */
1722 if (ckWARN(WARN_NUMERIC))
1723 not_a_number(buffer);
1724 /* We just want something true to return, so that S_sv_2iuv_common
1725 can tail call us and return true. */
1730 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1732 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1733 SV *const buffer = sv_newmortal();
1735 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1738 gv_efullname3(buffer, gv, "*");
1739 SvFLAGS(gv) |= wasfake;
1741 assert(SvPOK(buffer));
1743 *len = SvCUR(buffer);
1745 return SvPVX(buffer);
1748 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1749 until proven guilty, assume that things are not that bad... */
1754 As 64 bit platforms often have an NV that doesn't preserve all bits of
1755 an IV (an assumption perl has been based on to date) it becomes necessary
1756 to remove the assumption that the NV always carries enough precision to
1757 recreate the IV whenever needed, and that the NV is the canonical form.
1758 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1759 precision as a side effect of conversion (which would lead to insanity
1760 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1761 1) to distinguish between IV/UV/NV slots that have cached a valid
1762 conversion where precision was lost and IV/UV/NV slots that have a
1763 valid conversion which has lost no precision
1764 2) to ensure that if a numeric conversion to one form is requested that
1765 would lose precision, the precise conversion (or differently
1766 imprecise conversion) is also performed and cached, to prevent
1767 requests for different numeric formats on the same SV causing
1768 lossy conversion chains. (lossless conversion chains are perfectly
1773 SvIOKp is true if the IV slot contains a valid value
1774 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1775 SvNOKp is true if the NV slot contains a valid value
1776 SvNOK is true only if the NV value is accurate
1779 while converting from PV to NV, check to see if converting that NV to an
1780 IV(or UV) would lose accuracy over a direct conversion from PV to
1781 IV(or UV). If it would, cache both conversions, return NV, but mark
1782 SV as IOK NOKp (ie not NOK).
1784 While converting from PV to IV, check to see if converting that IV to an
1785 NV would lose accuracy over a direct conversion from PV to NV. If it
1786 would, cache both conversions, flag similarly.
1788 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1789 correctly because if IV & NV were set NV *always* overruled.
1790 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1791 changes - now IV and NV together means that the two are interchangeable:
1792 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1794 The benefit of this is that operations such as pp_add know that if
1795 SvIOK is true for both left and right operands, then integer addition
1796 can be used instead of floating point (for cases where the result won't
1797 overflow). Before, floating point was always used, which could lead to
1798 loss of precision compared with integer addition.
1800 * making IV and NV equal status should make maths accurate on 64 bit
1802 * may speed up maths somewhat if pp_add and friends start to use
1803 integers when possible instead of fp. (Hopefully the overhead in
1804 looking for SvIOK and checking for overflow will not outweigh the
1805 fp to integer speedup)
1806 * will slow down integer operations (callers of SvIV) on "inaccurate"
1807 values, as the change from SvIOK to SvIOKp will cause a call into
1808 sv_2iv each time rather than a macro access direct to the IV slot
1809 * should speed up number->string conversion on integers as IV is
1810 favoured when IV and NV are equally accurate
1812 ####################################################################
1813 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1814 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1815 On the other hand, SvUOK is true iff UV.
1816 ####################################################################
1818 Your mileage will vary depending your CPU's relative fp to integer
1822 #ifndef NV_PRESERVES_UV
1823 # define IS_NUMBER_UNDERFLOW_IV 1
1824 # define IS_NUMBER_UNDERFLOW_UV 2
1825 # define IS_NUMBER_IV_AND_UV 2
1826 # define IS_NUMBER_OVERFLOW_IV 4
1827 # define IS_NUMBER_OVERFLOW_UV 5
1829 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1831 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1833 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1836 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1837 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));
1838 if (SvNVX(sv) < (NV)IV_MIN) {
1839 (void)SvIOKp_on(sv);
1841 SvIV_set(sv, IV_MIN);
1842 return IS_NUMBER_UNDERFLOW_IV;
1844 if (SvNVX(sv) > (NV)UV_MAX) {
1845 (void)SvIOKp_on(sv);
1848 SvUV_set(sv, UV_MAX);
1849 return IS_NUMBER_OVERFLOW_UV;
1851 (void)SvIOKp_on(sv);
1853 /* Can't use strtol etc to convert this string. (See truth table in
1855 if (SvNVX(sv) <= (UV)IV_MAX) {
1856 SvIV_set(sv, I_V(SvNVX(sv)));
1857 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1858 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1860 /* Integer is imprecise. NOK, IOKp */
1862 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1865 SvUV_set(sv, U_V(SvNVX(sv)));
1866 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1867 if (SvUVX(sv) == UV_MAX) {
1868 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1869 possibly be preserved by NV. Hence, it must be overflow.
1871 return IS_NUMBER_OVERFLOW_UV;
1873 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1875 /* Integer is imprecise. NOK, IOKp */
1877 return IS_NUMBER_OVERFLOW_IV;
1879 #endif /* !NV_PRESERVES_UV*/
1882 S_sv_2iuv_common(pTHX_ SV *sv) {
1885 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1886 * without also getting a cached IV/UV from it at the same time
1887 * (ie PV->NV conversion should detect loss of accuracy and cache
1888 * IV or UV at same time to avoid this. */
1889 /* IV-over-UV optimisation - choose to cache IV if possible */
1891 if (SvTYPE(sv) == SVt_NV)
1892 sv_upgrade(sv, SVt_PVNV);
1894 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1895 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1896 certainly cast into the IV range at IV_MAX, whereas the correct
1897 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1899 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1900 if (Perl_isnan(SvNVX(sv))) {
1906 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1907 SvIV_set(sv, I_V(SvNVX(sv)));
1908 if (SvNVX(sv) == (NV) SvIVX(sv)
1909 #ifndef NV_PRESERVES_UV
1910 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1911 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1912 /* Don't flag it as "accurately an integer" if the number
1913 came from a (by definition imprecise) NV operation, and
1914 we're outside the range of NV integer precision */
1917 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1918 DEBUG_c(PerlIO_printf(Perl_debug_log,
1919 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1925 /* IV not precise. No need to convert from PV, as NV
1926 conversion would already have cached IV if it detected
1927 that PV->IV would be better than PV->NV->IV
1928 flags already correct - don't set public IOK. */
1929 DEBUG_c(PerlIO_printf(Perl_debug_log,
1930 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1935 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1936 but the cast (NV)IV_MIN rounds to a the value less (more
1937 negative) than IV_MIN which happens to be equal to SvNVX ??
1938 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1939 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1940 (NV)UVX == NVX are both true, but the values differ. :-(
1941 Hopefully for 2s complement IV_MIN is something like
1942 0x8000000000000000 which will be exact. NWC */
1945 SvUV_set(sv, U_V(SvNVX(sv)));
1947 (SvNVX(sv) == (NV) SvUVX(sv))
1948 #ifndef NV_PRESERVES_UV
1949 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1950 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1951 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1952 /* Don't flag it as "accurately an integer" if the number
1953 came from a (by definition imprecise) NV operation, and
1954 we're outside the range of NV integer precision */
1959 DEBUG_c(PerlIO_printf(Perl_debug_log,
1960 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1966 else if (SvPOKp(sv) && SvLEN(sv)) {
1968 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1969 /* We want to avoid a possible problem when we cache an IV/ a UV which
1970 may be later translated to an NV, and the resulting NV is not
1971 the same as the direct translation of the initial string
1972 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1973 be careful to ensure that the value with the .456 is around if the
1974 NV value is requested in the future).
1976 This means that if we cache such an IV/a UV, we need to cache the
1977 NV as well. Moreover, we trade speed for space, and do not
1978 cache the NV if we are sure it's not needed.
1981 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1982 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1983 == IS_NUMBER_IN_UV) {
1984 /* It's definitely an integer, only upgrade to PVIV */
1985 if (SvTYPE(sv) < SVt_PVIV)
1986 sv_upgrade(sv, SVt_PVIV);
1988 } else if (SvTYPE(sv) < SVt_PVNV)
1989 sv_upgrade(sv, SVt_PVNV);
1991 /* If NVs preserve UVs then we only use the UV value if we know that
1992 we aren't going to call atof() below. If NVs don't preserve UVs
1993 then the value returned may have more precision than atof() will
1994 return, even though value isn't perfectly accurate. */
1995 if ((numtype & (IS_NUMBER_IN_UV
1996 #ifdef NV_PRESERVES_UV
1999 )) == IS_NUMBER_IN_UV) {
2000 /* This won't turn off the public IOK flag if it was set above */
2001 (void)SvIOKp_on(sv);
2003 if (!(numtype & IS_NUMBER_NEG)) {
2005 if (value <= (UV)IV_MAX) {
2006 SvIV_set(sv, (IV)value);
2008 /* it didn't overflow, and it was positive. */
2009 SvUV_set(sv, value);
2013 /* 2s complement assumption */
2014 if (value <= (UV)IV_MIN) {
2015 SvIV_set(sv, -(IV)value);
2017 /* Too negative for an IV. This is a double upgrade, but
2018 I'm assuming it will be rare. */
2019 if (SvTYPE(sv) < SVt_PVNV)
2020 sv_upgrade(sv, SVt_PVNV);
2024 SvNV_set(sv, -(NV)value);
2025 SvIV_set(sv, IV_MIN);
2029 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2030 will be in the previous block to set the IV slot, and the next
2031 block to set the NV slot. So no else here. */
2033 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2034 != IS_NUMBER_IN_UV) {
2035 /* It wasn't an (integer that doesn't overflow the UV). */
2036 SvNV_set(sv, Atof(SvPVX_const(sv)));
2038 if (! numtype && ckWARN(WARN_NUMERIC))
2041 #if defined(USE_LONG_DOUBLE)
2042 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2043 PTR2UV(sv), SvNVX(sv)));
2045 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2046 PTR2UV(sv), SvNVX(sv)));
2049 #ifdef NV_PRESERVES_UV
2050 (void)SvIOKp_on(sv);
2052 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2053 SvIV_set(sv, I_V(SvNVX(sv)));
2054 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2057 NOOP; /* Integer is imprecise. NOK, IOKp */
2059 /* UV will not work better than IV */
2061 if (SvNVX(sv) > (NV)UV_MAX) {
2063 /* Integer is inaccurate. NOK, IOKp, is UV */
2064 SvUV_set(sv, UV_MAX);
2066 SvUV_set(sv, U_V(SvNVX(sv)));
2067 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2068 NV preservse UV so can do correct comparison. */
2069 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2072 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2077 #else /* NV_PRESERVES_UV */
2078 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2079 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2080 /* The IV/UV slot will have been set from value returned by
2081 grok_number above. The NV slot has just been set using
2084 assert (SvIOKp(sv));
2086 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2087 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2088 /* Small enough to preserve all bits. */
2089 (void)SvIOKp_on(sv);
2091 SvIV_set(sv, I_V(SvNVX(sv)));
2092 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2094 /* Assumption: first non-preserved integer is < IV_MAX,
2095 this NV is in the preserved range, therefore: */
2096 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2098 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);
2102 0 0 already failed to read UV.
2103 0 1 already failed to read UV.
2104 1 0 you won't get here in this case. IV/UV
2105 slot set, public IOK, Atof() unneeded.
2106 1 1 already read UV.
2107 so there's no point in sv_2iuv_non_preserve() attempting
2108 to use atol, strtol, strtoul etc. */
2109 sv_2iuv_non_preserve (sv, numtype);
2112 #endif /* NV_PRESERVES_UV */
2116 if (isGV_with_GP(sv))
2117 return glob_2number((GV *)sv);
2119 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2120 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2123 if (SvTYPE(sv) < SVt_IV)
2124 /* Typically the caller expects that sv_any is not NULL now. */
2125 sv_upgrade(sv, SVt_IV);
2126 /* Return 0 from the caller. */
2133 =for apidoc sv_2iv_flags
2135 Return the integer value of an SV, doing any necessary string
2136 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2137 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2143 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2148 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2149 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2150 cache IVs just in case. In practice it seems that they never
2151 actually anywhere accessible by user Perl code, let alone get used
2152 in anything other than a string context. */
2153 if (flags & SV_GMAGIC)
2158 return I_V(SvNVX(sv));
2160 if (SvPOKp(sv) && SvLEN(sv)) {
2163 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2166 == IS_NUMBER_IN_UV) {
2167 /* It's definitely an integer */
2168 if (numtype & IS_NUMBER_NEG) {
2169 if (value < (UV)IV_MIN)
2172 if (value < (UV)IV_MAX)
2177 if (ckWARN(WARN_NUMERIC))
2180 return I_V(Atof(SvPVX_const(sv)));
2185 assert(SvTYPE(sv) >= SVt_PVMG);
2186 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2187 } else if (SvTHINKFIRST(sv)) {
2191 SV * const tmpstr=AMG_CALLun(sv,numer);
2192 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2193 return SvIV(tmpstr);
2196 return PTR2IV(SvRV(sv));
2199 sv_force_normal_flags(sv, 0);
2201 if (SvREADONLY(sv) && !SvOK(sv)) {
2202 if (ckWARN(WARN_UNINITIALIZED))
2208 if (S_sv_2iuv_common(aTHX_ sv))
2211 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2212 PTR2UV(sv),SvIVX(sv)));
2213 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2217 =for apidoc sv_2uv_flags
2219 Return the unsigned integer value of an SV, doing any necessary string
2220 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2221 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2227 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2232 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2233 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2234 cache IVs just in case. */
2235 if (flags & SV_GMAGIC)
2240 return U_V(SvNVX(sv));
2241 if (SvPOKp(sv) && SvLEN(sv)) {
2244 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2246 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2247 == IS_NUMBER_IN_UV) {
2248 /* It's definitely an integer */
2249 if (!(numtype & IS_NUMBER_NEG))
2253 if (ckWARN(WARN_NUMERIC))
2256 return U_V(Atof(SvPVX_const(sv)));
2261 assert(SvTYPE(sv) >= SVt_PVMG);
2262 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2263 } else if (SvTHINKFIRST(sv)) {
2267 SV *const tmpstr = AMG_CALLun(sv,numer);
2268 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2269 return SvUV(tmpstr);
2272 return PTR2UV(SvRV(sv));
2275 sv_force_normal_flags(sv, 0);
2277 if (SvREADONLY(sv) && !SvOK(sv)) {
2278 if (ckWARN(WARN_UNINITIALIZED))
2284 if (S_sv_2iuv_common(aTHX_ sv))
2288 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2289 PTR2UV(sv),SvUVX(sv)));
2290 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2296 Return the num value of an SV, doing any necessary string or integer
2297 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2304 Perl_sv_2nv(pTHX_ register SV *sv)
2309 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2310 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2311 cache IVs just in case. */
2315 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2316 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2317 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2319 return Atof(SvPVX_const(sv));
2323 return (NV)SvUVX(sv);
2325 return (NV)SvIVX(sv);
2330 assert(SvTYPE(sv) >= SVt_PVMG);
2331 /* This falls through to the report_uninit near the end of the
2333 } else if (SvTHINKFIRST(sv)) {
2337 SV *const tmpstr = AMG_CALLun(sv,numer);
2338 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2339 return SvNV(tmpstr);
2342 return PTR2NV(SvRV(sv));
2345 sv_force_normal_flags(sv, 0);
2347 if (SvREADONLY(sv) && !SvOK(sv)) {
2348 if (ckWARN(WARN_UNINITIALIZED))
2353 if (SvTYPE(sv) < SVt_NV) {
2354 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2355 sv_upgrade(sv, SVt_NV);
2356 #ifdef USE_LONG_DOUBLE
2358 STORE_NUMERIC_LOCAL_SET_STANDARD();
2359 PerlIO_printf(Perl_debug_log,
2360 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2361 PTR2UV(sv), SvNVX(sv));
2362 RESTORE_NUMERIC_LOCAL();
2366 STORE_NUMERIC_LOCAL_SET_STANDARD();
2367 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2368 PTR2UV(sv), SvNVX(sv));
2369 RESTORE_NUMERIC_LOCAL();
2373 else if (SvTYPE(sv) < SVt_PVNV)
2374 sv_upgrade(sv, SVt_PVNV);
2379 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2380 #ifdef NV_PRESERVES_UV
2383 /* Only set the public NV OK flag if this NV preserves the IV */
2384 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2385 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2386 : (SvIVX(sv) == I_V(SvNVX(sv))))
2392 else if (SvPOKp(sv) && SvLEN(sv)) {
2394 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2395 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2397 #ifdef NV_PRESERVES_UV
2398 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2399 == IS_NUMBER_IN_UV) {
2400 /* It's definitely an integer */
2401 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2403 SvNV_set(sv, Atof(SvPVX_const(sv)));
2406 SvNV_set(sv, Atof(SvPVX_const(sv)));
2407 /* Only set the public NV OK flag if this NV preserves the value in
2408 the PV at least as well as an IV/UV would.
2409 Not sure how to do this 100% reliably. */
2410 /* if that shift count is out of range then Configure's test is
2411 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2413 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2414 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2415 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2416 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2417 /* Can't use strtol etc to convert this string, so don't try.
2418 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2421 /* value has been set. It may not be precise. */
2422 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2423 /* 2s complement assumption for (UV)IV_MIN */
2424 SvNOK_on(sv); /* Integer is too negative. */
2429 if (numtype & IS_NUMBER_NEG) {
2430 SvIV_set(sv, -(IV)value);
2431 } else if (value <= (UV)IV_MAX) {
2432 SvIV_set(sv, (IV)value);
2434 SvUV_set(sv, value);
2438 if (numtype & IS_NUMBER_NOT_INT) {
2439 /* I believe that even if the original PV had decimals,
2440 they are lost beyond the limit of the FP precision.
2441 However, neither is canonical, so both only get p
2442 flags. NWC, 2000/11/25 */
2443 /* Both already have p flags, so do nothing */
2445 const NV nv = SvNVX(sv);
2446 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2447 if (SvIVX(sv) == I_V(nv)) {
2450 /* It had no "." so it must be integer. */
2454 /* between IV_MAX and NV(UV_MAX).
2455 Could be slightly > UV_MAX */
2457 if (numtype & IS_NUMBER_NOT_INT) {
2458 /* UV and NV both imprecise. */
2460 const UV nv_as_uv = U_V(nv);
2462 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2471 #endif /* NV_PRESERVES_UV */
2474 if (isGV_with_GP(sv)) {
2475 glob_2number((GV *)sv);
2479 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2481 assert (SvTYPE(sv) >= SVt_NV);
2482 /* Typically the caller expects that sv_any is not NULL now. */
2483 /* XXX Ilya implies that this is a bug in callers that assume this
2484 and ideally should be fixed. */
2487 #if defined(USE_LONG_DOUBLE)
2489 STORE_NUMERIC_LOCAL_SET_STANDARD();
2490 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2491 PTR2UV(sv), SvNVX(sv));
2492 RESTORE_NUMERIC_LOCAL();
2496 STORE_NUMERIC_LOCAL_SET_STANDARD();
2497 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2498 PTR2UV(sv), SvNVX(sv));
2499 RESTORE_NUMERIC_LOCAL();
2508 Return an SV with the numeric value of the source SV, doing any necessary
2509 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2510 access this function.
2516 Perl_sv_2num(pTHX_ register SV *sv)
2521 SV * const tmpsv = AMG_CALLun(sv,numer);
2522 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2523 return sv_2num(tmpsv);
2525 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2528 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2529 * UV as a string towards the end of buf, and return pointers to start and
2532 * We assume that buf is at least TYPE_CHARS(UV) long.
2536 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2538 char *ptr = buf + TYPE_CHARS(UV);
2539 char * const ebuf = ptr;
2552 *--ptr = '0' + (char)(uv % 10);
2561 =for apidoc sv_2pv_flags
2563 Returns a pointer to the string value of an SV, and sets *lp to its length.
2564 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2566 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2567 usually end up here too.
2573 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2583 if (SvGMAGICAL(sv)) {
2584 if (flags & SV_GMAGIC)
2589 if (flags & SV_MUTABLE_RETURN)
2590 return SvPVX_mutable(sv);
2591 if (flags & SV_CONST_RETURN)
2592 return (char *)SvPVX_const(sv);
2595 if (SvIOKp(sv) || SvNOKp(sv)) {
2596 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2601 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2602 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2604 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2611 #ifdef FIXNEGATIVEZERO
2612 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2618 SvUPGRADE(sv, SVt_PV);
2621 s = SvGROW_mutable(sv, len + 1);
2624 return (char*)memcpy(s, tbuf, len + 1);
2630 assert(SvTYPE(sv) >= SVt_PVMG);
2631 /* This falls through to the report_uninit near the end of the
2633 } else if (SvTHINKFIRST(sv)) {
2637 SV *const tmpstr = AMG_CALLun(sv,string);
2638 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2640 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2644 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2645 if (flags & SV_CONST_RETURN) {
2646 pv = (char *) SvPVX_const(tmpstr);
2648 pv = (flags & SV_MUTABLE_RETURN)
2649 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2652 *lp = SvCUR(tmpstr);
2654 pv = sv_2pv_flags(tmpstr, lp, flags);
2668 const SV *const referent = (SV*)SvRV(sv);
2672 retval = buffer = savepvn("NULLREF", len);
2673 } else if (SvTYPE(referent) == SVt_PVMG
2674 && ((SvFLAGS(referent) &
2675 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2676 == (SVs_OBJECT|SVs_SMG))
2677 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2682 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2687 PL_reginterp_cnt += haseval;
2690 const char *const typestr = sv_reftype(referent, 0);
2691 const STRLEN typelen = strlen(typestr);
2692 UV addr = PTR2UV(referent);
2693 const char *stashname = NULL;
2694 STRLEN stashnamelen = 0; /* hush, gcc */
2695 const char *buffer_end;
2697 if (SvOBJECT(referent)) {
2698 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2701 stashname = HEK_KEY(name);
2702 stashnamelen = HEK_LEN(name);
2704 if (HEK_UTF8(name)) {
2710 stashname = "__ANON__";
2713 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2714 + 2 * sizeof(UV) + 2 /* )\0 */;
2716 len = typelen + 3 /* (0x */
2717 + 2 * sizeof(UV) + 2 /* )\0 */;
2720 Newx(buffer, len, char);
2721 buffer_end = retval = buffer + len;
2723 /* Working backwards */
2727 *--retval = PL_hexdigit[addr & 15];
2728 } while (addr >>= 4);
2734 memcpy(retval, typestr, typelen);
2738 retval -= stashnamelen;
2739 memcpy(retval, stashname, stashnamelen);
2741 /* retval may not neccesarily have reached the start of the
2743 assert (retval >= buffer);
2745 len = buffer_end - retval - 1; /* -1 for that \0 */
2753 if (SvREADONLY(sv) && !SvOK(sv)) {
2754 if (ckWARN(WARN_UNINITIALIZED))
2761 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2762 /* I'm assuming that if both IV and NV are equally valid then
2763 converting the IV is going to be more efficient */
2764 const U32 isUIOK = SvIsUV(sv);
2765 char buf[TYPE_CHARS(UV)];
2769 if (SvTYPE(sv) < SVt_PVIV)
2770 sv_upgrade(sv, SVt_PVIV);
2771 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2773 /* inlined from sv_setpvn */
2774 s = SvGROW_mutable(sv, len + 1);
2775 Move(ptr, s, len, char);
2779 else if (SvNOKp(sv)) {
2780 const int olderrno = errno;
2781 if (SvTYPE(sv) < SVt_PVNV)
2782 sv_upgrade(sv, SVt_PVNV);
2783 /* The +20 is pure guesswork. Configure test needed. --jhi */
2784 s = SvGROW_mutable(sv, NV_DIG + 20);
2785 /* some Xenix systems wipe out errno here */
2787 if (SvNVX(sv) == 0.0)
2788 my_strlcpy(s, "0", SvLEN(sv));
2792 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2795 #ifdef FIXNEGATIVEZERO
2796 if (*s == '-' && s[1] == '0' && !s[2]) {
2808 if (isGV_with_GP(sv))
2809 return glob_2pv((GV *)sv, lp);
2811 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2815 if (SvTYPE(sv) < SVt_PV)
2816 /* Typically the caller expects that sv_any is not NULL now. */
2817 sv_upgrade(sv, SVt_PV);
2821 const STRLEN len = s - SvPVX_const(sv);
2827 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2828 PTR2UV(sv),SvPVX_const(sv)));
2829 if (flags & SV_CONST_RETURN)
2830 return (char *)SvPVX_const(sv);
2831 if (flags & SV_MUTABLE_RETURN)
2832 return SvPVX_mutable(sv);
2837 =for apidoc sv_copypv
2839 Copies a stringified representation of the source SV into the
2840 destination SV. Automatically performs any necessary mg_get and
2841 coercion of numeric values into strings. Guaranteed to preserve
2842 UTF8 flag even from overloaded objects. Similar in nature to
2843 sv_2pv[_flags] but operates directly on an SV instead of just the
2844 string. Mostly uses sv_2pv_flags to do its work, except when that
2845 would lose the UTF-8'ness of the PV.
2851 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2854 const char * const s = SvPV_const(ssv,len);
2855 sv_setpvn(dsv,s,len);
2863 =for apidoc sv_2pvbyte
2865 Return a pointer to the byte-encoded representation of the SV, and set *lp
2866 to its length. May cause the SV to be downgraded from UTF-8 as a
2869 Usually accessed via the C<SvPVbyte> macro.
2875 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2877 sv_utf8_downgrade(sv,0);
2878 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2882 =for apidoc sv_2pvutf8
2884 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2885 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2887 Usually accessed via the C<SvPVutf8> macro.
2893 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2895 sv_utf8_upgrade(sv);
2896 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2901 =for apidoc sv_2bool
2903 This function is only called on magical items, and is only used by
2904 sv_true() or its macro equivalent.
2910 Perl_sv_2bool(pTHX_ register SV *sv)
2919 SV * const tmpsv = AMG_CALLun(sv,bool_);
2920 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2921 return (bool)SvTRUE(tmpsv);
2923 return SvRV(sv) != 0;
2926 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2928 (*sv->sv_u.svu_pv > '0' ||
2929 Xpvtmp->xpv_cur > 1 ||
2930 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2937 return SvIVX(sv) != 0;
2940 return SvNVX(sv) != 0.0;
2942 if (isGV_with_GP(sv))
2952 =for apidoc sv_utf8_upgrade
2954 Converts the PV of an SV to its UTF-8-encoded form.
2955 Forces the SV to string form if it is not already.
2956 Always sets the SvUTF8 flag to avoid future validity checks even
2957 if all the bytes have hibit clear.
2959 This is not as a general purpose byte encoding to Unicode interface:
2960 use the Encode extension for that.
2962 =for apidoc sv_utf8_upgrade_flags
2964 Converts the PV of an SV to its UTF-8-encoded form.
2965 Forces the SV to string form if it is not already.
2966 Always sets the SvUTF8 flag to avoid future validity checks even
2967 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2968 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2969 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2971 This is not as a general purpose byte encoding to Unicode interface:
2972 use the Encode extension for that.
2978 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2981 if (sv == &PL_sv_undef)
2985 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2986 (void) sv_2pv_flags(sv,&len, flags);
2990 (void) SvPV_force(sv,len);
2999 sv_force_normal_flags(sv, 0);
3002 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3003 sv_recode_to_utf8(sv, PL_encoding);
3004 else { /* Assume Latin-1/EBCDIC */
3005 /* This function could be much more efficient if we
3006 * had a FLAG in SVs to signal if there are any hibit
3007 * chars in the PV. Given that there isn't such a flag
3008 * make the loop as fast as possible. */
3009 const U8 * const s = (U8 *) SvPVX_const(sv);
3010 const U8 * const e = (U8 *) SvEND(sv);
3015 /* Check for hi bit */
3016 if (!NATIVE_IS_INVARIANT(ch)) {
3017 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3018 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3020 SvPV_free(sv); /* No longer using what was there before. */
3021 SvPV_set(sv, (char*)recoded);
3022 SvCUR_set(sv, len - 1);
3023 SvLEN_set(sv, len); /* No longer know the real size. */
3027 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3034 =for apidoc sv_utf8_downgrade
3036 Attempts to convert the PV of an SV from characters to bytes.
3037 If the PV contains a character beyond byte, this conversion will fail;
3038 in this case, either returns false or, if C<fail_ok> is not
3041 This is not as a general purpose Unicode to byte encoding interface:
3042 use the Encode extension for that.
3048 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3051 if (SvPOKp(sv) && SvUTF8(sv)) {
3057 sv_force_normal_flags(sv, 0);
3059 s = (U8 *) SvPV(sv, len);
3060 if (!utf8_to_bytes(s, &len)) {
3065 Perl_croak(aTHX_ "Wide character in %s",
3068 Perl_croak(aTHX_ "Wide character");
3079 =for apidoc sv_utf8_encode
3081 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3082 flag off so that it looks like octets again.
3088 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3091 sv_force_normal_flags(sv, 0);
3093 if (SvREADONLY(sv)) {
3094 Perl_croak(aTHX_ PL_no_modify);
3096 (void) sv_utf8_upgrade(sv);
3101 =for apidoc sv_utf8_decode
3103 If the PV of the SV is an octet sequence in UTF-8
3104 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3105 so that it looks like a character. If the PV contains only single-byte
3106 characters, the C<SvUTF8> flag stays being off.
3107 Scans PV for validity and returns false if the PV is invalid UTF-8.
3113 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3119 /* The octets may have got themselves encoded - get them back as
3122 if (!sv_utf8_downgrade(sv, TRUE))
3125 /* it is actually just a matter of turning the utf8 flag on, but
3126 * we want to make sure everything inside is valid utf8 first.
3128 c = (const U8 *) SvPVX_const(sv);
3129 if (!is_utf8_string(c, SvCUR(sv)+1))
3131 e = (const U8 *) SvEND(sv);
3134 if (!UTF8_IS_INVARIANT(ch)) {
3144 =for apidoc sv_setsv
3146 Copies the contents of the source SV C<ssv> into the destination SV
3147 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3148 function if the source SV needs to be reused. Does not handle 'set' magic.
3149 Loosely speaking, it performs a copy-by-value, obliterating any previous
3150 content of the destination.
3152 You probably want to use one of the assortment of wrappers, such as
3153 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3154 C<SvSetMagicSV_nosteal>.
3156 =for apidoc sv_setsv_flags
3158 Copies the contents of the source SV C<ssv> into the destination SV
3159 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3160 function if the source SV needs to be reused. Does not handle 'set' magic.
3161 Loosely speaking, it performs a copy-by-value, obliterating any previous
3162 content of the destination.
3163 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3164 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3165 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3166 and C<sv_setsv_nomg> are implemented in terms of this function.
3168 You probably want to use one of the assortment of wrappers, such as
3169 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3170 C<SvSetMagicSV_nosteal>.
3172 This is the primary function for copying scalars, and most other
3173 copy-ish functions and macros use this underneath.
3179 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3181 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3183 if (dtype != SVt_PVGV) {
3184 const char * const name = GvNAME(sstr);
3185 const STRLEN len = GvNAMELEN(sstr);
3187 if (dtype >= SVt_PV) {
3193 SvUPGRADE(dstr, SVt_PVGV);
3194 (void)SvOK_off(dstr);
3195 /* FIXME - why are we doing this, then turning it off and on again
3197 isGV_with_GP_on(dstr);
3199 GvSTASH(dstr) = GvSTASH(sstr);
3201 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3202 gv_name_set((GV *)dstr, name, len, GV_ADD);
3203 SvFAKE_on(dstr); /* can coerce to non-glob */
3206 #ifdef GV_UNIQUE_CHECK
3207 if (GvUNIQUE((GV*)dstr)) {
3208 Perl_croak(aTHX_ PL_no_modify);
3212 if(GvGP((GV*)sstr)) {
3213 /* If source has method cache entry, clear it */
3215 SvREFCNT_dec(GvCV(sstr));
3219 /* If source has a real method, then a method is
3221 else if(GvCV((GV*)sstr)) {
3226 /* If dest already had a real method, that's a change as well */
3227 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3231 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3235 isGV_with_GP_off(dstr);
3236 (void)SvOK_off(dstr);
3237 isGV_with_GP_on(dstr);
3238 GvINTRO_off(dstr); /* one-shot flag */
3239 GvGP(dstr) = gp_ref(GvGP(sstr));
3240 if (SvTAINTED(sstr))
3242 if (GvIMPORTED(dstr) != GVf_IMPORTED
3243 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3245 GvIMPORTED_on(dstr);
3248 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3249 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3254 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3255 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3257 const int intro = GvINTRO(dstr);
3260 const U32 stype = SvTYPE(sref);
3263 #ifdef GV_UNIQUE_CHECK
3264 if (GvUNIQUE((GV*)dstr)) {
3265 Perl_croak(aTHX_ PL_no_modify);
3270 GvINTRO_off(dstr); /* one-shot flag */
3271 GvLINE(dstr) = CopLINE(PL_curcop);
3272 GvEGV(dstr) = (GV*)dstr;
3277 location = (SV **) &GvCV(dstr);
3278 import_flag = GVf_IMPORTED_CV;
3281 location = (SV **) &GvHV(dstr);
3282 import_flag = GVf_IMPORTED_HV;
3285 location = (SV **) &GvAV(dstr);
3286 import_flag = GVf_IMPORTED_AV;
3289 location = (SV **) &GvIOp(dstr);
3292 location = (SV **) &GvFORM(dstr);
3294 location = &GvSV(dstr);
3295 import_flag = GVf_IMPORTED_SV;
3298 if (stype == SVt_PVCV) {
3299 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3300 if (GvCVGEN(dstr)) {
3301 SvREFCNT_dec(GvCV(dstr));
3303 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3306 SAVEGENERICSV(*location);
3310 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3311 CV* const cv = (CV*)*location;
3313 if (!GvCVGEN((GV*)dstr) &&
3314 (CvROOT(cv) || CvXSUB(cv)))
3316 /* Redefining a sub - warning is mandatory if
3317 it was a const and its value changed. */
3318 if (CvCONST(cv) && CvCONST((CV*)sref)
3319 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3321 /* They are 2 constant subroutines generated from
3322 the same constant. This probably means that
3323 they are really the "same" proxy subroutine
3324 instantiated in 2 places. Most likely this is
3325 when a constant is exported twice. Don't warn.
3328 else if (ckWARN(WARN_REDEFINE)
3330 && (!CvCONST((CV*)sref)
3331 || sv_cmp(cv_const_sv(cv),
3332 cv_const_sv((CV*)sref))))) {
3333 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3336 ? "Constant subroutine %s::%s redefined"
3337 : "Subroutine %s::%s redefined"),
3338 HvNAME_get(GvSTASH((GV*)dstr)),
3339 GvENAME((GV*)dstr));
3343 cv_ckproto_len(cv, (GV*)dstr,
3344 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3345 SvPOK(sref) ? SvCUR(sref) : 0);
3347 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3348 GvASSUMECV_on(dstr);
3349 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3352 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3353 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3354 GvFLAGS(dstr) |= import_flag;
3359 if (SvTAINTED(sstr))
3365 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3368 register U32 sflags;
3370 register svtype stype;
3375 if (SvIS_FREED(dstr)) {
3376 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3377 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3379 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3381 sstr = &PL_sv_undef;
3382 if (SvIS_FREED(sstr)) {
3383 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3384 (void*)sstr, (void*)dstr);
3386 stype = SvTYPE(sstr);
3387 dtype = SvTYPE(dstr);
3389 (void)SvAMAGIC_off(dstr);
3392 /* need to nuke the magic */
3394 SvRMAGICAL_off(dstr);
3397 /* There's a lot of redundancy below but we're going for speed here */
3402 if (dtype != SVt_PVGV) {
3403 (void)SvOK_off(dstr);
3411 sv_upgrade(dstr, SVt_IV);
3416 sv_upgrade(dstr, SVt_PVIV);
3419 goto end_of_first_switch;
3421 (void)SvIOK_only(dstr);
3422 SvIV_set(dstr, SvIVX(sstr));
3425 /* SvTAINTED can only be true if the SV has taint magic, which in
3426 turn means that the SV type is PVMG (or greater). This is the
3427 case statement for SVt_IV, so this cannot be true (whatever gcov
3429 assert(!SvTAINTED(sstr));
3439 sv_upgrade(dstr, SVt_NV);
3444 sv_upgrade(dstr, SVt_PVNV);
3447 goto end_of_first_switch;
3449 SvNV_set(dstr, SvNVX(sstr));
3450 (void)SvNOK_only(dstr);
3451 /* SvTAINTED can only be true if the SV has taint magic, which in
3452 turn means that the SV type is PVMG (or greater). This is the
3453 case statement for SVt_NV, so this cannot be true (whatever gcov
3455 assert(!SvTAINTED(sstr));
3462 sv_upgrade(dstr, SVt_RV);
3465 #ifdef PERL_OLD_COPY_ON_WRITE
3466 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3467 if (dtype < SVt_PVIV)
3468 sv_upgrade(dstr, SVt_PVIV);
3475 sv_upgrade(dstr, SVt_PV);
3478 if (dtype < SVt_PVIV)
3479 sv_upgrade(dstr, SVt_PVIV);
3482 if (dtype < SVt_PVNV)
3483 sv_upgrade(dstr, SVt_PVNV);
3487 const char * const type = sv_reftype(sstr,0);
3489 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3491 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3495 /* case SVt_BIND: */
3498 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3499 glob_assign_glob(dstr, sstr, dtype);
3502 /* SvVALID means that this PVGV is playing at being an FBM. */
3506 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3508 if (SvTYPE(sstr) != stype) {
3509 stype = SvTYPE(sstr);
3510 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3511 glob_assign_glob(dstr, sstr, dtype);
3516 if (stype == SVt_PVLV)
3517 SvUPGRADE(dstr, SVt_PVNV);
3519 SvUPGRADE(dstr, (svtype)stype);
3521 end_of_first_switch:
3523 /* dstr may have been upgraded. */
3524 dtype = SvTYPE(dstr);
3525 sflags = SvFLAGS(sstr);
3527 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3528 /* Assigning to a subroutine sets the prototype. */
3531 const char *const ptr = SvPV_const(sstr, len);
3533 SvGROW(dstr, len + 1);
3534 Copy(ptr, SvPVX(dstr), len + 1, char);
3535 SvCUR_set(dstr, len);
3537 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3541 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3542 const char * const type = sv_reftype(dstr,0);
3544 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3546 Perl_croak(aTHX_ "Cannot copy to %s", type);
3547 } else if (sflags & SVf_ROK) {
3548 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3549 && 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 && isGV_with_GP(dstr)) {
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;
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 && isGV_with_GP(dstr)) {
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.
3606 * Likewise if we can set up COW rather than doing an actual copy, we
3607 * drop to the else clause, as the swipe code and the COW setup code
3608 * have much in common.
3611 /* Whichever path we take through the next code, we want this true,
3612 and doing it now facilitates the COW check. */
3613 (void)SvPOK_only(dstr);
3616 /* If we're already COW then this clause is not true, and if COW
3617 is allowed then we drop down to the else and make dest COW
3618 with us. If caller hasn't said that we're allowed to COW
3619 shared hash keys then we don't do the COW setup, even if the
3620 source scalar is a shared hash key scalar. */
3621 (((flags & SV_COW_SHARED_HASH_KEYS)
3622 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3623 : 1 /* If making a COW copy is forbidden then the behaviour we
3624 desire is as if the source SV isn't actually already
3625 COW, even if it is. So we act as if the source flags
3626 are not COW, rather than actually testing them. */
3628 #ifndef PERL_OLD_COPY_ON_WRITE
3629 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3630 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3631 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3632 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3633 but in turn, it's somewhat dead code, never expected to go
3634 live, but more kept as a placeholder on how to do it better
3635 in a newer implementation. */
3636 /* If we are COW and dstr is a suitable target then we drop down
3637 into the else and make dest a COW of us. */
3638 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3643 (sflags & SVs_TEMP) && /* slated for free anyway? */
3644 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3645 (!(flags & SV_NOSTEAL)) &&
3646 /* and we're allowed to steal temps */
3647 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3648 SvLEN(sstr) && /* and really is a string */
3649 /* and won't be needed again, potentially */
3650 !(PL_op && PL_op->op_type == OP_AASSIGN))
3651 #ifdef PERL_OLD_COPY_ON_WRITE
3652 && ((flags & SV_COW_SHARED_HASH_KEYS)
3653 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3654 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3655 && SvTYPE(sstr) >= SVt_PVIV))
3659 /* Failed the swipe test, and it's not a shared hash key either.
3660 Have to copy the string. */
3661 STRLEN len = SvCUR(sstr);
3662 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3663 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3664 SvCUR_set(dstr, len);
3665 *SvEND(dstr) = '\0';
3667 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3669 /* Either it's a shared hash key, or it's suitable for
3670 copy-on-write or we can swipe the string. */
3672 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3676 #ifdef PERL_OLD_COPY_ON_WRITE
3678 /* I believe I should acquire a global SV mutex if
3679 it's a COW sv (not a shared hash key) to stop
3680 it going un copy-on-write.
3681 If the source SV has gone un copy on write between up there
3682 and down here, then (assert() that) it is of the correct
3683 form to make it copy on write again */
3684 if ((sflags & (SVf_FAKE | SVf_READONLY))
3685 != (SVf_FAKE | SVf_READONLY)) {
3686 SvREADONLY_on(sstr);
3688 /* Make the source SV into a loop of 1.
3689 (about to become 2) */
3690 SV_COW_NEXT_SV_SET(sstr, sstr);
3694 /* Initial code is common. */
3695 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3700 /* making another shared SV. */
3701 STRLEN cur = SvCUR(sstr);
3702 STRLEN len = SvLEN(sstr);
3703 #ifdef PERL_OLD_COPY_ON_WRITE
3705 assert (SvTYPE(dstr) >= SVt_PVIV);
3706 /* SvIsCOW_normal */
3707 /* splice us in between source and next-after-source. */
3708 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3709 SV_COW_NEXT_SV_SET(sstr, dstr);
3710 SvPV_set(dstr, SvPVX_mutable(sstr));
3714 /* SvIsCOW_shared_hash */
3715 DEBUG_C(PerlIO_printf(Perl_debug_log,
3716 "Copy on write: Sharing hash\n"));
3718 assert (SvTYPE(dstr) >= SVt_PV);
3720 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3722 SvLEN_set(dstr, len);
3723 SvCUR_set(dstr, cur);
3724 SvREADONLY_on(dstr);
3726 /* Relesase a global SV mutex. */
3729 { /* Passes the swipe test. */
3730 SvPV_set(dstr, SvPVX_mutable(sstr));
3731 SvLEN_set(dstr, SvLEN(sstr));
3732 SvCUR_set(dstr, SvCUR(sstr));
3735 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3736 SvPV_set(sstr, NULL);
3742 if (sflags & SVp_NOK) {
3743 SvNV_set(dstr, SvNVX(sstr));
3745 if (sflags & SVp_IOK) {
3747 SvIV_set(dstr, SvIVX(sstr));
3748 /* Must do this otherwise some other overloaded use of 0x80000000
3749 gets confused. I guess SVpbm_VALID */
3750 if (sflags & SVf_IVisUV)
3753 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3755 const MAGIC * const smg = SvVSTRING_mg(sstr);
3757 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3758 smg->mg_ptr, smg->mg_len);
3759 SvRMAGICAL_on(dstr);
3763 else if (sflags & (SVp_IOK|SVp_NOK)) {
3764 (void)SvOK_off(dstr);
3765 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3766 if (sflags & SVp_IOK) {
3767 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3768 SvIV_set(dstr, SvIVX(sstr));
3770 if (sflags & SVp_NOK) {
3771 SvNV_set(dstr, SvNVX(sstr));
3775 if (isGV_with_GP(sstr)) {
3776 /* This stringification rule for globs is spread in 3 places.
3777 This feels bad. FIXME. */
3778 const U32 wasfake = sflags & SVf_FAKE;
3780 /* FAKE globs can get coerced, so need to turn this off
3781 temporarily if it is on. */
3783 gv_efullname3(dstr, (GV *)sstr, "*");
3784 SvFLAGS(sstr) |= wasfake;
3787 (void)SvOK_off(dstr);
3789 if (SvTAINTED(sstr))
3794 =for apidoc sv_setsv_mg
3796 Like C<sv_setsv>, but also handles 'set' magic.
3802 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3804 sv_setsv(dstr,sstr);
3808 #ifdef PERL_OLD_COPY_ON_WRITE
3810 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3812 STRLEN cur = SvCUR(sstr);
3813 STRLEN len = SvLEN(sstr);
3814 register char *new_pv;
3817 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3818 (void*)sstr, (void*)dstr);
3825 if (SvTHINKFIRST(dstr))
3826 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3827 else if (SvPVX_const(dstr))
3828 Safefree(SvPVX_const(dstr));
3832 SvUPGRADE(dstr, SVt_PVIV);
3834 assert (SvPOK(sstr));
3835 assert (SvPOKp(sstr));
3836 assert (!SvIOK(sstr));
3837 assert (!SvIOKp(sstr));
3838 assert (!SvNOK(sstr));
3839 assert (!SvNOKp(sstr));
3841 if (SvIsCOW(sstr)) {
3843 if (SvLEN(sstr) == 0) {
3844 /* source is a COW shared hash key. */
3845 DEBUG_C(PerlIO_printf(Perl_debug_log,
3846 "Fast copy on write: Sharing hash\n"));
3847 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3850 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3852 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3853 SvUPGRADE(sstr, SVt_PVIV);
3854 SvREADONLY_on(sstr);
3856 DEBUG_C(PerlIO_printf(Perl_debug_log,
3857 "Fast copy on write: Converting sstr to COW\n"));
3858 SV_COW_NEXT_SV_SET(dstr, sstr);
3860 SV_COW_NEXT_SV_SET(sstr, dstr);
3861 new_pv = SvPVX_mutable(sstr);
3864 SvPV_set(dstr, new_pv);
3865 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3868 SvLEN_set(dstr, len);
3869 SvCUR_set(dstr, cur);
3878 =for apidoc sv_setpvn
3880 Copies a string into an SV. The C<len> parameter indicates the number of
3881 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3882 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3888 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3891 register char *dptr;
3893 SV_CHECK_THINKFIRST_COW_DROP(sv);
3899 /* len is STRLEN which is unsigned, need to copy to signed */
3902 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3904 SvUPGRADE(sv, SVt_PV);
3906 dptr = SvGROW(sv, len + 1);
3907 Move(ptr,dptr,len,char);
3910 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3915 =for apidoc sv_setpvn_mg
3917 Like C<sv_setpvn>, but also handles 'set' magic.
3923 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3925 sv_setpvn(sv,ptr,len);
3930 =for apidoc sv_setpv
3932 Copies a string into an SV. The string must be null-terminated. Does not
3933 handle 'set' magic. See C<sv_setpv_mg>.
3939 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3942 register STRLEN len;
3944 SV_CHECK_THINKFIRST_COW_DROP(sv);
3950 SvUPGRADE(sv, SVt_PV);
3952 SvGROW(sv, len + 1);
3953 Move(ptr,SvPVX(sv),len+1,char);
3955 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3960 =for apidoc sv_setpv_mg
3962 Like C<sv_setpv>, but also handles 'set' magic.
3968 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3975 =for apidoc sv_usepvn_flags
3977 Tells an SV to use C<ptr> to find its string value. Normally the
3978 string is stored inside the SV but sv_usepvn allows the SV to use an
3979 outside string. The C<ptr> should point to memory that was allocated
3980 by C<malloc>. The string length, C<len>, must be supplied. By default
3981 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3982 so that pointer should not be freed or used by the programmer after
3983 giving it to sv_usepvn, and neither should any pointers from "behind"
3984 that pointer (e.g. ptr + 1) be used.
3986 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3987 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3988 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3989 C<len>, and already meets the requirements for storing in C<SvPVX>)
3995 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
3999 SV_CHECK_THINKFIRST_COW_DROP(sv);
4000 SvUPGRADE(sv, SVt_PV);
4003 if (flags & SV_SMAGIC)
4007 if (SvPVX_const(sv))
4011 if (flags & SV_HAS_TRAILING_NUL)
4012 assert(ptr[len] == '\0');
4015 allocate = (flags & SV_HAS_TRAILING_NUL)
4016 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4017 if (flags & SV_HAS_TRAILING_NUL) {
4018 /* It's long enough - do nothing.
4019 Specfically Perl_newCONSTSUB is relying on this. */
4022 /* Force a move to shake out bugs in callers. */
4023 char *new_ptr = (char*)safemalloc(allocate);
4024 Copy(ptr, new_ptr, len, char);
4025 PoisonFree(ptr,len,char);
4029 ptr = (char*) saferealloc (ptr, allocate);
4034 SvLEN_set(sv, allocate);
4035 if (!(flags & SV_HAS_TRAILING_NUL)) {
4038 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4040 if (flags & SV_SMAGIC)
4044 #ifdef PERL_OLD_COPY_ON_WRITE
4045 /* Need to do this *after* making the SV normal, as we need the buffer
4046 pointer to remain valid until after we've copied it. If we let go too early,
4047 another thread could invalidate it by unsharing last of the same hash key
4048 (which it can do by means other than releasing copy-on-write Svs)
4049 or by changing the other copy-on-write SVs in the loop. */
4051 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4053 { /* this SV was SvIsCOW_normal(sv) */
4054 /* we need to find the SV pointing to us. */
4055 SV *current = SV_COW_NEXT_SV(after);
4057 if (current == sv) {
4058 /* The SV we point to points back to us (there were only two of us
4060 Hence other SV is no longer copy on write either. */
4062 SvREADONLY_off(after);
4064 /* We need to follow the pointers around the loop. */
4066 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4069 /* don't loop forever if the structure is bust, and we have
4070 a pointer into a closed loop. */
4071 assert (current != after);
4072 assert (SvPVX_const(current) == pvx);
4074 /* Make the SV before us point to the SV after us. */
4075 SV_COW_NEXT_SV_SET(current, after);
4081 =for apidoc sv_force_normal_flags
4083 Undo various types of fakery on an SV: if the PV is a shared string, make
4084 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4085 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4086 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4087 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4088 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4089 set to some other value.) In addition, the C<flags> parameter gets passed to
4090 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4091 with flags set to 0.
4097 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4100 #ifdef PERL_OLD_COPY_ON_WRITE
4101 if (SvREADONLY(sv)) {
4102 /* At this point I believe I should acquire a global SV mutex. */
4104 const char * const pvx = SvPVX_const(sv);
4105 const STRLEN len = SvLEN(sv);
4106 const STRLEN cur = SvCUR(sv);
4107 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4108 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4109 we'll fail an assertion. */
4110 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4113 PerlIO_printf(Perl_debug_log,
4114 "Copy on write: Force normal %ld\n",
4120 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4123 if (flags & SV_COW_DROP_PV) {
4124 /* OK, so we don't need to copy our buffer. */
4127 SvGROW(sv, cur + 1);
4128 Move(pvx,SvPVX(sv),cur,char);
4133 sv_release_COW(sv, pvx, next);
4135 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4141 else if (IN_PERL_RUNTIME)
4142 Perl_croak(aTHX_ PL_no_modify);
4143 /* At this point I believe that I can drop the global SV mutex. */
4146 if (SvREADONLY(sv)) {
4148 const char * const pvx = SvPVX_const(sv);
4149 const STRLEN len = SvCUR(sv);
4154 SvGROW(sv, len + 1);
4155 Move(pvx,SvPVX(sv),len,char);
4157 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4159 else if (IN_PERL_RUNTIME)
4160 Perl_croak(aTHX_ PL_no_modify);
4164 sv_unref_flags(sv, flags);
4165 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4172 Efficient removal of characters from the beginning of the string buffer.
4173 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4174 the string buffer. The C<ptr> becomes the first character of the adjusted
4175 string. Uses the "OOK hack".
4176 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4177 refer to the same chunk of data.
4183 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4185 register STRLEN delta;
4186 if (!ptr || !SvPOKp(sv))
4188 delta = ptr - SvPVX_const(sv);
4189 SV_CHECK_THINKFIRST(sv);
4190 if (SvTYPE(sv) < SVt_PVIV)
4191 sv_upgrade(sv,SVt_PVIV);
4194 if (!SvLEN(sv)) { /* make copy of shared string */
4195 const char *pvx = SvPVX_const(sv);
4196 const STRLEN len = SvCUR(sv);
4197 SvGROW(sv, len + 1);
4198 Move(pvx,SvPVX(sv),len,char);
4202 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4203 and we do that anyway inside the SvNIOK_off
4205 SvFLAGS(sv) |= SVf_OOK;
4208 SvLEN_set(sv, SvLEN(sv) - delta);
4209 SvCUR_set(sv, SvCUR(sv) - delta);
4210 SvPV_set(sv, SvPVX(sv) + delta);
4211 SvIV_set(sv, SvIVX(sv) + delta);
4215 =for apidoc sv_catpvn
4217 Concatenates the string onto the end of the string which is in the SV. The
4218 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4219 status set, then the bytes appended should be valid UTF-8.
4220 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4222 =for apidoc sv_catpvn_flags
4224 Concatenates the string onto the end of the string which is in the SV. The
4225 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4226 status set, then the bytes appended should be valid UTF-8.
4227 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4228 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4229 in terms of this function.
4235 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4239 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4241 SvGROW(dsv, dlen + slen + 1);
4243 sstr = SvPVX_const(dsv);
4244 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4245 SvCUR_set(dsv, SvCUR(dsv) + slen);
4247 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4249 if (flags & SV_SMAGIC)
4254 =for apidoc sv_catsv
4256 Concatenates the string from SV C<ssv> onto the end of the string in
4257 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4258 not 'set' magic. See C<sv_catsv_mg>.
4260 =for apidoc sv_catsv_flags
4262 Concatenates the string from SV C<ssv> onto the end of the string in
4263 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4264 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4265 and C<sv_catsv_nomg> are implemented in terms of this function.
4270 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4275 const char *spv = SvPV_const(ssv, slen);
4277 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4278 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4279 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4280 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4281 dsv->sv_flags doesn't have that bit set.
4282 Andy Dougherty 12 Oct 2001
4284 const I32 sutf8 = DO_UTF8(ssv);
4287 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4289 dutf8 = DO_UTF8(dsv);
4291 if (dutf8 != sutf8) {
4293 /* Not modifying source SV, so taking a temporary copy. */
4294 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4296 sv_utf8_upgrade(csv);
4297 spv = SvPV_const(csv, slen);
4300 sv_utf8_upgrade_nomg(dsv);
4302 sv_catpvn_nomg(dsv, spv, slen);
4305 if (flags & SV_SMAGIC)
4310 =for apidoc sv_catpv
4312 Concatenates the string onto the end of the string which is in the SV.
4313 If the SV has the UTF-8 status set, then the bytes appended should be
4314 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4319 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4322 register STRLEN len;
4328 junk = SvPV_force(sv, tlen);
4330 SvGROW(sv, tlen + len + 1);
4332 ptr = SvPVX_const(sv);
4333 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4334 SvCUR_set(sv, SvCUR(sv) + len);
4335 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4340 =for apidoc sv_catpv_mg
4342 Like C<sv_catpv>, but also handles 'set' magic.
4348 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4357 Creates a new SV. A non-zero C<len> parameter indicates the number of
4358 bytes of preallocated string space the SV should have. An extra byte for a
4359 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4360 space is allocated.) The reference count for the new SV is set to 1.
4362 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4363 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4364 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4365 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4366 modules supporting older perls.
4372 Perl_newSV(pTHX_ STRLEN len)
4379 sv_upgrade(sv, SVt_PV);
4380 SvGROW(sv, len + 1);
4385 =for apidoc sv_magicext
4387 Adds magic to an SV, upgrading it if necessary. Applies the
4388 supplied vtable and returns a pointer to the magic added.
4390 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4391 In particular, you can add magic to SvREADONLY SVs, and add more than
4392 one instance of the same 'how'.
4394 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4395 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4396 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4397 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4399 (This is now used as a subroutine by C<sv_magic>.)
4404 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4405 const char* name, I32 namlen)
4410 SvUPGRADE(sv, SVt_PVMG);
4411 Newxz(mg, 1, MAGIC);
4412 mg->mg_moremagic = SvMAGIC(sv);
4413 SvMAGIC_set(sv, mg);
4415 /* Sometimes a magic contains a reference loop, where the sv and
4416 object refer to each other. To prevent a reference loop that
4417 would prevent such objects being freed, we look for such loops
4418 and if we find one we avoid incrementing the object refcount.
4420 Note we cannot do this to avoid self-tie loops as intervening RV must
4421 have its REFCNT incremented to keep it in existence.
4424 if (!obj || obj == sv ||
4425 how == PERL_MAGIC_arylen ||
4426 how == PERL_MAGIC_qr ||
4427 how == PERL_MAGIC_symtab ||
4428 (SvTYPE(obj) == SVt_PVGV &&
4429 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4430 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4431 GvFORM(obj) == (CV*)sv)))
4436 mg->mg_obj = SvREFCNT_inc_simple(obj);
4437 mg->mg_flags |= MGf_REFCOUNTED;
4440 /* Normal self-ties simply pass a null object, and instead of
4441 using mg_obj directly, use the SvTIED_obj macro to produce a
4442 new RV as needed. For glob "self-ties", we are tieing the PVIO
4443 with an RV obj pointing to the glob containing the PVIO. In
4444 this case, to avoid a reference loop, we need to weaken the
4448 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4449 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4455 mg->mg_len = namlen;
4458 mg->mg_ptr = savepvn(name, namlen);
4459 else if (namlen == HEf_SVKEY)
4460 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4462 mg->mg_ptr = (char *) name;
4464 mg->mg_virtual = (MGVTBL *) vtable;
4468 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4473 =for apidoc sv_magic
4475 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4476 then adds a new magic item of type C<how> to the head of the magic list.
4478 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4479 handling of the C<name> and C<namlen> arguments.
4481 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4482 to add more than one instance of the same 'how'.
4488 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4491 const MGVTBL *vtable;
4494 #ifdef PERL_OLD_COPY_ON_WRITE
4496 sv_force_normal_flags(sv, 0);
4498 if (SvREADONLY(sv)) {
4500 /* its okay to attach magic to shared strings; the subsequent
4501 * upgrade to PVMG will unshare the string */
4502 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4505 && how != PERL_MAGIC_regex_global
4506 && how != PERL_MAGIC_bm
4507 && how != PERL_MAGIC_fm
4508 && how != PERL_MAGIC_sv
4509 && how != PERL_MAGIC_backref
4512 Perl_croak(aTHX_ PL_no_modify);
4515 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4516 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4517 /* sv_magic() refuses to add a magic of the same 'how' as an
4520 if (how == PERL_MAGIC_taint) {
4522 /* Any scalar which already had taint magic on which someone
4523 (erroneously?) did SvIOK_on() or similar will now be
4524 incorrectly sporting public "OK" flags. */
4525 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4533 vtable = &PL_vtbl_sv;
4535 case PERL_MAGIC_overload:
4536 vtable = &PL_vtbl_amagic;
4538 case PERL_MAGIC_overload_elem:
4539 vtable = &PL_vtbl_amagicelem;
4541 case PERL_MAGIC_overload_table:
4542 vtable = &PL_vtbl_ovrld;
4545 vtable = &PL_vtbl_bm;
4547 case PERL_MAGIC_regdata:
4548 vtable = &PL_vtbl_regdata;
4550 case PERL_MAGIC_regdatum:
4551 vtable = &PL_vtbl_regdatum;
4553 case PERL_MAGIC_env:
4554 vtable = &PL_vtbl_env;
4557 vtable = &PL_vtbl_fm;
4559 case PERL_MAGIC_envelem:
4560 vtable = &PL_vtbl_envelem;
4562 case PERL_MAGIC_regex_global:
4563 vtable = &PL_vtbl_mglob;
4565 case PERL_MAGIC_isa:
4566 vtable = &PL_vtbl_isa;
4568 case PERL_MAGIC_isaelem:
4569 vtable = &PL_vtbl_isaelem;
4571 case PERL_MAGIC_nkeys:
4572 vtable = &PL_vtbl_nkeys;
4574 case PERL_MAGIC_dbfile:
4577 case PERL_MAGIC_dbline:
4578 vtable = &PL_vtbl_dbline;
4580 #ifdef USE_LOCALE_COLLATE
4581 case PERL_MAGIC_collxfrm:
4582 vtable = &PL_vtbl_collxfrm;
4584 #endif /* USE_LOCALE_COLLATE */
4585 case PERL_MAGIC_tied:
4586 vtable = &PL_vtbl_pack;
4588 case PERL_MAGIC_tiedelem:
4589 case PERL_MAGIC_tiedscalar:
4590 vtable = &PL_vtbl_packelem;
4593 vtable = &PL_vtbl_regexp;
4595 case PERL_MAGIC_hints:
4596 /* As this vtable is all NULL, we can reuse it. */
4597 case PERL_MAGIC_sig:
4598 vtable = &PL_vtbl_sig;
4600 case PERL_MAGIC_sigelem:
4601 vtable = &PL_vtbl_sigelem;
4603 case PERL_MAGIC_taint:
4604 vtable = &PL_vtbl_taint;
4606 case PERL_MAGIC_uvar:
4607 vtable = &PL_vtbl_uvar;
4609 case PERL_MAGIC_vec:
4610 vtable = &PL_vtbl_vec;
4612 case PERL_MAGIC_arylen_p:
4613 case PERL_MAGIC_rhash:
4614 case PERL_MAGIC_symtab:
4615 case PERL_MAGIC_vstring:
4618 case PERL_MAGIC_utf8:
4619 vtable = &PL_vtbl_utf8;
4621 case PERL_MAGIC_substr:
4622 vtable = &PL_vtbl_substr;
4624 case PERL_MAGIC_defelem:
4625 vtable = &PL_vtbl_defelem;
4627 case PERL_MAGIC_arylen:
4628 vtable = &PL_vtbl_arylen;
4630 case PERL_MAGIC_pos:
4631 vtable = &PL_vtbl_pos;
4633 case PERL_MAGIC_backref:
4634 vtable = &PL_vtbl_backref;
4636 case PERL_MAGIC_hintselem:
4637 vtable = &PL_vtbl_hintselem;
4639 case PERL_MAGIC_ext:
4640 /* Reserved for use by extensions not perl internals. */
4641 /* Useful for attaching extension internal data to perl vars. */
4642 /* Note that multiple extensions may clash if magical scalars */
4643 /* etc holding private data from one are passed to another. */
4647 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4650 /* Rest of work is done else where */
4651 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4654 case PERL_MAGIC_taint:
4657 case PERL_MAGIC_ext:
4658 case PERL_MAGIC_dbfile:
4665 =for apidoc sv_unmagic
4667 Removes all magic of type C<type> from an SV.
4673 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4677 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4679 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4680 for (mg = *mgp; mg; mg = *mgp) {
4681 if (mg->mg_type == type) {
4682 const MGVTBL* const vtbl = mg->mg_virtual;
4683 *mgp = mg->mg_moremagic;
4684 if (vtbl && vtbl->svt_free)
4685 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4686 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4688 Safefree(mg->mg_ptr);
4689 else if (mg->mg_len == HEf_SVKEY)
4690 SvREFCNT_dec((SV*)mg->mg_ptr);
4691 else if (mg->mg_type == PERL_MAGIC_utf8)
4692 Safefree(mg->mg_ptr);
4694 if (mg->mg_flags & MGf_REFCOUNTED)
4695 SvREFCNT_dec(mg->mg_obj);
4699 mgp = &mg->mg_moremagic;
4703 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4704 SvMAGIC_set(sv, NULL);
4711 =for apidoc sv_rvweaken
4713 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4714 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4715 push a back-reference to this RV onto the array of backreferences
4716 associated with that magic. If the RV is magical, set magic will be
4717 called after the RV is cleared.
4723 Perl_sv_rvweaken(pTHX_ SV *sv)
4726 if (!SvOK(sv)) /* let undefs pass */
4729 Perl_croak(aTHX_ "Can't weaken a nonreference");
4730 else if (SvWEAKREF(sv)) {
4731 if (ckWARN(WARN_MISC))
4732 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4736 Perl_sv_add_backref(aTHX_ tsv, sv);
4742 /* Give tsv backref magic if it hasn't already got it, then push a
4743 * back-reference to sv onto the array associated with the backref magic.
4747 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4752 if (SvTYPE(tsv) == SVt_PVHV) {
4753 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4757 /* There is no AV in the offical place - try a fixup. */
4758 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4761 /* Aha. They've got it stowed in magic. Bring it back. */
4762 av = (AV*)mg->mg_obj;
4763 /* Stop mg_free decreasing the refernce count. */
4765 /* Stop mg_free even calling the destructor, given that
4766 there's no AV to free up. */
4768 sv_unmagic(tsv, PERL_MAGIC_backref);
4772 SvREFCNT_inc_simple_void(av);
4777 const MAGIC *const mg
4778 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4780 av = (AV*)mg->mg_obj;
4784 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4785 /* av now has a refcnt of 2, which avoids it getting freed
4786 * before us during global cleanup. The extra ref is removed
4787 * by magic_killbackrefs() when tsv is being freed */
4790 if (AvFILLp(av) >= AvMAX(av)) {
4791 av_extend(av, AvFILLp(av)+1);
4793 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4796 /* delete a back-reference to ourselves from the backref magic associated
4797 * with the SV we point to.
4801 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4808 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4809 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4810 /* We mustn't attempt to "fix up" the hash here by moving the
4811 backreference array back to the hv_aux structure, as that is stored
4812 in the main HvARRAY(), and hfreentries assumes that no-one
4813 reallocates HvARRAY() while it is running. */
4816 const MAGIC *const mg
4817 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4819 av = (AV *)mg->mg_obj;
4822 if (PL_in_clean_all)
4824 Perl_croak(aTHX_ "panic: del_backref");
4831 /* We shouldn't be in here more than once, but for paranoia reasons lets
4833 for (i = AvFILLp(av); i >= 0; i--) {
4835 const SSize_t fill = AvFILLp(av);
4837 /* We weren't the last entry.
4838 An unordered list has this property that you can take the
4839 last element off the end to fill the hole, and it's still
4840 an unordered list :-)
4845 AvFILLp(av) = fill - 1;
4851 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4853 SV **svp = AvARRAY(av);
4855 PERL_UNUSED_ARG(sv);
4857 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4858 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4859 if (svp && !SvIS_FREED(av)) {
4860 SV *const *const last = svp + AvFILLp(av);
4862 while (svp <= last) {
4864 SV *const referrer = *svp;
4865 if (SvWEAKREF(referrer)) {
4866 /* XXX Should we check that it hasn't changed? */
4867 SvRV_set(referrer, 0);
4869 SvWEAKREF_off(referrer);
4870 SvSETMAGIC(referrer);
4871 } else if (SvTYPE(referrer) == SVt_PVGV ||
4872 SvTYPE(referrer) == SVt_PVLV) {
4873 /* You lookin' at me? */
4874 assert(GvSTASH(referrer));
4875 assert(GvSTASH(referrer) == (HV*)sv);
4876 GvSTASH(referrer) = 0;
4879 "panic: magic_killbackrefs (flags=%"UVxf")",
4880 (UV)SvFLAGS(referrer));
4888 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4893 =for apidoc sv_insert
4895 Inserts a string at the specified offset/length within the SV. Similar to
4896 the Perl substr() function.
4902 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4907 register char *midend;
4908 register char *bigend;
4914 Perl_croak(aTHX_ "Can't modify non-existent substring");
4915 SvPV_force(bigstr, curlen);
4916 (void)SvPOK_only_UTF8(bigstr);
4917 if (offset + len > curlen) {
4918 SvGROW(bigstr, offset+len+1);
4919 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4920 SvCUR_set(bigstr, offset+len);
4924 i = littlelen - len;
4925 if (i > 0) { /* string might grow */
4926 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4927 mid = big + offset + len;
4928 midend = bigend = big + SvCUR(bigstr);
4931 while (midend > mid) /* shove everything down */
4932 *--bigend = *--midend;
4933 Move(little,big+offset,littlelen,char);
4934 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4939 Move(little,SvPVX(bigstr)+offset,len,char);
4944 big = SvPVX(bigstr);
4947 bigend = big + SvCUR(bigstr);
4949 if (midend > bigend)
4950 Perl_croak(aTHX_ "panic: sv_insert");
4952 if (mid - big > bigend - midend) { /* faster to shorten from end */
4954 Move(little, mid, littlelen,char);
4957 i = bigend - midend;
4959 Move(midend, mid, i,char);
4963 SvCUR_set(bigstr, mid - big);
4965 else if ((i = mid - big)) { /* faster from front */
4966 midend -= littlelen;
4968 sv_chop(bigstr,midend-i);
4973 Move(little, mid, littlelen,char);
4975 else if (littlelen) {
4976 midend -= littlelen;
4977 sv_chop(bigstr,midend);
4978 Move(little,midend,littlelen,char);
4981 sv_chop(bigstr,midend);
4987 =for apidoc sv_replace
4989 Make the first argument a copy of the second, then delete the original.
4990 The target SV physically takes over ownership of the body of the source SV
4991 and inherits its flags; however, the target keeps any magic it owns,
4992 and any magic in the source is discarded.
4993 Note that this is a rather specialist SV copying operation; most of the
4994 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5000 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5003 const U32 refcnt = SvREFCNT(sv);
5004 SV_CHECK_THINKFIRST_COW_DROP(sv);
5005 if (SvREFCNT(nsv) != 1) {
5006 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5007 UVuf " != 1)", (UV) SvREFCNT(nsv));
5009 if (SvMAGICAL(sv)) {
5013 sv_upgrade(nsv, SVt_PVMG);
5014 SvMAGIC_set(nsv, SvMAGIC(sv));
5015 SvFLAGS(nsv) |= SvMAGICAL(sv);
5017 SvMAGIC_set(sv, NULL);
5021 assert(!SvREFCNT(sv));
5022 #ifdef DEBUG_LEAKING_SCALARS
5023 sv->sv_flags = nsv->sv_flags;
5024 sv->sv_any = nsv->sv_any;
5025 sv->sv_refcnt = nsv->sv_refcnt;
5026 sv->sv_u = nsv->sv_u;
5028 StructCopy(nsv,sv,SV);
5030 /* Currently could join these into one piece of pointer arithmetic, but
5031 it would be unclear. */
5032 if(SvTYPE(sv) == SVt_IV)
5034 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5035 else if (SvTYPE(sv) == SVt_RV) {
5036 SvANY(sv) = &sv->sv_u.svu_rv;
5040 #ifdef PERL_OLD_COPY_ON_WRITE
5041 if (SvIsCOW_normal(nsv)) {
5042 /* We need to follow the pointers around the loop to make the
5043 previous SV point to sv, rather than nsv. */
5046 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5049 assert(SvPVX_const(current) == SvPVX_const(nsv));
5051 /* Make the SV before us point to the SV after us. */
5053 PerlIO_printf(Perl_debug_log, "previous is\n");
5055 PerlIO_printf(Perl_debug_log,
5056 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5057 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5059 SV_COW_NEXT_SV_SET(current, sv);
5062 SvREFCNT(sv) = refcnt;
5063 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5069 =for apidoc sv_clear
5071 Clear an SV: call any destructors, free up any memory used by the body,
5072 and free the body itself. The SV's head is I<not> freed, although
5073 its type is set to all 1's so that it won't inadvertently be assumed
5074 to be live during global destruction etc.
5075 This function should only be called when REFCNT is zero. Most of the time
5076 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5083 Perl_sv_clear(pTHX_ register SV *sv)
5086 const U32 type = SvTYPE(sv);
5087 const struct body_details *const sv_type_details
5088 = bodies_by_type + type;
5092 assert(SvREFCNT(sv) == 0);
5094 if (type <= SVt_IV) {
5095 /* See the comment in sv.h about the collusion between this early
5096 return and the overloading of the NULL and IV slots in the size
5102 if (PL_defstash && /* Still have a symbol table? */
5109 stash = SvSTASH(sv);
5110 destructor = StashHANDLER(stash,DESTROY);
5112 SV* const tmpref = newRV(sv);
5113 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5115 PUSHSTACKi(PERLSI_DESTROY);
5120 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5126 if(SvREFCNT(tmpref) < 2) {
5127 /* tmpref is not kept alive! */
5129 SvRV_set(tmpref, NULL);
5132 SvREFCNT_dec(tmpref);
5134 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5138 if (PL_in_clean_objs)
5139 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5141 /* DESTROY gave object new lease on life */
5147 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5148 SvOBJECT_off(sv); /* Curse the object. */
5149 if (type != SVt_PVIO)
5150 --PL_sv_objcount; /* XXX Might want something more general */
5153 if (type >= SVt_PVMG) {
5154 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5155 SvREFCNT_dec(SvOURSTASH(sv));
5156 } else if (SvMAGIC(sv))
5158 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5159 SvREFCNT_dec(SvSTASH(sv));
5162 /* case SVt_BIND: */
5165 IoIFP(sv) != PerlIO_stdin() &&
5166 IoIFP(sv) != PerlIO_stdout() &&
5167 IoIFP(sv) != PerlIO_stderr())
5169 io_close((IO*)sv, FALSE);
5171 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5172 PerlDir_close(IoDIRP(sv));
5173 IoDIRP(sv) = (DIR*)NULL;
5174 Safefree(IoTOP_NAME(sv));
5175 Safefree(IoFMT_NAME(sv));
5176 Safefree(IoBOTTOM_NAME(sv));
5183 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5187 if (PL_comppad == (AV*)sv) {
5194 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5195 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5196 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5197 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5199 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5200 SvREFCNT_dec(LvTARG(sv));
5202 if (isGV_with_GP(sv)) {
5203 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5204 mro_method_changed_in(stash);
5207 unshare_hek(GvNAME_HEK(sv));
5208 /* If we're in a stash, we don't own a reference to it. However it does
5209 have a back reference to us, which needs to be cleared. */
5210 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5211 sv_del_backref((SV*)stash, sv);
5213 /* FIXME. There are probably more unreferenced pointers to SVs in the
5214 interpreter struct that we should check and tidy in a similar
5216 if ((GV*)sv == PL_last_in_gv)
5217 PL_last_in_gv = NULL;
5222 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5224 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5225 /* Don't even bother with turning off the OOK flag. */
5230 SV * const target = SvRV(sv);
5232 sv_del_backref(target, sv);
5234 SvREFCNT_dec(target);
5236 #ifdef PERL_OLD_COPY_ON_WRITE
5237 else if (SvPVX_const(sv)) {
5239 /* I believe I need to grab the global SV mutex here and
5240 then recheck the COW status. */
5242 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5246 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5248 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5251 /* And drop it here. */
5253 } else if (SvLEN(sv)) {
5254 Safefree(SvPVX_const(sv));
5258 else if (SvPVX_const(sv) && SvLEN(sv))
5259 Safefree(SvPVX_mutable(sv));
5260 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5261 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5270 SvFLAGS(sv) &= SVf_BREAK;
5271 SvFLAGS(sv) |= SVTYPEMASK;
5273 if (sv_type_details->arena) {
5274 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5275 &PL_body_roots[type]);
5277 else if (sv_type_details->body_size) {
5278 my_safefree(SvANY(sv));
5283 =for apidoc sv_newref
5285 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5292 Perl_sv_newref(pTHX_ SV *sv)
5294 PERL_UNUSED_CONTEXT;
5303 Decrement an SV's reference count, and if it drops to zero, call
5304 C<sv_clear> to invoke destructors and free up any memory used by
5305 the body; finally, deallocate the SV's head itself.
5306 Normally called via a wrapper macro C<SvREFCNT_dec>.
5312 Perl_sv_free(pTHX_ SV *sv)
5317 if (SvREFCNT(sv) == 0) {
5318 if (SvFLAGS(sv) & SVf_BREAK)
5319 /* this SV's refcnt has been artificially decremented to
5320 * trigger cleanup */
5322 if (PL_in_clean_all) /* All is fair */
5324 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5325 /* make sure SvREFCNT(sv)==0 happens very seldom */
5326 SvREFCNT(sv) = (~(U32)0)/2;
5329 if (ckWARN_d(WARN_INTERNAL)) {
5330 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5331 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5332 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5333 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5334 Perl_dump_sv_child(aTHX_ sv);
5336 #ifdef DEBUG_LEAKING_SCALARS
5343 if (--(SvREFCNT(sv)) > 0)
5345 Perl_sv_free2(aTHX_ sv);
5349 Perl_sv_free2(pTHX_ SV *sv)
5354 if (ckWARN_d(WARN_DEBUGGING))
5355 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5356 "Attempt to free temp prematurely: SV 0x%"UVxf
5357 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5361 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5362 /* make sure SvREFCNT(sv)==0 happens very seldom */
5363 SvREFCNT(sv) = (~(U32)0)/2;
5374 Returns the length of the string in the SV. Handles magic and type
5375 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5381 Perl_sv_len(pTHX_ register SV *sv)
5389 len = mg_length(sv);
5391 (void)SvPV_const(sv, len);
5396 =for apidoc sv_len_utf8
5398 Returns the number of characters in the string in an SV, counting wide
5399 UTF-8 bytes as a single character. Handles magic and type coercion.
5405 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5406 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5407 * (Note that the mg_len is not the length of the mg_ptr field.
5408 * This allows the cache to store the character length of the string without
5409 * needing to malloc() extra storage to attach to the mg_ptr.)
5414 Perl_sv_len_utf8(pTHX_ register SV *sv)
5420 return mg_length(sv);
5424 const U8 *s = (U8*)SvPV_const(sv, len);
5428 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5430 if (mg && mg->mg_len != -1) {
5432 if (PL_utf8cache < 0) {
5433 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5435 /* Need to turn the assertions off otherwise we may
5436 recurse infinitely while printing error messages.
5438 SAVEI8(PL_utf8cache);
5440 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5441 " real %"UVuf" for %"SVf,
5442 (UV) ulen, (UV) real, SVfARG(sv));
5447 ulen = Perl_utf8_length(aTHX_ s, s + len);
5448 if (!SvREADONLY(sv)) {
5450 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5451 &PL_vtbl_utf8, 0, 0);
5459 return Perl_utf8_length(aTHX_ s, s + len);
5463 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5466 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5469 const U8 *s = start;
5471 while (s < send && uoffset--)
5474 /* This is the existing behaviour. Possibly it should be a croak, as
5475 it's actually a bounds error */
5481 /* Given the length of the string in both bytes and UTF-8 characters, decide
5482 whether to walk forwards or backwards to find the byte corresponding to
5483 the passed in UTF-8 offset. */
5485 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5486 STRLEN uoffset, STRLEN uend)
5488 STRLEN backw = uend - uoffset;
5489 if (uoffset < 2 * backw) {
5490 /* The assumption is that going forwards is twice the speed of going
5491 forward (that's where the 2 * backw comes from).
5492 (The real figure of course depends on the UTF-8 data.) */
5493 return sv_pos_u2b_forwards(start, send, uoffset);
5498 while (UTF8_IS_CONTINUATION(*send))
5501 return send - start;
5504 /* For the string representation of the given scalar, find the byte
5505 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5506 give another position in the string, *before* the sought offset, which
5507 (which is always true, as 0, 0 is a valid pair of positions), which should
5508 help reduce the amount of linear searching.
5509 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5510 will be used to reduce the amount of linear searching. The cache will be
5511 created if necessary, and the found value offered to it for update. */
5513 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5514 const U8 *const send, STRLEN uoffset,
5515 STRLEN uoffset0, STRLEN boffset0) {
5516 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5519 assert (uoffset >= uoffset0);
5521 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5522 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5523 if ((*mgp)->mg_ptr) {
5524 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5525 if (cache[0] == uoffset) {
5526 /* An exact match. */
5529 if (cache[2] == uoffset) {
5530 /* An exact match. */
5534 if (cache[0] < uoffset) {
5535 /* The cache already knows part of the way. */
5536 if (cache[0] > uoffset0) {
5537 /* The cache knows more than the passed in pair */
5538 uoffset0 = cache[0];
5539 boffset0 = cache[1];
5541 if ((*mgp)->mg_len != -1) {
5542 /* And we know the end too. */
5544 + sv_pos_u2b_midway(start + boffset0, send,
5546 (*mgp)->mg_len - uoffset0);
5549 + sv_pos_u2b_forwards(start + boffset0,
5550 send, uoffset - uoffset0);
5553 else if (cache[2] < uoffset) {
5554 /* We're between the two cache entries. */
5555 if (cache[2] > uoffset0) {
5556 /* and the cache knows more than the passed in pair */
5557 uoffset0 = cache[2];
5558 boffset0 = cache[3];
5562 + sv_pos_u2b_midway(start + boffset0,
5565 cache[0] - uoffset0);
5568 + sv_pos_u2b_midway(start + boffset0,
5571 cache[2] - uoffset0);
5575 else if ((*mgp)->mg_len != -1) {
5576 /* If we can take advantage of a passed in offset, do so. */
5577 /* In fact, offset0 is either 0, or less than offset, so don't
5578 need to worry about the other possibility. */
5580 + sv_pos_u2b_midway(start + boffset0, send,
5582 (*mgp)->mg_len - uoffset0);
5587 if (!found || PL_utf8cache < 0) {
5588 const STRLEN real_boffset
5589 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5590 send, uoffset - uoffset0);
5592 if (found && PL_utf8cache < 0) {
5593 if (real_boffset != boffset) {
5594 /* Need to turn the assertions off otherwise we may recurse
5595 infinitely while printing error messages. */
5596 SAVEI8(PL_utf8cache);
5598 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5599 " real %"UVuf" for %"SVf,
5600 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5603 boffset = real_boffset;
5606 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5612 =for apidoc sv_pos_u2b
5614 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5615 the start of the string, to a count of the equivalent number of bytes; if
5616 lenp is non-zero, it does the same to lenp, but this time starting from
5617 the offset, rather than from the start of the string. Handles magic and
5624 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5625 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5626 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5631 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5639 start = (U8*)SvPV_const(sv, len);
5641 STRLEN uoffset = (STRLEN) *offsetp;
5642 const U8 * const send = start + len;
5644 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5647 *offsetp = (I32) boffset;
5650 /* Convert the relative offset to absolute. */
5651 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5652 const STRLEN boffset2
5653 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5654 uoffset, boffset) - boffset;
5668 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5669 byte length pairing. The (byte) length of the total SV is passed in too,
5670 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5671 may not have updated SvCUR, so we can't rely on reading it directly.
5673 The proffered utf8/byte length pairing isn't used if the cache already has
5674 two pairs, and swapping either for the proffered pair would increase the
5675 RMS of the intervals between known byte offsets.
5677 The cache itself consists of 4 STRLEN values
5678 0: larger UTF-8 offset
5679 1: corresponding byte offset
5680 2: smaller UTF-8 offset
5681 3: corresponding byte offset
5683 Unused cache pairs have the value 0, 0.
5684 Keeping the cache "backwards" means that the invariant of
5685 cache[0] >= cache[2] is maintained even with empty slots, which means that
5686 the code that uses it doesn't need to worry if only 1 entry has actually
5687 been set to non-zero. It also makes the "position beyond the end of the
5688 cache" logic much simpler, as the first slot is always the one to start
5692 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5700 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5702 (*mgp)->mg_len = -1;
5706 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5707 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5708 (*mgp)->mg_ptr = (char *) cache;
5712 if (PL_utf8cache < 0) {
5713 const U8 *start = (const U8 *) SvPVX_const(sv);
5714 const STRLEN realutf8 = utf8_length(start, start + byte);
5716 if (realutf8 != utf8) {
5717 /* Need to turn the assertions off otherwise we may recurse
5718 infinitely while printing error messages. */
5719 SAVEI8(PL_utf8cache);
5721 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5722 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5726 /* Cache is held with the later position first, to simplify the code
5727 that deals with unbounded ends. */
5729 ASSERT_UTF8_CACHE(cache);
5730 if (cache[1] == 0) {
5731 /* Cache is totally empty */
5734 } else if (cache[3] == 0) {
5735 if (byte > cache[1]) {
5736 /* New one is larger, so goes first. */
5737 cache[2] = cache[0];
5738 cache[3] = cache[1];
5746 #define THREEWAY_SQUARE(a,b,c,d) \
5747 ((float)((d) - (c))) * ((float)((d) - (c))) \
5748 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5749 + ((float)((b) - (a))) * ((float)((b) - (a)))
5751 /* Cache has 2 slots in use, and we know three potential pairs.
5752 Keep the two that give the lowest RMS distance. Do the
5753 calcualation in bytes simply because we always know the byte
5754 length. squareroot has the same ordering as the positive value,
5755 so don't bother with the actual square root. */
5756 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5757 if (byte > cache[1]) {
5758 /* New position is after 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, cache[1], byte, blen);
5764 if (keep_later < keep_earlier) {
5765 if (keep_later < existing) {
5766 cache[2] = cache[0];
5767 cache[3] = cache[1];
5773 if (keep_earlier < existing) {
5779 else if (byte > cache[3]) {
5780 /* New position is between the existing pair of pairs. */
5781 const float keep_earlier
5782 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5783 const float keep_later
5784 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5786 if (keep_later < keep_earlier) {
5787 if (keep_later < existing) {
5793 if (keep_earlier < existing) {
5800 /* New position is before the existing pair of pairs. */
5801 const float keep_earlier
5802 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5803 const float keep_later
5804 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5806 if (keep_later < keep_earlier) {
5807 if (keep_later < existing) {
5813 if (keep_earlier < existing) {
5814 cache[0] = cache[2];
5815 cache[1] = cache[3];
5822 ASSERT_UTF8_CACHE(cache);
5825 /* We already know all of the way, now we may be able to walk back. The same
5826 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5827 backward is half the speed of walking forward. */
5829 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5832 const STRLEN forw = target - s;
5833 STRLEN backw = end - target;
5835 if (forw < 2 * backw) {
5836 return utf8_length(s, target);
5839 while (end > target) {
5841 while (UTF8_IS_CONTINUATION(*end)) {
5850 =for apidoc sv_pos_b2u
5852 Converts the value pointed to by offsetp from a count of bytes from the
5853 start of the string, to a count of the equivalent number of UTF-8 chars.
5854 Handles magic and type coercion.
5860 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5861 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5866 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5869 const STRLEN byte = *offsetp;
5870 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5879 s = (const U8*)SvPV_const(sv, blen);
5882 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5886 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5887 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5889 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5890 if (cache[1] == byte) {
5891 /* An exact match. */
5892 *offsetp = cache[0];
5895 if (cache[3] == byte) {
5896 /* An exact match. */
5897 *offsetp = cache[2];
5901 if (cache[1] < byte) {
5902 /* We already know part of the way. */
5903 if (mg->mg_len != -1) {
5904 /* Actually, we know the end too. */
5906 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5907 s + blen, mg->mg_len - cache[0]);
5909 len = cache[0] + utf8_length(s + cache[1], send);
5912 else if (cache[3] < byte) {
5913 /* We're between the two cached pairs, so we do the calculation
5914 offset by the byte/utf-8 positions for the earlier pair,
5915 then add the utf-8 characters from the string start to
5917 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5918 s + cache[1], cache[0] - cache[2])
5922 else { /* cache[3] > byte */
5923 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5927 ASSERT_UTF8_CACHE(cache);
5929 } else if (mg->mg_len != -1) {
5930 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5934 if (!found || PL_utf8cache < 0) {
5935 const STRLEN real_len = utf8_length(s, send);
5937 if (found && PL_utf8cache < 0) {
5938 if (len != real_len) {
5939 /* Need to turn the assertions off otherwise we may recurse
5940 infinitely while printing error messages. */
5941 SAVEI8(PL_utf8cache);
5943 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5944 " real %"UVuf" for %"SVf,
5945 (UV) len, (UV) real_len, SVfARG(sv));
5952 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5958 Returns a boolean indicating whether the strings in the two SVs are
5959 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5960 coerce its args to strings if necessary.
5966 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5975 SV* svrecode = NULL;
5982 /* if pv1 and pv2 are the same, second SvPV_const call may
5983 * invalidate pv1, so we may need to make a copy */
5984 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5985 pv1 = SvPV_const(sv1, cur1);
5986 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5987 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5989 pv1 = SvPV_const(sv1, cur1);
5997 pv2 = SvPV_const(sv2, cur2);
5999 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6000 /* Differing utf8ness.
6001 * Do not UTF8size the comparands as a side-effect. */
6004 svrecode = newSVpvn(pv2, cur2);
6005 sv_recode_to_utf8(svrecode, PL_encoding);
6006 pv2 = SvPV_const(svrecode, cur2);
6009 svrecode = newSVpvn(pv1, cur1);
6010 sv_recode_to_utf8(svrecode, PL_encoding);
6011 pv1 = SvPV_const(svrecode, cur1);
6013 /* Now both are in UTF-8. */
6015 SvREFCNT_dec(svrecode);
6020 bool is_utf8 = TRUE;
6023 /* sv1 is the UTF-8 one,
6024 * if is equal it must be downgrade-able */
6025 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6031 /* sv2 is the UTF-8 one,
6032 * if is equal it must be downgrade-able */
6033 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6039 /* Downgrade not possible - cannot be eq */
6047 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6049 SvREFCNT_dec(svrecode);
6059 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6060 string in C<sv1> is less than, equal to, or greater than the string in
6061 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6062 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6068 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6072 const char *pv1, *pv2;
6075 SV *svrecode = NULL;
6082 pv1 = SvPV_const(sv1, cur1);
6089 pv2 = SvPV_const(sv2, cur2);
6091 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6092 /* Differing utf8ness.
6093 * Do not UTF8size the comparands as a side-effect. */
6096 svrecode = newSVpvn(pv2, cur2);
6097 sv_recode_to_utf8(svrecode, PL_encoding);
6098 pv2 = SvPV_const(svrecode, cur2);
6101 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6106 svrecode = newSVpvn(pv1, cur1);
6107 sv_recode_to_utf8(svrecode, PL_encoding);
6108 pv1 = SvPV_const(svrecode, cur1);
6111 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6117 cmp = cur2 ? -1 : 0;
6121 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6124 cmp = retval < 0 ? -1 : 1;
6125 } else if (cur1 == cur2) {
6128 cmp = cur1 < cur2 ? -1 : 1;
6132 SvREFCNT_dec(svrecode);
6140 =for apidoc sv_cmp_locale
6142 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6143 'use bytes' aware, handles get magic, and will coerce its args to strings
6144 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6150 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6153 #ifdef USE_LOCALE_COLLATE
6159 if (PL_collation_standard)
6163 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6165 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6167 if (!pv1 || !len1) {
6178 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6181 return retval < 0 ? -1 : 1;
6184 * When the result of collation is equality, that doesn't mean
6185 * that there are no differences -- some locales exclude some
6186 * characters from consideration. So to avoid false equalities,
6187 * we use the raw string as a tiebreaker.
6193 #endif /* USE_LOCALE_COLLATE */
6195 return sv_cmp(sv1, sv2);
6199 #ifdef USE_LOCALE_COLLATE
6202 =for apidoc sv_collxfrm
6204 Add Collate Transform magic to an SV if it doesn't already have it.
6206 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6207 scalar data of the variable, but transformed to such a format that a normal
6208 memory comparison can be used to compare the data according to the locale
6215 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6220 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6221 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6227 Safefree(mg->mg_ptr);
6228 s = SvPV_const(sv, len);
6229 if ((xf = mem_collxfrm(s, len, &xlen))) {
6230 if (SvREADONLY(sv)) {
6233 return xf + sizeof(PL_collation_ix);
6236 #ifdef PERL_OLD_COPY_ON_WRITE
6238 sv_force_normal_flags(sv, 0);
6240 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6254 if (mg && mg->mg_ptr) {
6256 return mg->mg_ptr + sizeof(PL_collation_ix);
6264 #endif /* USE_LOCALE_COLLATE */
6269 Get a line from the filehandle and store it into the SV, optionally
6270 appending to the currently-stored string.
6276 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6281 register STDCHAR rslast;
6282 register STDCHAR *bp;
6287 if (SvTHINKFIRST(sv))
6288 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6289 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6291 However, perlbench says it's slower, because the existing swipe code
6292 is faster than copy on write.
6293 Swings and roundabouts. */
6294 SvUPGRADE(sv, SVt_PV);
6299 if (PerlIO_isutf8(fp)) {
6301 sv_utf8_upgrade_nomg(sv);
6302 sv_pos_u2b(sv,&append,0);
6304 } else if (SvUTF8(sv)) {
6305 SV * const tsv = newSV(0);
6306 sv_gets(tsv, fp, 0);
6307 sv_utf8_upgrade_nomg(tsv);
6308 SvCUR_set(sv,append);
6311 goto return_string_or_null;
6316 if (PerlIO_isutf8(fp))
6319 if (IN_PERL_COMPILETIME) {
6320 /* we always read code in line mode */
6324 else if (RsSNARF(PL_rs)) {
6325 /* If it is a regular disk file use size from stat() as estimate
6326 of amount we are going to read -- may result in mallocing
6327 more memory than we really need if the layers below reduce
6328 the size we read (e.g. CRLF or a gzip layer).
6331 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6332 const Off_t offset = PerlIO_tell(fp);
6333 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6334 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6340 else if (RsRECORD(PL_rs)) {
6345 /* Grab the size of the record we're getting */
6346 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6347 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6350 /* VMS wants read instead of fread, because fread doesn't respect */
6351 /* RMS record boundaries. This is not necessarily a good thing to be */
6352 /* doing, but we've got no other real choice - except avoid stdio
6353 as implementation - perhaps write a :vms layer ?
6355 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6357 bytesread = PerlIO_read(fp, buffer, recsize);
6361 SvCUR_set(sv, bytesread += append);
6362 buffer[bytesread] = '\0';
6363 goto return_string_or_null;
6365 else if (RsPARA(PL_rs)) {
6371 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6372 if (PerlIO_isutf8(fp)) {
6373 rsptr = SvPVutf8(PL_rs, rslen);
6376 if (SvUTF8(PL_rs)) {
6377 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6378 Perl_croak(aTHX_ "Wide character in $/");
6381 rsptr = SvPV_const(PL_rs, rslen);
6385 rslast = rslen ? rsptr[rslen - 1] : '\0';
6387 if (rspara) { /* have to do this both before and after */
6388 do { /* to make sure file boundaries work right */
6391 i = PerlIO_getc(fp);
6395 PerlIO_ungetc(fp,i);
6401 /* See if we know enough about I/O mechanism to cheat it ! */
6403 /* This used to be #ifdef test - it is made run-time test for ease
6404 of abstracting out stdio interface. One call should be cheap
6405 enough here - and may even be a macro allowing compile
6409 if (PerlIO_fast_gets(fp)) {
6412 * We're going to steal some values from the stdio struct
6413 * and put EVERYTHING in the innermost loop into registers.
6415 register STDCHAR *ptr;
6419 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6420 /* An ungetc()d char is handled separately from the regular
6421 * buffer, so we getc() it back out and stuff it in the buffer.
6423 i = PerlIO_getc(fp);
6424 if (i == EOF) return 0;
6425 *(--((*fp)->_ptr)) = (unsigned char) i;
6429 /* Here is some breathtakingly efficient cheating */
6431 cnt = PerlIO_get_cnt(fp); /* get count into register */
6432 /* make sure we have the room */
6433 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6434 /* Not room for all of it
6435 if we are looking for a separator and room for some
6437 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6438 /* just process what we have room for */
6439 shortbuffered = cnt - SvLEN(sv) + append + 1;
6440 cnt -= shortbuffered;
6444 /* remember that cnt can be negative */
6445 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6450 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6451 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6452 DEBUG_P(PerlIO_printf(Perl_debug_log,
6453 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6454 DEBUG_P(PerlIO_printf(Perl_debug_log,
6455 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6456 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6457 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6462 while (cnt > 0) { /* this | eat */
6464 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6465 goto thats_all_folks; /* screams | sed :-) */
6469 Copy(ptr, bp, cnt, char); /* this | eat */
6470 bp += cnt; /* screams | dust */
6471 ptr += cnt; /* louder | sed :-) */
6476 if (shortbuffered) { /* oh well, must extend */
6477 cnt = shortbuffered;
6479 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6481 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6482 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6486 DEBUG_P(PerlIO_printf(Perl_debug_log,
6487 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6488 PTR2UV(ptr),(long)cnt));
6489 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6491 DEBUG_P(PerlIO_printf(Perl_debug_log,
6492 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6493 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6494 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6496 /* This used to call 'filbuf' in stdio form, but as that behaves like
6497 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6498 another abstraction. */
6499 i = PerlIO_getc(fp); /* get more characters */
6501 DEBUG_P(PerlIO_printf(Perl_debug_log,
6502 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6503 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6504 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6506 cnt = PerlIO_get_cnt(fp);
6507 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6508 DEBUG_P(PerlIO_printf(Perl_debug_log,
6509 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6511 if (i == EOF) /* all done for ever? */
6512 goto thats_really_all_folks;
6514 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6516 SvGROW(sv, bpx + cnt + 2);
6517 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6519 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6521 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6522 goto thats_all_folks;
6526 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6527 memNE((char*)bp - rslen, rsptr, rslen))
6528 goto screamer; /* go back to the fray */
6529 thats_really_all_folks:
6531 cnt += shortbuffered;
6532 DEBUG_P(PerlIO_printf(Perl_debug_log,
6533 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6534 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6535 DEBUG_P(PerlIO_printf(Perl_debug_log,
6536 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6537 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6538 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6540 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6541 DEBUG_P(PerlIO_printf(Perl_debug_log,
6542 "Screamer: done, len=%ld, string=|%.*s|\n",
6543 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6547 /*The big, slow, and stupid way. */
6548 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6549 STDCHAR *buf = NULL;
6550 Newx(buf, 8192, STDCHAR);
6558 register const STDCHAR * const bpe = buf + sizeof(buf);
6560 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6561 ; /* keep reading */
6565 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6566 /* Accomodate broken VAXC compiler, which applies U8 cast to
6567 * both args of ?: operator, causing EOF to change into 255
6570 i = (U8)buf[cnt - 1];
6576 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6578 sv_catpvn(sv, (char *) buf, cnt);
6580 sv_setpvn(sv, (char *) buf, cnt);
6582 if (i != EOF && /* joy */
6584 SvCUR(sv) < rslen ||
6585 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6589 * If we're reading from a TTY and we get a short read,
6590 * indicating that the user hit his EOF character, we need
6591 * to notice it now, because if we try to read from the TTY
6592 * again, the EOF condition will disappear.
6594 * The comparison of cnt to sizeof(buf) is an optimization
6595 * that prevents unnecessary calls to feof().
6599 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6603 #ifdef USE_HEAP_INSTEAD_OF_STACK
6608 if (rspara) { /* have to do this both before and after */
6609 while (i != EOF) { /* to make sure file boundaries work right */
6610 i = PerlIO_getc(fp);
6612 PerlIO_ungetc(fp,i);
6618 return_string_or_null:
6619 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6625 Auto-increment of the value in the SV, doing string to numeric conversion
6626 if necessary. Handles 'get' magic.
6632 Perl_sv_inc(pTHX_ register SV *sv)
6641 if (SvTHINKFIRST(sv)) {
6643 sv_force_normal_flags(sv, 0);
6644 if (SvREADONLY(sv)) {
6645 if (IN_PERL_RUNTIME)
6646 Perl_croak(aTHX_ PL_no_modify);
6650 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6652 i = PTR2IV(SvRV(sv));
6657 flags = SvFLAGS(sv);
6658 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6659 /* It's (privately or publicly) a float, but not tested as an
6660 integer, so test it to see. */
6662 flags = SvFLAGS(sv);
6664 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6665 /* It's publicly an integer, or privately an integer-not-float */
6666 #ifdef PERL_PRESERVE_IVUV
6670 if (SvUVX(sv) == UV_MAX)
6671 sv_setnv(sv, UV_MAX_P1);
6673 (void)SvIOK_only_UV(sv);
6674 SvUV_set(sv, SvUVX(sv) + 1);
6676 if (SvIVX(sv) == IV_MAX)
6677 sv_setuv(sv, (UV)IV_MAX + 1);
6679 (void)SvIOK_only(sv);
6680 SvIV_set(sv, SvIVX(sv) + 1);
6685 if (flags & SVp_NOK) {
6686 (void)SvNOK_only(sv);
6687 SvNV_set(sv, SvNVX(sv) + 1.0);
6691 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6692 if ((flags & SVTYPEMASK) < SVt_PVIV)
6693 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6694 (void)SvIOK_only(sv);
6699 while (isALPHA(*d)) d++;
6700 while (isDIGIT(*d)) d++;
6702 #ifdef PERL_PRESERVE_IVUV
6703 /* Got to punt this as an integer if needs be, but we don't issue
6704 warnings. Probably ought to make the sv_iv_please() that does
6705 the conversion if possible, and silently. */
6706 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6707 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6708 /* Need to try really hard to see if it's an integer.
6709 9.22337203685478e+18 is an integer.
6710 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6711 so $a="9.22337203685478e+18"; $a+0; $a++
6712 needs to be the same as $a="9.22337203685478e+18"; $a++
6719 /* sv_2iv *should* have made this an NV */
6720 if (flags & SVp_NOK) {
6721 (void)SvNOK_only(sv);
6722 SvNV_set(sv, SvNVX(sv) + 1.0);
6725 /* I don't think we can get here. Maybe I should assert this
6726 And if we do get here I suspect that sv_setnv will croak. NWC
6728 #if defined(USE_LONG_DOUBLE)
6729 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",
6730 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6732 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6733 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6736 #endif /* PERL_PRESERVE_IVUV */
6737 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6741 while (d >= SvPVX_const(sv)) {
6749 /* MKS: The original code here died if letters weren't consecutive.
6750 * at least it didn't have to worry about non-C locales. The
6751 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6752 * arranged in order (although not consecutively) and that only
6753 * [A-Za-z] are accepted by isALPHA in the C locale.
6755 if (*d != 'z' && *d != 'Z') {
6756 do { ++*d; } while (!isALPHA(*d));
6759 *(d--) -= 'z' - 'a';
6764 *(d--) -= 'z' - 'a' + 1;
6768 /* oh,oh, the number grew */
6769 SvGROW(sv, SvCUR(sv) + 2);
6770 SvCUR_set(sv, SvCUR(sv) + 1);
6771 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6782 Auto-decrement of the value in the SV, doing string to numeric conversion
6783 if necessary. Handles 'get' magic.
6789 Perl_sv_dec(pTHX_ register SV *sv)
6797 if (SvTHINKFIRST(sv)) {
6799 sv_force_normal_flags(sv, 0);
6800 if (SvREADONLY(sv)) {
6801 if (IN_PERL_RUNTIME)
6802 Perl_croak(aTHX_ PL_no_modify);
6806 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6808 i = PTR2IV(SvRV(sv));
6813 /* Unlike sv_inc we don't have to worry about string-never-numbers
6814 and keeping them magic. But we mustn't warn on punting */
6815 flags = SvFLAGS(sv);
6816 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6817 /* It's publicly an integer, or privately an integer-not-float */
6818 #ifdef PERL_PRESERVE_IVUV
6822 if (SvUVX(sv) == 0) {
6823 (void)SvIOK_only(sv);
6827 (void)SvIOK_only_UV(sv);
6828 SvUV_set(sv, SvUVX(sv) - 1);
6831 if (SvIVX(sv) == IV_MIN)
6832 sv_setnv(sv, (NV)IV_MIN - 1.0);
6834 (void)SvIOK_only(sv);
6835 SvIV_set(sv, SvIVX(sv) - 1);
6840 if (flags & SVp_NOK) {
6841 SvNV_set(sv, SvNVX(sv) - 1.0);
6842 (void)SvNOK_only(sv);
6845 if (!(flags & SVp_POK)) {
6846 if ((flags & SVTYPEMASK) < SVt_PVIV)
6847 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6849 (void)SvIOK_only(sv);
6852 #ifdef PERL_PRESERVE_IVUV
6854 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6855 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6856 /* Need to try really hard to see if it's an integer.
6857 9.22337203685478e+18 is an integer.
6858 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6859 so $a="9.22337203685478e+18"; $a+0; $a--
6860 needs to be the same as $a="9.22337203685478e+18"; $a--
6867 /* sv_2iv *should* have made this an NV */
6868 if (flags & SVp_NOK) {
6869 (void)SvNOK_only(sv);
6870 SvNV_set(sv, SvNVX(sv) - 1.0);
6873 /* I don't think we can get here. Maybe I should assert this
6874 And if we do get here I suspect that sv_setnv will croak. NWC
6876 #if defined(USE_LONG_DOUBLE)
6877 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",
6878 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6880 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6881 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6885 #endif /* PERL_PRESERVE_IVUV */
6886 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6890 =for apidoc sv_mortalcopy
6892 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6893 The new SV is marked as mortal. It will be destroyed "soon", either by an
6894 explicit call to FREETMPS, or by an implicit call at places such as
6895 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6900 /* Make a string that will exist for the duration of the expression
6901 * evaluation. Actually, it may have to last longer than that, but
6902 * hopefully we won't free it until it has been assigned to a
6903 * permanent location. */
6906 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6912 sv_setsv(sv,oldstr);
6914 PL_tmps_stack[++PL_tmps_ix] = sv;
6920 =for apidoc sv_newmortal
6922 Creates a new null SV which is mortal. The reference count of the SV is
6923 set to 1. It will be destroyed "soon", either by an explicit call to
6924 FREETMPS, or by an implicit call at places such as statement boundaries.
6925 See also C<sv_mortalcopy> and C<sv_2mortal>.
6931 Perl_sv_newmortal(pTHX)
6937 SvFLAGS(sv) = SVs_TEMP;
6939 PL_tmps_stack[++PL_tmps_ix] = sv;
6944 =for apidoc sv_2mortal
6946 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6947 by an explicit call to FREETMPS, or by an implicit call at places such as
6948 statement boundaries. SvTEMP() is turned on which means that the SV's
6949 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6950 and C<sv_mortalcopy>.
6956 Perl_sv_2mortal(pTHX_ register SV *sv)
6961 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6964 PL_tmps_stack[++PL_tmps_ix] = sv;
6972 Creates a new SV and copies a string into it. The reference count for the
6973 SV is set to 1. If C<len> is zero, Perl will compute the length using
6974 strlen(). For efficiency, consider using C<newSVpvn> instead.
6980 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6986 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6991 =for apidoc newSVpvn
6993 Creates a new SV and copies a string into it. The reference count for the
6994 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
6995 string. You are responsible for ensuring that the source string is at least
6996 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7002 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7008 sv_setpvn(sv,s,len);
7014 =for apidoc newSVhek
7016 Creates a new SV from the hash key structure. It will generate scalars that
7017 point to the shared string table where possible. Returns a new (undefined)
7018 SV if the hek is NULL.
7024 Perl_newSVhek(pTHX_ const HEK *hek)
7034 if (HEK_LEN(hek) == HEf_SVKEY) {
7035 return newSVsv(*(SV**)HEK_KEY(hek));
7037 const int flags = HEK_FLAGS(hek);
7038 if (flags & HVhek_WASUTF8) {
7040 Andreas would like keys he put in as utf8 to come back as utf8
7042 STRLEN utf8_len = HEK_LEN(hek);
7043 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7044 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7047 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7049 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7050 /* We don't have a pointer to the hv, so we have to replicate the
7051 flag into every HEK. This hv is using custom a hasing
7052 algorithm. Hence we can't return a shared string scalar, as
7053 that would contain the (wrong) hash value, and might get passed
7054 into an hv routine with a regular hash.
7055 Similarly, a hash that isn't using shared hash keys has to have
7056 the flag in every key so that we know not to try to call
7057 share_hek_kek on it. */
7059 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7064 /* This will be overwhelminly the most common case. */
7066 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7067 more efficient than sharepvn(). */
7071 sv_upgrade(sv, SVt_PV);
7072 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7073 SvCUR_set(sv, HEK_LEN(hek));
7086 =for apidoc newSVpvn_share
7088 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7089 table. If the string does not already exist in the table, it is created
7090 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7091 value is used; otherwise the hash is computed. The string's hash can be later
7092 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7093 that as the string table is used for shared hash keys these strings will have
7094 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7100 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7104 bool is_utf8 = FALSE;
7105 const char *const orig_src = src;
7108 STRLEN tmplen = -len;
7110 /* See the note in hv.c:hv_fetch() --jhi */
7111 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7115 PERL_HASH(hash, src, len);
7117 sv_upgrade(sv, SVt_PV);
7118 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7126 if (src != orig_src)
7132 #if defined(PERL_IMPLICIT_CONTEXT)
7134 /* pTHX_ magic can't cope with varargs, so this is a no-context
7135 * version of the main function, (which may itself be aliased to us).
7136 * Don't access this version directly.
7140 Perl_newSVpvf_nocontext(const char* pat, ...)
7145 va_start(args, pat);
7146 sv = vnewSVpvf(pat, &args);
7153 =for apidoc newSVpvf
7155 Creates a new SV and initializes it with the string formatted like
7162 Perl_newSVpvf(pTHX_ const char* pat, ...)
7166 va_start(args, pat);
7167 sv = vnewSVpvf(pat, &args);
7172 /* backend for newSVpvf() and newSVpvf_nocontext() */
7175 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7180 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7187 Creates a new SV and copies a floating point value into it.
7188 The reference count for the SV is set to 1.
7194 Perl_newSVnv(pTHX_ NV n)
7207 Creates a new SV and copies an integer into it. The reference count for the
7214 Perl_newSViv(pTHX_ IV i)
7227 Creates a new SV and copies an unsigned integer into it.
7228 The reference count for the SV is set to 1.
7234 Perl_newSVuv(pTHX_ UV u)
7245 =for apidoc newSV_type
7247 Creates a new SV, of the type specified. The reference count for the new SV
7254 Perl_newSV_type(pTHX_ svtype type)
7259 sv_upgrade(sv, type);
7264 =for apidoc newRV_noinc
7266 Creates an RV wrapper for an SV. The reference count for the original
7267 SV is B<not> incremented.
7273 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7276 register SV *sv = newSV_type(SVt_RV);
7278 SvRV_set(sv, tmpRef);
7283 /* newRV_inc is the official function name to use now.
7284 * newRV_inc is in fact #defined to newRV in sv.h
7288 Perl_newRV(pTHX_ SV *sv)
7291 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7297 Creates a new SV which is an exact duplicate of the original SV.
7304 Perl_newSVsv(pTHX_ register SV *old)
7311 if (SvTYPE(old) == SVTYPEMASK) {
7312 if (ckWARN_d(WARN_INTERNAL))
7313 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7317 /* SV_GMAGIC is the default for sv_setv()
7318 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7319 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7320 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7325 =for apidoc sv_reset
7327 Underlying implementation for the C<reset> Perl function.
7328 Note that the perl-level function is vaguely deprecated.
7334 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7337 char todo[PERL_UCHAR_MAX+1];
7342 if (!*s) { /* reset ?? searches */
7343 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7345 const U32 count = mg->mg_len / sizeof(PMOP**);
7346 PMOP **pmp = (PMOP**) mg->mg_ptr;
7347 PMOP *const *const end = pmp + count;
7351 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7353 (*pmp)->op_pmflags &= ~PMf_USED;
7361 /* reset variables */
7363 if (!HvARRAY(stash))
7366 Zero(todo, 256, char);
7369 I32 i = (unsigned char)*s;
7373 max = (unsigned char)*s++;
7374 for ( ; i <= max; i++) {
7377 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7379 for (entry = HvARRAY(stash)[i];
7381 entry = HeNEXT(entry))
7386 if (!todo[(U8)*HeKEY(entry)])
7388 gv = (GV*)HeVAL(entry);
7391 if (SvTHINKFIRST(sv)) {
7392 if (!SvREADONLY(sv) && SvROK(sv))
7394 /* XXX Is this continue a bug? Why should THINKFIRST
7395 exempt us from resetting arrays and hashes? */
7399 if (SvTYPE(sv) >= SVt_PV) {
7401 if (SvPVX_const(sv) != NULL)
7409 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7411 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7414 # if defined(USE_ENVIRON_ARRAY)
7417 # endif /* USE_ENVIRON_ARRAY */
7428 Using various gambits, try to get an IO from an SV: the IO slot if its a
7429 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7430 named after the PV if we're a string.
7436 Perl_sv_2io(pTHX_ SV *sv)
7441 switch (SvTYPE(sv)) {
7449 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7453 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7455 return sv_2io(SvRV(sv));
7456 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7462 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7471 Using various gambits, try to get a CV from an SV; in addition, try if
7472 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7473 The flags in C<lref> are passed to sv_fetchsv.
7479 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7490 switch (SvTYPE(sv)) {
7509 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7510 tryAMAGICunDEREF(to_cv);
7513 if (SvTYPE(sv) == SVt_PVCV) {
7522 Perl_croak(aTHX_ "Not a subroutine reference");
7527 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7533 /* Some flags to gv_fetchsv mean don't really create the GV */
7534 if (SvTYPE(gv) != SVt_PVGV) {
7540 if (lref && !GvCVu(gv)) {
7544 gv_efullname3(tmpsv, gv, NULL);
7545 /* XXX this is probably not what they think they're getting.
7546 * It has the same effect as "sub name;", i.e. just a forward
7548 newSUB(start_subparse(FALSE, 0),
7549 newSVOP(OP_CONST, 0, tmpsv),
7553 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7563 Returns true if the SV has a true value by Perl's rules.
7564 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7565 instead use an in-line version.
7571 Perl_sv_true(pTHX_ register SV *sv)
7576 register const XPV* const tXpv = (XPV*)SvANY(sv);
7578 (tXpv->xpv_cur > 1 ||
7579 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7586 return SvIVX(sv) != 0;
7589 return SvNVX(sv) != 0.0;
7591 return sv_2bool(sv);
7597 =for apidoc sv_pvn_force
7599 Get a sensible string out of the SV somehow.
7600 A private implementation of the C<SvPV_force> macro for compilers which
7601 can't cope with complex macro expressions. Always use the macro instead.
7603 =for apidoc sv_pvn_force_flags
7605 Get a sensible string out of the SV somehow.
7606 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7607 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7608 implemented in terms of this function.
7609 You normally want to use the various wrapper macros instead: see
7610 C<SvPV_force> and C<SvPV_force_nomg>
7616 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7619 if (SvTHINKFIRST(sv) && !SvROK(sv))
7620 sv_force_normal_flags(sv, 0);
7630 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7631 const char * const ref = sv_reftype(sv,0);
7633 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7634 ref, OP_NAME(PL_op));
7636 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7638 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7639 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7641 s = sv_2pv_flags(sv, &len, flags);
7645 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7648 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7649 SvGROW(sv, len + 1);
7650 Move(s,SvPVX(sv),len,char);
7652 SvPVX(sv)[len] = '\0';
7655 SvPOK_on(sv); /* validate pointer */
7657 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7658 PTR2UV(sv),SvPVX_const(sv)));
7661 return SvPVX_mutable(sv);
7665 =for apidoc sv_pvbyten_force
7667 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7673 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7675 sv_pvn_force(sv,lp);
7676 sv_utf8_downgrade(sv,0);
7682 =for apidoc sv_pvutf8n_force
7684 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7690 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7692 sv_pvn_force(sv,lp);
7693 sv_utf8_upgrade(sv);
7699 =for apidoc sv_reftype
7701 Returns a string describing what the SV is a reference to.
7707 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7709 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7710 inside return suggests a const propagation bug in g++. */
7711 if (ob && SvOBJECT(sv)) {
7712 char * const name = HvNAME_get(SvSTASH(sv));
7713 return name ? name : (char *) "__ANON__";
7716 switch (SvTYPE(sv)) {
7732 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7733 /* tied lvalues should appear to be
7734 * scalars for backwards compatitbility */
7735 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7736 ? "SCALAR" : "LVALUE");
7737 case SVt_PVAV: return "ARRAY";
7738 case SVt_PVHV: return "HASH";
7739 case SVt_PVCV: return "CODE";
7740 case SVt_PVGV: return "GLOB";
7741 case SVt_PVFM: return "FORMAT";
7742 case SVt_PVIO: return "IO";
7743 case SVt_BIND: return "BIND";
7744 default: return "UNKNOWN";
7750 =for apidoc sv_isobject
7752 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7753 object. If the SV is not an RV, or if the object is not blessed, then this
7760 Perl_sv_isobject(pTHX_ SV *sv)
7776 Returns a boolean indicating whether the SV is blessed into the specified
7777 class. This does not check for subtypes; use C<sv_derived_from> to verify
7778 an inheritance relationship.
7784 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7795 hvname = HvNAME_get(SvSTASH(sv));
7799 return strEQ(hvname, name);
7805 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7806 it will be upgraded to one. If C<classname> is non-null then the new SV will
7807 be blessed in the specified package. The new SV is returned and its
7808 reference count is 1.
7814 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7821 SV_CHECK_THINKFIRST_COW_DROP(rv);
7822 (void)SvAMAGIC_off(rv);
7824 if (SvTYPE(rv) >= SVt_PVMG) {
7825 const U32 refcnt = SvREFCNT(rv);
7829 SvREFCNT(rv) = refcnt;
7831 sv_upgrade(rv, SVt_RV);
7832 } else if (SvROK(rv)) {
7833 SvREFCNT_dec(SvRV(rv));
7834 } else if (SvTYPE(rv) < SVt_RV)
7835 sv_upgrade(rv, SVt_RV);
7836 else if (SvTYPE(rv) > SVt_RV) {
7847 HV* const stash = gv_stashpv(classname, GV_ADD);
7848 (void)sv_bless(rv, stash);
7854 =for apidoc sv_setref_pv
7856 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7857 argument will be upgraded to an RV. That RV will be modified to point to
7858 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7859 into the SV. The C<classname> argument indicates the package for the
7860 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7861 will have a reference count of 1, and the RV will be returned.
7863 Do not use with other Perl types such as HV, AV, SV, CV, because those
7864 objects will become corrupted by the pointer copy process.
7866 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7872 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7876 sv_setsv(rv, &PL_sv_undef);
7880 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7885 =for apidoc sv_setref_iv
7887 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7888 argument will be upgraded to an RV. That RV will be modified to point to
7889 the new SV. The C<classname> argument indicates the package for the
7890 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7891 will have a reference count of 1, and the RV will be returned.
7897 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7899 sv_setiv(newSVrv(rv,classname), iv);
7904 =for apidoc sv_setref_uv
7906 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7907 argument will be upgraded to an RV. That RV will be modified to point to
7908 the new SV. The C<classname> argument indicates the package for the
7909 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7910 will have a reference count of 1, and the RV will be returned.
7916 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7918 sv_setuv(newSVrv(rv,classname), uv);
7923 =for apidoc sv_setref_nv
7925 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7926 argument will be upgraded to an RV. That RV will be modified to point to
7927 the new SV. The C<classname> argument indicates the package for the
7928 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7929 will have a reference count of 1, and the RV will be returned.
7935 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7937 sv_setnv(newSVrv(rv,classname), nv);
7942 =for apidoc sv_setref_pvn
7944 Copies a string into a new SV, optionally blessing the SV. The length of the
7945 string must be specified with C<n>. The C<rv> argument will be upgraded to
7946 an RV. That RV will be modified to point to the new SV. The C<classname>
7947 argument indicates the package for the blessing. Set C<classname> to
7948 C<NULL> to avoid the blessing. The new SV will have a reference count
7949 of 1, and the RV will be returned.
7951 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7957 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7959 sv_setpvn(newSVrv(rv,classname), pv, n);
7964 =for apidoc sv_bless
7966 Blesses an SV into a specified package. The SV must be an RV. The package
7967 must be designated by its stash (see C<gv_stashpv()>). The reference count
7968 of the SV is unaffected.
7974 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7979 Perl_croak(aTHX_ "Can't bless non-reference value");
7981 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7982 if (SvIsCOW(tmpRef))
7983 sv_force_normal_flags(tmpRef, 0);
7984 if (SvREADONLY(tmpRef))
7985 Perl_croak(aTHX_ PL_no_modify);
7986 if (SvOBJECT(tmpRef)) {
7987 if (SvTYPE(tmpRef) != SVt_PVIO)
7989 SvREFCNT_dec(SvSTASH(tmpRef));
7992 SvOBJECT_on(tmpRef);
7993 if (SvTYPE(tmpRef) != SVt_PVIO)
7995 SvUPGRADE(tmpRef, SVt_PVMG);
7996 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8001 (void)SvAMAGIC_off(sv);
8003 if(SvSMAGICAL(tmpRef))
8004 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8012 /* Downgrades a PVGV to a PVMG.
8016 S_sv_unglob(pTHX_ SV *sv)
8021 SV * const temp = sv_newmortal();
8023 assert(SvTYPE(sv) == SVt_PVGV);
8025 gv_efullname3(temp, (GV *) sv, "*");
8028 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8029 mro_method_changed_in(stash);
8033 sv_del_backref((SV*)GvSTASH(sv), sv);
8037 if (GvNAME_HEK(sv)) {
8038 unshare_hek(GvNAME_HEK(sv));
8040 isGV_with_GP_off(sv);
8042 /* need to keep SvANY(sv) in the right arena */
8043 xpvmg = new_XPVMG();
8044 StructCopy(SvANY(sv), xpvmg, XPVMG);
8045 del_XPVGV(SvANY(sv));
8048 SvFLAGS(sv) &= ~SVTYPEMASK;
8049 SvFLAGS(sv) |= SVt_PVMG;
8051 /* Intentionally not calling any local SET magic, as this isn't so much a
8052 set operation as merely an internal storage change. */
8053 sv_setsv_flags(sv, temp, 0);
8057 =for apidoc sv_unref_flags
8059 Unsets the RV status of the SV, and decrements the reference count of
8060 whatever was being referenced by the RV. This can almost be thought of
8061 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8062 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8063 (otherwise the decrementing is conditional on the reference count being
8064 different from one or the reference being a readonly SV).
8071 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8073 SV* const target = SvRV(ref);
8075 if (SvWEAKREF(ref)) {
8076 sv_del_backref(target, ref);
8078 SvRV_set(ref, NULL);
8081 SvRV_set(ref, NULL);
8083 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8084 assigned to as BEGIN {$a = \"Foo"} will fail. */
8085 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8086 SvREFCNT_dec(target);
8087 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8088 sv_2mortal(target); /* Schedule for freeing later */
8092 =for apidoc sv_untaint
8094 Untaint an SV. Use C<SvTAINTED_off> instead.
8099 Perl_sv_untaint(pTHX_ SV *sv)
8101 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8102 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8109 =for apidoc sv_tainted
8111 Test an SV for taintedness. Use C<SvTAINTED> instead.
8116 Perl_sv_tainted(pTHX_ SV *sv)
8118 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8119 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8120 if (mg && (mg->mg_len & 1) )
8127 =for apidoc sv_setpviv
8129 Copies an integer into the given SV, also updating its string value.
8130 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8136 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8138 char buf[TYPE_CHARS(UV)];
8140 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8142 sv_setpvn(sv, ptr, ebuf - ptr);
8146 =for apidoc sv_setpviv_mg
8148 Like C<sv_setpviv>, but also handles 'set' magic.
8154 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8160 #if defined(PERL_IMPLICIT_CONTEXT)
8162 /* pTHX_ magic can't cope with varargs, so this is a no-context
8163 * version of the main function, (which may itself be aliased to us).
8164 * Don't access this version directly.
8168 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8172 va_start(args, pat);
8173 sv_vsetpvf(sv, pat, &args);
8177 /* pTHX_ magic can't cope with varargs, so this is a no-context
8178 * version of the main function, (which may itself be aliased to us).
8179 * Don't access this version directly.
8183 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8187 va_start(args, pat);
8188 sv_vsetpvf_mg(sv, pat, &args);
8194 =for apidoc sv_setpvf
8196 Works like C<sv_catpvf> but copies the text into the SV instead of
8197 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8203 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8206 va_start(args, pat);
8207 sv_vsetpvf(sv, pat, &args);
8212 =for apidoc sv_vsetpvf
8214 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8215 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8217 Usually used via its frontend C<sv_setpvf>.
8223 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8225 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8229 =for apidoc sv_setpvf_mg
8231 Like C<sv_setpvf>, but also handles 'set' magic.
8237 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8240 va_start(args, pat);
8241 sv_vsetpvf_mg(sv, pat, &args);
8246 =for apidoc sv_vsetpvf_mg
8248 Like C<sv_vsetpvf>, but also handles 'set' magic.
8250 Usually used via its frontend C<sv_setpvf_mg>.
8256 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8258 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8262 #if defined(PERL_IMPLICIT_CONTEXT)
8264 /* pTHX_ magic can't cope with varargs, so this is a no-context
8265 * version of the main function, (which may itself be aliased to us).
8266 * Don't access this version directly.
8270 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8274 va_start(args, pat);
8275 sv_vcatpvf(sv, pat, &args);
8279 /* pTHX_ magic can't cope with varargs, so this is a no-context
8280 * version of the main function, (which may itself be aliased to us).
8281 * Don't access this version directly.
8285 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8289 va_start(args, pat);
8290 sv_vcatpvf_mg(sv, pat, &args);
8296 =for apidoc sv_catpvf
8298 Processes its arguments like C<sprintf> and appends the formatted
8299 output to an SV. If the appended data contains "wide" characters
8300 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8301 and characters >255 formatted with %c), the original SV might get
8302 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8303 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8304 valid UTF-8; if the original SV was bytes, the pattern should be too.
8309 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8312 va_start(args, pat);
8313 sv_vcatpvf(sv, pat, &args);
8318 =for apidoc sv_vcatpvf
8320 Processes its arguments like C<vsprintf> and appends the formatted output
8321 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8323 Usually used via its frontend C<sv_catpvf>.
8329 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8331 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8335 =for apidoc sv_catpvf_mg
8337 Like C<sv_catpvf>, but also handles 'set' magic.
8343 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8346 va_start(args, pat);
8347 sv_vcatpvf_mg(sv, pat, &args);
8352 =for apidoc sv_vcatpvf_mg
8354 Like C<sv_vcatpvf>, but also handles 'set' magic.
8356 Usually used via its frontend C<sv_catpvf_mg>.
8362 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8364 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8369 =for apidoc sv_vsetpvfn
8371 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8374 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8380 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8382 sv_setpvn(sv, "", 0);
8383 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8387 S_expect_number(pTHX_ char** pattern)
8391 switch (**pattern) {
8392 case '1': case '2': case '3':
8393 case '4': case '5': case '6':
8394 case '7': case '8': case '9':
8395 var = *(*pattern)++ - '0';
8396 while (isDIGIT(**pattern)) {
8397 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8399 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8407 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8409 const int neg = nv < 0;
8418 if (uv & 1 && uv == nv)
8419 uv--; /* Round to even */
8421 const unsigned dig = uv % 10;
8434 =for apidoc sv_vcatpvfn
8436 Processes its arguments like C<vsprintf> and appends the formatted output
8437 to an SV. Uses an array of SVs if the C style variable argument list is
8438 missing (NULL). When running with taint checks enabled, indicates via
8439 C<maybe_tainted> if results are untrustworthy (often due to the use of
8442 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8448 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8449 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8450 vec_utf8 = DO_UTF8(vecsv);
8452 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8455 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8463 static const char nullstr[] = "(null)";
8465 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8466 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8468 /* Times 4: a decimal digit takes more than 3 binary digits.
8469 * NV_DIG: mantissa takes than many decimal digits.
8470 * Plus 32: Playing safe. */
8471 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8472 /* large enough for "%#.#f" --chip */
8473 /* what about long double NVs? --jhi */
8475 PERL_UNUSED_ARG(maybe_tainted);
8477 /* no matter what, this is a string now */
8478 (void)SvPV_force(sv, origlen);
8480 /* special-case "", "%s", and "%-p" (SVf - see below) */
8483 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8485 const char * const s = va_arg(*args, char*);
8486 sv_catpv(sv, s ? s : nullstr);
8488 else if (svix < svmax) {
8489 sv_catsv(sv, *svargs);
8493 if (args && patlen == 3 && pat[0] == '%' &&
8494 pat[1] == '-' && pat[2] == 'p') {
8495 argsv = (SV*)va_arg(*args, void*);
8496 sv_catsv(sv, argsv);
8500 #ifndef USE_LONG_DOUBLE
8501 /* special-case "%.<number>[gf]" */
8502 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8503 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8504 unsigned digits = 0;
8508 while (*pp >= '0' && *pp <= '9')
8509 digits = 10 * digits + (*pp++ - '0');
8510 if (pp - pat == (int)patlen - 1) {
8518 /* Add check for digits != 0 because it seems that some
8519 gconverts are buggy in this case, and we don't yet have
8520 a Configure test for this. */
8521 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8522 /* 0, point, slack */
8523 Gconvert(nv, (int)digits, 0, ebuf);
8525 if (*ebuf) /* May return an empty string for digits==0 */
8528 } else if (!digits) {
8531 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8532 sv_catpvn(sv, p, l);
8538 #endif /* !USE_LONG_DOUBLE */
8540 if (!args && svix < svmax && DO_UTF8(*svargs))
8543 patend = (char*)pat + patlen;
8544 for (p = (char*)pat; p < patend; p = q) {
8547 bool vectorize = FALSE;
8548 bool vectorarg = FALSE;
8549 bool vec_utf8 = FALSE;
8555 bool has_precis = FALSE;
8557 const I32 osvix = svix;
8558 bool is_utf8 = FALSE; /* is this item utf8? */
8559 #ifdef HAS_LDBL_SPRINTF_BUG
8560 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8561 with sfio - Allen <allens@cpan.org> */
8562 bool fix_ldbl_sprintf_bug = FALSE;
8566 U8 utf8buf[UTF8_MAXBYTES+1];
8567 STRLEN esignlen = 0;
8569 const char *eptr = NULL;
8572 const U8 *vecstr = NULL;
8579 /* we need a long double target in case HAS_LONG_DOUBLE but
8582 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8590 const char *dotstr = ".";
8591 STRLEN dotstrlen = 1;
8592 I32 efix = 0; /* explicit format parameter index */
8593 I32 ewix = 0; /* explicit width index */
8594 I32 epix = 0; /* explicit precision index */
8595 I32 evix = 0; /* explicit vector index */
8596 bool asterisk = FALSE;
8598 /* echo everything up to the next format specification */
8599 for (q = p; q < patend && *q != '%'; ++q) ;
8601 if (has_utf8 && !pat_utf8)
8602 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8604 sv_catpvn(sv, p, q - p);
8611 We allow format specification elements in this order:
8612 \d+\$ explicit format parameter index
8614 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8615 0 flag (as above): repeated to allow "v02"
8616 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8617 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8619 [%bcdefginopsuxDFOUX] format (mandatory)
8624 As of perl5.9.3, printf format checking is on by default.
8625 Internally, perl uses %p formats to provide an escape to
8626 some extended formatting. This block deals with those
8627 extensions: if it does not match, (char*)q is reset and
8628 the normal format processing code is used.
8630 Currently defined extensions are:
8631 %p include pointer address (standard)
8632 %-p (SVf) include an SV (previously %_)
8633 %-<num>p include an SV with precision <num>
8634 %<num>p reserved for future extensions
8636 Robin Barker 2005-07-14
8638 %1p (VDf) removed. RMB 2007-10-19
8645 n = expect_number(&q);
8652 argsv = (SV*)va_arg(*args, void*);
8653 eptr = SvPV_const(argsv, elen);
8659 if (ckWARN_d(WARN_INTERNAL))
8660 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8661 "internal %%<num>p might conflict with future printf extensions");
8667 if ( (width = expect_number(&q)) ) {
8682 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8711 if ( (ewix = expect_number(&q)) )
8720 if ((vectorarg = asterisk)) {
8733 width = expect_number(&q);
8739 vecsv = va_arg(*args, SV*);
8741 vecsv = (evix > 0 && evix <= svmax)
8742 ? svargs[evix-1] : &PL_sv_undef;
8744 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8746 dotstr = SvPV_const(vecsv, dotstrlen);
8747 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8748 bad with tied or overloaded values that return UTF8. */
8751 else if (has_utf8) {
8752 vecsv = sv_mortalcopy(vecsv);
8753 sv_utf8_upgrade(vecsv);
8754 dotstr = SvPV_const(vecsv, dotstrlen);
8761 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8762 vecsv = svargs[efix ? efix-1 : svix++];
8763 vecstr = (U8*)SvPV_const(vecsv,veclen);
8764 vec_utf8 = DO_UTF8(vecsv);
8766 /* if this is a version object, we need to convert
8767 * back into v-string notation and then let the
8768 * vectorize happen normally
8770 if (sv_derived_from(vecsv, "version")) {
8771 char *version = savesvpv(vecsv);
8772 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8773 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8774 "vector argument not supported with alpha versions");
8777 vecsv = sv_newmortal();
8778 scan_vstring(version, version + veclen, vecsv);
8779 vecstr = (U8*)SvPV_const(vecsv, veclen);
8780 vec_utf8 = DO_UTF8(vecsv);
8792 i = va_arg(*args, int);
8794 i = (ewix ? ewix <= svmax : svix < svmax) ?
8795 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8797 width = (i < 0) ? -i : i;
8807 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8809 /* XXX: todo, support specified precision parameter */
8813 i = va_arg(*args, int);
8815 i = (ewix ? ewix <= svmax : svix < svmax)
8816 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8818 has_precis = !(i < 0);
8823 precis = precis * 10 + (*q++ - '0');
8832 case 'I': /* Ix, I32x, and I64x */
8834 if (q[1] == '6' && q[2] == '4') {
8840 if (q[1] == '3' && q[2] == '2') {
8850 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8861 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8862 if (*(q + 1) == 'l') { /* lld, llf */
8888 if (!vectorize && !args) {
8890 const I32 i = efix-1;
8891 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8893 argsv = (svix >= 0 && svix < svmax)
8894 ? svargs[svix++] : &PL_sv_undef;
8905 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8907 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8909 eptr = (char*)utf8buf;
8910 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8924 eptr = va_arg(*args, char*);
8926 #ifdef MACOS_TRADITIONAL
8927 /* On MacOS, %#s format is used for Pascal strings */
8932 elen = strlen(eptr);
8934 eptr = (char *)nullstr;
8935 elen = sizeof nullstr - 1;
8939 eptr = SvPV_const(argsv, elen);
8940 if (DO_UTF8(argsv)) {
8941 I32 old_precis = precis;
8942 if (has_precis && precis < elen) {
8944 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8947 if (width) { /* fudge width (can't fudge elen) */
8948 if (has_precis && precis < elen)
8949 width += precis - old_precis;
8951 width += elen - sv_len_utf8(argsv);
8958 if (has_precis && elen > precis)
8965 if (alt || vectorize)
8967 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8988 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8997 esignbuf[esignlen++] = plus;
9001 case 'h': iv = (short)va_arg(*args, int); break;
9002 case 'l': iv = va_arg(*args, long); break;
9003 case 'V': iv = va_arg(*args, IV); break;
9004 default: iv = va_arg(*args, int); break;
9006 case 'q': iv = va_arg(*args, Quad_t); break;
9011 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9013 case 'h': iv = (short)tiv; break;
9014 case 'l': iv = (long)tiv; break;
9016 default: iv = tiv; break;
9018 case 'q': iv = (Quad_t)tiv; break;
9022 if ( !vectorize ) /* we already set uv above */
9027 esignbuf[esignlen++] = plus;
9031 esignbuf[esignlen++] = '-';
9075 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9086 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9087 case 'l': uv = va_arg(*args, unsigned long); break;
9088 case 'V': uv = va_arg(*args, UV); break;
9089 default: uv = va_arg(*args, unsigned); break;
9091 case 'q': uv = va_arg(*args, Uquad_t); break;
9096 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9098 case 'h': uv = (unsigned short)tuv; break;
9099 case 'l': uv = (unsigned long)tuv; break;
9101 default: uv = tuv; break;
9103 case 'q': uv = (Uquad_t)tuv; break;
9110 char *ptr = ebuf + sizeof ebuf;
9111 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9117 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9123 esignbuf[esignlen++] = '0';
9124 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9132 if (alt && *ptr != '0')
9141 esignbuf[esignlen++] = '0';
9142 esignbuf[esignlen++] = c;
9145 default: /* it had better be ten or less */
9149 } while (uv /= base);
9152 elen = (ebuf + sizeof ebuf) - ptr;
9156 zeros = precis - elen;
9157 else if (precis == 0 && elen == 1 && *eptr == '0'
9158 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9161 /* a precision nullifies the 0 flag. */
9168 /* FLOATING POINT */
9171 c = 'f'; /* maybe %F isn't supported here */
9179 /* This is evil, but floating point is even more evil */
9181 /* for SV-style calling, we can only get NV
9182 for C-style calling, we assume %f is double;
9183 for simplicity we allow any of %Lf, %llf, %qf for long double
9187 #if defined(USE_LONG_DOUBLE)
9191 /* [perl #20339] - we should accept and ignore %lf rather than die */
9195 #if defined(USE_LONG_DOUBLE)
9196 intsize = args ? 0 : 'q';
9200 #if defined(HAS_LONG_DOUBLE)
9209 /* now we need (long double) if intsize == 'q', else (double) */
9211 #if LONG_DOUBLESIZE > DOUBLESIZE
9213 va_arg(*args, long double) :
9214 va_arg(*args, double)
9216 va_arg(*args, double)
9221 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9222 else. frexp() has some unspecified behaviour for those three */
9223 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9225 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9226 will cast our (long double) to (double) */
9227 (void)Perl_frexp(nv, &i);
9228 if (i == PERL_INT_MIN)
9229 Perl_die(aTHX_ "panic: frexp");
9231 need = BIT_DIGITS(i);
9233 need += has_precis ? precis : 6; /* known default */
9238 #ifdef HAS_LDBL_SPRINTF_BUG
9239 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9240 with sfio - Allen <allens@cpan.org> */
9243 # define MY_DBL_MAX DBL_MAX
9244 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9245 # if DOUBLESIZE >= 8
9246 # define MY_DBL_MAX 1.7976931348623157E+308L
9248 # define MY_DBL_MAX 3.40282347E+38L
9252 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9253 # define MY_DBL_MAX_BUG 1L
9255 # define MY_DBL_MAX_BUG MY_DBL_MAX
9259 # define MY_DBL_MIN DBL_MIN
9260 # else /* XXX guessing! -Allen */
9261 # if DOUBLESIZE >= 8
9262 # define MY_DBL_MIN 2.2250738585072014E-308L
9264 # define MY_DBL_MIN 1.17549435E-38L
9268 if ((intsize == 'q') && (c == 'f') &&
9269 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9271 /* it's going to be short enough that
9272 * long double precision is not needed */
9274 if ((nv <= 0L) && (nv >= -0L))
9275 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9277 /* would use Perl_fp_class as a double-check but not
9278 * functional on IRIX - see perl.h comments */
9280 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9281 /* It's within the range that a double can represent */
9282 #if defined(DBL_MAX) && !defined(DBL_MIN)
9283 if ((nv >= ((long double)1/DBL_MAX)) ||
9284 (nv <= (-(long double)1/DBL_MAX)))
9286 fix_ldbl_sprintf_bug = TRUE;
9289 if (fix_ldbl_sprintf_bug == TRUE) {
9299 # undef MY_DBL_MAX_BUG
9302 #endif /* HAS_LDBL_SPRINTF_BUG */
9304 need += 20; /* fudge factor */
9305 if (PL_efloatsize < need) {
9306 Safefree(PL_efloatbuf);
9307 PL_efloatsize = need + 20; /* more fudge */
9308 Newx(PL_efloatbuf, PL_efloatsize, char);
9309 PL_efloatbuf[0] = '\0';
9312 if ( !(width || left || plus || alt) && fill != '0'
9313 && has_precis && intsize != 'q' ) { /* Shortcuts */
9314 /* See earlier comment about buggy Gconvert when digits,
9316 if ( c == 'g' && precis) {
9317 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9318 /* May return an empty string for digits==0 */
9319 if (*PL_efloatbuf) {
9320 elen = strlen(PL_efloatbuf);
9321 goto float_converted;
9323 } else if ( c == 'f' && !precis) {
9324 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9329 char *ptr = ebuf + sizeof ebuf;
9332 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9333 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9334 if (intsize == 'q') {
9335 /* Copy the one or more characters in a long double
9336 * format before the 'base' ([efgEFG]) character to
9337 * the format string. */
9338 static char const prifldbl[] = PERL_PRIfldbl;
9339 char const *p = prifldbl + sizeof(prifldbl) - 3;
9340 while (p >= prifldbl) { *--ptr = *p--; }
9345 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9350 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9362 /* No taint. Otherwise we are in the strange situation
9363 * where printf() taints but print($float) doesn't.
9365 #if defined(HAS_LONG_DOUBLE)
9366 elen = ((intsize == 'q')
9367 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9368 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9370 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9374 eptr = PL_efloatbuf;
9382 i = SvCUR(sv) - origlen;
9385 case 'h': *(va_arg(*args, short*)) = i; break;
9386 default: *(va_arg(*args, int*)) = i; break;
9387 case 'l': *(va_arg(*args, long*)) = i; break;
9388 case 'V': *(va_arg(*args, IV*)) = i; break;
9390 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9395 sv_setuv_mg(argsv, (UV)i);
9396 continue; /* not "break" */
9403 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9404 && ckWARN(WARN_PRINTF))
9406 SV * const msg = sv_newmortal();
9407 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9408 (PL_op->op_type == OP_PRTF) ? "" : "s");
9411 Perl_sv_catpvf(aTHX_ msg,
9412 "\"%%%c\"", c & 0xFF);
9414 Perl_sv_catpvf(aTHX_ msg,
9415 "\"%%\\%03"UVof"\"",
9418 sv_catpvs(msg, "end of string");
9419 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9422 /* output mangled stuff ... */
9428 /* ... right here, because formatting flags should not apply */
9429 SvGROW(sv, SvCUR(sv) + elen + 1);
9431 Copy(eptr, p, elen, char);
9434 SvCUR_set(sv, p - SvPVX_const(sv));
9436 continue; /* not "break" */
9439 if (is_utf8 != has_utf8) {
9442 sv_utf8_upgrade(sv);
9445 const STRLEN old_elen = elen;
9446 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9447 sv_utf8_upgrade(nsv);
9448 eptr = SvPVX_const(nsv);
9451 if (width) { /* fudge width (can't fudge elen) */
9452 width += elen - old_elen;
9458 have = esignlen + zeros + elen;
9460 Perl_croak_nocontext(PL_memory_wrap);
9462 need = (have > width ? have : width);
9465 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9466 Perl_croak_nocontext(PL_memory_wrap);
9467 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9469 if (esignlen && fill == '0') {
9471 for (i = 0; i < (int)esignlen; i++)
9475 memset(p, fill, gap);
9478 if (esignlen && fill != '0') {
9480 for (i = 0; i < (int)esignlen; i++)
9485 for (i = zeros; i; i--)
9489 Copy(eptr, p, elen, char);
9493 memset(p, ' ', gap);
9498 Copy(dotstr, p, dotstrlen, char);
9502 vectorize = FALSE; /* done iterating over vecstr */
9509 SvCUR_set(sv, p - SvPVX_const(sv));
9517 /* =========================================================================
9519 =head1 Cloning an interpreter
9521 All the macros and functions in this section are for the private use of
9522 the main function, perl_clone().
9524 The foo_dup() functions make an exact copy of an existing foo thingy.
9525 During the course of a cloning, a hash table is used to map old addresses
9526 to new addresses. The table is created and manipulated with the
9527 ptr_table_* functions.
9531 ============================================================================*/
9534 #if defined(USE_ITHREADS)
9536 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9537 #ifndef GpREFCNT_inc
9538 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9542 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9543 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9544 If this changes, please unmerge ss_dup. */
9545 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9546 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9547 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9548 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9549 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9550 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9551 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9552 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9553 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9554 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9555 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9556 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9557 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9558 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9560 /* clone a parser */
9563 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9570 /* look for it in the table first */
9571 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9575 /* create anew and remember what it is */
9576 Newxz(parser, 1, yy_parser);
9577 ptr_table_store(PL_ptr_table, proto, parser);
9579 parser->yyerrstatus = 0;
9580 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9582 /* XXX these not yet duped */
9583 parser->old_parser = NULL;
9584 parser->stack = NULL;
9586 parser->stack_size = 0;
9587 /* XXX parser->stack->state = 0; */
9589 /* XXX eventually, just Copy() most of the parser struct ? */
9591 parser->lex_brackets = proto->lex_brackets;
9592 parser->lex_casemods = proto->lex_casemods;
9593 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9594 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9595 parser->lex_casestack = savepvn(proto->lex_casestack,
9596 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9597 parser->lex_defer = proto->lex_defer;
9598 parser->lex_dojoin = proto->lex_dojoin;
9599 parser->lex_expect = proto->lex_expect;
9600 parser->lex_formbrack = proto->lex_formbrack;
9601 parser->lex_inpat = proto->lex_inpat;
9602 parser->lex_inwhat = proto->lex_inwhat;
9603 parser->lex_op = proto->lex_op;
9604 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9605 parser->lex_starts = proto->lex_starts;
9606 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9607 parser->multi_close = proto->multi_close;
9608 parser->multi_open = proto->multi_open;
9609 parser->multi_start = proto->multi_start;
9610 parser->multi_end = proto->multi_end;
9611 parser->pending_ident = proto->pending_ident;
9612 parser->preambled = proto->preambled;
9613 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9614 parser->linestr = sv_dup_inc(proto->linestr, param);
9615 parser->expect = proto->expect;
9616 parser->copline = proto->copline;
9617 parser->last_lop_op = proto->last_lop_op;
9618 parser->lex_state = proto->lex_state;
9619 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9620 /* rsfp_filters entries have fake IoDIRP() */
9621 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9622 parser->in_my = proto->in_my;
9623 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9624 parser->error_count = proto->error_count;
9627 parser->linestr = sv_dup_inc(proto->linestr, param);
9630 char * const ols = SvPVX(proto->linestr);
9631 char * const ls = SvPVX(parser->linestr);
9633 parser->bufptr = ls + (proto->bufptr >= ols ?
9634 proto->bufptr - ols : 0);
9635 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9636 proto->oldbufptr - ols : 0);
9637 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9638 proto->oldoldbufptr - ols : 0);
9639 parser->linestart = ls + (proto->linestart >= ols ?
9640 proto->linestart - ols : 0);
9641 parser->last_uni = ls + (proto->last_uni >= ols ?
9642 proto->last_uni - ols : 0);
9643 parser->last_lop = ls + (proto->last_lop >= ols ?
9644 proto->last_lop - ols : 0);
9646 parser->bufend = ls + SvCUR(parser->linestr);
9649 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9653 parser->endwhite = proto->endwhite;
9654 parser->faketokens = proto->faketokens;
9655 parser->lasttoke = proto->lasttoke;
9656 parser->nextwhite = proto->nextwhite;
9657 parser->realtokenstart = proto->realtokenstart;
9658 parser->skipwhite = proto->skipwhite;
9659 parser->thisclose = proto->thisclose;
9660 parser->thismad = proto->thismad;
9661 parser->thisopen = proto->thisopen;
9662 parser->thisstuff = proto->thisstuff;
9663 parser->thistoken = proto->thistoken;
9664 parser->thiswhite = proto->thiswhite;
9666 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9667 parser->curforce = proto->curforce;
9669 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9670 Copy(proto->nexttype, parser->nexttype, 5, I32);
9671 parser->nexttoke = proto->nexttoke;
9677 /* duplicate a file handle */
9680 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9684 PERL_UNUSED_ARG(type);
9687 return (PerlIO*)NULL;
9689 /* look for it in the table first */
9690 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9694 /* create anew and remember what it is */
9695 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9696 ptr_table_store(PL_ptr_table, fp, ret);
9700 /* duplicate a directory handle */
9703 Perl_dirp_dup(pTHX_ DIR *dp)
9705 PERL_UNUSED_CONTEXT;
9712 /* duplicate a typeglob */
9715 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9721 /* look for it in the table first */
9722 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9726 /* create anew and remember what it is */
9728 ptr_table_store(PL_ptr_table, gp, ret);
9731 ret->gp_refcnt = 0; /* must be before any other dups! */
9732 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9733 ret->gp_io = io_dup_inc(gp->gp_io, param);
9734 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9735 ret->gp_av = av_dup_inc(gp->gp_av, param);
9736 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9737 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9738 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9739 ret->gp_cvgen = gp->gp_cvgen;
9740 ret->gp_line = gp->gp_line;
9741 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9745 /* duplicate a chain of magic */
9748 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9750 MAGIC *mgprev = (MAGIC*)NULL;
9753 return (MAGIC*)NULL;
9754 /* look for it in the table first */
9755 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9759 for (; mg; mg = mg->mg_moremagic) {
9761 Newxz(nmg, 1, MAGIC);
9763 mgprev->mg_moremagic = nmg;
9766 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9767 nmg->mg_private = mg->mg_private;
9768 nmg->mg_type = mg->mg_type;
9769 nmg->mg_flags = mg->mg_flags;
9770 if (mg->mg_type == PERL_MAGIC_qr) {
9771 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9773 else if(mg->mg_type == PERL_MAGIC_backref) {
9774 /* The backref AV has its reference count deliberately bumped by
9776 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9779 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9780 ? sv_dup_inc(mg->mg_obj, param)
9781 : sv_dup(mg->mg_obj, param);
9783 nmg->mg_len = mg->mg_len;
9784 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9785 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9786 if (mg->mg_len > 0) {
9787 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9788 if (mg->mg_type == PERL_MAGIC_overload_table &&
9789 AMT_AMAGIC((AMT*)mg->mg_ptr))
9791 const AMT * const amtp = (AMT*)mg->mg_ptr;
9792 AMT * const namtp = (AMT*)nmg->mg_ptr;
9794 for (i = 1; i < NofAMmeth; i++) {
9795 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9799 else if (mg->mg_len == HEf_SVKEY)
9800 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9802 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9803 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9810 #endif /* USE_ITHREADS */
9812 /* create a new pointer-mapping table */
9815 Perl_ptr_table_new(pTHX)
9818 PERL_UNUSED_CONTEXT;
9820 Newxz(tbl, 1, PTR_TBL_t);
9823 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9827 #define PTR_TABLE_HASH(ptr) \
9828 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9831 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9832 following define) and at call to new_body_inline made below in
9833 Perl_ptr_table_store()
9836 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9838 /* map an existing pointer using a table */
9840 STATIC PTR_TBL_ENT_t *
9841 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9842 PTR_TBL_ENT_t *tblent;
9843 const UV hash = PTR_TABLE_HASH(sv);
9845 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9846 for (; tblent; tblent = tblent->next) {
9847 if (tblent->oldval == sv)
9854 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9856 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9857 PERL_UNUSED_CONTEXT;
9858 return tblent ? tblent->newval : NULL;
9861 /* add a new entry to a pointer-mapping table */
9864 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9866 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9867 PERL_UNUSED_CONTEXT;
9870 tblent->newval = newsv;
9872 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9874 new_body_inline(tblent, PTE_SVSLOT);
9876 tblent->oldval = oldsv;
9877 tblent->newval = newsv;
9878 tblent->next = tbl->tbl_ary[entry];
9879 tbl->tbl_ary[entry] = tblent;
9881 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9882 ptr_table_split(tbl);
9886 /* double the hash bucket size of an existing ptr table */
9889 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9891 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9892 const UV oldsize = tbl->tbl_max + 1;
9893 UV newsize = oldsize * 2;
9895 PERL_UNUSED_CONTEXT;
9897 Renew(ary, newsize, PTR_TBL_ENT_t*);
9898 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9899 tbl->tbl_max = --newsize;
9901 for (i=0; i < oldsize; i++, ary++) {
9902 PTR_TBL_ENT_t **curentp, **entp, *ent;
9905 curentp = ary + oldsize;
9906 for (entp = ary, ent = *ary; ent; ent = *entp) {
9907 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9909 ent->next = *curentp;
9919 /* remove all the entries from a ptr table */
9922 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9924 if (tbl && tbl->tbl_items) {
9925 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9926 UV riter = tbl->tbl_max;
9929 PTR_TBL_ENT_t *entry = array[riter];
9932 PTR_TBL_ENT_t * const oentry = entry;
9933 entry = entry->next;
9942 /* clear and free a ptr table */
9945 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9950 ptr_table_clear(tbl);
9951 Safefree(tbl->tbl_ary);
9955 #if defined(USE_ITHREADS)
9958 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9961 SvRV_set(dstr, SvWEAKREF(sstr)
9962 ? sv_dup(SvRV(sstr), param)
9963 : sv_dup_inc(SvRV(sstr), param));
9966 else if (SvPVX_const(sstr)) {
9967 /* Has something there */
9969 /* Normal PV - clone whole allocated space */
9970 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9971 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9972 /* Not that normal - actually sstr is copy on write.
9973 But we are a true, independant SV, so: */
9974 SvREADONLY_off(dstr);
9979 /* Special case - not normally malloced for some reason */
9980 if (isGV_with_GP(sstr)) {
9981 /* Don't need to do anything here. */
9983 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9984 /* A "shared" PV - clone it as "shared" PV */
9986 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9990 /* Some other special case - random pointer */
9991 SvPV_set(dstr, SvPVX(sstr));
9997 if (SvTYPE(dstr) == SVt_RV)
9998 SvRV_set(dstr, NULL);
10000 SvPV_set(dstr, NULL);
10004 /* duplicate an SV of any type (including AV, HV etc) */
10007 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10012 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10014 /* look for it in the table first */
10015 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10019 if(param->flags & CLONEf_JOIN_IN) {
10020 /** We are joining here so we don't want do clone
10021 something that is bad **/
10022 if (SvTYPE(sstr) == SVt_PVHV) {
10023 const HEK * const hvname = HvNAME_HEK(sstr);
10025 /** don't clone stashes if they already exist **/
10026 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10030 /* create anew and remember what it is */
10033 #ifdef DEBUG_LEAKING_SCALARS
10034 dstr->sv_debug_optype = sstr->sv_debug_optype;
10035 dstr->sv_debug_line = sstr->sv_debug_line;
10036 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10037 dstr->sv_debug_cloned = 1;
10038 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10041 ptr_table_store(PL_ptr_table, sstr, dstr);
10044 SvFLAGS(dstr) = SvFLAGS(sstr);
10045 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10046 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10049 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10050 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10051 (void*)PL_watch_pvx, SvPVX_const(sstr));
10054 /* don't clone objects whose class has asked us not to */
10055 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10060 switch (SvTYPE(sstr)) {
10062 SvANY(dstr) = NULL;
10065 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10066 SvIV_set(dstr, SvIVX(sstr));
10069 SvANY(dstr) = new_XNV();
10070 SvNV_set(dstr, SvNVX(sstr));
10073 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10074 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10076 /* case SVt_BIND: */
10079 /* These are all the types that need complex bodies allocating. */
10081 const svtype sv_type = SvTYPE(sstr);
10082 const struct body_details *const sv_type_details
10083 = bodies_by_type + sv_type;
10087 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10091 if (GvUNIQUE((GV*)sstr)) {
10092 NOOP; /* Do sharing here, and fall through */
10104 assert(sv_type_details->body_size);
10105 if (sv_type_details->arena) {
10106 new_body_inline(new_body, sv_type);
10108 = (void*)((char*)new_body - sv_type_details->offset);
10110 new_body = new_NOARENA(sv_type_details);
10114 SvANY(dstr) = new_body;
10117 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10118 ((char*)SvANY(dstr)) + sv_type_details->offset,
10119 sv_type_details->copy, char);
10121 Copy(((char*)SvANY(sstr)),
10122 ((char*)SvANY(dstr)),
10123 sv_type_details->body_size + sv_type_details->offset, char);
10126 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10127 && !isGV_with_GP(dstr))
10128 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10130 /* The Copy above means that all the source (unduplicated) pointers
10131 are now in the destination. We can check the flags and the
10132 pointers in either, but it's possible that there's less cache
10133 missing by always going for the destination.
10134 FIXME - instrument and check that assumption */
10135 if (sv_type >= SVt_PVMG) {
10136 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10137 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10138 } else if (SvMAGIC(dstr))
10139 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10141 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10144 /* The cast silences a GCC warning about unhandled types. */
10145 switch ((int)sv_type) {
10155 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10156 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10157 LvTARG(dstr) = dstr;
10158 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10159 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10161 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10163 if(isGV_with_GP(sstr)) {
10164 if (GvNAME_HEK(dstr))
10165 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10166 /* Don't call sv_add_backref here as it's going to be
10167 created as part of the magic cloning of the symbol
10169 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10170 at the point of this comment. */
10171 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10172 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10173 (void)GpREFCNT_inc(GvGP(dstr));
10175 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10178 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10179 if (IoOFP(dstr) == IoIFP(sstr))
10180 IoOFP(dstr) = IoIFP(dstr);
10182 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10183 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10184 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10185 /* I have no idea why fake dirp (rsfps)
10186 should be treated differently but otherwise
10187 we end up with leaks -- sky*/
10188 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10189 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10190 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10192 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10193 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10194 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10195 if (IoDIRP(dstr)) {
10196 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10199 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10202 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10203 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10204 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10207 if (AvARRAY((AV*)sstr)) {
10208 SV **dst_ary, **src_ary;
10209 SSize_t items = AvFILLp((AV*)sstr) + 1;
10211 src_ary = AvARRAY((AV*)sstr);
10212 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10213 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10214 AvARRAY((AV*)dstr) = dst_ary;
10215 AvALLOC((AV*)dstr) = dst_ary;
10216 if (AvREAL((AV*)sstr)) {
10217 while (items-- > 0)
10218 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10221 while (items-- > 0)
10222 *dst_ary++ = sv_dup(*src_ary++, param);
10224 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10225 while (items-- > 0) {
10226 *dst_ary++ = &PL_sv_undef;
10230 AvARRAY((AV*)dstr) = NULL;
10231 AvALLOC((AV*)dstr) = (SV**)NULL;
10235 if (HvARRAY((HV*)sstr)) {
10237 const bool sharekeys = !!HvSHAREKEYS(sstr);
10238 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10239 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10241 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10242 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10244 HvARRAY(dstr) = (HE**)darray;
10245 while (i <= sxhv->xhv_max) {
10246 const HE * const source = HvARRAY(sstr)[i];
10247 HvARRAY(dstr)[i] = source
10248 ? he_dup(source, sharekeys, param) : 0;
10253 const struct xpvhv_aux * const saux = HvAUX(sstr);
10254 struct xpvhv_aux * const daux = HvAUX(dstr);
10255 /* This flag isn't copied. */
10256 /* SvOOK_on(hv) attacks the IV flags. */
10257 SvFLAGS(dstr) |= SVf_OOK;
10259 hvname = saux->xhv_name;
10260 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10262 daux->xhv_riter = saux->xhv_riter;
10263 daux->xhv_eiter = saux->xhv_eiter
10264 ? he_dup(saux->xhv_eiter,
10265 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10266 daux->xhv_backreferences =
10267 saux->xhv_backreferences
10268 ? (AV*) SvREFCNT_inc(
10269 sv_dup((SV*)saux->xhv_backreferences, param))
10272 daux->xhv_mro_meta = saux->xhv_mro_meta
10273 ? mro_meta_dup(saux->xhv_mro_meta, param)
10276 /* Record stashes for possible cloning in Perl_clone(). */
10278 av_push(param->stashes, dstr);
10282 HvARRAY((HV*)dstr) = NULL;
10285 if (!(param->flags & CLONEf_COPY_STACKS)) {
10289 /* NOTE: not refcounted */
10290 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10292 if (!CvISXSUB(dstr))
10293 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10295 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10296 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10297 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10298 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10300 /* don't dup if copying back - CvGV isn't refcounted, so the
10301 * duped GV may never be freed. A bit of a hack! DAPM */
10302 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10303 NULL : gv_dup(CvGV(dstr), param) ;
10304 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10306 CvWEAKOUTSIDE(sstr)
10307 ? cv_dup( CvOUTSIDE(dstr), param)
10308 : cv_dup_inc(CvOUTSIDE(dstr), param);
10309 if (!CvISXSUB(dstr))
10310 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10316 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10322 /* duplicate a context */
10325 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10327 PERL_CONTEXT *ncxs;
10330 return (PERL_CONTEXT*)NULL;
10332 /* look for it in the table first */
10333 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10337 /* create anew and remember what it is */
10338 Newxz(ncxs, max + 1, PERL_CONTEXT);
10339 ptr_table_store(PL_ptr_table, cxs, ncxs);
10342 PERL_CONTEXT * const cx = &cxs[ix];
10343 PERL_CONTEXT * const ncx = &ncxs[ix];
10344 ncx->cx_type = cx->cx_type;
10345 if (CxTYPE(cx) == CXt_SUBST) {
10346 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10349 ncx->blk_oldsp = cx->blk_oldsp;
10350 ncx->blk_oldcop = cx->blk_oldcop;
10351 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10352 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10353 ncx->blk_oldpm = cx->blk_oldpm;
10354 ncx->blk_gimme = cx->blk_gimme;
10355 switch (CxTYPE(cx)) {
10357 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10358 ? cv_dup_inc(cx->blk_sub.cv, param)
10359 : cv_dup(cx->blk_sub.cv,param));
10360 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10361 ? av_dup_inc(cx->blk_sub.argarray, param)
10363 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10364 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10365 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10366 ncx->blk_sub.lval = cx->blk_sub.lval;
10367 ncx->blk_sub.retop = cx->blk_sub.retop;
10368 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10369 cx->blk_sub.oldcomppad);
10372 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10373 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10374 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10375 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10376 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10377 ncx->blk_eval.retop = cx->blk_eval.retop;
10380 ncx->blk_loop.label = cx->blk_loop.label;
10381 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10382 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10383 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10384 ? cx->blk_loop.iterdata
10385 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10386 ncx->blk_loop.oldcomppad
10387 = (PAD*)ptr_table_fetch(PL_ptr_table,
10388 cx->blk_loop.oldcomppad);
10389 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10390 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10391 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10392 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10393 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10396 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10397 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10398 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10399 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10400 ncx->blk_sub.retop = cx->blk_sub.retop;
10412 /* duplicate a stack info structure */
10415 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10420 return (PERL_SI*)NULL;
10422 /* look for it in the table first */
10423 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10427 /* create anew and remember what it is */
10428 Newxz(nsi, 1, PERL_SI);
10429 ptr_table_store(PL_ptr_table, si, nsi);
10431 nsi->si_stack = av_dup_inc(si->si_stack, param);
10432 nsi->si_cxix = si->si_cxix;
10433 nsi->si_cxmax = si->si_cxmax;
10434 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10435 nsi->si_type = si->si_type;
10436 nsi->si_prev = si_dup(si->si_prev, param);
10437 nsi->si_next = si_dup(si->si_next, param);
10438 nsi->si_markoff = si->si_markoff;
10443 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10444 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10445 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10446 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10447 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10448 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10449 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10450 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10451 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10452 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10453 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10454 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10455 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10456 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10459 #define pv_dup_inc(p) SAVEPV(p)
10460 #define pv_dup(p) SAVEPV(p)
10461 #define svp_dup_inc(p,pp) any_dup(p,pp)
10463 /* map any object to the new equivent - either something in the
10464 * ptr table, or something in the interpreter structure
10468 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10473 return (void*)NULL;
10475 /* look for it in the table first */
10476 ret = ptr_table_fetch(PL_ptr_table, v);
10480 /* see if it is part of the interpreter structure */
10481 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10482 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10490 /* duplicate the save stack */
10493 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10496 ANY * const ss = proto_perl->Isavestack;
10497 const I32 max = proto_perl->Isavestack_max;
10498 I32 ix = proto_perl->Isavestack_ix;
10511 void (*dptr) (void*);
10512 void (*dxptr) (pTHX_ void*);
10514 Newxz(nss, max, ANY);
10517 const I32 type = POPINT(ss,ix);
10518 TOPINT(nss,ix) = type;
10520 case SAVEt_HELEM: /* hash element */
10521 sv = (SV*)POPPTR(ss,ix);
10522 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10524 case SAVEt_ITEM: /* normal string */
10525 case SAVEt_SV: /* scalar reference */
10526 sv = (SV*)POPPTR(ss,ix);
10527 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10530 case SAVEt_MORTALIZESV:
10531 sv = (SV*)POPPTR(ss,ix);
10532 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10534 case SAVEt_SHARED_PVREF: /* char* in shared space */
10535 c = (char*)POPPTR(ss,ix);
10536 TOPPTR(nss,ix) = savesharedpv(c);
10537 ptr = POPPTR(ss,ix);
10538 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10540 case SAVEt_GENERIC_SVREF: /* generic sv */
10541 case SAVEt_SVREF: /* scalar reference */
10542 sv = (SV*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10547 case SAVEt_HV: /* hash reference */
10548 case SAVEt_AV: /* array reference */
10549 sv = (SV*) POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10552 case SAVEt_COMPPAD:
10554 sv = (SV*) POPPTR(ss,ix);
10555 TOPPTR(nss,ix) = sv_dup(sv, param);
10557 case SAVEt_INT: /* int reference */
10558 ptr = POPPTR(ss,ix);
10559 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10560 intval = (int)POPINT(ss,ix);
10561 TOPINT(nss,ix) = intval;
10563 case SAVEt_LONG: /* long reference */
10564 ptr = POPPTR(ss,ix);
10565 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10567 case SAVEt_CLEARSV:
10568 longval = (long)POPLONG(ss,ix);
10569 TOPLONG(nss,ix) = longval;
10571 case SAVEt_I32: /* I32 reference */
10572 case SAVEt_I16: /* I16 reference */
10573 case SAVEt_I8: /* I8 reference */
10574 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10575 ptr = POPPTR(ss,ix);
10576 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10578 TOPINT(nss,ix) = i;
10580 case SAVEt_IV: /* IV reference */
10581 ptr = POPPTR(ss,ix);
10582 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10584 TOPIV(nss,ix) = iv;
10586 case SAVEt_HPTR: /* HV* reference */
10587 case SAVEt_APTR: /* AV* reference */
10588 case SAVEt_SPTR: /* SV* reference */
10589 ptr = POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 sv = (SV*)POPPTR(ss,ix);
10592 TOPPTR(nss,ix) = sv_dup(sv, param);
10594 case SAVEt_VPTR: /* random* reference */
10595 ptr = POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10597 ptr = POPPTR(ss,ix);
10598 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10600 case SAVEt_GENERIC_PVREF: /* generic char* */
10601 case SAVEt_PPTR: /* char* reference */
10602 ptr = POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10604 c = (char*)POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = pv_dup(c);
10607 case SAVEt_GP: /* scalar reference */
10608 gp = (GP*)POPPTR(ss,ix);
10609 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10610 (void)GpREFCNT_inc(gp);
10611 gv = (GV*)POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10615 ptr = POPPTR(ss,ix);
10616 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10617 /* these are assumed to be refcounted properly */
10619 switch (((OP*)ptr)->op_type) {
10621 case OP_LEAVESUBLV:
10625 case OP_LEAVEWRITE:
10626 TOPPTR(nss,ix) = ptr;
10629 (void) OpREFCNT_inc(o);
10633 TOPPTR(nss,ix) = NULL;
10638 TOPPTR(nss,ix) = NULL;
10641 c = (char*)POPPTR(ss,ix);
10642 TOPPTR(nss,ix) = pv_dup_inc(c);
10645 hv = (HV*)POPPTR(ss,ix);
10646 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10647 c = (char*)POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = pv_dup_inc(c);
10650 case SAVEt_STACK_POS: /* Position on Perl stack */
10652 TOPINT(nss,ix) = i;
10654 case SAVEt_DESTRUCTOR:
10655 ptr = POPPTR(ss,ix);
10656 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10657 dptr = POPDPTR(ss,ix);
10658 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10659 any_dup(FPTR2DPTR(void *, dptr),
10662 case SAVEt_DESTRUCTOR_X:
10663 ptr = POPPTR(ss,ix);
10664 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10665 dxptr = POPDXPTR(ss,ix);
10666 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10667 any_dup(FPTR2DPTR(void *, dxptr),
10670 case SAVEt_REGCONTEXT:
10673 TOPINT(nss,ix) = i;
10676 case SAVEt_AELEM: /* array element */
10677 sv = (SV*)POPPTR(ss,ix);
10678 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10680 TOPINT(nss,ix) = i;
10681 av = (AV*)POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = av_dup_inc(av, param);
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = ptr;
10690 TOPINT(nss,ix) = i;
10691 ptr = POPPTR(ss,ix);
10694 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10695 HINTS_REFCNT_UNLOCK;
10697 TOPPTR(nss,ix) = ptr;
10698 if (i & HINT_LOCALIZE_HH) {
10699 hv = (HV*)POPPTR(ss,ix);
10700 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10704 longval = (long)POPLONG(ss,ix);
10705 TOPLONG(nss,ix) = longval;
10706 ptr = POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10708 sv = (SV*)POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = sv_dup(sv, param);
10712 ptr = POPPTR(ss,ix);
10713 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10714 longval = (long)POPBOOL(ss,ix);
10715 TOPBOOL(nss,ix) = (bool)longval;
10717 case SAVEt_SET_SVFLAGS:
10719 TOPINT(nss,ix) = i;
10721 TOPINT(nss,ix) = i;
10722 sv = (SV*)POPPTR(ss,ix);
10723 TOPPTR(nss,ix) = sv_dup(sv, param);
10725 case SAVEt_RE_STATE:
10727 const struct re_save_state *const old_state
10728 = (struct re_save_state *)
10729 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10730 struct re_save_state *const new_state
10731 = (struct re_save_state *)
10732 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10734 Copy(old_state, new_state, 1, struct re_save_state);
10735 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10737 new_state->re_state_bostr
10738 = pv_dup(old_state->re_state_bostr);
10739 new_state->re_state_reginput
10740 = pv_dup(old_state->re_state_reginput);
10741 new_state->re_state_regeol
10742 = pv_dup(old_state->re_state_regeol);
10743 new_state->re_state_regoffs
10744 = (regexp_paren_pair*)
10745 any_dup(old_state->re_state_regoffs, proto_perl);
10746 new_state->re_state_reglastparen
10747 = (U32*) any_dup(old_state->re_state_reglastparen,
10749 new_state->re_state_reglastcloseparen
10750 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10752 /* XXX This just has to be broken. The old save_re_context
10753 code did SAVEGENERICPV(PL_reg_start_tmp);
10754 PL_reg_start_tmp is char **.
10755 Look above to what the dup code does for
10756 SAVEt_GENERIC_PVREF
10757 It can never have worked.
10758 So this is merely a faithful copy of the exiting bug: */
10759 new_state->re_state_reg_start_tmp
10760 = (char **) pv_dup((char *)
10761 old_state->re_state_reg_start_tmp);
10762 /* I assume that it only ever "worked" because no-one called
10763 (pseudo)fork while the regexp engine had re-entered itself.
10765 #ifdef PERL_OLD_COPY_ON_WRITE
10766 new_state->re_state_nrs
10767 = sv_dup(old_state->re_state_nrs, param);
10769 new_state->re_state_reg_magic
10770 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10772 new_state->re_state_reg_oldcurpm
10773 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10775 new_state->re_state_reg_curpm
10776 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10778 new_state->re_state_reg_oldsaved
10779 = pv_dup(old_state->re_state_reg_oldsaved);
10780 new_state->re_state_reg_poscache
10781 = pv_dup(old_state->re_state_reg_poscache);
10782 new_state->re_state_reg_starttry
10783 = pv_dup(old_state->re_state_reg_starttry);
10786 case SAVEt_COMPILE_WARNINGS:
10787 ptr = POPPTR(ss,ix);
10788 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10791 ptr = POPPTR(ss,ix);
10792 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10796 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10804 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10805 * flag to the result. This is done for each stash before cloning starts,
10806 * so we know which stashes want their objects cloned */
10809 do_mark_cloneable_stash(pTHX_ SV *sv)
10811 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10813 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10814 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10815 if (cloner && GvCV(cloner)) {
10822 XPUSHs(sv_2mortal(newSVhek(hvname)));
10824 call_sv((SV*)GvCV(cloner), G_SCALAR);
10831 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10839 =for apidoc perl_clone
10841 Create and return a new interpreter by cloning the current one.
10843 perl_clone takes these flags as parameters:
10845 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10846 without it we only clone the data and zero the stacks,
10847 with it we copy the stacks and the new perl interpreter is
10848 ready to run at the exact same point as the previous one.
10849 The pseudo-fork code uses COPY_STACKS while the
10850 threads->create doesn't.
10852 CLONEf_KEEP_PTR_TABLE
10853 perl_clone keeps a ptr_table with the pointer of the old
10854 variable as a key and the new variable as a value,
10855 this allows it to check if something has been cloned and not
10856 clone it again but rather just use the value and increase the
10857 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10858 the ptr_table using the function
10859 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10860 reason to keep it around is if you want to dup some of your own
10861 variable who are outside the graph perl scans, example of this
10862 code is in threads.xs create
10865 This is a win32 thing, it is ignored on unix, it tells perls
10866 win32host code (which is c++) to clone itself, this is needed on
10867 win32 if you want to run two threads at the same time,
10868 if you just want to do some stuff in a separate perl interpreter
10869 and then throw it away and return to the original one,
10870 you don't need to do anything.
10875 /* XXX the above needs expanding by someone who actually understands it ! */
10876 EXTERN_C PerlInterpreter *
10877 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10880 perl_clone(PerlInterpreter *proto_perl, UV flags)
10883 #ifdef PERL_IMPLICIT_SYS
10885 /* perlhost.h so we need to call into it
10886 to clone the host, CPerlHost should have a c interface, sky */
10888 if (flags & CLONEf_CLONE_HOST) {
10889 return perl_clone_host(proto_perl,flags);
10891 return perl_clone_using(proto_perl, flags,
10893 proto_perl->IMemShared,
10894 proto_perl->IMemParse,
10896 proto_perl->IStdIO,
10900 proto_perl->IProc);
10904 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10905 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10906 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10907 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10908 struct IPerlDir* ipD, struct IPerlSock* ipS,
10909 struct IPerlProc* ipP)
10911 /* XXX many of the string copies here can be optimized if they're
10912 * constants; they need to be allocated as common memory and just
10913 * their pointers copied. */
10916 CLONE_PARAMS clone_params;
10917 CLONE_PARAMS* const param = &clone_params;
10919 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10920 /* for each stash, determine whether its objects should be cloned */
10921 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10922 PERL_SET_THX(my_perl);
10925 PoisonNew(my_perl, 1, PerlInterpreter);
10931 PL_savestack_ix = 0;
10932 PL_savestack_max = -1;
10933 PL_sig_pending = 0;
10935 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10936 # else /* !DEBUGGING */
10937 Zero(my_perl, 1, PerlInterpreter);
10938 # endif /* DEBUGGING */
10940 /* host pointers */
10942 PL_MemShared = ipMS;
10943 PL_MemParse = ipMP;
10950 #else /* !PERL_IMPLICIT_SYS */
10952 CLONE_PARAMS clone_params;
10953 CLONE_PARAMS* param = &clone_params;
10954 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10955 /* for each stash, determine whether its objects should be cloned */
10956 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10957 PERL_SET_THX(my_perl);
10960 PoisonNew(my_perl, 1, PerlInterpreter);
10966 PL_savestack_ix = 0;
10967 PL_savestack_max = -1;
10968 PL_sig_pending = 0;
10970 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10971 # else /* !DEBUGGING */
10972 Zero(my_perl, 1, PerlInterpreter);
10973 # endif /* DEBUGGING */
10974 #endif /* PERL_IMPLICIT_SYS */
10975 param->flags = flags;
10976 param->proto_perl = proto_perl;
10978 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10980 PL_body_arenas = NULL;
10981 Zero(&PL_body_roots, 1, PL_body_roots);
10983 PL_nice_chunk = NULL;
10984 PL_nice_chunk_size = 0;
10986 PL_sv_objcount = 0;
10988 PL_sv_arenaroot = NULL;
10990 PL_debug = proto_perl->Idebug;
10992 PL_hash_seed = proto_perl->Ihash_seed;
10993 PL_rehash_seed = proto_perl->Irehash_seed;
10995 #ifdef USE_REENTRANT_API
10996 /* XXX: things like -Dm will segfault here in perlio, but doing
10997 * PERL_SET_CONTEXT(proto_perl);
10998 * breaks too many other things
11000 Perl_reentrant_init(aTHX);
11003 /* create SV map for pointer relocation */
11004 PL_ptr_table = ptr_table_new();
11006 /* initialize these special pointers as early as possible */
11007 SvANY(&PL_sv_undef) = NULL;
11008 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11009 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11010 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11012 SvANY(&PL_sv_no) = new_XPVNV();
11013 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11014 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11015 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11016 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11017 SvCUR_set(&PL_sv_no, 0);
11018 SvLEN_set(&PL_sv_no, 1);
11019 SvIV_set(&PL_sv_no, 0);
11020 SvNV_set(&PL_sv_no, 0);
11021 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11023 SvANY(&PL_sv_yes) = new_XPVNV();
11024 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11025 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11026 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11027 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11028 SvCUR_set(&PL_sv_yes, 1);
11029 SvLEN_set(&PL_sv_yes, 2);
11030 SvIV_set(&PL_sv_yes, 1);
11031 SvNV_set(&PL_sv_yes, 1);
11032 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11034 /* create (a non-shared!) shared string table */
11035 PL_strtab = newHV();
11036 HvSHAREKEYS_off(PL_strtab);
11037 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11038 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11040 PL_compiling = proto_perl->Icompiling;
11042 /* These two PVs will be free'd special way so must set them same way op.c does */
11043 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11044 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11046 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11047 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11049 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11050 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11051 if (PL_compiling.cop_hints_hash) {
11053 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11054 HINTS_REFCNT_UNLOCK;
11056 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11057 #ifdef PERL_DEBUG_READONLY_OPS
11062 /* pseudo environmental stuff */
11063 PL_origargc = proto_perl->Iorigargc;
11064 PL_origargv = proto_perl->Iorigargv;
11066 param->stashes = newAV(); /* Setup array of objects to call clone on */
11068 /* Set tainting stuff before PerlIO_debug can possibly get called */
11069 PL_tainting = proto_perl->Itainting;
11070 PL_taint_warn = proto_perl->Itaint_warn;
11072 #ifdef PERLIO_LAYERS
11073 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11074 PerlIO_clone(aTHX_ proto_perl, param);
11077 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11078 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11079 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11080 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11081 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11082 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11085 PL_minus_c = proto_perl->Iminus_c;
11086 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11087 PL_localpatches = proto_perl->Ilocalpatches;
11088 PL_splitstr = proto_perl->Isplitstr;
11089 PL_preprocess = proto_perl->Ipreprocess;
11090 PL_minus_n = proto_perl->Iminus_n;
11091 PL_minus_p = proto_perl->Iminus_p;
11092 PL_minus_l = proto_perl->Iminus_l;
11093 PL_minus_a = proto_perl->Iminus_a;
11094 PL_minus_E = proto_perl->Iminus_E;
11095 PL_minus_F = proto_perl->Iminus_F;
11096 PL_doswitches = proto_perl->Idoswitches;
11097 PL_dowarn = proto_perl->Idowarn;
11098 PL_doextract = proto_perl->Idoextract;
11099 PL_sawampersand = proto_perl->Isawampersand;
11100 PL_unsafe = proto_perl->Iunsafe;
11101 PL_inplace = SAVEPV(proto_perl->Iinplace);
11102 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11103 PL_perldb = proto_perl->Iperldb;
11104 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11105 PL_exit_flags = proto_perl->Iexit_flags;
11107 /* magical thingies */
11108 /* XXX time(&PL_basetime) when asked for? */
11109 PL_basetime = proto_perl->Ibasetime;
11110 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11112 PL_maxsysfd = proto_perl->Imaxsysfd;
11113 PL_statusvalue = proto_perl->Istatusvalue;
11115 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11117 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11119 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11121 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11122 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11123 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11126 /* RE engine related */
11127 Zero(&PL_reg_state, 1, struct re_save_state);
11128 PL_reginterp_cnt = 0;
11129 PL_regmatch_slab = NULL;
11131 /* Clone the regex array */
11132 PL_regex_padav = newAV();
11134 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11135 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11137 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11138 for(i = 1; i <= len; i++) {
11139 const SV * const regex = regexen[i];
11142 ? sv_dup_inc(regex, param)
11144 newSViv(PTR2IV(CALLREGDUPE(
11145 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11147 if (SvFLAGS(regex) & SVf_BREAK)
11148 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11149 av_push(PL_regex_padav, sv);
11152 PL_regex_pad = AvARRAY(PL_regex_padav);
11154 /* shortcuts to various I/O objects */
11155 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11156 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11157 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11158 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11159 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11160 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11162 /* shortcuts to regexp stuff */
11163 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11165 /* shortcuts to misc objects */
11166 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11168 /* shortcuts to debugging objects */
11169 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11170 PL_DBline = gv_dup(proto_perl->IDBline, param);
11171 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11172 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11173 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11174 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11175 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11177 /* symbol tables */
11178 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11179 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11180 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11181 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11182 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11184 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11185 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11186 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11187 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11188 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11189 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11190 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11191 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11193 PL_sub_generation = proto_perl->Isub_generation;
11194 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11196 /* funky return mechanisms */
11197 PL_forkprocess = proto_perl->Iforkprocess;
11199 /* subprocess state */
11200 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11202 /* internal state */
11203 PL_maxo = proto_perl->Imaxo;
11204 if (proto_perl->Iop_mask)
11205 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11208 /* PL_asserting = proto_perl->Iasserting; */
11210 /* current interpreter roots */
11211 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11213 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11215 PL_main_start = proto_perl->Imain_start;
11216 PL_eval_root = proto_perl->Ieval_root;
11217 PL_eval_start = proto_perl->Ieval_start;
11219 /* runtime control stuff */
11220 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11222 PL_filemode = proto_perl->Ifilemode;
11223 PL_lastfd = proto_perl->Ilastfd;
11224 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11227 PL_gensym = proto_perl->Igensym;
11228 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11229 PL_laststatval = proto_perl->Ilaststatval;
11230 PL_laststype = proto_perl->Ilaststype;
11233 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11235 /* interpreter atexit processing */
11236 PL_exitlistlen = proto_perl->Iexitlistlen;
11237 if (PL_exitlistlen) {
11238 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11239 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11242 PL_exitlist = (PerlExitListEntry*)NULL;
11244 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11245 if (PL_my_cxt_size) {
11246 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11247 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11248 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11249 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11250 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11254 PL_my_cxt_list = (void**)NULL;
11255 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11256 PL_my_cxt_keys = (const char**)NULL;
11259 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11260 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11261 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11263 PL_profiledata = NULL;
11265 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11267 PAD_CLONE_VARS(proto_perl, param);
11269 #ifdef HAVE_INTERP_INTERN
11270 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11273 /* more statics moved here */
11274 PL_generation = proto_perl->Igeneration;
11275 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11277 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11278 PL_in_clean_all = proto_perl->Iin_clean_all;
11280 PL_uid = proto_perl->Iuid;
11281 PL_euid = proto_perl->Ieuid;
11282 PL_gid = proto_perl->Igid;
11283 PL_egid = proto_perl->Iegid;
11284 PL_nomemok = proto_perl->Inomemok;
11285 PL_an = proto_perl->Ian;
11286 PL_evalseq = proto_perl->Ievalseq;
11287 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11288 PL_origalen = proto_perl->Iorigalen;
11289 #ifdef PERL_USES_PL_PIDSTATUS
11290 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11292 PL_osname = SAVEPV(proto_perl->Iosname);
11293 PL_sighandlerp = proto_perl->Isighandlerp;
11295 PL_runops = proto_perl->Irunops;
11297 PL_parser = parser_dup(proto_perl->Iparser, param);
11299 PL_subline = proto_perl->Isubline;
11300 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11303 PL_cryptseen = proto_perl->Icryptseen;
11306 PL_hints = proto_perl->Ihints;
11308 PL_amagic_generation = proto_perl->Iamagic_generation;
11310 #ifdef USE_LOCALE_COLLATE
11311 PL_collation_ix = proto_perl->Icollation_ix;
11312 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11313 PL_collation_standard = proto_perl->Icollation_standard;
11314 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11315 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11316 #endif /* USE_LOCALE_COLLATE */
11318 #ifdef USE_LOCALE_NUMERIC
11319 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11320 PL_numeric_standard = proto_perl->Inumeric_standard;
11321 PL_numeric_local = proto_perl->Inumeric_local;
11322 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11323 #endif /* !USE_LOCALE_NUMERIC */
11325 /* utf8 character classes */
11326 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11327 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11328 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11329 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11330 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11331 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11332 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11333 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11334 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11335 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11336 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11337 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11338 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11339 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11340 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11341 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11342 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11343 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11344 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11345 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11347 /* Did the locale setup indicate UTF-8? */
11348 PL_utf8locale = proto_perl->Iutf8locale;
11349 /* Unicode features (see perlrun/-C) */
11350 PL_unicode = proto_perl->Iunicode;
11352 /* Pre-5.8 signals control */
11353 PL_signals = proto_perl->Isignals;
11355 /* times() ticks per second */
11356 PL_clocktick = proto_perl->Iclocktick;
11358 /* Recursion stopper for PerlIO_find_layer */
11359 PL_in_load_module = proto_perl->Iin_load_module;
11361 /* sort() routine */
11362 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11364 /* Not really needed/useful since the reenrant_retint is "volatile",
11365 * but do it for consistency's sake. */
11366 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11368 /* Hooks to shared SVs and locks. */
11369 PL_sharehook = proto_perl->Isharehook;
11370 PL_lockhook = proto_perl->Ilockhook;
11371 PL_unlockhook = proto_perl->Iunlockhook;
11372 PL_threadhook = proto_perl->Ithreadhook;
11373 PL_destroyhook = proto_perl->Idestroyhook;
11375 #ifdef THREADS_HAVE_PIDS
11376 PL_ppid = proto_perl->Ippid;
11380 PL_last_swash_hv = NULL; /* reinits on demand */
11381 PL_last_swash_klen = 0;
11382 PL_last_swash_key[0]= '\0';
11383 PL_last_swash_tmps = (U8*)NULL;
11384 PL_last_swash_slen = 0;
11386 PL_glob_index = proto_perl->Iglob_index;
11387 PL_srand_called = proto_perl->Isrand_called;
11388 PL_bitcount = NULL; /* reinits on demand */
11390 if (proto_perl->Ipsig_pend) {
11391 Newxz(PL_psig_pend, SIG_SIZE, int);
11394 PL_psig_pend = (int*)NULL;
11397 if (proto_perl->Ipsig_ptr) {
11398 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11399 Newxz(PL_psig_name, SIG_SIZE, SV*);
11400 for (i = 1; i < SIG_SIZE; i++) {
11401 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11402 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11406 PL_psig_ptr = (SV**)NULL;
11407 PL_psig_name = (SV**)NULL;
11410 /* intrpvar.h stuff */
11412 if (flags & CLONEf_COPY_STACKS) {
11413 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11414 PL_tmps_ix = proto_perl->Itmps_ix;
11415 PL_tmps_max = proto_perl->Itmps_max;
11416 PL_tmps_floor = proto_perl->Itmps_floor;
11417 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11419 while (i <= PL_tmps_ix) {
11420 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11424 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11425 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11426 Newxz(PL_markstack, i, I32);
11427 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11428 - proto_perl->Imarkstack);
11429 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11430 - proto_perl->Imarkstack);
11431 Copy(proto_perl->Imarkstack, PL_markstack,
11432 PL_markstack_ptr - PL_markstack + 1, I32);
11434 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11435 * NOTE: unlike the others! */
11436 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11437 PL_scopestack_max = proto_perl->Iscopestack_max;
11438 Newxz(PL_scopestack, PL_scopestack_max, I32);
11439 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11441 /* NOTE: si_dup() looks at PL_markstack */
11442 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11444 /* PL_curstack = PL_curstackinfo->si_stack; */
11445 PL_curstack = av_dup(proto_perl->Icurstack, param);
11446 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11448 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11449 PL_stack_base = AvARRAY(PL_curstack);
11450 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11451 - proto_perl->Istack_base);
11452 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11454 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11455 * NOTE: unlike the others! */
11456 PL_savestack_ix = proto_perl->Isavestack_ix;
11457 PL_savestack_max = proto_perl->Isavestack_max;
11458 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11459 PL_savestack = ss_dup(proto_perl, param);
11463 ENTER; /* perl_destruct() wants to LEAVE; */
11465 /* although we're not duplicating the tmps stack, we should still
11466 * add entries for any SVs on the tmps stack that got cloned by a
11467 * non-refcount means (eg a temp in @_); otherwise they will be
11470 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11471 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11472 proto_perl->Itmps_stack[i]);
11473 if (nsv && !SvREFCNT(nsv)) {
11475 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11480 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11481 PL_top_env = &PL_start_env;
11483 PL_op = proto_perl->Iop;
11486 PL_Xpv = (XPV*)NULL;
11487 PL_na = proto_perl->Ina;
11489 PL_statbuf = proto_perl->Istatbuf;
11490 PL_statcache = proto_perl->Istatcache;
11491 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11492 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11494 PL_timesbuf = proto_perl->Itimesbuf;
11497 PL_tainted = proto_perl->Itainted;
11498 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11499 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11500 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11501 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11502 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11503 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11504 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11505 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11506 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11508 PL_restartop = proto_perl->Irestartop;
11509 PL_in_eval = proto_perl->Iin_eval;
11510 PL_delaymagic = proto_perl->Idelaymagic;
11511 PL_dirty = proto_perl->Idirty;
11512 PL_localizing = proto_perl->Ilocalizing;
11514 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11515 PL_hv_fetch_ent_mh = NULL;
11516 PL_modcount = proto_perl->Imodcount;
11517 PL_lastgotoprobe = NULL;
11518 PL_dumpindent = proto_perl->Idumpindent;
11520 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11521 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11522 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11523 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11524 PL_efloatbuf = NULL; /* reinits on demand */
11525 PL_efloatsize = 0; /* reinits on demand */
11529 PL_screamfirst = NULL;
11530 PL_screamnext = NULL;
11531 PL_maxscream = -1; /* reinits on demand */
11532 PL_lastscream = NULL;
11535 PL_regdummy = proto_perl->Iregdummy;
11536 PL_colorset = 0; /* reinits PL_colors[] */
11537 /*PL_colors[6] = {0,0,0,0,0,0};*/
11541 /* Pluggable optimizer */
11542 PL_peepp = proto_perl->Ipeepp;
11544 PL_stashcache = newHV();
11546 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11547 proto_perl->Iwatchaddr);
11548 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11549 if (PL_debug && PL_watchaddr) {
11550 PerlIO_printf(Perl_debug_log,
11551 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11552 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11553 PTR2UV(PL_watchok));
11556 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11557 ptr_table_free(PL_ptr_table);
11558 PL_ptr_table = NULL;
11561 /* Call the ->CLONE method, if it exists, for each of the stashes
11562 identified by sv_dup() above.
11564 while(av_len(param->stashes) != -1) {
11565 HV* const stash = (HV*) av_shift(param->stashes);
11566 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11567 if (cloner && GvCV(cloner)) {
11572 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11574 call_sv((SV*)GvCV(cloner), G_DISCARD);
11580 SvREFCNT_dec(param->stashes);
11582 /* orphaned? eg threads->new inside BEGIN or use */
11583 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11584 SvREFCNT_inc_simple_void(PL_compcv);
11585 SAVEFREESV(PL_compcv);
11591 #endif /* USE_ITHREADS */
11594 =head1 Unicode Support
11596 =for apidoc sv_recode_to_utf8
11598 The encoding is assumed to be an Encode object, on entry the PV
11599 of the sv is assumed to be octets in that encoding, and the sv
11600 will be converted into Unicode (and UTF-8).
11602 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11603 is not a reference, nothing is done to the sv. If the encoding is not
11604 an C<Encode::XS> Encoding object, bad things will happen.
11605 (See F<lib/encoding.pm> and L<Encode>).
11607 The PV of the sv is returned.
11612 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11615 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11629 Passing sv_yes is wrong - it needs to be or'ed set of constants
11630 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11631 remove converted chars from source.
11633 Both will default the value - let them.
11635 XPUSHs(&PL_sv_yes);
11638 call_method("decode", G_SCALAR);
11642 s = SvPV_const(uni, len);
11643 if (s != SvPVX_const(sv)) {
11644 SvGROW(sv, len + 1);
11645 Move(s, SvPVX(sv), len + 1, char);
11646 SvCUR_set(sv, len);
11653 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11657 =for apidoc sv_cat_decode
11659 The encoding is assumed to be an Encode object, the PV of the ssv is
11660 assumed to be octets in that encoding and decoding the input starts
11661 from the position which (PV + *offset) pointed to. The dsv will be
11662 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11663 when the string tstr appears in decoding output or the input ends on
11664 the PV of the ssv. The value which the offset points will be modified
11665 to the last input position on the ssv.
11667 Returns TRUE if the terminator was found, else returns FALSE.
11672 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11673 SV *ssv, int *offset, char *tstr, int tlen)
11677 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11688 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11689 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11691 call_method("cat_decode", G_SCALAR);
11693 ret = SvTRUE(TOPs);
11694 *offset = SvIV(offsv);
11700 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11705 /* ---------------------------------------------------------------------
11707 * support functions for report_uninit()
11710 /* the maxiumum size of array or hash where we will scan looking
11711 * for the undefined element that triggered the warning */
11713 #define FUV_MAX_SEARCH_SIZE 1000
11715 /* Look for an entry in the hash whose value has the same SV as val;
11716 * If so, return a mortal copy of the key. */
11719 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11722 register HE **array;
11725 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11726 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11729 array = HvARRAY(hv);
11731 for (i=HvMAX(hv); i>0; i--) {
11732 register HE *entry;
11733 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11734 if (HeVAL(entry) != val)
11736 if ( HeVAL(entry) == &PL_sv_undef ||
11737 HeVAL(entry) == &PL_sv_placeholder)
11741 if (HeKLEN(entry) == HEf_SVKEY)
11742 return sv_mortalcopy(HeKEY_sv(entry));
11743 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11749 /* Look for an entry in the array whose value has the same SV as val;
11750 * If so, return the index, otherwise return -1. */
11753 S_find_array_subscript(pTHX_ AV *av, SV* val)
11756 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11757 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11760 if (val != &PL_sv_undef) {
11761 SV ** const svp = AvARRAY(av);
11764 for (i=AvFILLp(av); i>=0; i--)
11771 /* S_varname(): return the name of a variable, optionally with a subscript.
11772 * If gv is non-zero, use the name of that global, along with gvtype (one
11773 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11774 * targ. Depending on the value of the subscript_type flag, return:
11777 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11778 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11779 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11780 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11783 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11784 SV* keyname, I32 aindex, int subscript_type)
11787 SV * const name = sv_newmortal();
11790 buffer[0] = gvtype;
11793 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11795 gv_fullname4(name, gv, buffer, 0);
11797 if ((unsigned int)SvPVX(name)[1] <= 26) {
11799 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11801 /* Swap the 1 unprintable control character for the 2 byte pretty
11802 version - ie substr($name, 1, 1) = $buffer; */
11803 sv_insert(name, 1, 1, buffer, 2);
11807 CV * const cv = find_runcv(NULL);
11811 if (!cv || !CvPADLIST(cv))
11813 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11814 sv = *av_fetch(av, targ, FALSE);
11815 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11818 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11819 SV * const sv = newSV(0);
11820 *SvPVX(name) = '$';
11821 Perl_sv_catpvf(aTHX_ name, "{%s}",
11822 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11825 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11826 *SvPVX(name) = '$';
11827 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11829 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11830 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11837 =for apidoc find_uninit_var
11839 Find the name of the undefined variable (if any) that caused the operator o
11840 to issue a "Use of uninitialized value" warning.
11841 If match is true, only return a name if it's value matches uninit_sv.
11842 So roughly speaking, if a unary operator (such as OP_COS) generates a
11843 warning, then following the direct child of the op may yield an
11844 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11845 other hand, with OP_ADD there are two branches to follow, so we only print
11846 the variable name if we get an exact match.
11848 The name is returned as a mortal SV.
11850 Assumes that PL_op is the op that originally triggered the error, and that
11851 PL_comppad/PL_curpad points to the currently executing pad.
11857 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11865 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11866 uninit_sv == &PL_sv_placeholder)))
11869 switch (obase->op_type) {
11876 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11877 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11880 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11882 if (pad) { /* @lex, %lex */
11883 sv = PAD_SVl(obase->op_targ);
11887 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11888 /* @global, %global */
11889 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11892 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11894 else /* @{expr}, %{expr} */
11895 return find_uninit_var(cUNOPx(obase)->op_first,
11899 /* attempt to find a match within the aggregate */
11901 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11903 subscript_type = FUV_SUBSCRIPT_HASH;
11906 index = find_array_subscript((AV*)sv, uninit_sv);
11908 subscript_type = FUV_SUBSCRIPT_ARRAY;
11911 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11914 return varname(gv, hash ? '%' : '@', obase->op_targ,
11915 keysv, index, subscript_type);
11919 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11921 return varname(NULL, '$', obase->op_targ,
11922 NULL, 0, FUV_SUBSCRIPT_NONE);
11925 gv = cGVOPx_gv(obase);
11926 if (!gv || (match && GvSV(gv) != uninit_sv))
11928 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11931 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11934 av = (AV*)PAD_SV(obase->op_targ);
11935 if (!av || SvRMAGICAL(av))
11937 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11938 if (!svp || *svp != uninit_sv)
11941 return varname(NULL, '$', obase->op_targ,
11942 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11945 gv = cGVOPx_gv(obase);
11951 if (!av || SvRMAGICAL(av))
11953 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11954 if (!svp || *svp != uninit_sv)
11957 return varname(gv, '$', 0,
11958 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11963 o = cUNOPx(obase)->op_first;
11964 if (!o || o->op_type != OP_NULL ||
11965 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11967 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11971 if (PL_op == obase)
11972 /* $a[uninit_expr] or $h{uninit_expr} */
11973 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11976 o = cBINOPx(obase)->op_first;
11977 kid = cBINOPx(obase)->op_last;
11979 /* get the av or hv, and optionally the gv */
11981 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11982 sv = PAD_SV(o->op_targ);
11984 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11985 && cUNOPo->op_first->op_type == OP_GV)
11987 gv = cGVOPx_gv(cUNOPo->op_first);
11990 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
11995 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
11996 /* index is constant */
12000 if (obase->op_type == OP_HELEM) {
12001 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12002 if (!he || HeVAL(he) != uninit_sv)
12006 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12007 if (!svp || *svp != uninit_sv)
12011 if (obase->op_type == OP_HELEM)
12012 return varname(gv, '%', o->op_targ,
12013 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12015 return varname(gv, '@', o->op_targ, NULL,
12016 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12019 /* index is an expression;
12020 * attempt to find a match within the aggregate */
12021 if (obase->op_type == OP_HELEM) {
12022 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12024 return varname(gv, '%', o->op_targ,
12025 keysv, 0, FUV_SUBSCRIPT_HASH);
12028 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12030 return varname(gv, '@', o->op_targ,
12031 NULL, index, FUV_SUBSCRIPT_ARRAY);
12036 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12038 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12043 /* only examine RHS */
12044 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12047 o = cUNOPx(obase)->op_first;
12048 if (o->op_type == OP_PUSHMARK)
12051 if (!o->op_sibling) {
12052 /* one-arg version of open is highly magical */
12054 if (o->op_type == OP_GV) { /* open FOO; */
12056 if (match && GvSV(gv) != uninit_sv)
12058 return varname(gv, '$', 0,
12059 NULL, 0, FUV_SUBSCRIPT_NONE);
12061 /* other possibilities not handled are:
12062 * open $x; or open my $x; should return '${*$x}'
12063 * open expr; should return '$'.expr ideally
12069 /* ops where $_ may be an implicit arg */
12073 if ( !(obase->op_flags & OPf_STACKED)) {
12074 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12075 ? PAD_SVl(obase->op_targ)
12078 sv = sv_newmortal();
12079 sv_setpvn(sv, "$_", 2);
12088 /* skip filehandle as it can't produce 'undef' warning */
12089 o = cUNOPx(obase)->op_first;
12090 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12091 o = o->op_sibling->op_sibling;
12097 match = 1; /* XS or custom code could trigger random warnings */
12102 /* XXX tmp hack: these two may call an XS sub, and currently
12103 XS subs don't have a SUB entry on the context stack, so CV and
12104 pad determination goes wrong, and BAD things happen. So, just
12105 don't try to determine the value under those circumstances.
12106 Need a better fix at dome point. DAPM 11/2007 */
12110 /* def-ness of rval pos() is independent of the def-ness of its arg */
12111 if ( !(obase->op_flags & OPf_MOD))
12116 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12117 return sv_2mortal(newSVpvs("${$/}"));
12122 if (!(obase->op_flags & OPf_KIDS))
12124 o = cUNOPx(obase)->op_first;
12130 /* if all except one arg are constant, or have no side-effects,
12131 * or are optimized away, then it's unambiguous */
12133 for (kid=o; kid; kid = kid->op_sibling) {
12135 const OPCODE type = kid->op_type;
12136 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12137 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12138 || (type == OP_PUSHMARK)
12142 if (o2) { /* more than one found */
12149 return find_uninit_var(o2, uninit_sv, match);
12151 /* scan all args */
12153 sv = find_uninit_var(o, uninit_sv, 1);
12165 =for apidoc report_uninit
12167 Print appropriate "Use of uninitialized variable" warning
12173 Perl_report_uninit(pTHX_ SV* uninit_sv)
12177 SV* varname = NULL;
12179 varname = find_uninit_var(PL_op, uninit_sv,0);
12181 sv_insert(varname, 0, 0, " ", 1);
12183 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12184 varname ? SvPV_nolen_const(varname) : "",
12185 " in ", OP_DESC(PL_op));
12188 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12194 * c-indentation-style: bsd
12195 * c-basic-offset: 4
12196 * indent-tabs-mode: t
12199 * ex: set ts=8 sts=4 sw=4 noet: