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)
1400 PERL_UNUSED_CONTEXT;
1402 assert(SvTYPE(sv) != SVt_PVHV);
1403 assert(SvTYPE(sv) != SVt_PVAV);
1405 const char * const s = SvPVX_const(sv);
1407 /* Validate the preceding buffer's sentinels to verify that no-one is
1409 const U8 *p = (const U8*) s;
1410 const U8 *const real_start = p - SvIVX(sv);
1411 while (p > real_start) {
1413 assert (*p == (U8)PTR2UV(p));
1416 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1417 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1419 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1421 SvFLAGS(sv) &= ~SVf_OOK;
1428 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1429 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1430 Use the C<SvGROW> wrapper instead.
1436 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1440 if (PL_madskills && newlen >= 0x100000) {
1441 PerlIO_printf(Perl_debug_log,
1442 "Allocation too large: %"UVxf"\n", (UV)newlen);
1444 #ifdef HAS_64K_LIMIT
1445 if (newlen >= 0x10000) {
1446 PerlIO_printf(Perl_debug_log,
1447 "Allocation too large: %"UVxf"\n", (UV)newlen);
1450 #endif /* HAS_64K_LIMIT */
1453 if (SvTYPE(sv) < SVt_PV) {
1454 sv_upgrade(sv, SVt_PV);
1455 s = SvPVX_mutable(sv);
1457 else if (SvOOK(sv)) { /* pv is offset? */
1459 s = SvPVX_mutable(sv);
1460 if (newlen > SvLEN(sv))
1461 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1462 #ifdef HAS_64K_LIMIT
1463 if (newlen >= 0x10000)
1468 s = SvPVX_mutable(sv);
1470 if (newlen > SvLEN(sv)) { /* need more room? */
1471 newlen = PERL_STRLEN_ROUNDUP(newlen);
1472 if (SvLEN(sv) && s) {
1474 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1480 s = (char*)saferealloc(s, newlen);
1483 s = (char*)safemalloc(newlen);
1484 if (SvPVX_const(sv) && SvCUR(sv)) {
1485 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1489 SvLEN_set(sv, newlen);
1495 =for apidoc sv_setiv
1497 Copies an integer into the given SV, upgrading first if necessary.
1498 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1504 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1507 SV_CHECK_THINKFIRST_COW_DROP(sv);
1508 switch (SvTYPE(sv)) {
1511 sv_upgrade(sv, SVt_IV);
1514 sv_upgrade(sv, SVt_PVIV);
1523 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1527 (void)SvIOK_only(sv); /* validate number */
1533 =for apidoc sv_setiv_mg
1535 Like C<sv_setiv>, but also handles 'set' magic.
1541 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1548 =for apidoc sv_setuv
1550 Copies an unsigned integer into the given SV, upgrading first if necessary.
1551 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1557 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1559 /* With these two if statements:
1560 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1563 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1565 If you wish to remove them, please benchmark to see what the effect is
1567 if (u <= (UV)IV_MAX) {
1568 sv_setiv(sv, (IV)u);
1577 =for apidoc sv_setuv_mg
1579 Like C<sv_setuv>, but also handles 'set' magic.
1585 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1592 =for apidoc sv_setnv
1594 Copies a double into the given SV, upgrading first if necessary.
1595 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1601 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1604 SV_CHECK_THINKFIRST_COW_DROP(sv);
1605 switch (SvTYPE(sv)) {
1608 sv_upgrade(sv, SVt_NV);
1612 sv_upgrade(sv, SVt_PVNV);
1621 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1626 (void)SvNOK_only(sv); /* validate number */
1631 =for apidoc sv_setnv_mg
1633 Like C<sv_setnv>, but also handles 'set' magic.
1639 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1645 /* Print an "isn't numeric" warning, using a cleaned-up,
1646 * printable version of the offending string
1650 S_not_a_number(pTHX_ SV *sv)
1658 dsv = newSVpvs_flags("", SVs_TEMP);
1659 pv = sv_uni_display(dsv, sv, 10, 0);
1662 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1663 /* each *s can expand to 4 chars + "...\0",
1664 i.e. need room for 8 chars */
1666 const char *s = SvPVX_const(sv);
1667 const char * const end = s + SvCUR(sv);
1668 for ( ; s < end && d < limit; s++ ) {
1670 if (ch & 128 && !isPRINT_LC(ch)) {
1679 else if (ch == '\r') {
1683 else if (ch == '\f') {
1687 else if (ch == '\\') {
1691 else if (ch == '\0') {
1695 else if (isPRINT_LC(ch))
1712 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1713 "Argument \"%s\" isn't numeric in %s", pv,
1716 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1717 "Argument \"%s\" isn't numeric", pv);
1721 =for apidoc looks_like_number
1723 Test if the content of an SV looks like a number (or is a number).
1724 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1725 non-numeric warning), even if your atof() doesn't grok them.
1731 Perl_looks_like_number(pTHX_ SV *sv)
1733 register const char *sbegin;
1737 sbegin = SvPVX_const(sv);
1740 else if (SvPOKp(sv))
1741 sbegin = SvPV_const(sv, len);
1743 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1744 return grok_number(sbegin, len, NULL);
1748 S_glob_2number(pTHX_ GV * const gv)
1750 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1751 SV *const buffer = sv_newmortal();
1753 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1756 gv_efullname3(buffer, gv, "*");
1757 SvFLAGS(gv) |= wasfake;
1759 /* We know that all GVs stringify to something that is not-a-number,
1760 so no need to test that. */
1761 if (ckWARN(WARN_NUMERIC))
1762 not_a_number(buffer);
1763 /* We just want something true to return, so that S_sv_2iuv_common
1764 can tail call us and return true. */
1769 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1771 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1772 SV *const buffer = sv_newmortal();
1774 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1777 gv_efullname3(buffer, gv, "*");
1778 SvFLAGS(gv) |= wasfake;
1780 assert(SvPOK(buffer));
1782 *len = SvCUR(buffer);
1784 return SvPVX(buffer);
1787 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1788 until proven guilty, assume that things are not that bad... */
1793 As 64 bit platforms often have an NV that doesn't preserve all bits of
1794 an IV (an assumption perl has been based on to date) it becomes necessary
1795 to remove the assumption that the NV always carries enough precision to
1796 recreate the IV whenever needed, and that the NV is the canonical form.
1797 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1798 precision as a side effect of conversion (which would lead to insanity
1799 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1800 1) to distinguish between IV/UV/NV slots that have cached a valid
1801 conversion where precision was lost and IV/UV/NV slots that have a
1802 valid conversion which has lost no precision
1803 2) to ensure that if a numeric conversion to one form is requested that
1804 would lose precision, the precise conversion (or differently
1805 imprecise conversion) is also performed and cached, to prevent
1806 requests for different numeric formats on the same SV causing
1807 lossy conversion chains. (lossless conversion chains are perfectly
1812 SvIOKp is true if the IV slot contains a valid value
1813 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1814 SvNOKp is true if the NV slot contains a valid value
1815 SvNOK is true only if the NV value is accurate
1818 while converting from PV to NV, check to see if converting that NV to an
1819 IV(or UV) would lose accuracy over a direct conversion from PV to
1820 IV(or UV). If it would, cache both conversions, return NV, but mark
1821 SV as IOK NOKp (ie not NOK).
1823 While converting from PV to IV, check to see if converting that IV to an
1824 NV would lose accuracy over a direct conversion from PV to NV. If it
1825 would, cache both conversions, flag similarly.
1827 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1828 correctly because if IV & NV were set NV *always* overruled.
1829 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1830 changes - now IV and NV together means that the two are interchangeable:
1831 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1833 The benefit of this is that operations such as pp_add know that if
1834 SvIOK is true for both left and right operands, then integer addition
1835 can be used instead of floating point (for cases where the result won't
1836 overflow). Before, floating point was always used, which could lead to
1837 loss of precision compared with integer addition.
1839 * making IV and NV equal status should make maths accurate on 64 bit
1841 * may speed up maths somewhat if pp_add and friends start to use
1842 integers when possible instead of fp. (Hopefully the overhead in
1843 looking for SvIOK and checking for overflow will not outweigh the
1844 fp to integer speedup)
1845 * will slow down integer operations (callers of SvIV) on "inaccurate"
1846 values, as the change from SvIOK to SvIOKp will cause a call into
1847 sv_2iv each time rather than a macro access direct to the IV slot
1848 * should speed up number->string conversion on integers as IV is
1849 favoured when IV and NV are equally accurate
1851 ####################################################################
1852 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1853 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1854 On the other hand, SvUOK is true iff UV.
1855 ####################################################################
1857 Your mileage will vary depending your CPU's relative fp to integer
1861 #ifndef NV_PRESERVES_UV
1862 # define IS_NUMBER_UNDERFLOW_IV 1
1863 # define IS_NUMBER_UNDERFLOW_UV 2
1864 # define IS_NUMBER_IV_AND_UV 2
1865 # define IS_NUMBER_OVERFLOW_IV 4
1866 # define IS_NUMBER_OVERFLOW_UV 5
1868 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1870 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1872 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1875 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1876 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));
1877 if (SvNVX(sv) < (NV)IV_MIN) {
1878 (void)SvIOKp_on(sv);
1880 SvIV_set(sv, IV_MIN);
1881 return IS_NUMBER_UNDERFLOW_IV;
1883 if (SvNVX(sv) > (NV)UV_MAX) {
1884 (void)SvIOKp_on(sv);
1887 SvUV_set(sv, UV_MAX);
1888 return IS_NUMBER_OVERFLOW_UV;
1890 (void)SvIOKp_on(sv);
1892 /* Can't use strtol etc to convert this string. (See truth table in
1894 if (SvNVX(sv) <= (UV)IV_MAX) {
1895 SvIV_set(sv, I_V(SvNVX(sv)));
1896 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1897 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1899 /* Integer is imprecise. NOK, IOKp */
1901 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1904 SvUV_set(sv, U_V(SvNVX(sv)));
1905 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1906 if (SvUVX(sv) == UV_MAX) {
1907 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1908 possibly be preserved by NV. Hence, it must be overflow.
1910 return IS_NUMBER_OVERFLOW_UV;
1912 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1914 /* Integer is imprecise. NOK, IOKp */
1916 return IS_NUMBER_OVERFLOW_IV;
1918 #endif /* !NV_PRESERVES_UV*/
1921 S_sv_2iuv_common(pTHX_ SV *sv) {
1924 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1925 * without also getting a cached IV/UV from it at the same time
1926 * (ie PV->NV conversion should detect loss of accuracy and cache
1927 * IV or UV at same time to avoid this. */
1928 /* IV-over-UV optimisation - choose to cache IV if possible */
1930 if (SvTYPE(sv) == SVt_NV)
1931 sv_upgrade(sv, SVt_PVNV);
1933 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1934 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1935 certainly cast into the IV range at IV_MAX, whereas the correct
1936 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1938 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1939 if (Perl_isnan(SvNVX(sv))) {
1945 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1946 SvIV_set(sv, I_V(SvNVX(sv)));
1947 if (SvNVX(sv) == (NV) SvIVX(sv)
1948 #ifndef NV_PRESERVES_UV
1949 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1950 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1951 /* Don't flag it as "accurately an integer" if the number
1952 came from a (by definition imprecise) NV operation, and
1953 we're outside the range of NV integer precision */
1956 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1957 DEBUG_c(PerlIO_printf(Perl_debug_log,
1958 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1964 /* IV not precise. No need to convert from PV, as NV
1965 conversion would already have cached IV if it detected
1966 that PV->IV would be better than PV->NV->IV
1967 flags already correct - don't set public IOK. */
1968 DEBUG_c(PerlIO_printf(Perl_debug_log,
1969 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1974 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1975 but the cast (NV)IV_MIN rounds to a the value less (more
1976 negative) than IV_MIN which happens to be equal to SvNVX ??
1977 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1978 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1979 (NV)UVX == NVX are both true, but the values differ. :-(
1980 Hopefully for 2s complement IV_MIN is something like
1981 0x8000000000000000 which will be exact. NWC */
1984 SvUV_set(sv, U_V(SvNVX(sv)));
1986 (SvNVX(sv) == (NV) SvUVX(sv))
1987 #ifndef NV_PRESERVES_UV
1988 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1989 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1990 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1991 /* Don't flag it as "accurately an integer" if the number
1992 came from a (by definition imprecise) NV operation, and
1993 we're outside the range of NV integer precision */
1998 DEBUG_c(PerlIO_printf(Perl_debug_log,
1999 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2005 else if (SvPOKp(sv) && SvLEN(sv)) {
2007 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2008 /* We want to avoid a possible problem when we cache an IV/ a UV which
2009 may be later translated to an NV, and the resulting NV is not
2010 the same as the direct translation of the initial string
2011 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2012 be careful to ensure that the value with the .456 is around if the
2013 NV value is requested in the future).
2015 This means that if we cache such an IV/a UV, we need to cache the
2016 NV as well. Moreover, we trade speed for space, and do not
2017 cache the NV if we are sure it's not needed.
2020 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2021 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2022 == IS_NUMBER_IN_UV) {
2023 /* It's definitely an integer, only upgrade to PVIV */
2024 if (SvTYPE(sv) < SVt_PVIV)
2025 sv_upgrade(sv, SVt_PVIV);
2027 } else if (SvTYPE(sv) < SVt_PVNV)
2028 sv_upgrade(sv, SVt_PVNV);
2030 /* If NVs preserve UVs then we only use the UV value if we know that
2031 we aren't going to call atof() below. If NVs don't preserve UVs
2032 then the value returned may have more precision than atof() will
2033 return, even though value isn't perfectly accurate. */
2034 if ((numtype & (IS_NUMBER_IN_UV
2035 #ifdef NV_PRESERVES_UV
2038 )) == IS_NUMBER_IN_UV) {
2039 /* This won't turn off the public IOK flag if it was set above */
2040 (void)SvIOKp_on(sv);
2042 if (!(numtype & IS_NUMBER_NEG)) {
2044 if (value <= (UV)IV_MAX) {
2045 SvIV_set(sv, (IV)value);
2047 /* it didn't overflow, and it was positive. */
2048 SvUV_set(sv, value);
2052 /* 2s complement assumption */
2053 if (value <= (UV)IV_MIN) {
2054 SvIV_set(sv, -(IV)value);
2056 /* Too negative for an IV. This is a double upgrade, but
2057 I'm assuming it will be rare. */
2058 if (SvTYPE(sv) < SVt_PVNV)
2059 sv_upgrade(sv, SVt_PVNV);
2063 SvNV_set(sv, -(NV)value);
2064 SvIV_set(sv, IV_MIN);
2068 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2069 will be in the previous block to set the IV slot, and the next
2070 block to set the NV slot. So no else here. */
2072 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2073 != IS_NUMBER_IN_UV) {
2074 /* It wasn't an (integer that doesn't overflow the UV). */
2075 SvNV_set(sv, Atof(SvPVX_const(sv)));
2077 if (! numtype && ckWARN(WARN_NUMERIC))
2080 #if defined(USE_LONG_DOUBLE)
2081 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2082 PTR2UV(sv), SvNVX(sv)));
2084 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2085 PTR2UV(sv), SvNVX(sv)));
2088 #ifdef NV_PRESERVES_UV
2089 (void)SvIOKp_on(sv);
2091 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2092 SvIV_set(sv, I_V(SvNVX(sv)));
2093 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2096 NOOP; /* Integer is imprecise. NOK, IOKp */
2098 /* UV will not work better than IV */
2100 if (SvNVX(sv) > (NV)UV_MAX) {
2102 /* Integer is inaccurate. NOK, IOKp, is UV */
2103 SvUV_set(sv, UV_MAX);
2105 SvUV_set(sv, U_V(SvNVX(sv)));
2106 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2107 NV preservse UV so can do correct comparison. */
2108 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2111 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2116 #else /* NV_PRESERVES_UV */
2117 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2118 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2119 /* The IV/UV slot will have been set from value returned by
2120 grok_number above. The NV slot has just been set using
2123 assert (SvIOKp(sv));
2125 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2126 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2127 /* Small enough to preserve all bits. */
2128 (void)SvIOKp_on(sv);
2130 SvIV_set(sv, I_V(SvNVX(sv)));
2131 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2133 /* Assumption: first non-preserved integer is < IV_MAX,
2134 this NV is in the preserved range, therefore: */
2135 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2137 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);
2141 0 0 already failed to read UV.
2142 0 1 already failed to read UV.
2143 1 0 you won't get here in this case. IV/UV
2144 slot set, public IOK, Atof() unneeded.
2145 1 1 already read UV.
2146 so there's no point in sv_2iuv_non_preserve() attempting
2147 to use atol, strtol, strtoul etc. */
2148 sv_2iuv_non_preserve (sv, numtype);
2151 #endif /* NV_PRESERVES_UV */
2155 if (isGV_with_GP(sv))
2156 return glob_2number((GV *)sv);
2158 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2159 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2162 if (SvTYPE(sv) < SVt_IV)
2163 /* Typically the caller expects that sv_any is not NULL now. */
2164 sv_upgrade(sv, SVt_IV);
2165 /* Return 0 from the caller. */
2172 =for apidoc sv_2iv_flags
2174 Return the integer value of an SV, doing any necessary string
2175 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2176 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2182 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2187 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2188 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2189 cache IVs just in case. In practice it seems that they never
2190 actually anywhere accessible by user Perl code, let alone get used
2191 in anything other than a string context. */
2192 if (flags & SV_GMAGIC)
2197 return I_V(SvNVX(sv));
2199 if (SvPOKp(sv) && SvLEN(sv)) {
2202 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2204 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2205 == IS_NUMBER_IN_UV) {
2206 /* It's definitely an integer */
2207 if (numtype & IS_NUMBER_NEG) {
2208 if (value < (UV)IV_MIN)
2211 if (value < (UV)IV_MAX)
2216 if (ckWARN(WARN_NUMERIC))
2219 return I_V(Atof(SvPVX_const(sv)));
2224 assert(SvTYPE(sv) >= SVt_PVMG);
2225 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2226 } else if (SvTHINKFIRST(sv)) {
2230 SV * const tmpstr=AMG_CALLun(sv,numer);
2231 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2232 return SvIV(tmpstr);
2235 return PTR2IV(SvRV(sv));
2238 sv_force_normal_flags(sv, 0);
2240 if (SvREADONLY(sv) && !SvOK(sv)) {
2241 if (ckWARN(WARN_UNINITIALIZED))
2247 if (S_sv_2iuv_common(aTHX_ sv))
2250 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2251 PTR2UV(sv),SvIVX(sv)));
2252 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2256 =for apidoc sv_2uv_flags
2258 Return the unsigned integer value of an SV, doing any necessary string
2259 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2260 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2266 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2271 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2272 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2273 cache IVs just in case. */
2274 if (flags & SV_GMAGIC)
2279 return U_V(SvNVX(sv));
2280 if (SvPOKp(sv) && SvLEN(sv)) {
2283 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2285 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2286 == IS_NUMBER_IN_UV) {
2287 /* It's definitely an integer */
2288 if (!(numtype & IS_NUMBER_NEG))
2292 if (ckWARN(WARN_NUMERIC))
2295 return U_V(Atof(SvPVX_const(sv)));
2300 assert(SvTYPE(sv) >= SVt_PVMG);
2301 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2302 } else if (SvTHINKFIRST(sv)) {
2306 SV *const tmpstr = AMG_CALLun(sv,numer);
2307 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2308 return SvUV(tmpstr);
2311 return PTR2UV(SvRV(sv));
2314 sv_force_normal_flags(sv, 0);
2316 if (SvREADONLY(sv) && !SvOK(sv)) {
2317 if (ckWARN(WARN_UNINITIALIZED))
2323 if (S_sv_2iuv_common(aTHX_ sv))
2327 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2328 PTR2UV(sv),SvUVX(sv)));
2329 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2335 Return the num value of an SV, doing any necessary string or integer
2336 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2343 Perl_sv_2nv(pTHX_ register SV *sv)
2348 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2349 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2350 cache IVs just in case. */
2354 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2355 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2356 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2358 return Atof(SvPVX_const(sv));
2362 return (NV)SvUVX(sv);
2364 return (NV)SvIVX(sv);
2369 assert(SvTYPE(sv) >= SVt_PVMG);
2370 /* This falls through to the report_uninit near the end of the
2372 } else if (SvTHINKFIRST(sv)) {
2376 SV *const tmpstr = AMG_CALLun(sv,numer);
2377 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2378 return SvNV(tmpstr);
2381 return PTR2NV(SvRV(sv));
2384 sv_force_normal_flags(sv, 0);
2386 if (SvREADONLY(sv) && !SvOK(sv)) {
2387 if (ckWARN(WARN_UNINITIALIZED))
2392 if (SvTYPE(sv) < SVt_NV) {
2393 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2394 sv_upgrade(sv, SVt_NV);
2395 #ifdef USE_LONG_DOUBLE
2397 STORE_NUMERIC_LOCAL_SET_STANDARD();
2398 PerlIO_printf(Perl_debug_log,
2399 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 STORE_NUMERIC_LOCAL_SET_STANDARD();
2406 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2407 PTR2UV(sv), SvNVX(sv));
2408 RESTORE_NUMERIC_LOCAL();
2412 else if (SvTYPE(sv) < SVt_PVNV)
2413 sv_upgrade(sv, SVt_PVNV);
2418 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2419 #ifdef NV_PRESERVES_UV
2422 /* Only set the public NV OK flag if this NV preserves the IV */
2423 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2424 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2425 : (SvIVX(sv) == I_V(SvNVX(sv))))
2431 else if (SvPOKp(sv) && SvLEN(sv)) {
2433 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2434 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2436 #ifdef NV_PRESERVES_UV
2437 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2438 == IS_NUMBER_IN_UV) {
2439 /* It's definitely an integer */
2440 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2442 SvNV_set(sv, Atof(SvPVX_const(sv)));
2445 SvNV_set(sv, Atof(SvPVX_const(sv)));
2446 /* Only set the public NV OK flag if this NV preserves the value in
2447 the PV at least as well as an IV/UV would.
2448 Not sure how to do this 100% reliably. */
2449 /* if that shift count is out of range then Configure's test is
2450 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2452 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2453 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2454 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2455 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2456 /* Can't use strtol etc to convert this string, so don't try.
2457 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2460 /* value has been set. It may not be precise. */
2461 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2462 /* 2s complement assumption for (UV)IV_MIN */
2463 SvNOK_on(sv); /* Integer is too negative. */
2468 if (numtype & IS_NUMBER_NEG) {
2469 SvIV_set(sv, -(IV)value);
2470 } else if (value <= (UV)IV_MAX) {
2471 SvIV_set(sv, (IV)value);
2473 SvUV_set(sv, value);
2477 if (numtype & IS_NUMBER_NOT_INT) {
2478 /* I believe that even if the original PV had decimals,
2479 they are lost beyond the limit of the FP precision.
2480 However, neither is canonical, so both only get p
2481 flags. NWC, 2000/11/25 */
2482 /* Both already have p flags, so do nothing */
2484 const NV nv = SvNVX(sv);
2485 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2486 if (SvIVX(sv) == I_V(nv)) {
2489 /* It had no "." so it must be integer. */
2493 /* between IV_MAX and NV(UV_MAX).
2494 Could be slightly > UV_MAX */
2496 if (numtype & IS_NUMBER_NOT_INT) {
2497 /* UV and NV both imprecise. */
2499 const UV nv_as_uv = U_V(nv);
2501 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2510 #endif /* NV_PRESERVES_UV */
2513 if (isGV_with_GP(sv)) {
2514 glob_2number((GV *)sv);
2518 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2520 assert (SvTYPE(sv) >= SVt_NV);
2521 /* Typically the caller expects that sv_any is not NULL now. */
2522 /* XXX Ilya implies that this is a bug in callers that assume this
2523 and ideally should be fixed. */
2526 #if defined(USE_LONG_DOUBLE)
2528 STORE_NUMERIC_LOCAL_SET_STANDARD();
2529 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2530 PTR2UV(sv), SvNVX(sv));
2531 RESTORE_NUMERIC_LOCAL();
2535 STORE_NUMERIC_LOCAL_SET_STANDARD();
2536 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2537 PTR2UV(sv), SvNVX(sv));
2538 RESTORE_NUMERIC_LOCAL();
2547 Return an SV with the numeric value of the source SV, doing any necessary
2548 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2549 access this function.
2555 Perl_sv_2num(pTHX_ register SV *sv)
2560 SV * const tmpsv = AMG_CALLun(sv,numer);
2561 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2562 return sv_2num(tmpsv);
2564 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2567 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2568 * UV as a string towards the end of buf, and return pointers to start and
2571 * We assume that buf is at least TYPE_CHARS(UV) long.
2575 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2577 char *ptr = buf + TYPE_CHARS(UV);
2578 char * const ebuf = ptr;
2591 *--ptr = '0' + (char)(uv % 10);
2600 =for apidoc sv_2pv_flags
2602 Returns a pointer to the string value of an SV, and sets *lp to its length.
2603 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2605 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2606 usually end up here too.
2612 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2622 if (SvGMAGICAL(sv)) {
2623 if (flags & SV_GMAGIC)
2628 if (flags & SV_MUTABLE_RETURN)
2629 return SvPVX_mutable(sv);
2630 if (flags & SV_CONST_RETURN)
2631 return (char *)SvPVX_const(sv);
2634 if (SvIOKp(sv) || SvNOKp(sv)) {
2635 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2640 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2641 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2643 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2650 #ifdef FIXNEGATIVEZERO
2651 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2657 SvUPGRADE(sv, SVt_PV);
2660 s = SvGROW_mutable(sv, len + 1);
2663 return (char*)memcpy(s, tbuf, len + 1);
2669 assert(SvTYPE(sv) >= SVt_PVMG);
2670 /* This falls through to the report_uninit near the end of the
2672 } else if (SvTHINKFIRST(sv)) {
2676 SV *const tmpstr = AMG_CALLun(sv,string);
2677 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2679 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2683 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2684 if (flags & SV_CONST_RETURN) {
2685 pv = (char *) SvPVX_const(tmpstr);
2687 pv = (flags & SV_MUTABLE_RETURN)
2688 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2691 *lp = SvCUR(tmpstr);
2693 pv = sv_2pv_flags(tmpstr, lp, flags);
2706 const SV *const referent = (SV*)SvRV(sv);
2710 retval = buffer = savepvn("NULLREF", len);
2711 } else if (SvTYPE(referent) == SVt_REGEXP) {
2716 /* FIXME - get rid of this cast away of const, or work out
2717 how to do it better. */
2718 temp.mg_obj = (SV *)referent;
2719 assert(temp.mg_obj);
2720 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2725 PL_reginterp_cnt += haseval;
2728 const char *const typestr = sv_reftype(referent, 0);
2729 const STRLEN typelen = strlen(typestr);
2730 UV addr = PTR2UV(referent);
2731 const char *stashname = NULL;
2732 STRLEN stashnamelen = 0; /* hush, gcc */
2733 const char *buffer_end;
2735 if (SvOBJECT(referent)) {
2736 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2739 stashname = HEK_KEY(name);
2740 stashnamelen = HEK_LEN(name);
2742 if (HEK_UTF8(name)) {
2748 stashname = "__ANON__";
2751 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2752 + 2 * sizeof(UV) + 2 /* )\0 */;
2754 len = typelen + 3 /* (0x */
2755 + 2 * sizeof(UV) + 2 /* )\0 */;
2758 Newx(buffer, len, char);
2759 buffer_end = retval = buffer + len;
2761 /* Working backwards */
2765 *--retval = PL_hexdigit[addr & 15];
2766 } while (addr >>= 4);
2772 memcpy(retval, typestr, typelen);
2776 retval -= stashnamelen;
2777 memcpy(retval, stashname, stashnamelen);
2779 /* retval may not neccesarily have reached the start of the
2781 assert (retval >= buffer);
2783 len = buffer_end - retval - 1; /* -1 for that \0 */
2791 if (SvREADONLY(sv) && !SvOK(sv)) {
2792 if (ckWARN(WARN_UNINITIALIZED))
2799 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2800 /* I'm assuming that if both IV and NV are equally valid then
2801 converting the IV is going to be more efficient */
2802 const U32 isUIOK = SvIsUV(sv);
2803 char buf[TYPE_CHARS(UV)];
2807 if (SvTYPE(sv) < SVt_PVIV)
2808 sv_upgrade(sv, SVt_PVIV);
2809 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2811 /* inlined from sv_setpvn */
2812 s = SvGROW_mutable(sv, len + 1);
2813 Move(ptr, s, len, char);
2817 else if (SvNOKp(sv)) {
2818 const int olderrno = errno;
2819 if (SvTYPE(sv) < SVt_PVNV)
2820 sv_upgrade(sv, SVt_PVNV);
2821 /* The +20 is pure guesswork. Configure test needed. --jhi */
2822 s = SvGROW_mutable(sv, NV_DIG + 20);
2823 /* some Xenix systems wipe out errno here */
2825 if (SvNVX(sv) == 0.0)
2826 my_strlcpy(s, "0", SvLEN(sv));
2830 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2833 #ifdef FIXNEGATIVEZERO
2834 if (*s == '-' && s[1] == '0' && !s[2]) {
2846 if (isGV_with_GP(sv))
2847 return glob_2pv((GV *)sv, lp);
2849 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2853 if (SvTYPE(sv) < SVt_PV)
2854 /* Typically the caller expects that sv_any is not NULL now. */
2855 sv_upgrade(sv, SVt_PV);
2859 const STRLEN len = s - SvPVX_const(sv);
2865 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2866 PTR2UV(sv),SvPVX_const(sv)));
2867 if (flags & SV_CONST_RETURN)
2868 return (char *)SvPVX_const(sv);
2869 if (flags & SV_MUTABLE_RETURN)
2870 return SvPVX_mutable(sv);
2875 =for apidoc sv_copypv
2877 Copies a stringified representation of the source SV into the
2878 destination SV. Automatically performs any necessary mg_get and
2879 coercion of numeric values into strings. Guaranteed to preserve
2880 UTF8 flag even from overloaded objects. Similar in nature to
2881 sv_2pv[_flags] but operates directly on an SV instead of just the
2882 string. Mostly uses sv_2pv_flags to do its work, except when that
2883 would lose the UTF-8'ness of the PV.
2889 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2892 const char * const s = SvPV_const(ssv,len);
2893 sv_setpvn(dsv,s,len);
2901 =for apidoc sv_2pvbyte
2903 Return a pointer to the byte-encoded representation of the SV, and set *lp
2904 to its length. May cause the SV to be downgraded from UTF-8 as a
2907 Usually accessed via the C<SvPVbyte> macro.
2913 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2915 sv_utf8_downgrade(sv,0);
2916 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2920 =for apidoc sv_2pvutf8
2922 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2923 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2925 Usually accessed via the C<SvPVutf8> macro.
2931 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2933 sv_utf8_upgrade(sv);
2934 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2939 =for apidoc sv_2bool
2941 This function is only called on magical items, and is only used by
2942 sv_true() or its macro equivalent.
2948 Perl_sv_2bool(pTHX_ register SV *sv)
2957 SV * const tmpsv = AMG_CALLun(sv,bool_);
2958 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2959 return (bool)SvTRUE(tmpsv);
2961 return SvRV(sv) != 0;
2964 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2966 (*sv->sv_u.svu_pv > '0' ||
2967 Xpvtmp->xpv_cur > 1 ||
2968 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2975 return SvIVX(sv) != 0;
2978 return SvNVX(sv) != 0.0;
2980 if (isGV_with_GP(sv))
2990 =for apidoc sv_utf8_upgrade
2992 Converts the PV of an SV to its UTF-8-encoded form.
2993 Forces the SV to string form if it is not already.
2994 Always sets the SvUTF8 flag to avoid future validity checks even
2995 if all the bytes have hibit clear.
2997 This is not as a general purpose byte encoding to Unicode interface:
2998 use the Encode extension for that.
3000 =for apidoc sv_utf8_upgrade_flags
3002 Converts the PV of an SV to its UTF-8-encoded form.
3003 Forces the SV to string form if it is not already.
3004 Always sets the SvUTF8 flag to avoid future validity checks even
3005 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3006 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3007 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3009 This is not as a general purpose byte encoding to Unicode interface:
3010 use the Encode extension for that.
3016 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3019 if (sv == &PL_sv_undef)
3023 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3024 (void) sv_2pv_flags(sv,&len, flags);
3028 (void) SvPV_force(sv,len);
3037 sv_force_normal_flags(sv, 0);
3040 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3041 sv_recode_to_utf8(sv, PL_encoding);
3042 else { /* Assume Latin-1/EBCDIC */
3043 /* This function could be much more efficient if we
3044 * had a FLAG in SVs to signal if there are any hibit
3045 * chars in the PV. Given that there isn't such a flag
3046 * make the loop as fast as possible. */
3047 const U8 * const s = (U8 *) SvPVX_const(sv);
3048 const U8 * const e = (U8 *) SvEND(sv);
3053 /* Check for hi bit */
3054 if (!NATIVE_IS_INVARIANT(ch)) {
3055 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3056 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3058 SvPV_free(sv); /* No longer using what was there before. */
3059 SvPV_set(sv, (char*)recoded);
3060 SvCUR_set(sv, len - 1);
3061 SvLEN_set(sv, len); /* No longer know the real size. */
3065 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3072 =for apidoc sv_utf8_downgrade
3074 Attempts to convert the PV of an SV from characters to bytes.
3075 If the PV contains a character beyond byte, this conversion will fail;
3076 in this case, either returns false or, if C<fail_ok> is not
3079 This is not as a general purpose Unicode to byte encoding interface:
3080 use the Encode extension for that.
3086 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3089 if (SvPOKp(sv) && SvUTF8(sv)) {
3095 sv_force_normal_flags(sv, 0);
3097 s = (U8 *) SvPV(sv, len);
3098 if (!utf8_to_bytes(s, &len)) {
3103 Perl_croak(aTHX_ "Wide character in %s",
3106 Perl_croak(aTHX_ "Wide character");
3117 =for apidoc sv_utf8_encode
3119 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3120 flag off so that it looks like octets again.
3126 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3129 sv_force_normal_flags(sv, 0);
3131 if (SvREADONLY(sv)) {
3132 Perl_croak(aTHX_ PL_no_modify);
3134 (void) sv_utf8_upgrade(sv);
3139 =for apidoc sv_utf8_decode
3141 If the PV of the SV is an octet sequence in UTF-8
3142 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3143 so that it looks like a character. If the PV contains only single-byte
3144 characters, the C<SvUTF8> flag stays being off.
3145 Scans PV for validity and returns false if the PV is invalid UTF-8.
3151 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3157 /* The octets may have got themselves encoded - get them back as
3160 if (!sv_utf8_downgrade(sv, TRUE))
3163 /* it is actually just a matter of turning the utf8 flag on, but
3164 * we want to make sure everything inside is valid utf8 first.
3166 c = (const U8 *) SvPVX_const(sv);
3167 if (!is_utf8_string(c, SvCUR(sv)+1))
3169 e = (const U8 *) SvEND(sv);
3172 if (!UTF8_IS_INVARIANT(ch)) {
3182 =for apidoc sv_setsv
3184 Copies the contents of the source SV C<ssv> into the destination SV
3185 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3186 function if the source SV needs to be reused. Does not handle 'set' magic.
3187 Loosely speaking, it performs a copy-by-value, obliterating any previous
3188 content of the destination.
3190 You probably want to use one of the assortment of wrappers, such as
3191 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3192 C<SvSetMagicSV_nosteal>.
3194 =for apidoc sv_setsv_flags
3196 Copies the contents of the source SV C<ssv> into the destination SV
3197 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3198 function if the source SV needs to be reused. Does not handle 'set' magic.
3199 Loosely speaking, it performs a copy-by-value, obliterating any previous
3200 content of the destination.
3201 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3202 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3203 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3204 and C<sv_setsv_nomg> are implemented in terms of this function.
3206 You probably want to use one of the assortment of wrappers, such as
3207 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3208 C<SvSetMagicSV_nosteal>.
3210 This is the primary function for copying scalars, and most other
3211 copy-ish functions and macros use this underneath.
3217 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3219 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3221 if (dtype != SVt_PVGV) {
3222 const char * const name = GvNAME(sstr);
3223 const STRLEN len = GvNAMELEN(sstr);
3225 if (dtype >= SVt_PV) {
3231 SvUPGRADE(dstr, SVt_PVGV);
3232 (void)SvOK_off(dstr);
3233 /* FIXME - why are we doing this, then turning it off and on again
3235 isGV_with_GP_on(dstr);
3237 GvSTASH(dstr) = GvSTASH(sstr);
3239 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3240 gv_name_set((GV *)dstr, name, len, GV_ADD);
3241 SvFAKE_on(dstr); /* can coerce to non-glob */
3244 #ifdef GV_UNIQUE_CHECK
3245 if (GvUNIQUE((GV*)dstr)) {
3246 Perl_croak(aTHX_ PL_no_modify);
3250 if(GvGP((GV*)sstr)) {
3251 /* If source has method cache entry, clear it */
3253 SvREFCNT_dec(GvCV(sstr));
3257 /* If source has a real method, then a method is
3259 else if(GvCV((GV*)sstr)) {
3264 /* If dest already had a real method, that's a change as well */
3265 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3269 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3273 isGV_with_GP_off(dstr);
3274 (void)SvOK_off(dstr);
3275 isGV_with_GP_on(dstr);
3276 GvINTRO_off(dstr); /* one-shot flag */
3277 GvGP(dstr) = gp_ref(GvGP(sstr));
3278 if (SvTAINTED(sstr))
3280 if (GvIMPORTED(dstr) != GVf_IMPORTED
3281 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3283 GvIMPORTED_on(dstr);
3286 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3287 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3292 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3293 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3295 const int intro = GvINTRO(dstr);
3298 const U32 stype = SvTYPE(sref);
3301 #ifdef GV_UNIQUE_CHECK
3302 if (GvUNIQUE((GV*)dstr)) {
3303 Perl_croak(aTHX_ PL_no_modify);
3308 GvINTRO_off(dstr); /* one-shot flag */
3309 GvLINE(dstr) = CopLINE(PL_curcop);
3310 GvEGV(dstr) = (GV*)dstr;
3315 location = (SV **) &GvCV(dstr);
3316 import_flag = GVf_IMPORTED_CV;
3319 location = (SV **) &GvHV(dstr);
3320 import_flag = GVf_IMPORTED_HV;
3323 location = (SV **) &GvAV(dstr);
3324 import_flag = GVf_IMPORTED_AV;
3327 location = (SV **) &GvIOp(dstr);
3330 location = (SV **) &GvFORM(dstr);
3332 location = &GvSV(dstr);
3333 import_flag = GVf_IMPORTED_SV;
3336 if (stype == SVt_PVCV) {
3337 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3338 if (GvCVGEN(dstr)) {
3339 SvREFCNT_dec(GvCV(dstr));
3341 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3344 SAVEGENERICSV(*location);
3348 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3349 CV* const cv = (CV*)*location;
3351 if (!GvCVGEN((GV*)dstr) &&
3352 (CvROOT(cv) || CvXSUB(cv)))
3354 /* Redefining a sub - warning is mandatory if
3355 it was a const and its value changed. */
3356 if (CvCONST(cv) && CvCONST((CV*)sref)
3357 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3359 /* They are 2 constant subroutines generated from
3360 the same constant. This probably means that
3361 they are really the "same" proxy subroutine
3362 instantiated in 2 places. Most likely this is
3363 when a constant is exported twice. Don't warn.
3366 else if (ckWARN(WARN_REDEFINE)
3368 && (!CvCONST((CV*)sref)
3369 || sv_cmp(cv_const_sv(cv),
3370 cv_const_sv((CV*)sref))))) {
3371 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3374 ? "Constant subroutine %s::%s redefined"
3375 : "Subroutine %s::%s redefined"),
3376 HvNAME_get(GvSTASH((GV*)dstr)),
3377 GvENAME((GV*)dstr));
3381 cv_ckproto_len(cv, (GV*)dstr,
3382 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3383 SvPOK(sref) ? SvCUR(sref) : 0);
3385 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3386 GvASSUMECV_on(dstr);
3387 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3390 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3391 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3392 GvFLAGS(dstr) |= import_flag;
3397 if (SvTAINTED(sstr))
3403 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3406 register U32 sflags;
3408 register svtype stype;
3413 if (SvIS_FREED(dstr)) {
3414 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3415 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3417 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3419 sstr = &PL_sv_undef;
3420 if (SvIS_FREED(sstr)) {
3421 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3422 (void*)sstr, (void*)dstr);
3424 stype = SvTYPE(sstr);
3425 dtype = SvTYPE(dstr);
3427 (void)SvAMAGIC_off(dstr);
3430 /* need to nuke the magic */
3432 SvRMAGICAL_off(dstr);
3435 /* There's a lot of redundancy below but we're going for speed here */
3440 if (dtype != SVt_PVGV) {
3441 (void)SvOK_off(dstr);
3449 sv_upgrade(dstr, SVt_IV);
3453 sv_upgrade(dstr, SVt_PVIV);
3456 goto end_of_first_switch;
3458 (void)SvIOK_only(dstr);
3459 SvIV_set(dstr, SvIVX(sstr));
3462 /* SvTAINTED can only be true if the SV has taint magic, which in
3463 turn means that the SV type is PVMG (or greater). This is the
3464 case statement for SVt_IV, so this cannot be true (whatever gcov
3466 assert(!SvTAINTED(sstr));
3471 if (dtype < SVt_PV && dtype != SVt_IV)
3472 sv_upgrade(dstr, SVt_IV);
3480 sv_upgrade(dstr, SVt_NV);
3484 sv_upgrade(dstr, SVt_PVNV);
3487 goto end_of_first_switch;
3489 SvNV_set(dstr, SvNVX(sstr));
3490 (void)SvNOK_only(dstr);
3491 /* SvTAINTED can only be true if the SV has taint magic, which in
3492 turn means that the SV type is PVMG (or greater). This is the
3493 case statement for SVt_NV, so this cannot be true (whatever gcov
3495 assert(!SvTAINTED(sstr));
3501 #ifdef PERL_OLD_COPY_ON_WRITE
3502 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3503 if (dtype < SVt_PVIV)
3504 sv_upgrade(dstr, SVt_PVIV);
3511 sv_upgrade(dstr, SVt_PV);
3514 if (dtype < SVt_PVIV)
3515 sv_upgrade(dstr, SVt_PVIV);
3518 if (dtype < SVt_PVNV)
3519 sv_upgrade(dstr, SVt_PVNV);
3523 const char * const type = sv_reftype(sstr,0);
3525 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3527 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3531 /* case SVt_BIND: */
3534 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3535 glob_assign_glob(dstr, sstr, dtype);
3538 /* SvVALID means that this PVGV is playing at being an FBM. */
3542 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3544 if (SvTYPE(sstr) != stype) {
3545 stype = SvTYPE(sstr);
3546 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3547 glob_assign_glob(dstr, sstr, dtype);
3552 if (stype == SVt_PVLV)
3553 SvUPGRADE(dstr, SVt_PVNV);
3555 SvUPGRADE(dstr, (svtype)stype);
3557 end_of_first_switch:
3559 /* dstr may have been upgraded. */
3560 dtype = SvTYPE(dstr);
3561 sflags = SvFLAGS(sstr);
3563 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3564 /* Assigning to a subroutine sets the prototype. */
3567 const char *const ptr = SvPV_const(sstr, len);
3569 SvGROW(dstr, len + 1);
3570 Copy(ptr, SvPVX(dstr), len + 1, char);
3571 SvCUR_set(dstr, len);
3573 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3577 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3578 const char * const type = sv_reftype(dstr,0);
3580 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3582 Perl_croak(aTHX_ "Cannot copy to %s", type);
3583 } else if (sflags & SVf_ROK) {
3584 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3585 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3588 if (GvIMPORTED(dstr) != GVf_IMPORTED
3589 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3591 GvIMPORTED_on(dstr);
3596 glob_assign_glob(dstr, sstr, dtype);
3600 if (dtype >= SVt_PV) {
3601 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3602 glob_assign_ref(dstr, sstr);
3605 if (SvPVX_const(dstr)) {
3611 (void)SvOK_off(dstr);
3612 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3613 SvFLAGS(dstr) |= sflags & SVf_ROK;
3614 assert(!(sflags & SVp_NOK));
3615 assert(!(sflags & SVp_IOK));
3616 assert(!(sflags & SVf_NOK));
3617 assert(!(sflags & SVf_IOK));
3619 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3620 if (!(sflags & SVf_OK)) {
3621 if (ckWARN(WARN_MISC))
3622 Perl_warner(aTHX_ packWARN(WARN_MISC),
3623 "Undefined value assigned to typeglob");
3626 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3627 if (dstr != (SV*)gv) {
3630 GvGP(dstr) = gp_ref(GvGP(gv));
3634 else if (sflags & SVp_POK) {
3638 * Check to see if we can just swipe the string. If so, it's a
3639 * possible small lose on short strings, but a big win on long ones.
3640 * It might even be a win on short strings if SvPVX_const(dstr)
3641 * has to be allocated and SvPVX_const(sstr) has to be freed.
3642 * Likewise if we can set up COW rather than doing an actual copy, we
3643 * drop to the else clause, as the swipe code and the COW setup code
3644 * have much in common.
3647 /* Whichever path we take through the next code, we want this true,
3648 and doing it now facilitates the COW check. */
3649 (void)SvPOK_only(dstr);
3652 /* If we're already COW then this clause is not true, and if COW
3653 is allowed then we drop down to the else and make dest COW
3654 with us. If caller hasn't said that we're allowed to COW
3655 shared hash keys then we don't do the COW setup, even if the
3656 source scalar is a shared hash key scalar. */
3657 (((flags & SV_COW_SHARED_HASH_KEYS)
3658 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3659 : 1 /* If making a COW copy is forbidden then the behaviour we
3660 desire is as if the source SV isn't actually already
3661 COW, even if it is. So we act as if the source flags
3662 are not COW, rather than actually testing them. */
3664 #ifndef PERL_OLD_COPY_ON_WRITE
3665 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3666 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3667 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3668 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3669 but in turn, it's somewhat dead code, never expected to go
3670 live, but more kept as a placeholder on how to do it better
3671 in a newer implementation. */
3672 /* If we are COW and dstr is a suitable target then we drop down
3673 into the else and make dest a COW of us. */
3674 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3679 (sflags & SVs_TEMP) && /* slated for free anyway? */
3680 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3681 (!(flags & SV_NOSTEAL)) &&
3682 /* and we're allowed to steal temps */
3683 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3684 SvLEN(sstr) && /* and really is a string */
3685 /* and won't be needed again, potentially */
3686 !(PL_op && PL_op->op_type == OP_AASSIGN))
3687 #ifdef PERL_OLD_COPY_ON_WRITE
3688 && ((flags & SV_COW_SHARED_HASH_KEYS)
3689 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3690 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3691 && SvTYPE(sstr) >= SVt_PVIV))
3695 /* Failed the swipe test, and it's not a shared hash key either.
3696 Have to copy the string. */
3697 STRLEN len = SvCUR(sstr);
3698 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3699 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3700 SvCUR_set(dstr, len);
3701 *SvEND(dstr) = '\0';
3703 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3705 /* Either it's a shared hash key, or it's suitable for
3706 copy-on-write or we can swipe the string. */
3708 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3712 #ifdef PERL_OLD_COPY_ON_WRITE
3714 /* I believe I should acquire a global SV mutex if
3715 it's a COW sv (not a shared hash key) to stop
3716 it going un copy-on-write.
3717 If the source SV has gone un copy on write between up there
3718 and down here, then (assert() that) it is of the correct
3719 form to make it copy on write again */
3720 if ((sflags & (SVf_FAKE | SVf_READONLY))
3721 != (SVf_FAKE | SVf_READONLY)) {
3722 SvREADONLY_on(sstr);
3724 /* Make the source SV into a loop of 1.
3725 (about to become 2) */
3726 SV_COW_NEXT_SV_SET(sstr, sstr);
3730 /* Initial code is common. */
3731 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3736 /* making another shared SV. */
3737 STRLEN cur = SvCUR(sstr);
3738 STRLEN len = SvLEN(sstr);
3739 #ifdef PERL_OLD_COPY_ON_WRITE
3741 assert (SvTYPE(dstr) >= SVt_PVIV);
3742 /* SvIsCOW_normal */
3743 /* splice us in between source and next-after-source. */
3744 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3745 SV_COW_NEXT_SV_SET(sstr, dstr);
3746 SvPV_set(dstr, SvPVX_mutable(sstr));
3750 /* SvIsCOW_shared_hash */
3751 DEBUG_C(PerlIO_printf(Perl_debug_log,
3752 "Copy on write: Sharing hash\n"));
3754 assert (SvTYPE(dstr) >= SVt_PV);
3756 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3758 SvLEN_set(dstr, len);
3759 SvCUR_set(dstr, cur);
3760 SvREADONLY_on(dstr);
3762 /* Relesase a global SV mutex. */
3765 { /* Passes the swipe test. */
3766 SvPV_set(dstr, SvPVX_mutable(sstr));
3767 SvLEN_set(dstr, SvLEN(sstr));
3768 SvCUR_set(dstr, SvCUR(sstr));
3771 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3772 SvPV_set(sstr, NULL);
3778 if (sflags & SVp_NOK) {
3779 SvNV_set(dstr, SvNVX(sstr));
3781 if (sflags & SVp_IOK) {
3783 SvIV_set(dstr, SvIVX(sstr));
3784 /* Must do this otherwise some other overloaded use of 0x80000000
3785 gets confused. I guess SVpbm_VALID */
3786 if (sflags & SVf_IVisUV)
3789 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3791 const MAGIC * const smg = SvVSTRING_mg(sstr);
3793 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3794 smg->mg_ptr, smg->mg_len);
3795 SvRMAGICAL_on(dstr);
3799 else if (sflags & (SVp_IOK|SVp_NOK)) {
3800 (void)SvOK_off(dstr);
3801 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3802 if (sflags & SVp_IOK) {
3803 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3804 SvIV_set(dstr, SvIVX(sstr));
3806 if (sflags & SVp_NOK) {
3807 SvNV_set(dstr, SvNVX(sstr));
3811 if (isGV_with_GP(sstr)) {
3812 /* This stringification rule for globs is spread in 3 places.
3813 This feels bad. FIXME. */
3814 const U32 wasfake = sflags & SVf_FAKE;
3816 /* FAKE globs can get coerced, so need to turn this off
3817 temporarily if it is on. */
3819 gv_efullname3(dstr, (GV *)sstr, "*");
3820 SvFLAGS(sstr) |= wasfake;
3823 (void)SvOK_off(dstr);
3825 if (SvTAINTED(sstr))
3830 =for apidoc sv_setsv_mg
3832 Like C<sv_setsv>, but also handles 'set' magic.
3838 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3840 sv_setsv(dstr,sstr);
3844 #ifdef PERL_OLD_COPY_ON_WRITE
3846 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3848 STRLEN cur = SvCUR(sstr);
3849 STRLEN len = SvLEN(sstr);
3850 register char *new_pv;
3853 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3854 (void*)sstr, (void*)dstr);
3861 if (SvTHINKFIRST(dstr))
3862 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3863 else if (SvPVX_const(dstr))
3864 Safefree(SvPVX_const(dstr));
3868 SvUPGRADE(dstr, SVt_PVIV);
3870 assert (SvPOK(sstr));
3871 assert (SvPOKp(sstr));
3872 assert (!SvIOK(sstr));
3873 assert (!SvIOKp(sstr));
3874 assert (!SvNOK(sstr));
3875 assert (!SvNOKp(sstr));
3877 if (SvIsCOW(sstr)) {
3879 if (SvLEN(sstr) == 0) {
3880 /* source is a COW shared hash key. */
3881 DEBUG_C(PerlIO_printf(Perl_debug_log,
3882 "Fast copy on write: Sharing hash\n"));
3883 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3886 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3888 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3889 SvUPGRADE(sstr, SVt_PVIV);
3890 SvREADONLY_on(sstr);
3892 DEBUG_C(PerlIO_printf(Perl_debug_log,
3893 "Fast copy on write: Converting sstr to COW\n"));
3894 SV_COW_NEXT_SV_SET(dstr, sstr);
3896 SV_COW_NEXT_SV_SET(sstr, dstr);
3897 new_pv = SvPVX_mutable(sstr);
3900 SvPV_set(dstr, new_pv);
3901 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3904 SvLEN_set(dstr, len);
3905 SvCUR_set(dstr, cur);
3914 =for apidoc sv_setpvn
3916 Copies a string into an SV. The C<len> parameter indicates the number of
3917 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3918 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3924 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3927 register char *dptr;
3929 SV_CHECK_THINKFIRST_COW_DROP(sv);
3935 /* len is STRLEN which is unsigned, need to copy to signed */
3938 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3940 SvUPGRADE(sv, SVt_PV);
3942 dptr = SvGROW(sv, len + 1);
3943 Move(ptr,dptr,len,char);
3946 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3951 =for apidoc sv_setpvn_mg
3953 Like C<sv_setpvn>, but also handles 'set' magic.
3959 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3961 sv_setpvn(sv,ptr,len);
3966 =for apidoc sv_setpv
3968 Copies a string into an SV. The string must be null-terminated. Does not
3969 handle 'set' magic. See C<sv_setpv_mg>.
3975 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3978 register STRLEN len;
3980 SV_CHECK_THINKFIRST_COW_DROP(sv);
3986 SvUPGRADE(sv, SVt_PV);
3988 SvGROW(sv, len + 1);
3989 Move(ptr,SvPVX(sv),len+1,char);
3991 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3996 =for apidoc sv_setpv_mg
3998 Like C<sv_setpv>, but also handles 'set' magic.
4004 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4011 =for apidoc sv_usepvn_flags
4013 Tells an SV to use C<ptr> to find its string value. Normally the
4014 string is stored inside the SV but sv_usepvn allows the SV to use an
4015 outside string. The C<ptr> should point to memory that was allocated
4016 by C<malloc>. The string length, C<len>, must be supplied. By default
4017 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4018 so that pointer should not be freed or used by the programmer after
4019 giving it to sv_usepvn, and neither should any pointers from "behind"
4020 that pointer (e.g. ptr + 1) be used.
4022 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4023 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4024 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4025 C<len>, and already meets the requirements for storing in C<SvPVX>)
4031 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4035 SV_CHECK_THINKFIRST_COW_DROP(sv);
4036 SvUPGRADE(sv, SVt_PV);
4039 if (flags & SV_SMAGIC)
4043 if (SvPVX_const(sv))
4047 if (flags & SV_HAS_TRAILING_NUL)
4048 assert(ptr[len] == '\0');
4051 allocate = (flags & SV_HAS_TRAILING_NUL)
4052 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4053 if (flags & SV_HAS_TRAILING_NUL) {
4054 /* It's long enough - do nothing.
4055 Specfically Perl_newCONSTSUB is relying on this. */
4058 /* Force a move to shake out bugs in callers. */
4059 char *new_ptr = (char*)safemalloc(allocate);
4060 Copy(ptr, new_ptr, len, char);
4061 PoisonFree(ptr,len,char);
4065 ptr = (char*) saferealloc (ptr, allocate);
4070 SvLEN_set(sv, allocate);
4071 if (!(flags & SV_HAS_TRAILING_NUL)) {
4074 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4076 if (flags & SV_SMAGIC)
4080 #ifdef PERL_OLD_COPY_ON_WRITE
4081 /* Need to do this *after* making the SV normal, as we need the buffer
4082 pointer to remain valid until after we've copied it. If we let go too early,
4083 another thread could invalidate it by unsharing last of the same hash key
4084 (which it can do by means other than releasing copy-on-write Svs)
4085 or by changing the other copy-on-write SVs in the loop. */
4087 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4089 { /* this SV was SvIsCOW_normal(sv) */
4090 /* we need to find the SV pointing to us. */
4091 SV *current = SV_COW_NEXT_SV(after);
4093 if (current == sv) {
4094 /* The SV we point to points back to us (there were only two of us
4096 Hence other SV is no longer copy on write either. */
4098 SvREADONLY_off(after);
4100 /* We need to follow the pointers around the loop. */
4102 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4105 /* don't loop forever if the structure is bust, and we have
4106 a pointer into a closed loop. */
4107 assert (current != after);
4108 assert (SvPVX_const(current) == pvx);
4110 /* Make the SV before us point to the SV after us. */
4111 SV_COW_NEXT_SV_SET(current, after);
4117 =for apidoc sv_force_normal_flags
4119 Undo various types of fakery on an SV: if the PV is a shared string, make
4120 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4121 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4122 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4123 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4124 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4125 set to some other value.) In addition, the C<flags> parameter gets passed to
4126 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4127 with flags set to 0.
4133 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4136 #ifdef PERL_OLD_COPY_ON_WRITE
4137 if (SvREADONLY(sv)) {
4138 /* At this point I believe I should acquire a global SV mutex. */
4140 const char * const pvx = SvPVX_const(sv);
4141 const STRLEN len = SvLEN(sv);
4142 const STRLEN cur = SvCUR(sv);
4143 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4144 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4145 we'll fail an assertion. */
4146 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4149 PerlIO_printf(Perl_debug_log,
4150 "Copy on write: Force normal %ld\n",
4156 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4159 if (flags & SV_COW_DROP_PV) {
4160 /* OK, so we don't need to copy our buffer. */
4163 SvGROW(sv, cur + 1);
4164 Move(pvx,SvPVX(sv),cur,char);
4169 sv_release_COW(sv, pvx, next);
4171 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4177 else if (IN_PERL_RUNTIME)
4178 Perl_croak(aTHX_ PL_no_modify);
4179 /* At this point I believe that I can drop the global SV mutex. */
4182 if (SvREADONLY(sv)) {
4184 const char * const pvx = SvPVX_const(sv);
4185 const STRLEN len = SvCUR(sv);
4190 SvGROW(sv, len + 1);
4191 Move(pvx,SvPVX(sv),len,char);
4193 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4195 else if (IN_PERL_RUNTIME)
4196 Perl_croak(aTHX_ PL_no_modify);
4200 sv_unref_flags(sv, flags);
4201 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4208 Efficient removal of characters from the beginning of the string buffer.
4209 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4210 the string buffer. The C<ptr> becomes the first character of the adjusted
4211 string. Uses the "OOK hack".
4212 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4213 refer to the same chunk of data.
4219 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4221 register STRLEN delta;
4222 if (!ptr || !SvPOKp(sv))
4224 delta = ptr - SvPVX_const(sv);
4226 /* Nothing to do. */
4229 assert(ptr > SvPVX_const(sv));
4230 SV_CHECK_THINKFIRST(sv);
4231 if (SvTYPE(sv) < SVt_PVIV)
4232 sv_upgrade(sv,SVt_PVIV);
4235 if (!SvLEN(sv)) { /* make copy of shared string */
4236 const char *pvx = SvPVX_const(sv);
4237 const STRLEN len = SvCUR(sv);
4238 SvGROW(sv, len + 1);
4239 Move(pvx,SvPVX(sv),len,char);
4243 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4244 and we do that anyway inside the SvNIOK_off
4246 SvFLAGS(sv) |= SVf_OOK;
4249 SvLEN_set(sv, SvLEN(sv) - delta);
4250 SvCUR_set(sv, SvCUR(sv) - delta);
4251 SvPV_set(sv, SvPVX(sv) + delta);
4252 SvIV_set(sv, SvIVX(sv) + delta);
4255 /* Fill the preceding buffer with sentinals to verify that no-one is
4257 U8 *p = (U8*) SvPVX(sv);
4258 const U8 *const real_start = p - SvIVX(sv);
4259 while (p > real_start) {
4268 =for apidoc sv_catpvn
4270 Concatenates the string onto the end of the string which is in the SV. The
4271 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4272 status set, then the bytes appended should be valid UTF-8.
4273 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4275 =for apidoc sv_catpvn_flags
4277 Concatenates the string onto the end of the string which is in the SV. The
4278 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4279 status set, then the bytes appended should be valid UTF-8.
4280 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4281 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4282 in terms of this function.
4288 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4292 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4294 SvGROW(dsv, dlen + slen + 1);
4296 sstr = SvPVX_const(dsv);
4297 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4298 SvCUR_set(dsv, SvCUR(dsv) + slen);
4300 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4302 if (flags & SV_SMAGIC)
4307 =for apidoc sv_catsv
4309 Concatenates the string from SV C<ssv> onto the end of the string in
4310 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4311 not 'set' magic. See C<sv_catsv_mg>.
4313 =for apidoc sv_catsv_flags
4315 Concatenates the string from SV C<ssv> onto the end of the string in
4316 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4317 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4318 and C<sv_catsv_nomg> are implemented in terms of this function.
4323 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4328 const char *spv = SvPV_const(ssv, slen);
4330 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4331 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4332 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4333 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4334 dsv->sv_flags doesn't have that bit set.
4335 Andy Dougherty 12 Oct 2001
4337 const I32 sutf8 = DO_UTF8(ssv);
4340 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4342 dutf8 = DO_UTF8(dsv);
4344 if (dutf8 != sutf8) {
4346 /* Not modifying source SV, so taking a temporary copy. */
4347 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4349 sv_utf8_upgrade(csv);
4350 spv = SvPV_const(csv, slen);
4353 sv_utf8_upgrade_nomg(dsv);
4355 sv_catpvn_nomg(dsv, spv, slen);
4358 if (flags & SV_SMAGIC)
4363 =for apidoc sv_catpv
4365 Concatenates the string onto the end of the string which is in the SV.
4366 If the SV has the UTF-8 status set, then the bytes appended should be
4367 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4372 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4375 register STRLEN len;
4381 junk = SvPV_force(sv, tlen);
4383 SvGROW(sv, tlen + len + 1);
4385 ptr = SvPVX_const(sv);
4386 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4387 SvCUR_set(sv, SvCUR(sv) + len);
4388 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4393 =for apidoc sv_catpv_mg
4395 Like C<sv_catpv>, but also handles 'set' magic.
4401 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4410 Creates a new SV. A non-zero C<len> parameter indicates the number of
4411 bytes of preallocated string space the SV should have. An extra byte for a
4412 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4413 space is allocated.) The reference count for the new SV is set to 1.
4415 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4416 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4417 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4418 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4419 modules supporting older perls.
4425 Perl_newSV(pTHX_ STRLEN len)
4432 sv_upgrade(sv, SVt_PV);
4433 SvGROW(sv, len + 1);
4438 =for apidoc sv_magicext
4440 Adds magic to an SV, upgrading it if necessary. Applies the
4441 supplied vtable and returns a pointer to the magic added.
4443 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4444 In particular, you can add magic to SvREADONLY SVs, and add more than
4445 one instance of the same 'how'.
4447 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4448 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4449 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4450 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4452 (This is now used as a subroutine by C<sv_magic>.)
4457 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4458 const char* name, I32 namlen)
4463 SvUPGRADE(sv, SVt_PVMG);
4464 Newxz(mg, 1, MAGIC);
4465 mg->mg_moremagic = SvMAGIC(sv);
4466 SvMAGIC_set(sv, mg);
4468 /* Sometimes a magic contains a reference loop, where the sv and
4469 object refer to each other. To prevent a reference loop that
4470 would prevent such objects being freed, we look for such loops
4471 and if we find one we avoid incrementing the object refcount.
4473 Note we cannot do this to avoid self-tie loops as intervening RV must
4474 have its REFCNT incremented to keep it in existence.
4477 if (!obj || obj == sv ||
4478 how == PERL_MAGIC_arylen ||
4479 how == PERL_MAGIC_symtab ||
4480 (SvTYPE(obj) == SVt_PVGV &&
4481 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4482 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4483 GvFORM(obj) == (CV*)sv)))
4488 mg->mg_obj = SvREFCNT_inc_simple(obj);
4489 mg->mg_flags |= MGf_REFCOUNTED;
4492 /* Normal self-ties simply pass a null object, and instead of
4493 using mg_obj directly, use the SvTIED_obj macro to produce a
4494 new RV as needed. For glob "self-ties", we are tieing the PVIO
4495 with an RV obj pointing to the glob containing the PVIO. In
4496 this case, to avoid a reference loop, we need to weaken the
4500 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4501 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4507 mg->mg_len = namlen;
4510 mg->mg_ptr = savepvn(name, namlen);
4511 else if (namlen == HEf_SVKEY)
4512 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4514 mg->mg_ptr = (char *) name;
4516 mg->mg_virtual = (MGVTBL *) vtable;
4520 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4525 =for apidoc sv_magic
4527 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4528 then adds a new magic item of type C<how> to the head of the magic list.
4530 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4531 handling of the C<name> and C<namlen> arguments.
4533 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4534 to add more than one instance of the same 'how'.
4540 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4543 const MGVTBL *vtable;
4546 #ifdef PERL_OLD_COPY_ON_WRITE
4548 sv_force_normal_flags(sv, 0);
4550 if (SvREADONLY(sv)) {
4552 /* its okay to attach magic to shared strings; the subsequent
4553 * upgrade to PVMG will unshare the string */
4554 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4557 && how != PERL_MAGIC_regex_global
4558 && how != PERL_MAGIC_bm
4559 && how != PERL_MAGIC_fm
4560 && how != PERL_MAGIC_sv
4561 && how != PERL_MAGIC_backref
4564 Perl_croak(aTHX_ PL_no_modify);
4567 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4568 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4569 /* sv_magic() refuses to add a magic of the same 'how' as an
4572 if (how == PERL_MAGIC_taint) {
4574 /* Any scalar which already had taint magic on which someone
4575 (erroneously?) did SvIOK_on() or similar will now be
4576 incorrectly sporting public "OK" flags. */
4577 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4585 vtable = &PL_vtbl_sv;
4587 case PERL_MAGIC_overload:
4588 vtable = &PL_vtbl_amagic;
4590 case PERL_MAGIC_overload_elem:
4591 vtable = &PL_vtbl_amagicelem;
4593 case PERL_MAGIC_overload_table:
4594 vtable = &PL_vtbl_ovrld;
4597 vtable = &PL_vtbl_bm;
4599 case PERL_MAGIC_regdata:
4600 vtable = &PL_vtbl_regdata;
4602 case PERL_MAGIC_regdatum:
4603 vtable = &PL_vtbl_regdatum;
4605 case PERL_MAGIC_env:
4606 vtable = &PL_vtbl_env;
4609 vtable = &PL_vtbl_fm;
4611 case PERL_MAGIC_envelem:
4612 vtable = &PL_vtbl_envelem;
4614 case PERL_MAGIC_regex_global:
4615 vtable = &PL_vtbl_mglob;
4617 case PERL_MAGIC_isa:
4618 vtable = &PL_vtbl_isa;
4620 case PERL_MAGIC_isaelem:
4621 vtable = &PL_vtbl_isaelem;
4623 case PERL_MAGIC_nkeys:
4624 vtable = &PL_vtbl_nkeys;
4626 case PERL_MAGIC_dbfile:
4629 case PERL_MAGIC_dbline:
4630 vtable = &PL_vtbl_dbline;
4632 #ifdef USE_LOCALE_COLLATE
4633 case PERL_MAGIC_collxfrm:
4634 vtable = &PL_vtbl_collxfrm;
4636 #endif /* USE_LOCALE_COLLATE */
4637 case PERL_MAGIC_tied:
4638 vtable = &PL_vtbl_pack;
4640 case PERL_MAGIC_tiedelem:
4641 case PERL_MAGIC_tiedscalar:
4642 vtable = &PL_vtbl_packelem;
4645 vtable = &PL_vtbl_regexp;
4647 case PERL_MAGIC_hints:
4648 /* As this vtable is all NULL, we can reuse it. */
4649 case PERL_MAGIC_sig:
4650 vtable = &PL_vtbl_sig;
4652 case PERL_MAGIC_sigelem:
4653 vtable = &PL_vtbl_sigelem;
4655 case PERL_MAGIC_taint:
4656 vtable = &PL_vtbl_taint;
4658 case PERL_MAGIC_uvar:
4659 vtable = &PL_vtbl_uvar;
4661 case PERL_MAGIC_vec:
4662 vtable = &PL_vtbl_vec;
4664 case PERL_MAGIC_arylen_p:
4665 case PERL_MAGIC_rhash:
4666 case PERL_MAGIC_symtab:
4667 case PERL_MAGIC_vstring:
4670 case PERL_MAGIC_utf8:
4671 vtable = &PL_vtbl_utf8;
4673 case PERL_MAGIC_substr:
4674 vtable = &PL_vtbl_substr;
4676 case PERL_MAGIC_defelem:
4677 vtable = &PL_vtbl_defelem;
4679 case PERL_MAGIC_arylen:
4680 vtable = &PL_vtbl_arylen;
4682 case PERL_MAGIC_pos:
4683 vtable = &PL_vtbl_pos;
4685 case PERL_MAGIC_backref:
4686 vtable = &PL_vtbl_backref;
4688 case PERL_MAGIC_hintselem:
4689 vtable = &PL_vtbl_hintselem;
4691 case PERL_MAGIC_ext:
4692 /* Reserved for use by extensions not perl internals. */
4693 /* Useful for attaching extension internal data to perl vars. */
4694 /* Note that multiple extensions may clash if magical scalars */
4695 /* etc holding private data from one are passed to another. */
4699 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4702 /* Rest of work is done else where */
4703 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4706 case PERL_MAGIC_taint:
4709 case PERL_MAGIC_ext:
4710 case PERL_MAGIC_dbfile:
4717 =for apidoc sv_unmagic
4719 Removes all magic of type C<type> from an SV.
4725 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4729 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4731 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4732 for (mg = *mgp; mg; mg = *mgp) {
4733 if (mg->mg_type == type) {
4734 const MGVTBL* const vtbl = mg->mg_virtual;
4735 *mgp = mg->mg_moremagic;
4736 if (vtbl && vtbl->svt_free)
4737 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4738 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4740 Safefree(mg->mg_ptr);
4741 else if (mg->mg_len == HEf_SVKEY)
4742 SvREFCNT_dec((SV*)mg->mg_ptr);
4743 else if (mg->mg_type == PERL_MAGIC_utf8)
4744 Safefree(mg->mg_ptr);
4746 if (mg->mg_flags & MGf_REFCOUNTED)
4747 SvREFCNT_dec(mg->mg_obj);
4751 mgp = &mg->mg_moremagic;
4755 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4756 SvMAGIC_set(sv, NULL);
4763 =for apidoc sv_rvweaken
4765 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4766 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4767 push a back-reference to this RV onto the array of backreferences
4768 associated with that magic. If the RV is magical, set magic will be
4769 called after the RV is cleared.
4775 Perl_sv_rvweaken(pTHX_ SV *sv)
4778 if (!SvOK(sv)) /* let undefs pass */
4781 Perl_croak(aTHX_ "Can't weaken a nonreference");
4782 else if (SvWEAKREF(sv)) {
4783 if (ckWARN(WARN_MISC))
4784 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4788 Perl_sv_add_backref(aTHX_ tsv, sv);
4794 /* Give tsv backref magic if it hasn't already got it, then push a
4795 * back-reference to sv onto the array associated with the backref magic.
4799 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4804 if (SvTYPE(tsv) == SVt_PVHV) {
4805 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4809 /* There is no AV in the offical place - try a fixup. */
4810 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4813 /* Aha. They've got it stowed in magic. Bring it back. */
4814 av = (AV*)mg->mg_obj;
4815 /* Stop mg_free decreasing the refernce count. */
4817 /* Stop mg_free even calling the destructor, given that
4818 there's no AV to free up. */
4820 sv_unmagic(tsv, PERL_MAGIC_backref);
4824 SvREFCNT_inc_simple_void(av);
4829 const MAGIC *const mg
4830 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4832 av = (AV*)mg->mg_obj;
4836 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4837 /* av now has a refcnt of 2, which avoids it getting freed
4838 * before us during global cleanup. The extra ref is removed
4839 * by magic_killbackrefs() when tsv is being freed */
4842 if (AvFILLp(av) >= AvMAX(av)) {
4843 av_extend(av, AvFILLp(av)+1);
4845 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4848 /* delete a back-reference to ourselves from the backref magic associated
4849 * with the SV we point to.
4853 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4860 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4861 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4862 /* We mustn't attempt to "fix up" the hash here by moving the
4863 backreference array back to the hv_aux structure, as that is stored
4864 in the main HvARRAY(), and hfreentries assumes that no-one
4865 reallocates HvARRAY() while it is running. */
4868 const MAGIC *const mg
4869 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4871 av = (AV *)mg->mg_obj;
4874 if (PL_in_clean_all)
4876 Perl_croak(aTHX_ "panic: del_backref");
4883 /* We shouldn't be in here more than once, but for paranoia reasons lets
4885 for (i = AvFILLp(av); i >= 0; i--) {
4887 const SSize_t fill = AvFILLp(av);
4889 /* We weren't the last entry.
4890 An unordered list has this property that you can take the
4891 last element off the end to fill the hole, and it's still
4892 an unordered list :-)
4897 AvFILLp(av) = fill - 1;
4903 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4905 SV **svp = AvARRAY(av);
4907 PERL_UNUSED_ARG(sv);
4909 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4910 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4911 if (svp && !SvIS_FREED(av)) {
4912 SV *const *const last = svp + AvFILLp(av);
4914 while (svp <= last) {
4916 SV *const referrer = *svp;
4917 if (SvWEAKREF(referrer)) {
4918 /* XXX Should we check that it hasn't changed? */
4919 SvRV_set(referrer, 0);
4921 SvWEAKREF_off(referrer);
4922 SvSETMAGIC(referrer);
4923 } else if (SvTYPE(referrer) == SVt_PVGV ||
4924 SvTYPE(referrer) == SVt_PVLV) {
4925 /* You lookin' at me? */
4926 assert(GvSTASH(referrer));
4927 assert(GvSTASH(referrer) == (HV*)sv);
4928 GvSTASH(referrer) = 0;
4931 "panic: magic_killbackrefs (flags=%"UVxf")",
4932 (UV)SvFLAGS(referrer));
4940 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4945 =for apidoc sv_insert
4947 Inserts a string at the specified offset/length within the SV. Similar to
4948 the Perl substr() function.
4954 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4959 register char *midend;
4960 register char *bigend;
4966 Perl_croak(aTHX_ "Can't modify non-existent substring");
4967 SvPV_force(bigstr, curlen);
4968 (void)SvPOK_only_UTF8(bigstr);
4969 if (offset + len > curlen) {
4970 SvGROW(bigstr, offset+len+1);
4971 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4972 SvCUR_set(bigstr, offset+len);
4976 i = littlelen - len;
4977 if (i > 0) { /* string might grow */
4978 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4979 mid = big + offset + len;
4980 midend = bigend = big + SvCUR(bigstr);
4983 while (midend > mid) /* shove everything down */
4984 *--bigend = *--midend;
4985 Move(little,big+offset,littlelen,char);
4986 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4991 Move(little,SvPVX(bigstr)+offset,len,char);
4996 big = SvPVX(bigstr);
4999 bigend = big + SvCUR(bigstr);
5001 if (midend > bigend)
5002 Perl_croak(aTHX_ "panic: sv_insert");
5004 if (mid - big > bigend - midend) { /* faster to shorten from end */
5006 Move(little, mid, littlelen,char);
5009 i = bigend - midend;
5011 Move(midend, mid, i,char);
5015 SvCUR_set(bigstr, mid - big);
5017 else if ((i = mid - big)) { /* faster from front */
5018 midend -= littlelen;
5020 Move(big, midend - i, i, char);
5021 sv_chop(bigstr,midend-i);
5023 Move(little, mid, littlelen,char);
5025 else if (littlelen) {
5026 midend -= littlelen;
5027 sv_chop(bigstr,midend);
5028 Move(little,midend,littlelen,char);
5031 sv_chop(bigstr,midend);
5037 =for apidoc sv_replace
5039 Make the first argument a copy of the second, then delete the original.
5040 The target SV physically takes over ownership of the body of the source SV
5041 and inherits its flags; however, the target keeps any magic it owns,
5042 and any magic in the source is discarded.
5043 Note that this is a rather specialist SV copying operation; most of the
5044 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5050 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5053 const U32 refcnt = SvREFCNT(sv);
5054 SV_CHECK_THINKFIRST_COW_DROP(sv);
5055 if (SvREFCNT(nsv) != 1) {
5056 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5057 UVuf " != 1)", (UV) SvREFCNT(nsv));
5059 if (SvMAGICAL(sv)) {
5063 sv_upgrade(nsv, SVt_PVMG);
5064 SvMAGIC_set(nsv, SvMAGIC(sv));
5065 SvFLAGS(nsv) |= SvMAGICAL(sv);
5067 SvMAGIC_set(sv, NULL);
5071 assert(!SvREFCNT(sv));
5072 #ifdef DEBUG_LEAKING_SCALARS
5073 sv->sv_flags = nsv->sv_flags;
5074 sv->sv_any = nsv->sv_any;
5075 sv->sv_refcnt = nsv->sv_refcnt;
5076 sv->sv_u = nsv->sv_u;
5078 StructCopy(nsv,sv,SV);
5080 if(SvTYPE(sv) == SVt_IV) {
5082 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5086 #ifdef PERL_OLD_COPY_ON_WRITE
5087 if (SvIsCOW_normal(nsv)) {
5088 /* We need to follow the pointers around the loop to make the
5089 previous SV point to sv, rather than nsv. */
5092 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5095 assert(SvPVX_const(current) == SvPVX_const(nsv));
5097 /* Make the SV before us point to the SV after us. */
5099 PerlIO_printf(Perl_debug_log, "previous is\n");
5101 PerlIO_printf(Perl_debug_log,
5102 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5103 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5105 SV_COW_NEXT_SV_SET(current, sv);
5108 SvREFCNT(sv) = refcnt;
5109 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5115 =for apidoc sv_clear
5117 Clear an SV: call any destructors, free up any memory used by the body,
5118 and free the body itself. The SV's head is I<not> freed, although
5119 its type is set to all 1's so that it won't inadvertently be assumed
5120 to be live during global destruction etc.
5121 This function should only be called when REFCNT is zero. Most of the time
5122 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5129 Perl_sv_clear(pTHX_ register SV *sv)
5132 const U32 type = SvTYPE(sv);
5133 const struct body_details *const sv_type_details
5134 = bodies_by_type + type;
5138 assert(SvREFCNT(sv) == 0);
5139 assert(SvTYPE(sv) != SVTYPEMASK);
5141 if (type <= SVt_IV) {
5142 /* See the comment in sv.h about the collusion between this early
5143 return and the overloading of the NULL and IV slots in the size
5146 SV * const target = SvRV(sv);
5148 sv_del_backref(target, sv);
5150 SvREFCNT_dec(target);
5152 SvFLAGS(sv) &= SVf_BREAK;
5153 SvFLAGS(sv) |= SVTYPEMASK;
5158 if (PL_defstash && /* Still have a symbol table? */
5165 stash = SvSTASH(sv);
5166 destructor = StashHANDLER(stash,DESTROY);
5168 SV* const tmpref = newRV(sv);
5169 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5171 PUSHSTACKi(PERLSI_DESTROY);
5176 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5182 if(SvREFCNT(tmpref) < 2) {
5183 /* tmpref is not kept alive! */
5185 SvRV_set(tmpref, NULL);
5188 SvREFCNT_dec(tmpref);
5190 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5194 if (PL_in_clean_objs)
5195 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5197 /* DESTROY gave object new lease on life */
5203 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5204 SvOBJECT_off(sv); /* Curse the object. */
5205 if (type != SVt_PVIO)
5206 --PL_sv_objcount; /* XXX Might want something more general */
5209 if (type >= SVt_PVMG) {
5210 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5211 SvREFCNT_dec(SvOURSTASH(sv));
5212 } else if (SvMAGIC(sv))
5214 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5215 SvREFCNT_dec(SvSTASH(sv));
5218 /* case SVt_BIND: */
5221 IoIFP(sv) != PerlIO_stdin() &&
5222 IoIFP(sv) != PerlIO_stdout() &&
5223 IoIFP(sv) != PerlIO_stderr())
5225 io_close((IO*)sv, FALSE);
5227 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5228 PerlDir_close(IoDIRP(sv));
5229 IoDIRP(sv) = (DIR*)NULL;
5230 Safefree(IoTOP_NAME(sv));
5231 Safefree(IoFMT_NAME(sv));
5232 Safefree(IoBOTTOM_NAME(sv));
5235 /* FIXME for plugins */
5243 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5247 if (PL_comppad == (AV*)sv) {
5254 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5255 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5256 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5257 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5259 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5260 SvREFCNT_dec(LvTARG(sv));
5262 if (isGV_with_GP(sv)) {
5263 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5264 mro_method_changed_in(stash);
5267 unshare_hek(GvNAME_HEK(sv));
5268 /* If we're in a stash, we don't own a reference to it. However it does
5269 have a back reference to us, which needs to be cleared. */
5270 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5271 sv_del_backref((SV*)stash, sv);
5273 /* FIXME. There are probably more unreferenced pointers to SVs in the
5274 interpreter struct that we should check and tidy in a similar
5276 if ((GV*)sv == PL_last_in_gv)
5277 PL_last_in_gv = NULL;
5282 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5284 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5285 /* Don't even bother with turning off the OOK flag. */
5289 SV * const target = SvRV(sv);
5291 sv_del_backref(target, sv);
5293 SvREFCNT_dec(target);
5295 #ifdef PERL_OLD_COPY_ON_WRITE
5296 else if (SvPVX_const(sv)) {
5298 /* I believe I need to grab the global SV mutex here and
5299 then recheck the COW status. */
5301 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5305 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5307 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5310 /* And drop it here. */
5312 } else if (SvLEN(sv)) {
5313 Safefree(SvPVX_const(sv));
5317 else if (SvPVX_const(sv) && SvLEN(sv))
5318 Safefree(SvPVX_mutable(sv));
5319 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5320 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5329 SvFLAGS(sv) &= SVf_BREAK;
5330 SvFLAGS(sv) |= SVTYPEMASK;
5332 if (sv_type_details->arena) {
5333 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5334 &PL_body_roots[type]);
5336 else if (sv_type_details->body_size) {
5337 my_safefree(SvANY(sv));
5342 =for apidoc sv_newref
5344 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5351 Perl_sv_newref(pTHX_ SV *sv)
5353 PERL_UNUSED_CONTEXT;
5362 Decrement an SV's reference count, and if it drops to zero, call
5363 C<sv_clear> to invoke destructors and free up any memory used by
5364 the body; finally, deallocate the SV's head itself.
5365 Normally called via a wrapper macro C<SvREFCNT_dec>.
5371 Perl_sv_free(pTHX_ SV *sv)
5376 if (SvREFCNT(sv) == 0) {
5377 if (SvFLAGS(sv) & SVf_BREAK)
5378 /* this SV's refcnt has been artificially decremented to
5379 * trigger cleanup */
5381 if (PL_in_clean_all) /* All is fair */
5383 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5384 /* make sure SvREFCNT(sv)==0 happens very seldom */
5385 SvREFCNT(sv) = (~(U32)0)/2;
5388 if (ckWARN_d(WARN_INTERNAL)) {
5389 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5390 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5391 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5392 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5393 Perl_dump_sv_child(aTHX_ sv);
5395 #ifdef DEBUG_LEAKING_SCALARS
5402 if (--(SvREFCNT(sv)) > 0)
5404 Perl_sv_free2(aTHX_ sv);
5408 Perl_sv_free2(pTHX_ SV *sv)
5413 if (ckWARN_d(WARN_DEBUGGING))
5414 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5415 "Attempt to free temp prematurely: SV 0x%"UVxf
5416 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5420 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5421 /* make sure SvREFCNT(sv)==0 happens very seldom */
5422 SvREFCNT(sv) = (~(U32)0)/2;
5433 Returns the length of the string in the SV. Handles magic and type
5434 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5440 Perl_sv_len(pTHX_ register SV *sv)
5448 len = mg_length(sv);
5450 (void)SvPV_const(sv, len);
5455 =for apidoc sv_len_utf8
5457 Returns the number of characters in the string in an SV, counting wide
5458 UTF-8 bytes as a single character. Handles magic and type coercion.
5464 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5465 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5466 * (Note that the mg_len is not the length of the mg_ptr field.
5467 * This allows the cache to store the character length of the string without
5468 * needing to malloc() extra storage to attach to the mg_ptr.)
5473 Perl_sv_len_utf8(pTHX_ register SV *sv)
5479 return mg_length(sv);
5483 const U8 *s = (U8*)SvPV_const(sv, len);
5487 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5489 if (mg && mg->mg_len != -1) {
5491 if (PL_utf8cache < 0) {
5492 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5494 /* Need to turn the assertions off otherwise we may
5495 recurse infinitely while printing error messages.
5497 SAVEI8(PL_utf8cache);
5499 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5500 " real %"UVuf" for %"SVf,
5501 (UV) ulen, (UV) real, SVfARG(sv));
5506 ulen = Perl_utf8_length(aTHX_ s, s + len);
5507 if (!SvREADONLY(sv)) {
5509 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5510 &PL_vtbl_utf8, 0, 0);
5518 return Perl_utf8_length(aTHX_ s, s + len);
5522 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5525 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5528 const U8 *s = start;
5530 while (s < send && uoffset--)
5533 /* This is the existing behaviour. Possibly it should be a croak, as
5534 it's actually a bounds error */
5540 /* Given the length of the string in both bytes and UTF-8 characters, decide
5541 whether to walk forwards or backwards to find the byte corresponding to
5542 the passed in UTF-8 offset. */
5544 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5545 STRLEN uoffset, STRLEN uend)
5547 STRLEN backw = uend - uoffset;
5548 if (uoffset < 2 * backw) {
5549 /* The assumption is that going forwards is twice the speed of going
5550 forward (that's where the 2 * backw comes from).
5551 (The real figure of course depends on the UTF-8 data.) */
5552 return sv_pos_u2b_forwards(start, send, uoffset);
5557 while (UTF8_IS_CONTINUATION(*send))
5560 return send - start;
5563 /* For the string representation of the given scalar, find the byte
5564 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5565 give another position in the string, *before* the sought offset, which
5566 (which is always true, as 0, 0 is a valid pair of positions), which should
5567 help reduce the amount of linear searching.
5568 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5569 will be used to reduce the amount of linear searching. The cache will be
5570 created if necessary, and the found value offered to it for update. */
5572 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5573 const U8 *const send, STRLEN uoffset,
5574 STRLEN uoffset0, STRLEN boffset0) {
5575 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5578 assert (uoffset >= uoffset0);
5580 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5581 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5582 if ((*mgp)->mg_ptr) {
5583 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5584 if (cache[0] == uoffset) {
5585 /* An exact match. */
5588 if (cache[2] == uoffset) {
5589 /* An exact match. */
5593 if (cache[0] < uoffset) {
5594 /* The cache already knows part of the way. */
5595 if (cache[0] > uoffset0) {
5596 /* The cache knows more than the passed in pair */
5597 uoffset0 = cache[0];
5598 boffset0 = cache[1];
5600 if ((*mgp)->mg_len != -1) {
5601 /* And we know the end too. */
5603 + sv_pos_u2b_midway(start + boffset0, send,
5605 (*mgp)->mg_len - uoffset0);
5608 + sv_pos_u2b_forwards(start + boffset0,
5609 send, uoffset - uoffset0);
5612 else if (cache[2] < uoffset) {
5613 /* We're between the two cache entries. */
5614 if (cache[2] > uoffset0) {
5615 /* and the cache knows more than the passed in pair */
5616 uoffset0 = cache[2];
5617 boffset0 = cache[3];
5621 + sv_pos_u2b_midway(start + boffset0,
5624 cache[0] - uoffset0);
5627 + sv_pos_u2b_midway(start + boffset0,
5630 cache[2] - uoffset0);
5634 else if ((*mgp)->mg_len != -1) {
5635 /* If we can take advantage of a passed in offset, do so. */
5636 /* In fact, offset0 is either 0, or less than offset, so don't
5637 need to worry about the other possibility. */
5639 + sv_pos_u2b_midway(start + boffset0, send,
5641 (*mgp)->mg_len - uoffset0);
5646 if (!found || PL_utf8cache < 0) {
5647 const STRLEN real_boffset
5648 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5649 send, uoffset - uoffset0);
5651 if (found && PL_utf8cache < 0) {
5652 if (real_boffset != boffset) {
5653 /* Need to turn the assertions off otherwise we may recurse
5654 infinitely while printing error messages. */
5655 SAVEI8(PL_utf8cache);
5657 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5658 " real %"UVuf" for %"SVf,
5659 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5662 boffset = real_boffset;
5665 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5671 =for apidoc sv_pos_u2b
5673 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5674 the start of the string, to a count of the equivalent number of bytes; if
5675 lenp is non-zero, it does the same to lenp, but this time starting from
5676 the offset, rather than from the start of the string. Handles magic and
5683 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5684 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5685 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5690 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5698 start = (U8*)SvPV_const(sv, len);
5700 STRLEN uoffset = (STRLEN) *offsetp;
5701 const U8 * const send = start + len;
5703 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5706 *offsetp = (I32) boffset;
5709 /* Convert the relative offset to absolute. */
5710 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5711 const STRLEN boffset2
5712 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5713 uoffset, boffset) - boffset;
5727 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5728 byte length pairing. The (byte) length of the total SV is passed in too,
5729 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5730 may not have updated SvCUR, so we can't rely on reading it directly.
5732 The proffered utf8/byte length pairing isn't used if the cache already has
5733 two pairs, and swapping either for the proffered pair would increase the
5734 RMS of the intervals between known byte offsets.
5736 The cache itself consists of 4 STRLEN values
5737 0: larger UTF-8 offset
5738 1: corresponding byte offset
5739 2: smaller UTF-8 offset
5740 3: corresponding byte offset
5742 Unused cache pairs have the value 0, 0.
5743 Keeping the cache "backwards" means that the invariant of
5744 cache[0] >= cache[2] is maintained even with empty slots, which means that
5745 the code that uses it doesn't need to worry if only 1 entry has actually
5746 been set to non-zero. It also makes the "position beyond the end of the
5747 cache" logic much simpler, as the first slot is always the one to start
5751 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5759 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5761 (*mgp)->mg_len = -1;
5765 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5766 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5767 (*mgp)->mg_ptr = (char *) cache;
5771 if (PL_utf8cache < 0) {
5772 const U8 *start = (const U8 *) SvPVX_const(sv);
5773 const STRLEN realutf8 = utf8_length(start, start + byte);
5775 if (realutf8 != utf8) {
5776 /* Need to turn the assertions off otherwise we may recurse
5777 infinitely while printing error messages. */
5778 SAVEI8(PL_utf8cache);
5780 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5781 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5785 /* Cache is held with the later position first, to simplify the code
5786 that deals with unbounded ends. */
5788 ASSERT_UTF8_CACHE(cache);
5789 if (cache[1] == 0) {
5790 /* Cache is totally empty */
5793 } else if (cache[3] == 0) {
5794 if (byte > cache[1]) {
5795 /* New one is larger, so goes first. */
5796 cache[2] = cache[0];
5797 cache[3] = cache[1];
5805 #define THREEWAY_SQUARE(a,b,c,d) \
5806 ((float)((d) - (c))) * ((float)((d) - (c))) \
5807 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5808 + ((float)((b) - (a))) * ((float)((b) - (a)))
5810 /* Cache has 2 slots in use, and we know three potential pairs.
5811 Keep the two that give the lowest RMS distance. Do the
5812 calcualation in bytes simply because we always know the byte
5813 length. squareroot has the same ordering as the positive value,
5814 so don't bother with the actual square root. */
5815 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5816 if (byte > cache[1]) {
5817 /* New position is after the existing pair of pairs. */
5818 const float keep_earlier
5819 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5820 const float keep_later
5821 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5823 if (keep_later < keep_earlier) {
5824 if (keep_later < existing) {
5825 cache[2] = cache[0];
5826 cache[3] = cache[1];
5832 if (keep_earlier < existing) {
5838 else if (byte > cache[3]) {
5839 /* New position is between the existing pair of pairs. */
5840 const float keep_earlier
5841 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5842 const float keep_later
5843 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5845 if (keep_later < keep_earlier) {
5846 if (keep_later < existing) {
5852 if (keep_earlier < existing) {
5859 /* New position is before the existing pair of pairs. */
5860 const float keep_earlier
5861 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5862 const float keep_later
5863 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5865 if (keep_later < keep_earlier) {
5866 if (keep_later < existing) {
5872 if (keep_earlier < existing) {
5873 cache[0] = cache[2];
5874 cache[1] = cache[3];
5881 ASSERT_UTF8_CACHE(cache);
5884 /* We already know all of the way, now we may be able to walk back. The same
5885 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5886 backward is half the speed of walking forward. */
5888 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5891 const STRLEN forw = target - s;
5892 STRLEN backw = end - target;
5894 if (forw < 2 * backw) {
5895 return utf8_length(s, target);
5898 while (end > target) {
5900 while (UTF8_IS_CONTINUATION(*end)) {
5909 =for apidoc sv_pos_b2u
5911 Converts the value pointed to by offsetp from a count of bytes from the
5912 start of the string, to a count of the equivalent number of UTF-8 chars.
5913 Handles magic and type coercion.
5919 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5920 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5925 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5928 const STRLEN byte = *offsetp;
5929 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5938 s = (const U8*)SvPV_const(sv, blen);
5941 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5945 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5946 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5948 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5949 if (cache[1] == byte) {
5950 /* An exact match. */
5951 *offsetp = cache[0];
5954 if (cache[3] == byte) {
5955 /* An exact match. */
5956 *offsetp = cache[2];
5960 if (cache[1] < byte) {
5961 /* We already know part of the way. */
5962 if (mg->mg_len != -1) {
5963 /* Actually, we know the end too. */
5965 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5966 s + blen, mg->mg_len - cache[0]);
5968 len = cache[0] + utf8_length(s + cache[1], send);
5971 else if (cache[3] < byte) {
5972 /* We're between the two cached pairs, so we do the calculation
5973 offset by the byte/utf-8 positions for the earlier pair,
5974 then add the utf-8 characters from the string start to
5976 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5977 s + cache[1], cache[0] - cache[2])
5981 else { /* cache[3] > byte */
5982 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5986 ASSERT_UTF8_CACHE(cache);
5988 } else if (mg->mg_len != -1) {
5989 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5993 if (!found || PL_utf8cache < 0) {
5994 const STRLEN real_len = utf8_length(s, send);
5996 if (found && PL_utf8cache < 0) {
5997 if (len != real_len) {
5998 /* Need to turn the assertions off otherwise we may recurse
5999 infinitely while printing error messages. */
6000 SAVEI8(PL_utf8cache);
6002 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6003 " real %"UVuf" for %"SVf,
6004 (UV) len, (UV) real_len, SVfARG(sv));
6011 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6017 Returns a boolean indicating whether the strings in the two SVs are
6018 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6019 coerce its args to strings if necessary.
6025 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6034 SV* svrecode = NULL;
6041 /* if pv1 and pv2 are the same, second SvPV_const call may
6042 * invalidate pv1, so we may need to make a copy */
6043 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6044 pv1 = SvPV_const(sv1, cur1);
6045 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6047 pv1 = SvPV_const(sv1, cur1);
6055 pv2 = SvPV_const(sv2, cur2);
6057 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6058 /* Differing utf8ness.
6059 * Do not UTF8size the comparands as a side-effect. */
6062 svrecode = newSVpvn(pv2, cur2);
6063 sv_recode_to_utf8(svrecode, PL_encoding);
6064 pv2 = SvPV_const(svrecode, cur2);
6067 svrecode = newSVpvn(pv1, cur1);
6068 sv_recode_to_utf8(svrecode, PL_encoding);
6069 pv1 = SvPV_const(svrecode, cur1);
6071 /* Now both are in UTF-8. */
6073 SvREFCNT_dec(svrecode);
6078 bool is_utf8 = TRUE;
6081 /* sv1 is the UTF-8 one,
6082 * if is equal it must be downgrade-able */
6083 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6089 /* sv2 is the UTF-8 one,
6090 * if is equal it must be downgrade-able */
6091 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6097 /* Downgrade not possible - cannot be eq */
6105 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6107 SvREFCNT_dec(svrecode);
6117 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6118 string in C<sv1> is less than, equal to, or greater than the string in
6119 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6120 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6126 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6130 const char *pv1, *pv2;
6133 SV *svrecode = NULL;
6140 pv1 = SvPV_const(sv1, cur1);
6147 pv2 = SvPV_const(sv2, cur2);
6149 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6150 /* Differing utf8ness.
6151 * Do not UTF8size the comparands as a side-effect. */
6154 svrecode = newSVpvn(pv2, cur2);
6155 sv_recode_to_utf8(svrecode, PL_encoding);
6156 pv2 = SvPV_const(svrecode, cur2);
6159 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6164 svrecode = newSVpvn(pv1, cur1);
6165 sv_recode_to_utf8(svrecode, PL_encoding);
6166 pv1 = SvPV_const(svrecode, cur1);
6169 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6175 cmp = cur2 ? -1 : 0;
6179 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6182 cmp = retval < 0 ? -1 : 1;
6183 } else if (cur1 == cur2) {
6186 cmp = cur1 < cur2 ? -1 : 1;
6190 SvREFCNT_dec(svrecode);
6198 =for apidoc sv_cmp_locale
6200 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6201 'use bytes' aware, handles get magic, and will coerce its args to strings
6202 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6208 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6211 #ifdef USE_LOCALE_COLLATE
6217 if (PL_collation_standard)
6221 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6223 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6225 if (!pv1 || !len1) {
6236 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6239 return retval < 0 ? -1 : 1;
6242 * When the result of collation is equality, that doesn't mean
6243 * that there are no differences -- some locales exclude some
6244 * characters from consideration. So to avoid false equalities,
6245 * we use the raw string as a tiebreaker.
6251 #endif /* USE_LOCALE_COLLATE */
6253 return sv_cmp(sv1, sv2);
6257 #ifdef USE_LOCALE_COLLATE
6260 =for apidoc sv_collxfrm
6262 Add Collate Transform magic to an SV if it doesn't already have it.
6264 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6265 scalar data of the variable, but transformed to such a format that a normal
6266 memory comparison can be used to compare the data according to the locale
6273 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6278 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6279 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6285 Safefree(mg->mg_ptr);
6286 s = SvPV_const(sv, len);
6287 if ((xf = mem_collxfrm(s, len, &xlen))) {
6288 if (SvREADONLY(sv)) {
6291 return xf + sizeof(PL_collation_ix);
6294 #ifdef PERL_OLD_COPY_ON_WRITE
6296 sv_force_normal_flags(sv, 0);
6298 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6312 if (mg && mg->mg_ptr) {
6314 return mg->mg_ptr + sizeof(PL_collation_ix);
6322 #endif /* USE_LOCALE_COLLATE */
6327 Get a line from the filehandle and store it into the SV, optionally
6328 appending to the currently-stored string.
6334 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6339 register STDCHAR rslast;
6340 register STDCHAR *bp;
6345 if (SvTHINKFIRST(sv))
6346 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6347 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6349 However, perlbench says it's slower, because the existing swipe code
6350 is faster than copy on write.
6351 Swings and roundabouts. */
6352 SvUPGRADE(sv, SVt_PV);
6357 if (PerlIO_isutf8(fp)) {
6359 sv_utf8_upgrade_nomg(sv);
6360 sv_pos_u2b(sv,&append,0);
6362 } else if (SvUTF8(sv)) {
6363 SV * const tsv = newSV(0);
6364 sv_gets(tsv, fp, 0);
6365 sv_utf8_upgrade_nomg(tsv);
6366 SvCUR_set(sv,append);
6369 goto return_string_or_null;
6374 if (PerlIO_isutf8(fp))
6377 if (IN_PERL_COMPILETIME) {
6378 /* we always read code in line mode */
6382 else if (RsSNARF(PL_rs)) {
6383 /* If it is a regular disk file use size from stat() as estimate
6384 of amount we are going to read -- may result in mallocing
6385 more memory than we really need if the layers below reduce
6386 the size we read (e.g. CRLF or a gzip layer).
6389 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6390 const Off_t offset = PerlIO_tell(fp);
6391 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6392 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6398 else if (RsRECORD(PL_rs)) {
6403 /* Grab the size of the record we're getting */
6404 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6405 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6408 /* VMS wants read instead of fread, because fread doesn't respect */
6409 /* RMS record boundaries. This is not necessarily a good thing to be */
6410 /* doing, but we've got no other real choice - except avoid stdio
6411 as implementation - perhaps write a :vms layer ?
6413 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6415 bytesread = PerlIO_read(fp, buffer, recsize);
6419 SvCUR_set(sv, bytesread += append);
6420 buffer[bytesread] = '\0';
6421 goto return_string_or_null;
6423 else if (RsPARA(PL_rs)) {
6429 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6430 if (PerlIO_isutf8(fp)) {
6431 rsptr = SvPVutf8(PL_rs, rslen);
6434 if (SvUTF8(PL_rs)) {
6435 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6436 Perl_croak(aTHX_ "Wide character in $/");
6439 rsptr = SvPV_const(PL_rs, rslen);
6443 rslast = rslen ? rsptr[rslen - 1] : '\0';
6445 if (rspara) { /* have to do this both before and after */
6446 do { /* to make sure file boundaries work right */
6449 i = PerlIO_getc(fp);
6453 PerlIO_ungetc(fp,i);
6459 /* See if we know enough about I/O mechanism to cheat it ! */
6461 /* This used to be #ifdef test - it is made run-time test for ease
6462 of abstracting out stdio interface. One call should be cheap
6463 enough here - and may even be a macro allowing compile
6467 if (PerlIO_fast_gets(fp)) {
6470 * We're going to steal some values from the stdio struct
6471 * and put EVERYTHING in the innermost loop into registers.
6473 register STDCHAR *ptr;
6477 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6478 /* An ungetc()d char is handled separately from the regular
6479 * buffer, so we getc() it back out and stuff it in the buffer.
6481 i = PerlIO_getc(fp);
6482 if (i == EOF) return 0;
6483 *(--((*fp)->_ptr)) = (unsigned char) i;
6487 /* Here is some breathtakingly efficient cheating */
6489 cnt = PerlIO_get_cnt(fp); /* get count into register */
6490 /* make sure we have the room */
6491 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6492 /* Not room for all of it
6493 if we are looking for a separator and room for some
6495 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6496 /* just process what we have room for */
6497 shortbuffered = cnt - SvLEN(sv) + append + 1;
6498 cnt -= shortbuffered;
6502 /* remember that cnt can be negative */
6503 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6508 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6509 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6510 DEBUG_P(PerlIO_printf(Perl_debug_log,
6511 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6512 DEBUG_P(PerlIO_printf(Perl_debug_log,
6513 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6514 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6515 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6520 while (cnt > 0) { /* this | eat */
6522 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6523 goto thats_all_folks; /* screams | sed :-) */
6527 Copy(ptr, bp, cnt, char); /* this | eat */
6528 bp += cnt; /* screams | dust */
6529 ptr += cnt; /* louder | sed :-) */
6534 if (shortbuffered) { /* oh well, must extend */
6535 cnt = shortbuffered;
6537 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6539 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6540 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6544 DEBUG_P(PerlIO_printf(Perl_debug_log,
6545 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6546 PTR2UV(ptr),(long)cnt));
6547 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6549 DEBUG_P(PerlIO_printf(Perl_debug_log,
6550 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6551 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6552 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6554 /* This used to call 'filbuf' in stdio form, but as that behaves like
6555 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6556 another abstraction. */
6557 i = PerlIO_getc(fp); /* get more characters */
6559 DEBUG_P(PerlIO_printf(Perl_debug_log,
6560 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6561 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6562 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6564 cnt = PerlIO_get_cnt(fp);
6565 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6566 DEBUG_P(PerlIO_printf(Perl_debug_log,
6567 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6569 if (i == EOF) /* all done for ever? */
6570 goto thats_really_all_folks;
6572 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6574 SvGROW(sv, bpx + cnt + 2);
6575 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6577 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6579 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6580 goto thats_all_folks;
6584 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6585 memNE((char*)bp - rslen, rsptr, rslen))
6586 goto screamer; /* go back to the fray */
6587 thats_really_all_folks:
6589 cnt += shortbuffered;
6590 DEBUG_P(PerlIO_printf(Perl_debug_log,
6591 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6592 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6593 DEBUG_P(PerlIO_printf(Perl_debug_log,
6594 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6595 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6596 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6598 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6599 DEBUG_P(PerlIO_printf(Perl_debug_log,
6600 "Screamer: done, len=%ld, string=|%.*s|\n",
6601 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6605 /*The big, slow, and stupid way. */
6606 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6607 STDCHAR *buf = NULL;
6608 Newx(buf, 8192, STDCHAR);
6616 register const STDCHAR * const bpe = buf + sizeof(buf);
6618 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6619 ; /* keep reading */
6623 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6624 /* Accomodate broken VAXC compiler, which applies U8 cast to
6625 * both args of ?: operator, causing EOF to change into 255
6628 i = (U8)buf[cnt - 1];
6634 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6636 sv_catpvn(sv, (char *) buf, cnt);
6638 sv_setpvn(sv, (char *) buf, cnt);
6640 if (i != EOF && /* joy */
6642 SvCUR(sv) < rslen ||
6643 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6647 * If we're reading from a TTY and we get a short read,
6648 * indicating that the user hit his EOF character, we need
6649 * to notice it now, because if we try to read from the TTY
6650 * again, the EOF condition will disappear.
6652 * The comparison of cnt to sizeof(buf) is an optimization
6653 * that prevents unnecessary calls to feof().
6657 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6661 #ifdef USE_HEAP_INSTEAD_OF_STACK
6666 if (rspara) { /* have to do this both before and after */
6667 while (i != EOF) { /* to make sure file boundaries work right */
6668 i = PerlIO_getc(fp);
6670 PerlIO_ungetc(fp,i);
6676 return_string_or_null:
6677 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6683 Auto-increment of the value in the SV, doing string to numeric conversion
6684 if necessary. Handles 'get' magic.
6690 Perl_sv_inc(pTHX_ register SV *sv)
6699 if (SvTHINKFIRST(sv)) {
6701 sv_force_normal_flags(sv, 0);
6702 if (SvREADONLY(sv)) {
6703 if (IN_PERL_RUNTIME)
6704 Perl_croak(aTHX_ PL_no_modify);
6708 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6710 i = PTR2IV(SvRV(sv));
6715 flags = SvFLAGS(sv);
6716 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6717 /* It's (privately or publicly) a float, but not tested as an
6718 integer, so test it to see. */
6720 flags = SvFLAGS(sv);
6722 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6723 /* It's publicly an integer, or privately an integer-not-float */
6724 #ifdef PERL_PRESERVE_IVUV
6728 if (SvUVX(sv) == UV_MAX)
6729 sv_setnv(sv, UV_MAX_P1);
6731 (void)SvIOK_only_UV(sv);
6732 SvUV_set(sv, SvUVX(sv) + 1);
6734 if (SvIVX(sv) == IV_MAX)
6735 sv_setuv(sv, (UV)IV_MAX + 1);
6737 (void)SvIOK_only(sv);
6738 SvIV_set(sv, SvIVX(sv) + 1);
6743 if (flags & SVp_NOK) {
6744 (void)SvNOK_only(sv);
6745 SvNV_set(sv, SvNVX(sv) + 1.0);
6749 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6750 if ((flags & SVTYPEMASK) < SVt_PVIV)
6751 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6752 (void)SvIOK_only(sv);
6757 while (isALPHA(*d)) d++;
6758 while (isDIGIT(*d)) d++;
6760 #ifdef PERL_PRESERVE_IVUV
6761 /* Got to punt this as an integer if needs be, but we don't issue
6762 warnings. Probably ought to make the sv_iv_please() that does
6763 the conversion if possible, and silently. */
6764 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6765 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6766 /* Need to try really hard to see if it's an integer.
6767 9.22337203685478e+18 is an integer.
6768 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6769 so $a="9.22337203685478e+18"; $a+0; $a++
6770 needs to be the same as $a="9.22337203685478e+18"; $a++
6777 /* sv_2iv *should* have made this an NV */
6778 if (flags & SVp_NOK) {
6779 (void)SvNOK_only(sv);
6780 SvNV_set(sv, SvNVX(sv) + 1.0);
6783 /* I don't think we can get here. Maybe I should assert this
6784 And if we do get here I suspect that sv_setnv will croak. NWC
6786 #if defined(USE_LONG_DOUBLE)
6787 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",
6788 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6790 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6791 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6794 #endif /* PERL_PRESERVE_IVUV */
6795 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6799 while (d >= SvPVX_const(sv)) {
6807 /* MKS: The original code here died if letters weren't consecutive.
6808 * at least it didn't have to worry about non-C locales. The
6809 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6810 * arranged in order (although not consecutively) and that only
6811 * [A-Za-z] are accepted by isALPHA in the C locale.
6813 if (*d != 'z' && *d != 'Z') {
6814 do { ++*d; } while (!isALPHA(*d));
6817 *(d--) -= 'z' - 'a';
6822 *(d--) -= 'z' - 'a' + 1;
6826 /* oh,oh, the number grew */
6827 SvGROW(sv, SvCUR(sv) + 2);
6828 SvCUR_set(sv, SvCUR(sv) + 1);
6829 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6840 Auto-decrement of the value in the SV, doing string to numeric conversion
6841 if necessary. Handles 'get' magic.
6847 Perl_sv_dec(pTHX_ register SV *sv)
6855 if (SvTHINKFIRST(sv)) {
6857 sv_force_normal_flags(sv, 0);
6858 if (SvREADONLY(sv)) {
6859 if (IN_PERL_RUNTIME)
6860 Perl_croak(aTHX_ PL_no_modify);
6864 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6866 i = PTR2IV(SvRV(sv));
6871 /* Unlike sv_inc we don't have to worry about string-never-numbers
6872 and keeping them magic. But we mustn't warn on punting */
6873 flags = SvFLAGS(sv);
6874 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6875 /* It's publicly an integer, or privately an integer-not-float */
6876 #ifdef PERL_PRESERVE_IVUV
6880 if (SvUVX(sv) == 0) {
6881 (void)SvIOK_only(sv);
6885 (void)SvIOK_only_UV(sv);
6886 SvUV_set(sv, SvUVX(sv) - 1);
6889 if (SvIVX(sv) == IV_MIN)
6890 sv_setnv(sv, (NV)IV_MIN - 1.0);
6892 (void)SvIOK_only(sv);
6893 SvIV_set(sv, SvIVX(sv) - 1);
6898 if (flags & SVp_NOK) {
6899 SvNV_set(sv, SvNVX(sv) - 1.0);
6900 (void)SvNOK_only(sv);
6903 if (!(flags & SVp_POK)) {
6904 if ((flags & SVTYPEMASK) < SVt_PVIV)
6905 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6907 (void)SvIOK_only(sv);
6910 #ifdef PERL_PRESERVE_IVUV
6912 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6913 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6914 /* Need to try really hard to see if it's an integer.
6915 9.22337203685478e+18 is an integer.
6916 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6917 so $a="9.22337203685478e+18"; $a+0; $a--
6918 needs to be the same as $a="9.22337203685478e+18"; $a--
6925 /* sv_2iv *should* have made this an NV */
6926 if (flags & SVp_NOK) {
6927 (void)SvNOK_only(sv);
6928 SvNV_set(sv, SvNVX(sv) - 1.0);
6931 /* I don't think we can get here. Maybe I should assert this
6932 And if we do get here I suspect that sv_setnv will croak. NWC
6934 #if defined(USE_LONG_DOUBLE)
6935 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",
6936 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6938 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6939 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6943 #endif /* PERL_PRESERVE_IVUV */
6944 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6948 =for apidoc sv_mortalcopy
6950 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6951 The new SV is marked as mortal. It will be destroyed "soon", either by an
6952 explicit call to FREETMPS, or by an implicit call at places such as
6953 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6958 /* Make a string that will exist for the duration of the expression
6959 * evaluation. Actually, it may have to last longer than that, but
6960 * hopefully we won't free it until it has been assigned to a
6961 * permanent location. */
6964 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6970 sv_setsv(sv,oldstr);
6972 PL_tmps_stack[++PL_tmps_ix] = sv;
6978 =for apidoc sv_newmortal
6980 Creates a new null SV which is mortal. The reference count of the SV is
6981 set to 1. It will be destroyed "soon", either by an explicit call to
6982 FREETMPS, or by an implicit call at places such as statement boundaries.
6983 See also C<sv_mortalcopy> and C<sv_2mortal>.
6989 Perl_sv_newmortal(pTHX)
6995 SvFLAGS(sv) = SVs_TEMP;
6997 PL_tmps_stack[++PL_tmps_ix] = sv;
7003 =for apidoc newSVpvn_flags
7005 Creates a new SV and copies a string into it. The reference count for the
7006 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7007 string. You are responsible for ensuring that the source string is at least
7008 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7009 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7010 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7011 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7012 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7014 #define newSVpvn_utf8(s, len, u) \
7015 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7021 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7026 /* All the flags we don't support must be zero.
7027 And we're new code so I'm going to assert this from the start. */
7028 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7030 sv_setpvn(sv,s,len);
7031 SvFLAGS(sv) |= (flags & SVf_UTF8);
7032 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7036 =for apidoc sv_2mortal
7038 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7039 by an explicit call to FREETMPS, or by an implicit call at places such as
7040 statement boundaries. SvTEMP() is turned on which means that the SV's
7041 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7042 and C<sv_mortalcopy>.
7048 Perl_sv_2mortal(pTHX_ register SV *sv)
7053 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7056 PL_tmps_stack[++PL_tmps_ix] = sv;
7064 Creates a new SV and copies a string into it. The reference count for the
7065 SV is set to 1. If C<len> is zero, Perl will compute the length using
7066 strlen(). For efficiency, consider using C<newSVpvn> instead.
7072 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7078 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7083 =for apidoc newSVpvn
7085 Creates a new SV and copies a string into it. The reference count for the
7086 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7087 string. You are responsible for ensuring that the source string is at least
7088 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7094 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7100 sv_setpvn(sv,s,len);
7105 =for apidoc newSVhek
7107 Creates a new SV from the hash key structure. It will generate scalars that
7108 point to the shared string table where possible. Returns a new (undefined)
7109 SV if the hek is NULL.
7115 Perl_newSVhek(pTHX_ const HEK *hek)
7125 if (HEK_LEN(hek) == HEf_SVKEY) {
7126 return newSVsv(*(SV**)HEK_KEY(hek));
7128 const int flags = HEK_FLAGS(hek);
7129 if (flags & HVhek_WASUTF8) {
7131 Andreas would like keys he put in as utf8 to come back as utf8
7133 STRLEN utf8_len = HEK_LEN(hek);
7134 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7135 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7138 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7140 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7141 /* We don't have a pointer to the hv, so we have to replicate the
7142 flag into every HEK. This hv is using custom a hasing
7143 algorithm. Hence we can't return a shared string scalar, as
7144 that would contain the (wrong) hash value, and might get passed
7145 into an hv routine with a regular hash.
7146 Similarly, a hash that isn't using shared hash keys has to have
7147 the flag in every key so that we know not to try to call
7148 share_hek_kek on it. */
7150 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7155 /* This will be overwhelminly the most common case. */
7157 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7158 more efficient than sharepvn(). */
7162 sv_upgrade(sv, SVt_PV);
7163 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7164 SvCUR_set(sv, HEK_LEN(hek));
7177 =for apidoc newSVpvn_share
7179 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7180 table. If the string does not already exist in the table, it is created
7181 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7182 value is used; otherwise the hash is computed. The string's hash can be later
7183 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7184 that as the string table is used for shared hash keys these strings will have
7185 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7191 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7195 bool is_utf8 = FALSE;
7196 const char *const orig_src = src;
7199 STRLEN tmplen = -len;
7201 /* See the note in hv.c:hv_fetch() --jhi */
7202 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7206 PERL_HASH(hash, src, len);
7208 sv_upgrade(sv, SVt_PV);
7209 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7217 if (src != orig_src)
7223 #if defined(PERL_IMPLICIT_CONTEXT)
7225 /* pTHX_ magic can't cope with varargs, so this is a no-context
7226 * version of the main function, (which may itself be aliased to us).
7227 * Don't access this version directly.
7231 Perl_newSVpvf_nocontext(const char* pat, ...)
7236 va_start(args, pat);
7237 sv = vnewSVpvf(pat, &args);
7244 =for apidoc newSVpvf
7246 Creates a new SV and initializes it with the string formatted like
7253 Perl_newSVpvf(pTHX_ const char* pat, ...)
7257 va_start(args, pat);
7258 sv = vnewSVpvf(pat, &args);
7263 /* backend for newSVpvf() and newSVpvf_nocontext() */
7266 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7271 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7278 Creates a new SV and copies a floating point value into it.
7279 The reference count for the SV is set to 1.
7285 Perl_newSVnv(pTHX_ NV n)
7298 Creates a new SV and copies an integer into it. The reference count for the
7305 Perl_newSViv(pTHX_ IV i)
7318 Creates a new SV and copies an unsigned integer into it.
7319 The reference count for the SV is set to 1.
7325 Perl_newSVuv(pTHX_ UV u)
7336 =for apidoc newSV_type
7338 Creates a new SV, of the type specified. The reference count for the new SV
7345 Perl_newSV_type(pTHX_ svtype type)
7350 sv_upgrade(sv, type);
7355 =for apidoc newRV_noinc
7357 Creates an RV wrapper for an SV. The reference count for the original
7358 SV is B<not> incremented.
7364 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7367 register SV *sv = newSV_type(SVt_IV);
7369 SvRV_set(sv, tmpRef);
7374 /* newRV_inc is the official function name to use now.
7375 * newRV_inc is in fact #defined to newRV in sv.h
7379 Perl_newRV(pTHX_ SV *sv)
7382 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7388 Creates a new SV which is an exact duplicate of the original SV.
7395 Perl_newSVsv(pTHX_ register SV *old)
7402 if (SvTYPE(old) == SVTYPEMASK) {
7403 if (ckWARN_d(WARN_INTERNAL))
7404 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7408 /* SV_GMAGIC is the default for sv_setv()
7409 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7410 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7411 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7416 =for apidoc sv_reset
7418 Underlying implementation for the C<reset> Perl function.
7419 Note that the perl-level function is vaguely deprecated.
7425 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7428 char todo[PERL_UCHAR_MAX+1];
7433 if (!*s) { /* reset ?? searches */
7434 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7436 const U32 count = mg->mg_len / sizeof(PMOP**);
7437 PMOP **pmp = (PMOP**) mg->mg_ptr;
7438 PMOP *const *const end = pmp + count;
7442 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7444 (*pmp)->op_pmflags &= ~PMf_USED;
7452 /* reset variables */
7454 if (!HvARRAY(stash))
7457 Zero(todo, 256, char);
7460 I32 i = (unsigned char)*s;
7464 max = (unsigned char)*s++;
7465 for ( ; i <= max; i++) {
7468 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7470 for (entry = HvARRAY(stash)[i];
7472 entry = HeNEXT(entry))
7477 if (!todo[(U8)*HeKEY(entry)])
7479 gv = (GV*)HeVAL(entry);
7482 if (SvTHINKFIRST(sv)) {
7483 if (!SvREADONLY(sv) && SvROK(sv))
7485 /* XXX Is this continue a bug? Why should THINKFIRST
7486 exempt us from resetting arrays and hashes? */
7490 if (SvTYPE(sv) >= SVt_PV) {
7492 if (SvPVX_const(sv) != NULL)
7500 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7502 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7505 # if defined(USE_ENVIRON_ARRAY)
7508 # endif /* USE_ENVIRON_ARRAY */
7519 Using various gambits, try to get an IO from an SV: the IO slot if its a
7520 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7521 named after the PV if we're a string.
7527 Perl_sv_2io(pTHX_ SV *sv)
7532 switch (SvTYPE(sv)) {
7540 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7544 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7546 return sv_2io(SvRV(sv));
7547 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7553 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7562 Using various gambits, try to get a CV from an SV; in addition, try if
7563 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7564 The flags in C<lref> are passed to sv_fetchsv.
7570 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7581 switch (SvTYPE(sv)) {
7600 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7601 tryAMAGICunDEREF(to_cv);
7604 if (SvTYPE(sv) == SVt_PVCV) {
7613 Perl_croak(aTHX_ "Not a subroutine reference");
7618 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7624 /* Some flags to gv_fetchsv mean don't really create the GV */
7625 if (SvTYPE(gv) != SVt_PVGV) {
7631 if (lref && !GvCVu(gv)) {
7635 gv_efullname3(tmpsv, gv, NULL);
7636 /* XXX this is probably not what they think they're getting.
7637 * It has the same effect as "sub name;", i.e. just a forward
7639 newSUB(start_subparse(FALSE, 0),
7640 newSVOP(OP_CONST, 0, tmpsv),
7644 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7654 Returns true if the SV has a true value by Perl's rules.
7655 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7656 instead use an in-line version.
7662 Perl_sv_true(pTHX_ register SV *sv)
7667 register const XPV* const tXpv = (XPV*)SvANY(sv);
7669 (tXpv->xpv_cur > 1 ||
7670 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7677 return SvIVX(sv) != 0;
7680 return SvNVX(sv) != 0.0;
7682 return sv_2bool(sv);
7688 =for apidoc sv_pvn_force
7690 Get a sensible string out of the SV somehow.
7691 A private implementation of the C<SvPV_force> macro for compilers which
7692 can't cope with complex macro expressions. Always use the macro instead.
7694 =for apidoc sv_pvn_force_flags
7696 Get a sensible string out of the SV somehow.
7697 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7698 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7699 implemented in terms of this function.
7700 You normally want to use the various wrapper macros instead: see
7701 C<SvPV_force> and C<SvPV_force_nomg>
7707 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7710 if (SvTHINKFIRST(sv) && !SvROK(sv))
7711 sv_force_normal_flags(sv, 0);
7721 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7722 const char * const ref = sv_reftype(sv,0);
7724 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7725 ref, OP_NAME(PL_op));
7727 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7729 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7730 || isGV_with_GP(sv))
7731 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7733 s = sv_2pv_flags(sv, &len, flags);
7737 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7740 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7741 SvGROW(sv, len + 1);
7742 Move(s,SvPVX(sv),len,char);
7744 SvPVX(sv)[len] = '\0';
7747 SvPOK_on(sv); /* validate pointer */
7749 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7750 PTR2UV(sv),SvPVX_const(sv)));
7753 return SvPVX_mutable(sv);
7757 =for apidoc sv_pvbyten_force
7759 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7765 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7767 sv_pvn_force(sv,lp);
7768 sv_utf8_downgrade(sv,0);
7774 =for apidoc sv_pvutf8n_force
7776 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7782 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7784 sv_pvn_force(sv,lp);
7785 sv_utf8_upgrade(sv);
7791 =for apidoc sv_reftype
7793 Returns a string describing what the SV is a reference to.
7799 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7801 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7802 inside return suggests a const propagation bug in g++. */
7803 if (ob && SvOBJECT(sv)) {
7804 char * const name = HvNAME_get(SvSTASH(sv));
7805 return name ? name : (char *) "__ANON__";
7808 switch (SvTYPE(sv)) {
7823 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7824 /* tied lvalues should appear to be
7825 * scalars for backwards compatitbility */
7826 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7827 ? "SCALAR" : "LVALUE");
7828 case SVt_PVAV: return "ARRAY";
7829 case SVt_PVHV: return "HASH";
7830 case SVt_PVCV: return "CODE";
7831 case SVt_PVGV: return "GLOB";
7832 case SVt_PVFM: return "FORMAT";
7833 case SVt_PVIO: return "IO";
7834 case SVt_BIND: return "BIND";
7835 case SVt_REGEXP: return "Regexp"; /* FIXME? to "REGEXP" */
7836 default: return "UNKNOWN";
7842 =for apidoc sv_isobject
7844 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7845 object. If the SV is not an RV, or if the object is not blessed, then this
7852 Perl_sv_isobject(pTHX_ SV *sv)
7868 Returns a boolean indicating whether the SV is blessed into the specified
7869 class. This does not check for subtypes; use C<sv_derived_from> to verify
7870 an inheritance relationship.
7876 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7887 hvname = HvNAME_get(SvSTASH(sv));
7891 return strEQ(hvname, name);
7897 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7898 it will be upgraded to one. If C<classname> is non-null then the new SV will
7899 be blessed in the specified package. The new SV is returned and its
7900 reference count is 1.
7906 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7913 SV_CHECK_THINKFIRST_COW_DROP(rv);
7914 (void)SvAMAGIC_off(rv);
7916 if (SvTYPE(rv) >= SVt_PVMG) {
7917 const U32 refcnt = SvREFCNT(rv);
7921 SvREFCNT(rv) = refcnt;
7923 sv_upgrade(rv, SVt_IV);
7924 } else if (SvROK(rv)) {
7925 SvREFCNT_dec(SvRV(rv));
7927 prepare_SV_for_RV(rv);
7935 HV* const stash = gv_stashpv(classname, GV_ADD);
7936 (void)sv_bless(rv, stash);
7942 =for apidoc sv_setref_pv
7944 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7945 argument will be upgraded to an RV. That RV will be modified to point to
7946 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7947 into the SV. The C<classname> argument indicates the package for the
7948 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7949 will have a reference count of 1, and the RV will be returned.
7951 Do not use with other Perl types such as HV, AV, SV, CV, because those
7952 objects will become corrupted by the pointer copy process.
7954 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7960 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7964 sv_setsv(rv, &PL_sv_undef);
7968 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7973 =for apidoc sv_setref_iv
7975 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7976 argument will be upgraded to an RV. That RV will be modified to point to
7977 the new SV. The C<classname> argument indicates the package for the
7978 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7979 will have a reference count of 1, and the RV will be returned.
7985 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7987 sv_setiv(newSVrv(rv,classname), iv);
7992 =for apidoc sv_setref_uv
7994 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7995 argument will be upgraded to an RV. That RV will be modified to point to
7996 the new SV. The C<classname> argument indicates the package for the
7997 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7998 will have a reference count of 1, and the RV will be returned.
8004 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8006 sv_setuv(newSVrv(rv,classname), uv);
8011 =for apidoc sv_setref_nv
8013 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8014 argument will be upgraded to an RV. That RV will be modified to point to
8015 the new SV. The C<classname> argument indicates the package for the
8016 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8017 will have a reference count of 1, and the RV will be returned.
8023 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8025 sv_setnv(newSVrv(rv,classname), nv);
8030 =for apidoc sv_setref_pvn
8032 Copies a string into a new SV, optionally blessing the SV. The length of the
8033 string must be specified with C<n>. The C<rv> argument will be upgraded to
8034 an RV. That RV will be modified to point to the new SV. The C<classname>
8035 argument indicates the package for the blessing. Set C<classname> to
8036 C<NULL> to avoid the blessing. The new SV will have a reference count
8037 of 1, and the RV will be returned.
8039 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8045 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8047 sv_setpvn(newSVrv(rv,classname), pv, n);
8052 =for apidoc sv_bless
8054 Blesses an SV into a specified package. The SV must be an RV. The package
8055 must be designated by its stash (see C<gv_stashpv()>). The reference count
8056 of the SV is unaffected.
8062 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8067 Perl_croak(aTHX_ "Can't bless non-reference value");
8069 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8070 if (SvIsCOW(tmpRef))
8071 sv_force_normal_flags(tmpRef, 0);
8072 if (SvREADONLY(tmpRef))
8073 Perl_croak(aTHX_ PL_no_modify);
8074 if (SvOBJECT(tmpRef)) {
8075 if (SvTYPE(tmpRef) != SVt_PVIO)
8077 SvREFCNT_dec(SvSTASH(tmpRef));
8080 SvOBJECT_on(tmpRef);
8081 if (SvTYPE(tmpRef) != SVt_PVIO)
8083 SvUPGRADE(tmpRef, SVt_PVMG);
8084 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8089 (void)SvAMAGIC_off(sv);
8091 if(SvSMAGICAL(tmpRef))
8092 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8100 /* Downgrades a PVGV to a PVMG.
8104 S_sv_unglob(pTHX_ SV *sv)
8109 SV * const temp = sv_newmortal();
8111 assert(SvTYPE(sv) == SVt_PVGV);
8113 gv_efullname3(temp, (GV *) sv, "*");
8116 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8117 mro_method_changed_in(stash);
8121 sv_del_backref((SV*)GvSTASH(sv), sv);
8125 if (GvNAME_HEK(sv)) {
8126 unshare_hek(GvNAME_HEK(sv));
8128 isGV_with_GP_off(sv);
8130 /* need to keep SvANY(sv) in the right arena */
8131 xpvmg = new_XPVMG();
8132 StructCopy(SvANY(sv), xpvmg, XPVMG);
8133 del_XPVGV(SvANY(sv));
8136 SvFLAGS(sv) &= ~SVTYPEMASK;
8137 SvFLAGS(sv) |= SVt_PVMG;
8139 /* Intentionally not calling any local SET magic, as this isn't so much a
8140 set operation as merely an internal storage change. */
8141 sv_setsv_flags(sv, temp, 0);
8145 =for apidoc sv_unref_flags
8147 Unsets the RV status of the SV, and decrements the reference count of
8148 whatever was being referenced by the RV. This can almost be thought of
8149 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8150 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8151 (otherwise the decrementing is conditional on the reference count being
8152 different from one or the reference being a readonly SV).
8159 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8161 SV* const target = SvRV(ref);
8163 if (SvWEAKREF(ref)) {
8164 sv_del_backref(target, ref);
8166 SvRV_set(ref, NULL);
8169 SvRV_set(ref, NULL);
8171 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8172 assigned to as BEGIN {$a = \"Foo"} will fail. */
8173 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8174 SvREFCNT_dec(target);
8175 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8176 sv_2mortal(target); /* Schedule for freeing later */
8180 =for apidoc sv_untaint
8182 Untaint an SV. Use C<SvTAINTED_off> instead.
8187 Perl_sv_untaint(pTHX_ SV *sv)
8189 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8190 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8197 =for apidoc sv_tainted
8199 Test an SV for taintedness. Use C<SvTAINTED> instead.
8204 Perl_sv_tainted(pTHX_ SV *sv)
8206 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8207 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8208 if (mg && (mg->mg_len & 1) )
8215 =for apidoc sv_setpviv
8217 Copies an integer into the given SV, also updating its string value.
8218 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8224 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8226 char buf[TYPE_CHARS(UV)];
8228 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8230 sv_setpvn(sv, ptr, ebuf - ptr);
8234 =for apidoc sv_setpviv_mg
8236 Like C<sv_setpviv>, but also handles 'set' magic.
8242 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8248 #if defined(PERL_IMPLICIT_CONTEXT)
8250 /* pTHX_ magic can't cope with varargs, so this is a no-context
8251 * version of the main function, (which may itself be aliased to us).
8252 * Don't access this version directly.
8256 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8260 va_start(args, pat);
8261 sv_vsetpvf(sv, pat, &args);
8265 /* pTHX_ magic can't cope with varargs, so this is a no-context
8266 * version of the main function, (which may itself be aliased to us).
8267 * Don't access this version directly.
8271 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8275 va_start(args, pat);
8276 sv_vsetpvf_mg(sv, pat, &args);
8282 =for apidoc sv_setpvf
8284 Works like C<sv_catpvf> but copies the text into the SV instead of
8285 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8291 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8294 va_start(args, pat);
8295 sv_vsetpvf(sv, pat, &args);
8300 =for apidoc sv_vsetpvf
8302 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8303 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8305 Usually used via its frontend C<sv_setpvf>.
8311 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8313 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8317 =for apidoc sv_setpvf_mg
8319 Like C<sv_setpvf>, but also handles 'set' magic.
8325 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8328 va_start(args, pat);
8329 sv_vsetpvf_mg(sv, pat, &args);
8334 =for apidoc sv_vsetpvf_mg
8336 Like C<sv_vsetpvf>, but also handles 'set' magic.
8338 Usually used via its frontend C<sv_setpvf_mg>.
8344 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8346 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8350 #if defined(PERL_IMPLICIT_CONTEXT)
8352 /* pTHX_ magic can't cope with varargs, so this is a no-context
8353 * version of the main function, (which may itself be aliased to us).
8354 * Don't access this version directly.
8358 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8362 va_start(args, pat);
8363 sv_vcatpvf(sv, pat, &args);
8367 /* pTHX_ magic can't cope with varargs, so this is a no-context
8368 * version of the main function, (which may itself be aliased to us).
8369 * Don't access this version directly.
8373 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8377 va_start(args, pat);
8378 sv_vcatpvf_mg(sv, pat, &args);
8384 =for apidoc sv_catpvf
8386 Processes its arguments like C<sprintf> and appends the formatted
8387 output to an SV. If the appended data contains "wide" characters
8388 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8389 and characters >255 formatted with %c), the original SV might get
8390 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8391 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8392 valid UTF-8; if the original SV was bytes, the pattern should be too.
8397 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8400 va_start(args, pat);
8401 sv_vcatpvf(sv, pat, &args);
8406 =for apidoc sv_vcatpvf
8408 Processes its arguments like C<vsprintf> and appends the formatted output
8409 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8411 Usually used via its frontend C<sv_catpvf>.
8417 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8419 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8423 =for apidoc sv_catpvf_mg
8425 Like C<sv_catpvf>, but also handles 'set' magic.
8431 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8434 va_start(args, pat);
8435 sv_vcatpvf_mg(sv, pat, &args);
8440 =for apidoc sv_vcatpvf_mg
8442 Like C<sv_vcatpvf>, but also handles 'set' magic.
8444 Usually used via its frontend C<sv_catpvf_mg>.
8450 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8452 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8457 =for apidoc sv_vsetpvfn
8459 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8462 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8468 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8470 sv_setpvn(sv, "", 0);
8471 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8475 S_expect_number(pTHX_ char** pattern)
8479 switch (**pattern) {
8480 case '1': case '2': case '3':
8481 case '4': case '5': case '6':
8482 case '7': case '8': case '9':
8483 var = *(*pattern)++ - '0';
8484 while (isDIGIT(**pattern)) {
8485 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8487 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8495 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8497 const int neg = nv < 0;
8506 if (uv & 1 && uv == nv)
8507 uv--; /* Round to even */
8509 const unsigned dig = uv % 10;
8522 =for apidoc sv_vcatpvfn
8524 Processes its arguments like C<vsprintf> and appends the formatted output
8525 to an SV. Uses an array of SVs if the C style variable argument list is
8526 missing (NULL). When running with taint checks enabled, indicates via
8527 C<maybe_tainted> if results are untrustworthy (often due to the use of
8530 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8536 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8537 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8538 vec_utf8 = DO_UTF8(vecsv);
8540 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8543 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8551 static const char nullstr[] = "(null)";
8553 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8554 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8556 /* Times 4: a decimal digit takes more than 3 binary digits.
8557 * NV_DIG: mantissa takes than many decimal digits.
8558 * Plus 32: Playing safe. */
8559 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8560 /* large enough for "%#.#f" --chip */
8561 /* what about long double NVs? --jhi */
8563 PERL_UNUSED_ARG(maybe_tainted);
8565 /* no matter what, this is a string now */
8566 (void)SvPV_force(sv, origlen);
8568 /* special-case "", "%s", and "%-p" (SVf - see below) */
8571 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8573 const char * const s = va_arg(*args, char*);
8574 sv_catpv(sv, s ? s : nullstr);
8576 else if (svix < svmax) {
8577 sv_catsv(sv, *svargs);
8581 if (args && patlen == 3 && pat[0] == '%' &&
8582 pat[1] == '-' && pat[2] == 'p') {
8583 argsv = (SV*)va_arg(*args, void*);
8584 sv_catsv(sv, argsv);
8588 #ifndef USE_LONG_DOUBLE
8589 /* special-case "%.<number>[gf]" */
8590 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8591 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8592 unsigned digits = 0;
8596 while (*pp >= '0' && *pp <= '9')
8597 digits = 10 * digits + (*pp++ - '0');
8598 if (pp - pat == (int)patlen - 1) {
8606 /* Add check for digits != 0 because it seems that some
8607 gconverts are buggy in this case, and we don't yet have
8608 a Configure test for this. */
8609 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8610 /* 0, point, slack */
8611 Gconvert(nv, (int)digits, 0, ebuf);
8613 if (*ebuf) /* May return an empty string for digits==0 */
8616 } else if (!digits) {
8619 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8620 sv_catpvn(sv, p, l);
8626 #endif /* !USE_LONG_DOUBLE */
8628 if (!args && svix < svmax && DO_UTF8(*svargs))
8631 patend = (char*)pat + patlen;
8632 for (p = (char*)pat; p < patend; p = q) {
8635 bool vectorize = FALSE;
8636 bool vectorarg = FALSE;
8637 bool vec_utf8 = FALSE;
8643 bool has_precis = FALSE;
8645 const I32 osvix = svix;
8646 bool is_utf8 = FALSE; /* is this item utf8? */
8647 #ifdef HAS_LDBL_SPRINTF_BUG
8648 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8649 with sfio - Allen <allens@cpan.org> */
8650 bool fix_ldbl_sprintf_bug = FALSE;
8654 U8 utf8buf[UTF8_MAXBYTES+1];
8655 STRLEN esignlen = 0;
8657 const char *eptr = NULL;
8660 const U8 *vecstr = NULL;
8667 /* we need a long double target in case HAS_LONG_DOUBLE but
8670 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8678 const char *dotstr = ".";
8679 STRLEN dotstrlen = 1;
8680 I32 efix = 0; /* explicit format parameter index */
8681 I32 ewix = 0; /* explicit width index */
8682 I32 epix = 0; /* explicit precision index */
8683 I32 evix = 0; /* explicit vector index */
8684 bool asterisk = FALSE;
8686 /* echo everything up to the next format specification */
8687 for (q = p; q < patend && *q != '%'; ++q) ;
8689 if (has_utf8 && !pat_utf8)
8690 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8692 sv_catpvn(sv, p, q - p);
8699 We allow format specification elements in this order:
8700 \d+\$ explicit format parameter index
8702 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8703 0 flag (as above): repeated to allow "v02"
8704 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8705 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8707 [%bcdefginopsuxDFOUX] format (mandatory)
8712 As of perl5.9.3, printf format checking is on by default.
8713 Internally, perl uses %p formats to provide an escape to
8714 some extended formatting. This block deals with those
8715 extensions: if it does not match, (char*)q is reset and
8716 the normal format processing code is used.
8718 Currently defined extensions are:
8719 %p include pointer address (standard)
8720 %-p (SVf) include an SV (previously %_)
8721 %-<num>p include an SV with precision <num>
8722 %<num>p reserved for future extensions
8724 Robin Barker 2005-07-14
8726 %1p (VDf) removed. RMB 2007-10-19
8733 n = expect_number(&q);
8740 argsv = (SV*)va_arg(*args, void*);
8741 eptr = SvPV_const(argsv, elen);
8747 if (ckWARN_d(WARN_INTERNAL))
8748 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8749 "internal %%<num>p might conflict with future printf extensions");
8755 if ( (width = expect_number(&q)) ) {
8770 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8799 if ( (ewix = expect_number(&q)) )
8808 if ((vectorarg = asterisk)) {
8821 width = expect_number(&q);
8827 vecsv = va_arg(*args, SV*);
8829 vecsv = (evix > 0 && evix <= svmax)
8830 ? svargs[evix-1] : &PL_sv_undef;
8832 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8834 dotstr = SvPV_const(vecsv, dotstrlen);
8835 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8836 bad with tied or overloaded values that return UTF8. */
8839 else if (has_utf8) {
8840 vecsv = sv_mortalcopy(vecsv);
8841 sv_utf8_upgrade(vecsv);
8842 dotstr = SvPV_const(vecsv, dotstrlen);
8849 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8850 vecsv = svargs[efix ? efix-1 : svix++];
8851 vecstr = (U8*)SvPV_const(vecsv,veclen);
8852 vec_utf8 = DO_UTF8(vecsv);
8854 /* if this is a version object, we need to convert
8855 * back into v-string notation and then let the
8856 * vectorize happen normally
8858 if (sv_derived_from(vecsv, "version")) {
8859 char *version = savesvpv(vecsv);
8860 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8861 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8862 "vector argument not supported with alpha versions");
8865 vecsv = sv_newmortal();
8866 scan_vstring(version, version + veclen, vecsv);
8867 vecstr = (U8*)SvPV_const(vecsv, veclen);
8868 vec_utf8 = DO_UTF8(vecsv);
8880 i = va_arg(*args, int);
8882 i = (ewix ? ewix <= svmax : svix < svmax) ?
8883 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8885 width = (i < 0) ? -i : i;
8895 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8897 /* XXX: todo, support specified precision parameter */
8901 i = va_arg(*args, int);
8903 i = (ewix ? ewix <= svmax : svix < svmax)
8904 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8906 has_precis = !(i < 0);
8911 precis = precis * 10 + (*q++ - '0');
8920 case 'I': /* Ix, I32x, and I64x */
8922 if (q[1] == '6' && q[2] == '4') {
8928 if (q[1] == '3' && q[2] == '2') {
8938 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8949 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8950 if (*(q + 1) == 'l') { /* lld, llf */
8976 if (!vectorize && !args) {
8978 const I32 i = efix-1;
8979 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8981 argsv = (svix >= 0 && svix < svmax)
8982 ? svargs[svix++] : &PL_sv_undef;
8993 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8995 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8997 eptr = (char*)utf8buf;
8998 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9012 eptr = va_arg(*args, char*);
9014 #ifdef MACOS_TRADITIONAL
9015 /* On MacOS, %#s format is used for Pascal strings */
9020 elen = strlen(eptr);
9022 eptr = (char *)nullstr;
9023 elen = sizeof nullstr - 1;
9027 eptr = SvPV_const(argsv, elen);
9028 if (DO_UTF8(argsv)) {
9029 I32 old_precis = precis;
9030 if (has_precis && precis < elen) {
9032 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9035 if (width) { /* fudge width (can't fudge elen) */
9036 if (has_precis && precis < elen)
9037 width += precis - old_precis;
9039 width += elen - sv_len_utf8(argsv);
9046 if (has_precis && elen > precis)
9053 if (alt || vectorize)
9055 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9076 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9085 esignbuf[esignlen++] = plus;
9089 case 'h': iv = (short)va_arg(*args, int); break;
9090 case 'l': iv = va_arg(*args, long); break;
9091 case 'V': iv = va_arg(*args, IV); break;
9092 default: iv = va_arg(*args, int); break;
9094 case 'q': iv = va_arg(*args, Quad_t); break;
9099 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9101 case 'h': iv = (short)tiv; break;
9102 case 'l': iv = (long)tiv; break;
9104 default: iv = tiv; break;
9106 case 'q': iv = (Quad_t)tiv; break;
9110 if ( !vectorize ) /* we already set uv above */
9115 esignbuf[esignlen++] = plus;
9119 esignbuf[esignlen++] = '-';
9163 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9174 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9175 case 'l': uv = va_arg(*args, unsigned long); break;
9176 case 'V': uv = va_arg(*args, UV); break;
9177 default: uv = va_arg(*args, unsigned); break;
9179 case 'q': uv = va_arg(*args, Uquad_t); break;
9184 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9186 case 'h': uv = (unsigned short)tuv; break;
9187 case 'l': uv = (unsigned long)tuv; break;
9189 default: uv = tuv; break;
9191 case 'q': uv = (Uquad_t)tuv; break;
9198 char *ptr = ebuf + sizeof ebuf;
9199 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9205 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9211 esignbuf[esignlen++] = '0';
9212 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9220 if (alt && *ptr != '0')
9229 esignbuf[esignlen++] = '0';
9230 esignbuf[esignlen++] = c;
9233 default: /* it had better be ten or less */
9237 } while (uv /= base);
9240 elen = (ebuf + sizeof ebuf) - ptr;
9244 zeros = precis - elen;
9245 else if (precis == 0 && elen == 1 && *eptr == '0'
9246 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9249 /* a precision nullifies the 0 flag. */
9256 /* FLOATING POINT */
9259 c = 'f'; /* maybe %F isn't supported here */
9267 /* This is evil, but floating point is even more evil */
9269 /* for SV-style calling, we can only get NV
9270 for C-style calling, we assume %f is double;
9271 for simplicity we allow any of %Lf, %llf, %qf for long double
9275 #if defined(USE_LONG_DOUBLE)
9279 /* [perl #20339] - we should accept and ignore %lf rather than die */
9283 #if defined(USE_LONG_DOUBLE)
9284 intsize = args ? 0 : 'q';
9288 #if defined(HAS_LONG_DOUBLE)
9297 /* now we need (long double) if intsize == 'q', else (double) */
9299 #if LONG_DOUBLESIZE > DOUBLESIZE
9301 va_arg(*args, long double) :
9302 va_arg(*args, double)
9304 va_arg(*args, double)
9309 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9310 else. frexp() has some unspecified behaviour for those three */
9311 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9313 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9314 will cast our (long double) to (double) */
9315 (void)Perl_frexp(nv, &i);
9316 if (i == PERL_INT_MIN)
9317 Perl_die(aTHX_ "panic: frexp");
9319 need = BIT_DIGITS(i);
9321 need += has_precis ? precis : 6; /* known default */
9326 #ifdef HAS_LDBL_SPRINTF_BUG
9327 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9328 with sfio - Allen <allens@cpan.org> */
9331 # define MY_DBL_MAX DBL_MAX
9332 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9333 # if DOUBLESIZE >= 8
9334 # define MY_DBL_MAX 1.7976931348623157E+308L
9336 # define MY_DBL_MAX 3.40282347E+38L
9340 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9341 # define MY_DBL_MAX_BUG 1L
9343 # define MY_DBL_MAX_BUG MY_DBL_MAX
9347 # define MY_DBL_MIN DBL_MIN
9348 # else /* XXX guessing! -Allen */
9349 # if DOUBLESIZE >= 8
9350 # define MY_DBL_MIN 2.2250738585072014E-308L
9352 # define MY_DBL_MIN 1.17549435E-38L
9356 if ((intsize == 'q') && (c == 'f') &&
9357 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9359 /* it's going to be short enough that
9360 * long double precision is not needed */
9362 if ((nv <= 0L) && (nv >= -0L))
9363 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9365 /* would use Perl_fp_class as a double-check but not
9366 * functional on IRIX - see perl.h comments */
9368 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9369 /* It's within the range that a double can represent */
9370 #if defined(DBL_MAX) && !defined(DBL_MIN)
9371 if ((nv >= ((long double)1/DBL_MAX)) ||
9372 (nv <= (-(long double)1/DBL_MAX)))
9374 fix_ldbl_sprintf_bug = TRUE;
9377 if (fix_ldbl_sprintf_bug == TRUE) {
9387 # undef MY_DBL_MAX_BUG
9390 #endif /* HAS_LDBL_SPRINTF_BUG */
9392 need += 20; /* fudge factor */
9393 if (PL_efloatsize < need) {
9394 Safefree(PL_efloatbuf);
9395 PL_efloatsize = need + 20; /* more fudge */
9396 Newx(PL_efloatbuf, PL_efloatsize, char);
9397 PL_efloatbuf[0] = '\0';
9400 if ( !(width || left || plus || alt) && fill != '0'
9401 && has_precis && intsize != 'q' ) { /* Shortcuts */
9402 /* See earlier comment about buggy Gconvert when digits,
9404 if ( c == 'g' && precis) {
9405 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9406 /* May return an empty string for digits==0 */
9407 if (*PL_efloatbuf) {
9408 elen = strlen(PL_efloatbuf);
9409 goto float_converted;
9411 } else if ( c == 'f' && !precis) {
9412 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9417 char *ptr = ebuf + sizeof ebuf;
9420 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9421 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9422 if (intsize == 'q') {
9423 /* Copy the one or more characters in a long double
9424 * format before the 'base' ([efgEFG]) character to
9425 * the format string. */
9426 static char const prifldbl[] = PERL_PRIfldbl;
9427 char const *p = prifldbl + sizeof(prifldbl) - 3;
9428 while (p >= prifldbl) { *--ptr = *p--; }
9433 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9438 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9450 /* No taint. Otherwise we are in the strange situation
9451 * where printf() taints but print($float) doesn't.
9453 #if defined(HAS_LONG_DOUBLE)
9454 elen = ((intsize == 'q')
9455 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9456 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9458 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9462 eptr = PL_efloatbuf;
9470 i = SvCUR(sv) - origlen;
9473 case 'h': *(va_arg(*args, short*)) = i; break;
9474 default: *(va_arg(*args, int*)) = i; break;
9475 case 'l': *(va_arg(*args, long*)) = i; break;
9476 case 'V': *(va_arg(*args, IV*)) = i; break;
9478 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9483 sv_setuv_mg(argsv, (UV)i);
9484 continue; /* not "break" */
9491 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9492 && ckWARN(WARN_PRINTF))
9494 SV * const msg = sv_newmortal();
9495 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9496 (PL_op->op_type == OP_PRTF) ? "" : "s");
9499 Perl_sv_catpvf(aTHX_ msg,
9500 "\"%%%c\"", c & 0xFF);
9502 Perl_sv_catpvf(aTHX_ msg,
9503 "\"%%\\%03"UVof"\"",
9506 sv_catpvs(msg, "end of string");
9507 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9510 /* output mangled stuff ... */
9516 /* ... right here, because formatting flags should not apply */
9517 SvGROW(sv, SvCUR(sv) + elen + 1);
9519 Copy(eptr, p, elen, char);
9522 SvCUR_set(sv, p - SvPVX_const(sv));
9524 continue; /* not "break" */
9527 if (is_utf8 != has_utf8) {
9530 sv_utf8_upgrade(sv);
9533 const STRLEN old_elen = elen;
9534 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9535 sv_utf8_upgrade(nsv);
9536 eptr = SvPVX_const(nsv);
9539 if (width) { /* fudge width (can't fudge elen) */
9540 width += elen - old_elen;
9546 have = esignlen + zeros + elen;
9548 Perl_croak_nocontext(PL_memory_wrap);
9550 need = (have > width ? have : width);
9553 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9554 Perl_croak_nocontext(PL_memory_wrap);
9555 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9557 if (esignlen && fill == '0') {
9559 for (i = 0; i < (int)esignlen; i++)
9563 memset(p, fill, gap);
9566 if (esignlen && fill != '0') {
9568 for (i = 0; i < (int)esignlen; i++)
9573 for (i = zeros; i; i--)
9577 Copy(eptr, p, elen, char);
9581 memset(p, ' ', gap);
9586 Copy(dotstr, p, dotstrlen, char);
9590 vectorize = FALSE; /* done iterating over vecstr */
9597 SvCUR_set(sv, p - SvPVX_const(sv));
9605 /* =========================================================================
9607 =head1 Cloning an interpreter
9609 All the macros and functions in this section are for the private use of
9610 the main function, perl_clone().
9612 The foo_dup() functions make an exact copy of an existing foo thingy.
9613 During the course of a cloning, a hash table is used to map old addresses
9614 to new addresses. The table is created and manipulated with the
9615 ptr_table_* functions.
9619 ============================================================================*/
9622 #if defined(USE_ITHREADS)
9624 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9625 #ifndef GpREFCNT_inc
9626 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9630 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9631 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9632 If this changes, please unmerge ss_dup. */
9633 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9634 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9635 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9636 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9637 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9638 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9639 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9640 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9641 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9642 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9643 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9644 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9645 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9646 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9648 /* clone a parser */
9651 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9658 /* look for it in the table first */
9659 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9663 /* create anew and remember what it is */
9664 Newxz(parser, 1, yy_parser);
9665 ptr_table_store(PL_ptr_table, proto, parser);
9667 parser->yyerrstatus = 0;
9668 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9670 /* XXX these not yet duped */
9671 parser->old_parser = NULL;
9672 parser->stack = NULL;
9674 parser->stack_size = 0;
9675 /* XXX parser->stack->state = 0; */
9677 /* XXX eventually, just Copy() most of the parser struct ? */
9679 parser->lex_brackets = proto->lex_brackets;
9680 parser->lex_casemods = proto->lex_casemods;
9681 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9682 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9683 parser->lex_casestack = savepvn(proto->lex_casestack,
9684 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9685 parser->lex_defer = proto->lex_defer;
9686 parser->lex_dojoin = proto->lex_dojoin;
9687 parser->lex_expect = proto->lex_expect;
9688 parser->lex_formbrack = proto->lex_formbrack;
9689 parser->lex_inpat = proto->lex_inpat;
9690 parser->lex_inwhat = proto->lex_inwhat;
9691 parser->lex_op = proto->lex_op;
9692 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9693 parser->lex_starts = proto->lex_starts;
9694 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9695 parser->multi_close = proto->multi_close;
9696 parser->multi_open = proto->multi_open;
9697 parser->multi_start = proto->multi_start;
9698 parser->multi_end = proto->multi_end;
9699 parser->pending_ident = proto->pending_ident;
9700 parser->preambled = proto->preambled;
9701 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9702 parser->linestr = sv_dup_inc(proto->linestr, param);
9703 parser->expect = proto->expect;
9704 parser->copline = proto->copline;
9705 parser->last_lop_op = proto->last_lop_op;
9706 parser->lex_state = proto->lex_state;
9707 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9708 /* rsfp_filters entries have fake IoDIRP() */
9709 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9710 parser->in_my = proto->in_my;
9711 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9712 parser->error_count = proto->error_count;
9715 parser->linestr = sv_dup_inc(proto->linestr, param);
9718 char * const ols = SvPVX(proto->linestr);
9719 char * const ls = SvPVX(parser->linestr);
9721 parser->bufptr = ls + (proto->bufptr >= ols ?
9722 proto->bufptr - ols : 0);
9723 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9724 proto->oldbufptr - ols : 0);
9725 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9726 proto->oldoldbufptr - ols : 0);
9727 parser->linestart = ls + (proto->linestart >= ols ?
9728 proto->linestart - ols : 0);
9729 parser->last_uni = ls + (proto->last_uni >= ols ?
9730 proto->last_uni - ols : 0);
9731 parser->last_lop = ls + (proto->last_lop >= ols ?
9732 proto->last_lop - ols : 0);
9734 parser->bufend = ls + SvCUR(parser->linestr);
9737 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9741 parser->endwhite = proto->endwhite;
9742 parser->faketokens = proto->faketokens;
9743 parser->lasttoke = proto->lasttoke;
9744 parser->nextwhite = proto->nextwhite;
9745 parser->realtokenstart = proto->realtokenstart;
9746 parser->skipwhite = proto->skipwhite;
9747 parser->thisclose = proto->thisclose;
9748 parser->thismad = proto->thismad;
9749 parser->thisopen = proto->thisopen;
9750 parser->thisstuff = proto->thisstuff;
9751 parser->thistoken = proto->thistoken;
9752 parser->thiswhite = proto->thiswhite;
9754 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9755 parser->curforce = proto->curforce;
9757 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9758 Copy(proto->nexttype, parser->nexttype, 5, I32);
9759 parser->nexttoke = proto->nexttoke;
9765 /* duplicate a file handle */
9768 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9772 PERL_UNUSED_ARG(type);
9775 return (PerlIO*)NULL;
9777 /* look for it in the table first */
9778 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9782 /* create anew and remember what it is */
9783 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9784 ptr_table_store(PL_ptr_table, fp, ret);
9788 /* duplicate a directory handle */
9791 Perl_dirp_dup(pTHX_ DIR *dp)
9793 PERL_UNUSED_CONTEXT;
9800 /* duplicate a typeglob */
9803 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9809 /* look for it in the table first */
9810 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9814 /* create anew and remember what it is */
9816 ptr_table_store(PL_ptr_table, gp, ret);
9819 ret->gp_refcnt = 0; /* must be before any other dups! */
9820 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9821 ret->gp_io = io_dup_inc(gp->gp_io, param);
9822 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9823 ret->gp_av = av_dup_inc(gp->gp_av, param);
9824 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9825 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9826 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9827 ret->gp_cvgen = gp->gp_cvgen;
9828 ret->gp_line = gp->gp_line;
9829 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9833 /* duplicate a chain of magic */
9836 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9838 MAGIC *mgprev = (MAGIC*)NULL;
9841 return (MAGIC*)NULL;
9842 /* look for it in the table first */
9843 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9847 for (; mg; mg = mg->mg_moremagic) {
9849 Newxz(nmg, 1, MAGIC);
9851 mgprev->mg_moremagic = nmg;
9854 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9855 nmg->mg_private = mg->mg_private;
9856 nmg->mg_type = mg->mg_type;
9857 nmg->mg_flags = mg->mg_flags;
9858 /* FIXME for plugins
9859 if (mg->mg_type == PERL_MAGIC_qr) {
9860 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9864 if(mg->mg_type == PERL_MAGIC_backref) {
9865 /* The backref AV has its reference count deliberately bumped by
9867 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9870 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9871 ? sv_dup_inc(mg->mg_obj, param)
9872 : sv_dup(mg->mg_obj, param);
9874 nmg->mg_len = mg->mg_len;
9875 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9876 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9877 if (mg->mg_len > 0) {
9878 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9879 if (mg->mg_type == PERL_MAGIC_overload_table &&
9880 AMT_AMAGIC((AMT*)mg->mg_ptr))
9882 const AMT * const amtp = (AMT*)mg->mg_ptr;
9883 AMT * const namtp = (AMT*)nmg->mg_ptr;
9885 for (i = 1; i < NofAMmeth; i++) {
9886 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9890 else if (mg->mg_len == HEf_SVKEY)
9891 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9893 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9894 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9901 #endif /* USE_ITHREADS */
9903 /* create a new pointer-mapping table */
9906 Perl_ptr_table_new(pTHX)
9909 PERL_UNUSED_CONTEXT;
9911 Newxz(tbl, 1, PTR_TBL_t);
9914 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9918 #define PTR_TABLE_HASH(ptr) \
9919 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9922 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9923 following define) and at call to new_body_inline made below in
9924 Perl_ptr_table_store()
9927 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9929 /* map an existing pointer using a table */
9931 STATIC PTR_TBL_ENT_t *
9932 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9933 PTR_TBL_ENT_t *tblent;
9934 const UV hash = PTR_TABLE_HASH(sv);
9936 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9937 for (; tblent; tblent = tblent->next) {
9938 if (tblent->oldval == sv)
9945 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9947 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9948 PERL_UNUSED_CONTEXT;
9949 return tblent ? tblent->newval : NULL;
9952 /* add a new entry to a pointer-mapping table */
9955 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9957 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9958 PERL_UNUSED_CONTEXT;
9961 tblent->newval = newsv;
9963 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9965 new_body_inline(tblent, PTE_SVSLOT);
9967 tblent->oldval = oldsv;
9968 tblent->newval = newsv;
9969 tblent->next = tbl->tbl_ary[entry];
9970 tbl->tbl_ary[entry] = tblent;
9972 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9973 ptr_table_split(tbl);
9977 /* double the hash bucket size of an existing ptr table */
9980 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9982 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9983 const UV oldsize = tbl->tbl_max + 1;
9984 UV newsize = oldsize * 2;
9986 PERL_UNUSED_CONTEXT;
9988 Renew(ary, newsize, PTR_TBL_ENT_t*);
9989 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9990 tbl->tbl_max = --newsize;
9992 for (i=0; i < oldsize; i++, ary++) {
9993 PTR_TBL_ENT_t **curentp, **entp, *ent;
9996 curentp = ary + oldsize;
9997 for (entp = ary, ent = *ary; ent; ent = *entp) {
9998 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10000 ent->next = *curentp;
10010 /* remove all the entries from a ptr table */
10013 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10015 if (tbl && tbl->tbl_items) {
10016 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10017 UV riter = tbl->tbl_max;
10020 PTR_TBL_ENT_t *entry = array[riter];
10023 PTR_TBL_ENT_t * const oentry = entry;
10024 entry = entry->next;
10029 tbl->tbl_items = 0;
10033 /* clear and free a ptr table */
10036 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10041 ptr_table_clear(tbl);
10042 Safefree(tbl->tbl_ary);
10046 #if defined(USE_ITHREADS)
10049 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10052 SvRV_set(dstr, SvWEAKREF(sstr)
10053 ? sv_dup(SvRV(sstr), param)
10054 : sv_dup_inc(SvRV(sstr), param));
10057 else if (SvPVX_const(sstr)) {
10058 /* Has something there */
10060 /* Normal PV - clone whole allocated space */
10061 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10062 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10063 /* Not that normal - actually sstr is copy on write.
10064 But we are a true, independant SV, so: */
10065 SvREADONLY_off(dstr);
10070 /* Special case - not normally malloced for some reason */
10071 if (isGV_with_GP(sstr)) {
10072 /* Don't need to do anything here. */
10074 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10075 /* A "shared" PV - clone it as "shared" PV */
10077 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10081 /* Some other special case - random pointer */
10082 SvPV_set(dstr, SvPVX(sstr));
10087 /* Copy the NULL */
10088 SvPV_set(dstr, NULL);
10092 /* duplicate an SV of any type (including AV, HV etc) */
10095 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10100 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10102 /* look for it in the table first */
10103 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10107 if(param->flags & CLONEf_JOIN_IN) {
10108 /** We are joining here so we don't want do clone
10109 something that is bad **/
10110 if (SvTYPE(sstr) == SVt_PVHV) {
10111 const HEK * const hvname = HvNAME_HEK(sstr);
10113 /** don't clone stashes if they already exist **/
10114 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10118 /* create anew and remember what it is */
10121 #ifdef DEBUG_LEAKING_SCALARS
10122 dstr->sv_debug_optype = sstr->sv_debug_optype;
10123 dstr->sv_debug_line = sstr->sv_debug_line;
10124 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10125 dstr->sv_debug_cloned = 1;
10126 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10129 ptr_table_store(PL_ptr_table, sstr, dstr);
10132 SvFLAGS(dstr) = SvFLAGS(sstr);
10133 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10134 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10137 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10138 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10139 (void*)PL_watch_pvx, SvPVX_const(sstr));
10142 /* don't clone objects whose class has asked us not to */
10143 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10148 switch (SvTYPE(sstr)) {
10150 SvANY(dstr) = NULL;
10153 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10155 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10157 SvIV_set(dstr, SvIVX(sstr));
10161 SvANY(dstr) = new_XNV();
10162 SvNV_set(dstr, SvNVX(sstr));
10164 /* case SVt_BIND: */
10167 /* These are all the types that need complex bodies allocating. */
10169 const svtype sv_type = SvTYPE(sstr);
10170 const struct body_details *const sv_type_details
10171 = bodies_by_type + sv_type;
10175 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10179 if (GvUNIQUE((GV*)sstr)) {
10180 NOOP; /* Do sharing here, and fall through */
10193 assert(sv_type_details->body_size);
10194 if (sv_type_details->arena) {
10195 new_body_inline(new_body, sv_type);
10197 = (void*)((char*)new_body - sv_type_details->offset);
10199 new_body = new_NOARENA(sv_type_details);
10203 SvANY(dstr) = new_body;
10206 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10207 ((char*)SvANY(dstr)) + sv_type_details->offset,
10208 sv_type_details->copy, char);
10210 Copy(((char*)SvANY(sstr)),
10211 ((char*)SvANY(dstr)),
10212 sv_type_details->body_size + sv_type_details->offset, char);
10215 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10216 && !isGV_with_GP(dstr))
10217 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10219 /* The Copy above means that all the source (unduplicated) pointers
10220 are now in the destination. We can check the flags and the
10221 pointers in either, but it's possible that there's less cache
10222 missing by always going for the destination.
10223 FIXME - instrument and check that assumption */
10224 if (sv_type >= SVt_PVMG) {
10225 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10226 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10227 } else if (SvMAGIC(dstr))
10228 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10230 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10233 /* The cast silences a GCC warning about unhandled types. */
10234 switch ((int)sv_type) {
10244 /* FIXME for plugins */
10245 re_dup_guts(sstr, dstr, param);
10248 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10249 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10250 LvTARG(dstr) = dstr;
10251 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10252 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10254 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10256 if(isGV_with_GP(sstr)) {
10257 if (GvNAME_HEK(dstr))
10258 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10259 /* Don't call sv_add_backref here as it's going to be
10260 created as part of the magic cloning of the symbol
10262 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10263 at the point of this comment. */
10264 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10265 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10266 (void)GpREFCNT_inc(GvGP(dstr));
10268 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10271 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10272 if (IoOFP(dstr) == IoIFP(sstr))
10273 IoOFP(dstr) = IoIFP(dstr);
10275 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10276 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10277 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10278 /* I have no idea why fake dirp (rsfps)
10279 should be treated differently but otherwise
10280 we end up with leaks -- sky*/
10281 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10282 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10283 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10285 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10286 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10287 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10288 if (IoDIRP(dstr)) {
10289 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10292 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10295 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10296 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10297 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10300 if (AvARRAY((AV*)sstr)) {
10301 SV **dst_ary, **src_ary;
10302 SSize_t items = AvFILLp((AV*)sstr) + 1;
10304 src_ary = AvARRAY((AV*)sstr);
10305 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10306 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10307 AvARRAY((AV*)dstr) = dst_ary;
10308 AvALLOC((AV*)dstr) = dst_ary;
10309 if (AvREAL((AV*)sstr)) {
10310 while (items-- > 0)
10311 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10314 while (items-- > 0)
10315 *dst_ary++ = sv_dup(*src_ary++, param);
10317 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10318 while (items-- > 0) {
10319 *dst_ary++ = &PL_sv_undef;
10323 AvARRAY((AV*)dstr) = NULL;
10324 AvALLOC((AV*)dstr) = (SV**)NULL;
10328 if (HvARRAY((HV*)sstr)) {
10330 const bool sharekeys = !!HvSHAREKEYS(sstr);
10331 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10332 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10334 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10335 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10337 HvARRAY(dstr) = (HE**)darray;
10338 while (i <= sxhv->xhv_max) {
10339 const HE * const source = HvARRAY(sstr)[i];
10340 HvARRAY(dstr)[i] = source
10341 ? he_dup(source, sharekeys, param) : 0;
10346 const struct xpvhv_aux * const saux = HvAUX(sstr);
10347 struct xpvhv_aux * const daux = HvAUX(dstr);
10348 /* This flag isn't copied. */
10349 /* SvOOK_on(hv) attacks the IV flags. */
10350 SvFLAGS(dstr) |= SVf_OOK;
10352 hvname = saux->xhv_name;
10353 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10355 daux->xhv_riter = saux->xhv_riter;
10356 daux->xhv_eiter = saux->xhv_eiter
10357 ? he_dup(saux->xhv_eiter,
10358 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10359 daux->xhv_backreferences =
10360 saux->xhv_backreferences
10361 ? (AV*) SvREFCNT_inc(
10362 sv_dup((SV*)saux->xhv_backreferences, param))
10365 daux->xhv_mro_meta = saux->xhv_mro_meta
10366 ? mro_meta_dup(saux->xhv_mro_meta, param)
10369 /* Record stashes for possible cloning in Perl_clone(). */
10371 av_push(param->stashes, dstr);
10375 HvARRAY((HV*)dstr) = NULL;
10378 if (!(param->flags & CLONEf_COPY_STACKS)) {
10382 /* NOTE: not refcounted */
10383 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10385 if (!CvISXSUB(dstr))
10386 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10388 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10389 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10390 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10391 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10393 /* don't dup if copying back - CvGV isn't refcounted, so the
10394 * duped GV may never be freed. A bit of a hack! DAPM */
10395 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10396 NULL : gv_dup(CvGV(dstr), param) ;
10397 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10399 CvWEAKOUTSIDE(sstr)
10400 ? cv_dup( CvOUTSIDE(dstr), param)
10401 : cv_dup_inc(CvOUTSIDE(dstr), param);
10402 if (!CvISXSUB(dstr))
10403 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10409 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10415 /* duplicate a context */
10418 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10420 PERL_CONTEXT *ncxs;
10423 return (PERL_CONTEXT*)NULL;
10425 /* look for it in the table first */
10426 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10430 /* create anew and remember what it is */
10431 Newxz(ncxs, max + 1, PERL_CONTEXT);
10432 ptr_table_store(PL_ptr_table, cxs, ncxs);
10435 PERL_CONTEXT * const cx = &cxs[ix];
10436 PERL_CONTEXT * const ncx = &ncxs[ix];
10437 ncx->cx_type = cx->cx_type;
10438 if (CxTYPE(cx) == CXt_SUBST) {
10439 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10442 ncx->blk_oldsp = cx->blk_oldsp;
10443 ncx->blk_oldcop = cx->blk_oldcop;
10444 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10445 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10446 ncx->blk_oldpm = cx->blk_oldpm;
10447 ncx->blk_gimme = cx->blk_gimme;
10448 switch (CxTYPE(cx)) {
10450 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10451 ? cv_dup_inc(cx->blk_sub.cv, param)
10452 : cv_dup(cx->blk_sub.cv,param));
10453 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10454 ? av_dup_inc(cx->blk_sub.argarray, param)
10456 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10457 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10458 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10459 ncx->blk_sub.lval = cx->blk_sub.lval;
10460 ncx->blk_sub.retop = cx->blk_sub.retop;
10461 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10462 cx->blk_sub.oldcomppad);
10465 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10466 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10467 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10468 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10469 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10470 ncx->blk_eval.retop = cx->blk_eval.retop;
10473 ncx->blk_loop.label = cx->blk_loop.label;
10474 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10475 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10476 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10477 ? cx->blk_loop.iterdata
10478 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10479 ncx->blk_loop.oldcomppad
10480 = (PAD*)ptr_table_fetch(PL_ptr_table,
10481 cx->blk_loop.oldcomppad);
10482 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10483 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10484 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10485 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10486 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10489 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10490 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10491 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10492 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10493 ncx->blk_sub.retop = cx->blk_sub.retop;
10505 /* duplicate a stack info structure */
10508 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10513 return (PERL_SI*)NULL;
10515 /* look for it in the table first */
10516 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10520 /* create anew and remember what it is */
10521 Newxz(nsi, 1, PERL_SI);
10522 ptr_table_store(PL_ptr_table, si, nsi);
10524 nsi->si_stack = av_dup_inc(si->si_stack, param);
10525 nsi->si_cxix = si->si_cxix;
10526 nsi->si_cxmax = si->si_cxmax;
10527 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10528 nsi->si_type = si->si_type;
10529 nsi->si_prev = si_dup(si->si_prev, param);
10530 nsi->si_next = si_dup(si->si_next, param);
10531 nsi->si_markoff = si->si_markoff;
10536 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10537 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10538 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10539 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10540 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10541 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10542 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10543 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10544 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10545 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10546 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10547 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10548 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10549 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10552 #define pv_dup_inc(p) SAVEPV(p)
10553 #define pv_dup(p) SAVEPV(p)
10554 #define svp_dup_inc(p,pp) any_dup(p,pp)
10556 /* map any object to the new equivent - either something in the
10557 * ptr table, or something in the interpreter structure
10561 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10566 return (void*)NULL;
10568 /* look for it in the table first */
10569 ret = ptr_table_fetch(PL_ptr_table, v);
10573 /* see if it is part of the interpreter structure */
10574 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10575 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10583 /* duplicate the save stack */
10586 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10589 ANY * const ss = proto_perl->Isavestack;
10590 const I32 max = proto_perl->Isavestack_max;
10591 I32 ix = proto_perl->Isavestack_ix;
10604 void (*dptr) (void*);
10605 void (*dxptr) (pTHX_ void*);
10607 Newxz(nss, max, ANY);
10610 const I32 type = POPINT(ss,ix);
10611 TOPINT(nss,ix) = type;
10613 case SAVEt_HELEM: /* hash element */
10614 sv = (SV*)POPPTR(ss,ix);
10615 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10617 case SAVEt_ITEM: /* normal string */
10618 case SAVEt_SV: /* scalar reference */
10619 sv = (SV*)POPPTR(ss,ix);
10620 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10623 case SAVEt_MORTALIZESV:
10624 sv = (SV*)POPPTR(ss,ix);
10625 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10627 case SAVEt_SHARED_PVREF: /* char* in shared space */
10628 c = (char*)POPPTR(ss,ix);
10629 TOPPTR(nss,ix) = savesharedpv(c);
10630 ptr = POPPTR(ss,ix);
10631 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10633 case SAVEt_GENERIC_SVREF: /* generic sv */
10634 case SAVEt_SVREF: /* scalar reference */
10635 sv = (SV*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10637 ptr = POPPTR(ss,ix);
10638 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10640 case SAVEt_HV: /* hash reference */
10641 case SAVEt_AV: /* array reference */
10642 sv = (SV*) POPPTR(ss,ix);
10643 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10645 case SAVEt_COMPPAD:
10647 sv = (SV*) POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = sv_dup(sv, param);
10650 case SAVEt_INT: /* int reference */
10651 ptr = POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10653 intval = (int)POPINT(ss,ix);
10654 TOPINT(nss,ix) = intval;
10656 case SAVEt_LONG: /* long reference */
10657 ptr = POPPTR(ss,ix);
10658 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10660 case SAVEt_CLEARSV:
10661 longval = (long)POPLONG(ss,ix);
10662 TOPLONG(nss,ix) = longval;
10664 case SAVEt_I32: /* I32 reference */
10665 case SAVEt_I16: /* I16 reference */
10666 case SAVEt_I8: /* I8 reference */
10667 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10668 ptr = POPPTR(ss,ix);
10669 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10671 TOPINT(nss,ix) = i;
10673 case SAVEt_IV: /* IV reference */
10674 ptr = POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10677 TOPIV(nss,ix) = iv;
10679 case SAVEt_HPTR: /* HV* reference */
10680 case SAVEt_APTR: /* AV* reference */
10681 case SAVEt_SPTR: /* SV* reference */
10682 ptr = POPPTR(ss,ix);
10683 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10684 sv = (SV*)POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = sv_dup(sv, param);
10687 case SAVEt_VPTR: /* random* reference */
10688 ptr = POPPTR(ss,ix);
10689 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10690 ptr = POPPTR(ss,ix);
10691 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10693 case SAVEt_GENERIC_PVREF: /* generic char* */
10694 case SAVEt_PPTR: /* char* reference */
10695 ptr = POPPTR(ss,ix);
10696 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10697 c = (char*)POPPTR(ss,ix);
10698 TOPPTR(nss,ix) = pv_dup(c);
10700 case SAVEt_GP: /* scalar reference */
10701 gp = (GP*)POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10703 (void)GpREFCNT_inc(gp);
10704 gv = (GV*)POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10708 ptr = POPPTR(ss,ix);
10709 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10710 /* these are assumed to be refcounted properly */
10712 switch (((OP*)ptr)->op_type) {
10714 case OP_LEAVESUBLV:
10718 case OP_LEAVEWRITE:
10719 TOPPTR(nss,ix) = ptr;
10722 (void) OpREFCNT_inc(o);
10726 TOPPTR(nss,ix) = NULL;
10731 TOPPTR(nss,ix) = NULL;
10734 c = (char*)POPPTR(ss,ix);
10735 TOPPTR(nss,ix) = pv_dup_inc(c);
10738 hv = (HV*)POPPTR(ss,ix);
10739 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10740 c = (char*)POPPTR(ss,ix);
10741 TOPPTR(nss,ix) = pv_dup_inc(c);
10743 case SAVEt_STACK_POS: /* Position on Perl stack */
10745 TOPINT(nss,ix) = i;
10747 case SAVEt_DESTRUCTOR:
10748 ptr = POPPTR(ss,ix);
10749 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10750 dptr = POPDPTR(ss,ix);
10751 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10752 any_dup(FPTR2DPTR(void *, dptr),
10755 case SAVEt_DESTRUCTOR_X:
10756 ptr = POPPTR(ss,ix);
10757 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10758 dxptr = POPDXPTR(ss,ix);
10759 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10760 any_dup(FPTR2DPTR(void *, dxptr),
10763 case SAVEt_REGCONTEXT:
10766 TOPINT(nss,ix) = i;
10769 case SAVEt_AELEM: /* array element */
10770 sv = (SV*)POPPTR(ss,ix);
10771 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10773 TOPINT(nss,ix) = i;
10774 av = (AV*)POPPTR(ss,ix);
10775 TOPPTR(nss,ix) = av_dup_inc(av, param);
10778 ptr = POPPTR(ss,ix);
10779 TOPPTR(nss,ix) = ptr;
10783 TOPINT(nss,ix) = i;
10784 ptr = POPPTR(ss,ix);
10787 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10788 HINTS_REFCNT_UNLOCK;
10790 TOPPTR(nss,ix) = ptr;
10791 if (i & HINT_LOCALIZE_HH) {
10792 hv = (HV*)POPPTR(ss,ix);
10793 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10797 longval = (long)POPLONG(ss,ix);
10798 TOPLONG(nss,ix) = longval;
10799 ptr = POPPTR(ss,ix);
10800 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10801 sv = (SV*)POPPTR(ss,ix);
10802 TOPPTR(nss,ix) = sv_dup(sv, param);
10805 ptr = POPPTR(ss,ix);
10806 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10807 longval = (long)POPBOOL(ss,ix);
10808 TOPBOOL(nss,ix) = (bool)longval;
10810 case SAVEt_SET_SVFLAGS:
10812 TOPINT(nss,ix) = i;
10814 TOPINT(nss,ix) = i;
10815 sv = (SV*)POPPTR(ss,ix);
10816 TOPPTR(nss,ix) = sv_dup(sv, param);
10818 case SAVEt_RE_STATE:
10820 const struct re_save_state *const old_state
10821 = (struct re_save_state *)
10822 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10823 struct re_save_state *const new_state
10824 = (struct re_save_state *)
10825 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10827 Copy(old_state, new_state, 1, struct re_save_state);
10828 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10830 new_state->re_state_bostr
10831 = pv_dup(old_state->re_state_bostr);
10832 new_state->re_state_reginput
10833 = pv_dup(old_state->re_state_reginput);
10834 new_state->re_state_regeol
10835 = pv_dup(old_state->re_state_regeol);
10836 new_state->re_state_regoffs
10837 = (regexp_paren_pair*)
10838 any_dup(old_state->re_state_regoffs, proto_perl);
10839 new_state->re_state_reglastparen
10840 = (U32*) any_dup(old_state->re_state_reglastparen,
10842 new_state->re_state_reglastcloseparen
10843 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10845 /* XXX This just has to be broken. The old save_re_context
10846 code did SAVEGENERICPV(PL_reg_start_tmp);
10847 PL_reg_start_tmp is char **.
10848 Look above to what the dup code does for
10849 SAVEt_GENERIC_PVREF
10850 It can never have worked.
10851 So this is merely a faithful copy of the exiting bug: */
10852 new_state->re_state_reg_start_tmp
10853 = (char **) pv_dup((char *)
10854 old_state->re_state_reg_start_tmp);
10855 /* I assume that it only ever "worked" because no-one called
10856 (pseudo)fork while the regexp engine had re-entered itself.
10858 #ifdef PERL_OLD_COPY_ON_WRITE
10859 new_state->re_state_nrs
10860 = sv_dup(old_state->re_state_nrs, param);
10862 new_state->re_state_reg_magic
10863 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10865 new_state->re_state_reg_oldcurpm
10866 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10868 new_state->re_state_reg_curpm
10869 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10871 new_state->re_state_reg_oldsaved
10872 = pv_dup(old_state->re_state_reg_oldsaved);
10873 new_state->re_state_reg_poscache
10874 = pv_dup(old_state->re_state_reg_poscache);
10875 new_state->re_state_reg_starttry
10876 = pv_dup(old_state->re_state_reg_starttry);
10879 case SAVEt_COMPILE_WARNINGS:
10880 ptr = POPPTR(ss,ix);
10881 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10884 ptr = POPPTR(ss,ix);
10885 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10889 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10897 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10898 * flag to the result. This is done for each stash before cloning starts,
10899 * so we know which stashes want their objects cloned */
10902 do_mark_cloneable_stash(pTHX_ SV *sv)
10904 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10906 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10907 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10908 if (cloner && GvCV(cloner)) {
10915 mXPUSHs(newSVhek(hvname));
10917 call_sv((SV*)GvCV(cloner), G_SCALAR);
10924 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10932 =for apidoc perl_clone
10934 Create and return a new interpreter by cloning the current one.
10936 perl_clone takes these flags as parameters:
10938 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10939 without it we only clone the data and zero the stacks,
10940 with it we copy the stacks and the new perl interpreter is
10941 ready to run at the exact same point as the previous one.
10942 The pseudo-fork code uses COPY_STACKS while the
10943 threads->create doesn't.
10945 CLONEf_KEEP_PTR_TABLE
10946 perl_clone keeps a ptr_table with the pointer of the old
10947 variable as a key and the new variable as a value,
10948 this allows it to check if something has been cloned and not
10949 clone it again but rather just use the value and increase the
10950 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10951 the ptr_table using the function
10952 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10953 reason to keep it around is if you want to dup some of your own
10954 variable who are outside the graph perl scans, example of this
10955 code is in threads.xs create
10958 This is a win32 thing, it is ignored on unix, it tells perls
10959 win32host code (which is c++) to clone itself, this is needed on
10960 win32 if you want to run two threads at the same time,
10961 if you just want to do some stuff in a separate perl interpreter
10962 and then throw it away and return to the original one,
10963 you don't need to do anything.
10968 /* XXX the above needs expanding by someone who actually understands it ! */
10969 EXTERN_C PerlInterpreter *
10970 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10973 perl_clone(PerlInterpreter *proto_perl, UV flags)
10976 #ifdef PERL_IMPLICIT_SYS
10978 /* perlhost.h so we need to call into it
10979 to clone the host, CPerlHost should have a c interface, sky */
10981 if (flags & CLONEf_CLONE_HOST) {
10982 return perl_clone_host(proto_perl,flags);
10984 return perl_clone_using(proto_perl, flags,
10986 proto_perl->IMemShared,
10987 proto_perl->IMemParse,
10989 proto_perl->IStdIO,
10993 proto_perl->IProc);
10997 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10998 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10999 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11000 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11001 struct IPerlDir* ipD, struct IPerlSock* ipS,
11002 struct IPerlProc* ipP)
11004 /* XXX many of the string copies here can be optimized if they're
11005 * constants; they need to be allocated as common memory and just
11006 * their pointers copied. */
11009 CLONE_PARAMS clone_params;
11010 CLONE_PARAMS* const param = &clone_params;
11012 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11013 /* for each stash, determine whether its objects should be cloned */
11014 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11015 PERL_SET_THX(my_perl);
11018 PoisonNew(my_perl, 1, PerlInterpreter);
11024 PL_savestack_ix = 0;
11025 PL_savestack_max = -1;
11026 PL_sig_pending = 0;
11028 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11029 # else /* !DEBUGGING */
11030 Zero(my_perl, 1, PerlInterpreter);
11031 # endif /* DEBUGGING */
11033 /* host pointers */
11035 PL_MemShared = ipMS;
11036 PL_MemParse = ipMP;
11043 #else /* !PERL_IMPLICIT_SYS */
11045 CLONE_PARAMS clone_params;
11046 CLONE_PARAMS* param = &clone_params;
11047 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11048 /* for each stash, determine whether its objects should be cloned */
11049 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11050 PERL_SET_THX(my_perl);
11053 PoisonNew(my_perl, 1, PerlInterpreter);
11059 PL_savestack_ix = 0;
11060 PL_savestack_max = -1;
11061 PL_sig_pending = 0;
11063 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11064 # else /* !DEBUGGING */
11065 Zero(my_perl, 1, PerlInterpreter);
11066 # endif /* DEBUGGING */
11067 #endif /* PERL_IMPLICIT_SYS */
11068 param->flags = flags;
11069 param->proto_perl = proto_perl;
11071 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11073 PL_body_arenas = NULL;
11074 Zero(&PL_body_roots, 1, PL_body_roots);
11076 PL_nice_chunk = NULL;
11077 PL_nice_chunk_size = 0;
11079 PL_sv_objcount = 0;
11081 PL_sv_arenaroot = NULL;
11083 PL_debug = proto_perl->Idebug;
11085 PL_hash_seed = proto_perl->Ihash_seed;
11086 PL_rehash_seed = proto_perl->Irehash_seed;
11088 #ifdef USE_REENTRANT_API
11089 /* XXX: things like -Dm will segfault here in perlio, but doing
11090 * PERL_SET_CONTEXT(proto_perl);
11091 * breaks too many other things
11093 Perl_reentrant_init(aTHX);
11096 /* create SV map for pointer relocation */
11097 PL_ptr_table = ptr_table_new();
11099 /* initialize these special pointers as early as possible */
11100 SvANY(&PL_sv_undef) = NULL;
11101 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11102 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11103 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11105 SvANY(&PL_sv_no) = new_XPVNV();
11106 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11107 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11108 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11109 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11110 SvCUR_set(&PL_sv_no, 0);
11111 SvLEN_set(&PL_sv_no, 1);
11112 SvIV_set(&PL_sv_no, 0);
11113 SvNV_set(&PL_sv_no, 0);
11114 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11116 SvANY(&PL_sv_yes) = new_XPVNV();
11117 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11118 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11119 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11120 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11121 SvCUR_set(&PL_sv_yes, 1);
11122 SvLEN_set(&PL_sv_yes, 2);
11123 SvIV_set(&PL_sv_yes, 1);
11124 SvNV_set(&PL_sv_yes, 1);
11125 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11127 /* create (a non-shared!) shared string table */
11128 PL_strtab = newHV();
11129 HvSHAREKEYS_off(PL_strtab);
11130 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11131 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11133 PL_compiling = proto_perl->Icompiling;
11135 /* These two PVs will be free'd special way so must set them same way op.c does */
11136 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11137 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11139 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11140 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11142 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11143 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11144 if (PL_compiling.cop_hints_hash) {
11146 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11147 HINTS_REFCNT_UNLOCK;
11149 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11150 #ifdef PERL_DEBUG_READONLY_OPS
11155 /* pseudo environmental stuff */
11156 PL_origargc = proto_perl->Iorigargc;
11157 PL_origargv = proto_perl->Iorigargv;
11159 param->stashes = newAV(); /* Setup array of objects to call clone on */
11161 /* Set tainting stuff before PerlIO_debug can possibly get called */
11162 PL_tainting = proto_perl->Itainting;
11163 PL_taint_warn = proto_perl->Itaint_warn;
11165 #ifdef PERLIO_LAYERS
11166 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11167 PerlIO_clone(aTHX_ proto_perl, param);
11170 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11171 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11172 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11173 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11174 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11175 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11178 PL_minus_c = proto_perl->Iminus_c;
11179 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11180 PL_localpatches = proto_perl->Ilocalpatches;
11181 PL_splitstr = proto_perl->Isplitstr;
11182 PL_preprocess = proto_perl->Ipreprocess;
11183 PL_minus_n = proto_perl->Iminus_n;
11184 PL_minus_p = proto_perl->Iminus_p;
11185 PL_minus_l = proto_perl->Iminus_l;
11186 PL_minus_a = proto_perl->Iminus_a;
11187 PL_minus_E = proto_perl->Iminus_E;
11188 PL_minus_F = proto_perl->Iminus_F;
11189 PL_doswitches = proto_perl->Idoswitches;
11190 PL_dowarn = proto_perl->Idowarn;
11191 PL_doextract = proto_perl->Idoextract;
11192 PL_sawampersand = proto_perl->Isawampersand;
11193 PL_unsafe = proto_perl->Iunsafe;
11194 PL_inplace = SAVEPV(proto_perl->Iinplace);
11195 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11196 PL_perldb = proto_perl->Iperldb;
11197 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11198 PL_exit_flags = proto_perl->Iexit_flags;
11200 /* magical thingies */
11201 /* XXX time(&PL_basetime) when asked for? */
11202 PL_basetime = proto_perl->Ibasetime;
11203 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11205 PL_maxsysfd = proto_perl->Imaxsysfd;
11206 PL_statusvalue = proto_perl->Istatusvalue;
11208 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11210 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11212 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11214 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11215 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11216 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11219 /* RE engine related */
11220 Zero(&PL_reg_state, 1, struct re_save_state);
11221 PL_reginterp_cnt = 0;
11222 PL_regmatch_slab = NULL;
11224 /* Clone the regex array */
11225 PL_regex_padav = newAV();
11227 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11228 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11230 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11231 for(i = 1; i <= len; i++) {
11232 const SV * const regex = regexen[i];
11233 /* FIXME for plugins
11234 newSViv(PTR2IV(CALLREGDUPE(
11235 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11237 /* And while we're at it, can we FIXME on the whole hiding
11238 pointer inside an IV hack? */
11241 ? sv_dup_inc(regex, param)
11243 newSViv(PTR2IV(sv_dup_inc(INT2PTR(REGEXP *, SvIVX(regex)), param))))
11245 if (SvFLAGS(regex) & SVf_BREAK)
11246 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11247 av_push(PL_regex_padav, sv);
11250 PL_regex_pad = AvARRAY(PL_regex_padav);
11252 /* shortcuts to various I/O objects */
11253 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11254 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11255 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11256 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11257 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11258 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11260 /* shortcuts to regexp stuff */
11261 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11263 /* shortcuts to misc objects */
11264 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11266 /* shortcuts to debugging objects */
11267 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11268 PL_DBline = gv_dup(proto_perl->IDBline, param);
11269 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11270 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11271 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11272 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11273 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11275 /* symbol tables */
11276 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11277 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11278 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11279 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11280 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11282 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11283 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11284 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11285 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11286 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11287 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11288 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11289 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11291 PL_sub_generation = proto_perl->Isub_generation;
11292 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11294 /* funky return mechanisms */
11295 PL_forkprocess = proto_perl->Iforkprocess;
11297 /* subprocess state */
11298 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11300 /* internal state */
11301 PL_maxo = proto_perl->Imaxo;
11302 if (proto_perl->Iop_mask)
11303 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11306 /* PL_asserting = proto_perl->Iasserting; */
11308 /* current interpreter roots */
11309 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11311 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11313 PL_main_start = proto_perl->Imain_start;
11314 PL_eval_root = proto_perl->Ieval_root;
11315 PL_eval_start = proto_perl->Ieval_start;
11317 /* runtime control stuff */
11318 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11320 PL_filemode = proto_perl->Ifilemode;
11321 PL_lastfd = proto_perl->Ilastfd;
11322 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11325 PL_gensym = proto_perl->Igensym;
11326 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11327 PL_laststatval = proto_perl->Ilaststatval;
11328 PL_laststype = proto_perl->Ilaststype;
11331 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11333 /* interpreter atexit processing */
11334 PL_exitlistlen = proto_perl->Iexitlistlen;
11335 if (PL_exitlistlen) {
11336 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11337 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11340 PL_exitlist = (PerlExitListEntry*)NULL;
11342 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11343 if (PL_my_cxt_size) {
11344 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11345 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11346 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11347 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11348 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11352 PL_my_cxt_list = (void**)NULL;
11353 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11354 PL_my_cxt_keys = (const char**)NULL;
11357 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11358 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11359 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11361 PL_profiledata = NULL;
11363 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11365 PAD_CLONE_VARS(proto_perl, param);
11367 #ifdef HAVE_INTERP_INTERN
11368 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11371 /* more statics moved here */
11372 PL_generation = proto_perl->Igeneration;
11373 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11375 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11376 PL_in_clean_all = proto_perl->Iin_clean_all;
11378 PL_uid = proto_perl->Iuid;
11379 PL_euid = proto_perl->Ieuid;
11380 PL_gid = proto_perl->Igid;
11381 PL_egid = proto_perl->Iegid;
11382 PL_nomemok = proto_perl->Inomemok;
11383 PL_an = proto_perl->Ian;
11384 PL_evalseq = proto_perl->Ievalseq;
11385 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11386 PL_origalen = proto_perl->Iorigalen;
11387 #ifdef PERL_USES_PL_PIDSTATUS
11388 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11390 PL_osname = SAVEPV(proto_perl->Iosname);
11391 PL_sighandlerp = proto_perl->Isighandlerp;
11393 PL_runops = proto_perl->Irunops;
11395 PL_parser = parser_dup(proto_perl->Iparser, param);
11397 PL_subline = proto_perl->Isubline;
11398 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11401 PL_cryptseen = proto_perl->Icryptseen;
11404 PL_hints = proto_perl->Ihints;
11406 PL_amagic_generation = proto_perl->Iamagic_generation;
11408 #ifdef USE_LOCALE_COLLATE
11409 PL_collation_ix = proto_perl->Icollation_ix;
11410 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11411 PL_collation_standard = proto_perl->Icollation_standard;
11412 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11413 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11414 #endif /* USE_LOCALE_COLLATE */
11416 #ifdef USE_LOCALE_NUMERIC
11417 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11418 PL_numeric_standard = proto_perl->Inumeric_standard;
11419 PL_numeric_local = proto_perl->Inumeric_local;
11420 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11421 #endif /* !USE_LOCALE_NUMERIC */
11423 /* utf8 character classes */
11424 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11425 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11426 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11427 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11428 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11429 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11430 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11431 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11432 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11433 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11434 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11435 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11436 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11437 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11438 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11439 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11440 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11441 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11442 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11443 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11445 /* Did the locale setup indicate UTF-8? */
11446 PL_utf8locale = proto_perl->Iutf8locale;
11447 /* Unicode features (see perlrun/-C) */
11448 PL_unicode = proto_perl->Iunicode;
11450 /* Pre-5.8 signals control */
11451 PL_signals = proto_perl->Isignals;
11453 /* times() ticks per second */
11454 PL_clocktick = proto_perl->Iclocktick;
11456 /* Recursion stopper for PerlIO_find_layer */
11457 PL_in_load_module = proto_perl->Iin_load_module;
11459 /* sort() routine */
11460 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11462 /* Not really needed/useful since the reenrant_retint is "volatile",
11463 * but do it for consistency's sake. */
11464 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11466 /* Hooks to shared SVs and locks. */
11467 PL_sharehook = proto_perl->Isharehook;
11468 PL_lockhook = proto_perl->Ilockhook;
11469 PL_unlockhook = proto_perl->Iunlockhook;
11470 PL_threadhook = proto_perl->Ithreadhook;
11471 PL_destroyhook = proto_perl->Idestroyhook;
11473 #ifdef THREADS_HAVE_PIDS
11474 PL_ppid = proto_perl->Ippid;
11478 PL_last_swash_hv = NULL; /* reinits on demand */
11479 PL_last_swash_klen = 0;
11480 PL_last_swash_key[0]= '\0';
11481 PL_last_swash_tmps = (U8*)NULL;
11482 PL_last_swash_slen = 0;
11484 PL_glob_index = proto_perl->Iglob_index;
11485 PL_srand_called = proto_perl->Isrand_called;
11486 PL_bitcount = NULL; /* reinits on demand */
11488 if (proto_perl->Ipsig_pend) {
11489 Newxz(PL_psig_pend, SIG_SIZE, int);
11492 PL_psig_pend = (int*)NULL;
11495 if (proto_perl->Ipsig_ptr) {
11496 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11497 Newxz(PL_psig_name, SIG_SIZE, SV*);
11498 for (i = 1; i < SIG_SIZE; i++) {
11499 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11500 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11504 PL_psig_ptr = (SV**)NULL;
11505 PL_psig_name = (SV**)NULL;
11508 /* intrpvar.h stuff */
11510 if (flags & CLONEf_COPY_STACKS) {
11511 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11512 PL_tmps_ix = proto_perl->Itmps_ix;
11513 PL_tmps_max = proto_perl->Itmps_max;
11514 PL_tmps_floor = proto_perl->Itmps_floor;
11515 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11517 while (i <= PL_tmps_ix) {
11518 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11522 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11523 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11524 Newxz(PL_markstack, i, I32);
11525 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11526 - proto_perl->Imarkstack);
11527 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11528 - proto_perl->Imarkstack);
11529 Copy(proto_perl->Imarkstack, PL_markstack,
11530 PL_markstack_ptr - PL_markstack + 1, I32);
11532 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11533 * NOTE: unlike the others! */
11534 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11535 PL_scopestack_max = proto_perl->Iscopestack_max;
11536 Newxz(PL_scopestack, PL_scopestack_max, I32);
11537 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11539 /* NOTE: si_dup() looks at PL_markstack */
11540 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11542 /* PL_curstack = PL_curstackinfo->si_stack; */
11543 PL_curstack = av_dup(proto_perl->Icurstack, param);
11544 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11546 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11547 PL_stack_base = AvARRAY(PL_curstack);
11548 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11549 - proto_perl->Istack_base);
11550 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11552 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11553 * NOTE: unlike the others! */
11554 PL_savestack_ix = proto_perl->Isavestack_ix;
11555 PL_savestack_max = proto_perl->Isavestack_max;
11556 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11557 PL_savestack = ss_dup(proto_perl, param);
11561 ENTER; /* perl_destruct() wants to LEAVE; */
11563 /* although we're not duplicating the tmps stack, we should still
11564 * add entries for any SVs on the tmps stack that got cloned by a
11565 * non-refcount means (eg a temp in @_); otherwise they will be
11568 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11569 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11570 proto_perl->Itmps_stack[i]);
11571 if (nsv && !SvREFCNT(nsv)) {
11573 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11578 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11579 PL_top_env = &PL_start_env;
11581 PL_op = proto_perl->Iop;
11584 PL_Xpv = (XPV*)NULL;
11585 my_perl->Ina = proto_perl->Ina;
11587 PL_statbuf = proto_perl->Istatbuf;
11588 PL_statcache = proto_perl->Istatcache;
11589 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11590 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11592 PL_timesbuf = proto_perl->Itimesbuf;
11595 PL_tainted = proto_perl->Itainted;
11596 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11597 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11598 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11599 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11600 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11601 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11602 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11603 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11604 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11606 PL_restartop = proto_perl->Irestartop;
11607 PL_in_eval = proto_perl->Iin_eval;
11608 PL_delaymagic = proto_perl->Idelaymagic;
11609 PL_dirty = proto_perl->Idirty;
11610 PL_localizing = proto_perl->Ilocalizing;
11612 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11613 PL_hv_fetch_ent_mh = NULL;
11614 PL_modcount = proto_perl->Imodcount;
11615 PL_lastgotoprobe = NULL;
11616 PL_dumpindent = proto_perl->Idumpindent;
11618 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11619 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11620 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11621 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11622 PL_efloatbuf = NULL; /* reinits on demand */
11623 PL_efloatsize = 0; /* reinits on demand */
11627 PL_screamfirst = NULL;
11628 PL_screamnext = NULL;
11629 PL_maxscream = -1; /* reinits on demand */
11630 PL_lastscream = NULL;
11633 PL_regdummy = proto_perl->Iregdummy;
11634 PL_colorset = 0; /* reinits PL_colors[] */
11635 /*PL_colors[6] = {0,0,0,0,0,0};*/
11639 /* Pluggable optimizer */
11640 PL_peepp = proto_perl->Ipeepp;
11642 PL_stashcache = newHV();
11644 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11645 proto_perl->Iwatchaddr);
11646 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11647 if (PL_debug && PL_watchaddr) {
11648 PerlIO_printf(Perl_debug_log,
11649 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11650 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11651 PTR2UV(PL_watchok));
11654 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11655 ptr_table_free(PL_ptr_table);
11656 PL_ptr_table = NULL;
11659 /* Call the ->CLONE method, if it exists, for each of the stashes
11660 identified by sv_dup() above.
11662 while(av_len(param->stashes) != -1) {
11663 HV* const stash = (HV*) av_shift(param->stashes);
11664 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11665 if (cloner && GvCV(cloner)) {
11670 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11672 call_sv((SV*)GvCV(cloner), G_DISCARD);
11678 SvREFCNT_dec(param->stashes);
11680 /* orphaned? eg threads->new inside BEGIN or use */
11681 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11682 SvREFCNT_inc_simple_void(PL_compcv);
11683 SAVEFREESV(PL_compcv);
11689 #endif /* USE_ITHREADS */
11692 =head1 Unicode Support
11694 =for apidoc sv_recode_to_utf8
11696 The encoding is assumed to be an Encode object, on entry the PV
11697 of the sv is assumed to be octets in that encoding, and the sv
11698 will be converted into Unicode (and UTF-8).
11700 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11701 is not a reference, nothing is done to the sv. If the encoding is not
11702 an C<Encode::XS> Encoding object, bad things will happen.
11703 (See F<lib/encoding.pm> and L<Encode>).
11705 The PV of the sv is returned.
11710 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11713 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11727 Passing sv_yes is wrong - it needs to be or'ed set of constants
11728 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11729 remove converted chars from source.
11731 Both will default the value - let them.
11733 XPUSHs(&PL_sv_yes);
11736 call_method("decode", G_SCALAR);
11740 s = SvPV_const(uni, len);
11741 if (s != SvPVX_const(sv)) {
11742 SvGROW(sv, len + 1);
11743 Move(s, SvPVX(sv), len + 1, char);
11744 SvCUR_set(sv, len);
11751 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11755 =for apidoc sv_cat_decode
11757 The encoding is assumed to be an Encode object, the PV of the ssv is
11758 assumed to be octets in that encoding and decoding the input starts
11759 from the position which (PV + *offset) pointed to. The dsv will be
11760 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11761 when the string tstr appears in decoding output or the input ends on
11762 the PV of the ssv. The value which the offset points will be modified
11763 to the last input position on the ssv.
11765 Returns TRUE if the terminator was found, else returns FALSE.
11770 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11771 SV *ssv, int *offset, char *tstr, int tlen)
11775 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11786 offsv = newSViv(*offset);
11788 mXPUSHp(tstr, tlen);
11790 call_method("cat_decode", G_SCALAR);
11792 ret = SvTRUE(TOPs);
11793 *offset = SvIV(offsv);
11799 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11804 /* ---------------------------------------------------------------------
11806 * support functions for report_uninit()
11809 /* the maxiumum size of array or hash where we will scan looking
11810 * for the undefined element that triggered the warning */
11812 #define FUV_MAX_SEARCH_SIZE 1000
11814 /* Look for an entry in the hash whose value has the same SV as val;
11815 * If so, return a mortal copy of the key. */
11818 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11821 register HE **array;
11824 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11825 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11828 array = HvARRAY(hv);
11830 for (i=HvMAX(hv); i>0; i--) {
11831 register HE *entry;
11832 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11833 if (HeVAL(entry) != val)
11835 if ( HeVAL(entry) == &PL_sv_undef ||
11836 HeVAL(entry) == &PL_sv_placeholder)
11840 if (HeKLEN(entry) == HEf_SVKEY)
11841 return sv_mortalcopy(HeKEY_sv(entry));
11842 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11848 /* Look for an entry in the array whose value has the same SV as val;
11849 * If so, return the index, otherwise return -1. */
11852 S_find_array_subscript(pTHX_ AV *av, SV* val)
11855 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11856 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11859 if (val != &PL_sv_undef) {
11860 SV ** const svp = AvARRAY(av);
11863 for (i=AvFILLp(av); i>=0; i--)
11870 /* S_varname(): return the name of a variable, optionally with a subscript.
11871 * If gv is non-zero, use the name of that global, along with gvtype (one
11872 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11873 * targ. Depending on the value of the subscript_type flag, return:
11876 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11877 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11878 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11879 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11882 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11883 SV* keyname, I32 aindex, int subscript_type)
11886 SV * const name = sv_newmortal();
11889 buffer[0] = gvtype;
11892 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11894 gv_fullname4(name, gv, buffer, 0);
11896 if ((unsigned int)SvPVX(name)[1] <= 26) {
11898 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11900 /* Swap the 1 unprintable control character for the 2 byte pretty
11901 version - ie substr($name, 1, 1) = $buffer; */
11902 sv_insert(name, 1, 1, buffer, 2);
11906 CV * const cv = find_runcv(NULL);
11910 if (!cv || !CvPADLIST(cv))
11912 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11913 sv = *av_fetch(av, targ, FALSE);
11914 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11917 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11918 SV * const sv = newSV(0);
11919 *SvPVX(name) = '$';
11920 Perl_sv_catpvf(aTHX_ name, "{%s}",
11921 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11924 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11925 *SvPVX(name) = '$';
11926 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11928 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11929 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11936 =for apidoc find_uninit_var
11938 Find the name of the undefined variable (if any) that caused the operator o
11939 to issue a "Use of uninitialized value" warning.
11940 If match is true, only return a name if it's value matches uninit_sv.
11941 So roughly speaking, if a unary operator (such as OP_COS) generates a
11942 warning, then following the direct child of the op may yield an
11943 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11944 other hand, with OP_ADD there are two branches to follow, so we only print
11945 the variable name if we get an exact match.
11947 The name is returned as a mortal SV.
11949 Assumes that PL_op is the op that originally triggered the error, and that
11950 PL_comppad/PL_curpad points to the currently executing pad.
11956 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11964 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11965 uninit_sv == &PL_sv_placeholder)))
11968 switch (obase->op_type) {
11975 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11976 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11979 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11981 if (pad) { /* @lex, %lex */
11982 sv = PAD_SVl(obase->op_targ);
11986 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11987 /* @global, %global */
11988 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11991 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11993 else /* @{expr}, %{expr} */
11994 return find_uninit_var(cUNOPx(obase)->op_first,
11998 /* attempt to find a match within the aggregate */
12000 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12002 subscript_type = FUV_SUBSCRIPT_HASH;
12005 index = find_array_subscript((AV*)sv, uninit_sv);
12007 subscript_type = FUV_SUBSCRIPT_ARRAY;
12010 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12013 return varname(gv, hash ? '%' : '@', obase->op_targ,
12014 keysv, index, subscript_type);
12018 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12020 return varname(NULL, '$', obase->op_targ,
12021 NULL, 0, FUV_SUBSCRIPT_NONE);
12024 gv = cGVOPx_gv(obase);
12025 if (!gv || (match && GvSV(gv) != uninit_sv))
12027 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12030 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12033 av = (AV*)PAD_SV(obase->op_targ);
12034 if (!av || SvRMAGICAL(av))
12036 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12037 if (!svp || *svp != uninit_sv)
12040 return varname(NULL, '$', obase->op_targ,
12041 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12044 gv = cGVOPx_gv(obase);
12050 if (!av || SvRMAGICAL(av))
12052 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12053 if (!svp || *svp != uninit_sv)
12056 return varname(gv, '$', 0,
12057 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12062 o = cUNOPx(obase)->op_first;
12063 if (!o || o->op_type != OP_NULL ||
12064 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12066 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12070 if (PL_op == obase)
12071 /* $a[uninit_expr] or $h{uninit_expr} */
12072 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12075 o = cBINOPx(obase)->op_first;
12076 kid = cBINOPx(obase)->op_last;
12078 /* get the av or hv, and optionally the gv */
12080 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12081 sv = PAD_SV(o->op_targ);
12083 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12084 && cUNOPo->op_first->op_type == OP_GV)
12086 gv = cGVOPx_gv(cUNOPo->op_first);
12089 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12094 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12095 /* index is constant */
12099 if (obase->op_type == OP_HELEM) {
12100 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12101 if (!he || HeVAL(he) != uninit_sv)
12105 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12106 if (!svp || *svp != uninit_sv)
12110 if (obase->op_type == OP_HELEM)
12111 return varname(gv, '%', o->op_targ,
12112 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12114 return varname(gv, '@', o->op_targ, NULL,
12115 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12118 /* index is an expression;
12119 * attempt to find a match within the aggregate */
12120 if (obase->op_type == OP_HELEM) {
12121 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12123 return varname(gv, '%', o->op_targ,
12124 keysv, 0, FUV_SUBSCRIPT_HASH);
12127 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12129 return varname(gv, '@', o->op_targ,
12130 NULL, index, FUV_SUBSCRIPT_ARRAY);
12135 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12137 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12142 /* only examine RHS */
12143 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12146 o = cUNOPx(obase)->op_first;
12147 if (o->op_type == OP_PUSHMARK)
12150 if (!o->op_sibling) {
12151 /* one-arg version of open is highly magical */
12153 if (o->op_type == OP_GV) { /* open FOO; */
12155 if (match && GvSV(gv) != uninit_sv)
12157 return varname(gv, '$', 0,
12158 NULL, 0, FUV_SUBSCRIPT_NONE);
12160 /* other possibilities not handled are:
12161 * open $x; or open my $x; should return '${*$x}'
12162 * open expr; should return '$'.expr ideally
12168 /* ops where $_ may be an implicit arg */
12172 if ( !(obase->op_flags & OPf_STACKED)) {
12173 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12174 ? PAD_SVl(obase->op_targ)
12177 sv = sv_newmortal();
12178 sv_setpvn(sv, "$_", 2);
12187 /* skip filehandle as it can't produce 'undef' warning */
12188 o = cUNOPx(obase)->op_first;
12189 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12190 o = o->op_sibling->op_sibling;
12196 match = 1; /* XS or custom code could trigger random warnings */
12201 /* XXX tmp hack: these two may call an XS sub, and currently
12202 XS subs don't have a SUB entry on the context stack, so CV and
12203 pad determination goes wrong, and BAD things happen. So, just
12204 don't try to determine the value under those circumstances.
12205 Need a better fix at dome point. DAPM 11/2007 */
12209 /* def-ness of rval pos() is independent of the def-ness of its arg */
12210 if ( !(obase->op_flags & OPf_MOD))
12215 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12216 return newSVpvs_flags("${$/}", SVs_TEMP);
12221 if (!(obase->op_flags & OPf_KIDS))
12223 o = cUNOPx(obase)->op_first;
12229 /* if all except one arg are constant, or have no side-effects,
12230 * or are optimized away, then it's unambiguous */
12232 for (kid=o; kid; kid = kid->op_sibling) {
12234 const OPCODE type = kid->op_type;
12235 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12236 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12237 || (type == OP_PUSHMARK)
12241 if (o2) { /* more than one found */
12248 return find_uninit_var(o2, uninit_sv, match);
12250 /* scan all args */
12252 sv = find_uninit_var(o, uninit_sv, 1);
12264 =for apidoc report_uninit
12266 Print appropriate "Use of uninitialized variable" warning
12272 Perl_report_uninit(pTHX_ SV* uninit_sv)
12276 SV* varname = NULL;
12278 varname = find_uninit_var(PL_op, uninit_sv,0);
12280 sv_insert(varname, 0, 0, " ", 1);
12282 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12283 varname ? SvPV_nolen_const(varname) : "",
12284 " in ", OP_DESC(PL_op));
12287 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12293 * c-indentation-style: bsd
12294 * c-basic-offset: 4
12295 * indent-tabs-mode: t
12298 * ex: set ts=8 sts=4 sw=4 noet: