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 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(struct regexp), sizeof(struct regexp), 0,
921 SVt_REGEXP, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(struct regexp))
925 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
929 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
932 { sizeof(xpvav_allocated),
933 copy_length(XPVAV, xmg_stash)
934 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
935 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
936 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
938 { sizeof(xpvhv_allocated),
939 copy_length(XPVHV, xmg_stash)
940 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
941 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
942 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
945 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
946 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
947 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
949 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
950 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
951 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
953 /* XPVIO is 84 bytes, fits 48x */
954 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
955 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
958 #define new_body_type(sv_type) \
959 (void *)((char *)S_new_body(aTHX_ sv_type))
961 #define del_body_type(p, sv_type) \
962 del_body(p, &PL_body_roots[sv_type])
965 #define new_body_allocated(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ sv_type) \
967 - bodies_by_type[sv_type].offset)
969 #define del_body_allocated(p, sv_type) \
970 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
973 #define my_safemalloc(s) (void*)safemalloc(s)
974 #define my_safecalloc(s) (void*)safecalloc(s, 1)
975 #define my_safefree(p) safefree((char*)p)
979 #define new_XNV() my_safemalloc(sizeof(XPVNV))
980 #define del_XNV(p) my_safefree(p)
982 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
983 #define del_XPVNV(p) my_safefree(p)
985 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
986 #define del_XPVAV(p) my_safefree(p)
988 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
989 #define del_XPVHV(p) my_safefree(p)
991 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
992 #define del_XPVMG(p) my_safefree(p)
994 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
995 #define del_XPVGV(p) my_safefree(p)
999 #define new_XNV() new_body_type(SVt_NV)
1000 #define del_XNV(p) del_body_type(p, SVt_NV)
1002 #define new_XPVNV() new_body_type(SVt_PVNV)
1003 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1005 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1006 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1008 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1009 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1011 #define new_XPVMG() new_body_type(SVt_PVMG)
1012 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1014 #define new_XPVGV() new_body_type(SVt_PVGV)
1015 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1019 /* no arena for you! */
1021 #define new_NOARENA(details) \
1022 my_safemalloc((details)->body_size + (details)->offset)
1023 #define new_NOARENAZ(details) \
1024 my_safecalloc((details)->body_size + (details)->offset)
1027 S_more_bodies (pTHX_ svtype sv_type)
1030 void ** const root = &PL_body_roots[sv_type];
1031 const struct body_details * const bdp = &bodies_by_type[sv_type];
1032 const size_t body_size = bdp->body_size;
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1038 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1039 * variables like done_sanity_check. */
1040 if (!done_sanity_check) {
1041 unsigned int i = SVt_LAST;
1043 done_sanity_check = TRUE;
1046 assert (bodies_by_type[i].type == i);
1050 assert(bdp->arena_size);
1052 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1054 end = start + bdp->arena_size - body_size;
1056 /* computed count doesnt reflect the 1st slot reservation */
1057 DEBUG_m(PerlIO_printf(Perl_debug_log,
1058 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1059 (void*)start, (void*)end,
1060 (int)bdp->arena_size, sv_type, (int)body_size,
1061 (int)bdp->arena_size / (int)body_size));
1063 *root = (void *)start;
1065 while (start < end) {
1066 char * const next = start + body_size;
1067 *(void**) start = (void *)next;
1070 *(void **)start = 0;
1075 /* grab a new thing from the free list, allocating more if necessary.
1076 The inline version is used for speed in hot routines, and the
1077 function using it serves the rest (unless PURIFY).
1079 #define new_body_inline(xpv, sv_type) \
1081 void ** const r3wt = &PL_body_roots[sv_type]; \
1082 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1083 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1084 *(r3wt) = *(void**)(xpv); \
1090 S_new_body(pTHX_ svtype sv_type)
1094 new_body_inline(xpv, sv_type);
1100 static const struct body_details fake_rv =
1101 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1104 =for apidoc sv_upgrade
1106 Upgrade an SV to a more complex form. Generally adds a new body type to the
1107 SV, then copies across as much information as possible from the old body.
1108 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1114 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1119 const svtype old_type = SvTYPE(sv);
1120 const struct body_details *new_type_details;
1121 const struct body_details *old_type_details
1122 = bodies_by_type + old_type;
1123 SV *referant = NULL;
1125 if (new_type != SVt_PV && SvIsCOW(sv)) {
1126 sv_force_normal_flags(sv, 0);
1129 if (old_type == new_type)
1132 old_body = SvANY(sv);
1134 /* Copying structures onto other structures that have been neatly zeroed
1135 has a subtle gotcha. Consider XPVMG
1137 +------+------+------+------+------+-------+-------+
1138 | NV | CUR | LEN | IV | MAGIC | STASH |
1139 +------+------+------+------+------+-------+-------+
1140 0 4 8 12 16 20 24 28
1142 where NVs are aligned to 8 bytes, so that sizeof that structure is
1143 actually 32 bytes long, with 4 bytes of padding at the end:
1145 +------+------+------+------+------+-------+-------+------+
1146 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1147 +------+------+------+------+------+-------+-------+------+
1148 0 4 8 12 16 20 24 28 32
1150 so what happens if you allocate memory for this structure:
1152 +------+------+------+------+------+-------+-------+------+------+...
1153 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 0 4 8 12 16 20 24 28 32 36
1157 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1158 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1159 started out as zero once, but it's quite possible that it isn't. So now,
1160 rather than a nicely zeroed GP, you have it pointing somewhere random.
1163 (In fact, GP ends up pointing at a previous GP structure, because the
1164 principle cause of the padding in XPVMG getting garbage is a copy of
1165 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1166 this happens to be moot because XPVGV has been re-ordered, with GP
1167 no longer after STASH)
1169 So we are careful and work out the size of used parts of all the
1177 referant = SvRV(sv);
1178 old_type_details = &fake_rv;
1179 if (new_type == SVt_NV)
1180 new_type = SVt_PVNV;
1182 if (new_type < SVt_PVIV) {
1183 new_type = (new_type == SVt_NV)
1184 ? SVt_PVNV : SVt_PVIV;
1189 if (new_type < SVt_PVNV) {
1190 new_type = SVt_PVNV;
1194 assert(new_type > SVt_PV);
1195 assert(SVt_IV < SVt_PV);
1196 assert(SVt_NV < SVt_PV);
1203 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1204 there's no way that it can be safely upgraded, because perl.c
1205 expects to Safefree(SvANY(PL_mess_sv)) */
1206 assert(sv != PL_mess_sv);
1207 /* This flag bit is used to mean other things in other scalar types.
1208 Given that it only has meaning inside the pad, it shouldn't be set
1209 on anything that can get upgraded. */
1210 assert(!SvPAD_TYPED(sv));
1213 if (old_type_details->cant_upgrade)
1214 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1215 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1218 if (old_type > new_type)
1219 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1220 (int)old_type, (int)new_type);
1222 new_type_details = bodies_by_type + new_type;
1224 SvFLAGS(sv) &= ~SVTYPEMASK;
1225 SvFLAGS(sv) |= new_type;
1227 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1228 the return statements above will have triggered. */
1229 assert (new_type != SVt_NULL);
1232 assert(old_type == SVt_NULL);
1233 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1237 assert(old_type == SVt_NULL);
1238 SvANY(sv) = new_XNV();
1243 assert(new_type_details->body_size);
1246 assert(new_type_details->arena);
1247 assert(new_type_details->arena_size);
1248 /* This points to the start of the allocated area. */
1249 new_body_inline(new_body, new_type);
1250 Zero(new_body, new_type_details->body_size, char);
1251 new_body = ((char *)new_body) - new_type_details->offset;
1253 /* We always allocated the full length item with PURIFY. To do this
1254 we fake things so that arena is false for all 16 types.. */
1255 new_body = new_NOARENAZ(new_type_details);
1257 SvANY(sv) = new_body;
1258 if (new_type == SVt_PVAV) {
1262 if (old_type_details->body_size) {
1265 /* It will have been zeroed when the new body was allocated.
1266 Lets not write to it, in case it confuses a write-back
1272 #ifndef NODEFAULT_SHAREKEYS
1273 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1275 HvMAX(sv) = 7; /* (start with 8 buckets) */
1276 if (old_type_details->body_size) {
1279 /* It will have been zeroed when the new body was allocated.
1280 Lets not write to it, in case it confuses a write-back
1285 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1286 The target created by newSVrv also is, and it can have magic.
1287 However, it never has SvPVX set.
1289 if (old_type == SVt_IV) {
1291 } else if (old_type >= SVt_PV) {
1292 assert(SvPVX_const(sv) == 0);
1295 if (old_type >= SVt_PVMG) {
1296 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1297 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1299 sv->sv_u.svu_array = NULL; /* or svu_hash */
1305 /* XXX Is this still needed? Was it ever needed? Surely as there is
1306 no route from NV to PVIV, NOK can never be true */
1307 assert(!SvNOKp(sv));
1319 assert(new_type_details->body_size);
1320 /* We always allocated the full length item with PURIFY. To do this
1321 we fake things so that arena is false for all 16 types.. */
1322 if(new_type_details->arena) {
1323 /* This points to the start of the allocated area. */
1324 new_body_inline(new_body, new_type);
1325 Zero(new_body, new_type_details->body_size, char);
1326 new_body = ((char *)new_body) - new_type_details->offset;
1328 new_body = new_NOARENAZ(new_type_details);
1330 SvANY(sv) = new_body;
1332 if (old_type_details->copy) {
1333 /* There is now the potential for an upgrade from something without
1334 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1335 int offset = old_type_details->offset;
1336 int length = old_type_details->copy;
1338 if (new_type_details->offset > old_type_details->offset) {
1339 const int difference
1340 = new_type_details->offset - old_type_details->offset;
1341 offset += difference;
1342 length -= difference;
1344 assert (length >= 0);
1346 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1350 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1351 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1352 * correct 0.0 for us. Otherwise, if the old body didn't have an
1353 * NV slot, but the new one does, then we need to initialise the
1354 * freshly created NV slot with whatever the correct bit pattern is
1356 if (old_type_details->zero_nv && !new_type_details->zero_nv
1357 && !isGV_with_GP(sv))
1361 if (new_type == SVt_PVIO)
1362 IoPAGE_LEN(sv) = 60;
1363 if (old_type < SVt_PV) {
1364 /* referant will be NULL unless the old type was SVt_IV emulating
1366 sv->sv_u.svu_rv = referant;
1370 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1371 (unsigned long)new_type);
1374 if (old_type_details->arena) {
1375 /* If there was an old body, then we need to free it.
1376 Note that there is an assumption that all bodies of types that
1377 can be upgraded came from arenas. Only the more complex non-
1378 upgradable types are allowed to be directly malloc()ed. */
1380 my_safefree(old_body);
1382 del_body((void*)((char*)old_body + old_type_details->offset),
1383 &PL_body_roots[old_type]);
1389 =for apidoc sv_backoff
1391 Remove any string offset. You should normally use the C<SvOOK_off> macro
1398 Perl_sv_backoff(pTHX_ register SV *sv)
1401 const char * const s = SvPVX_const(sv);
1402 PERL_UNUSED_CONTEXT;
1404 assert(SvTYPE(sv) != SVt_PVHV);
1405 assert(SvTYPE(sv) != SVt_PVAV);
1407 SvOOK_offset(sv, delta);
1409 SvLEN_set(sv, SvLEN(sv) + delta);
1410 SvPV_set(sv, SvPVX(sv) - delta);
1411 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1412 SvFLAGS(sv) &= ~SVf_OOK;
1419 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1420 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1421 Use the C<SvGROW> wrapper instead.
1427 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1431 if (PL_madskills && newlen >= 0x100000) {
1432 PerlIO_printf(Perl_debug_log,
1433 "Allocation too large: %"UVxf"\n", (UV)newlen);
1435 #ifdef HAS_64K_LIMIT
1436 if (newlen >= 0x10000) {
1437 PerlIO_printf(Perl_debug_log,
1438 "Allocation too large: %"UVxf"\n", (UV)newlen);
1441 #endif /* HAS_64K_LIMIT */
1444 if (SvTYPE(sv) < SVt_PV) {
1445 sv_upgrade(sv, SVt_PV);
1446 s = SvPVX_mutable(sv);
1448 else if (SvOOK(sv)) { /* pv is offset? */
1450 s = SvPVX_mutable(sv);
1451 if (newlen > SvLEN(sv))
1452 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1453 #ifdef HAS_64K_LIMIT
1454 if (newlen >= 0x10000)
1459 s = SvPVX_mutable(sv);
1461 if (newlen > SvLEN(sv)) { /* need more room? */
1462 newlen = PERL_STRLEN_ROUNDUP(newlen);
1463 if (SvLEN(sv) && s) {
1465 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1471 s = (char*)saferealloc(s, newlen);
1474 s = (char*)safemalloc(newlen);
1475 if (SvPVX_const(sv) && SvCUR(sv)) {
1476 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1480 SvLEN_set(sv, newlen);
1486 =for apidoc sv_setiv
1488 Copies an integer into the given SV, upgrading first if necessary.
1489 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1495 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1498 SV_CHECK_THINKFIRST_COW_DROP(sv);
1499 switch (SvTYPE(sv)) {
1502 sv_upgrade(sv, SVt_IV);
1505 sv_upgrade(sv, SVt_PVIV);
1514 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1518 (void)SvIOK_only(sv); /* validate number */
1524 =for apidoc sv_setiv_mg
1526 Like C<sv_setiv>, but also handles 'set' magic.
1532 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1539 =for apidoc sv_setuv
1541 Copies an unsigned integer into the given SV, upgrading first if necessary.
1542 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1548 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1550 /* With these two if statements:
1551 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1554 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1556 If you wish to remove them, please benchmark to see what the effect is
1558 if (u <= (UV)IV_MAX) {
1559 sv_setiv(sv, (IV)u);
1568 =for apidoc sv_setuv_mg
1570 Like C<sv_setuv>, but also handles 'set' magic.
1576 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1583 =for apidoc sv_setnv
1585 Copies a double into the given SV, upgrading first if necessary.
1586 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1592 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1595 SV_CHECK_THINKFIRST_COW_DROP(sv);
1596 switch (SvTYPE(sv)) {
1599 sv_upgrade(sv, SVt_NV);
1603 sv_upgrade(sv, SVt_PVNV);
1612 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1617 (void)SvNOK_only(sv); /* validate number */
1622 =for apidoc sv_setnv_mg
1624 Like C<sv_setnv>, but also handles 'set' magic.
1630 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1636 /* Print an "isn't numeric" warning, using a cleaned-up,
1637 * printable version of the offending string
1641 S_not_a_number(pTHX_ SV *sv)
1649 dsv = newSVpvs_flags("", SVs_TEMP);
1650 pv = sv_uni_display(dsv, sv, 10, 0);
1653 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1654 /* each *s can expand to 4 chars + "...\0",
1655 i.e. need room for 8 chars */
1657 const char *s = SvPVX_const(sv);
1658 const char * const end = s + SvCUR(sv);
1659 for ( ; s < end && d < limit; s++ ) {
1661 if (ch & 128 && !isPRINT_LC(ch)) {
1670 else if (ch == '\r') {
1674 else if (ch == '\f') {
1678 else if (ch == '\\') {
1682 else if (ch == '\0') {
1686 else if (isPRINT_LC(ch))
1703 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1704 "Argument \"%s\" isn't numeric in %s", pv,
1707 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1708 "Argument \"%s\" isn't numeric", pv);
1712 =for apidoc looks_like_number
1714 Test if the content of an SV looks like a number (or is a number).
1715 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1716 non-numeric warning), even if your atof() doesn't grok them.
1722 Perl_looks_like_number(pTHX_ SV *sv)
1724 register const char *sbegin;
1728 sbegin = SvPVX_const(sv);
1731 else if (SvPOKp(sv))
1732 sbegin = SvPV_const(sv, len);
1734 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1735 return grok_number(sbegin, len, NULL);
1739 S_glob_2number(pTHX_ GV * const gv)
1741 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1742 SV *const buffer = sv_newmortal();
1744 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1747 gv_efullname3(buffer, gv, "*");
1748 SvFLAGS(gv) |= wasfake;
1750 /* We know that all GVs stringify to something that is not-a-number,
1751 so no need to test that. */
1752 if (ckWARN(WARN_NUMERIC))
1753 not_a_number(buffer);
1754 /* We just want something true to return, so that S_sv_2iuv_common
1755 can tail call us and return true. */
1760 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1762 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1763 SV *const buffer = sv_newmortal();
1765 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1768 gv_efullname3(buffer, gv, "*");
1769 SvFLAGS(gv) |= wasfake;
1771 assert(SvPOK(buffer));
1773 *len = SvCUR(buffer);
1775 return SvPVX(buffer);
1778 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1779 until proven guilty, assume that things are not that bad... */
1784 As 64 bit platforms often have an NV that doesn't preserve all bits of
1785 an IV (an assumption perl has been based on to date) it becomes necessary
1786 to remove the assumption that the NV always carries enough precision to
1787 recreate the IV whenever needed, and that the NV is the canonical form.
1788 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1789 precision as a side effect of conversion (which would lead to insanity
1790 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1791 1) to distinguish between IV/UV/NV slots that have cached a valid
1792 conversion where precision was lost and IV/UV/NV slots that have a
1793 valid conversion which has lost no precision
1794 2) to ensure that if a numeric conversion to one form is requested that
1795 would lose precision, the precise conversion (or differently
1796 imprecise conversion) is also performed and cached, to prevent
1797 requests for different numeric formats on the same SV causing
1798 lossy conversion chains. (lossless conversion chains are perfectly
1803 SvIOKp is true if the IV slot contains a valid value
1804 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1805 SvNOKp is true if the NV slot contains a valid value
1806 SvNOK is true only if the NV value is accurate
1809 while converting from PV to NV, check to see if converting that NV to an
1810 IV(or UV) would lose accuracy over a direct conversion from PV to
1811 IV(or UV). If it would, cache both conversions, return NV, but mark
1812 SV as IOK NOKp (ie not NOK).
1814 While converting from PV to IV, check to see if converting that IV to an
1815 NV would lose accuracy over a direct conversion from PV to NV. If it
1816 would, cache both conversions, flag similarly.
1818 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1819 correctly because if IV & NV were set NV *always* overruled.
1820 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1821 changes - now IV and NV together means that the two are interchangeable:
1822 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1824 The benefit of this is that operations such as pp_add know that if
1825 SvIOK is true for both left and right operands, then integer addition
1826 can be used instead of floating point (for cases where the result won't
1827 overflow). Before, floating point was always used, which could lead to
1828 loss of precision compared with integer addition.
1830 * making IV and NV equal status should make maths accurate on 64 bit
1832 * may speed up maths somewhat if pp_add and friends start to use
1833 integers when possible instead of fp. (Hopefully the overhead in
1834 looking for SvIOK and checking for overflow will not outweigh the
1835 fp to integer speedup)
1836 * will slow down integer operations (callers of SvIV) on "inaccurate"
1837 values, as the change from SvIOK to SvIOKp will cause a call into
1838 sv_2iv each time rather than a macro access direct to the IV slot
1839 * should speed up number->string conversion on integers as IV is
1840 favoured when IV and NV are equally accurate
1842 ####################################################################
1843 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1844 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1845 On the other hand, SvUOK is true iff UV.
1846 ####################################################################
1848 Your mileage will vary depending your CPU's relative fp to integer
1852 #ifndef NV_PRESERVES_UV
1853 # define IS_NUMBER_UNDERFLOW_IV 1
1854 # define IS_NUMBER_UNDERFLOW_UV 2
1855 # define IS_NUMBER_IV_AND_UV 2
1856 # define IS_NUMBER_OVERFLOW_IV 4
1857 # define IS_NUMBER_OVERFLOW_UV 5
1859 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1861 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1863 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1866 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1867 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));
1868 if (SvNVX(sv) < (NV)IV_MIN) {
1869 (void)SvIOKp_on(sv);
1871 SvIV_set(sv, IV_MIN);
1872 return IS_NUMBER_UNDERFLOW_IV;
1874 if (SvNVX(sv) > (NV)UV_MAX) {
1875 (void)SvIOKp_on(sv);
1878 SvUV_set(sv, UV_MAX);
1879 return IS_NUMBER_OVERFLOW_UV;
1881 (void)SvIOKp_on(sv);
1883 /* Can't use strtol etc to convert this string. (See truth table in
1885 if (SvNVX(sv) <= (UV)IV_MAX) {
1886 SvIV_set(sv, I_V(SvNVX(sv)));
1887 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1888 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1890 /* Integer is imprecise. NOK, IOKp */
1892 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1895 SvUV_set(sv, U_V(SvNVX(sv)));
1896 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1897 if (SvUVX(sv) == UV_MAX) {
1898 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1899 possibly be preserved by NV. Hence, it must be overflow.
1901 return IS_NUMBER_OVERFLOW_UV;
1903 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1905 /* Integer is imprecise. NOK, IOKp */
1907 return IS_NUMBER_OVERFLOW_IV;
1909 #endif /* !NV_PRESERVES_UV*/
1912 S_sv_2iuv_common(pTHX_ SV *sv) {
1915 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1916 * without also getting a cached IV/UV from it at the same time
1917 * (ie PV->NV conversion should detect loss of accuracy and cache
1918 * IV or UV at same time to avoid this. */
1919 /* IV-over-UV optimisation - choose to cache IV if possible */
1921 if (SvTYPE(sv) == SVt_NV)
1922 sv_upgrade(sv, SVt_PVNV);
1924 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1925 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1926 certainly cast into the IV range at IV_MAX, whereas the correct
1927 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1929 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1930 if (Perl_isnan(SvNVX(sv))) {
1936 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1937 SvIV_set(sv, I_V(SvNVX(sv)));
1938 if (SvNVX(sv) == (NV) SvIVX(sv)
1939 #ifndef NV_PRESERVES_UV
1940 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1941 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1942 /* Don't flag it as "accurately an integer" if the number
1943 came from a (by definition imprecise) NV operation, and
1944 we're outside the range of NV integer precision */
1947 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1948 DEBUG_c(PerlIO_printf(Perl_debug_log,
1949 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1955 /* IV not precise. No need to convert from PV, as NV
1956 conversion would already have cached IV if it detected
1957 that PV->IV would be better than PV->NV->IV
1958 flags already correct - don't set public IOK. */
1959 DEBUG_c(PerlIO_printf(Perl_debug_log,
1960 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1965 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1966 but the cast (NV)IV_MIN rounds to a the value less (more
1967 negative) than IV_MIN which happens to be equal to SvNVX ??
1968 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1969 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1970 (NV)UVX == NVX are both true, but the values differ. :-(
1971 Hopefully for 2s complement IV_MIN is something like
1972 0x8000000000000000 which will be exact. NWC */
1975 SvUV_set(sv, U_V(SvNVX(sv)));
1977 (SvNVX(sv) == (NV) SvUVX(sv))
1978 #ifndef NV_PRESERVES_UV
1979 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1980 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1981 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1982 /* Don't flag it as "accurately an integer" if the number
1983 came from a (by definition imprecise) NV operation, and
1984 we're outside the range of NV integer precision */
1989 DEBUG_c(PerlIO_printf(Perl_debug_log,
1990 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1996 else if (SvPOKp(sv) && SvLEN(sv)) {
1998 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1999 /* We want to avoid a possible problem when we cache an IV/ a UV which
2000 may be later translated to an NV, and the resulting NV is not
2001 the same as the direct translation of the initial string
2002 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2003 be careful to ensure that the value with the .456 is around if the
2004 NV value is requested in the future).
2006 This means that if we cache such an IV/a UV, we need to cache the
2007 NV as well. Moreover, we trade speed for space, and do not
2008 cache the NV if we are sure it's not needed.
2011 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2012 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2013 == IS_NUMBER_IN_UV) {
2014 /* It's definitely an integer, only upgrade to PVIV */
2015 if (SvTYPE(sv) < SVt_PVIV)
2016 sv_upgrade(sv, SVt_PVIV);
2018 } else if (SvTYPE(sv) < SVt_PVNV)
2019 sv_upgrade(sv, SVt_PVNV);
2021 /* If NVs preserve UVs then we only use the UV value if we know that
2022 we aren't going to call atof() below. If NVs don't preserve UVs
2023 then the value returned may have more precision than atof() will
2024 return, even though value isn't perfectly accurate. */
2025 if ((numtype & (IS_NUMBER_IN_UV
2026 #ifdef NV_PRESERVES_UV
2029 )) == IS_NUMBER_IN_UV) {
2030 /* This won't turn off the public IOK flag if it was set above */
2031 (void)SvIOKp_on(sv);
2033 if (!(numtype & IS_NUMBER_NEG)) {
2035 if (value <= (UV)IV_MAX) {
2036 SvIV_set(sv, (IV)value);
2038 /* it didn't overflow, and it was positive. */
2039 SvUV_set(sv, value);
2043 /* 2s complement assumption */
2044 if (value <= (UV)IV_MIN) {
2045 SvIV_set(sv, -(IV)value);
2047 /* Too negative for an IV. This is a double upgrade, but
2048 I'm assuming it will be rare. */
2049 if (SvTYPE(sv) < SVt_PVNV)
2050 sv_upgrade(sv, SVt_PVNV);
2054 SvNV_set(sv, -(NV)value);
2055 SvIV_set(sv, IV_MIN);
2059 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2060 will be in the previous block to set the IV slot, and the next
2061 block to set the NV slot. So no else here. */
2063 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2064 != IS_NUMBER_IN_UV) {
2065 /* It wasn't an (integer that doesn't overflow the UV). */
2066 SvNV_set(sv, Atof(SvPVX_const(sv)));
2068 if (! numtype && ckWARN(WARN_NUMERIC))
2071 #if defined(USE_LONG_DOUBLE)
2072 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2073 PTR2UV(sv), SvNVX(sv)));
2075 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2076 PTR2UV(sv), SvNVX(sv)));
2079 #ifdef NV_PRESERVES_UV
2080 (void)SvIOKp_on(sv);
2082 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2083 SvIV_set(sv, I_V(SvNVX(sv)));
2084 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2087 NOOP; /* Integer is imprecise. NOK, IOKp */
2089 /* UV will not work better than IV */
2091 if (SvNVX(sv) > (NV)UV_MAX) {
2093 /* Integer is inaccurate. NOK, IOKp, is UV */
2094 SvUV_set(sv, UV_MAX);
2096 SvUV_set(sv, U_V(SvNVX(sv)));
2097 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2098 NV preservse UV so can do correct comparison. */
2099 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2102 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2107 #else /* NV_PRESERVES_UV */
2108 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2109 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2110 /* The IV/UV slot will have been set from value returned by
2111 grok_number above. The NV slot has just been set using
2114 assert (SvIOKp(sv));
2116 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2117 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2118 /* Small enough to preserve all bits. */
2119 (void)SvIOKp_on(sv);
2121 SvIV_set(sv, I_V(SvNVX(sv)));
2122 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2124 /* Assumption: first non-preserved integer is < IV_MAX,
2125 this NV is in the preserved range, therefore: */
2126 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2128 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);
2132 0 0 already failed to read UV.
2133 0 1 already failed to read UV.
2134 1 0 you won't get here in this case. IV/UV
2135 slot set, public IOK, Atof() unneeded.
2136 1 1 already read UV.
2137 so there's no point in sv_2iuv_non_preserve() attempting
2138 to use atol, strtol, strtoul etc. */
2139 sv_2iuv_non_preserve (sv, numtype);
2142 #endif /* NV_PRESERVES_UV */
2146 if (isGV_with_GP(sv))
2147 return glob_2number((GV *)sv);
2149 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2150 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2153 if (SvTYPE(sv) < SVt_IV)
2154 /* Typically the caller expects that sv_any is not NULL now. */
2155 sv_upgrade(sv, SVt_IV);
2156 /* Return 0 from the caller. */
2163 =for apidoc sv_2iv_flags
2165 Return the integer value of an SV, doing any necessary string
2166 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2167 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2173 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2178 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2179 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2180 cache IVs just in case. In practice it seems that they never
2181 actually anywhere accessible by user Perl code, let alone get used
2182 in anything other than a string context. */
2183 if (flags & SV_GMAGIC)
2188 return I_V(SvNVX(sv));
2190 if (SvPOKp(sv) && SvLEN(sv)) {
2193 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2195 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2196 == IS_NUMBER_IN_UV) {
2197 /* It's definitely an integer */
2198 if (numtype & IS_NUMBER_NEG) {
2199 if (value < (UV)IV_MIN)
2202 if (value < (UV)IV_MAX)
2207 if (ckWARN(WARN_NUMERIC))
2210 return I_V(Atof(SvPVX_const(sv)));
2215 assert(SvTYPE(sv) >= SVt_PVMG);
2216 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2217 } else if (SvTHINKFIRST(sv)) {
2221 SV * const tmpstr=AMG_CALLun(sv,numer);
2222 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2223 return SvIV(tmpstr);
2226 return PTR2IV(SvRV(sv));
2229 sv_force_normal_flags(sv, 0);
2231 if (SvREADONLY(sv) && !SvOK(sv)) {
2232 if (ckWARN(WARN_UNINITIALIZED))
2238 if (S_sv_2iuv_common(aTHX_ sv))
2241 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2242 PTR2UV(sv),SvIVX(sv)));
2243 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2247 =for apidoc sv_2uv_flags
2249 Return the unsigned integer value of an SV, doing any necessary string
2250 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2251 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2257 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2262 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2263 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2264 cache IVs just in case. */
2265 if (flags & SV_GMAGIC)
2270 return U_V(SvNVX(sv));
2271 if (SvPOKp(sv) && SvLEN(sv)) {
2274 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2276 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2277 == IS_NUMBER_IN_UV) {
2278 /* It's definitely an integer */
2279 if (!(numtype & IS_NUMBER_NEG))
2283 if (ckWARN(WARN_NUMERIC))
2286 return U_V(Atof(SvPVX_const(sv)));
2291 assert(SvTYPE(sv) >= SVt_PVMG);
2292 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2293 } else if (SvTHINKFIRST(sv)) {
2297 SV *const tmpstr = AMG_CALLun(sv,numer);
2298 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2299 return SvUV(tmpstr);
2302 return PTR2UV(SvRV(sv));
2305 sv_force_normal_flags(sv, 0);
2307 if (SvREADONLY(sv) && !SvOK(sv)) {
2308 if (ckWARN(WARN_UNINITIALIZED))
2314 if (S_sv_2iuv_common(aTHX_ sv))
2318 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2319 PTR2UV(sv),SvUVX(sv)));
2320 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2326 Return the num value of an SV, doing any necessary string or integer
2327 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2334 Perl_sv_2nv(pTHX_ register SV *sv)
2339 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2340 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2341 cache IVs just in case. */
2345 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2346 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2347 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2349 return Atof(SvPVX_const(sv));
2353 return (NV)SvUVX(sv);
2355 return (NV)SvIVX(sv);
2360 assert(SvTYPE(sv) >= SVt_PVMG);
2361 /* This falls through to the report_uninit near the end of the
2363 } else if (SvTHINKFIRST(sv)) {
2367 SV *const tmpstr = AMG_CALLun(sv,numer);
2368 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2369 return SvNV(tmpstr);
2372 return PTR2NV(SvRV(sv));
2375 sv_force_normal_flags(sv, 0);
2377 if (SvREADONLY(sv) && !SvOK(sv)) {
2378 if (ckWARN(WARN_UNINITIALIZED))
2383 if (SvTYPE(sv) < SVt_NV) {
2384 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2385 sv_upgrade(sv, SVt_NV);
2386 #ifdef USE_LONG_DOUBLE
2388 STORE_NUMERIC_LOCAL_SET_STANDARD();
2389 PerlIO_printf(Perl_debug_log,
2390 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2391 PTR2UV(sv), SvNVX(sv));
2392 RESTORE_NUMERIC_LOCAL();
2396 STORE_NUMERIC_LOCAL_SET_STANDARD();
2397 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2398 PTR2UV(sv), SvNVX(sv));
2399 RESTORE_NUMERIC_LOCAL();
2403 else if (SvTYPE(sv) < SVt_PVNV)
2404 sv_upgrade(sv, SVt_PVNV);
2409 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2410 #ifdef NV_PRESERVES_UV
2413 /* Only set the public NV OK flag if this NV preserves the IV */
2414 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2415 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2416 : (SvIVX(sv) == I_V(SvNVX(sv))))
2422 else if (SvPOKp(sv) && SvLEN(sv)) {
2424 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2425 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2427 #ifdef NV_PRESERVES_UV
2428 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2429 == IS_NUMBER_IN_UV) {
2430 /* It's definitely an integer */
2431 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2433 SvNV_set(sv, Atof(SvPVX_const(sv)));
2436 SvNV_set(sv, Atof(SvPVX_const(sv)));
2437 /* Only set the public NV OK flag if this NV preserves the value in
2438 the PV at least as well as an IV/UV would.
2439 Not sure how to do this 100% reliably. */
2440 /* if that shift count is out of range then Configure's test is
2441 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2443 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2444 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2445 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2446 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2447 /* Can't use strtol etc to convert this string, so don't try.
2448 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2451 /* value has been set. It may not be precise. */
2452 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2453 /* 2s complement assumption for (UV)IV_MIN */
2454 SvNOK_on(sv); /* Integer is too negative. */
2459 if (numtype & IS_NUMBER_NEG) {
2460 SvIV_set(sv, -(IV)value);
2461 } else if (value <= (UV)IV_MAX) {
2462 SvIV_set(sv, (IV)value);
2464 SvUV_set(sv, value);
2468 if (numtype & IS_NUMBER_NOT_INT) {
2469 /* I believe that even if the original PV had decimals,
2470 they are lost beyond the limit of the FP precision.
2471 However, neither is canonical, so both only get p
2472 flags. NWC, 2000/11/25 */
2473 /* Both already have p flags, so do nothing */
2475 const NV nv = SvNVX(sv);
2476 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2477 if (SvIVX(sv) == I_V(nv)) {
2480 /* It had no "." so it must be integer. */
2484 /* between IV_MAX and NV(UV_MAX).
2485 Could be slightly > UV_MAX */
2487 if (numtype & IS_NUMBER_NOT_INT) {
2488 /* UV and NV both imprecise. */
2490 const UV nv_as_uv = U_V(nv);
2492 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2501 #endif /* NV_PRESERVES_UV */
2504 if (isGV_with_GP(sv)) {
2505 glob_2number((GV *)sv);
2509 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2511 assert (SvTYPE(sv) >= SVt_NV);
2512 /* Typically the caller expects that sv_any is not NULL now. */
2513 /* XXX Ilya implies that this is a bug in callers that assume this
2514 and ideally should be fixed. */
2517 #if defined(USE_LONG_DOUBLE)
2519 STORE_NUMERIC_LOCAL_SET_STANDARD();
2520 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2521 PTR2UV(sv), SvNVX(sv));
2522 RESTORE_NUMERIC_LOCAL();
2526 STORE_NUMERIC_LOCAL_SET_STANDARD();
2527 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2528 PTR2UV(sv), SvNVX(sv));
2529 RESTORE_NUMERIC_LOCAL();
2538 Return an SV with the numeric value of the source SV, doing any necessary
2539 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2540 access this function.
2546 Perl_sv_2num(pTHX_ register SV *sv)
2551 SV * const tmpsv = AMG_CALLun(sv,numer);
2552 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2553 return sv_2num(tmpsv);
2555 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2558 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2559 * UV as a string towards the end of buf, and return pointers to start and
2562 * We assume that buf is at least TYPE_CHARS(UV) long.
2566 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2568 char *ptr = buf + TYPE_CHARS(UV);
2569 char * const ebuf = ptr;
2582 *--ptr = '0' + (char)(uv % 10);
2591 =for apidoc sv_2pv_flags
2593 Returns a pointer to the string value of an SV, and sets *lp to its length.
2594 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2596 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2597 usually end up here too.
2603 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2613 if (SvGMAGICAL(sv)) {
2614 if (flags & SV_GMAGIC)
2619 if (flags & SV_MUTABLE_RETURN)
2620 return SvPVX_mutable(sv);
2621 if (flags & SV_CONST_RETURN)
2622 return (char *)SvPVX_const(sv);
2625 if (SvIOKp(sv) || SvNOKp(sv)) {
2626 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2631 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2632 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2634 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2641 #ifdef FIXNEGATIVEZERO
2642 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2648 SvUPGRADE(sv, SVt_PV);
2651 s = SvGROW_mutable(sv, len + 1);
2654 return (char*)memcpy(s, tbuf, len + 1);
2660 assert(SvTYPE(sv) >= SVt_PVMG);
2661 /* This falls through to the report_uninit near the end of the
2663 } else if (SvTHINKFIRST(sv)) {
2667 SV *const tmpstr = AMG_CALLun(sv,string);
2668 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2670 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2674 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2675 if (flags & SV_CONST_RETURN) {
2676 pv = (char *) SvPVX_const(tmpstr);
2678 pv = (flags & SV_MUTABLE_RETURN)
2679 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2682 *lp = SvCUR(tmpstr);
2684 pv = sv_2pv_flags(tmpstr, lp, flags);
2697 const SV *const referent = (SV*)SvRV(sv);
2701 retval = buffer = savepvn("NULLREF", len);
2702 } else if (SvTYPE(referent) == SVt_REGEXP) {
2707 /* FIXME - get rid of this cast away of const, or work out
2708 how to do it better. */
2709 temp.mg_obj = (SV *)referent;
2710 assert(temp.mg_obj);
2711 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2716 PL_reginterp_cnt += haseval;
2719 const char *const typestr = sv_reftype(referent, 0);
2720 const STRLEN typelen = strlen(typestr);
2721 UV addr = PTR2UV(referent);
2722 const char *stashname = NULL;
2723 STRLEN stashnamelen = 0; /* hush, gcc */
2724 const char *buffer_end;
2726 if (SvOBJECT(referent)) {
2727 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2730 stashname = HEK_KEY(name);
2731 stashnamelen = HEK_LEN(name);
2733 if (HEK_UTF8(name)) {
2739 stashname = "__ANON__";
2742 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2743 + 2 * sizeof(UV) + 2 /* )\0 */;
2745 len = typelen + 3 /* (0x */
2746 + 2 * sizeof(UV) + 2 /* )\0 */;
2749 Newx(buffer, len, char);
2750 buffer_end = retval = buffer + len;
2752 /* Working backwards */
2756 *--retval = PL_hexdigit[addr & 15];
2757 } while (addr >>= 4);
2763 memcpy(retval, typestr, typelen);
2767 retval -= stashnamelen;
2768 memcpy(retval, stashname, stashnamelen);
2770 /* retval may not neccesarily have reached the start of the
2772 assert (retval >= buffer);
2774 len = buffer_end - retval - 1; /* -1 for that \0 */
2782 if (SvREADONLY(sv) && !SvOK(sv)) {
2783 if (ckWARN(WARN_UNINITIALIZED))
2790 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2791 /* I'm assuming that if both IV and NV are equally valid then
2792 converting the IV is going to be more efficient */
2793 const U32 isUIOK = SvIsUV(sv);
2794 char buf[TYPE_CHARS(UV)];
2798 if (SvTYPE(sv) < SVt_PVIV)
2799 sv_upgrade(sv, SVt_PVIV);
2800 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2802 /* inlined from sv_setpvn */
2803 s = SvGROW_mutable(sv, len + 1);
2804 Move(ptr, s, len, char);
2808 else if (SvNOKp(sv)) {
2809 const int olderrno = errno;
2810 if (SvTYPE(sv) < SVt_PVNV)
2811 sv_upgrade(sv, SVt_PVNV);
2812 /* The +20 is pure guesswork. Configure test needed. --jhi */
2813 s = SvGROW_mutable(sv, NV_DIG + 20);
2814 /* some Xenix systems wipe out errno here */
2816 if (SvNVX(sv) == 0.0)
2817 my_strlcpy(s, "0", SvLEN(sv));
2821 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2824 #ifdef FIXNEGATIVEZERO
2825 if (*s == '-' && s[1] == '0' && !s[2]) {
2837 if (isGV_with_GP(sv))
2838 return glob_2pv((GV *)sv, lp);
2840 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2844 if (SvTYPE(sv) < SVt_PV)
2845 /* Typically the caller expects that sv_any is not NULL now. */
2846 sv_upgrade(sv, SVt_PV);
2850 const STRLEN len = s - SvPVX_const(sv);
2856 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2857 PTR2UV(sv),SvPVX_const(sv)));
2858 if (flags & SV_CONST_RETURN)
2859 return (char *)SvPVX_const(sv);
2860 if (flags & SV_MUTABLE_RETURN)
2861 return SvPVX_mutable(sv);
2866 =for apidoc sv_copypv
2868 Copies a stringified representation of the source SV into the
2869 destination SV. Automatically performs any necessary mg_get and
2870 coercion of numeric values into strings. Guaranteed to preserve
2871 UTF8 flag even from overloaded objects. Similar in nature to
2872 sv_2pv[_flags] but operates directly on an SV instead of just the
2873 string. Mostly uses sv_2pv_flags to do its work, except when that
2874 would lose the UTF-8'ness of the PV.
2880 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2883 const char * const s = SvPV_const(ssv,len);
2884 sv_setpvn(dsv,s,len);
2892 =for apidoc sv_2pvbyte
2894 Return a pointer to the byte-encoded representation of the SV, and set *lp
2895 to its length. May cause the SV to be downgraded from UTF-8 as a
2898 Usually accessed via the C<SvPVbyte> macro.
2904 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2906 sv_utf8_downgrade(sv,0);
2907 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2911 =for apidoc sv_2pvutf8
2913 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2914 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2916 Usually accessed via the C<SvPVutf8> macro.
2922 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2924 sv_utf8_upgrade(sv);
2925 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2930 =for apidoc sv_2bool
2932 This function is only called on magical items, and is only used by
2933 sv_true() or its macro equivalent.
2939 Perl_sv_2bool(pTHX_ register SV *sv)
2948 SV * const tmpsv = AMG_CALLun(sv,bool_);
2949 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2950 return (bool)SvTRUE(tmpsv);
2952 return SvRV(sv) != 0;
2955 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2957 (*sv->sv_u.svu_pv > '0' ||
2958 Xpvtmp->xpv_cur > 1 ||
2959 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2966 return SvIVX(sv) != 0;
2969 return SvNVX(sv) != 0.0;
2971 if (isGV_with_GP(sv))
2981 =for apidoc sv_utf8_upgrade
2983 Converts the PV of an SV to its UTF-8-encoded form.
2984 Forces the SV to string form if it is not already.
2985 Always sets the SvUTF8 flag to avoid future validity checks even
2986 if all the bytes have hibit clear.
2988 This is not as a general purpose byte encoding to Unicode interface:
2989 use the Encode extension for that.
2991 =for apidoc sv_utf8_upgrade_flags
2993 Converts the PV of an SV to its UTF-8-encoded form.
2994 Forces the SV to string form if it is not already.
2995 Always sets the SvUTF8 flag to avoid future validity checks even
2996 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2997 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2998 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3000 This is not as a general purpose byte encoding to Unicode interface:
3001 use the Encode extension for that.
3007 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3010 if (sv == &PL_sv_undef)
3014 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3015 (void) sv_2pv_flags(sv,&len, flags);
3019 (void) SvPV_force(sv,len);
3028 sv_force_normal_flags(sv, 0);
3031 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3032 sv_recode_to_utf8(sv, PL_encoding);
3033 else { /* Assume Latin-1/EBCDIC */
3034 /* This function could be much more efficient if we
3035 * had a FLAG in SVs to signal if there are any hibit
3036 * chars in the PV. Given that there isn't such a flag
3037 * make the loop as fast as possible. */
3038 const U8 * const s = (U8 *) SvPVX_const(sv);
3039 const U8 * const e = (U8 *) SvEND(sv);
3044 /* Check for hi bit */
3045 if (!NATIVE_IS_INVARIANT(ch)) {
3046 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3047 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3049 SvPV_free(sv); /* No longer using what was there before. */
3050 SvPV_set(sv, (char*)recoded);
3051 SvCUR_set(sv, len - 1);
3052 SvLEN_set(sv, len); /* No longer know the real size. */
3056 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3063 =for apidoc sv_utf8_downgrade
3065 Attempts to convert the PV of an SV from characters to bytes.
3066 If the PV contains a character beyond byte, this conversion will fail;
3067 in this case, either returns false or, if C<fail_ok> is not
3070 This is not as a general purpose Unicode to byte encoding interface:
3071 use the Encode extension for that.
3077 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3080 if (SvPOKp(sv) && SvUTF8(sv)) {
3086 sv_force_normal_flags(sv, 0);
3088 s = (U8 *) SvPV(sv, len);
3089 if (!utf8_to_bytes(s, &len)) {
3094 Perl_croak(aTHX_ "Wide character in %s",
3097 Perl_croak(aTHX_ "Wide character");
3108 =for apidoc sv_utf8_encode
3110 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3111 flag off so that it looks like octets again.
3117 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3120 sv_force_normal_flags(sv, 0);
3122 if (SvREADONLY(sv)) {
3123 Perl_croak(aTHX_ PL_no_modify);
3125 (void) sv_utf8_upgrade(sv);
3130 =for apidoc sv_utf8_decode
3132 If the PV of the SV is an octet sequence in UTF-8
3133 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3134 so that it looks like a character. If the PV contains only single-byte
3135 characters, the C<SvUTF8> flag stays being off.
3136 Scans PV for validity and returns false if the PV is invalid UTF-8.
3142 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3148 /* The octets may have got themselves encoded - get them back as
3151 if (!sv_utf8_downgrade(sv, TRUE))
3154 /* it is actually just a matter of turning the utf8 flag on, but
3155 * we want to make sure everything inside is valid utf8 first.
3157 c = (const U8 *) SvPVX_const(sv);
3158 if (!is_utf8_string(c, SvCUR(sv)+1))
3160 e = (const U8 *) SvEND(sv);
3163 if (!UTF8_IS_INVARIANT(ch)) {
3173 =for apidoc sv_setsv
3175 Copies the contents of the source SV C<ssv> into the destination SV
3176 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3177 function if the source SV needs to be reused. Does not handle 'set' magic.
3178 Loosely speaking, it performs a copy-by-value, obliterating any previous
3179 content of the destination.
3181 You probably want to use one of the assortment of wrappers, such as
3182 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3183 C<SvSetMagicSV_nosteal>.
3185 =for apidoc sv_setsv_flags
3187 Copies the contents of the source SV C<ssv> into the destination SV
3188 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3189 function if the source SV needs to be reused. Does not handle 'set' magic.
3190 Loosely speaking, it performs a copy-by-value, obliterating any previous
3191 content of the destination.
3192 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3193 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3194 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3195 and C<sv_setsv_nomg> are implemented in terms of this function.
3197 You probably want to use one of the assortment of wrappers, such as
3198 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3199 C<SvSetMagicSV_nosteal>.
3201 This is the primary function for copying scalars, and most other
3202 copy-ish functions and macros use this underneath.
3208 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3210 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3212 if (dtype != SVt_PVGV) {
3213 const char * const name = GvNAME(sstr);
3214 const STRLEN len = GvNAMELEN(sstr);
3216 if (dtype >= SVt_PV) {
3222 SvUPGRADE(dstr, SVt_PVGV);
3223 (void)SvOK_off(dstr);
3224 /* FIXME - why are we doing this, then turning it off and on again
3226 isGV_with_GP_on(dstr);
3228 GvSTASH(dstr) = GvSTASH(sstr);
3230 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3231 gv_name_set((GV *)dstr, name, len, GV_ADD);
3232 SvFAKE_on(dstr); /* can coerce to non-glob */
3235 #ifdef GV_UNIQUE_CHECK
3236 if (GvUNIQUE((GV*)dstr)) {
3237 Perl_croak(aTHX_ PL_no_modify);
3241 if(GvGP((GV*)sstr)) {
3242 /* If source has method cache entry, clear it */
3244 SvREFCNT_dec(GvCV(sstr));
3248 /* If source has a real method, then a method is
3250 else if(GvCV((GV*)sstr)) {
3255 /* If dest already had a real method, that's a change as well */
3256 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3260 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3264 isGV_with_GP_off(dstr);
3265 (void)SvOK_off(dstr);
3266 isGV_with_GP_on(dstr);
3267 GvINTRO_off(dstr); /* one-shot flag */
3268 GvGP(dstr) = gp_ref(GvGP(sstr));
3269 if (SvTAINTED(sstr))
3271 if (GvIMPORTED(dstr) != GVf_IMPORTED
3272 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3274 GvIMPORTED_on(dstr);
3277 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3278 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3283 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3284 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3286 const int intro = GvINTRO(dstr);
3289 const U32 stype = SvTYPE(sref);
3292 #ifdef GV_UNIQUE_CHECK
3293 if (GvUNIQUE((GV*)dstr)) {
3294 Perl_croak(aTHX_ PL_no_modify);
3299 GvINTRO_off(dstr); /* one-shot flag */
3300 GvLINE(dstr) = CopLINE(PL_curcop);
3301 GvEGV(dstr) = (GV*)dstr;
3306 location = (SV **) &GvCV(dstr);
3307 import_flag = GVf_IMPORTED_CV;
3310 location = (SV **) &GvHV(dstr);
3311 import_flag = GVf_IMPORTED_HV;
3314 location = (SV **) &GvAV(dstr);
3315 import_flag = GVf_IMPORTED_AV;
3318 location = (SV **) &GvIOp(dstr);
3321 location = (SV **) &GvFORM(dstr);
3323 location = &GvSV(dstr);
3324 import_flag = GVf_IMPORTED_SV;
3327 if (stype == SVt_PVCV) {
3328 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3329 if (GvCVGEN(dstr)) {
3330 SvREFCNT_dec(GvCV(dstr));
3332 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3335 SAVEGENERICSV(*location);
3339 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3340 CV* const cv = (CV*)*location;
3342 if (!GvCVGEN((GV*)dstr) &&
3343 (CvROOT(cv) || CvXSUB(cv)))
3345 /* Redefining a sub - warning is mandatory if
3346 it was a const and its value changed. */
3347 if (CvCONST(cv) && CvCONST((CV*)sref)
3348 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3350 /* They are 2 constant subroutines generated from
3351 the same constant. This probably means that
3352 they are really the "same" proxy subroutine
3353 instantiated in 2 places. Most likely this is
3354 when a constant is exported twice. Don't warn.
3357 else if (ckWARN(WARN_REDEFINE)
3359 && (!CvCONST((CV*)sref)
3360 || sv_cmp(cv_const_sv(cv),
3361 cv_const_sv((CV*)sref))))) {
3362 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3365 ? "Constant subroutine %s::%s redefined"
3366 : "Subroutine %s::%s redefined"),
3367 HvNAME_get(GvSTASH((GV*)dstr)),
3368 GvENAME((GV*)dstr));
3372 cv_ckproto_len(cv, (GV*)dstr,
3373 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3374 SvPOK(sref) ? SvCUR(sref) : 0);
3376 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3377 GvASSUMECV_on(dstr);
3378 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3381 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3382 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3383 GvFLAGS(dstr) |= import_flag;
3388 if (SvTAINTED(sstr))
3394 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3397 register U32 sflags;
3399 register svtype stype;
3404 if (SvIS_FREED(dstr)) {
3405 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3406 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3408 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3410 sstr = &PL_sv_undef;
3411 if (SvIS_FREED(sstr)) {
3412 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3413 (void*)sstr, (void*)dstr);
3415 stype = SvTYPE(sstr);
3416 dtype = SvTYPE(dstr);
3418 (void)SvAMAGIC_off(dstr);
3421 /* need to nuke the magic */
3423 SvRMAGICAL_off(dstr);
3426 /* There's a lot of redundancy below but we're going for speed here */
3431 if (dtype != SVt_PVGV) {
3432 (void)SvOK_off(dstr);
3440 sv_upgrade(dstr, SVt_IV);
3444 sv_upgrade(dstr, SVt_PVIV);
3447 goto end_of_first_switch;
3449 (void)SvIOK_only(dstr);
3450 SvIV_set(dstr, SvIVX(sstr));
3453 /* SvTAINTED can only be true if the SV has taint magic, which in
3454 turn means that the SV type is PVMG (or greater). This is the
3455 case statement for SVt_IV, so this cannot be true (whatever gcov
3457 assert(!SvTAINTED(sstr));
3462 if (dtype < SVt_PV && dtype != SVt_IV)
3463 sv_upgrade(dstr, SVt_IV);
3471 sv_upgrade(dstr, SVt_NV);
3475 sv_upgrade(dstr, SVt_PVNV);
3478 goto end_of_first_switch;
3480 SvNV_set(dstr, SvNVX(sstr));
3481 (void)SvNOK_only(dstr);
3482 /* SvTAINTED can only be true if the SV has taint magic, which in
3483 turn means that the SV type is PVMG (or greater). This is the
3484 case statement for SVt_NV, so this cannot be true (whatever gcov
3486 assert(!SvTAINTED(sstr));
3492 #ifdef PERL_OLD_COPY_ON_WRITE
3493 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3494 if (dtype < SVt_PVIV)
3495 sv_upgrade(dstr, SVt_PVIV);
3502 sv_upgrade(dstr, SVt_PV);
3505 if (dtype < SVt_PVIV)
3506 sv_upgrade(dstr, SVt_PVIV);
3509 if (dtype < SVt_PVNV)
3510 sv_upgrade(dstr, SVt_PVNV);
3514 const char * const type = sv_reftype(sstr,0);
3516 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3518 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3522 /* case SVt_BIND: */
3525 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3526 glob_assign_glob(dstr, sstr, dtype);
3529 /* SvVALID means that this PVGV is playing at being an FBM. */
3533 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3535 if (SvTYPE(sstr) != stype) {
3536 stype = SvTYPE(sstr);
3537 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3538 glob_assign_glob(dstr, sstr, dtype);
3543 if (stype == SVt_PVLV)
3544 SvUPGRADE(dstr, SVt_PVNV);
3546 SvUPGRADE(dstr, (svtype)stype);
3548 end_of_first_switch:
3550 /* dstr may have been upgraded. */
3551 dtype = SvTYPE(dstr);
3552 sflags = SvFLAGS(sstr);
3554 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3555 /* Assigning to a subroutine sets the prototype. */
3558 const char *const ptr = SvPV_const(sstr, len);
3560 SvGROW(dstr, len + 1);
3561 Copy(ptr, SvPVX(dstr), len + 1, char);
3562 SvCUR_set(dstr, len);
3564 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3568 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3569 const char * const type = sv_reftype(dstr,0);
3571 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3573 Perl_croak(aTHX_ "Cannot copy to %s", type);
3574 } else if (sflags & SVf_ROK) {
3575 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3576 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3579 if (GvIMPORTED(dstr) != GVf_IMPORTED
3580 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3582 GvIMPORTED_on(dstr);
3587 glob_assign_glob(dstr, sstr, dtype);
3591 if (dtype >= SVt_PV) {
3592 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3593 glob_assign_ref(dstr, sstr);
3596 if (SvPVX_const(dstr)) {
3602 (void)SvOK_off(dstr);
3603 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3604 SvFLAGS(dstr) |= sflags & SVf_ROK;
3605 assert(!(sflags & SVp_NOK));
3606 assert(!(sflags & SVp_IOK));
3607 assert(!(sflags & SVf_NOK));
3608 assert(!(sflags & SVf_IOK));
3610 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3611 if (!(sflags & SVf_OK)) {
3612 if (ckWARN(WARN_MISC))
3613 Perl_warner(aTHX_ packWARN(WARN_MISC),
3614 "Undefined value assigned to typeglob");
3617 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3618 if (dstr != (SV*)gv) {
3621 GvGP(dstr) = gp_ref(GvGP(gv));
3625 else if (sflags & SVp_POK) {
3629 * Check to see if we can just swipe the string. If so, it's a
3630 * possible small lose on short strings, but a big win on long ones.
3631 * It might even be a win on short strings if SvPVX_const(dstr)
3632 * has to be allocated and SvPVX_const(sstr) has to be freed.
3633 * Likewise if we can set up COW rather than doing an actual copy, we
3634 * drop to the else clause, as the swipe code and the COW setup code
3635 * have much in common.
3638 /* Whichever path we take through the next code, we want this true,
3639 and doing it now facilitates the COW check. */
3640 (void)SvPOK_only(dstr);
3643 /* If we're already COW then this clause is not true, and if COW
3644 is allowed then we drop down to the else and make dest COW
3645 with us. If caller hasn't said that we're allowed to COW
3646 shared hash keys then we don't do the COW setup, even if the
3647 source scalar is a shared hash key scalar. */
3648 (((flags & SV_COW_SHARED_HASH_KEYS)
3649 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3650 : 1 /* If making a COW copy is forbidden then the behaviour we
3651 desire is as if the source SV isn't actually already
3652 COW, even if it is. So we act as if the source flags
3653 are not COW, rather than actually testing them. */
3655 #ifndef PERL_OLD_COPY_ON_WRITE
3656 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3657 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3658 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3659 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3660 but in turn, it's somewhat dead code, never expected to go
3661 live, but more kept as a placeholder on how to do it better
3662 in a newer implementation. */
3663 /* If we are COW and dstr is a suitable target then we drop down
3664 into the else and make dest a COW of us. */
3665 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3670 (sflags & SVs_TEMP) && /* slated for free anyway? */
3671 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3672 (!(flags & SV_NOSTEAL)) &&
3673 /* and we're allowed to steal temps */
3674 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3675 SvLEN(sstr) && /* and really is a string */
3676 /* and won't be needed again, potentially */
3677 !(PL_op && PL_op->op_type == OP_AASSIGN))
3678 #ifdef PERL_OLD_COPY_ON_WRITE
3679 && ((flags & SV_COW_SHARED_HASH_KEYS)
3680 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3681 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3682 && SvTYPE(sstr) >= SVt_PVIV))
3686 /* Failed the swipe test, and it's not a shared hash key either.
3687 Have to copy the string. */
3688 STRLEN len = SvCUR(sstr);
3689 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3690 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3691 SvCUR_set(dstr, len);
3692 *SvEND(dstr) = '\0';
3694 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3696 /* Either it's a shared hash key, or it's suitable for
3697 copy-on-write or we can swipe the string. */
3699 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3703 #ifdef PERL_OLD_COPY_ON_WRITE
3705 /* I believe I should acquire a global SV mutex if
3706 it's a COW sv (not a shared hash key) to stop
3707 it going un copy-on-write.
3708 If the source SV has gone un copy on write between up there
3709 and down here, then (assert() that) it is of the correct
3710 form to make it copy on write again */
3711 if ((sflags & (SVf_FAKE | SVf_READONLY))
3712 != (SVf_FAKE | SVf_READONLY)) {
3713 SvREADONLY_on(sstr);
3715 /* Make the source SV into a loop of 1.
3716 (about to become 2) */
3717 SV_COW_NEXT_SV_SET(sstr, sstr);
3721 /* Initial code is common. */
3722 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3727 /* making another shared SV. */
3728 STRLEN cur = SvCUR(sstr);
3729 STRLEN len = SvLEN(sstr);
3730 #ifdef PERL_OLD_COPY_ON_WRITE
3732 assert (SvTYPE(dstr) >= SVt_PVIV);
3733 /* SvIsCOW_normal */
3734 /* splice us in between source and next-after-source. */
3735 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3736 SV_COW_NEXT_SV_SET(sstr, dstr);
3737 SvPV_set(dstr, SvPVX_mutable(sstr));
3741 /* SvIsCOW_shared_hash */
3742 DEBUG_C(PerlIO_printf(Perl_debug_log,
3743 "Copy on write: Sharing hash\n"));
3745 assert (SvTYPE(dstr) >= SVt_PV);
3747 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3749 SvLEN_set(dstr, len);
3750 SvCUR_set(dstr, cur);
3751 SvREADONLY_on(dstr);
3753 /* Relesase a global SV mutex. */
3756 { /* Passes the swipe test. */
3757 SvPV_set(dstr, SvPVX_mutable(sstr));
3758 SvLEN_set(dstr, SvLEN(sstr));
3759 SvCUR_set(dstr, SvCUR(sstr));
3762 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3763 SvPV_set(sstr, NULL);
3769 if (sflags & SVp_NOK) {
3770 SvNV_set(dstr, SvNVX(sstr));
3772 if (sflags & SVp_IOK) {
3773 SvIV_set(dstr, SvIVX(sstr));
3774 /* Must do this otherwise some other overloaded use of 0x80000000
3775 gets confused. I guess SVpbm_VALID */
3776 if (sflags & SVf_IVisUV)
3779 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3781 const MAGIC * const smg = SvVSTRING_mg(sstr);
3783 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3784 smg->mg_ptr, smg->mg_len);
3785 SvRMAGICAL_on(dstr);
3789 else if (sflags & (SVp_IOK|SVp_NOK)) {
3790 (void)SvOK_off(dstr);
3791 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3792 if (sflags & SVp_IOK) {
3793 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3794 SvIV_set(dstr, SvIVX(sstr));
3796 if (sflags & SVp_NOK) {
3797 SvNV_set(dstr, SvNVX(sstr));
3801 if (isGV_with_GP(sstr)) {
3802 /* This stringification rule for globs is spread in 3 places.
3803 This feels bad. FIXME. */
3804 const U32 wasfake = sflags & SVf_FAKE;
3806 /* FAKE globs can get coerced, so need to turn this off
3807 temporarily if it is on. */
3809 gv_efullname3(dstr, (GV *)sstr, "*");
3810 SvFLAGS(sstr) |= wasfake;
3813 (void)SvOK_off(dstr);
3815 if (SvTAINTED(sstr))
3820 =for apidoc sv_setsv_mg
3822 Like C<sv_setsv>, but also handles 'set' magic.
3828 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3830 sv_setsv(dstr,sstr);
3834 #ifdef PERL_OLD_COPY_ON_WRITE
3836 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3838 STRLEN cur = SvCUR(sstr);
3839 STRLEN len = SvLEN(sstr);
3840 register char *new_pv;
3843 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3844 (void*)sstr, (void*)dstr);
3851 if (SvTHINKFIRST(dstr))
3852 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3853 else if (SvPVX_const(dstr))
3854 Safefree(SvPVX_const(dstr));
3858 SvUPGRADE(dstr, SVt_PVIV);
3860 assert (SvPOK(sstr));
3861 assert (SvPOKp(sstr));
3862 assert (!SvIOK(sstr));
3863 assert (!SvIOKp(sstr));
3864 assert (!SvNOK(sstr));
3865 assert (!SvNOKp(sstr));
3867 if (SvIsCOW(sstr)) {
3869 if (SvLEN(sstr) == 0) {
3870 /* source is a COW shared hash key. */
3871 DEBUG_C(PerlIO_printf(Perl_debug_log,
3872 "Fast copy on write: Sharing hash\n"));
3873 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3876 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3878 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3879 SvUPGRADE(sstr, SVt_PVIV);
3880 SvREADONLY_on(sstr);
3882 DEBUG_C(PerlIO_printf(Perl_debug_log,
3883 "Fast copy on write: Converting sstr to COW\n"));
3884 SV_COW_NEXT_SV_SET(dstr, sstr);
3886 SV_COW_NEXT_SV_SET(sstr, dstr);
3887 new_pv = SvPVX_mutable(sstr);
3890 SvPV_set(dstr, new_pv);
3891 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3894 SvLEN_set(dstr, len);
3895 SvCUR_set(dstr, cur);
3904 =for apidoc sv_setpvn
3906 Copies a string into an SV. The C<len> parameter indicates the number of
3907 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3908 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3914 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3917 register char *dptr;
3919 SV_CHECK_THINKFIRST_COW_DROP(sv);
3925 /* len is STRLEN which is unsigned, need to copy to signed */
3928 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3930 SvUPGRADE(sv, SVt_PV);
3932 dptr = SvGROW(sv, len + 1);
3933 Move(ptr,dptr,len,char);
3936 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3941 =for apidoc sv_setpvn_mg
3943 Like C<sv_setpvn>, but also handles 'set' magic.
3949 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3951 sv_setpvn(sv,ptr,len);
3956 =for apidoc sv_setpv
3958 Copies a string into an SV. The string must be null-terminated. Does not
3959 handle 'set' magic. See C<sv_setpv_mg>.
3965 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3968 register STRLEN len;
3970 SV_CHECK_THINKFIRST_COW_DROP(sv);
3976 SvUPGRADE(sv, SVt_PV);
3978 SvGROW(sv, len + 1);
3979 Move(ptr,SvPVX(sv),len+1,char);
3981 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3986 =for apidoc sv_setpv_mg
3988 Like C<sv_setpv>, but also handles 'set' magic.
3994 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4001 =for apidoc sv_usepvn_flags
4003 Tells an SV to use C<ptr> to find its string value. Normally the
4004 string is stored inside the SV but sv_usepvn allows the SV to use an
4005 outside string. The C<ptr> should point to memory that was allocated
4006 by C<malloc>. The string length, C<len>, must be supplied. By default
4007 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4008 so that pointer should not be freed or used by the programmer after
4009 giving it to sv_usepvn, and neither should any pointers from "behind"
4010 that pointer (e.g. ptr + 1) be used.
4012 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4013 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4014 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4015 C<len>, and already meets the requirements for storing in C<SvPVX>)
4021 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4025 SV_CHECK_THINKFIRST_COW_DROP(sv);
4026 SvUPGRADE(sv, SVt_PV);
4029 if (flags & SV_SMAGIC)
4033 if (SvPVX_const(sv))
4037 if (flags & SV_HAS_TRAILING_NUL)
4038 assert(ptr[len] == '\0');
4041 allocate = (flags & SV_HAS_TRAILING_NUL)
4042 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4043 if (flags & SV_HAS_TRAILING_NUL) {
4044 /* It's long enough - do nothing.
4045 Specfically Perl_newCONSTSUB is relying on this. */
4048 /* Force a move to shake out bugs in callers. */
4049 char *new_ptr = (char*)safemalloc(allocate);
4050 Copy(ptr, new_ptr, len, char);
4051 PoisonFree(ptr,len,char);
4055 ptr = (char*) saferealloc (ptr, allocate);
4060 SvLEN_set(sv, allocate);
4061 if (!(flags & SV_HAS_TRAILING_NUL)) {
4064 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4066 if (flags & SV_SMAGIC)
4070 #ifdef PERL_OLD_COPY_ON_WRITE
4071 /* Need to do this *after* making the SV normal, as we need the buffer
4072 pointer to remain valid until after we've copied it. If we let go too early,
4073 another thread could invalidate it by unsharing last of the same hash key
4074 (which it can do by means other than releasing copy-on-write Svs)
4075 or by changing the other copy-on-write SVs in the loop. */
4077 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4079 { /* this SV was SvIsCOW_normal(sv) */
4080 /* we need to find the SV pointing to us. */
4081 SV *current = SV_COW_NEXT_SV(after);
4083 if (current == sv) {
4084 /* The SV we point to points back to us (there were only two of us
4086 Hence other SV is no longer copy on write either. */
4088 SvREADONLY_off(after);
4090 /* We need to follow the pointers around the loop. */
4092 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4095 /* don't loop forever if the structure is bust, and we have
4096 a pointer into a closed loop. */
4097 assert (current != after);
4098 assert (SvPVX_const(current) == pvx);
4100 /* Make the SV before us point to the SV after us. */
4101 SV_COW_NEXT_SV_SET(current, after);
4107 =for apidoc sv_force_normal_flags
4109 Undo various types of fakery on an SV: if the PV is a shared string, make
4110 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4111 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4112 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4113 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4114 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4115 set to some other value.) In addition, the C<flags> parameter gets passed to
4116 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4117 with flags set to 0.
4123 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4126 #ifdef PERL_OLD_COPY_ON_WRITE
4127 if (SvREADONLY(sv)) {
4128 /* At this point I believe I should acquire a global SV mutex. */
4130 const char * const pvx = SvPVX_const(sv);
4131 const STRLEN len = SvLEN(sv);
4132 const STRLEN cur = SvCUR(sv);
4133 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4134 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4135 we'll fail an assertion. */
4136 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4139 PerlIO_printf(Perl_debug_log,
4140 "Copy on write: Force normal %ld\n",
4146 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4149 if (flags & SV_COW_DROP_PV) {
4150 /* OK, so we don't need to copy our buffer. */
4153 SvGROW(sv, cur + 1);
4154 Move(pvx,SvPVX(sv),cur,char);
4159 sv_release_COW(sv, pvx, next);
4161 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4167 else if (IN_PERL_RUNTIME)
4168 Perl_croak(aTHX_ PL_no_modify);
4169 /* At this point I believe that I can drop the global SV mutex. */
4172 if (SvREADONLY(sv)) {
4174 const char * const pvx = SvPVX_const(sv);
4175 const STRLEN len = SvCUR(sv);
4180 SvGROW(sv, len + 1);
4181 Move(pvx,SvPVX(sv),len,char);
4183 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4185 else if (IN_PERL_RUNTIME)
4186 Perl_croak(aTHX_ PL_no_modify);
4190 sv_unref_flags(sv, flags);
4191 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4198 Efficient removal of characters from the beginning of the string buffer.
4199 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4200 the string buffer. The C<ptr> becomes the first character of the adjusted
4201 string. Uses the "OOK hack".
4202 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4203 refer to the same chunk of data.
4209 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4215 const U8 *real_start;
4218 if (!ptr || !SvPOKp(sv))
4220 delta = ptr - SvPVX_const(sv);
4222 /* Nothing to do. */
4225 assert(ptr > SvPVX_const(sv));
4226 SV_CHECK_THINKFIRST(sv);
4229 if (!SvLEN(sv)) { /* make copy of shared string */
4230 const char *pvx = SvPVX_const(sv);
4231 const STRLEN len = SvCUR(sv);
4232 SvGROW(sv, len + 1);
4233 Move(pvx,SvPVX(sv),len,char);
4236 SvFLAGS(sv) |= SVf_OOK;
4239 SvOOK_offset(sv, old_delta);
4241 SvLEN_set(sv, SvLEN(sv) - delta);
4242 SvCUR_set(sv, SvCUR(sv) - delta);
4243 SvPV_set(sv, SvPVX(sv) + delta);
4245 p = (U8 *)SvPVX_const(sv);
4250 real_start = p - delta;
4254 if (delta < 0x100) {
4258 p -= sizeof(STRLEN);
4259 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4263 /* Fill the preceding buffer with sentinals to verify that no-one is
4265 while (p > real_start) {
4273 =for apidoc sv_catpvn
4275 Concatenates the string onto the end of the string which is in the SV. The
4276 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4277 status set, then the bytes appended should be valid UTF-8.
4278 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4280 =for apidoc sv_catpvn_flags
4282 Concatenates the string onto the end of the string which is in the SV. The
4283 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4284 status set, then the bytes appended should be valid UTF-8.
4285 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4286 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4287 in terms of this function.
4293 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4297 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4299 SvGROW(dsv, dlen + slen + 1);
4301 sstr = SvPVX_const(dsv);
4302 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4303 SvCUR_set(dsv, SvCUR(dsv) + slen);
4305 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4307 if (flags & SV_SMAGIC)
4312 =for apidoc sv_catsv
4314 Concatenates the string from SV C<ssv> onto the end of the string in
4315 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4316 not 'set' magic. See C<sv_catsv_mg>.
4318 =for apidoc sv_catsv_flags
4320 Concatenates the string from SV C<ssv> onto the end of the string in
4321 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4322 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4323 and C<sv_catsv_nomg> are implemented in terms of this function.
4328 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4333 const char *spv = SvPV_const(ssv, slen);
4335 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4336 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4337 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4338 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4339 dsv->sv_flags doesn't have that bit set.
4340 Andy Dougherty 12 Oct 2001
4342 const I32 sutf8 = DO_UTF8(ssv);
4345 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4347 dutf8 = DO_UTF8(dsv);
4349 if (dutf8 != sutf8) {
4351 /* Not modifying source SV, so taking a temporary copy. */
4352 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4354 sv_utf8_upgrade(csv);
4355 spv = SvPV_const(csv, slen);
4358 sv_utf8_upgrade_nomg(dsv);
4360 sv_catpvn_nomg(dsv, spv, slen);
4363 if (flags & SV_SMAGIC)
4368 =for apidoc sv_catpv
4370 Concatenates the string onto the end of the string which is in the SV.
4371 If the SV has the UTF-8 status set, then the bytes appended should be
4372 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4377 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4380 register STRLEN len;
4386 junk = SvPV_force(sv, tlen);
4388 SvGROW(sv, tlen + len + 1);
4390 ptr = SvPVX_const(sv);
4391 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4392 SvCUR_set(sv, SvCUR(sv) + len);
4393 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4398 =for apidoc sv_catpv_mg
4400 Like C<sv_catpv>, but also handles 'set' magic.
4406 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4415 Creates a new SV. A non-zero C<len> parameter indicates the number of
4416 bytes of preallocated string space the SV should have. An extra byte for a
4417 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4418 space is allocated.) The reference count for the new SV is set to 1.
4420 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4421 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4422 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4423 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4424 modules supporting older perls.
4430 Perl_newSV(pTHX_ STRLEN len)
4437 sv_upgrade(sv, SVt_PV);
4438 SvGROW(sv, len + 1);
4443 =for apidoc sv_magicext
4445 Adds magic to an SV, upgrading it if necessary. Applies the
4446 supplied vtable and returns a pointer to the magic added.
4448 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4449 In particular, you can add magic to SvREADONLY SVs, and add more than
4450 one instance of the same 'how'.
4452 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4453 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4454 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4455 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4457 (This is now used as a subroutine by C<sv_magic>.)
4462 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4463 const char* name, I32 namlen)
4468 SvUPGRADE(sv, SVt_PVMG);
4469 Newxz(mg, 1, MAGIC);
4470 mg->mg_moremagic = SvMAGIC(sv);
4471 SvMAGIC_set(sv, mg);
4473 /* Sometimes a magic contains a reference loop, where the sv and
4474 object refer to each other. To prevent a reference loop that
4475 would prevent such objects being freed, we look for such loops
4476 and if we find one we avoid incrementing the object refcount.
4478 Note we cannot do this to avoid self-tie loops as intervening RV must
4479 have its REFCNT incremented to keep it in existence.
4482 if (!obj || obj == sv ||
4483 how == PERL_MAGIC_arylen ||
4484 how == PERL_MAGIC_symtab ||
4485 (SvTYPE(obj) == SVt_PVGV &&
4486 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4487 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4488 GvFORM(obj) == (CV*)sv)))
4493 mg->mg_obj = SvREFCNT_inc_simple(obj);
4494 mg->mg_flags |= MGf_REFCOUNTED;
4497 /* Normal self-ties simply pass a null object, and instead of
4498 using mg_obj directly, use the SvTIED_obj macro to produce a
4499 new RV as needed. For glob "self-ties", we are tieing the PVIO
4500 with an RV obj pointing to the glob containing the PVIO. In
4501 this case, to avoid a reference loop, we need to weaken the
4505 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4506 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4512 mg->mg_len = namlen;
4515 mg->mg_ptr = savepvn(name, namlen);
4516 else if (namlen == HEf_SVKEY)
4517 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4519 mg->mg_ptr = (char *) name;
4521 mg->mg_virtual = (MGVTBL *) vtable;
4525 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4530 =for apidoc sv_magic
4532 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4533 then adds a new magic item of type C<how> to the head of the magic list.
4535 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4536 handling of the C<name> and C<namlen> arguments.
4538 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4539 to add more than one instance of the same 'how'.
4545 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4548 const MGVTBL *vtable;
4551 #ifdef PERL_OLD_COPY_ON_WRITE
4553 sv_force_normal_flags(sv, 0);
4555 if (SvREADONLY(sv)) {
4557 /* its okay to attach magic to shared strings; the subsequent
4558 * upgrade to PVMG will unshare the string */
4559 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4562 && how != PERL_MAGIC_regex_global
4563 && how != PERL_MAGIC_bm
4564 && how != PERL_MAGIC_fm
4565 && how != PERL_MAGIC_sv
4566 && how != PERL_MAGIC_backref
4569 Perl_croak(aTHX_ PL_no_modify);
4572 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4573 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4574 /* sv_magic() refuses to add a magic of the same 'how' as an
4577 if (how == PERL_MAGIC_taint) {
4579 /* Any scalar which already had taint magic on which someone
4580 (erroneously?) did SvIOK_on() or similar will now be
4581 incorrectly sporting public "OK" flags. */
4582 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4590 vtable = &PL_vtbl_sv;
4592 case PERL_MAGIC_overload:
4593 vtable = &PL_vtbl_amagic;
4595 case PERL_MAGIC_overload_elem:
4596 vtable = &PL_vtbl_amagicelem;
4598 case PERL_MAGIC_overload_table:
4599 vtable = &PL_vtbl_ovrld;
4602 vtable = &PL_vtbl_bm;
4604 case PERL_MAGIC_regdata:
4605 vtable = &PL_vtbl_regdata;
4607 case PERL_MAGIC_regdatum:
4608 vtable = &PL_vtbl_regdatum;
4610 case PERL_MAGIC_env:
4611 vtable = &PL_vtbl_env;
4614 vtable = &PL_vtbl_fm;
4616 case PERL_MAGIC_envelem:
4617 vtable = &PL_vtbl_envelem;
4619 case PERL_MAGIC_regex_global:
4620 vtable = &PL_vtbl_mglob;
4622 case PERL_MAGIC_isa:
4623 vtable = &PL_vtbl_isa;
4625 case PERL_MAGIC_isaelem:
4626 vtable = &PL_vtbl_isaelem;
4628 case PERL_MAGIC_nkeys:
4629 vtable = &PL_vtbl_nkeys;
4631 case PERL_MAGIC_dbfile:
4634 case PERL_MAGIC_dbline:
4635 vtable = &PL_vtbl_dbline;
4637 #ifdef USE_LOCALE_COLLATE
4638 case PERL_MAGIC_collxfrm:
4639 vtable = &PL_vtbl_collxfrm;
4641 #endif /* USE_LOCALE_COLLATE */
4642 case PERL_MAGIC_tied:
4643 vtable = &PL_vtbl_pack;
4645 case PERL_MAGIC_tiedelem:
4646 case PERL_MAGIC_tiedscalar:
4647 vtable = &PL_vtbl_packelem;
4650 vtable = &PL_vtbl_regexp;
4652 case PERL_MAGIC_hints:
4653 /* As this vtable is all NULL, we can reuse it. */
4654 case PERL_MAGIC_sig:
4655 vtable = &PL_vtbl_sig;
4657 case PERL_MAGIC_sigelem:
4658 vtable = &PL_vtbl_sigelem;
4660 case PERL_MAGIC_taint:
4661 vtable = &PL_vtbl_taint;
4663 case PERL_MAGIC_uvar:
4664 vtable = &PL_vtbl_uvar;
4666 case PERL_MAGIC_vec:
4667 vtable = &PL_vtbl_vec;
4669 case PERL_MAGIC_arylen_p:
4670 case PERL_MAGIC_rhash:
4671 case PERL_MAGIC_symtab:
4672 case PERL_MAGIC_vstring:
4675 case PERL_MAGIC_utf8:
4676 vtable = &PL_vtbl_utf8;
4678 case PERL_MAGIC_substr:
4679 vtable = &PL_vtbl_substr;
4681 case PERL_MAGIC_defelem:
4682 vtable = &PL_vtbl_defelem;
4684 case PERL_MAGIC_arylen:
4685 vtable = &PL_vtbl_arylen;
4687 case PERL_MAGIC_pos:
4688 vtable = &PL_vtbl_pos;
4690 case PERL_MAGIC_backref:
4691 vtable = &PL_vtbl_backref;
4693 case PERL_MAGIC_hintselem:
4694 vtable = &PL_vtbl_hintselem;
4696 case PERL_MAGIC_ext:
4697 /* Reserved for use by extensions not perl internals. */
4698 /* Useful for attaching extension internal data to perl vars. */
4699 /* Note that multiple extensions may clash if magical scalars */
4700 /* etc holding private data from one are passed to another. */
4704 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4707 /* Rest of work is done else where */
4708 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4711 case PERL_MAGIC_taint:
4714 case PERL_MAGIC_ext:
4715 case PERL_MAGIC_dbfile:
4722 =for apidoc sv_unmagic
4724 Removes all magic of type C<type> from an SV.
4730 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4734 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4736 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4737 for (mg = *mgp; mg; mg = *mgp) {
4738 if (mg->mg_type == type) {
4739 const MGVTBL* const vtbl = mg->mg_virtual;
4740 *mgp = mg->mg_moremagic;
4741 if (vtbl && vtbl->svt_free)
4742 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4743 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4745 Safefree(mg->mg_ptr);
4746 else if (mg->mg_len == HEf_SVKEY)
4747 SvREFCNT_dec((SV*)mg->mg_ptr);
4748 else if (mg->mg_type == PERL_MAGIC_utf8)
4749 Safefree(mg->mg_ptr);
4751 if (mg->mg_flags & MGf_REFCOUNTED)
4752 SvREFCNT_dec(mg->mg_obj);
4756 mgp = &mg->mg_moremagic;
4760 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4761 SvMAGIC_set(sv, NULL);
4768 =for apidoc sv_rvweaken
4770 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4771 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4772 push a back-reference to this RV onto the array of backreferences
4773 associated with that magic. If the RV is magical, set magic will be
4774 called after the RV is cleared.
4780 Perl_sv_rvweaken(pTHX_ SV *sv)
4783 if (!SvOK(sv)) /* let undefs pass */
4786 Perl_croak(aTHX_ "Can't weaken a nonreference");
4787 else if (SvWEAKREF(sv)) {
4788 if (ckWARN(WARN_MISC))
4789 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4793 Perl_sv_add_backref(aTHX_ tsv, sv);
4799 /* Give tsv backref magic if it hasn't already got it, then push a
4800 * back-reference to sv onto the array associated with the backref magic.
4804 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4809 if (SvTYPE(tsv) == SVt_PVHV) {
4810 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4814 /* There is no AV in the offical place - try a fixup. */
4815 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4818 /* Aha. They've got it stowed in magic. Bring it back. */
4819 av = (AV*)mg->mg_obj;
4820 /* Stop mg_free decreasing the refernce count. */
4822 /* Stop mg_free even calling the destructor, given that
4823 there's no AV to free up. */
4825 sv_unmagic(tsv, PERL_MAGIC_backref);
4829 SvREFCNT_inc_simple_void(av);
4834 const MAGIC *const mg
4835 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4837 av = (AV*)mg->mg_obj;
4841 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4842 /* av now has a refcnt of 2, which avoids it getting freed
4843 * before us during global cleanup. The extra ref is removed
4844 * by magic_killbackrefs() when tsv is being freed */
4847 if (AvFILLp(av) >= AvMAX(av)) {
4848 av_extend(av, AvFILLp(av)+1);
4850 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4853 /* delete a back-reference to ourselves from the backref magic associated
4854 * with the SV we point to.
4858 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4865 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4866 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4867 /* We mustn't attempt to "fix up" the hash here by moving the
4868 backreference array back to the hv_aux structure, as that is stored
4869 in the main HvARRAY(), and hfreentries assumes that no-one
4870 reallocates HvARRAY() while it is running. */
4873 const MAGIC *const mg
4874 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4876 av = (AV *)mg->mg_obj;
4879 if (PL_in_clean_all)
4881 Perl_croak(aTHX_ "panic: del_backref");
4888 /* We shouldn't be in here more than once, but for paranoia reasons lets
4890 for (i = AvFILLp(av); i >= 0; i--) {
4892 const SSize_t fill = AvFILLp(av);
4894 /* We weren't the last entry.
4895 An unordered list has this property that you can take the
4896 last element off the end to fill the hole, and it's still
4897 an unordered list :-)
4902 AvFILLp(av) = fill - 1;
4908 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4910 SV **svp = AvARRAY(av);
4912 PERL_UNUSED_ARG(sv);
4914 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4915 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4916 if (svp && !SvIS_FREED(av)) {
4917 SV *const *const last = svp + AvFILLp(av);
4919 while (svp <= last) {
4921 SV *const referrer = *svp;
4922 if (SvWEAKREF(referrer)) {
4923 /* XXX Should we check that it hasn't changed? */
4924 SvRV_set(referrer, 0);
4926 SvWEAKREF_off(referrer);
4927 SvSETMAGIC(referrer);
4928 } else if (SvTYPE(referrer) == SVt_PVGV ||
4929 SvTYPE(referrer) == SVt_PVLV) {
4930 /* You lookin' at me? */
4931 assert(GvSTASH(referrer));
4932 assert(GvSTASH(referrer) == (HV*)sv);
4933 GvSTASH(referrer) = 0;
4936 "panic: magic_killbackrefs (flags=%"UVxf")",
4937 (UV)SvFLAGS(referrer));
4945 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4950 =for apidoc sv_insert
4952 Inserts a string at the specified offset/length within the SV. Similar to
4953 the Perl substr() function.
4959 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4964 register char *midend;
4965 register char *bigend;
4971 Perl_croak(aTHX_ "Can't modify non-existent substring");
4972 SvPV_force(bigstr, curlen);
4973 (void)SvPOK_only_UTF8(bigstr);
4974 if (offset + len > curlen) {
4975 SvGROW(bigstr, offset+len+1);
4976 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4977 SvCUR_set(bigstr, offset+len);
4981 i = littlelen - len;
4982 if (i > 0) { /* string might grow */
4983 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4984 mid = big + offset + len;
4985 midend = bigend = big + SvCUR(bigstr);
4988 while (midend > mid) /* shove everything down */
4989 *--bigend = *--midend;
4990 Move(little,big+offset,littlelen,char);
4991 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4996 Move(little,SvPVX(bigstr)+offset,len,char);
5001 big = SvPVX(bigstr);
5004 bigend = big + SvCUR(bigstr);
5006 if (midend > bigend)
5007 Perl_croak(aTHX_ "panic: sv_insert");
5009 if (mid - big > bigend - midend) { /* faster to shorten from end */
5011 Move(little, mid, littlelen,char);
5014 i = bigend - midend;
5016 Move(midend, mid, i,char);
5020 SvCUR_set(bigstr, mid - big);
5022 else if ((i = mid - big)) { /* faster from front */
5023 midend -= littlelen;
5025 Move(big, midend - i, i, char);
5026 sv_chop(bigstr,midend-i);
5028 Move(little, mid, littlelen,char);
5030 else if (littlelen) {
5031 midend -= littlelen;
5032 sv_chop(bigstr,midend);
5033 Move(little,midend,littlelen,char);
5036 sv_chop(bigstr,midend);
5042 =for apidoc sv_replace
5044 Make the first argument a copy of the second, then delete the original.
5045 The target SV physically takes over ownership of the body of the source SV
5046 and inherits its flags; however, the target keeps any magic it owns,
5047 and any magic in the source is discarded.
5048 Note that this is a rather specialist SV copying operation; most of the
5049 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5055 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5058 const U32 refcnt = SvREFCNT(sv);
5059 SV_CHECK_THINKFIRST_COW_DROP(sv);
5060 if (SvREFCNT(nsv) != 1) {
5061 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5062 UVuf " != 1)", (UV) SvREFCNT(nsv));
5064 if (SvMAGICAL(sv)) {
5068 sv_upgrade(nsv, SVt_PVMG);
5069 SvMAGIC_set(nsv, SvMAGIC(sv));
5070 SvFLAGS(nsv) |= SvMAGICAL(sv);
5072 SvMAGIC_set(sv, NULL);
5076 assert(!SvREFCNT(sv));
5077 #ifdef DEBUG_LEAKING_SCALARS
5078 sv->sv_flags = nsv->sv_flags;
5079 sv->sv_any = nsv->sv_any;
5080 sv->sv_refcnt = nsv->sv_refcnt;
5081 sv->sv_u = nsv->sv_u;
5083 StructCopy(nsv,sv,SV);
5085 if(SvTYPE(sv) == SVt_IV) {
5087 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5091 #ifdef PERL_OLD_COPY_ON_WRITE
5092 if (SvIsCOW_normal(nsv)) {
5093 /* We need to follow the pointers around the loop to make the
5094 previous SV point to sv, rather than nsv. */
5097 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5100 assert(SvPVX_const(current) == SvPVX_const(nsv));
5102 /* Make the SV before us point to the SV after us. */
5104 PerlIO_printf(Perl_debug_log, "previous is\n");
5106 PerlIO_printf(Perl_debug_log,
5107 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5108 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5110 SV_COW_NEXT_SV_SET(current, sv);
5113 SvREFCNT(sv) = refcnt;
5114 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5120 =for apidoc sv_clear
5122 Clear an SV: call any destructors, free up any memory used by the body,
5123 and free the body itself. The SV's head is I<not> freed, although
5124 its type is set to all 1's so that it won't inadvertently be assumed
5125 to be live during global destruction etc.
5126 This function should only be called when REFCNT is zero. Most of the time
5127 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5134 Perl_sv_clear(pTHX_ register SV *sv)
5137 const U32 type = SvTYPE(sv);
5138 const struct body_details *const sv_type_details
5139 = bodies_by_type + type;
5143 assert(SvREFCNT(sv) == 0);
5144 assert(SvTYPE(sv) != SVTYPEMASK);
5146 if (type <= SVt_IV) {
5147 /* See the comment in sv.h about the collusion between this early
5148 return and the overloading of the NULL and IV slots in the size
5151 SV * const target = SvRV(sv);
5153 sv_del_backref(target, sv);
5155 SvREFCNT_dec(target);
5157 SvFLAGS(sv) &= SVf_BREAK;
5158 SvFLAGS(sv) |= SVTYPEMASK;
5163 if (PL_defstash && /* Still have a symbol table? */
5170 stash = SvSTASH(sv);
5171 destructor = StashHANDLER(stash,DESTROY);
5173 SV* const tmpref = newRV(sv);
5174 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5176 PUSHSTACKi(PERLSI_DESTROY);
5181 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5187 if(SvREFCNT(tmpref) < 2) {
5188 /* tmpref is not kept alive! */
5190 SvRV_set(tmpref, NULL);
5193 SvREFCNT_dec(tmpref);
5195 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5199 if (PL_in_clean_objs)
5200 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5202 /* DESTROY gave object new lease on life */
5208 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5209 SvOBJECT_off(sv); /* Curse the object. */
5210 if (type != SVt_PVIO)
5211 --PL_sv_objcount; /* XXX Might want something more general */
5214 if (type >= SVt_PVMG) {
5215 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5216 SvREFCNT_dec(SvOURSTASH(sv));
5217 } else if (SvMAGIC(sv))
5219 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5220 SvREFCNT_dec(SvSTASH(sv));
5223 /* case SVt_BIND: */
5226 IoIFP(sv) != PerlIO_stdin() &&
5227 IoIFP(sv) != PerlIO_stdout() &&
5228 IoIFP(sv) != PerlIO_stderr())
5230 io_close((IO*)sv, FALSE);
5232 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5233 PerlDir_close(IoDIRP(sv));
5234 IoDIRP(sv) = (DIR*)NULL;
5235 Safefree(IoTOP_NAME(sv));
5236 Safefree(IoFMT_NAME(sv));
5237 Safefree(IoBOTTOM_NAME(sv));
5240 /* FIXME for plugins */
5248 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5252 if (PL_comppad == (AV*)sv) {
5259 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5260 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5261 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5262 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5264 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5265 SvREFCNT_dec(LvTARG(sv));
5267 if (isGV_with_GP(sv)) {
5268 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5269 mro_method_changed_in(stash);
5272 unshare_hek(GvNAME_HEK(sv));
5273 /* If we're in a stash, we don't own a reference to it. However it does
5274 have a back reference to us, which needs to be cleared. */
5275 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5276 sv_del_backref((SV*)stash, sv);
5278 /* FIXME. There are probably more unreferenced pointers to SVs in the
5279 interpreter struct that we should check and tidy in a similar
5281 if ((GV*)sv == PL_last_in_gv)
5282 PL_last_in_gv = NULL;
5288 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5291 SvOOK_offset(sv, offset);
5292 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5293 /* Don't even bother with turning off the OOK flag. */
5296 SV * const target = SvRV(sv);
5298 sv_del_backref(target, sv);
5300 SvREFCNT_dec(target);
5302 #ifdef PERL_OLD_COPY_ON_WRITE
5303 else if (SvPVX_const(sv)) {
5305 /* I believe I need to grab the global SV mutex here and
5306 then recheck the COW status. */
5308 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5312 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5314 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5317 /* And drop it here. */
5319 } else if (SvLEN(sv)) {
5320 Safefree(SvPVX_const(sv));
5324 else if (SvPVX_const(sv) && SvLEN(sv))
5325 Safefree(SvPVX_mutable(sv));
5326 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5327 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5336 SvFLAGS(sv) &= SVf_BREAK;
5337 SvFLAGS(sv) |= SVTYPEMASK;
5339 if (sv_type_details->arena) {
5340 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5341 &PL_body_roots[type]);
5343 else if (sv_type_details->body_size) {
5344 my_safefree(SvANY(sv));
5349 =for apidoc sv_newref
5351 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5358 Perl_sv_newref(pTHX_ SV *sv)
5360 PERL_UNUSED_CONTEXT;
5369 Decrement an SV's reference count, and if it drops to zero, call
5370 C<sv_clear> to invoke destructors and free up any memory used by
5371 the body; finally, deallocate the SV's head itself.
5372 Normally called via a wrapper macro C<SvREFCNT_dec>.
5378 Perl_sv_free(pTHX_ SV *sv)
5383 if (SvREFCNT(sv) == 0) {
5384 if (SvFLAGS(sv) & SVf_BREAK)
5385 /* this SV's refcnt has been artificially decremented to
5386 * trigger cleanup */
5388 if (PL_in_clean_all) /* All is fair */
5390 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5391 /* make sure SvREFCNT(sv)==0 happens very seldom */
5392 SvREFCNT(sv) = (~(U32)0)/2;
5395 if (ckWARN_d(WARN_INTERNAL)) {
5396 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5397 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5398 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5399 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5400 Perl_dump_sv_child(aTHX_ sv);
5402 #ifdef DEBUG_LEAKING_SCALARS
5409 if (--(SvREFCNT(sv)) > 0)
5411 Perl_sv_free2(aTHX_ sv);
5415 Perl_sv_free2(pTHX_ SV *sv)
5420 if (ckWARN_d(WARN_DEBUGGING))
5421 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5422 "Attempt to free temp prematurely: SV 0x%"UVxf
5423 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5427 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5428 /* make sure SvREFCNT(sv)==0 happens very seldom */
5429 SvREFCNT(sv) = (~(U32)0)/2;
5440 Returns the length of the string in the SV. Handles magic and type
5441 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5447 Perl_sv_len(pTHX_ register SV *sv)
5455 len = mg_length(sv);
5457 (void)SvPV_const(sv, len);
5462 =for apidoc sv_len_utf8
5464 Returns the number of characters in the string in an SV, counting wide
5465 UTF-8 bytes as a single character. Handles magic and type coercion.
5471 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5472 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5473 * (Note that the mg_len is not the length of the mg_ptr field.
5474 * This allows the cache to store the character length of the string without
5475 * needing to malloc() extra storage to attach to the mg_ptr.)
5480 Perl_sv_len_utf8(pTHX_ register SV *sv)
5486 return mg_length(sv);
5490 const U8 *s = (U8*)SvPV_const(sv, len);
5494 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5496 if (mg && mg->mg_len != -1) {
5498 if (PL_utf8cache < 0) {
5499 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5501 /* Need to turn the assertions off otherwise we may
5502 recurse infinitely while printing error messages.
5504 SAVEI8(PL_utf8cache);
5506 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5507 " real %"UVuf" for %"SVf,
5508 (UV) ulen, (UV) real, SVfARG(sv));
5513 ulen = Perl_utf8_length(aTHX_ s, s + len);
5514 if (!SvREADONLY(sv)) {
5516 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5517 &PL_vtbl_utf8, 0, 0);
5525 return Perl_utf8_length(aTHX_ s, s + len);
5529 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5532 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5535 const U8 *s = start;
5537 while (s < send && uoffset--)
5540 /* This is the existing behaviour. Possibly it should be a croak, as
5541 it's actually a bounds error */
5547 /* Given the length of the string in both bytes and UTF-8 characters, decide
5548 whether to walk forwards or backwards to find the byte corresponding to
5549 the passed in UTF-8 offset. */
5551 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5552 STRLEN uoffset, STRLEN uend)
5554 STRLEN backw = uend - uoffset;
5555 if (uoffset < 2 * backw) {
5556 /* The assumption is that going forwards is twice the speed of going
5557 forward (that's where the 2 * backw comes from).
5558 (The real figure of course depends on the UTF-8 data.) */
5559 return sv_pos_u2b_forwards(start, send, uoffset);
5564 while (UTF8_IS_CONTINUATION(*send))
5567 return send - start;
5570 /* For the string representation of the given scalar, find the byte
5571 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5572 give another position in the string, *before* the sought offset, which
5573 (which is always true, as 0, 0 is a valid pair of positions), which should
5574 help reduce the amount of linear searching.
5575 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5576 will be used to reduce the amount of linear searching. The cache will be
5577 created if necessary, and the found value offered to it for update. */
5579 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5580 const U8 *const send, STRLEN uoffset,
5581 STRLEN uoffset0, STRLEN boffset0) {
5582 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5585 assert (uoffset >= uoffset0);
5587 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5588 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5589 if ((*mgp)->mg_ptr) {
5590 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5591 if (cache[0] == uoffset) {
5592 /* An exact match. */
5595 if (cache[2] == uoffset) {
5596 /* An exact match. */
5600 if (cache[0] < uoffset) {
5601 /* The cache already knows part of the way. */
5602 if (cache[0] > uoffset0) {
5603 /* The cache knows more than the passed in pair */
5604 uoffset0 = cache[0];
5605 boffset0 = cache[1];
5607 if ((*mgp)->mg_len != -1) {
5608 /* And we know the end too. */
5610 + sv_pos_u2b_midway(start + boffset0, send,
5612 (*mgp)->mg_len - uoffset0);
5615 + sv_pos_u2b_forwards(start + boffset0,
5616 send, uoffset - uoffset0);
5619 else if (cache[2] < uoffset) {
5620 /* We're between the two cache entries. */
5621 if (cache[2] > uoffset0) {
5622 /* and the cache knows more than the passed in pair */
5623 uoffset0 = cache[2];
5624 boffset0 = cache[3];
5628 + sv_pos_u2b_midway(start + boffset0,
5631 cache[0] - uoffset0);
5634 + sv_pos_u2b_midway(start + boffset0,
5637 cache[2] - uoffset0);
5641 else if ((*mgp)->mg_len != -1) {
5642 /* If we can take advantage of a passed in offset, do so. */
5643 /* In fact, offset0 is either 0, or less than offset, so don't
5644 need to worry about the other possibility. */
5646 + sv_pos_u2b_midway(start + boffset0, send,
5648 (*mgp)->mg_len - uoffset0);
5653 if (!found || PL_utf8cache < 0) {
5654 const STRLEN real_boffset
5655 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5656 send, uoffset - uoffset0);
5658 if (found && PL_utf8cache < 0) {
5659 if (real_boffset != boffset) {
5660 /* Need to turn the assertions off otherwise we may recurse
5661 infinitely while printing error messages. */
5662 SAVEI8(PL_utf8cache);
5664 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5665 " real %"UVuf" for %"SVf,
5666 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5669 boffset = real_boffset;
5672 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5678 =for apidoc sv_pos_u2b
5680 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5681 the start of the string, to a count of the equivalent number of bytes; if
5682 lenp is non-zero, it does the same to lenp, but this time starting from
5683 the offset, rather than from the start of the string. Handles magic and
5690 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5691 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5692 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5697 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5705 start = (U8*)SvPV_const(sv, len);
5707 STRLEN uoffset = (STRLEN) *offsetp;
5708 const U8 * const send = start + len;
5710 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5713 *offsetp = (I32) boffset;
5716 /* Convert the relative offset to absolute. */
5717 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5718 const STRLEN boffset2
5719 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5720 uoffset, boffset) - boffset;
5734 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5735 byte length pairing. The (byte) length of the total SV is passed in too,
5736 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5737 may not have updated SvCUR, so we can't rely on reading it directly.
5739 The proffered utf8/byte length pairing isn't used if the cache already has
5740 two pairs, and swapping either for the proffered pair would increase the
5741 RMS of the intervals between known byte offsets.
5743 The cache itself consists of 4 STRLEN values
5744 0: larger UTF-8 offset
5745 1: corresponding byte offset
5746 2: smaller UTF-8 offset
5747 3: corresponding byte offset
5749 Unused cache pairs have the value 0, 0.
5750 Keeping the cache "backwards" means that the invariant of
5751 cache[0] >= cache[2] is maintained even with empty slots, which means that
5752 the code that uses it doesn't need to worry if only 1 entry has actually
5753 been set to non-zero. It also makes the "position beyond the end of the
5754 cache" logic much simpler, as the first slot is always the one to start
5758 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5766 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5768 (*mgp)->mg_len = -1;
5772 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5773 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5774 (*mgp)->mg_ptr = (char *) cache;
5778 if (PL_utf8cache < 0) {
5779 const U8 *start = (const U8 *) SvPVX_const(sv);
5780 const STRLEN realutf8 = utf8_length(start, start + byte);
5782 if (realutf8 != utf8) {
5783 /* Need to turn the assertions off otherwise we may recurse
5784 infinitely while printing error messages. */
5785 SAVEI8(PL_utf8cache);
5787 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5788 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5792 /* Cache is held with the later position first, to simplify the code
5793 that deals with unbounded ends. */
5795 ASSERT_UTF8_CACHE(cache);
5796 if (cache[1] == 0) {
5797 /* Cache is totally empty */
5800 } else if (cache[3] == 0) {
5801 if (byte > cache[1]) {
5802 /* New one is larger, so goes first. */
5803 cache[2] = cache[0];
5804 cache[3] = cache[1];
5812 #define THREEWAY_SQUARE(a,b,c,d) \
5813 ((float)((d) - (c))) * ((float)((d) - (c))) \
5814 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5815 + ((float)((b) - (a))) * ((float)((b) - (a)))
5817 /* Cache has 2 slots in use, and we know three potential pairs.
5818 Keep the two that give the lowest RMS distance. Do the
5819 calcualation in bytes simply because we always know the byte
5820 length. squareroot has the same ordering as the positive value,
5821 so don't bother with the actual square root. */
5822 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5823 if (byte > cache[1]) {
5824 /* New position is after the existing pair of pairs. */
5825 const float keep_earlier
5826 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5827 const float keep_later
5828 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5830 if (keep_later < keep_earlier) {
5831 if (keep_later < existing) {
5832 cache[2] = cache[0];
5833 cache[3] = cache[1];
5839 if (keep_earlier < existing) {
5845 else if (byte > cache[3]) {
5846 /* New position is between the existing pair of pairs. */
5847 const float keep_earlier
5848 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5849 const float keep_later
5850 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5852 if (keep_later < keep_earlier) {
5853 if (keep_later < existing) {
5859 if (keep_earlier < existing) {
5866 /* New position is before the existing pair of pairs. */
5867 const float keep_earlier
5868 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5869 const float keep_later
5870 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5872 if (keep_later < keep_earlier) {
5873 if (keep_later < existing) {
5879 if (keep_earlier < existing) {
5880 cache[0] = cache[2];
5881 cache[1] = cache[3];
5888 ASSERT_UTF8_CACHE(cache);
5891 /* We already know all of the way, now we may be able to walk back. The same
5892 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5893 backward is half the speed of walking forward. */
5895 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5898 const STRLEN forw = target - s;
5899 STRLEN backw = end - target;
5901 if (forw < 2 * backw) {
5902 return utf8_length(s, target);
5905 while (end > target) {
5907 while (UTF8_IS_CONTINUATION(*end)) {
5916 =for apidoc sv_pos_b2u
5918 Converts the value pointed to by offsetp from a count of bytes from the
5919 start of the string, to a count of the equivalent number of UTF-8 chars.
5920 Handles magic and type coercion.
5926 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5927 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5932 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5935 const STRLEN byte = *offsetp;
5936 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5945 s = (const U8*)SvPV_const(sv, blen);
5948 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5952 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5953 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5955 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5956 if (cache[1] == byte) {
5957 /* An exact match. */
5958 *offsetp = cache[0];
5961 if (cache[3] == byte) {
5962 /* An exact match. */
5963 *offsetp = cache[2];
5967 if (cache[1] < byte) {
5968 /* We already know part of the way. */
5969 if (mg->mg_len != -1) {
5970 /* Actually, we know the end too. */
5972 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5973 s + blen, mg->mg_len - cache[0]);
5975 len = cache[0] + utf8_length(s + cache[1], send);
5978 else if (cache[3] < byte) {
5979 /* We're between the two cached pairs, so we do the calculation
5980 offset by the byte/utf-8 positions for the earlier pair,
5981 then add the utf-8 characters from the string start to
5983 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5984 s + cache[1], cache[0] - cache[2])
5988 else { /* cache[3] > byte */
5989 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5993 ASSERT_UTF8_CACHE(cache);
5995 } else if (mg->mg_len != -1) {
5996 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6000 if (!found || PL_utf8cache < 0) {
6001 const STRLEN real_len = utf8_length(s, send);
6003 if (found && PL_utf8cache < 0) {
6004 if (len != real_len) {
6005 /* Need to turn the assertions off otherwise we may recurse
6006 infinitely while printing error messages. */
6007 SAVEI8(PL_utf8cache);
6009 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6010 " real %"UVuf" for %"SVf,
6011 (UV) len, (UV) real_len, SVfARG(sv));
6018 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6024 Returns a boolean indicating whether the strings in the two SVs are
6025 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6026 coerce its args to strings if necessary.
6032 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6041 SV* svrecode = NULL;
6048 /* if pv1 and pv2 are the same, second SvPV_const call may
6049 * invalidate pv1, so we may need to make a copy */
6050 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6051 pv1 = SvPV_const(sv1, cur1);
6052 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6054 pv1 = SvPV_const(sv1, cur1);
6062 pv2 = SvPV_const(sv2, cur2);
6064 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6065 /* Differing utf8ness.
6066 * Do not UTF8size the comparands as a side-effect. */
6069 svrecode = newSVpvn(pv2, cur2);
6070 sv_recode_to_utf8(svrecode, PL_encoding);
6071 pv2 = SvPV_const(svrecode, cur2);
6074 svrecode = newSVpvn(pv1, cur1);
6075 sv_recode_to_utf8(svrecode, PL_encoding);
6076 pv1 = SvPV_const(svrecode, cur1);
6078 /* Now both are in UTF-8. */
6080 SvREFCNT_dec(svrecode);
6085 bool is_utf8 = TRUE;
6088 /* sv1 is the UTF-8 one,
6089 * if is equal it must be downgrade-able */
6090 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6096 /* sv2 is the UTF-8 one,
6097 * if is equal it must be downgrade-able */
6098 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6104 /* Downgrade not possible - cannot be eq */
6112 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6114 SvREFCNT_dec(svrecode);
6124 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6125 string in C<sv1> is less than, equal to, or greater than the string in
6126 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6127 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6133 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6137 const char *pv1, *pv2;
6140 SV *svrecode = NULL;
6147 pv1 = SvPV_const(sv1, cur1);
6154 pv2 = SvPV_const(sv2, cur2);
6156 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6157 /* Differing utf8ness.
6158 * Do not UTF8size the comparands as a side-effect. */
6161 svrecode = newSVpvn(pv2, cur2);
6162 sv_recode_to_utf8(svrecode, PL_encoding);
6163 pv2 = SvPV_const(svrecode, cur2);
6166 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6171 svrecode = newSVpvn(pv1, cur1);
6172 sv_recode_to_utf8(svrecode, PL_encoding);
6173 pv1 = SvPV_const(svrecode, cur1);
6176 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6182 cmp = cur2 ? -1 : 0;
6186 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6189 cmp = retval < 0 ? -1 : 1;
6190 } else if (cur1 == cur2) {
6193 cmp = cur1 < cur2 ? -1 : 1;
6197 SvREFCNT_dec(svrecode);
6205 =for apidoc sv_cmp_locale
6207 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6208 'use bytes' aware, handles get magic, and will coerce its args to strings
6209 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6215 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6218 #ifdef USE_LOCALE_COLLATE
6224 if (PL_collation_standard)
6228 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6230 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6232 if (!pv1 || !len1) {
6243 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6246 return retval < 0 ? -1 : 1;
6249 * When the result of collation is equality, that doesn't mean
6250 * that there are no differences -- some locales exclude some
6251 * characters from consideration. So to avoid false equalities,
6252 * we use the raw string as a tiebreaker.
6258 #endif /* USE_LOCALE_COLLATE */
6260 return sv_cmp(sv1, sv2);
6264 #ifdef USE_LOCALE_COLLATE
6267 =for apidoc sv_collxfrm
6269 Add Collate Transform magic to an SV if it doesn't already have it.
6271 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6272 scalar data of the variable, but transformed to such a format that a normal
6273 memory comparison can be used to compare the data according to the locale
6280 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6285 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6286 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6292 Safefree(mg->mg_ptr);
6293 s = SvPV_const(sv, len);
6294 if ((xf = mem_collxfrm(s, len, &xlen))) {
6295 if (SvREADONLY(sv)) {
6298 return xf + sizeof(PL_collation_ix);
6301 #ifdef PERL_OLD_COPY_ON_WRITE
6303 sv_force_normal_flags(sv, 0);
6305 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6319 if (mg && mg->mg_ptr) {
6321 return mg->mg_ptr + sizeof(PL_collation_ix);
6329 #endif /* USE_LOCALE_COLLATE */
6334 Get a line from the filehandle and store it into the SV, optionally
6335 appending to the currently-stored string.
6341 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6346 register STDCHAR rslast;
6347 register STDCHAR *bp;
6352 if (SvTHINKFIRST(sv))
6353 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6354 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6356 However, perlbench says it's slower, because the existing swipe code
6357 is faster than copy on write.
6358 Swings and roundabouts. */
6359 SvUPGRADE(sv, SVt_PV);
6364 if (PerlIO_isutf8(fp)) {
6366 sv_utf8_upgrade_nomg(sv);
6367 sv_pos_u2b(sv,&append,0);
6369 } else if (SvUTF8(sv)) {
6370 SV * const tsv = newSV(0);
6371 sv_gets(tsv, fp, 0);
6372 sv_utf8_upgrade_nomg(tsv);
6373 SvCUR_set(sv,append);
6376 goto return_string_or_null;
6381 if (PerlIO_isutf8(fp))
6384 if (IN_PERL_COMPILETIME) {
6385 /* we always read code in line mode */
6389 else if (RsSNARF(PL_rs)) {
6390 /* If it is a regular disk file use size from stat() as estimate
6391 of amount we are going to read -- may result in mallocing
6392 more memory than we really need if the layers below reduce
6393 the size we read (e.g. CRLF or a gzip layer).
6396 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6397 const Off_t offset = PerlIO_tell(fp);
6398 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6399 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6405 else if (RsRECORD(PL_rs)) {
6410 /* Grab the size of the record we're getting */
6411 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6412 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6415 /* VMS wants read instead of fread, because fread doesn't respect */
6416 /* RMS record boundaries. This is not necessarily a good thing to be */
6417 /* doing, but we've got no other real choice - except avoid stdio
6418 as implementation - perhaps write a :vms layer ?
6420 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6422 bytesread = PerlIO_read(fp, buffer, recsize);
6426 SvCUR_set(sv, bytesread += append);
6427 buffer[bytesread] = '\0';
6428 goto return_string_or_null;
6430 else if (RsPARA(PL_rs)) {
6436 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6437 if (PerlIO_isutf8(fp)) {
6438 rsptr = SvPVutf8(PL_rs, rslen);
6441 if (SvUTF8(PL_rs)) {
6442 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6443 Perl_croak(aTHX_ "Wide character in $/");
6446 rsptr = SvPV_const(PL_rs, rslen);
6450 rslast = rslen ? rsptr[rslen - 1] : '\0';
6452 if (rspara) { /* have to do this both before and after */
6453 do { /* to make sure file boundaries work right */
6456 i = PerlIO_getc(fp);
6460 PerlIO_ungetc(fp,i);
6466 /* See if we know enough about I/O mechanism to cheat it ! */
6468 /* This used to be #ifdef test - it is made run-time test for ease
6469 of abstracting out stdio interface. One call should be cheap
6470 enough here - and may even be a macro allowing compile
6474 if (PerlIO_fast_gets(fp)) {
6477 * We're going to steal some values from the stdio struct
6478 * and put EVERYTHING in the innermost loop into registers.
6480 register STDCHAR *ptr;
6484 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6485 /* An ungetc()d char is handled separately from the regular
6486 * buffer, so we getc() it back out and stuff it in the buffer.
6488 i = PerlIO_getc(fp);
6489 if (i == EOF) return 0;
6490 *(--((*fp)->_ptr)) = (unsigned char) i;
6494 /* Here is some breathtakingly efficient cheating */
6496 cnt = PerlIO_get_cnt(fp); /* get count into register */
6497 /* make sure we have the room */
6498 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6499 /* Not room for all of it
6500 if we are looking for a separator and room for some
6502 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6503 /* just process what we have room for */
6504 shortbuffered = cnt - SvLEN(sv) + append + 1;
6505 cnt -= shortbuffered;
6509 /* remember that cnt can be negative */
6510 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6515 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6516 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6517 DEBUG_P(PerlIO_printf(Perl_debug_log,
6518 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6519 DEBUG_P(PerlIO_printf(Perl_debug_log,
6520 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6521 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6522 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6527 while (cnt > 0) { /* this | eat */
6529 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6530 goto thats_all_folks; /* screams | sed :-) */
6534 Copy(ptr, bp, cnt, char); /* this | eat */
6535 bp += cnt; /* screams | dust */
6536 ptr += cnt; /* louder | sed :-) */
6541 if (shortbuffered) { /* oh well, must extend */
6542 cnt = shortbuffered;
6544 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6546 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6547 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6551 DEBUG_P(PerlIO_printf(Perl_debug_log,
6552 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6553 PTR2UV(ptr),(long)cnt));
6554 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6556 DEBUG_P(PerlIO_printf(Perl_debug_log,
6557 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6558 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6559 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6561 /* This used to call 'filbuf' in stdio form, but as that behaves like
6562 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6563 another abstraction. */
6564 i = PerlIO_getc(fp); /* get more characters */
6566 DEBUG_P(PerlIO_printf(Perl_debug_log,
6567 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6568 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6569 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6571 cnt = PerlIO_get_cnt(fp);
6572 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6573 DEBUG_P(PerlIO_printf(Perl_debug_log,
6574 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6576 if (i == EOF) /* all done for ever? */
6577 goto thats_really_all_folks;
6579 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6581 SvGROW(sv, bpx + cnt + 2);
6582 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6584 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6586 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6587 goto thats_all_folks;
6591 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6592 memNE((char*)bp - rslen, rsptr, rslen))
6593 goto screamer; /* go back to the fray */
6594 thats_really_all_folks:
6596 cnt += shortbuffered;
6597 DEBUG_P(PerlIO_printf(Perl_debug_log,
6598 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6599 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6600 DEBUG_P(PerlIO_printf(Perl_debug_log,
6601 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6602 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6603 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6605 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6606 DEBUG_P(PerlIO_printf(Perl_debug_log,
6607 "Screamer: done, len=%ld, string=|%.*s|\n",
6608 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6612 /*The big, slow, and stupid way. */
6613 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6614 STDCHAR *buf = NULL;
6615 Newx(buf, 8192, STDCHAR);
6623 register const STDCHAR * const bpe = buf + sizeof(buf);
6625 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6626 ; /* keep reading */
6630 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6631 /* Accomodate broken VAXC compiler, which applies U8 cast to
6632 * both args of ?: operator, causing EOF to change into 255
6635 i = (U8)buf[cnt - 1];
6641 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6643 sv_catpvn(sv, (char *) buf, cnt);
6645 sv_setpvn(sv, (char *) buf, cnt);
6647 if (i != EOF && /* joy */
6649 SvCUR(sv) < rslen ||
6650 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6654 * If we're reading from a TTY and we get a short read,
6655 * indicating that the user hit his EOF character, we need
6656 * to notice it now, because if we try to read from the TTY
6657 * again, the EOF condition will disappear.
6659 * The comparison of cnt to sizeof(buf) is an optimization
6660 * that prevents unnecessary calls to feof().
6664 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6668 #ifdef USE_HEAP_INSTEAD_OF_STACK
6673 if (rspara) { /* have to do this both before and after */
6674 while (i != EOF) { /* to make sure file boundaries work right */
6675 i = PerlIO_getc(fp);
6677 PerlIO_ungetc(fp,i);
6683 return_string_or_null:
6684 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6690 Auto-increment of the value in the SV, doing string to numeric conversion
6691 if necessary. Handles 'get' magic.
6697 Perl_sv_inc(pTHX_ register SV *sv)
6706 if (SvTHINKFIRST(sv)) {
6708 sv_force_normal_flags(sv, 0);
6709 if (SvREADONLY(sv)) {
6710 if (IN_PERL_RUNTIME)
6711 Perl_croak(aTHX_ PL_no_modify);
6715 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6717 i = PTR2IV(SvRV(sv));
6722 flags = SvFLAGS(sv);
6723 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6724 /* It's (privately or publicly) a float, but not tested as an
6725 integer, so test it to see. */
6727 flags = SvFLAGS(sv);
6729 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6730 /* It's publicly an integer, or privately an integer-not-float */
6731 #ifdef PERL_PRESERVE_IVUV
6735 if (SvUVX(sv) == UV_MAX)
6736 sv_setnv(sv, UV_MAX_P1);
6738 (void)SvIOK_only_UV(sv);
6739 SvUV_set(sv, SvUVX(sv) + 1);
6741 if (SvIVX(sv) == IV_MAX)
6742 sv_setuv(sv, (UV)IV_MAX + 1);
6744 (void)SvIOK_only(sv);
6745 SvIV_set(sv, SvIVX(sv) + 1);
6750 if (flags & SVp_NOK) {
6751 (void)SvNOK_only(sv);
6752 SvNV_set(sv, SvNVX(sv) + 1.0);
6756 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6757 if ((flags & SVTYPEMASK) < SVt_PVIV)
6758 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6759 (void)SvIOK_only(sv);
6764 while (isALPHA(*d)) d++;
6765 while (isDIGIT(*d)) d++;
6767 #ifdef PERL_PRESERVE_IVUV
6768 /* Got to punt this as an integer if needs be, but we don't issue
6769 warnings. Probably ought to make the sv_iv_please() that does
6770 the conversion if possible, and silently. */
6771 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6772 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6773 /* Need to try really hard to see if it's an integer.
6774 9.22337203685478e+18 is an integer.
6775 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6776 so $a="9.22337203685478e+18"; $a+0; $a++
6777 needs to be the same as $a="9.22337203685478e+18"; $a++
6784 /* sv_2iv *should* have made this an NV */
6785 if (flags & SVp_NOK) {
6786 (void)SvNOK_only(sv);
6787 SvNV_set(sv, SvNVX(sv) + 1.0);
6790 /* I don't think we can get here. Maybe I should assert this
6791 And if we do get here I suspect that sv_setnv will croak. NWC
6793 #if defined(USE_LONG_DOUBLE)
6794 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",
6795 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6797 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6798 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6801 #endif /* PERL_PRESERVE_IVUV */
6802 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6806 while (d >= SvPVX_const(sv)) {
6814 /* MKS: The original code here died if letters weren't consecutive.
6815 * at least it didn't have to worry about non-C locales. The
6816 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6817 * arranged in order (although not consecutively) and that only
6818 * [A-Za-z] are accepted by isALPHA in the C locale.
6820 if (*d != 'z' && *d != 'Z') {
6821 do { ++*d; } while (!isALPHA(*d));
6824 *(d--) -= 'z' - 'a';
6829 *(d--) -= 'z' - 'a' + 1;
6833 /* oh,oh, the number grew */
6834 SvGROW(sv, SvCUR(sv) + 2);
6835 SvCUR_set(sv, SvCUR(sv) + 1);
6836 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6847 Auto-decrement of the value in the SV, doing string to numeric conversion
6848 if necessary. Handles 'get' magic.
6854 Perl_sv_dec(pTHX_ register SV *sv)
6862 if (SvTHINKFIRST(sv)) {
6864 sv_force_normal_flags(sv, 0);
6865 if (SvREADONLY(sv)) {
6866 if (IN_PERL_RUNTIME)
6867 Perl_croak(aTHX_ PL_no_modify);
6871 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6873 i = PTR2IV(SvRV(sv));
6878 /* Unlike sv_inc we don't have to worry about string-never-numbers
6879 and keeping them magic. But we mustn't warn on punting */
6880 flags = SvFLAGS(sv);
6881 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6882 /* It's publicly an integer, or privately an integer-not-float */
6883 #ifdef PERL_PRESERVE_IVUV
6887 if (SvUVX(sv) == 0) {
6888 (void)SvIOK_only(sv);
6892 (void)SvIOK_only_UV(sv);
6893 SvUV_set(sv, SvUVX(sv) - 1);
6896 if (SvIVX(sv) == IV_MIN)
6897 sv_setnv(sv, (NV)IV_MIN - 1.0);
6899 (void)SvIOK_only(sv);
6900 SvIV_set(sv, SvIVX(sv) - 1);
6905 if (flags & SVp_NOK) {
6906 SvNV_set(sv, SvNVX(sv) - 1.0);
6907 (void)SvNOK_only(sv);
6910 if (!(flags & SVp_POK)) {
6911 if ((flags & SVTYPEMASK) < SVt_PVIV)
6912 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6914 (void)SvIOK_only(sv);
6917 #ifdef PERL_PRESERVE_IVUV
6919 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6920 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6921 /* Need to try really hard to see if it's an integer.
6922 9.22337203685478e+18 is an integer.
6923 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6924 so $a="9.22337203685478e+18"; $a+0; $a--
6925 needs to be the same as $a="9.22337203685478e+18"; $a--
6932 /* sv_2iv *should* have made this an NV */
6933 if (flags & SVp_NOK) {
6934 (void)SvNOK_only(sv);
6935 SvNV_set(sv, SvNVX(sv) - 1.0);
6938 /* I don't think we can get here. Maybe I should assert this
6939 And if we do get here I suspect that sv_setnv will croak. NWC
6941 #if defined(USE_LONG_DOUBLE)
6942 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",
6943 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6945 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6946 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6950 #endif /* PERL_PRESERVE_IVUV */
6951 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6955 =for apidoc sv_mortalcopy
6957 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6958 The new SV is marked as mortal. It will be destroyed "soon", either by an
6959 explicit call to FREETMPS, or by an implicit call at places such as
6960 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6965 /* Make a string that will exist for the duration of the expression
6966 * evaluation. Actually, it may have to last longer than that, but
6967 * hopefully we won't free it until it has been assigned to a
6968 * permanent location. */
6971 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6977 sv_setsv(sv,oldstr);
6979 PL_tmps_stack[++PL_tmps_ix] = sv;
6985 =for apidoc sv_newmortal
6987 Creates a new null SV which is mortal. The reference count of the SV is
6988 set to 1. It will be destroyed "soon", either by an explicit call to
6989 FREETMPS, or by an implicit call at places such as statement boundaries.
6990 See also C<sv_mortalcopy> and C<sv_2mortal>.
6996 Perl_sv_newmortal(pTHX)
7002 SvFLAGS(sv) = SVs_TEMP;
7004 PL_tmps_stack[++PL_tmps_ix] = sv;
7010 =for apidoc newSVpvn_flags
7012 Creates a new SV and copies a string into it. The reference count for the
7013 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7014 string. You are responsible for ensuring that the source string is at least
7015 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7016 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7017 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7018 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7019 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7021 #define newSVpvn_utf8(s, len, u) \
7022 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7028 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7033 /* All the flags we don't support must be zero.
7034 And we're new code so I'm going to assert this from the start. */
7035 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7037 sv_setpvn(sv,s,len);
7038 SvFLAGS(sv) |= (flags & SVf_UTF8);
7039 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7043 =for apidoc sv_2mortal
7045 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7046 by an explicit call to FREETMPS, or by an implicit call at places such as
7047 statement boundaries. SvTEMP() is turned on which means that the SV's
7048 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7049 and C<sv_mortalcopy>.
7055 Perl_sv_2mortal(pTHX_ register SV *sv)
7060 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7063 PL_tmps_stack[++PL_tmps_ix] = sv;
7071 Creates a new SV and copies a string into it. The reference count for the
7072 SV is set to 1. If C<len> is zero, Perl will compute the length using
7073 strlen(). For efficiency, consider using C<newSVpvn> instead.
7079 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7085 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7090 =for apidoc newSVpvn
7092 Creates a new SV and copies a string into it. The reference count for the
7093 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7094 string. You are responsible for ensuring that the source string is at least
7095 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7101 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7107 sv_setpvn(sv,s,len);
7112 =for apidoc newSVhek
7114 Creates a new SV from the hash key structure. It will generate scalars that
7115 point to the shared string table where possible. Returns a new (undefined)
7116 SV if the hek is NULL.
7122 Perl_newSVhek(pTHX_ const HEK *hek)
7132 if (HEK_LEN(hek) == HEf_SVKEY) {
7133 return newSVsv(*(SV**)HEK_KEY(hek));
7135 const int flags = HEK_FLAGS(hek);
7136 if (flags & HVhek_WASUTF8) {
7138 Andreas would like keys he put in as utf8 to come back as utf8
7140 STRLEN utf8_len = HEK_LEN(hek);
7141 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7142 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7145 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7147 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7148 /* We don't have a pointer to the hv, so we have to replicate the
7149 flag into every HEK. This hv is using custom a hasing
7150 algorithm. Hence we can't return a shared string scalar, as
7151 that would contain the (wrong) hash value, and might get passed
7152 into an hv routine with a regular hash.
7153 Similarly, a hash that isn't using shared hash keys has to have
7154 the flag in every key so that we know not to try to call
7155 share_hek_kek on it. */
7157 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7162 /* This will be overwhelminly the most common case. */
7164 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7165 more efficient than sharepvn(). */
7169 sv_upgrade(sv, SVt_PV);
7170 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7171 SvCUR_set(sv, HEK_LEN(hek));
7184 =for apidoc newSVpvn_share
7186 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7187 table. If the string does not already exist in the table, it is created
7188 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7189 value is used; otherwise the hash is computed. The string's hash can be later
7190 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7191 that as the string table is used for shared hash keys these strings will have
7192 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7198 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7202 bool is_utf8 = FALSE;
7203 const char *const orig_src = src;
7206 STRLEN tmplen = -len;
7208 /* See the note in hv.c:hv_fetch() --jhi */
7209 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7213 PERL_HASH(hash, src, len);
7215 sv_upgrade(sv, SVt_PV);
7216 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7224 if (src != orig_src)
7230 #if defined(PERL_IMPLICIT_CONTEXT)
7232 /* pTHX_ magic can't cope with varargs, so this is a no-context
7233 * version of the main function, (which may itself be aliased to us).
7234 * Don't access this version directly.
7238 Perl_newSVpvf_nocontext(const char* pat, ...)
7243 va_start(args, pat);
7244 sv = vnewSVpvf(pat, &args);
7251 =for apidoc newSVpvf
7253 Creates a new SV and initializes it with the string formatted like
7260 Perl_newSVpvf(pTHX_ const char* pat, ...)
7264 va_start(args, pat);
7265 sv = vnewSVpvf(pat, &args);
7270 /* backend for newSVpvf() and newSVpvf_nocontext() */
7273 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7278 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7285 Creates a new SV and copies a floating point value into it.
7286 The reference count for the SV is set to 1.
7292 Perl_newSVnv(pTHX_ NV n)
7305 Creates a new SV and copies an integer into it. The reference count for the
7312 Perl_newSViv(pTHX_ IV i)
7325 Creates a new SV and copies an unsigned integer into it.
7326 The reference count for the SV is set to 1.
7332 Perl_newSVuv(pTHX_ UV u)
7343 =for apidoc newSV_type
7345 Creates a new SV, of the type specified. The reference count for the new SV
7352 Perl_newSV_type(pTHX_ svtype type)
7357 sv_upgrade(sv, type);
7362 =for apidoc newRV_noinc
7364 Creates an RV wrapper for an SV. The reference count for the original
7365 SV is B<not> incremented.
7371 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7374 register SV *sv = newSV_type(SVt_IV);
7376 SvRV_set(sv, tmpRef);
7381 /* newRV_inc is the official function name to use now.
7382 * newRV_inc is in fact #defined to newRV in sv.h
7386 Perl_newRV(pTHX_ SV *sv)
7389 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7395 Creates a new SV which is an exact duplicate of the original SV.
7402 Perl_newSVsv(pTHX_ register SV *old)
7409 if (SvTYPE(old) == SVTYPEMASK) {
7410 if (ckWARN_d(WARN_INTERNAL))
7411 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7415 /* SV_GMAGIC is the default for sv_setv()
7416 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7417 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7418 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7423 =for apidoc sv_reset
7425 Underlying implementation for the C<reset> Perl function.
7426 Note that the perl-level function is vaguely deprecated.
7432 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7435 char todo[PERL_UCHAR_MAX+1];
7440 if (!*s) { /* reset ?? searches */
7441 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7443 const U32 count = mg->mg_len / sizeof(PMOP**);
7444 PMOP **pmp = (PMOP**) mg->mg_ptr;
7445 PMOP *const *const end = pmp + count;
7449 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7451 (*pmp)->op_pmflags &= ~PMf_USED;
7459 /* reset variables */
7461 if (!HvARRAY(stash))
7464 Zero(todo, 256, char);
7467 I32 i = (unsigned char)*s;
7471 max = (unsigned char)*s++;
7472 for ( ; i <= max; i++) {
7475 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7477 for (entry = HvARRAY(stash)[i];
7479 entry = HeNEXT(entry))
7484 if (!todo[(U8)*HeKEY(entry)])
7486 gv = (GV*)HeVAL(entry);
7489 if (SvTHINKFIRST(sv)) {
7490 if (!SvREADONLY(sv) && SvROK(sv))
7492 /* XXX Is this continue a bug? Why should THINKFIRST
7493 exempt us from resetting arrays and hashes? */
7497 if (SvTYPE(sv) >= SVt_PV) {
7499 if (SvPVX_const(sv) != NULL)
7507 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7509 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7512 # if defined(USE_ENVIRON_ARRAY)
7515 # endif /* USE_ENVIRON_ARRAY */
7526 Using various gambits, try to get an IO from an SV: the IO slot if its a
7527 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7528 named after the PV if we're a string.
7534 Perl_sv_2io(pTHX_ SV *sv)
7539 switch (SvTYPE(sv)) {
7547 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7551 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7553 return sv_2io(SvRV(sv));
7554 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7560 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7569 Using various gambits, try to get a CV from an SV; in addition, try if
7570 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7571 The flags in C<lref> are passed to sv_fetchsv.
7577 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7588 switch (SvTYPE(sv)) {
7607 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7608 tryAMAGICunDEREF(to_cv);
7611 if (SvTYPE(sv) == SVt_PVCV) {
7620 Perl_croak(aTHX_ "Not a subroutine reference");
7625 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7631 /* Some flags to gv_fetchsv mean don't really create the GV */
7632 if (SvTYPE(gv) != SVt_PVGV) {
7638 if (lref && !GvCVu(gv)) {
7642 gv_efullname3(tmpsv, gv, NULL);
7643 /* XXX this is probably not what they think they're getting.
7644 * It has the same effect as "sub name;", i.e. just a forward
7646 newSUB(start_subparse(FALSE, 0),
7647 newSVOP(OP_CONST, 0, tmpsv),
7651 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7661 Returns true if the SV has a true value by Perl's rules.
7662 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7663 instead use an in-line version.
7669 Perl_sv_true(pTHX_ register SV *sv)
7674 register const XPV* const tXpv = (XPV*)SvANY(sv);
7676 (tXpv->xpv_cur > 1 ||
7677 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7684 return SvIVX(sv) != 0;
7687 return SvNVX(sv) != 0.0;
7689 return sv_2bool(sv);
7695 =for apidoc sv_pvn_force
7697 Get a sensible string out of the SV somehow.
7698 A private implementation of the C<SvPV_force> macro for compilers which
7699 can't cope with complex macro expressions. Always use the macro instead.
7701 =for apidoc sv_pvn_force_flags
7703 Get a sensible string out of the SV somehow.
7704 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7705 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7706 implemented in terms of this function.
7707 You normally want to use the various wrapper macros instead: see
7708 C<SvPV_force> and C<SvPV_force_nomg>
7714 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7717 if (SvTHINKFIRST(sv) && !SvROK(sv))
7718 sv_force_normal_flags(sv, 0);
7728 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7729 const char * const ref = sv_reftype(sv,0);
7731 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7732 ref, OP_NAME(PL_op));
7734 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7736 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7737 || isGV_with_GP(sv))
7738 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7740 s = sv_2pv_flags(sv, &len, flags);
7744 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7747 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7748 SvGROW(sv, len + 1);
7749 Move(s,SvPVX(sv),len,char);
7751 SvPVX(sv)[len] = '\0';
7754 SvPOK_on(sv); /* validate pointer */
7756 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7757 PTR2UV(sv),SvPVX_const(sv)));
7760 return SvPVX_mutable(sv);
7764 =for apidoc sv_pvbyten_force
7766 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7772 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7774 sv_pvn_force(sv,lp);
7775 sv_utf8_downgrade(sv,0);
7781 =for apidoc sv_pvutf8n_force
7783 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7789 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7791 sv_pvn_force(sv,lp);
7792 sv_utf8_upgrade(sv);
7798 =for apidoc sv_reftype
7800 Returns a string describing what the SV is a reference to.
7806 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7808 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7809 inside return suggests a const propagation bug in g++. */
7810 if (ob && SvOBJECT(sv)) {
7811 char * const name = HvNAME_get(SvSTASH(sv));
7812 return name ? name : (char *) "__ANON__";
7815 switch (SvTYPE(sv)) {
7830 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7831 /* tied lvalues should appear to be
7832 * scalars for backwards compatitbility */
7833 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7834 ? "SCALAR" : "LVALUE");
7835 case SVt_PVAV: return "ARRAY";
7836 case SVt_PVHV: return "HASH";
7837 case SVt_PVCV: return "CODE";
7838 case SVt_PVGV: return "GLOB";
7839 case SVt_PVFM: return "FORMAT";
7840 case SVt_PVIO: return "IO";
7841 case SVt_BIND: return "BIND";
7842 case SVt_REGEXP: return "Regexp"; /* FIXME? to "REGEXP" */
7843 default: return "UNKNOWN";
7849 =for apidoc sv_isobject
7851 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7852 object. If the SV is not an RV, or if the object is not blessed, then this
7859 Perl_sv_isobject(pTHX_ SV *sv)
7875 Returns a boolean indicating whether the SV is blessed into the specified
7876 class. This does not check for subtypes; use C<sv_derived_from> to verify
7877 an inheritance relationship.
7883 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7894 hvname = HvNAME_get(SvSTASH(sv));
7898 return strEQ(hvname, name);
7904 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7905 it will be upgraded to one. If C<classname> is non-null then the new SV will
7906 be blessed in the specified package. The new SV is returned and its
7907 reference count is 1.
7913 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7920 SV_CHECK_THINKFIRST_COW_DROP(rv);
7921 (void)SvAMAGIC_off(rv);
7923 if (SvTYPE(rv) >= SVt_PVMG) {
7924 const U32 refcnt = SvREFCNT(rv);
7928 SvREFCNT(rv) = refcnt;
7930 sv_upgrade(rv, SVt_IV);
7931 } else if (SvROK(rv)) {
7932 SvREFCNT_dec(SvRV(rv));
7934 prepare_SV_for_RV(rv);
7942 HV* const stash = gv_stashpv(classname, GV_ADD);
7943 (void)sv_bless(rv, stash);
7949 =for apidoc sv_setref_pv
7951 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7952 argument will be upgraded to an RV. That RV will be modified to point to
7953 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7954 into the SV. The C<classname> argument indicates the package for the
7955 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7956 will have a reference count of 1, and the RV will be returned.
7958 Do not use with other Perl types such as HV, AV, SV, CV, because those
7959 objects will become corrupted by the pointer copy process.
7961 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7967 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7971 sv_setsv(rv, &PL_sv_undef);
7975 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7980 =for apidoc sv_setref_iv
7982 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7983 argument will be upgraded to an RV. That RV will be modified to point to
7984 the new SV. The C<classname> argument indicates the package for the
7985 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7986 will have a reference count of 1, and the RV will be returned.
7992 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7994 sv_setiv(newSVrv(rv,classname), iv);
7999 =for apidoc sv_setref_uv
8001 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8002 argument will be upgraded to an RV. That RV will be modified to point to
8003 the new SV. The C<classname> argument indicates the package for the
8004 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8005 will have a reference count of 1, and the RV will be returned.
8011 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8013 sv_setuv(newSVrv(rv,classname), uv);
8018 =for apidoc sv_setref_nv
8020 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8021 argument will be upgraded to an RV. That RV will be modified to point to
8022 the new SV. The C<classname> argument indicates the package for the
8023 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8024 will have a reference count of 1, and the RV will be returned.
8030 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8032 sv_setnv(newSVrv(rv,classname), nv);
8037 =for apidoc sv_setref_pvn
8039 Copies a string into a new SV, optionally blessing the SV. The length of the
8040 string must be specified with C<n>. The C<rv> argument will be upgraded to
8041 an RV. That RV will be modified to point to the new SV. The C<classname>
8042 argument indicates the package for the blessing. Set C<classname> to
8043 C<NULL> to avoid the blessing. The new SV will have a reference count
8044 of 1, and the RV will be returned.
8046 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8052 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8054 sv_setpvn(newSVrv(rv,classname), pv, n);
8059 =for apidoc sv_bless
8061 Blesses an SV into a specified package. The SV must be an RV. The package
8062 must be designated by its stash (see C<gv_stashpv()>). The reference count
8063 of the SV is unaffected.
8069 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8074 Perl_croak(aTHX_ "Can't bless non-reference value");
8076 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8077 if (SvIsCOW(tmpRef))
8078 sv_force_normal_flags(tmpRef, 0);
8079 if (SvREADONLY(tmpRef))
8080 Perl_croak(aTHX_ PL_no_modify);
8081 if (SvOBJECT(tmpRef)) {
8082 if (SvTYPE(tmpRef) != SVt_PVIO)
8084 SvREFCNT_dec(SvSTASH(tmpRef));
8087 SvOBJECT_on(tmpRef);
8088 if (SvTYPE(tmpRef) != SVt_PVIO)
8090 SvUPGRADE(tmpRef, SVt_PVMG);
8091 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8096 (void)SvAMAGIC_off(sv);
8098 if(SvSMAGICAL(tmpRef))
8099 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8107 /* Downgrades a PVGV to a PVMG.
8111 S_sv_unglob(pTHX_ SV *sv)
8116 SV * const temp = sv_newmortal();
8118 assert(SvTYPE(sv) == SVt_PVGV);
8120 gv_efullname3(temp, (GV *) sv, "*");
8123 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8124 mro_method_changed_in(stash);
8128 sv_del_backref((SV*)GvSTASH(sv), sv);
8132 if (GvNAME_HEK(sv)) {
8133 unshare_hek(GvNAME_HEK(sv));
8135 isGV_with_GP_off(sv);
8137 /* need to keep SvANY(sv) in the right arena */
8138 xpvmg = new_XPVMG();
8139 StructCopy(SvANY(sv), xpvmg, XPVMG);
8140 del_XPVGV(SvANY(sv));
8143 SvFLAGS(sv) &= ~SVTYPEMASK;
8144 SvFLAGS(sv) |= SVt_PVMG;
8146 /* Intentionally not calling any local SET magic, as this isn't so much a
8147 set operation as merely an internal storage change. */
8148 sv_setsv_flags(sv, temp, 0);
8152 =for apidoc sv_unref_flags
8154 Unsets the RV status of the SV, and decrements the reference count of
8155 whatever was being referenced by the RV. This can almost be thought of
8156 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8157 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8158 (otherwise the decrementing is conditional on the reference count being
8159 different from one or the reference being a readonly SV).
8166 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8168 SV* const target = SvRV(ref);
8170 if (SvWEAKREF(ref)) {
8171 sv_del_backref(target, ref);
8173 SvRV_set(ref, NULL);
8176 SvRV_set(ref, NULL);
8178 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8179 assigned to as BEGIN {$a = \"Foo"} will fail. */
8180 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8181 SvREFCNT_dec(target);
8182 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8183 sv_2mortal(target); /* Schedule for freeing later */
8187 =for apidoc sv_untaint
8189 Untaint an SV. Use C<SvTAINTED_off> instead.
8194 Perl_sv_untaint(pTHX_ SV *sv)
8196 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8197 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8204 =for apidoc sv_tainted
8206 Test an SV for taintedness. Use C<SvTAINTED> instead.
8211 Perl_sv_tainted(pTHX_ SV *sv)
8213 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8214 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8215 if (mg && (mg->mg_len & 1) )
8222 =for apidoc sv_setpviv
8224 Copies an integer into the given SV, also updating its string value.
8225 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8231 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8233 char buf[TYPE_CHARS(UV)];
8235 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8237 sv_setpvn(sv, ptr, ebuf - ptr);
8241 =for apidoc sv_setpviv_mg
8243 Like C<sv_setpviv>, but also handles 'set' magic.
8249 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8255 #if defined(PERL_IMPLICIT_CONTEXT)
8257 /* pTHX_ magic can't cope with varargs, so this is a no-context
8258 * version of the main function, (which may itself be aliased to us).
8259 * Don't access this version directly.
8263 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8267 va_start(args, pat);
8268 sv_vsetpvf(sv, pat, &args);
8272 /* pTHX_ magic can't cope with varargs, so this is a no-context
8273 * version of the main function, (which may itself be aliased to us).
8274 * Don't access this version directly.
8278 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8282 va_start(args, pat);
8283 sv_vsetpvf_mg(sv, pat, &args);
8289 =for apidoc sv_setpvf
8291 Works like C<sv_catpvf> but copies the text into the SV instead of
8292 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8298 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8301 va_start(args, pat);
8302 sv_vsetpvf(sv, pat, &args);
8307 =for apidoc sv_vsetpvf
8309 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8310 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8312 Usually used via its frontend C<sv_setpvf>.
8318 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8320 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8324 =for apidoc sv_setpvf_mg
8326 Like C<sv_setpvf>, but also handles 'set' magic.
8332 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8335 va_start(args, pat);
8336 sv_vsetpvf_mg(sv, pat, &args);
8341 =for apidoc sv_vsetpvf_mg
8343 Like C<sv_vsetpvf>, but also handles 'set' magic.
8345 Usually used via its frontend C<sv_setpvf_mg>.
8351 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8353 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8357 #if defined(PERL_IMPLICIT_CONTEXT)
8359 /* pTHX_ magic can't cope with varargs, so this is a no-context
8360 * version of the main function, (which may itself be aliased to us).
8361 * Don't access this version directly.
8365 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8369 va_start(args, pat);
8370 sv_vcatpvf(sv, pat, &args);
8374 /* pTHX_ magic can't cope with varargs, so this is a no-context
8375 * version of the main function, (which may itself be aliased to us).
8376 * Don't access this version directly.
8380 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8384 va_start(args, pat);
8385 sv_vcatpvf_mg(sv, pat, &args);
8391 =for apidoc sv_catpvf
8393 Processes its arguments like C<sprintf> and appends the formatted
8394 output to an SV. If the appended data contains "wide" characters
8395 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8396 and characters >255 formatted with %c), the original SV might get
8397 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8398 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8399 valid UTF-8; if the original SV was bytes, the pattern should be too.
8404 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8407 va_start(args, pat);
8408 sv_vcatpvf(sv, pat, &args);
8413 =for apidoc sv_vcatpvf
8415 Processes its arguments like C<vsprintf> and appends the formatted output
8416 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8418 Usually used via its frontend C<sv_catpvf>.
8424 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8426 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8430 =for apidoc sv_catpvf_mg
8432 Like C<sv_catpvf>, but also handles 'set' magic.
8438 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8441 va_start(args, pat);
8442 sv_vcatpvf_mg(sv, pat, &args);
8447 =for apidoc sv_vcatpvf_mg
8449 Like C<sv_vcatpvf>, but also handles 'set' magic.
8451 Usually used via its frontend C<sv_catpvf_mg>.
8457 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8459 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8464 =for apidoc sv_vsetpvfn
8466 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8469 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8475 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8477 sv_setpvn(sv, "", 0);
8478 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8482 S_expect_number(pTHX_ char** pattern)
8486 switch (**pattern) {
8487 case '1': case '2': case '3':
8488 case '4': case '5': case '6':
8489 case '7': case '8': case '9':
8490 var = *(*pattern)++ - '0';
8491 while (isDIGIT(**pattern)) {
8492 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8494 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8502 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8504 const int neg = nv < 0;
8513 if (uv & 1 && uv == nv)
8514 uv--; /* Round to even */
8516 const unsigned dig = uv % 10;
8529 =for apidoc sv_vcatpvfn
8531 Processes its arguments like C<vsprintf> and appends the formatted output
8532 to an SV. Uses an array of SVs if the C style variable argument list is
8533 missing (NULL). When running with taint checks enabled, indicates via
8534 C<maybe_tainted> if results are untrustworthy (often due to the use of
8537 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8543 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8544 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8545 vec_utf8 = DO_UTF8(vecsv);
8547 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8550 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8558 static const char nullstr[] = "(null)";
8560 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8561 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8563 /* Times 4: a decimal digit takes more than 3 binary digits.
8564 * NV_DIG: mantissa takes than many decimal digits.
8565 * Plus 32: Playing safe. */
8566 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8567 /* large enough for "%#.#f" --chip */
8568 /* what about long double NVs? --jhi */
8570 PERL_UNUSED_ARG(maybe_tainted);
8572 /* no matter what, this is a string now */
8573 (void)SvPV_force(sv, origlen);
8575 /* special-case "", "%s", and "%-p" (SVf - see below) */
8578 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8580 const char * const s = va_arg(*args, char*);
8581 sv_catpv(sv, s ? s : nullstr);
8583 else if (svix < svmax) {
8584 sv_catsv(sv, *svargs);
8588 if (args && patlen == 3 && pat[0] == '%' &&
8589 pat[1] == '-' && pat[2] == 'p') {
8590 argsv = (SV*)va_arg(*args, void*);
8591 sv_catsv(sv, argsv);
8595 #ifndef USE_LONG_DOUBLE
8596 /* special-case "%.<number>[gf]" */
8597 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8598 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8599 unsigned digits = 0;
8603 while (*pp >= '0' && *pp <= '9')
8604 digits = 10 * digits + (*pp++ - '0');
8605 if (pp - pat == (int)patlen - 1) {
8613 /* Add check for digits != 0 because it seems that some
8614 gconverts are buggy in this case, and we don't yet have
8615 a Configure test for this. */
8616 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8617 /* 0, point, slack */
8618 Gconvert(nv, (int)digits, 0, ebuf);
8620 if (*ebuf) /* May return an empty string for digits==0 */
8623 } else if (!digits) {
8626 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8627 sv_catpvn(sv, p, l);
8633 #endif /* !USE_LONG_DOUBLE */
8635 if (!args && svix < svmax && DO_UTF8(*svargs))
8638 patend = (char*)pat + patlen;
8639 for (p = (char*)pat; p < patend; p = q) {
8642 bool vectorize = FALSE;
8643 bool vectorarg = FALSE;
8644 bool vec_utf8 = FALSE;
8650 bool has_precis = FALSE;
8652 const I32 osvix = svix;
8653 bool is_utf8 = FALSE; /* is this item utf8? */
8654 #ifdef HAS_LDBL_SPRINTF_BUG
8655 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8656 with sfio - Allen <allens@cpan.org> */
8657 bool fix_ldbl_sprintf_bug = FALSE;
8661 U8 utf8buf[UTF8_MAXBYTES+1];
8662 STRLEN esignlen = 0;
8664 const char *eptr = NULL;
8667 const U8 *vecstr = NULL;
8674 /* we need a long double target in case HAS_LONG_DOUBLE but
8677 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8685 const char *dotstr = ".";
8686 STRLEN dotstrlen = 1;
8687 I32 efix = 0; /* explicit format parameter index */
8688 I32 ewix = 0; /* explicit width index */
8689 I32 epix = 0; /* explicit precision index */
8690 I32 evix = 0; /* explicit vector index */
8691 bool asterisk = FALSE;
8693 /* echo everything up to the next format specification */
8694 for (q = p; q < patend && *q != '%'; ++q) ;
8696 if (has_utf8 && !pat_utf8)
8697 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8699 sv_catpvn(sv, p, q - p);
8706 We allow format specification elements in this order:
8707 \d+\$ explicit format parameter index
8709 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8710 0 flag (as above): repeated to allow "v02"
8711 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8712 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8714 [%bcdefginopsuxDFOUX] format (mandatory)
8719 As of perl5.9.3, printf format checking is on by default.
8720 Internally, perl uses %p formats to provide an escape to
8721 some extended formatting. This block deals with those
8722 extensions: if it does not match, (char*)q is reset and
8723 the normal format processing code is used.
8725 Currently defined extensions are:
8726 %p include pointer address (standard)
8727 %-p (SVf) include an SV (previously %_)
8728 %-<num>p include an SV with precision <num>
8729 %<num>p reserved for future extensions
8731 Robin Barker 2005-07-14
8733 %1p (VDf) removed. RMB 2007-10-19
8740 n = expect_number(&q);
8747 argsv = (SV*)va_arg(*args, void*);
8748 eptr = SvPV_const(argsv, elen);
8754 if (ckWARN_d(WARN_INTERNAL))
8755 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8756 "internal %%<num>p might conflict with future printf extensions");
8762 if ( (width = expect_number(&q)) ) {
8777 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8806 if ( (ewix = expect_number(&q)) )
8815 if ((vectorarg = asterisk)) {
8828 width = expect_number(&q);
8834 vecsv = va_arg(*args, SV*);
8836 vecsv = (evix > 0 && evix <= svmax)
8837 ? svargs[evix-1] : &PL_sv_undef;
8839 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8841 dotstr = SvPV_const(vecsv, dotstrlen);
8842 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8843 bad with tied or overloaded values that return UTF8. */
8846 else if (has_utf8) {
8847 vecsv = sv_mortalcopy(vecsv);
8848 sv_utf8_upgrade(vecsv);
8849 dotstr = SvPV_const(vecsv, dotstrlen);
8856 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8857 vecsv = svargs[efix ? efix-1 : svix++];
8858 vecstr = (U8*)SvPV_const(vecsv,veclen);
8859 vec_utf8 = DO_UTF8(vecsv);
8861 /* if this is a version object, we need to convert
8862 * back into v-string notation and then let the
8863 * vectorize happen normally
8865 if (sv_derived_from(vecsv, "version")) {
8866 char *version = savesvpv(vecsv);
8867 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8868 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8869 "vector argument not supported with alpha versions");
8872 vecsv = sv_newmortal();
8873 scan_vstring(version, version + veclen, vecsv);
8874 vecstr = (U8*)SvPV_const(vecsv, veclen);
8875 vec_utf8 = DO_UTF8(vecsv);
8887 i = va_arg(*args, int);
8889 i = (ewix ? ewix <= svmax : svix < svmax) ?
8890 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8892 width = (i < 0) ? -i : i;
8902 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8904 /* XXX: todo, support specified precision parameter */
8908 i = va_arg(*args, int);
8910 i = (ewix ? ewix <= svmax : svix < svmax)
8911 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8913 has_precis = !(i < 0);
8918 precis = precis * 10 + (*q++ - '0');
8927 case 'I': /* Ix, I32x, and I64x */
8929 if (q[1] == '6' && q[2] == '4') {
8935 if (q[1] == '3' && q[2] == '2') {
8945 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8956 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8957 if (*(q + 1) == 'l') { /* lld, llf */
8983 if (!vectorize && !args) {
8985 const I32 i = efix-1;
8986 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8988 argsv = (svix >= 0 && svix < svmax)
8989 ? svargs[svix++] : &PL_sv_undef;
9000 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9002 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9004 eptr = (char*)utf8buf;
9005 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9019 eptr = va_arg(*args, char*);
9021 #ifdef MACOS_TRADITIONAL
9022 /* On MacOS, %#s format is used for Pascal strings */
9027 elen = strlen(eptr);
9029 eptr = (char *)nullstr;
9030 elen = sizeof nullstr - 1;
9034 eptr = SvPV_const(argsv, elen);
9035 if (DO_UTF8(argsv)) {
9036 I32 old_precis = precis;
9037 if (has_precis && precis < elen) {
9039 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9042 if (width) { /* fudge width (can't fudge elen) */
9043 if (has_precis && precis < elen)
9044 width += precis - old_precis;
9046 width += elen - sv_len_utf8(argsv);
9053 if (has_precis && elen > precis)
9060 if (alt || vectorize)
9062 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9083 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9092 esignbuf[esignlen++] = plus;
9096 case 'h': iv = (short)va_arg(*args, int); break;
9097 case 'l': iv = va_arg(*args, long); break;
9098 case 'V': iv = va_arg(*args, IV); break;
9099 default: iv = va_arg(*args, int); break;
9101 case 'q': iv = va_arg(*args, Quad_t); break;
9106 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9108 case 'h': iv = (short)tiv; break;
9109 case 'l': iv = (long)tiv; break;
9111 default: iv = tiv; break;
9113 case 'q': iv = (Quad_t)tiv; break;
9117 if ( !vectorize ) /* we already set uv above */
9122 esignbuf[esignlen++] = plus;
9126 esignbuf[esignlen++] = '-';
9170 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9181 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9182 case 'l': uv = va_arg(*args, unsigned long); break;
9183 case 'V': uv = va_arg(*args, UV); break;
9184 default: uv = va_arg(*args, unsigned); break;
9186 case 'q': uv = va_arg(*args, Uquad_t); break;
9191 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9193 case 'h': uv = (unsigned short)tuv; break;
9194 case 'l': uv = (unsigned long)tuv; break;
9196 default: uv = tuv; break;
9198 case 'q': uv = (Uquad_t)tuv; break;
9205 char *ptr = ebuf + sizeof ebuf;
9206 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9212 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9218 esignbuf[esignlen++] = '0';
9219 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9227 if (alt && *ptr != '0')
9236 esignbuf[esignlen++] = '0';
9237 esignbuf[esignlen++] = c;
9240 default: /* it had better be ten or less */
9244 } while (uv /= base);
9247 elen = (ebuf + sizeof ebuf) - ptr;
9251 zeros = precis - elen;
9252 else if (precis == 0 && elen == 1 && *eptr == '0'
9253 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9256 /* a precision nullifies the 0 flag. */
9263 /* FLOATING POINT */
9266 c = 'f'; /* maybe %F isn't supported here */
9274 /* This is evil, but floating point is even more evil */
9276 /* for SV-style calling, we can only get NV
9277 for C-style calling, we assume %f is double;
9278 for simplicity we allow any of %Lf, %llf, %qf for long double
9282 #if defined(USE_LONG_DOUBLE)
9286 /* [perl #20339] - we should accept and ignore %lf rather than die */
9290 #if defined(USE_LONG_DOUBLE)
9291 intsize = args ? 0 : 'q';
9295 #if defined(HAS_LONG_DOUBLE)
9304 /* now we need (long double) if intsize == 'q', else (double) */
9306 #if LONG_DOUBLESIZE > DOUBLESIZE
9308 va_arg(*args, long double) :
9309 va_arg(*args, double)
9311 va_arg(*args, double)
9316 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9317 else. frexp() has some unspecified behaviour for those three */
9318 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9320 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9321 will cast our (long double) to (double) */
9322 (void)Perl_frexp(nv, &i);
9323 if (i == PERL_INT_MIN)
9324 Perl_die(aTHX_ "panic: frexp");
9326 need = BIT_DIGITS(i);
9328 need += has_precis ? precis : 6; /* known default */
9333 #ifdef HAS_LDBL_SPRINTF_BUG
9334 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9335 with sfio - Allen <allens@cpan.org> */
9338 # define MY_DBL_MAX DBL_MAX
9339 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9340 # if DOUBLESIZE >= 8
9341 # define MY_DBL_MAX 1.7976931348623157E+308L
9343 # define MY_DBL_MAX 3.40282347E+38L
9347 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9348 # define MY_DBL_MAX_BUG 1L
9350 # define MY_DBL_MAX_BUG MY_DBL_MAX
9354 # define MY_DBL_MIN DBL_MIN
9355 # else /* XXX guessing! -Allen */
9356 # if DOUBLESIZE >= 8
9357 # define MY_DBL_MIN 2.2250738585072014E-308L
9359 # define MY_DBL_MIN 1.17549435E-38L
9363 if ((intsize == 'q') && (c == 'f') &&
9364 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9366 /* it's going to be short enough that
9367 * long double precision is not needed */
9369 if ((nv <= 0L) && (nv >= -0L))
9370 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9372 /* would use Perl_fp_class as a double-check but not
9373 * functional on IRIX - see perl.h comments */
9375 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9376 /* It's within the range that a double can represent */
9377 #if defined(DBL_MAX) && !defined(DBL_MIN)
9378 if ((nv >= ((long double)1/DBL_MAX)) ||
9379 (nv <= (-(long double)1/DBL_MAX)))
9381 fix_ldbl_sprintf_bug = TRUE;
9384 if (fix_ldbl_sprintf_bug == TRUE) {
9394 # undef MY_DBL_MAX_BUG
9397 #endif /* HAS_LDBL_SPRINTF_BUG */
9399 need += 20; /* fudge factor */
9400 if (PL_efloatsize < need) {
9401 Safefree(PL_efloatbuf);
9402 PL_efloatsize = need + 20; /* more fudge */
9403 Newx(PL_efloatbuf, PL_efloatsize, char);
9404 PL_efloatbuf[0] = '\0';
9407 if ( !(width || left || plus || alt) && fill != '0'
9408 && has_precis && intsize != 'q' ) { /* Shortcuts */
9409 /* See earlier comment about buggy Gconvert when digits,
9411 if ( c == 'g' && precis) {
9412 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9413 /* May return an empty string for digits==0 */
9414 if (*PL_efloatbuf) {
9415 elen = strlen(PL_efloatbuf);
9416 goto float_converted;
9418 } else if ( c == 'f' && !precis) {
9419 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9424 char *ptr = ebuf + sizeof ebuf;
9427 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9428 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9429 if (intsize == 'q') {
9430 /* Copy the one or more characters in a long double
9431 * format before the 'base' ([efgEFG]) character to
9432 * the format string. */
9433 static char const prifldbl[] = PERL_PRIfldbl;
9434 char const *p = prifldbl + sizeof(prifldbl) - 3;
9435 while (p >= prifldbl) { *--ptr = *p--; }
9440 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9445 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9457 /* No taint. Otherwise we are in the strange situation
9458 * where printf() taints but print($float) doesn't.
9460 #if defined(HAS_LONG_DOUBLE)
9461 elen = ((intsize == 'q')
9462 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9463 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9465 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9469 eptr = PL_efloatbuf;
9477 i = SvCUR(sv) - origlen;
9480 case 'h': *(va_arg(*args, short*)) = i; break;
9481 default: *(va_arg(*args, int*)) = i; break;
9482 case 'l': *(va_arg(*args, long*)) = i; break;
9483 case 'V': *(va_arg(*args, IV*)) = i; break;
9485 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9490 sv_setuv_mg(argsv, (UV)i);
9491 continue; /* not "break" */
9498 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9499 && ckWARN(WARN_PRINTF))
9501 SV * const msg = sv_newmortal();
9502 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9503 (PL_op->op_type == OP_PRTF) ? "" : "s");
9506 Perl_sv_catpvf(aTHX_ msg,
9507 "\"%%%c\"", c & 0xFF);
9509 Perl_sv_catpvf(aTHX_ msg,
9510 "\"%%\\%03"UVof"\"",
9513 sv_catpvs(msg, "end of string");
9514 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9517 /* output mangled stuff ... */
9523 /* ... right here, because formatting flags should not apply */
9524 SvGROW(sv, SvCUR(sv) + elen + 1);
9526 Copy(eptr, p, elen, char);
9529 SvCUR_set(sv, p - SvPVX_const(sv));
9531 continue; /* not "break" */
9534 if (is_utf8 != has_utf8) {
9537 sv_utf8_upgrade(sv);
9540 const STRLEN old_elen = elen;
9541 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9542 sv_utf8_upgrade(nsv);
9543 eptr = SvPVX_const(nsv);
9546 if (width) { /* fudge width (can't fudge elen) */
9547 width += elen - old_elen;
9553 have = esignlen + zeros + elen;
9555 Perl_croak_nocontext(PL_memory_wrap);
9557 need = (have > width ? have : width);
9560 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9561 Perl_croak_nocontext(PL_memory_wrap);
9562 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9564 if (esignlen && fill == '0') {
9566 for (i = 0; i < (int)esignlen; i++)
9570 memset(p, fill, gap);
9573 if (esignlen && fill != '0') {
9575 for (i = 0; i < (int)esignlen; i++)
9580 for (i = zeros; i; i--)
9584 Copy(eptr, p, elen, char);
9588 memset(p, ' ', gap);
9593 Copy(dotstr, p, dotstrlen, char);
9597 vectorize = FALSE; /* done iterating over vecstr */
9604 SvCUR_set(sv, p - SvPVX_const(sv));
9612 /* =========================================================================
9614 =head1 Cloning an interpreter
9616 All the macros and functions in this section are for the private use of
9617 the main function, perl_clone().
9619 The foo_dup() functions make an exact copy of an existing foo thingy.
9620 During the course of a cloning, a hash table is used to map old addresses
9621 to new addresses. The table is created and manipulated with the
9622 ptr_table_* functions.
9626 ============================================================================*/
9629 #if defined(USE_ITHREADS)
9631 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9632 #ifndef GpREFCNT_inc
9633 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9637 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9638 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9639 If this changes, please unmerge ss_dup. */
9640 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9641 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9642 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9643 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9644 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9645 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9646 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9647 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9648 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9649 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9650 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9651 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9652 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9653 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9655 /* clone a parser */
9658 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9665 /* look for it in the table first */
9666 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9670 /* create anew and remember what it is */
9671 Newxz(parser, 1, yy_parser);
9672 ptr_table_store(PL_ptr_table, proto, parser);
9674 parser->yyerrstatus = 0;
9675 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9677 /* XXX these not yet duped */
9678 parser->old_parser = NULL;
9679 parser->stack = NULL;
9681 parser->stack_size = 0;
9682 /* XXX parser->stack->state = 0; */
9684 /* XXX eventually, just Copy() most of the parser struct ? */
9686 parser->lex_brackets = proto->lex_brackets;
9687 parser->lex_casemods = proto->lex_casemods;
9688 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9689 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9690 parser->lex_casestack = savepvn(proto->lex_casestack,
9691 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9692 parser->lex_defer = proto->lex_defer;
9693 parser->lex_dojoin = proto->lex_dojoin;
9694 parser->lex_expect = proto->lex_expect;
9695 parser->lex_formbrack = proto->lex_formbrack;
9696 parser->lex_inpat = proto->lex_inpat;
9697 parser->lex_inwhat = proto->lex_inwhat;
9698 parser->lex_op = proto->lex_op;
9699 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9700 parser->lex_starts = proto->lex_starts;
9701 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9702 parser->multi_close = proto->multi_close;
9703 parser->multi_open = proto->multi_open;
9704 parser->multi_start = proto->multi_start;
9705 parser->multi_end = proto->multi_end;
9706 parser->pending_ident = proto->pending_ident;
9707 parser->preambled = proto->preambled;
9708 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9709 parser->linestr = sv_dup_inc(proto->linestr, param);
9710 parser->expect = proto->expect;
9711 parser->copline = proto->copline;
9712 parser->last_lop_op = proto->last_lop_op;
9713 parser->lex_state = proto->lex_state;
9714 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9715 /* rsfp_filters entries have fake IoDIRP() */
9716 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9717 parser->in_my = proto->in_my;
9718 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9719 parser->error_count = proto->error_count;
9722 parser->linestr = sv_dup_inc(proto->linestr, param);
9725 char * const ols = SvPVX(proto->linestr);
9726 char * const ls = SvPVX(parser->linestr);
9728 parser->bufptr = ls + (proto->bufptr >= ols ?
9729 proto->bufptr - ols : 0);
9730 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9731 proto->oldbufptr - ols : 0);
9732 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9733 proto->oldoldbufptr - ols : 0);
9734 parser->linestart = ls + (proto->linestart >= ols ?
9735 proto->linestart - ols : 0);
9736 parser->last_uni = ls + (proto->last_uni >= ols ?
9737 proto->last_uni - ols : 0);
9738 parser->last_lop = ls + (proto->last_lop >= ols ?
9739 proto->last_lop - ols : 0);
9741 parser->bufend = ls + SvCUR(parser->linestr);
9744 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9748 parser->endwhite = proto->endwhite;
9749 parser->faketokens = proto->faketokens;
9750 parser->lasttoke = proto->lasttoke;
9751 parser->nextwhite = proto->nextwhite;
9752 parser->realtokenstart = proto->realtokenstart;
9753 parser->skipwhite = proto->skipwhite;
9754 parser->thisclose = proto->thisclose;
9755 parser->thismad = proto->thismad;
9756 parser->thisopen = proto->thisopen;
9757 parser->thisstuff = proto->thisstuff;
9758 parser->thistoken = proto->thistoken;
9759 parser->thiswhite = proto->thiswhite;
9761 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9762 parser->curforce = proto->curforce;
9764 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9765 Copy(proto->nexttype, parser->nexttype, 5, I32);
9766 parser->nexttoke = proto->nexttoke;
9772 /* duplicate a file handle */
9775 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9779 PERL_UNUSED_ARG(type);
9782 return (PerlIO*)NULL;
9784 /* look for it in the table first */
9785 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9789 /* create anew and remember what it is */
9790 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9791 ptr_table_store(PL_ptr_table, fp, ret);
9795 /* duplicate a directory handle */
9798 Perl_dirp_dup(pTHX_ DIR *dp)
9800 PERL_UNUSED_CONTEXT;
9807 /* duplicate a typeglob */
9810 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9816 /* look for it in the table first */
9817 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9821 /* create anew and remember what it is */
9823 ptr_table_store(PL_ptr_table, gp, ret);
9826 ret->gp_refcnt = 0; /* must be before any other dups! */
9827 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9828 ret->gp_io = io_dup_inc(gp->gp_io, param);
9829 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9830 ret->gp_av = av_dup_inc(gp->gp_av, param);
9831 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9832 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9833 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9834 ret->gp_cvgen = gp->gp_cvgen;
9835 ret->gp_line = gp->gp_line;
9836 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9840 /* duplicate a chain of magic */
9843 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9845 MAGIC *mgprev = (MAGIC*)NULL;
9848 return (MAGIC*)NULL;
9849 /* look for it in the table first */
9850 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9854 for (; mg; mg = mg->mg_moremagic) {
9856 Newxz(nmg, 1, MAGIC);
9858 mgprev->mg_moremagic = nmg;
9861 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9862 nmg->mg_private = mg->mg_private;
9863 nmg->mg_type = mg->mg_type;
9864 nmg->mg_flags = mg->mg_flags;
9865 /* FIXME for plugins
9866 if (mg->mg_type == PERL_MAGIC_qr) {
9867 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9871 if(mg->mg_type == PERL_MAGIC_backref) {
9872 /* The backref AV has its reference count deliberately bumped by
9874 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9877 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9878 ? sv_dup_inc(mg->mg_obj, param)
9879 : sv_dup(mg->mg_obj, param);
9881 nmg->mg_len = mg->mg_len;
9882 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9883 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9884 if (mg->mg_len > 0) {
9885 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9886 if (mg->mg_type == PERL_MAGIC_overload_table &&
9887 AMT_AMAGIC((AMT*)mg->mg_ptr))
9889 const AMT * const amtp = (AMT*)mg->mg_ptr;
9890 AMT * const namtp = (AMT*)nmg->mg_ptr;
9892 for (i = 1; i < NofAMmeth; i++) {
9893 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9897 else if (mg->mg_len == HEf_SVKEY)
9898 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9900 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9901 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9908 #endif /* USE_ITHREADS */
9910 /* create a new pointer-mapping table */
9913 Perl_ptr_table_new(pTHX)
9916 PERL_UNUSED_CONTEXT;
9918 Newxz(tbl, 1, PTR_TBL_t);
9921 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9925 #define PTR_TABLE_HASH(ptr) \
9926 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9929 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9930 following define) and at call to new_body_inline made below in
9931 Perl_ptr_table_store()
9934 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9936 /* map an existing pointer using a table */
9938 STATIC PTR_TBL_ENT_t *
9939 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9940 PTR_TBL_ENT_t *tblent;
9941 const UV hash = PTR_TABLE_HASH(sv);
9943 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9944 for (; tblent; tblent = tblent->next) {
9945 if (tblent->oldval == sv)
9952 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9954 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9955 PERL_UNUSED_CONTEXT;
9956 return tblent ? tblent->newval : NULL;
9959 /* add a new entry to a pointer-mapping table */
9962 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9964 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9965 PERL_UNUSED_CONTEXT;
9968 tblent->newval = newsv;
9970 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9972 new_body_inline(tblent, PTE_SVSLOT);
9974 tblent->oldval = oldsv;
9975 tblent->newval = newsv;
9976 tblent->next = tbl->tbl_ary[entry];
9977 tbl->tbl_ary[entry] = tblent;
9979 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9980 ptr_table_split(tbl);
9984 /* double the hash bucket size of an existing ptr table */
9987 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9989 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9990 const UV oldsize = tbl->tbl_max + 1;
9991 UV newsize = oldsize * 2;
9993 PERL_UNUSED_CONTEXT;
9995 Renew(ary, newsize, PTR_TBL_ENT_t*);
9996 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9997 tbl->tbl_max = --newsize;
9999 for (i=0; i < oldsize; i++, ary++) {
10000 PTR_TBL_ENT_t **curentp, **entp, *ent;
10003 curentp = ary + oldsize;
10004 for (entp = ary, ent = *ary; ent; ent = *entp) {
10005 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10007 ent->next = *curentp;
10017 /* remove all the entries from a ptr table */
10020 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10022 if (tbl && tbl->tbl_items) {
10023 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10024 UV riter = tbl->tbl_max;
10027 PTR_TBL_ENT_t *entry = array[riter];
10030 PTR_TBL_ENT_t * const oentry = entry;
10031 entry = entry->next;
10036 tbl->tbl_items = 0;
10040 /* clear and free a ptr table */
10043 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10048 ptr_table_clear(tbl);
10049 Safefree(tbl->tbl_ary);
10053 #if defined(USE_ITHREADS)
10056 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10059 SvRV_set(dstr, SvWEAKREF(sstr)
10060 ? sv_dup(SvRV(sstr), param)
10061 : sv_dup_inc(SvRV(sstr), param));
10064 else if (SvPVX_const(sstr)) {
10065 /* Has something there */
10067 /* Normal PV - clone whole allocated space */
10068 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10069 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10070 /* Not that normal - actually sstr is copy on write.
10071 But we are a true, independant SV, so: */
10072 SvREADONLY_off(dstr);
10077 /* Special case - not normally malloced for some reason */
10078 if (isGV_with_GP(sstr)) {
10079 /* Don't need to do anything here. */
10081 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10082 /* A "shared" PV - clone it as "shared" PV */
10084 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10088 /* Some other special case - random pointer */
10089 SvPV_set(dstr, SvPVX(sstr));
10094 /* Copy the NULL */
10095 SvPV_set(dstr, NULL);
10099 /* duplicate an SV of any type (including AV, HV etc) */
10102 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10107 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10109 /* look for it in the table first */
10110 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10114 if(param->flags & CLONEf_JOIN_IN) {
10115 /** We are joining here so we don't want do clone
10116 something that is bad **/
10117 if (SvTYPE(sstr) == SVt_PVHV) {
10118 const HEK * const hvname = HvNAME_HEK(sstr);
10120 /** don't clone stashes if they already exist **/
10121 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10125 /* create anew and remember what it is */
10128 #ifdef DEBUG_LEAKING_SCALARS
10129 dstr->sv_debug_optype = sstr->sv_debug_optype;
10130 dstr->sv_debug_line = sstr->sv_debug_line;
10131 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10132 dstr->sv_debug_cloned = 1;
10133 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10136 ptr_table_store(PL_ptr_table, sstr, dstr);
10139 SvFLAGS(dstr) = SvFLAGS(sstr);
10140 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10141 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10144 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10145 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10146 (void*)PL_watch_pvx, SvPVX_const(sstr));
10149 /* don't clone objects whose class has asked us not to */
10150 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10155 switch (SvTYPE(sstr)) {
10157 SvANY(dstr) = NULL;
10160 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10162 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10164 SvIV_set(dstr, SvIVX(sstr));
10168 SvANY(dstr) = new_XNV();
10169 SvNV_set(dstr, SvNVX(sstr));
10171 /* case SVt_BIND: */
10174 /* These are all the types that need complex bodies allocating. */
10176 const svtype sv_type = SvTYPE(sstr);
10177 const struct body_details *const sv_type_details
10178 = bodies_by_type + sv_type;
10182 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10186 if (GvUNIQUE((GV*)sstr)) {
10187 NOOP; /* Do sharing here, and fall through */
10200 assert(sv_type_details->body_size);
10201 if (sv_type_details->arena) {
10202 new_body_inline(new_body, sv_type);
10204 = (void*)((char*)new_body - sv_type_details->offset);
10206 new_body = new_NOARENA(sv_type_details);
10210 SvANY(dstr) = new_body;
10213 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10214 ((char*)SvANY(dstr)) + sv_type_details->offset,
10215 sv_type_details->copy, char);
10217 Copy(((char*)SvANY(sstr)),
10218 ((char*)SvANY(dstr)),
10219 sv_type_details->body_size + sv_type_details->offset, char);
10222 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10223 && !isGV_with_GP(dstr))
10224 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10226 /* The Copy above means that all the source (unduplicated) pointers
10227 are now in the destination. We can check the flags and the
10228 pointers in either, but it's possible that there's less cache
10229 missing by always going for the destination.
10230 FIXME - instrument and check that assumption */
10231 if (sv_type >= SVt_PVMG) {
10232 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10233 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10234 } else if (SvMAGIC(dstr))
10235 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10237 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10240 /* The cast silences a GCC warning about unhandled types. */
10241 switch ((int)sv_type) {
10251 /* FIXME for plugins */
10252 re_dup_guts(sstr, dstr, param);
10255 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10256 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10257 LvTARG(dstr) = dstr;
10258 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10259 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10261 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10263 if(isGV_with_GP(sstr)) {
10264 if (GvNAME_HEK(dstr))
10265 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10266 /* Don't call sv_add_backref here as it's going to be
10267 created as part of the magic cloning of the symbol
10269 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10270 at the point of this comment. */
10271 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10272 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10273 (void)GpREFCNT_inc(GvGP(dstr));
10275 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10278 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10279 if (IoOFP(dstr) == IoIFP(sstr))
10280 IoOFP(dstr) = IoIFP(dstr);
10282 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10283 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10284 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10285 /* I have no idea why fake dirp (rsfps)
10286 should be treated differently but otherwise
10287 we end up with leaks -- sky*/
10288 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10289 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10290 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10292 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10293 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10294 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10295 if (IoDIRP(dstr)) {
10296 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10299 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10302 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10303 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10304 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10307 if (AvARRAY((AV*)sstr)) {
10308 SV **dst_ary, **src_ary;
10309 SSize_t items = AvFILLp((AV*)sstr) + 1;
10311 src_ary = AvARRAY((AV*)sstr);
10312 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10313 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10314 AvARRAY((AV*)dstr) = dst_ary;
10315 AvALLOC((AV*)dstr) = dst_ary;
10316 if (AvREAL((AV*)sstr)) {
10317 while (items-- > 0)
10318 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10321 while (items-- > 0)
10322 *dst_ary++ = sv_dup(*src_ary++, param);
10324 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10325 while (items-- > 0) {
10326 *dst_ary++ = &PL_sv_undef;
10330 AvARRAY((AV*)dstr) = NULL;
10331 AvALLOC((AV*)dstr) = (SV**)NULL;
10335 if (HvARRAY((HV*)sstr)) {
10337 const bool sharekeys = !!HvSHAREKEYS(sstr);
10338 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10339 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10341 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10342 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10344 HvARRAY(dstr) = (HE**)darray;
10345 while (i <= sxhv->xhv_max) {
10346 const HE * const source = HvARRAY(sstr)[i];
10347 HvARRAY(dstr)[i] = source
10348 ? he_dup(source, sharekeys, param) : 0;
10353 const struct xpvhv_aux * const saux = HvAUX(sstr);
10354 struct xpvhv_aux * const daux = HvAUX(dstr);
10355 /* This flag isn't copied. */
10356 /* SvOOK_on(hv) attacks the IV flags. */
10357 SvFLAGS(dstr) |= SVf_OOK;
10359 hvname = saux->xhv_name;
10360 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10362 daux->xhv_riter = saux->xhv_riter;
10363 daux->xhv_eiter = saux->xhv_eiter
10364 ? he_dup(saux->xhv_eiter,
10365 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10366 daux->xhv_backreferences =
10367 saux->xhv_backreferences
10368 ? (AV*) SvREFCNT_inc(
10369 sv_dup((SV*)saux->xhv_backreferences, param))
10372 daux->xhv_mro_meta = saux->xhv_mro_meta
10373 ? mro_meta_dup(saux->xhv_mro_meta, param)
10376 /* Record stashes for possible cloning in Perl_clone(). */
10378 av_push(param->stashes, dstr);
10382 HvARRAY((HV*)dstr) = NULL;
10385 if (!(param->flags & CLONEf_COPY_STACKS)) {
10389 /* NOTE: not refcounted */
10390 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10392 if (!CvISXSUB(dstr))
10393 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10395 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10396 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10397 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10398 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10400 /* don't dup if copying back - CvGV isn't refcounted, so the
10401 * duped GV may never be freed. A bit of a hack! DAPM */
10402 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10403 NULL : gv_dup(CvGV(dstr), param) ;
10404 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10406 CvWEAKOUTSIDE(sstr)
10407 ? cv_dup( CvOUTSIDE(dstr), param)
10408 : cv_dup_inc(CvOUTSIDE(dstr), param);
10409 if (!CvISXSUB(dstr))
10410 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10416 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10422 /* duplicate a context */
10425 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10427 PERL_CONTEXT *ncxs;
10430 return (PERL_CONTEXT*)NULL;
10432 /* look for it in the table first */
10433 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10437 /* create anew and remember what it is */
10438 Newxz(ncxs, max + 1, PERL_CONTEXT);
10439 ptr_table_store(PL_ptr_table, cxs, ncxs);
10442 PERL_CONTEXT * const cx = &cxs[ix];
10443 PERL_CONTEXT * const ncx = &ncxs[ix];
10444 ncx->cx_type = cx->cx_type;
10445 if (CxTYPE(cx) == CXt_SUBST) {
10446 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10449 ncx->blk_oldsp = cx->blk_oldsp;
10450 ncx->blk_oldcop = cx->blk_oldcop;
10451 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10452 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10453 ncx->blk_oldpm = cx->blk_oldpm;
10454 ncx->blk_gimme = cx->blk_gimme;
10455 switch (CxTYPE(cx)) {
10457 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10458 ? cv_dup_inc(cx->blk_sub.cv, param)
10459 : cv_dup(cx->blk_sub.cv,param));
10460 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10461 ? av_dup_inc(cx->blk_sub.argarray, param)
10463 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10464 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10465 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10466 ncx->blk_sub.lval = cx->blk_sub.lval;
10467 ncx->blk_sub.retop = cx->blk_sub.retop;
10468 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10469 cx->blk_sub.oldcomppad);
10472 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10473 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10474 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10475 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10476 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10477 ncx->blk_eval.retop = cx->blk_eval.retop;
10480 ncx->blk_loop.label = cx->blk_loop.label;
10481 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10482 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10483 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10484 ? cx->blk_loop.iterdata
10485 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10486 ncx->blk_loop.oldcomppad
10487 = (PAD*)ptr_table_fetch(PL_ptr_table,
10488 cx->blk_loop.oldcomppad);
10489 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10490 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10491 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10492 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10493 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10496 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10497 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10498 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10499 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10500 ncx->blk_sub.retop = cx->blk_sub.retop;
10512 /* duplicate a stack info structure */
10515 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10520 return (PERL_SI*)NULL;
10522 /* look for it in the table first */
10523 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10527 /* create anew and remember what it is */
10528 Newxz(nsi, 1, PERL_SI);
10529 ptr_table_store(PL_ptr_table, si, nsi);
10531 nsi->si_stack = av_dup_inc(si->si_stack, param);
10532 nsi->si_cxix = si->si_cxix;
10533 nsi->si_cxmax = si->si_cxmax;
10534 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10535 nsi->si_type = si->si_type;
10536 nsi->si_prev = si_dup(si->si_prev, param);
10537 nsi->si_next = si_dup(si->si_next, param);
10538 nsi->si_markoff = si->si_markoff;
10543 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10544 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10545 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10546 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10547 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10548 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10549 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10550 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10551 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10552 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10553 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10554 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10555 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10556 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10559 #define pv_dup_inc(p) SAVEPV(p)
10560 #define pv_dup(p) SAVEPV(p)
10561 #define svp_dup_inc(p,pp) any_dup(p,pp)
10563 /* map any object to the new equivent - either something in the
10564 * ptr table, or something in the interpreter structure
10568 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10573 return (void*)NULL;
10575 /* look for it in the table first */
10576 ret = ptr_table_fetch(PL_ptr_table, v);
10580 /* see if it is part of the interpreter structure */
10581 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10582 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10590 /* duplicate the save stack */
10593 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10596 ANY * const ss = proto_perl->Isavestack;
10597 const I32 max = proto_perl->Isavestack_max;
10598 I32 ix = proto_perl->Isavestack_ix;
10611 void (*dptr) (void*);
10612 void (*dxptr) (pTHX_ void*);
10614 Newxz(nss, max, ANY);
10617 const I32 type = POPINT(ss,ix);
10618 TOPINT(nss,ix) = type;
10620 case SAVEt_HELEM: /* hash element */
10621 sv = (SV*)POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10624 case SAVEt_ITEM: /* normal string */
10625 case SAVEt_SV: /* scalar reference */
10626 sv = (SV*)POPPTR(ss,ix);
10627 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10630 case SAVEt_MORTALIZESV:
10631 sv = (SV*)POPPTR(ss,ix);
10632 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10634 case SAVEt_SHARED_PVREF: /* char* in shared space */
10635 c = (char*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = savesharedpv(c);
10637 ptr = POPPTR(ss,ix);
10638 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10640 case SAVEt_GENERIC_SVREF: /* generic sv */
10641 case SAVEt_SVREF: /* scalar reference */
10642 sv = (SV*)POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10644 ptr = POPPTR(ss,ix);
10645 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10647 case SAVEt_HV: /* hash reference */
10648 case SAVEt_AV: /* array reference */
10649 sv = (SV*) POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10652 case SAVEt_COMPPAD:
10654 sv = (SV*) POPPTR(ss,ix);
10655 TOPPTR(nss,ix) = sv_dup(sv, param);
10657 case SAVEt_INT: /* int reference */
10658 ptr = POPPTR(ss,ix);
10659 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10660 intval = (int)POPINT(ss,ix);
10661 TOPINT(nss,ix) = intval;
10663 case SAVEt_LONG: /* long reference */
10664 ptr = POPPTR(ss,ix);
10665 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10667 case SAVEt_CLEARSV:
10668 longval = (long)POPLONG(ss,ix);
10669 TOPLONG(nss,ix) = longval;
10671 case SAVEt_I32: /* I32 reference */
10672 case SAVEt_I16: /* I16 reference */
10673 case SAVEt_I8: /* I8 reference */
10674 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10675 ptr = POPPTR(ss,ix);
10676 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10678 TOPINT(nss,ix) = i;
10680 case SAVEt_IV: /* IV reference */
10681 ptr = POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10684 TOPIV(nss,ix) = iv;
10686 case SAVEt_HPTR: /* HV* reference */
10687 case SAVEt_APTR: /* AV* reference */
10688 case SAVEt_SPTR: /* SV* reference */
10689 ptr = POPPTR(ss,ix);
10690 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10691 sv = (SV*)POPPTR(ss,ix);
10692 TOPPTR(nss,ix) = sv_dup(sv, param);
10694 case SAVEt_VPTR: /* random* reference */
10695 ptr = POPPTR(ss,ix);
10696 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10697 ptr = POPPTR(ss,ix);
10698 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10700 case SAVEt_GENERIC_PVREF: /* generic char* */
10701 case SAVEt_PPTR: /* char* reference */
10702 ptr = POPPTR(ss,ix);
10703 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10704 c = (char*)POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = pv_dup(c);
10707 case SAVEt_GP: /* scalar reference */
10708 gp = (GP*)POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10710 (void)GpREFCNT_inc(gp);
10711 gv = (GV*)POPPTR(ss,ix);
10712 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10715 ptr = POPPTR(ss,ix);
10716 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10717 /* these are assumed to be refcounted properly */
10719 switch (((OP*)ptr)->op_type) {
10721 case OP_LEAVESUBLV:
10725 case OP_LEAVEWRITE:
10726 TOPPTR(nss,ix) = ptr;
10729 (void) OpREFCNT_inc(o);
10733 TOPPTR(nss,ix) = NULL;
10738 TOPPTR(nss,ix) = NULL;
10741 c = (char*)POPPTR(ss,ix);
10742 TOPPTR(nss,ix) = pv_dup_inc(c);
10745 hv = (HV*)POPPTR(ss,ix);
10746 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10747 c = (char*)POPPTR(ss,ix);
10748 TOPPTR(nss,ix) = pv_dup_inc(c);
10750 case SAVEt_STACK_POS: /* Position on Perl stack */
10752 TOPINT(nss,ix) = i;
10754 case SAVEt_DESTRUCTOR:
10755 ptr = POPPTR(ss,ix);
10756 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10757 dptr = POPDPTR(ss,ix);
10758 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10759 any_dup(FPTR2DPTR(void *, dptr),
10762 case SAVEt_DESTRUCTOR_X:
10763 ptr = POPPTR(ss,ix);
10764 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10765 dxptr = POPDXPTR(ss,ix);
10766 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10767 any_dup(FPTR2DPTR(void *, dxptr),
10770 case SAVEt_REGCONTEXT:
10773 TOPINT(nss,ix) = i;
10776 case SAVEt_AELEM: /* array element */
10777 sv = (SV*)POPPTR(ss,ix);
10778 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10780 TOPINT(nss,ix) = i;
10781 av = (AV*)POPPTR(ss,ix);
10782 TOPPTR(nss,ix) = av_dup_inc(av, param);
10785 ptr = POPPTR(ss,ix);
10786 TOPPTR(nss,ix) = ptr;
10790 TOPINT(nss,ix) = i;
10791 ptr = POPPTR(ss,ix);
10794 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10795 HINTS_REFCNT_UNLOCK;
10797 TOPPTR(nss,ix) = ptr;
10798 if (i & HINT_LOCALIZE_HH) {
10799 hv = (HV*)POPPTR(ss,ix);
10800 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10804 longval = (long)POPLONG(ss,ix);
10805 TOPLONG(nss,ix) = longval;
10806 ptr = POPPTR(ss,ix);
10807 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10808 sv = (SV*)POPPTR(ss,ix);
10809 TOPPTR(nss,ix) = sv_dup(sv, param);
10812 ptr = POPPTR(ss,ix);
10813 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10814 longval = (long)POPBOOL(ss,ix);
10815 TOPBOOL(nss,ix) = (bool)longval;
10817 case SAVEt_SET_SVFLAGS:
10819 TOPINT(nss,ix) = i;
10821 TOPINT(nss,ix) = i;
10822 sv = (SV*)POPPTR(ss,ix);
10823 TOPPTR(nss,ix) = sv_dup(sv, param);
10825 case SAVEt_RE_STATE:
10827 const struct re_save_state *const old_state
10828 = (struct re_save_state *)
10829 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10830 struct re_save_state *const new_state
10831 = (struct re_save_state *)
10832 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10834 Copy(old_state, new_state, 1, struct re_save_state);
10835 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10837 new_state->re_state_bostr
10838 = pv_dup(old_state->re_state_bostr);
10839 new_state->re_state_reginput
10840 = pv_dup(old_state->re_state_reginput);
10841 new_state->re_state_regeol
10842 = pv_dup(old_state->re_state_regeol);
10843 new_state->re_state_regoffs
10844 = (regexp_paren_pair*)
10845 any_dup(old_state->re_state_regoffs, proto_perl);
10846 new_state->re_state_reglastparen
10847 = (U32*) any_dup(old_state->re_state_reglastparen,
10849 new_state->re_state_reglastcloseparen
10850 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10852 /* XXX This just has to be broken. The old save_re_context
10853 code did SAVEGENERICPV(PL_reg_start_tmp);
10854 PL_reg_start_tmp is char **.
10855 Look above to what the dup code does for
10856 SAVEt_GENERIC_PVREF
10857 It can never have worked.
10858 So this is merely a faithful copy of the exiting bug: */
10859 new_state->re_state_reg_start_tmp
10860 = (char **) pv_dup((char *)
10861 old_state->re_state_reg_start_tmp);
10862 /* I assume that it only ever "worked" because no-one called
10863 (pseudo)fork while the regexp engine had re-entered itself.
10865 #ifdef PERL_OLD_COPY_ON_WRITE
10866 new_state->re_state_nrs
10867 = sv_dup(old_state->re_state_nrs, param);
10869 new_state->re_state_reg_magic
10870 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10872 new_state->re_state_reg_oldcurpm
10873 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10875 new_state->re_state_reg_curpm
10876 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10878 new_state->re_state_reg_oldsaved
10879 = pv_dup(old_state->re_state_reg_oldsaved);
10880 new_state->re_state_reg_poscache
10881 = pv_dup(old_state->re_state_reg_poscache);
10882 new_state->re_state_reg_starttry
10883 = pv_dup(old_state->re_state_reg_starttry);
10886 case SAVEt_COMPILE_WARNINGS:
10887 ptr = POPPTR(ss,ix);
10888 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10891 ptr = POPPTR(ss,ix);
10892 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10896 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10904 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10905 * flag to the result. This is done for each stash before cloning starts,
10906 * so we know which stashes want their objects cloned */
10909 do_mark_cloneable_stash(pTHX_ SV *sv)
10911 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10913 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10914 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10915 if (cloner && GvCV(cloner)) {
10922 mXPUSHs(newSVhek(hvname));
10924 call_sv((SV*)GvCV(cloner), G_SCALAR);
10931 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10939 =for apidoc perl_clone
10941 Create and return a new interpreter by cloning the current one.
10943 perl_clone takes these flags as parameters:
10945 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10946 without it we only clone the data and zero the stacks,
10947 with it we copy the stacks and the new perl interpreter is
10948 ready to run at the exact same point as the previous one.
10949 The pseudo-fork code uses COPY_STACKS while the
10950 threads->create doesn't.
10952 CLONEf_KEEP_PTR_TABLE
10953 perl_clone keeps a ptr_table with the pointer of the old
10954 variable as a key and the new variable as a value,
10955 this allows it to check if something has been cloned and not
10956 clone it again but rather just use the value and increase the
10957 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10958 the ptr_table using the function
10959 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10960 reason to keep it around is if you want to dup some of your own
10961 variable who are outside the graph perl scans, example of this
10962 code is in threads.xs create
10965 This is a win32 thing, it is ignored on unix, it tells perls
10966 win32host code (which is c++) to clone itself, this is needed on
10967 win32 if you want to run two threads at the same time,
10968 if you just want to do some stuff in a separate perl interpreter
10969 and then throw it away and return to the original one,
10970 you don't need to do anything.
10975 /* XXX the above needs expanding by someone who actually understands it ! */
10976 EXTERN_C PerlInterpreter *
10977 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10980 perl_clone(PerlInterpreter *proto_perl, UV flags)
10983 #ifdef PERL_IMPLICIT_SYS
10985 /* perlhost.h so we need to call into it
10986 to clone the host, CPerlHost should have a c interface, sky */
10988 if (flags & CLONEf_CLONE_HOST) {
10989 return perl_clone_host(proto_perl,flags);
10991 return perl_clone_using(proto_perl, flags,
10993 proto_perl->IMemShared,
10994 proto_perl->IMemParse,
10996 proto_perl->IStdIO,
11000 proto_perl->IProc);
11004 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11005 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11006 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11007 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11008 struct IPerlDir* ipD, struct IPerlSock* ipS,
11009 struct IPerlProc* ipP)
11011 /* XXX many of the string copies here can be optimized if they're
11012 * constants; they need to be allocated as common memory and just
11013 * their pointers copied. */
11016 CLONE_PARAMS clone_params;
11017 CLONE_PARAMS* const param = &clone_params;
11019 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11020 /* for each stash, determine whether its objects should be cloned */
11021 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11022 PERL_SET_THX(my_perl);
11025 PoisonNew(my_perl, 1, PerlInterpreter);
11031 PL_savestack_ix = 0;
11032 PL_savestack_max = -1;
11033 PL_sig_pending = 0;
11035 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11036 # else /* !DEBUGGING */
11037 Zero(my_perl, 1, PerlInterpreter);
11038 # endif /* DEBUGGING */
11040 /* host pointers */
11042 PL_MemShared = ipMS;
11043 PL_MemParse = ipMP;
11050 #else /* !PERL_IMPLICIT_SYS */
11052 CLONE_PARAMS clone_params;
11053 CLONE_PARAMS* param = &clone_params;
11054 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11055 /* for each stash, determine whether its objects should be cloned */
11056 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11057 PERL_SET_THX(my_perl);
11060 PoisonNew(my_perl, 1, PerlInterpreter);
11066 PL_savestack_ix = 0;
11067 PL_savestack_max = -1;
11068 PL_sig_pending = 0;
11070 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11071 # else /* !DEBUGGING */
11072 Zero(my_perl, 1, PerlInterpreter);
11073 # endif /* DEBUGGING */
11074 #endif /* PERL_IMPLICIT_SYS */
11075 param->flags = flags;
11076 param->proto_perl = proto_perl;
11078 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11080 PL_body_arenas = NULL;
11081 Zero(&PL_body_roots, 1, PL_body_roots);
11083 PL_nice_chunk = NULL;
11084 PL_nice_chunk_size = 0;
11086 PL_sv_objcount = 0;
11088 PL_sv_arenaroot = NULL;
11090 PL_debug = proto_perl->Idebug;
11092 PL_hash_seed = proto_perl->Ihash_seed;
11093 PL_rehash_seed = proto_perl->Irehash_seed;
11095 #ifdef USE_REENTRANT_API
11096 /* XXX: things like -Dm will segfault here in perlio, but doing
11097 * PERL_SET_CONTEXT(proto_perl);
11098 * breaks too many other things
11100 Perl_reentrant_init(aTHX);
11103 /* create SV map for pointer relocation */
11104 PL_ptr_table = ptr_table_new();
11106 /* initialize these special pointers as early as possible */
11107 SvANY(&PL_sv_undef) = NULL;
11108 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11109 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11110 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11112 SvANY(&PL_sv_no) = new_XPVNV();
11113 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11114 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11115 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11116 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11117 SvCUR_set(&PL_sv_no, 0);
11118 SvLEN_set(&PL_sv_no, 1);
11119 SvIV_set(&PL_sv_no, 0);
11120 SvNV_set(&PL_sv_no, 0);
11121 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11123 SvANY(&PL_sv_yes) = new_XPVNV();
11124 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11125 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11126 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11127 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11128 SvCUR_set(&PL_sv_yes, 1);
11129 SvLEN_set(&PL_sv_yes, 2);
11130 SvIV_set(&PL_sv_yes, 1);
11131 SvNV_set(&PL_sv_yes, 1);
11132 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11134 /* create (a non-shared!) shared string table */
11135 PL_strtab = newHV();
11136 HvSHAREKEYS_off(PL_strtab);
11137 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11138 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11140 PL_compiling = proto_perl->Icompiling;
11142 /* These two PVs will be free'd special way so must set them same way op.c does */
11143 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11144 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11146 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11147 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11149 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11150 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11151 if (PL_compiling.cop_hints_hash) {
11153 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11154 HINTS_REFCNT_UNLOCK;
11156 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11157 #ifdef PERL_DEBUG_READONLY_OPS
11162 /* pseudo environmental stuff */
11163 PL_origargc = proto_perl->Iorigargc;
11164 PL_origargv = proto_perl->Iorigargv;
11166 param->stashes = newAV(); /* Setup array of objects to call clone on */
11168 /* Set tainting stuff before PerlIO_debug can possibly get called */
11169 PL_tainting = proto_perl->Itainting;
11170 PL_taint_warn = proto_perl->Itaint_warn;
11172 #ifdef PERLIO_LAYERS
11173 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11174 PerlIO_clone(aTHX_ proto_perl, param);
11177 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11178 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11179 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11180 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11181 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11182 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11185 PL_minus_c = proto_perl->Iminus_c;
11186 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11187 PL_localpatches = proto_perl->Ilocalpatches;
11188 PL_splitstr = proto_perl->Isplitstr;
11189 PL_preprocess = proto_perl->Ipreprocess;
11190 PL_minus_n = proto_perl->Iminus_n;
11191 PL_minus_p = proto_perl->Iminus_p;
11192 PL_minus_l = proto_perl->Iminus_l;
11193 PL_minus_a = proto_perl->Iminus_a;
11194 PL_minus_E = proto_perl->Iminus_E;
11195 PL_minus_F = proto_perl->Iminus_F;
11196 PL_doswitches = proto_perl->Idoswitches;
11197 PL_dowarn = proto_perl->Idowarn;
11198 PL_doextract = proto_perl->Idoextract;
11199 PL_sawampersand = proto_perl->Isawampersand;
11200 PL_unsafe = proto_perl->Iunsafe;
11201 PL_inplace = SAVEPV(proto_perl->Iinplace);
11202 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11203 PL_perldb = proto_perl->Iperldb;
11204 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11205 PL_exit_flags = proto_perl->Iexit_flags;
11207 /* magical thingies */
11208 /* XXX time(&PL_basetime) when asked for? */
11209 PL_basetime = proto_perl->Ibasetime;
11210 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11212 PL_maxsysfd = proto_perl->Imaxsysfd;
11213 PL_statusvalue = proto_perl->Istatusvalue;
11215 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11217 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11219 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11221 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11222 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11223 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11226 /* RE engine related */
11227 Zero(&PL_reg_state, 1, struct re_save_state);
11228 PL_reginterp_cnt = 0;
11229 PL_regmatch_slab = NULL;
11231 /* Clone the regex array */
11232 PL_regex_padav = newAV();
11234 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11235 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11237 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11238 for(i = 1; i <= len; i++) {
11239 const SV * const regex = regexen[i];
11240 /* FIXME for plugins
11241 newSViv(PTR2IV(CALLREGDUPE(
11242 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11244 /* And while we're at it, can we FIXME on the whole hiding
11245 pointer inside an IV hack? */
11248 ? sv_dup_inc(regex, param)
11250 newSViv(PTR2IV(sv_dup_inc(INT2PTR(REGEXP *, SvIVX(regex)), param))))
11252 if (SvFLAGS(regex) & SVf_BREAK)
11253 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11254 av_push(PL_regex_padav, sv);
11257 PL_regex_pad = AvARRAY(PL_regex_padav);
11259 /* shortcuts to various I/O objects */
11260 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11261 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11262 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11263 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11264 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11265 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11267 /* shortcuts to regexp stuff */
11268 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11270 /* shortcuts to misc objects */
11271 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11273 /* shortcuts to debugging objects */
11274 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11275 PL_DBline = gv_dup(proto_perl->IDBline, param);
11276 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11277 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11278 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11279 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11280 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11282 /* symbol tables */
11283 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11284 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11285 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11286 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11287 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11289 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11290 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11291 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11292 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11293 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11294 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11295 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11296 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11298 PL_sub_generation = proto_perl->Isub_generation;
11299 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11301 /* funky return mechanisms */
11302 PL_forkprocess = proto_perl->Iforkprocess;
11304 /* subprocess state */
11305 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11307 /* internal state */
11308 PL_maxo = proto_perl->Imaxo;
11309 if (proto_perl->Iop_mask)
11310 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11313 /* PL_asserting = proto_perl->Iasserting; */
11315 /* current interpreter roots */
11316 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11318 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11320 PL_main_start = proto_perl->Imain_start;
11321 PL_eval_root = proto_perl->Ieval_root;
11322 PL_eval_start = proto_perl->Ieval_start;
11324 /* runtime control stuff */
11325 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11327 PL_filemode = proto_perl->Ifilemode;
11328 PL_lastfd = proto_perl->Ilastfd;
11329 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11332 PL_gensym = proto_perl->Igensym;
11333 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11334 PL_laststatval = proto_perl->Ilaststatval;
11335 PL_laststype = proto_perl->Ilaststype;
11338 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11340 /* interpreter atexit processing */
11341 PL_exitlistlen = proto_perl->Iexitlistlen;
11342 if (PL_exitlistlen) {
11343 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11344 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11347 PL_exitlist = (PerlExitListEntry*)NULL;
11349 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11350 if (PL_my_cxt_size) {
11351 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11352 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11353 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11354 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11355 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11359 PL_my_cxt_list = (void**)NULL;
11360 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11361 PL_my_cxt_keys = (const char**)NULL;
11364 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11365 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11366 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11368 PL_profiledata = NULL;
11370 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11372 PAD_CLONE_VARS(proto_perl, param);
11374 #ifdef HAVE_INTERP_INTERN
11375 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11378 /* more statics moved here */
11379 PL_generation = proto_perl->Igeneration;
11380 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11382 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11383 PL_in_clean_all = proto_perl->Iin_clean_all;
11385 PL_uid = proto_perl->Iuid;
11386 PL_euid = proto_perl->Ieuid;
11387 PL_gid = proto_perl->Igid;
11388 PL_egid = proto_perl->Iegid;
11389 PL_nomemok = proto_perl->Inomemok;
11390 PL_an = proto_perl->Ian;
11391 PL_evalseq = proto_perl->Ievalseq;
11392 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11393 PL_origalen = proto_perl->Iorigalen;
11394 #ifdef PERL_USES_PL_PIDSTATUS
11395 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11397 PL_osname = SAVEPV(proto_perl->Iosname);
11398 PL_sighandlerp = proto_perl->Isighandlerp;
11400 PL_runops = proto_perl->Irunops;
11402 PL_parser = parser_dup(proto_perl->Iparser, param);
11404 PL_subline = proto_perl->Isubline;
11405 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11408 PL_cryptseen = proto_perl->Icryptseen;
11411 PL_hints = proto_perl->Ihints;
11413 PL_amagic_generation = proto_perl->Iamagic_generation;
11415 #ifdef USE_LOCALE_COLLATE
11416 PL_collation_ix = proto_perl->Icollation_ix;
11417 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11418 PL_collation_standard = proto_perl->Icollation_standard;
11419 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11420 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11421 #endif /* USE_LOCALE_COLLATE */
11423 #ifdef USE_LOCALE_NUMERIC
11424 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11425 PL_numeric_standard = proto_perl->Inumeric_standard;
11426 PL_numeric_local = proto_perl->Inumeric_local;
11427 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11428 #endif /* !USE_LOCALE_NUMERIC */
11430 /* utf8 character classes */
11431 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11432 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11433 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11434 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11435 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11436 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11437 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11438 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11439 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11440 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11441 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11442 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11443 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11444 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11445 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11446 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11447 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11448 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11449 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11450 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11452 /* Did the locale setup indicate UTF-8? */
11453 PL_utf8locale = proto_perl->Iutf8locale;
11454 /* Unicode features (see perlrun/-C) */
11455 PL_unicode = proto_perl->Iunicode;
11457 /* Pre-5.8 signals control */
11458 PL_signals = proto_perl->Isignals;
11460 /* times() ticks per second */
11461 PL_clocktick = proto_perl->Iclocktick;
11463 /* Recursion stopper for PerlIO_find_layer */
11464 PL_in_load_module = proto_perl->Iin_load_module;
11466 /* sort() routine */
11467 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11469 /* Not really needed/useful since the reenrant_retint is "volatile",
11470 * but do it for consistency's sake. */
11471 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11473 /* Hooks to shared SVs and locks. */
11474 PL_sharehook = proto_perl->Isharehook;
11475 PL_lockhook = proto_perl->Ilockhook;
11476 PL_unlockhook = proto_perl->Iunlockhook;
11477 PL_threadhook = proto_perl->Ithreadhook;
11478 PL_destroyhook = proto_perl->Idestroyhook;
11480 #ifdef THREADS_HAVE_PIDS
11481 PL_ppid = proto_perl->Ippid;
11485 PL_last_swash_hv = NULL; /* reinits on demand */
11486 PL_last_swash_klen = 0;
11487 PL_last_swash_key[0]= '\0';
11488 PL_last_swash_tmps = (U8*)NULL;
11489 PL_last_swash_slen = 0;
11491 PL_glob_index = proto_perl->Iglob_index;
11492 PL_srand_called = proto_perl->Isrand_called;
11493 PL_bitcount = NULL; /* reinits on demand */
11495 if (proto_perl->Ipsig_pend) {
11496 Newxz(PL_psig_pend, SIG_SIZE, int);
11499 PL_psig_pend = (int*)NULL;
11502 if (proto_perl->Ipsig_ptr) {
11503 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11504 Newxz(PL_psig_name, SIG_SIZE, SV*);
11505 for (i = 1; i < SIG_SIZE; i++) {
11506 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11507 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11511 PL_psig_ptr = (SV**)NULL;
11512 PL_psig_name = (SV**)NULL;
11515 /* intrpvar.h stuff */
11517 if (flags & CLONEf_COPY_STACKS) {
11518 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11519 PL_tmps_ix = proto_perl->Itmps_ix;
11520 PL_tmps_max = proto_perl->Itmps_max;
11521 PL_tmps_floor = proto_perl->Itmps_floor;
11522 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11524 while (i <= PL_tmps_ix) {
11525 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11529 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11530 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11531 Newxz(PL_markstack, i, I32);
11532 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11533 - proto_perl->Imarkstack);
11534 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11535 - proto_perl->Imarkstack);
11536 Copy(proto_perl->Imarkstack, PL_markstack,
11537 PL_markstack_ptr - PL_markstack + 1, I32);
11539 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11540 * NOTE: unlike the others! */
11541 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11542 PL_scopestack_max = proto_perl->Iscopestack_max;
11543 Newxz(PL_scopestack, PL_scopestack_max, I32);
11544 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11546 /* NOTE: si_dup() looks at PL_markstack */
11547 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11549 /* PL_curstack = PL_curstackinfo->si_stack; */
11550 PL_curstack = av_dup(proto_perl->Icurstack, param);
11551 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11553 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11554 PL_stack_base = AvARRAY(PL_curstack);
11555 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11556 - proto_perl->Istack_base);
11557 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11559 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11560 * NOTE: unlike the others! */
11561 PL_savestack_ix = proto_perl->Isavestack_ix;
11562 PL_savestack_max = proto_perl->Isavestack_max;
11563 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11564 PL_savestack = ss_dup(proto_perl, param);
11568 ENTER; /* perl_destruct() wants to LEAVE; */
11570 /* although we're not duplicating the tmps stack, we should still
11571 * add entries for any SVs on the tmps stack that got cloned by a
11572 * non-refcount means (eg a temp in @_); otherwise they will be
11575 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11576 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11577 proto_perl->Itmps_stack[i]);
11578 if (nsv && !SvREFCNT(nsv)) {
11580 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11585 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11586 PL_top_env = &PL_start_env;
11588 PL_op = proto_perl->Iop;
11591 PL_Xpv = (XPV*)NULL;
11592 my_perl->Ina = proto_perl->Ina;
11594 PL_statbuf = proto_perl->Istatbuf;
11595 PL_statcache = proto_perl->Istatcache;
11596 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11597 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11599 PL_timesbuf = proto_perl->Itimesbuf;
11602 PL_tainted = proto_perl->Itainted;
11603 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11604 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11605 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11606 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11607 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11608 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11609 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11610 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11611 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11613 PL_restartop = proto_perl->Irestartop;
11614 PL_in_eval = proto_perl->Iin_eval;
11615 PL_delaymagic = proto_perl->Idelaymagic;
11616 PL_dirty = proto_perl->Idirty;
11617 PL_localizing = proto_perl->Ilocalizing;
11619 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11620 PL_hv_fetch_ent_mh = NULL;
11621 PL_modcount = proto_perl->Imodcount;
11622 PL_lastgotoprobe = NULL;
11623 PL_dumpindent = proto_perl->Idumpindent;
11625 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11626 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11627 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11628 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11629 PL_efloatbuf = NULL; /* reinits on demand */
11630 PL_efloatsize = 0; /* reinits on demand */
11634 PL_screamfirst = NULL;
11635 PL_screamnext = NULL;
11636 PL_maxscream = -1; /* reinits on demand */
11637 PL_lastscream = NULL;
11640 PL_regdummy = proto_perl->Iregdummy;
11641 PL_colorset = 0; /* reinits PL_colors[] */
11642 /*PL_colors[6] = {0,0,0,0,0,0};*/
11646 /* Pluggable optimizer */
11647 PL_peepp = proto_perl->Ipeepp;
11649 PL_stashcache = newHV();
11651 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11652 proto_perl->Iwatchaddr);
11653 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11654 if (PL_debug && PL_watchaddr) {
11655 PerlIO_printf(Perl_debug_log,
11656 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11657 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11658 PTR2UV(PL_watchok));
11661 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11662 ptr_table_free(PL_ptr_table);
11663 PL_ptr_table = NULL;
11666 /* Call the ->CLONE method, if it exists, for each of the stashes
11667 identified by sv_dup() above.
11669 while(av_len(param->stashes) != -1) {
11670 HV* const stash = (HV*) av_shift(param->stashes);
11671 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11672 if (cloner && GvCV(cloner)) {
11677 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11679 call_sv((SV*)GvCV(cloner), G_DISCARD);
11685 SvREFCNT_dec(param->stashes);
11687 /* orphaned? eg threads->new inside BEGIN or use */
11688 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11689 SvREFCNT_inc_simple_void(PL_compcv);
11690 SAVEFREESV(PL_compcv);
11696 #endif /* USE_ITHREADS */
11699 =head1 Unicode Support
11701 =for apidoc sv_recode_to_utf8
11703 The encoding is assumed to be an Encode object, on entry the PV
11704 of the sv is assumed to be octets in that encoding, and the sv
11705 will be converted into Unicode (and UTF-8).
11707 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11708 is not a reference, nothing is done to the sv. If the encoding is not
11709 an C<Encode::XS> Encoding object, bad things will happen.
11710 (See F<lib/encoding.pm> and L<Encode>).
11712 The PV of the sv is returned.
11717 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11720 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11734 Passing sv_yes is wrong - it needs to be or'ed set of constants
11735 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11736 remove converted chars from source.
11738 Both will default the value - let them.
11740 XPUSHs(&PL_sv_yes);
11743 call_method("decode", G_SCALAR);
11747 s = SvPV_const(uni, len);
11748 if (s != SvPVX_const(sv)) {
11749 SvGROW(sv, len + 1);
11750 Move(s, SvPVX(sv), len + 1, char);
11751 SvCUR_set(sv, len);
11758 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11762 =for apidoc sv_cat_decode
11764 The encoding is assumed to be an Encode object, the PV of the ssv is
11765 assumed to be octets in that encoding and decoding the input starts
11766 from the position which (PV + *offset) pointed to. The dsv will be
11767 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11768 when the string tstr appears in decoding output or the input ends on
11769 the PV of the ssv. The value which the offset points will be modified
11770 to the last input position on the ssv.
11772 Returns TRUE if the terminator was found, else returns FALSE.
11777 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11778 SV *ssv, int *offset, char *tstr, int tlen)
11782 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11793 offsv = newSViv(*offset);
11795 mXPUSHp(tstr, tlen);
11797 call_method("cat_decode", G_SCALAR);
11799 ret = SvTRUE(TOPs);
11800 *offset = SvIV(offsv);
11806 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11811 /* ---------------------------------------------------------------------
11813 * support functions for report_uninit()
11816 /* the maxiumum size of array or hash where we will scan looking
11817 * for the undefined element that triggered the warning */
11819 #define FUV_MAX_SEARCH_SIZE 1000
11821 /* Look for an entry in the hash whose value has the same SV as val;
11822 * If so, return a mortal copy of the key. */
11825 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11828 register HE **array;
11831 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11832 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11835 array = HvARRAY(hv);
11837 for (i=HvMAX(hv); i>0; i--) {
11838 register HE *entry;
11839 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11840 if (HeVAL(entry) != val)
11842 if ( HeVAL(entry) == &PL_sv_undef ||
11843 HeVAL(entry) == &PL_sv_placeholder)
11847 if (HeKLEN(entry) == HEf_SVKEY)
11848 return sv_mortalcopy(HeKEY_sv(entry));
11849 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11855 /* Look for an entry in the array whose value has the same SV as val;
11856 * If so, return the index, otherwise return -1. */
11859 S_find_array_subscript(pTHX_ AV *av, SV* val)
11862 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11863 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11866 if (val != &PL_sv_undef) {
11867 SV ** const svp = AvARRAY(av);
11870 for (i=AvFILLp(av); i>=0; i--)
11877 /* S_varname(): return the name of a variable, optionally with a subscript.
11878 * If gv is non-zero, use the name of that global, along with gvtype (one
11879 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11880 * targ. Depending on the value of the subscript_type flag, return:
11883 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11884 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11885 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11886 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11889 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11890 SV* keyname, I32 aindex, int subscript_type)
11893 SV * const name = sv_newmortal();
11896 buffer[0] = gvtype;
11899 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11901 gv_fullname4(name, gv, buffer, 0);
11903 if ((unsigned int)SvPVX(name)[1] <= 26) {
11905 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11907 /* Swap the 1 unprintable control character for the 2 byte pretty
11908 version - ie substr($name, 1, 1) = $buffer; */
11909 sv_insert(name, 1, 1, buffer, 2);
11913 CV * const cv = find_runcv(NULL);
11917 if (!cv || !CvPADLIST(cv))
11919 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11920 sv = *av_fetch(av, targ, FALSE);
11921 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11924 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11925 SV * const sv = newSV(0);
11926 *SvPVX(name) = '$';
11927 Perl_sv_catpvf(aTHX_ name, "{%s}",
11928 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11931 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11932 *SvPVX(name) = '$';
11933 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11935 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11936 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11943 =for apidoc find_uninit_var
11945 Find the name of the undefined variable (if any) that caused the operator o
11946 to issue a "Use of uninitialized value" warning.
11947 If match is true, only return a name if it's value matches uninit_sv.
11948 So roughly speaking, if a unary operator (such as OP_COS) generates a
11949 warning, then following the direct child of the op may yield an
11950 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11951 other hand, with OP_ADD there are two branches to follow, so we only print
11952 the variable name if we get an exact match.
11954 The name is returned as a mortal SV.
11956 Assumes that PL_op is the op that originally triggered the error, and that
11957 PL_comppad/PL_curpad points to the currently executing pad.
11963 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11971 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11972 uninit_sv == &PL_sv_placeholder)))
11975 switch (obase->op_type) {
11982 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11983 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11986 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11988 if (pad) { /* @lex, %lex */
11989 sv = PAD_SVl(obase->op_targ);
11993 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11994 /* @global, %global */
11995 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11998 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12000 else /* @{expr}, %{expr} */
12001 return find_uninit_var(cUNOPx(obase)->op_first,
12005 /* attempt to find a match within the aggregate */
12007 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12009 subscript_type = FUV_SUBSCRIPT_HASH;
12012 index = find_array_subscript((AV*)sv, uninit_sv);
12014 subscript_type = FUV_SUBSCRIPT_ARRAY;
12017 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12020 return varname(gv, hash ? '%' : '@', obase->op_targ,
12021 keysv, index, subscript_type);
12025 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12027 return varname(NULL, '$', obase->op_targ,
12028 NULL, 0, FUV_SUBSCRIPT_NONE);
12031 gv = cGVOPx_gv(obase);
12032 if (!gv || (match && GvSV(gv) != uninit_sv))
12034 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12037 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12040 av = (AV*)PAD_SV(obase->op_targ);
12041 if (!av || SvRMAGICAL(av))
12043 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12044 if (!svp || *svp != uninit_sv)
12047 return varname(NULL, '$', obase->op_targ,
12048 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12051 gv = cGVOPx_gv(obase);
12057 if (!av || SvRMAGICAL(av))
12059 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12060 if (!svp || *svp != uninit_sv)
12063 return varname(gv, '$', 0,
12064 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12069 o = cUNOPx(obase)->op_first;
12070 if (!o || o->op_type != OP_NULL ||
12071 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12073 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12077 if (PL_op == obase)
12078 /* $a[uninit_expr] or $h{uninit_expr} */
12079 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12082 o = cBINOPx(obase)->op_first;
12083 kid = cBINOPx(obase)->op_last;
12085 /* get the av or hv, and optionally the gv */
12087 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12088 sv = PAD_SV(o->op_targ);
12090 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12091 && cUNOPo->op_first->op_type == OP_GV)
12093 gv = cGVOPx_gv(cUNOPo->op_first);
12096 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12101 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12102 /* index is constant */
12106 if (obase->op_type == OP_HELEM) {
12107 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12108 if (!he || HeVAL(he) != uninit_sv)
12112 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12113 if (!svp || *svp != uninit_sv)
12117 if (obase->op_type == OP_HELEM)
12118 return varname(gv, '%', o->op_targ,
12119 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12121 return varname(gv, '@', o->op_targ, NULL,
12122 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12125 /* index is an expression;
12126 * attempt to find a match within the aggregate */
12127 if (obase->op_type == OP_HELEM) {
12128 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12130 return varname(gv, '%', o->op_targ,
12131 keysv, 0, FUV_SUBSCRIPT_HASH);
12134 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12136 return varname(gv, '@', o->op_targ,
12137 NULL, index, FUV_SUBSCRIPT_ARRAY);
12142 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12144 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12149 /* only examine RHS */
12150 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12153 o = cUNOPx(obase)->op_first;
12154 if (o->op_type == OP_PUSHMARK)
12157 if (!o->op_sibling) {
12158 /* one-arg version of open is highly magical */
12160 if (o->op_type == OP_GV) { /* open FOO; */
12162 if (match && GvSV(gv) != uninit_sv)
12164 return varname(gv, '$', 0,
12165 NULL, 0, FUV_SUBSCRIPT_NONE);
12167 /* other possibilities not handled are:
12168 * open $x; or open my $x; should return '${*$x}'
12169 * open expr; should return '$'.expr ideally
12175 /* ops where $_ may be an implicit arg */
12179 if ( !(obase->op_flags & OPf_STACKED)) {
12180 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12181 ? PAD_SVl(obase->op_targ)
12184 sv = sv_newmortal();
12185 sv_setpvn(sv, "$_", 2);
12194 /* skip filehandle as it can't produce 'undef' warning */
12195 o = cUNOPx(obase)->op_first;
12196 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12197 o = o->op_sibling->op_sibling;
12203 match = 1; /* XS or custom code could trigger random warnings */
12208 /* XXX tmp hack: these two may call an XS sub, and currently
12209 XS subs don't have a SUB entry on the context stack, so CV and
12210 pad determination goes wrong, and BAD things happen. So, just
12211 don't try to determine the value under those circumstances.
12212 Need a better fix at dome point. DAPM 11/2007 */
12216 /* def-ness of rval pos() is independent of the def-ness of its arg */
12217 if ( !(obase->op_flags & OPf_MOD))
12222 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12223 return newSVpvs_flags("${$/}", SVs_TEMP);
12228 if (!(obase->op_flags & OPf_KIDS))
12230 o = cUNOPx(obase)->op_first;
12236 /* if all except one arg are constant, or have no side-effects,
12237 * or are optimized away, then it's unambiguous */
12239 for (kid=o; kid; kid = kid->op_sibling) {
12241 const OPCODE type = kid->op_type;
12242 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12243 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12244 || (type == OP_PUSHMARK)
12248 if (o2) { /* more than one found */
12255 return find_uninit_var(o2, uninit_sv, match);
12257 /* scan all args */
12259 sv = find_uninit_var(o, uninit_sv, 1);
12271 =for apidoc report_uninit
12273 Print appropriate "Use of uninitialized variable" warning
12279 Perl_report_uninit(pTHX_ SV* uninit_sv)
12283 SV* varname = NULL;
12285 varname = find_uninit_var(PL_op, uninit_sv,0);
12287 sv_insert(varname, 0, 0, " ", 1);
12289 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12290 varname ? SvPV_nolen_const(varname) : "",
12291 " in ", OP_DESC(PL_op));
12294 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12300 * c-indentation-style: bsd
12301 * c-basic-offset: 4
12302 * indent-tabs-mode: t
12305 * ex: set ts=8 sts=4 sw=4 noet: