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 xregexp), copy_length(struct xregexp, xrx_regexp), 0,
921 SVt_REGEXP, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(struct xregexp))
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 sentinals 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 = sv_2mortal(newSVpvs(""));
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) {
2717 = (SV*)((struct xregexp *)SvANY(referent))->xrx_regexp;
2718 assert(temp.mg_obj);
2719 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2724 PL_reginterp_cnt += haseval;
2727 const char *const typestr = sv_reftype(referent, 0);
2728 const STRLEN typelen = strlen(typestr);
2729 UV addr = PTR2UV(referent);
2730 const char *stashname = NULL;
2731 STRLEN stashnamelen = 0; /* hush, gcc */
2732 const char *buffer_end;
2734 if (SvOBJECT(referent)) {
2735 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2738 stashname = HEK_KEY(name);
2739 stashnamelen = HEK_LEN(name);
2741 if (HEK_UTF8(name)) {
2747 stashname = "__ANON__";
2750 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2751 + 2 * sizeof(UV) + 2 /* )\0 */;
2753 len = typelen + 3 /* (0x */
2754 + 2 * sizeof(UV) + 2 /* )\0 */;
2757 Newx(buffer, len, char);
2758 buffer_end = retval = buffer + len;
2760 /* Working backwards */
2764 *--retval = PL_hexdigit[addr & 15];
2765 } while (addr >>= 4);
2771 memcpy(retval, typestr, typelen);
2775 retval -= stashnamelen;
2776 memcpy(retval, stashname, stashnamelen);
2778 /* retval may not neccesarily have reached the start of the
2780 assert (retval >= buffer);
2782 len = buffer_end - retval - 1; /* -1 for that \0 */
2790 if (SvREADONLY(sv) && !SvOK(sv)) {
2791 if (ckWARN(WARN_UNINITIALIZED))
2798 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2799 /* I'm assuming that if both IV and NV are equally valid then
2800 converting the IV is going to be more efficient */
2801 const U32 isUIOK = SvIsUV(sv);
2802 char buf[TYPE_CHARS(UV)];
2806 if (SvTYPE(sv) < SVt_PVIV)
2807 sv_upgrade(sv, SVt_PVIV);
2808 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2810 /* inlined from sv_setpvn */
2811 s = SvGROW_mutable(sv, len + 1);
2812 Move(ptr, s, len, char);
2816 else if (SvNOKp(sv)) {
2817 const int olderrno = errno;
2818 if (SvTYPE(sv) < SVt_PVNV)
2819 sv_upgrade(sv, SVt_PVNV);
2820 /* The +20 is pure guesswork. Configure test needed. --jhi */
2821 s = SvGROW_mutable(sv, NV_DIG + 20);
2822 /* some Xenix systems wipe out errno here */
2824 if (SvNVX(sv) == 0.0)
2825 my_strlcpy(s, "0", SvLEN(sv));
2829 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2832 #ifdef FIXNEGATIVEZERO
2833 if (*s == '-' && s[1] == '0' && !s[2]) {
2845 if (isGV_with_GP(sv))
2846 return glob_2pv((GV *)sv, lp);
2848 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2852 if (SvTYPE(sv) < SVt_PV)
2853 /* Typically the caller expects that sv_any is not NULL now. */
2854 sv_upgrade(sv, SVt_PV);
2858 const STRLEN len = s - SvPVX_const(sv);
2864 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2865 PTR2UV(sv),SvPVX_const(sv)));
2866 if (flags & SV_CONST_RETURN)
2867 return (char *)SvPVX_const(sv);
2868 if (flags & SV_MUTABLE_RETURN)
2869 return SvPVX_mutable(sv);
2874 =for apidoc sv_copypv
2876 Copies a stringified representation of the source SV into the
2877 destination SV. Automatically performs any necessary mg_get and
2878 coercion of numeric values into strings. Guaranteed to preserve
2879 UTF8 flag even from overloaded objects. Similar in nature to
2880 sv_2pv[_flags] but operates directly on an SV instead of just the
2881 string. Mostly uses sv_2pv_flags to do its work, except when that
2882 would lose the UTF-8'ness of the PV.
2888 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2891 const char * const s = SvPV_const(ssv,len);
2892 sv_setpvn(dsv,s,len);
2900 =for apidoc sv_2pvbyte
2902 Return a pointer to the byte-encoded representation of the SV, and set *lp
2903 to its length. May cause the SV to be downgraded from UTF-8 as a
2906 Usually accessed via the C<SvPVbyte> macro.
2912 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2914 sv_utf8_downgrade(sv,0);
2915 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2919 =for apidoc sv_2pvutf8
2921 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2922 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2924 Usually accessed via the C<SvPVutf8> macro.
2930 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2932 sv_utf8_upgrade(sv);
2933 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2938 =for apidoc sv_2bool
2940 This function is only called on magical items, and is only used by
2941 sv_true() or its macro equivalent.
2947 Perl_sv_2bool(pTHX_ register SV *sv)
2956 SV * const tmpsv = AMG_CALLun(sv,bool_);
2957 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2958 return (bool)SvTRUE(tmpsv);
2960 return SvRV(sv) != 0;
2963 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2965 (*sv->sv_u.svu_pv > '0' ||
2966 Xpvtmp->xpv_cur > 1 ||
2967 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2974 return SvIVX(sv) != 0;
2977 return SvNVX(sv) != 0.0;
2979 if (isGV_with_GP(sv))
2989 =for apidoc sv_utf8_upgrade
2991 Converts the PV of an SV to its UTF-8-encoded form.
2992 Forces the SV to string form if it is not already.
2993 Always sets the SvUTF8 flag to avoid future validity checks even
2994 if all the bytes have hibit clear.
2996 This is not as a general purpose byte encoding to Unicode interface:
2997 use the Encode extension for that.
2999 =for apidoc sv_utf8_upgrade_flags
3001 Converts the PV of an SV to its UTF-8-encoded form.
3002 Forces the SV to string form if it is not already.
3003 Always sets the SvUTF8 flag to avoid future validity checks even
3004 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3005 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3006 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3008 This is not as a general purpose byte encoding to Unicode interface:
3009 use the Encode extension for that.
3015 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3018 if (sv == &PL_sv_undef)
3022 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3023 (void) sv_2pv_flags(sv,&len, flags);
3027 (void) SvPV_force(sv,len);
3036 sv_force_normal_flags(sv, 0);
3039 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3040 sv_recode_to_utf8(sv, PL_encoding);
3041 else { /* Assume Latin-1/EBCDIC */
3042 /* This function could be much more efficient if we
3043 * had a FLAG in SVs to signal if there are any hibit
3044 * chars in the PV. Given that there isn't such a flag
3045 * make the loop as fast as possible. */
3046 const U8 * const s = (U8 *) SvPVX_const(sv);
3047 const U8 * const e = (U8 *) SvEND(sv);
3052 /* Check for hi bit */
3053 if (!NATIVE_IS_INVARIANT(ch)) {
3054 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3055 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3057 SvPV_free(sv); /* No longer using what was there before. */
3058 SvPV_set(sv, (char*)recoded);
3059 SvCUR_set(sv, len - 1);
3060 SvLEN_set(sv, len); /* No longer know the real size. */
3064 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3071 =for apidoc sv_utf8_downgrade
3073 Attempts to convert the PV of an SV from characters to bytes.
3074 If the PV contains a character beyond byte, this conversion will fail;
3075 in this case, either returns false or, if C<fail_ok> is not
3078 This is not as a general purpose Unicode to byte encoding interface:
3079 use the Encode extension for that.
3085 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3088 if (SvPOKp(sv) && SvUTF8(sv)) {
3094 sv_force_normal_flags(sv, 0);
3096 s = (U8 *) SvPV(sv, len);
3097 if (!utf8_to_bytes(s, &len)) {
3102 Perl_croak(aTHX_ "Wide character in %s",
3105 Perl_croak(aTHX_ "Wide character");
3116 =for apidoc sv_utf8_encode
3118 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3119 flag off so that it looks like octets again.
3125 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3128 sv_force_normal_flags(sv, 0);
3130 if (SvREADONLY(sv)) {
3131 Perl_croak(aTHX_ PL_no_modify);
3133 (void) sv_utf8_upgrade(sv);
3138 =for apidoc sv_utf8_decode
3140 If the PV of the SV is an octet sequence in UTF-8
3141 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3142 so that it looks like a character. If the PV contains only single-byte
3143 characters, the C<SvUTF8> flag stays being off.
3144 Scans PV for validity and returns false if the PV is invalid UTF-8.
3150 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3156 /* The octets may have got themselves encoded - get them back as
3159 if (!sv_utf8_downgrade(sv, TRUE))
3162 /* it is actually just a matter of turning the utf8 flag on, but
3163 * we want to make sure everything inside is valid utf8 first.
3165 c = (const U8 *) SvPVX_const(sv);
3166 if (!is_utf8_string(c, SvCUR(sv)+1))
3168 e = (const U8 *) SvEND(sv);
3171 if (!UTF8_IS_INVARIANT(ch)) {
3181 =for apidoc sv_setsv
3183 Copies the contents of the source SV C<ssv> into the destination SV
3184 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3185 function if the source SV needs to be reused. Does not handle 'set' magic.
3186 Loosely speaking, it performs a copy-by-value, obliterating any previous
3187 content of the destination.
3189 You probably want to use one of the assortment of wrappers, such as
3190 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3191 C<SvSetMagicSV_nosteal>.
3193 =for apidoc sv_setsv_flags
3195 Copies the contents of the source SV C<ssv> into the destination SV
3196 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3197 function if the source SV needs to be reused. Does not handle 'set' magic.
3198 Loosely speaking, it performs a copy-by-value, obliterating any previous
3199 content of the destination.
3200 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3201 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3202 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3203 and C<sv_setsv_nomg> are implemented in terms of this function.
3205 You probably want to use one of the assortment of wrappers, such as
3206 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3207 C<SvSetMagicSV_nosteal>.
3209 This is the primary function for copying scalars, and most other
3210 copy-ish functions and macros use this underneath.
3216 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3218 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3220 if (dtype != SVt_PVGV) {
3221 const char * const name = GvNAME(sstr);
3222 const STRLEN len = GvNAMELEN(sstr);
3224 if (dtype >= SVt_PV) {
3230 SvUPGRADE(dstr, SVt_PVGV);
3231 (void)SvOK_off(dstr);
3232 /* FIXME - why are we doing this, then turning it off and on again
3234 isGV_with_GP_on(dstr);
3236 GvSTASH(dstr) = GvSTASH(sstr);
3238 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3239 gv_name_set((GV *)dstr, name, len, GV_ADD);
3240 SvFAKE_on(dstr); /* can coerce to non-glob */
3243 #ifdef GV_UNIQUE_CHECK
3244 if (GvUNIQUE((GV*)dstr)) {
3245 Perl_croak(aTHX_ PL_no_modify);
3249 if(GvGP((GV*)sstr)) {
3250 /* If source has method cache entry, clear it */
3252 SvREFCNT_dec(GvCV(sstr));
3256 /* If source has a real method, then a method is
3258 else if(GvCV((GV*)sstr)) {
3263 /* If dest already had a real method, that's a change as well */
3264 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3268 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3272 isGV_with_GP_off(dstr);
3273 (void)SvOK_off(dstr);
3274 isGV_with_GP_on(dstr);
3275 GvINTRO_off(dstr); /* one-shot flag */
3276 GvGP(dstr) = gp_ref(GvGP(sstr));
3277 if (SvTAINTED(sstr))
3279 if (GvIMPORTED(dstr) != GVf_IMPORTED
3280 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3282 GvIMPORTED_on(dstr);
3285 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3286 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3291 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3292 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3294 const int intro = GvINTRO(dstr);
3297 const U32 stype = SvTYPE(sref);
3300 #ifdef GV_UNIQUE_CHECK
3301 if (GvUNIQUE((GV*)dstr)) {
3302 Perl_croak(aTHX_ PL_no_modify);
3307 GvINTRO_off(dstr); /* one-shot flag */
3308 GvLINE(dstr) = CopLINE(PL_curcop);
3309 GvEGV(dstr) = (GV*)dstr;
3314 location = (SV **) &GvCV(dstr);
3315 import_flag = GVf_IMPORTED_CV;
3318 location = (SV **) &GvHV(dstr);
3319 import_flag = GVf_IMPORTED_HV;
3322 location = (SV **) &GvAV(dstr);
3323 import_flag = GVf_IMPORTED_AV;
3326 location = (SV **) &GvIOp(dstr);
3329 location = (SV **) &GvFORM(dstr);
3331 location = &GvSV(dstr);
3332 import_flag = GVf_IMPORTED_SV;
3335 if (stype == SVt_PVCV) {
3336 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3337 if (GvCVGEN(dstr)) {
3338 SvREFCNT_dec(GvCV(dstr));
3340 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3343 SAVEGENERICSV(*location);
3347 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3348 CV* const cv = (CV*)*location;
3350 if (!GvCVGEN((GV*)dstr) &&
3351 (CvROOT(cv) || CvXSUB(cv)))
3353 /* Redefining a sub - warning is mandatory if
3354 it was a const and its value changed. */
3355 if (CvCONST(cv) && CvCONST((CV*)sref)
3356 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3358 /* They are 2 constant subroutines generated from
3359 the same constant. This probably means that
3360 they are really the "same" proxy subroutine
3361 instantiated in 2 places. Most likely this is
3362 when a constant is exported twice. Don't warn.
3365 else if (ckWARN(WARN_REDEFINE)
3367 && (!CvCONST((CV*)sref)
3368 || sv_cmp(cv_const_sv(cv),
3369 cv_const_sv((CV*)sref))))) {
3370 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3373 ? "Constant subroutine %s::%s redefined"
3374 : "Subroutine %s::%s redefined"),
3375 HvNAME_get(GvSTASH((GV*)dstr)),
3376 GvENAME((GV*)dstr));
3380 cv_ckproto_len(cv, (GV*)dstr,
3381 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3382 SvPOK(sref) ? SvCUR(sref) : 0);
3384 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3385 GvASSUMECV_on(dstr);
3386 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3389 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3390 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3391 GvFLAGS(dstr) |= import_flag;
3396 if (SvTAINTED(sstr))
3402 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3405 register U32 sflags;
3407 register svtype stype;
3412 if (SvIS_FREED(dstr)) {
3413 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3414 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3416 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3418 sstr = &PL_sv_undef;
3419 if (SvIS_FREED(sstr)) {
3420 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3421 (void*)sstr, (void*)dstr);
3423 stype = SvTYPE(sstr);
3424 dtype = SvTYPE(dstr);
3426 (void)SvAMAGIC_off(dstr);
3429 /* need to nuke the magic */
3431 SvRMAGICAL_off(dstr);
3434 /* There's a lot of redundancy below but we're going for speed here */
3439 if (dtype != SVt_PVGV) {
3440 (void)SvOK_off(dstr);
3448 sv_upgrade(dstr, SVt_IV);
3452 sv_upgrade(dstr, SVt_PVIV);
3455 goto end_of_first_switch;
3457 (void)SvIOK_only(dstr);
3458 SvIV_set(dstr, SvIVX(sstr));
3461 /* SvTAINTED can only be true if the SV has taint magic, which in
3462 turn means that the SV type is PVMG (or greater). This is the
3463 case statement for SVt_IV, so this cannot be true (whatever gcov
3465 assert(!SvTAINTED(sstr));
3470 if (dtype < SVt_PV && dtype != SVt_IV)
3471 sv_upgrade(dstr, SVt_IV);
3479 sv_upgrade(dstr, SVt_NV);
3483 sv_upgrade(dstr, SVt_PVNV);
3486 goto end_of_first_switch;
3488 SvNV_set(dstr, SvNVX(sstr));
3489 (void)SvNOK_only(dstr);
3490 /* SvTAINTED can only be true if the SV has taint magic, which in
3491 turn means that the SV type is PVMG (or greater). This is the
3492 case statement for SVt_NV, so this cannot be true (whatever gcov
3494 assert(!SvTAINTED(sstr));
3500 #ifdef PERL_OLD_COPY_ON_WRITE
3501 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3502 if (dtype < SVt_PVIV)
3503 sv_upgrade(dstr, SVt_PVIV);
3510 sv_upgrade(dstr, SVt_PV);
3513 if (dtype < SVt_PVIV)
3514 sv_upgrade(dstr, SVt_PVIV);
3517 if (dtype < SVt_PVNV)
3518 sv_upgrade(dstr, SVt_PVNV);
3522 const char * const type = sv_reftype(sstr,0);
3524 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3526 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3530 /* case SVt_BIND: */
3533 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3534 glob_assign_glob(dstr, sstr, dtype);
3537 /* SvVALID means that this PVGV is playing at being an FBM. */
3541 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3543 if (SvTYPE(sstr) != stype) {
3544 stype = SvTYPE(sstr);
3545 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3546 glob_assign_glob(dstr, sstr, dtype);
3551 if (stype == SVt_PVLV)
3552 SvUPGRADE(dstr, SVt_PVNV);
3554 SvUPGRADE(dstr, (svtype)stype);
3556 end_of_first_switch:
3558 /* dstr may have been upgraded. */
3559 dtype = SvTYPE(dstr);
3560 sflags = SvFLAGS(sstr);
3562 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3563 /* Assigning to a subroutine sets the prototype. */
3566 const char *const ptr = SvPV_const(sstr, len);
3568 SvGROW(dstr, len + 1);
3569 Copy(ptr, SvPVX(dstr), len + 1, char);
3570 SvCUR_set(dstr, len);
3572 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3576 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3577 const char * const type = sv_reftype(dstr,0);
3579 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3581 Perl_croak(aTHX_ "Cannot copy to %s", type);
3582 } else if (sflags & SVf_ROK) {
3583 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3584 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3587 if (GvIMPORTED(dstr) != GVf_IMPORTED
3588 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3590 GvIMPORTED_on(dstr);
3595 glob_assign_glob(dstr, sstr, dtype);
3599 if (dtype >= SVt_PV) {
3600 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3601 glob_assign_ref(dstr, sstr);
3604 if (SvPVX_const(dstr)) {
3610 (void)SvOK_off(dstr);
3611 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3612 SvFLAGS(dstr) |= sflags & SVf_ROK;
3613 assert(!(sflags & SVp_NOK));
3614 assert(!(sflags & SVp_IOK));
3615 assert(!(sflags & SVf_NOK));
3616 assert(!(sflags & SVf_IOK));
3618 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3619 if (!(sflags & SVf_OK)) {
3620 if (ckWARN(WARN_MISC))
3621 Perl_warner(aTHX_ packWARN(WARN_MISC),
3622 "Undefined value assigned to typeglob");
3625 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3626 if (dstr != (SV*)gv) {
3629 GvGP(dstr) = gp_ref(GvGP(gv));
3633 else if (sflags & SVp_POK) {
3637 * Check to see if we can just swipe the string. If so, it's a
3638 * possible small lose on short strings, but a big win on long ones.
3639 * It might even be a win on short strings if SvPVX_const(dstr)
3640 * has to be allocated and SvPVX_const(sstr) has to be freed.
3641 * Likewise if we can set up COW rather than doing an actual copy, we
3642 * drop to the else clause, as the swipe code and the COW setup code
3643 * have much in common.
3646 /* Whichever path we take through the next code, we want this true,
3647 and doing it now facilitates the COW check. */
3648 (void)SvPOK_only(dstr);
3651 /* If we're already COW then this clause is not true, and if COW
3652 is allowed then we drop down to the else and make dest COW
3653 with us. If caller hasn't said that we're allowed to COW
3654 shared hash keys then we don't do the COW setup, even if the
3655 source scalar is a shared hash key scalar. */
3656 (((flags & SV_COW_SHARED_HASH_KEYS)
3657 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3658 : 1 /* If making a COW copy is forbidden then the behaviour we
3659 desire is as if the source SV isn't actually already
3660 COW, even if it is. So we act as if the source flags
3661 are not COW, rather than actually testing them. */
3663 #ifndef PERL_OLD_COPY_ON_WRITE
3664 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3665 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3666 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3667 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3668 but in turn, it's somewhat dead code, never expected to go
3669 live, but more kept as a placeholder on how to do it better
3670 in a newer implementation. */
3671 /* If we are COW and dstr is a suitable target then we drop down
3672 into the else and make dest a COW of us. */
3673 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3678 (sflags & SVs_TEMP) && /* slated for free anyway? */
3679 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3680 (!(flags & SV_NOSTEAL)) &&
3681 /* and we're allowed to steal temps */
3682 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3683 SvLEN(sstr) && /* and really is a string */
3684 /* and won't be needed again, potentially */
3685 !(PL_op && PL_op->op_type == OP_AASSIGN))
3686 #ifdef PERL_OLD_COPY_ON_WRITE
3687 && ((flags & SV_COW_SHARED_HASH_KEYS)
3688 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3689 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3690 && SvTYPE(sstr) >= SVt_PVIV))
3694 /* Failed the swipe test, and it's not a shared hash key either.
3695 Have to copy the string. */
3696 STRLEN len = SvCUR(sstr);
3697 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3698 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3699 SvCUR_set(dstr, len);
3700 *SvEND(dstr) = '\0';
3702 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3704 /* Either it's a shared hash key, or it's suitable for
3705 copy-on-write or we can swipe the string. */
3707 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3711 #ifdef PERL_OLD_COPY_ON_WRITE
3713 /* I believe I should acquire a global SV mutex if
3714 it's a COW sv (not a shared hash key) to stop
3715 it going un copy-on-write.
3716 If the source SV has gone un copy on write between up there
3717 and down here, then (assert() that) it is of the correct
3718 form to make it copy on write again */
3719 if ((sflags & (SVf_FAKE | SVf_READONLY))
3720 != (SVf_FAKE | SVf_READONLY)) {
3721 SvREADONLY_on(sstr);
3723 /* Make the source SV into a loop of 1.
3724 (about to become 2) */
3725 SV_COW_NEXT_SV_SET(sstr, sstr);
3729 /* Initial code is common. */
3730 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3735 /* making another shared SV. */
3736 STRLEN cur = SvCUR(sstr);
3737 STRLEN len = SvLEN(sstr);
3738 #ifdef PERL_OLD_COPY_ON_WRITE
3740 assert (SvTYPE(dstr) >= SVt_PVIV);
3741 /* SvIsCOW_normal */
3742 /* splice us in between source and next-after-source. */
3743 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3744 SV_COW_NEXT_SV_SET(sstr, dstr);
3745 SvPV_set(dstr, SvPVX_mutable(sstr));
3749 /* SvIsCOW_shared_hash */
3750 DEBUG_C(PerlIO_printf(Perl_debug_log,
3751 "Copy on write: Sharing hash\n"));
3753 assert (SvTYPE(dstr) >= SVt_PV);
3755 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3757 SvLEN_set(dstr, len);
3758 SvCUR_set(dstr, cur);
3759 SvREADONLY_on(dstr);
3761 /* Relesase a global SV mutex. */
3764 { /* Passes the swipe test. */
3765 SvPV_set(dstr, SvPVX_mutable(sstr));
3766 SvLEN_set(dstr, SvLEN(sstr));
3767 SvCUR_set(dstr, SvCUR(sstr));
3770 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3771 SvPV_set(sstr, NULL);
3777 if (sflags & SVp_NOK) {
3778 SvNV_set(dstr, SvNVX(sstr));
3780 if (sflags & SVp_IOK) {
3782 SvIV_set(dstr, SvIVX(sstr));
3783 /* Must do this otherwise some other overloaded use of 0x80000000
3784 gets confused. I guess SVpbm_VALID */
3785 if (sflags & SVf_IVisUV)
3788 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3790 const MAGIC * const smg = SvVSTRING_mg(sstr);
3792 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3793 smg->mg_ptr, smg->mg_len);
3794 SvRMAGICAL_on(dstr);
3798 else if (sflags & (SVp_IOK|SVp_NOK)) {
3799 (void)SvOK_off(dstr);
3800 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3801 if (sflags & SVp_IOK) {
3802 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3803 SvIV_set(dstr, SvIVX(sstr));
3805 if (sflags & SVp_NOK) {
3806 SvNV_set(dstr, SvNVX(sstr));
3810 if (isGV_with_GP(sstr)) {
3811 /* This stringification rule for globs is spread in 3 places.
3812 This feels bad. FIXME. */
3813 const U32 wasfake = sflags & SVf_FAKE;
3815 /* FAKE globs can get coerced, so need to turn this off
3816 temporarily if it is on. */
3818 gv_efullname3(dstr, (GV *)sstr, "*");
3819 SvFLAGS(sstr) |= wasfake;
3822 (void)SvOK_off(dstr);
3824 if (SvTAINTED(sstr))
3829 =for apidoc sv_setsv_mg
3831 Like C<sv_setsv>, but also handles 'set' magic.
3837 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3839 sv_setsv(dstr,sstr);
3843 #ifdef PERL_OLD_COPY_ON_WRITE
3845 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3847 STRLEN cur = SvCUR(sstr);
3848 STRLEN len = SvLEN(sstr);
3849 register char *new_pv;
3852 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3853 (void*)sstr, (void*)dstr);
3860 if (SvTHINKFIRST(dstr))
3861 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3862 else if (SvPVX_const(dstr))
3863 Safefree(SvPVX_const(dstr));
3867 SvUPGRADE(dstr, SVt_PVIV);
3869 assert (SvPOK(sstr));
3870 assert (SvPOKp(sstr));
3871 assert (!SvIOK(sstr));
3872 assert (!SvIOKp(sstr));
3873 assert (!SvNOK(sstr));
3874 assert (!SvNOKp(sstr));
3876 if (SvIsCOW(sstr)) {
3878 if (SvLEN(sstr) == 0) {
3879 /* source is a COW shared hash key. */
3880 DEBUG_C(PerlIO_printf(Perl_debug_log,
3881 "Fast copy on write: Sharing hash\n"));
3882 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3885 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3887 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3888 SvUPGRADE(sstr, SVt_PVIV);
3889 SvREADONLY_on(sstr);
3891 DEBUG_C(PerlIO_printf(Perl_debug_log,
3892 "Fast copy on write: Converting sstr to COW\n"));
3893 SV_COW_NEXT_SV_SET(dstr, sstr);
3895 SV_COW_NEXT_SV_SET(sstr, dstr);
3896 new_pv = SvPVX_mutable(sstr);
3899 SvPV_set(dstr, new_pv);
3900 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3903 SvLEN_set(dstr, len);
3904 SvCUR_set(dstr, cur);
3913 =for apidoc sv_setpvn
3915 Copies a string into an SV. The C<len> parameter indicates the number of
3916 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3917 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3923 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3926 register char *dptr;
3928 SV_CHECK_THINKFIRST_COW_DROP(sv);
3934 /* len is STRLEN which is unsigned, need to copy to signed */
3937 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3939 SvUPGRADE(sv, SVt_PV);
3941 dptr = SvGROW(sv, len + 1);
3942 Move(ptr,dptr,len,char);
3945 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3950 =for apidoc sv_setpvn_mg
3952 Like C<sv_setpvn>, but also handles 'set' magic.
3958 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3960 sv_setpvn(sv,ptr,len);
3965 =for apidoc sv_setpv
3967 Copies a string into an SV. The string must be null-terminated. Does not
3968 handle 'set' magic. See C<sv_setpv_mg>.
3974 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3977 register STRLEN len;
3979 SV_CHECK_THINKFIRST_COW_DROP(sv);
3985 SvUPGRADE(sv, SVt_PV);
3987 SvGROW(sv, len + 1);
3988 Move(ptr,SvPVX(sv),len+1,char);
3990 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3995 =for apidoc sv_setpv_mg
3997 Like C<sv_setpv>, but also handles 'set' magic.
4003 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4010 =for apidoc sv_usepvn_flags
4012 Tells an SV to use C<ptr> to find its string value. Normally the
4013 string is stored inside the SV but sv_usepvn allows the SV to use an
4014 outside string. The C<ptr> should point to memory that was allocated
4015 by C<malloc>. The string length, C<len>, must be supplied. By default
4016 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4017 so that pointer should not be freed or used by the programmer after
4018 giving it to sv_usepvn, and neither should any pointers from "behind"
4019 that pointer (e.g. ptr + 1) be used.
4021 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4022 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4023 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4024 C<len>, and already meets the requirements for storing in C<SvPVX>)
4030 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4034 SV_CHECK_THINKFIRST_COW_DROP(sv);
4035 SvUPGRADE(sv, SVt_PV);
4038 if (flags & SV_SMAGIC)
4042 if (SvPVX_const(sv))
4046 if (flags & SV_HAS_TRAILING_NUL)
4047 assert(ptr[len] == '\0');
4050 allocate = (flags & SV_HAS_TRAILING_NUL)
4051 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4052 if (flags & SV_HAS_TRAILING_NUL) {
4053 /* It's long enough - do nothing.
4054 Specfically Perl_newCONSTSUB is relying on this. */
4057 /* Force a move to shake out bugs in callers. */
4058 char *new_ptr = (char*)safemalloc(allocate);
4059 Copy(ptr, new_ptr, len, char);
4060 PoisonFree(ptr,len,char);
4064 ptr = (char*) saferealloc (ptr, allocate);
4069 SvLEN_set(sv, allocate);
4070 if (!(flags & SV_HAS_TRAILING_NUL)) {
4073 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4075 if (flags & SV_SMAGIC)
4079 #ifdef PERL_OLD_COPY_ON_WRITE
4080 /* Need to do this *after* making the SV normal, as we need the buffer
4081 pointer to remain valid until after we've copied it. If we let go too early,
4082 another thread could invalidate it by unsharing last of the same hash key
4083 (which it can do by means other than releasing copy-on-write Svs)
4084 or by changing the other copy-on-write SVs in the loop. */
4086 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4088 { /* this SV was SvIsCOW_normal(sv) */
4089 /* we need to find the SV pointing to us. */
4090 SV *current = SV_COW_NEXT_SV(after);
4092 if (current == sv) {
4093 /* The SV we point to points back to us (there were only two of us
4095 Hence other SV is no longer copy on write either. */
4097 SvREADONLY_off(after);
4099 /* We need to follow the pointers around the loop. */
4101 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4104 /* don't loop forever if the structure is bust, and we have
4105 a pointer into a closed loop. */
4106 assert (current != after);
4107 assert (SvPVX_const(current) == pvx);
4109 /* Make the SV before us point to the SV after us. */
4110 SV_COW_NEXT_SV_SET(current, after);
4116 =for apidoc sv_force_normal_flags
4118 Undo various types of fakery on an SV: if the PV is a shared string, make
4119 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4120 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4121 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4122 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4123 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4124 set to some other value.) In addition, the C<flags> parameter gets passed to
4125 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4126 with flags set to 0.
4132 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4135 #ifdef PERL_OLD_COPY_ON_WRITE
4136 if (SvREADONLY(sv)) {
4137 /* At this point I believe I should acquire a global SV mutex. */
4139 const char * const pvx = SvPVX_const(sv);
4140 const STRLEN len = SvLEN(sv);
4141 const STRLEN cur = SvCUR(sv);
4142 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4143 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4144 we'll fail an assertion. */
4145 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4148 PerlIO_printf(Perl_debug_log,
4149 "Copy on write: Force normal %ld\n",
4155 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4158 if (flags & SV_COW_DROP_PV) {
4159 /* OK, so we don't need to copy our buffer. */
4162 SvGROW(sv, cur + 1);
4163 Move(pvx,SvPVX(sv),cur,char);
4168 sv_release_COW(sv, pvx, next);
4170 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4176 else if (IN_PERL_RUNTIME)
4177 Perl_croak(aTHX_ PL_no_modify);
4178 /* At this point I believe that I can drop the global SV mutex. */
4181 if (SvREADONLY(sv)) {
4183 const char * const pvx = SvPVX_const(sv);
4184 const STRLEN len = SvCUR(sv);
4189 SvGROW(sv, len + 1);
4190 Move(pvx,SvPVX(sv),len,char);
4192 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4194 else if (IN_PERL_RUNTIME)
4195 Perl_croak(aTHX_ PL_no_modify);
4199 sv_unref_flags(sv, flags);
4200 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4207 Efficient removal of characters from the beginning of the string buffer.
4208 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4209 the string buffer. The C<ptr> becomes the first character of the adjusted
4210 string. Uses the "OOK hack".
4211 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4212 refer to the same chunk of data.
4218 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4220 register STRLEN delta;
4221 if (!ptr || !SvPOKp(sv))
4223 delta = ptr - SvPVX_const(sv);
4225 /* Nothing to do. */
4228 assert(ptr > SvPVX_const(sv));
4229 SV_CHECK_THINKFIRST(sv);
4230 if (SvTYPE(sv) < SVt_PVIV)
4231 sv_upgrade(sv,SVt_PVIV);
4234 if (!SvLEN(sv)) { /* make copy of shared string */
4235 const char *pvx = SvPVX_const(sv);
4236 const STRLEN len = SvCUR(sv);
4237 SvGROW(sv, len + 1);
4238 Move(pvx,SvPVX(sv),len,char);
4242 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4243 and we do that anyway inside the SvNIOK_off
4245 SvFLAGS(sv) |= SVf_OOK;
4248 SvLEN_set(sv, SvLEN(sv) - delta);
4249 SvCUR_set(sv, SvCUR(sv) - delta);
4250 SvPV_set(sv, SvPVX(sv) + delta);
4251 SvIV_set(sv, SvIVX(sv) + delta);
4254 /* Fill the preceding buffer with sentinals to verify that no-one is
4256 U8 *p = (U8*) SvPVX(sv);
4257 const U8 *const real_start = p - SvIVX(sv);
4258 while (p > real_start) {
4267 =for apidoc sv_catpvn
4269 Concatenates the string onto the end of the string which is in the SV. The
4270 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4271 status set, then the bytes appended should be valid UTF-8.
4272 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4274 =for apidoc sv_catpvn_flags
4276 Concatenates the string onto the end of the string which is in the SV. The
4277 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4278 status set, then the bytes appended should be valid UTF-8.
4279 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4280 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4281 in terms of this function.
4287 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4291 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4293 SvGROW(dsv, dlen + slen + 1);
4295 sstr = SvPVX_const(dsv);
4296 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4297 SvCUR_set(dsv, SvCUR(dsv) + slen);
4299 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4301 if (flags & SV_SMAGIC)
4306 =for apidoc sv_catsv
4308 Concatenates the string from SV C<ssv> onto the end of the string in
4309 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4310 not 'set' magic. See C<sv_catsv_mg>.
4312 =for apidoc sv_catsv_flags
4314 Concatenates the string from SV C<ssv> onto the end of the string in
4315 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4316 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4317 and C<sv_catsv_nomg> are implemented in terms of this function.
4322 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4327 const char *spv = SvPV_const(ssv, slen);
4329 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4330 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4331 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4332 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4333 dsv->sv_flags doesn't have that bit set.
4334 Andy Dougherty 12 Oct 2001
4336 const I32 sutf8 = DO_UTF8(ssv);
4339 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4341 dutf8 = DO_UTF8(dsv);
4343 if (dutf8 != sutf8) {
4345 /* Not modifying source SV, so taking a temporary copy. */
4346 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4348 sv_utf8_upgrade(csv);
4349 spv = SvPV_const(csv, slen);
4352 sv_utf8_upgrade_nomg(dsv);
4354 sv_catpvn_nomg(dsv, spv, slen);
4357 if (flags & SV_SMAGIC)
4362 =for apidoc sv_catpv
4364 Concatenates the string onto the end of the string which is in the SV.
4365 If the SV has the UTF-8 status set, then the bytes appended should be
4366 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4371 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4374 register STRLEN len;
4380 junk = SvPV_force(sv, tlen);
4382 SvGROW(sv, tlen + len + 1);
4384 ptr = SvPVX_const(sv);
4385 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4386 SvCUR_set(sv, SvCUR(sv) + len);
4387 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4392 =for apidoc sv_catpv_mg
4394 Like C<sv_catpv>, but also handles 'set' magic.
4400 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4409 Creates a new SV. A non-zero C<len> parameter indicates the number of
4410 bytes of preallocated string space the SV should have. An extra byte for a
4411 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4412 space is allocated.) The reference count for the new SV is set to 1.
4414 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4415 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4416 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4417 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4418 modules supporting older perls.
4424 Perl_newSV(pTHX_ STRLEN len)
4431 sv_upgrade(sv, SVt_PV);
4432 SvGROW(sv, len + 1);
4437 =for apidoc sv_magicext
4439 Adds magic to an SV, upgrading it if necessary. Applies the
4440 supplied vtable and returns a pointer to the magic added.
4442 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4443 In particular, you can add magic to SvREADONLY SVs, and add more than
4444 one instance of the same 'how'.
4446 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4447 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4448 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4449 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4451 (This is now used as a subroutine by C<sv_magic>.)
4456 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4457 const char* name, I32 namlen)
4462 SvUPGRADE(sv, SVt_PVMG);
4463 Newxz(mg, 1, MAGIC);
4464 mg->mg_moremagic = SvMAGIC(sv);
4465 SvMAGIC_set(sv, mg);
4467 /* Sometimes a magic contains a reference loop, where the sv and
4468 object refer to each other. To prevent a reference loop that
4469 would prevent such objects being freed, we look for such loops
4470 and if we find one we avoid incrementing the object refcount.
4472 Note we cannot do this to avoid self-tie loops as intervening RV must
4473 have its REFCNT incremented to keep it in existence.
4476 if (!obj || obj == sv ||
4477 how == PERL_MAGIC_arylen ||
4478 how == PERL_MAGIC_qr ||
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 ReREFCNT_dec(((struct xregexp *)SvANY(sv))->xrx_regexp);
5242 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5246 if (PL_comppad == (AV*)sv) {
5253 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5254 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5255 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5256 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5258 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5259 SvREFCNT_dec(LvTARG(sv));
5261 if (isGV_with_GP(sv)) {
5262 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5263 mro_method_changed_in(stash);
5266 unshare_hek(GvNAME_HEK(sv));
5267 /* If we're in a stash, we don't own a reference to it. However it does
5268 have a back reference to us, which needs to be cleared. */
5269 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5270 sv_del_backref((SV*)stash, sv);
5272 /* FIXME. There are probably more unreferenced pointers to SVs in the
5273 interpreter struct that we should check and tidy in a similar
5275 if ((GV*)sv == PL_last_in_gv)
5276 PL_last_in_gv = NULL;
5281 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5283 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5284 /* Don't even bother with turning off the OOK flag. */
5288 SV * const target = SvRV(sv);
5290 sv_del_backref(target, sv);
5292 SvREFCNT_dec(target);
5294 #ifdef PERL_OLD_COPY_ON_WRITE
5295 else if (SvPVX_const(sv)) {
5297 /* I believe I need to grab the global SV mutex here and
5298 then recheck the COW status. */
5300 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5304 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5306 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5309 /* And drop it here. */
5311 } else if (SvLEN(sv)) {
5312 Safefree(SvPVX_const(sv));
5316 else if (SvPVX_const(sv) && SvLEN(sv))
5317 Safefree(SvPVX_mutable(sv));
5318 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5319 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5328 SvFLAGS(sv) &= SVf_BREAK;
5329 SvFLAGS(sv) |= SVTYPEMASK;
5331 if (sv_type_details->arena) {
5332 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5333 &PL_body_roots[type]);
5335 else if (sv_type_details->body_size) {
5336 my_safefree(SvANY(sv));
5341 =for apidoc sv_newref
5343 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5350 Perl_sv_newref(pTHX_ SV *sv)
5352 PERL_UNUSED_CONTEXT;
5361 Decrement an SV's reference count, and if it drops to zero, call
5362 C<sv_clear> to invoke destructors and free up any memory used by
5363 the body; finally, deallocate the SV's head itself.
5364 Normally called via a wrapper macro C<SvREFCNT_dec>.
5370 Perl_sv_free(pTHX_ SV *sv)
5375 if (SvREFCNT(sv) == 0) {
5376 if (SvFLAGS(sv) & SVf_BREAK)
5377 /* this SV's refcnt has been artificially decremented to
5378 * trigger cleanup */
5380 if (PL_in_clean_all) /* All is fair */
5382 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5383 /* make sure SvREFCNT(sv)==0 happens very seldom */
5384 SvREFCNT(sv) = (~(U32)0)/2;
5387 if (ckWARN_d(WARN_INTERNAL)) {
5388 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5389 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5390 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5391 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5392 Perl_dump_sv_child(aTHX_ sv);
5394 #ifdef DEBUG_LEAKING_SCALARS
5401 if (--(SvREFCNT(sv)) > 0)
5403 Perl_sv_free2(aTHX_ sv);
5407 Perl_sv_free2(pTHX_ SV *sv)
5412 if (ckWARN_d(WARN_DEBUGGING))
5413 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5414 "Attempt to free temp prematurely: SV 0x%"UVxf
5415 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5419 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5420 /* make sure SvREFCNT(sv)==0 happens very seldom */
5421 SvREFCNT(sv) = (~(U32)0)/2;
5432 Returns the length of the string in the SV. Handles magic and type
5433 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5439 Perl_sv_len(pTHX_ register SV *sv)
5447 len = mg_length(sv);
5449 (void)SvPV_const(sv, len);
5454 =for apidoc sv_len_utf8
5456 Returns the number of characters in the string in an SV, counting wide
5457 UTF-8 bytes as a single character. Handles magic and type coercion.
5463 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5464 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5465 * (Note that the mg_len is not the length of the mg_ptr field.
5466 * This allows the cache to store the character length of the string without
5467 * needing to malloc() extra storage to attach to the mg_ptr.)
5472 Perl_sv_len_utf8(pTHX_ register SV *sv)
5478 return mg_length(sv);
5482 const U8 *s = (U8*)SvPV_const(sv, len);
5486 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5488 if (mg && mg->mg_len != -1) {
5490 if (PL_utf8cache < 0) {
5491 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5493 /* Need to turn the assertions off otherwise we may
5494 recurse infinitely while printing error messages.
5496 SAVEI8(PL_utf8cache);
5498 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5499 " real %"UVuf" for %"SVf,
5500 (UV) ulen, (UV) real, SVfARG(sv));
5505 ulen = Perl_utf8_length(aTHX_ s, s + len);
5506 if (!SvREADONLY(sv)) {
5508 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5509 &PL_vtbl_utf8, 0, 0);
5517 return Perl_utf8_length(aTHX_ s, s + len);
5521 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5524 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5527 const U8 *s = start;
5529 while (s < send && uoffset--)
5532 /* This is the existing behaviour. Possibly it should be a croak, as
5533 it's actually a bounds error */
5539 /* Given the length of the string in both bytes and UTF-8 characters, decide
5540 whether to walk forwards or backwards to find the byte corresponding to
5541 the passed in UTF-8 offset. */
5543 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5544 STRLEN uoffset, STRLEN uend)
5546 STRLEN backw = uend - uoffset;
5547 if (uoffset < 2 * backw) {
5548 /* The assumption is that going forwards is twice the speed of going
5549 forward (that's where the 2 * backw comes from).
5550 (The real figure of course depends on the UTF-8 data.) */
5551 return sv_pos_u2b_forwards(start, send, uoffset);
5556 while (UTF8_IS_CONTINUATION(*send))
5559 return send - start;
5562 /* For the string representation of the given scalar, find the byte
5563 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5564 give another position in the string, *before* the sought offset, which
5565 (which is always true, as 0, 0 is a valid pair of positions), which should
5566 help reduce the amount of linear searching.
5567 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5568 will be used to reduce the amount of linear searching. The cache will be
5569 created if necessary, and the found value offered to it for update. */
5571 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5572 const U8 *const send, STRLEN uoffset,
5573 STRLEN uoffset0, STRLEN boffset0) {
5574 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5577 assert (uoffset >= uoffset0);
5579 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5580 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5581 if ((*mgp)->mg_ptr) {
5582 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5583 if (cache[0] == uoffset) {
5584 /* An exact match. */
5587 if (cache[2] == uoffset) {
5588 /* An exact match. */
5592 if (cache[0] < uoffset) {
5593 /* The cache already knows part of the way. */
5594 if (cache[0] > uoffset0) {
5595 /* The cache knows more than the passed in pair */
5596 uoffset0 = cache[0];
5597 boffset0 = cache[1];
5599 if ((*mgp)->mg_len != -1) {
5600 /* And we know the end too. */
5602 + sv_pos_u2b_midway(start + boffset0, send,
5604 (*mgp)->mg_len - uoffset0);
5607 + sv_pos_u2b_forwards(start + boffset0,
5608 send, uoffset - uoffset0);
5611 else if (cache[2] < uoffset) {
5612 /* We're between the two cache entries. */
5613 if (cache[2] > uoffset0) {
5614 /* and the cache knows more than the passed in pair */
5615 uoffset0 = cache[2];
5616 boffset0 = cache[3];
5620 + sv_pos_u2b_midway(start + boffset0,
5623 cache[0] - uoffset0);
5626 + sv_pos_u2b_midway(start + boffset0,
5629 cache[2] - uoffset0);
5633 else if ((*mgp)->mg_len != -1) {
5634 /* If we can take advantage of a passed in offset, do so. */
5635 /* In fact, offset0 is either 0, or less than offset, so don't
5636 need to worry about the other possibility. */
5638 + sv_pos_u2b_midway(start + boffset0, send,
5640 (*mgp)->mg_len - uoffset0);
5645 if (!found || PL_utf8cache < 0) {
5646 const STRLEN real_boffset
5647 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5648 send, uoffset - uoffset0);
5650 if (found && PL_utf8cache < 0) {
5651 if (real_boffset != boffset) {
5652 /* Need to turn the assertions off otherwise we may recurse
5653 infinitely while printing error messages. */
5654 SAVEI8(PL_utf8cache);
5656 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5657 " real %"UVuf" for %"SVf,
5658 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5661 boffset = real_boffset;
5664 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5670 =for apidoc sv_pos_u2b
5672 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5673 the start of the string, to a count of the equivalent number of bytes; if
5674 lenp is non-zero, it does the same to lenp, but this time starting from
5675 the offset, rather than from the start of the string. Handles magic and
5682 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5683 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5684 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5689 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5697 start = (U8*)SvPV_const(sv, len);
5699 STRLEN uoffset = (STRLEN) *offsetp;
5700 const U8 * const send = start + len;
5702 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5705 *offsetp = (I32) boffset;
5708 /* Convert the relative offset to absolute. */
5709 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5710 const STRLEN boffset2
5711 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5712 uoffset, boffset) - boffset;
5726 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5727 byte length pairing. The (byte) length of the total SV is passed in too,
5728 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5729 may not have updated SvCUR, so we can't rely on reading it directly.
5731 The proffered utf8/byte length pairing isn't used if the cache already has
5732 two pairs, and swapping either for the proffered pair would increase the
5733 RMS of the intervals between known byte offsets.
5735 The cache itself consists of 4 STRLEN values
5736 0: larger UTF-8 offset
5737 1: corresponding byte offset
5738 2: smaller UTF-8 offset
5739 3: corresponding byte offset
5741 Unused cache pairs have the value 0, 0.
5742 Keeping the cache "backwards" means that the invariant of
5743 cache[0] >= cache[2] is maintained even with empty slots, which means that
5744 the code that uses it doesn't need to worry if only 1 entry has actually
5745 been set to non-zero. It also makes the "position beyond the end of the
5746 cache" logic much simpler, as the first slot is always the one to start
5750 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5758 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5760 (*mgp)->mg_len = -1;
5764 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5765 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5766 (*mgp)->mg_ptr = (char *) cache;
5770 if (PL_utf8cache < 0) {
5771 const U8 *start = (const U8 *) SvPVX_const(sv);
5772 const STRLEN realutf8 = utf8_length(start, start + byte);
5774 if (realutf8 != utf8) {
5775 /* Need to turn the assertions off otherwise we may recurse
5776 infinitely while printing error messages. */
5777 SAVEI8(PL_utf8cache);
5779 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5780 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5784 /* Cache is held with the later position first, to simplify the code
5785 that deals with unbounded ends. */
5787 ASSERT_UTF8_CACHE(cache);
5788 if (cache[1] == 0) {
5789 /* Cache is totally empty */
5792 } else if (cache[3] == 0) {
5793 if (byte > cache[1]) {
5794 /* New one is larger, so goes first. */
5795 cache[2] = cache[0];
5796 cache[3] = cache[1];
5804 #define THREEWAY_SQUARE(a,b,c,d) \
5805 ((float)((d) - (c))) * ((float)((d) - (c))) \
5806 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5807 + ((float)((b) - (a))) * ((float)((b) - (a)))
5809 /* Cache has 2 slots in use, and we know three potential pairs.
5810 Keep the two that give the lowest RMS distance. Do the
5811 calcualation in bytes simply because we always know the byte
5812 length. squareroot has the same ordering as the positive value,
5813 so don't bother with the actual square root. */
5814 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5815 if (byte > cache[1]) {
5816 /* New position is after the existing pair of pairs. */
5817 const float keep_earlier
5818 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5819 const float keep_later
5820 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5822 if (keep_later < keep_earlier) {
5823 if (keep_later < existing) {
5824 cache[2] = cache[0];
5825 cache[3] = cache[1];
5831 if (keep_earlier < existing) {
5837 else if (byte > cache[3]) {
5838 /* New position is between the existing pair of pairs. */
5839 const float keep_earlier
5840 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5841 const float keep_later
5842 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5844 if (keep_later < keep_earlier) {
5845 if (keep_later < existing) {
5851 if (keep_earlier < existing) {
5858 /* New position is before the existing pair of pairs. */
5859 const float keep_earlier
5860 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5861 const float keep_later
5862 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5864 if (keep_later < keep_earlier) {
5865 if (keep_later < existing) {
5871 if (keep_earlier < existing) {
5872 cache[0] = cache[2];
5873 cache[1] = cache[3];
5880 ASSERT_UTF8_CACHE(cache);
5883 /* We already know all of the way, now we may be able to walk back. The same
5884 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5885 backward is half the speed of walking forward. */
5887 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5890 const STRLEN forw = target - s;
5891 STRLEN backw = end - target;
5893 if (forw < 2 * backw) {
5894 return utf8_length(s, target);
5897 while (end > target) {
5899 while (UTF8_IS_CONTINUATION(*end)) {
5908 =for apidoc sv_pos_b2u
5910 Converts the value pointed to by offsetp from a count of bytes from the
5911 start of the string, to a count of the equivalent number of UTF-8 chars.
5912 Handles magic and type coercion.
5918 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5919 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5924 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5927 const STRLEN byte = *offsetp;
5928 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5937 s = (const U8*)SvPV_const(sv, blen);
5940 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5944 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5945 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5947 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5948 if (cache[1] == byte) {
5949 /* An exact match. */
5950 *offsetp = cache[0];
5953 if (cache[3] == byte) {
5954 /* An exact match. */
5955 *offsetp = cache[2];
5959 if (cache[1] < byte) {
5960 /* We already know part of the way. */
5961 if (mg->mg_len != -1) {
5962 /* Actually, we know the end too. */
5964 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5965 s + blen, mg->mg_len - cache[0]);
5967 len = cache[0] + utf8_length(s + cache[1], send);
5970 else if (cache[3] < byte) {
5971 /* We're between the two cached pairs, so we do the calculation
5972 offset by the byte/utf-8 positions for the earlier pair,
5973 then add the utf-8 characters from the string start to
5975 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5976 s + cache[1], cache[0] - cache[2])
5980 else { /* cache[3] > byte */
5981 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5985 ASSERT_UTF8_CACHE(cache);
5987 } else if (mg->mg_len != -1) {
5988 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5992 if (!found || PL_utf8cache < 0) {
5993 const STRLEN real_len = utf8_length(s, send);
5995 if (found && PL_utf8cache < 0) {
5996 if (len != real_len) {
5997 /* Need to turn the assertions off otherwise we may recurse
5998 infinitely while printing error messages. */
5999 SAVEI8(PL_utf8cache);
6001 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6002 " real %"UVuf" for %"SVf,
6003 (UV) len, (UV) real_len, SVfARG(sv));
6010 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6016 Returns a boolean indicating whether the strings in the two SVs are
6017 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6018 coerce its args to strings if necessary.
6024 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6033 SV* svrecode = NULL;
6040 /* if pv1 and pv2 are the same, second SvPV_const call may
6041 * invalidate pv1, so we may need to make a copy */
6042 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6043 pv1 = SvPV_const(sv1, cur1);
6044 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
6045 if (SvUTF8(sv2)) SvUTF8_on(sv1);
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;
7002 =for apidoc sv_2mortal
7004 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7005 by an explicit call to FREETMPS, or by an implicit call at places such as
7006 statement boundaries. SvTEMP() is turned on which means that the SV's
7007 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7008 and C<sv_mortalcopy>.
7014 Perl_sv_2mortal(pTHX_ register SV *sv)
7019 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7022 PL_tmps_stack[++PL_tmps_ix] = sv;
7030 Creates a new SV and copies a string into it. The reference count for the
7031 SV is set to 1. If C<len> is zero, Perl will compute the length using
7032 strlen(). For efficiency, consider using C<newSVpvn> instead.
7038 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7044 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7049 =for apidoc newSVpvn
7051 Creates a new SV and copies a string into it. The reference count for the
7052 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7053 string. You are responsible for ensuring that the source string is at least
7054 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7060 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7066 sv_setpvn(sv,s,len);
7072 =for apidoc newSVhek
7074 Creates a new SV from the hash key structure. It will generate scalars that
7075 point to the shared string table where possible. Returns a new (undefined)
7076 SV if the hek is NULL.
7082 Perl_newSVhek(pTHX_ const HEK *hek)
7092 if (HEK_LEN(hek) == HEf_SVKEY) {
7093 return newSVsv(*(SV**)HEK_KEY(hek));
7095 const int flags = HEK_FLAGS(hek);
7096 if (flags & HVhek_WASUTF8) {
7098 Andreas would like keys he put in as utf8 to come back as utf8
7100 STRLEN utf8_len = HEK_LEN(hek);
7101 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7102 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7105 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7107 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7108 /* We don't have a pointer to the hv, so we have to replicate the
7109 flag into every HEK. This hv is using custom a hasing
7110 algorithm. Hence we can't return a shared string scalar, as
7111 that would contain the (wrong) hash value, and might get passed
7112 into an hv routine with a regular hash.
7113 Similarly, a hash that isn't using shared hash keys has to have
7114 the flag in every key so that we know not to try to call
7115 share_hek_kek on it. */
7117 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7122 /* This will be overwhelminly the most common case. */
7124 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7125 more efficient than sharepvn(). */
7129 sv_upgrade(sv, SVt_PV);
7130 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7131 SvCUR_set(sv, HEK_LEN(hek));
7144 =for apidoc newSVpvn_share
7146 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7147 table. If the string does not already exist in the table, it is created
7148 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7149 value is used; otherwise the hash is computed. The string's hash can be later
7150 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7151 that as the string table is used for shared hash keys these strings will have
7152 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7158 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7162 bool is_utf8 = FALSE;
7163 const char *const orig_src = src;
7166 STRLEN tmplen = -len;
7168 /* See the note in hv.c:hv_fetch() --jhi */
7169 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7173 PERL_HASH(hash, src, len);
7175 sv_upgrade(sv, SVt_PV);
7176 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7184 if (src != orig_src)
7190 #if defined(PERL_IMPLICIT_CONTEXT)
7192 /* pTHX_ magic can't cope with varargs, so this is a no-context
7193 * version of the main function, (which may itself be aliased to us).
7194 * Don't access this version directly.
7198 Perl_newSVpvf_nocontext(const char* pat, ...)
7203 va_start(args, pat);
7204 sv = vnewSVpvf(pat, &args);
7211 =for apidoc newSVpvf
7213 Creates a new SV and initializes it with the string formatted like
7220 Perl_newSVpvf(pTHX_ const char* pat, ...)
7224 va_start(args, pat);
7225 sv = vnewSVpvf(pat, &args);
7230 /* backend for newSVpvf() and newSVpvf_nocontext() */
7233 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7238 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7245 Creates a new SV and copies a floating point value into it.
7246 The reference count for the SV is set to 1.
7252 Perl_newSVnv(pTHX_ NV n)
7265 Creates a new SV and copies an integer into it. The reference count for the
7272 Perl_newSViv(pTHX_ IV i)
7285 Creates a new SV and copies an unsigned integer into it.
7286 The reference count for the SV is set to 1.
7292 Perl_newSVuv(pTHX_ UV u)
7303 =for apidoc newSV_type
7305 Creates a new SV, of the type specified. The reference count for the new SV
7312 Perl_newSV_type(pTHX_ svtype type)
7317 sv_upgrade(sv, type);
7322 =for apidoc newRV_noinc
7324 Creates an RV wrapper for an SV. The reference count for the original
7325 SV is B<not> incremented.
7331 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7334 register SV *sv = newSV_type(SVt_IV);
7336 SvRV_set(sv, tmpRef);
7341 /* newRV_inc is the official function name to use now.
7342 * newRV_inc is in fact #defined to newRV in sv.h
7346 Perl_newRV(pTHX_ SV *sv)
7349 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7355 Creates a new SV which is an exact duplicate of the original SV.
7362 Perl_newSVsv(pTHX_ register SV *old)
7369 if (SvTYPE(old) == SVTYPEMASK) {
7370 if (ckWARN_d(WARN_INTERNAL))
7371 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7375 /* SV_GMAGIC is the default for sv_setv()
7376 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7377 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7378 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7383 =for apidoc sv_reset
7385 Underlying implementation for the C<reset> Perl function.
7386 Note that the perl-level function is vaguely deprecated.
7392 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7395 char todo[PERL_UCHAR_MAX+1];
7400 if (!*s) { /* reset ?? searches */
7401 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7403 const U32 count = mg->mg_len / sizeof(PMOP**);
7404 PMOP **pmp = (PMOP**) mg->mg_ptr;
7405 PMOP *const *const end = pmp + count;
7409 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7411 (*pmp)->op_pmflags &= ~PMf_USED;
7419 /* reset variables */
7421 if (!HvARRAY(stash))
7424 Zero(todo, 256, char);
7427 I32 i = (unsigned char)*s;
7431 max = (unsigned char)*s++;
7432 for ( ; i <= max; i++) {
7435 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7437 for (entry = HvARRAY(stash)[i];
7439 entry = HeNEXT(entry))
7444 if (!todo[(U8)*HeKEY(entry)])
7446 gv = (GV*)HeVAL(entry);
7449 if (SvTHINKFIRST(sv)) {
7450 if (!SvREADONLY(sv) && SvROK(sv))
7452 /* XXX Is this continue a bug? Why should THINKFIRST
7453 exempt us from resetting arrays and hashes? */
7457 if (SvTYPE(sv) >= SVt_PV) {
7459 if (SvPVX_const(sv) != NULL)
7467 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7469 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7472 # if defined(USE_ENVIRON_ARRAY)
7475 # endif /* USE_ENVIRON_ARRAY */
7486 Using various gambits, try to get an IO from an SV: the IO slot if its a
7487 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7488 named after the PV if we're a string.
7494 Perl_sv_2io(pTHX_ SV *sv)
7499 switch (SvTYPE(sv)) {
7507 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7511 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7513 return sv_2io(SvRV(sv));
7514 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7520 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7529 Using various gambits, try to get a CV from an SV; in addition, try if
7530 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7531 The flags in C<lref> are passed to sv_fetchsv.
7537 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7548 switch (SvTYPE(sv)) {
7567 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7568 tryAMAGICunDEREF(to_cv);
7571 if (SvTYPE(sv) == SVt_PVCV) {
7580 Perl_croak(aTHX_ "Not a subroutine reference");
7585 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7591 /* Some flags to gv_fetchsv mean don't really create the GV */
7592 if (SvTYPE(gv) != SVt_PVGV) {
7598 if (lref && !GvCVu(gv)) {
7602 gv_efullname3(tmpsv, gv, NULL);
7603 /* XXX this is probably not what they think they're getting.
7604 * It has the same effect as "sub name;", i.e. just a forward
7606 newSUB(start_subparse(FALSE, 0),
7607 newSVOP(OP_CONST, 0, tmpsv),
7611 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7621 Returns true if the SV has a true value by Perl's rules.
7622 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7623 instead use an in-line version.
7629 Perl_sv_true(pTHX_ register SV *sv)
7634 register const XPV* const tXpv = (XPV*)SvANY(sv);
7636 (tXpv->xpv_cur > 1 ||
7637 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7644 return SvIVX(sv) != 0;
7647 return SvNVX(sv) != 0.0;
7649 return sv_2bool(sv);
7655 =for apidoc sv_pvn_force
7657 Get a sensible string out of the SV somehow.
7658 A private implementation of the C<SvPV_force> macro for compilers which
7659 can't cope with complex macro expressions. Always use the macro instead.
7661 =for apidoc sv_pvn_force_flags
7663 Get a sensible string out of the SV somehow.
7664 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7665 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7666 implemented in terms of this function.
7667 You normally want to use the various wrapper macros instead: see
7668 C<SvPV_force> and C<SvPV_force_nomg>
7674 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7677 if (SvTHINKFIRST(sv) && !SvROK(sv))
7678 sv_force_normal_flags(sv, 0);
7688 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7689 const char * const ref = sv_reftype(sv,0);
7691 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7692 ref, OP_NAME(PL_op));
7694 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7696 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7697 || isGV_with_GP(sv))
7698 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7700 s = sv_2pv_flags(sv, &len, flags);
7704 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7707 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7708 SvGROW(sv, len + 1);
7709 Move(s,SvPVX(sv),len,char);
7711 SvPVX(sv)[len] = '\0';
7714 SvPOK_on(sv); /* validate pointer */
7716 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7717 PTR2UV(sv),SvPVX_const(sv)));
7720 return SvPVX_mutable(sv);
7724 =for apidoc sv_pvbyten_force
7726 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7732 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7734 sv_pvn_force(sv,lp);
7735 sv_utf8_downgrade(sv,0);
7741 =for apidoc sv_pvutf8n_force
7743 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7749 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7751 sv_pvn_force(sv,lp);
7752 sv_utf8_upgrade(sv);
7758 =for apidoc sv_reftype
7760 Returns a string describing what the SV is a reference to.
7766 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7768 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7769 inside return suggests a const propagation bug in g++. */
7770 if (ob && SvOBJECT(sv)) {
7771 char * const name = HvNAME_get(SvSTASH(sv));
7772 return name ? name : (char *) "__ANON__";
7775 switch (SvTYPE(sv)) {
7790 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7791 /* tied lvalues should appear to be
7792 * scalars for backwards compatitbility */
7793 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7794 ? "SCALAR" : "LVALUE");
7795 case SVt_PVAV: return "ARRAY";
7796 case SVt_PVHV: return "HASH";
7797 case SVt_PVCV: return "CODE";
7798 case SVt_PVGV: return "GLOB";
7799 case SVt_PVFM: return "FORMAT";
7800 case SVt_PVIO: return "IO";
7801 case SVt_BIND: return "BIND";
7802 case SVt_REGEXP: return "Regexp"; /* FIXME? to "REGEXP" */
7803 default: return "UNKNOWN";
7809 =for apidoc sv_isobject
7811 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7812 object. If the SV is not an RV, or if the object is not blessed, then this
7819 Perl_sv_isobject(pTHX_ SV *sv)
7835 Returns a boolean indicating whether the SV is blessed into the specified
7836 class. This does not check for subtypes; use C<sv_derived_from> to verify
7837 an inheritance relationship.
7843 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7854 hvname = HvNAME_get(SvSTASH(sv));
7858 return strEQ(hvname, name);
7864 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7865 it will be upgraded to one. If C<classname> is non-null then the new SV will
7866 be blessed in the specified package. The new SV is returned and its
7867 reference count is 1.
7873 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7880 SV_CHECK_THINKFIRST_COW_DROP(rv);
7881 (void)SvAMAGIC_off(rv);
7883 if (SvTYPE(rv) >= SVt_PVMG) {
7884 const U32 refcnt = SvREFCNT(rv);
7888 SvREFCNT(rv) = refcnt;
7890 sv_upgrade(rv, SVt_IV);
7891 } else if (SvROK(rv)) {
7892 SvREFCNT_dec(SvRV(rv));
7894 prepare_SV_for_RV(rv);
7902 HV* const stash = gv_stashpv(classname, GV_ADD);
7903 (void)sv_bless(rv, stash);
7909 =for apidoc sv_setref_pv
7911 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7912 argument will be upgraded to an RV. That RV will be modified to point to
7913 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7914 into the SV. The C<classname> argument indicates the package for the
7915 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7916 will have a reference count of 1, and the RV will be returned.
7918 Do not use with other Perl types such as HV, AV, SV, CV, because those
7919 objects will become corrupted by the pointer copy process.
7921 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7927 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7931 sv_setsv(rv, &PL_sv_undef);
7935 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7940 =for apidoc sv_setref_iv
7942 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7943 argument will be upgraded to an RV. That RV will be modified to point to
7944 the new SV. The C<classname> argument indicates the package for the
7945 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7946 will have a reference count of 1, and the RV will be returned.
7952 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7954 sv_setiv(newSVrv(rv,classname), iv);
7959 =for apidoc sv_setref_uv
7961 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7962 argument will be upgraded to an RV. That RV will be modified to point to
7963 the new SV. The C<classname> argument indicates the package for the
7964 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7965 will have a reference count of 1, and the RV will be returned.
7971 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7973 sv_setuv(newSVrv(rv,classname), uv);
7978 =for apidoc sv_setref_nv
7980 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7981 argument will be upgraded to an RV. That RV will be modified to point to
7982 the new SV. The C<classname> argument indicates the package for the
7983 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7984 will have a reference count of 1, and the RV will be returned.
7990 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7992 sv_setnv(newSVrv(rv,classname), nv);
7997 =for apidoc sv_setref_pvn
7999 Copies a string into a new SV, optionally blessing the SV. The length of the
8000 string must be specified with C<n>. The C<rv> argument will be upgraded to
8001 an RV. That RV will be modified to point to the new SV. The C<classname>
8002 argument indicates the package for the blessing. Set C<classname> to
8003 C<NULL> to avoid the blessing. The new SV will have a reference count
8004 of 1, and the RV will be returned.
8006 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8012 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8014 sv_setpvn(newSVrv(rv,classname), pv, n);
8019 =for apidoc sv_bless
8021 Blesses an SV into a specified package. The SV must be an RV. The package
8022 must be designated by its stash (see C<gv_stashpv()>). The reference count
8023 of the SV is unaffected.
8029 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8034 Perl_croak(aTHX_ "Can't bless non-reference value");
8036 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8037 if (SvIsCOW(tmpRef))
8038 sv_force_normal_flags(tmpRef, 0);
8039 if (SvREADONLY(tmpRef))
8040 Perl_croak(aTHX_ PL_no_modify);
8041 if (SvOBJECT(tmpRef)) {
8042 if (SvTYPE(tmpRef) != SVt_PVIO)
8044 SvREFCNT_dec(SvSTASH(tmpRef));
8047 SvOBJECT_on(tmpRef);
8048 if (SvTYPE(tmpRef) != SVt_PVIO)
8050 SvUPGRADE(tmpRef, SVt_PVMG);
8051 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8056 (void)SvAMAGIC_off(sv);
8058 if(SvSMAGICAL(tmpRef))
8059 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8067 /* Downgrades a PVGV to a PVMG.
8071 S_sv_unglob(pTHX_ SV *sv)
8076 SV * const temp = sv_newmortal();
8078 assert(SvTYPE(sv) == SVt_PVGV);
8080 gv_efullname3(temp, (GV *) sv, "*");
8083 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8084 mro_method_changed_in(stash);
8088 sv_del_backref((SV*)GvSTASH(sv), sv);
8092 if (GvNAME_HEK(sv)) {
8093 unshare_hek(GvNAME_HEK(sv));
8095 isGV_with_GP_off(sv);
8097 /* need to keep SvANY(sv) in the right arena */
8098 xpvmg = new_XPVMG();
8099 StructCopy(SvANY(sv), xpvmg, XPVMG);
8100 del_XPVGV(SvANY(sv));
8103 SvFLAGS(sv) &= ~SVTYPEMASK;
8104 SvFLAGS(sv) |= SVt_PVMG;
8106 /* Intentionally not calling any local SET magic, as this isn't so much a
8107 set operation as merely an internal storage change. */
8108 sv_setsv_flags(sv, temp, 0);
8112 =for apidoc sv_unref_flags
8114 Unsets the RV status of the SV, and decrements the reference count of
8115 whatever was being referenced by the RV. This can almost be thought of
8116 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8117 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8118 (otherwise the decrementing is conditional on the reference count being
8119 different from one or the reference being a readonly SV).
8126 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8128 SV* const target = SvRV(ref);
8130 if (SvWEAKREF(ref)) {
8131 sv_del_backref(target, ref);
8133 SvRV_set(ref, NULL);
8136 SvRV_set(ref, NULL);
8138 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8139 assigned to as BEGIN {$a = \"Foo"} will fail. */
8140 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8141 SvREFCNT_dec(target);
8142 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8143 sv_2mortal(target); /* Schedule for freeing later */
8147 =for apidoc sv_untaint
8149 Untaint an SV. Use C<SvTAINTED_off> instead.
8154 Perl_sv_untaint(pTHX_ SV *sv)
8156 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8157 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8164 =for apidoc sv_tainted
8166 Test an SV for taintedness. Use C<SvTAINTED> instead.
8171 Perl_sv_tainted(pTHX_ SV *sv)
8173 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8174 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8175 if (mg && (mg->mg_len & 1) )
8182 =for apidoc sv_setpviv
8184 Copies an integer into the given SV, also updating its string value.
8185 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8191 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8193 char buf[TYPE_CHARS(UV)];
8195 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8197 sv_setpvn(sv, ptr, ebuf - ptr);
8201 =for apidoc sv_setpviv_mg
8203 Like C<sv_setpviv>, but also handles 'set' magic.
8209 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8215 #if defined(PERL_IMPLICIT_CONTEXT)
8217 /* pTHX_ magic can't cope with varargs, so this is a no-context
8218 * version of the main function, (which may itself be aliased to us).
8219 * Don't access this version directly.
8223 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8227 va_start(args, pat);
8228 sv_vsetpvf(sv, pat, &args);
8232 /* pTHX_ magic can't cope with varargs, so this is a no-context
8233 * version of the main function, (which may itself be aliased to us).
8234 * Don't access this version directly.
8238 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8242 va_start(args, pat);
8243 sv_vsetpvf_mg(sv, pat, &args);
8249 =for apidoc sv_setpvf
8251 Works like C<sv_catpvf> but copies the text into the SV instead of
8252 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8258 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8261 va_start(args, pat);
8262 sv_vsetpvf(sv, pat, &args);
8267 =for apidoc sv_vsetpvf
8269 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8270 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8272 Usually used via its frontend C<sv_setpvf>.
8278 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8280 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8284 =for apidoc sv_setpvf_mg
8286 Like C<sv_setpvf>, but also handles 'set' magic.
8292 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8295 va_start(args, pat);
8296 sv_vsetpvf_mg(sv, pat, &args);
8301 =for apidoc sv_vsetpvf_mg
8303 Like C<sv_vsetpvf>, but also handles 'set' magic.
8305 Usually used via its frontend C<sv_setpvf_mg>.
8311 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8313 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8317 #if defined(PERL_IMPLICIT_CONTEXT)
8319 /* pTHX_ magic can't cope with varargs, so this is a no-context
8320 * version of the main function, (which may itself be aliased to us).
8321 * Don't access this version directly.
8325 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8329 va_start(args, pat);
8330 sv_vcatpvf(sv, pat, &args);
8334 /* pTHX_ magic can't cope with varargs, so this is a no-context
8335 * version of the main function, (which may itself be aliased to us).
8336 * Don't access this version directly.
8340 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8344 va_start(args, pat);
8345 sv_vcatpvf_mg(sv, pat, &args);
8351 =for apidoc sv_catpvf
8353 Processes its arguments like C<sprintf> and appends the formatted
8354 output to an SV. If the appended data contains "wide" characters
8355 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8356 and characters >255 formatted with %c), the original SV might get
8357 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8358 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8359 valid UTF-8; if the original SV was bytes, the pattern should be too.
8364 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8367 va_start(args, pat);
8368 sv_vcatpvf(sv, pat, &args);
8373 =for apidoc sv_vcatpvf
8375 Processes its arguments like C<vsprintf> and appends the formatted output
8376 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8378 Usually used via its frontend C<sv_catpvf>.
8384 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8386 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8390 =for apidoc sv_catpvf_mg
8392 Like C<sv_catpvf>, but also handles 'set' magic.
8398 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8401 va_start(args, pat);
8402 sv_vcatpvf_mg(sv, pat, &args);
8407 =for apidoc sv_vcatpvf_mg
8409 Like C<sv_vcatpvf>, but also handles 'set' magic.
8411 Usually used via its frontend C<sv_catpvf_mg>.
8417 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8419 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8424 =for apidoc sv_vsetpvfn
8426 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8429 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8435 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8437 sv_setpvn(sv, "", 0);
8438 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8442 S_expect_number(pTHX_ char** pattern)
8446 switch (**pattern) {
8447 case '1': case '2': case '3':
8448 case '4': case '5': case '6':
8449 case '7': case '8': case '9':
8450 var = *(*pattern)++ - '0';
8451 while (isDIGIT(**pattern)) {
8452 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8454 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8462 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8464 const int neg = nv < 0;
8473 if (uv & 1 && uv == nv)
8474 uv--; /* Round to even */
8476 const unsigned dig = uv % 10;
8489 =for apidoc sv_vcatpvfn
8491 Processes its arguments like C<vsprintf> and appends the formatted output
8492 to an SV. Uses an array of SVs if the C style variable argument list is
8493 missing (NULL). When running with taint checks enabled, indicates via
8494 C<maybe_tainted> if results are untrustworthy (often due to the use of
8497 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8503 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8504 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8505 vec_utf8 = DO_UTF8(vecsv);
8507 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8510 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8518 static const char nullstr[] = "(null)";
8520 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8521 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8523 /* Times 4: a decimal digit takes more than 3 binary digits.
8524 * NV_DIG: mantissa takes than many decimal digits.
8525 * Plus 32: Playing safe. */
8526 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8527 /* large enough for "%#.#f" --chip */
8528 /* what about long double NVs? --jhi */
8530 PERL_UNUSED_ARG(maybe_tainted);
8532 /* no matter what, this is a string now */
8533 (void)SvPV_force(sv, origlen);
8535 /* special-case "", "%s", and "%-p" (SVf - see below) */
8538 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8540 const char * const s = va_arg(*args, char*);
8541 sv_catpv(sv, s ? s : nullstr);
8543 else if (svix < svmax) {
8544 sv_catsv(sv, *svargs);
8548 if (args && patlen == 3 && pat[0] == '%' &&
8549 pat[1] == '-' && pat[2] == 'p') {
8550 argsv = (SV*)va_arg(*args, void*);
8551 sv_catsv(sv, argsv);
8555 #ifndef USE_LONG_DOUBLE
8556 /* special-case "%.<number>[gf]" */
8557 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8558 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8559 unsigned digits = 0;
8563 while (*pp >= '0' && *pp <= '9')
8564 digits = 10 * digits + (*pp++ - '0');
8565 if (pp - pat == (int)patlen - 1) {
8573 /* Add check for digits != 0 because it seems that some
8574 gconverts are buggy in this case, and we don't yet have
8575 a Configure test for this. */
8576 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8577 /* 0, point, slack */
8578 Gconvert(nv, (int)digits, 0, ebuf);
8580 if (*ebuf) /* May return an empty string for digits==0 */
8583 } else if (!digits) {
8586 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8587 sv_catpvn(sv, p, l);
8593 #endif /* !USE_LONG_DOUBLE */
8595 if (!args && svix < svmax && DO_UTF8(*svargs))
8598 patend = (char*)pat + patlen;
8599 for (p = (char*)pat; p < patend; p = q) {
8602 bool vectorize = FALSE;
8603 bool vectorarg = FALSE;
8604 bool vec_utf8 = FALSE;
8610 bool has_precis = FALSE;
8612 const I32 osvix = svix;
8613 bool is_utf8 = FALSE; /* is this item utf8? */
8614 #ifdef HAS_LDBL_SPRINTF_BUG
8615 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8616 with sfio - Allen <allens@cpan.org> */
8617 bool fix_ldbl_sprintf_bug = FALSE;
8621 U8 utf8buf[UTF8_MAXBYTES+1];
8622 STRLEN esignlen = 0;
8624 const char *eptr = NULL;
8627 const U8 *vecstr = NULL;
8634 /* we need a long double target in case HAS_LONG_DOUBLE but
8637 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8645 const char *dotstr = ".";
8646 STRLEN dotstrlen = 1;
8647 I32 efix = 0; /* explicit format parameter index */
8648 I32 ewix = 0; /* explicit width index */
8649 I32 epix = 0; /* explicit precision index */
8650 I32 evix = 0; /* explicit vector index */
8651 bool asterisk = FALSE;
8653 /* echo everything up to the next format specification */
8654 for (q = p; q < patend && *q != '%'; ++q) ;
8656 if (has_utf8 && !pat_utf8)
8657 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8659 sv_catpvn(sv, p, q - p);
8666 We allow format specification elements in this order:
8667 \d+\$ explicit format parameter index
8669 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8670 0 flag (as above): repeated to allow "v02"
8671 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8672 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8674 [%bcdefginopsuxDFOUX] format (mandatory)
8679 As of perl5.9.3, printf format checking is on by default.
8680 Internally, perl uses %p formats to provide an escape to
8681 some extended formatting. This block deals with those
8682 extensions: if it does not match, (char*)q is reset and
8683 the normal format processing code is used.
8685 Currently defined extensions are:
8686 %p include pointer address (standard)
8687 %-p (SVf) include an SV (previously %_)
8688 %-<num>p include an SV with precision <num>
8689 %<num>p reserved for future extensions
8691 Robin Barker 2005-07-14
8693 %1p (VDf) removed. RMB 2007-10-19
8700 n = expect_number(&q);
8707 argsv = (SV*)va_arg(*args, void*);
8708 eptr = SvPV_const(argsv, elen);
8714 if (ckWARN_d(WARN_INTERNAL))
8715 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8716 "internal %%<num>p might conflict with future printf extensions");
8722 if ( (width = expect_number(&q)) ) {
8737 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8766 if ( (ewix = expect_number(&q)) )
8775 if ((vectorarg = asterisk)) {
8788 width = expect_number(&q);
8794 vecsv = va_arg(*args, SV*);
8796 vecsv = (evix > 0 && evix <= svmax)
8797 ? svargs[evix-1] : &PL_sv_undef;
8799 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8801 dotstr = SvPV_const(vecsv, dotstrlen);
8802 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8803 bad with tied or overloaded values that return UTF8. */
8806 else if (has_utf8) {
8807 vecsv = sv_mortalcopy(vecsv);
8808 sv_utf8_upgrade(vecsv);
8809 dotstr = SvPV_const(vecsv, dotstrlen);
8816 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8817 vecsv = svargs[efix ? efix-1 : svix++];
8818 vecstr = (U8*)SvPV_const(vecsv,veclen);
8819 vec_utf8 = DO_UTF8(vecsv);
8821 /* if this is a version object, we need to convert
8822 * back into v-string notation and then let the
8823 * vectorize happen normally
8825 if (sv_derived_from(vecsv, "version")) {
8826 char *version = savesvpv(vecsv);
8827 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8828 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8829 "vector argument not supported with alpha versions");
8832 vecsv = sv_newmortal();
8833 scan_vstring(version, version + veclen, vecsv);
8834 vecstr = (U8*)SvPV_const(vecsv, veclen);
8835 vec_utf8 = DO_UTF8(vecsv);
8847 i = va_arg(*args, int);
8849 i = (ewix ? ewix <= svmax : svix < svmax) ?
8850 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8852 width = (i < 0) ? -i : i;
8862 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8864 /* XXX: todo, support specified precision parameter */
8868 i = va_arg(*args, int);
8870 i = (ewix ? ewix <= svmax : svix < svmax)
8871 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8873 has_precis = !(i < 0);
8878 precis = precis * 10 + (*q++ - '0');
8887 case 'I': /* Ix, I32x, and I64x */
8889 if (q[1] == '6' && q[2] == '4') {
8895 if (q[1] == '3' && q[2] == '2') {
8905 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8916 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8917 if (*(q + 1) == 'l') { /* lld, llf */
8943 if (!vectorize && !args) {
8945 const I32 i = efix-1;
8946 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8948 argsv = (svix >= 0 && svix < svmax)
8949 ? svargs[svix++] : &PL_sv_undef;
8960 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8962 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8964 eptr = (char*)utf8buf;
8965 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8979 eptr = va_arg(*args, char*);
8981 #ifdef MACOS_TRADITIONAL
8982 /* On MacOS, %#s format is used for Pascal strings */
8987 elen = strlen(eptr);
8989 eptr = (char *)nullstr;
8990 elen = sizeof nullstr - 1;
8994 eptr = SvPV_const(argsv, elen);
8995 if (DO_UTF8(argsv)) {
8996 I32 old_precis = precis;
8997 if (has_precis && precis < elen) {
8999 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9002 if (width) { /* fudge width (can't fudge elen) */
9003 if (has_precis && precis < elen)
9004 width += precis - old_precis;
9006 width += elen - sv_len_utf8(argsv);
9013 if (has_precis && elen > precis)
9020 if (alt || vectorize)
9022 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9043 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9052 esignbuf[esignlen++] = plus;
9056 case 'h': iv = (short)va_arg(*args, int); break;
9057 case 'l': iv = va_arg(*args, long); break;
9058 case 'V': iv = va_arg(*args, IV); break;
9059 default: iv = va_arg(*args, int); break;
9061 case 'q': iv = va_arg(*args, Quad_t); break;
9066 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9068 case 'h': iv = (short)tiv; break;
9069 case 'l': iv = (long)tiv; break;
9071 default: iv = tiv; break;
9073 case 'q': iv = (Quad_t)tiv; break;
9077 if ( !vectorize ) /* we already set uv above */
9082 esignbuf[esignlen++] = plus;
9086 esignbuf[esignlen++] = '-';
9130 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9141 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9142 case 'l': uv = va_arg(*args, unsigned long); break;
9143 case 'V': uv = va_arg(*args, UV); break;
9144 default: uv = va_arg(*args, unsigned); break;
9146 case 'q': uv = va_arg(*args, Uquad_t); break;
9151 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9153 case 'h': uv = (unsigned short)tuv; break;
9154 case 'l': uv = (unsigned long)tuv; break;
9156 default: uv = tuv; break;
9158 case 'q': uv = (Uquad_t)tuv; break;
9165 char *ptr = ebuf + sizeof ebuf;
9166 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9172 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9178 esignbuf[esignlen++] = '0';
9179 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9187 if (alt && *ptr != '0')
9196 esignbuf[esignlen++] = '0';
9197 esignbuf[esignlen++] = c;
9200 default: /* it had better be ten or less */
9204 } while (uv /= base);
9207 elen = (ebuf + sizeof ebuf) - ptr;
9211 zeros = precis - elen;
9212 else if (precis == 0 && elen == 1 && *eptr == '0'
9213 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9216 /* a precision nullifies the 0 flag. */
9223 /* FLOATING POINT */
9226 c = 'f'; /* maybe %F isn't supported here */
9234 /* This is evil, but floating point is even more evil */
9236 /* for SV-style calling, we can only get NV
9237 for C-style calling, we assume %f is double;
9238 for simplicity we allow any of %Lf, %llf, %qf for long double
9242 #if defined(USE_LONG_DOUBLE)
9246 /* [perl #20339] - we should accept and ignore %lf rather than die */
9250 #if defined(USE_LONG_DOUBLE)
9251 intsize = args ? 0 : 'q';
9255 #if defined(HAS_LONG_DOUBLE)
9264 /* now we need (long double) if intsize == 'q', else (double) */
9266 #if LONG_DOUBLESIZE > DOUBLESIZE
9268 va_arg(*args, long double) :
9269 va_arg(*args, double)
9271 va_arg(*args, double)
9276 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9277 else. frexp() has some unspecified behaviour for those three */
9278 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9280 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9281 will cast our (long double) to (double) */
9282 (void)Perl_frexp(nv, &i);
9283 if (i == PERL_INT_MIN)
9284 Perl_die(aTHX_ "panic: frexp");
9286 need = BIT_DIGITS(i);
9288 need += has_precis ? precis : 6; /* known default */
9293 #ifdef HAS_LDBL_SPRINTF_BUG
9294 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9295 with sfio - Allen <allens@cpan.org> */
9298 # define MY_DBL_MAX DBL_MAX
9299 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9300 # if DOUBLESIZE >= 8
9301 # define MY_DBL_MAX 1.7976931348623157E+308L
9303 # define MY_DBL_MAX 3.40282347E+38L
9307 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9308 # define MY_DBL_MAX_BUG 1L
9310 # define MY_DBL_MAX_BUG MY_DBL_MAX
9314 # define MY_DBL_MIN DBL_MIN
9315 # else /* XXX guessing! -Allen */
9316 # if DOUBLESIZE >= 8
9317 # define MY_DBL_MIN 2.2250738585072014E-308L
9319 # define MY_DBL_MIN 1.17549435E-38L
9323 if ((intsize == 'q') && (c == 'f') &&
9324 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9326 /* it's going to be short enough that
9327 * long double precision is not needed */
9329 if ((nv <= 0L) && (nv >= -0L))
9330 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9332 /* would use Perl_fp_class as a double-check but not
9333 * functional on IRIX - see perl.h comments */
9335 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9336 /* It's within the range that a double can represent */
9337 #if defined(DBL_MAX) && !defined(DBL_MIN)
9338 if ((nv >= ((long double)1/DBL_MAX)) ||
9339 (nv <= (-(long double)1/DBL_MAX)))
9341 fix_ldbl_sprintf_bug = TRUE;
9344 if (fix_ldbl_sprintf_bug == TRUE) {
9354 # undef MY_DBL_MAX_BUG
9357 #endif /* HAS_LDBL_SPRINTF_BUG */
9359 need += 20; /* fudge factor */
9360 if (PL_efloatsize < need) {
9361 Safefree(PL_efloatbuf);
9362 PL_efloatsize = need + 20; /* more fudge */
9363 Newx(PL_efloatbuf, PL_efloatsize, char);
9364 PL_efloatbuf[0] = '\0';
9367 if ( !(width || left || plus || alt) && fill != '0'
9368 && has_precis && intsize != 'q' ) { /* Shortcuts */
9369 /* See earlier comment about buggy Gconvert when digits,
9371 if ( c == 'g' && precis) {
9372 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9373 /* May return an empty string for digits==0 */
9374 if (*PL_efloatbuf) {
9375 elen = strlen(PL_efloatbuf);
9376 goto float_converted;
9378 } else if ( c == 'f' && !precis) {
9379 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9384 char *ptr = ebuf + sizeof ebuf;
9387 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9388 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9389 if (intsize == 'q') {
9390 /* Copy the one or more characters in a long double
9391 * format before the 'base' ([efgEFG]) character to
9392 * the format string. */
9393 static char const prifldbl[] = PERL_PRIfldbl;
9394 char const *p = prifldbl + sizeof(prifldbl) - 3;
9395 while (p >= prifldbl) { *--ptr = *p--; }
9400 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9405 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9417 /* No taint. Otherwise we are in the strange situation
9418 * where printf() taints but print($float) doesn't.
9420 #if defined(HAS_LONG_DOUBLE)
9421 elen = ((intsize == 'q')
9422 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9423 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9425 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9429 eptr = PL_efloatbuf;
9437 i = SvCUR(sv) - origlen;
9440 case 'h': *(va_arg(*args, short*)) = i; break;
9441 default: *(va_arg(*args, int*)) = i; break;
9442 case 'l': *(va_arg(*args, long*)) = i; break;
9443 case 'V': *(va_arg(*args, IV*)) = i; break;
9445 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9450 sv_setuv_mg(argsv, (UV)i);
9451 continue; /* not "break" */
9458 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9459 && ckWARN(WARN_PRINTF))
9461 SV * const msg = sv_newmortal();
9462 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9463 (PL_op->op_type == OP_PRTF) ? "" : "s");
9466 Perl_sv_catpvf(aTHX_ msg,
9467 "\"%%%c\"", c & 0xFF);
9469 Perl_sv_catpvf(aTHX_ msg,
9470 "\"%%\\%03"UVof"\"",
9473 sv_catpvs(msg, "end of string");
9474 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9477 /* output mangled stuff ... */
9483 /* ... right here, because formatting flags should not apply */
9484 SvGROW(sv, SvCUR(sv) + elen + 1);
9486 Copy(eptr, p, elen, char);
9489 SvCUR_set(sv, p - SvPVX_const(sv));
9491 continue; /* not "break" */
9494 if (is_utf8 != has_utf8) {
9497 sv_utf8_upgrade(sv);
9500 const STRLEN old_elen = elen;
9501 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9502 sv_utf8_upgrade(nsv);
9503 eptr = SvPVX_const(nsv);
9506 if (width) { /* fudge width (can't fudge elen) */
9507 width += elen - old_elen;
9513 have = esignlen + zeros + elen;
9515 Perl_croak_nocontext(PL_memory_wrap);
9517 need = (have > width ? have : width);
9520 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9521 Perl_croak_nocontext(PL_memory_wrap);
9522 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9524 if (esignlen && fill == '0') {
9526 for (i = 0; i < (int)esignlen; i++)
9530 memset(p, fill, gap);
9533 if (esignlen && fill != '0') {
9535 for (i = 0; i < (int)esignlen; i++)
9540 for (i = zeros; i; i--)
9544 Copy(eptr, p, elen, char);
9548 memset(p, ' ', gap);
9553 Copy(dotstr, p, dotstrlen, char);
9557 vectorize = FALSE; /* done iterating over vecstr */
9564 SvCUR_set(sv, p - SvPVX_const(sv));
9572 /* =========================================================================
9574 =head1 Cloning an interpreter
9576 All the macros and functions in this section are for the private use of
9577 the main function, perl_clone().
9579 The foo_dup() functions make an exact copy of an existing foo thingy.
9580 During the course of a cloning, a hash table is used to map old addresses
9581 to new addresses. The table is created and manipulated with the
9582 ptr_table_* functions.
9586 ============================================================================*/
9589 #if defined(USE_ITHREADS)
9591 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9592 #ifndef GpREFCNT_inc
9593 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9597 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9598 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9599 If this changes, please unmerge ss_dup. */
9600 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9601 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9602 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9603 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9604 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9605 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9606 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9607 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9608 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9609 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9610 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9611 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9612 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9613 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9615 /* clone a parser */
9618 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9625 /* look for it in the table first */
9626 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9630 /* create anew and remember what it is */
9631 Newxz(parser, 1, yy_parser);
9632 ptr_table_store(PL_ptr_table, proto, parser);
9634 parser->yyerrstatus = 0;
9635 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9637 /* XXX these not yet duped */
9638 parser->old_parser = NULL;
9639 parser->stack = NULL;
9641 parser->stack_size = 0;
9642 /* XXX parser->stack->state = 0; */
9644 /* XXX eventually, just Copy() most of the parser struct ? */
9646 parser->lex_brackets = proto->lex_brackets;
9647 parser->lex_casemods = proto->lex_casemods;
9648 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9649 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9650 parser->lex_casestack = savepvn(proto->lex_casestack,
9651 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9652 parser->lex_defer = proto->lex_defer;
9653 parser->lex_dojoin = proto->lex_dojoin;
9654 parser->lex_expect = proto->lex_expect;
9655 parser->lex_formbrack = proto->lex_formbrack;
9656 parser->lex_inpat = proto->lex_inpat;
9657 parser->lex_inwhat = proto->lex_inwhat;
9658 parser->lex_op = proto->lex_op;
9659 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9660 parser->lex_starts = proto->lex_starts;
9661 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9662 parser->multi_close = proto->multi_close;
9663 parser->multi_open = proto->multi_open;
9664 parser->multi_start = proto->multi_start;
9665 parser->multi_end = proto->multi_end;
9666 parser->pending_ident = proto->pending_ident;
9667 parser->preambled = proto->preambled;
9668 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9669 parser->linestr = sv_dup_inc(proto->linestr, param);
9670 parser->expect = proto->expect;
9671 parser->copline = proto->copline;
9672 parser->last_lop_op = proto->last_lop_op;
9673 parser->lex_state = proto->lex_state;
9674 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9675 /* rsfp_filters entries have fake IoDIRP() */
9676 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9677 parser->in_my = proto->in_my;
9678 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9679 parser->error_count = proto->error_count;
9682 parser->linestr = sv_dup_inc(proto->linestr, param);
9685 char * const ols = SvPVX(proto->linestr);
9686 char * const ls = SvPVX(parser->linestr);
9688 parser->bufptr = ls + (proto->bufptr >= ols ?
9689 proto->bufptr - ols : 0);
9690 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9691 proto->oldbufptr - ols : 0);
9692 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9693 proto->oldoldbufptr - ols : 0);
9694 parser->linestart = ls + (proto->linestart >= ols ?
9695 proto->linestart - ols : 0);
9696 parser->last_uni = ls + (proto->last_uni >= ols ?
9697 proto->last_uni - ols : 0);
9698 parser->last_lop = ls + (proto->last_lop >= ols ?
9699 proto->last_lop - ols : 0);
9701 parser->bufend = ls + SvCUR(parser->linestr);
9704 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9708 parser->endwhite = proto->endwhite;
9709 parser->faketokens = proto->faketokens;
9710 parser->lasttoke = proto->lasttoke;
9711 parser->nextwhite = proto->nextwhite;
9712 parser->realtokenstart = proto->realtokenstart;
9713 parser->skipwhite = proto->skipwhite;
9714 parser->thisclose = proto->thisclose;
9715 parser->thismad = proto->thismad;
9716 parser->thisopen = proto->thisopen;
9717 parser->thisstuff = proto->thisstuff;
9718 parser->thistoken = proto->thistoken;
9719 parser->thiswhite = proto->thiswhite;
9721 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9722 parser->curforce = proto->curforce;
9724 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9725 Copy(proto->nexttype, parser->nexttype, 5, I32);
9726 parser->nexttoke = proto->nexttoke;
9732 /* duplicate a file handle */
9735 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9739 PERL_UNUSED_ARG(type);
9742 return (PerlIO*)NULL;
9744 /* look for it in the table first */
9745 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9749 /* create anew and remember what it is */
9750 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9751 ptr_table_store(PL_ptr_table, fp, ret);
9755 /* duplicate a directory handle */
9758 Perl_dirp_dup(pTHX_ DIR *dp)
9760 PERL_UNUSED_CONTEXT;
9767 /* duplicate a typeglob */
9770 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9776 /* look for it in the table first */
9777 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9781 /* create anew and remember what it is */
9783 ptr_table_store(PL_ptr_table, gp, ret);
9786 ret->gp_refcnt = 0; /* must be before any other dups! */
9787 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9788 ret->gp_io = io_dup_inc(gp->gp_io, param);
9789 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9790 ret->gp_av = av_dup_inc(gp->gp_av, param);
9791 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9792 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9793 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9794 ret->gp_cvgen = gp->gp_cvgen;
9795 ret->gp_line = gp->gp_line;
9796 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9800 /* duplicate a chain of magic */
9803 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9805 MAGIC *mgprev = (MAGIC*)NULL;
9808 return (MAGIC*)NULL;
9809 /* look for it in the table first */
9810 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9814 for (; mg; mg = mg->mg_moremagic) {
9816 Newxz(nmg, 1, MAGIC);
9818 mgprev->mg_moremagic = nmg;
9821 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9822 nmg->mg_private = mg->mg_private;
9823 nmg->mg_type = mg->mg_type;
9824 nmg->mg_flags = mg->mg_flags;
9825 if (mg->mg_type == PERL_MAGIC_qr) {
9826 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9828 else if(mg->mg_type == PERL_MAGIC_backref) {
9829 /* The backref AV has its reference count deliberately bumped by
9831 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9834 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9835 ? sv_dup_inc(mg->mg_obj, param)
9836 : sv_dup(mg->mg_obj, param);
9838 nmg->mg_len = mg->mg_len;
9839 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9840 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9841 if (mg->mg_len > 0) {
9842 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9843 if (mg->mg_type == PERL_MAGIC_overload_table &&
9844 AMT_AMAGIC((AMT*)mg->mg_ptr))
9846 const AMT * const amtp = (AMT*)mg->mg_ptr;
9847 AMT * const namtp = (AMT*)nmg->mg_ptr;
9849 for (i = 1; i < NofAMmeth; i++) {
9850 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9854 else if (mg->mg_len == HEf_SVKEY)
9855 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9857 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9858 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9865 #endif /* USE_ITHREADS */
9867 /* create a new pointer-mapping table */
9870 Perl_ptr_table_new(pTHX)
9873 PERL_UNUSED_CONTEXT;
9875 Newxz(tbl, 1, PTR_TBL_t);
9878 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9882 #define PTR_TABLE_HASH(ptr) \
9883 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9886 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9887 following define) and at call to new_body_inline made below in
9888 Perl_ptr_table_store()
9891 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9893 /* map an existing pointer using a table */
9895 STATIC PTR_TBL_ENT_t *
9896 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9897 PTR_TBL_ENT_t *tblent;
9898 const UV hash = PTR_TABLE_HASH(sv);
9900 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9901 for (; tblent; tblent = tblent->next) {
9902 if (tblent->oldval == sv)
9909 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9911 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9912 PERL_UNUSED_CONTEXT;
9913 return tblent ? tblent->newval : NULL;
9916 /* add a new entry to a pointer-mapping table */
9919 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9921 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9922 PERL_UNUSED_CONTEXT;
9925 tblent->newval = newsv;
9927 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9929 new_body_inline(tblent, PTE_SVSLOT);
9931 tblent->oldval = oldsv;
9932 tblent->newval = newsv;
9933 tblent->next = tbl->tbl_ary[entry];
9934 tbl->tbl_ary[entry] = tblent;
9936 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9937 ptr_table_split(tbl);
9941 /* double the hash bucket size of an existing ptr table */
9944 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9946 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9947 const UV oldsize = tbl->tbl_max + 1;
9948 UV newsize = oldsize * 2;
9950 PERL_UNUSED_CONTEXT;
9952 Renew(ary, newsize, PTR_TBL_ENT_t*);
9953 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9954 tbl->tbl_max = --newsize;
9956 for (i=0; i < oldsize; i++, ary++) {
9957 PTR_TBL_ENT_t **curentp, **entp, *ent;
9960 curentp = ary + oldsize;
9961 for (entp = ary, ent = *ary; ent; ent = *entp) {
9962 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9964 ent->next = *curentp;
9974 /* remove all the entries from a ptr table */
9977 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9979 if (tbl && tbl->tbl_items) {
9980 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9981 UV riter = tbl->tbl_max;
9984 PTR_TBL_ENT_t *entry = array[riter];
9987 PTR_TBL_ENT_t * const oentry = entry;
9988 entry = entry->next;
9997 /* clear and free a ptr table */
10000 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10005 ptr_table_clear(tbl);
10006 Safefree(tbl->tbl_ary);
10010 #if defined(USE_ITHREADS)
10013 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10016 SvRV_set(dstr, SvWEAKREF(sstr)
10017 ? sv_dup(SvRV(sstr), param)
10018 : sv_dup_inc(SvRV(sstr), param));
10021 else if (SvPVX_const(sstr)) {
10022 /* Has something there */
10024 /* Normal PV - clone whole allocated space */
10025 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10026 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10027 /* Not that normal - actually sstr is copy on write.
10028 But we are a true, independant SV, so: */
10029 SvREADONLY_off(dstr);
10034 /* Special case - not normally malloced for some reason */
10035 if (isGV_with_GP(sstr)) {
10036 /* Don't need to do anything here. */
10038 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10039 /* A "shared" PV - clone it as "shared" PV */
10041 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10045 /* Some other special case - random pointer */
10046 SvPV_set(dstr, SvPVX(sstr));
10051 /* Copy the NULL */
10052 SvPV_set(dstr, NULL);
10056 /* duplicate an SV of any type (including AV, HV etc) */
10059 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10064 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10066 /* look for it in the table first */
10067 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10071 if(param->flags & CLONEf_JOIN_IN) {
10072 /** We are joining here so we don't want do clone
10073 something that is bad **/
10074 if (SvTYPE(sstr) == SVt_PVHV) {
10075 const HEK * const hvname = HvNAME_HEK(sstr);
10077 /** don't clone stashes if they already exist **/
10078 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10082 /* create anew and remember what it is */
10085 #ifdef DEBUG_LEAKING_SCALARS
10086 dstr->sv_debug_optype = sstr->sv_debug_optype;
10087 dstr->sv_debug_line = sstr->sv_debug_line;
10088 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10089 dstr->sv_debug_cloned = 1;
10090 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10093 ptr_table_store(PL_ptr_table, sstr, dstr);
10096 SvFLAGS(dstr) = SvFLAGS(sstr);
10097 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10098 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10101 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10102 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10103 (void*)PL_watch_pvx, SvPVX_const(sstr));
10106 /* don't clone objects whose class has asked us not to */
10107 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10112 switch (SvTYPE(sstr)) {
10114 SvANY(dstr) = NULL;
10117 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10119 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10121 SvIV_set(dstr, SvIVX(sstr));
10125 SvANY(dstr) = new_XNV();
10126 SvNV_set(dstr, SvNVX(sstr));
10128 /* case SVt_BIND: */
10131 /* These are all the types that need complex bodies allocating. */
10133 const svtype sv_type = SvTYPE(sstr);
10134 const struct body_details *const sv_type_details
10135 = bodies_by_type + sv_type;
10139 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10143 if (GvUNIQUE((GV*)sstr)) {
10144 NOOP; /* Do sharing here, and fall through */
10157 assert(sv_type_details->body_size);
10158 if (sv_type_details->arena) {
10159 new_body_inline(new_body, sv_type);
10161 = (void*)((char*)new_body - sv_type_details->offset);
10163 new_body = new_NOARENA(sv_type_details);
10167 SvANY(dstr) = new_body;
10170 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10171 ((char*)SvANY(dstr)) + sv_type_details->offset,
10172 sv_type_details->copy, char);
10174 Copy(((char*)SvANY(sstr)),
10175 ((char*)SvANY(dstr)),
10176 sv_type_details->body_size + sv_type_details->offset, char);
10179 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10180 && !isGV_with_GP(dstr))
10181 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10183 /* The Copy above means that all the source (unduplicated) pointers
10184 are now in the destination. We can check the flags and the
10185 pointers in either, but it's possible that there's less cache
10186 missing by always going for the destination.
10187 FIXME - instrument and check that assumption */
10188 if (sv_type >= SVt_PVMG) {
10189 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10190 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10191 } else if (SvMAGIC(dstr))
10192 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10194 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10197 /* The cast silences a GCC warning about unhandled types. */
10198 switch ((int)sv_type) {
10208 ((struct xregexp *)SvANY(dstr))->xrx_regexp
10209 = CALLREGDUPE(((struct xregexp *)SvANY(dstr))->xrx_regexp,
10213 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10214 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10215 LvTARG(dstr) = dstr;
10216 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10217 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10219 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10221 if(isGV_with_GP(sstr)) {
10222 if (GvNAME_HEK(dstr))
10223 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10224 /* Don't call sv_add_backref here as it's going to be
10225 created as part of the magic cloning of the symbol
10227 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10228 at the point of this comment. */
10229 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10230 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10231 (void)GpREFCNT_inc(GvGP(dstr));
10233 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10236 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10237 if (IoOFP(dstr) == IoIFP(sstr))
10238 IoOFP(dstr) = IoIFP(dstr);
10240 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10241 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10242 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10243 /* I have no idea why fake dirp (rsfps)
10244 should be treated differently but otherwise
10245 we end up with leaks -- sky*/
10246 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10247 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10248 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10250 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10251 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10252 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10253 if (IoDIRP(dstr)) {
10254 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10257 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10260 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10261 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10262 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10265 if (AvARRAY((AV*)sstr)) {
10266 SV **dst_ary, **src_ary;
10267 SSize_t items = AvFILLp((AV*)sstr) + 1;
10269 src_ary = AvARRAY((AV*)sstr);
10270 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10271 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10272 AvARRAY((AV*)dstr) = dst_ary;
10273 AvALLOC((AV*)dstr) = dst_ary;
10274 if (AvREAL((AV*)sstr)) {
10275 while (items-- > 0)
10276 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10279 while (items-- > 0)
10280 *dst_ary++ = sv_dup(*src_ary++, param);
10282 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10283 while (items-- > 0) {
10284 *dst_ary++ = &PL_sv_undef;
10288 AvARRAY((AV*)dstr) = NULL;
10289 AvALLOC((AV*)dstr) = (SV**)NULL;
10293 if (HvARRAY((HV*)sstr)) {
10295 const bool sharekeys = !!HvSHAREKEYS(sstr);
10296 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10297 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10299 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10300 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10302 HvARRAY(dstr) = (HE**)darray;
10303 while (i <= sxhv->xhv_max) {
10304 const HE * const source = HvARRAY(sstr)[i];
10305 HvARRAY(dstr)[i] = source
10306 ? he_dup(source, sharekeys, param) : 0;
10311 const struct xpvhv_aux * const saux = HvAUX(sstr);
10312 struct xpvhv_aux * const daux = HvAUX(dstr);
10313 /* This flag isn't copied. */
10314 /* SvOOK_on(hv) attacks the IV flags. */
10315 SvFLAGS(dstr) |= SVf_OOK;
10317 hvname = saux->xhv_name;
10318 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10320 daux->xhv_riter = saux->xhv_riter;
10321 daux->xhv_eiter = saux->xhv_eiter
10322 ? he_dup(saux->xhv_eiter,
10323 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10324 daux->xhv_backreferences =
10325 saux->xhv_backreferences
10326 ? (AV*) SvREFCNT_inc(
10327 sv_dup((SV*)saux->xhv_backreferences, param))
10330 daux->xhv_mro_meta = saux->xhv_mro_meta
10331 ? mro_meta_dup(saux->xhv_mro_meta, param)
10334 /* Record stashes for possible cloning in Perl_clone(). */
10336 av_push(param->stashes, dstr);
10340 HvARRAY((HV*)dstr) = NULL;
10343 if (!(param->flags & CLONEf_COPY_STACKS)) {
10347 /* NOTE: not refcounted */
10348 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10350 if (!CvISXSUB(dstr))
10351 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10353 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10354 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10355 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10356 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10358 /* don't dup if copying back - CvGV isn't refcounted, so the
10359 * duped GV may never be freed. A bit of a hack! DAPM */
10360 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10361 NULL : gv_dup(CvGV(dstr), param) ;
10362 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10364 CvWEAKOUTSIDE(sstr)
10365 ? cv_dup( CvOUTSIDE(dstr), param)
10366 : cv_dup_inc(CvOUTSIDE(dstr), param);
10367 if (!CvISXSUB(dstr))
10368 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10374 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10380 /* duplicate a context */
10383 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10385 PERL_CONTEXT *ncxs;
10388 return (PERL_CONTEXT*)NULL;
10390 /* look for it in the table first */
10391 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10395 /* create anew and remember what it is */
10396 Newxz(ncxs, max + 1, PERL_CONTEXT);
10397 ptr_table_store(PL_ptr_table, cxs, ncxs);
10400 PERL_CONTEXT * const cx = &cxs[ix];
10401 PERL_CONTEXT * const ncx = &ncxs[ix];
10402 ncx->cx_type = cx->cx_type;
10403 if (CxTYPE(cx) == CXt_SUBST) {
10404 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10407 ncx->blk_oldsp = cx->blk_oldsp;
10408 ncx->blk_oldcop = cx->blk_oldcop;
10409 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10410 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10411 ncx->blk_oldpm = cx->blk_oldpm;
10412 ncx->blk_gimme = cx->blk_gimme;
10413 switch (CxTYPE(cx)) {
10415 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10416 ? cv_dup_inc(cx->blk_sub.cv, param)
10417 : cv_dup(cx->blk_sub.cv,param));
10418 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10419 ? av_dup_inc(cx->blk_sub.argarray, param)
10421 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10422 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10423 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10424 ncx->blk_sub.lval = cx->blk_sub.lval;
10425 ncx->blk_sub.retop = cx->blk_sub.retop;
10426 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10427 cx->blk_sub.oldcomppad);
10430 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10431 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10432 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10433 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10434 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10435 ncx->blk_eval.retop = cx->blk_eval.retop;
10438 ncx->blk_loop.label = cx->blk_loop.label;
10439 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10440 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10441 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10442 ? cx->blk_loop.iterdata
10443 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10444 ncx->blk_loop.oldcomppad
10445 = (PAD*)ptr_table_fetch(PL_ptr_table,
10446 cx->blk_loop.oldcomppad);
10447 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10448 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10449 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10450 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10451 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10454 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10455 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10456 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10457 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10458 ncx->blk_sub.retop = cx->blk_sub.retop;
10470 /* duplicate a stack info structure */
10473 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10478 return (PERL_SI*)NULL;
10480 /* look for it in the table first */
10481 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10485 /* create anew and remember what it is */
10486 Newxz(nsi, 1, PERL_SI);
10487 ptr_table_store(PL_ptr_table, si, nsi);
10489 nsi->si_stack = av_dup_inc(si->si_stack, param);
10490 nsi->si_cxix = si->si_cxix;
10491 nsi->si_cxmax = si->si_cxmax;
10492 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10493 nsi->si_type = si->si_type;
10494 nsi->si_prev = si_dup(si->si_prev, param);
10495 nsi->si_next = si_dup(si->si_next, param);
10496 nsi->si_markoff = si->si_markoff;
10501 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10502 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10503 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10504 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10505 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10506 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10507 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10508 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10509 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10510 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10511 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10512 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10513 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10514 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10517 #define pv_dup_inc(p) SAVEPV(p)
10518 #define pv_dup(p) SAVEPV(p)
10519 #define svp_dup_inc(p,pp) any_dup(p,pp)
10521 /* map any object to the new equivent - either something in the
10522 * ptr table, or something in the interpreter structure
10526 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10531 return (void*)NULL;
10533 /* look for it in the table first */
10534 ret = ptr_table_fetch(PL_ptr_table, v);
10538 /* see if it is part of the interpreter structure */
10539 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10540 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10548 /* duplicate the save stack */
10551 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10554 ANY * const ss = proto_perl->Isavestack;
10555 const I32 max = proto_perl->Isavestack_max;
10556 I32 ix = proto_perl->Isavestack_ix;
10569 void (*dptr) (void*);
10570 void (*dxptr) (pTHX_ void*);
10572 Newxz(nss, max, ANY);
10575 const I32 type = POPINT(ss,ix);
10576 TOPINT(nss,ix) = type;
10578 case SAVEt_HELEM: /* hash element */
10579 sv = (SV*)POPPTR(ss,ix);
10580 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10582 case SAVEt_ITEM: /* normal string */
10583 case SAVEt_SV: /* scalar reference */
10584 sv = (SV*)POPPTR(ss,ix);
10585 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10588 case SAVEt_MORTALIZESV:
10589 sv = (SV*)POPPTR(ss,ix);
10590 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10592 case SAVEt_SHARED_PVREF: /* char* in shared space */
10593 c = (char*)POPPTR(ss,ix);
10594 TOPPTR(nss,ix) = savesharedpv(c);
10595 ptr = POPPTR(ss,ix);
10596 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10598 case SAVEt_GENERIC_SVREF: /* generic sv */
10599 case SAVEt_SVREF: /* scalar reference */
10600 sv = (SV*)POPPTR(ss,ix);
10601 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10602 ptr = POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10605 case SAVEt_HV: /* hash reference */
10606 case SAVEt_AV: /* array reference */
10607 sv = (SV*) POPPTR(ss,ix);
10608 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10610 case SAVEt_COMPPAD:
10612 sv = (SV*) POPPTR(ss,ix);
10613 TOPPTR(nss,ix) = sv_dup(sv, param);
10615 case SAVEt_INT: /* int reference */
10616 ptr = POPPTR(ss,ix);
10617 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10618 intval = (int)POPINT(ss,ix);
10619 TOPINT(nss,ix) = intval;
10621 case SAVEt_LONG: /* long reference */
10622 ptr = POPPTR(ss,ix);
10623 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10625 case SAVEt_CLEARSV:
10626 longval = (long)POPLONG(ss,ix);
10627 TOPLONG(nss,ix) = longval;
10629 case SAVEt_I32: /* I32 reference */
10630 case SAVEt_I16: /* I16 reference */
10631 case SAVEt_I8: /* I8 reference */
10632 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10633 ptr = POPPTR(ss,ix);
10634 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10636 TOPINT(nss,ix) = i;
10638 case SAVEt_IV: /* IV reference */
10639 ptr = POPPTR(ss,ix);
10640 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10642 TOPIV(nss,ix) = iv;
10644 case SAVEt_HPTR: /* HV* reference */
10645 case SAVEt_APTR: /* AV* reference */
10646 case SAVEt_SPTR: /* SV* reference */
10647 ptr = POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10649 sv = (SV*)POPPTR(ss,ix);
10650 TOPPTR(nss,ix) = sv_dup(sv, param);
10652 case SAVEt_VPTR: /* random* reference */
10653 ptr = POPPTR(ss,ix);
10654 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10655 ptr = POPPTR(ss,ix);
10656 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10658 case SAVEt_GENERIC_PVREF: /* generic char* */
10659 case SAVEt_PPTR: /* char* reference */
10660 ptr = POPPTR(ss,ix);
10661 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10662 c = (char*)POPPTR(ss,ix);
10663 TOPPTR(nss,ix) = pv_dup(c);
10665 case SAVEt_GP: /* scalar reference */
10666 gp = (GP*)POPPTR(ss,ix);
10667 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10668 (void)GpREFCNT_inc(gp);
10669 gv = (GV*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10673 ptr = POPPTR(ss,ix);
10674 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10675 /* these are assumed to be refcounted properly */
10677 switch (((OP*)ptr)->op_type) {
10679 case OP_LEAVESUBLV:
10683 case OP_LEAVEWRITE:
10684 TOPPTR(nss,ix) = ptr;
10687 (void) OpREFCNT_inc(o);
10691 TOPPTR(nss,ix) = NULL;
10696 TOPPTR(nss,ix) = NULL;
10699 c = (char*)POPPTR(ss,ix);
10700 TOPPTR(nss,ix) = pv_dup_inc(c);
10703 hv = (HV*)POPPTR(ss,ix);
10704 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10705 c = (char*)POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = pv_dup_inc(c);
10708 case SAVEt_STACK_POS: /* Position on Perl stack */
10710 TOPINT(nss,ix) = i;
10712 case SAVEt_DESTRUCTOR:
10713 ptr = POPPTR(ss,ix);
10714 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10715 dptr = POPDPTR(ss,ix);
10716 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10717 any_dup(FPTR2DPTR(void *, dptr),
10720 case SAVEt_DESTRUCTOR_X:
10721 ptr = POPPTR(ss,ix);
10722 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10723 dxptr = POPDXPTR(ss,ix);
10724 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10725 any_dup(FPTR2DPTR(void *, dxptr),
10728 case SAVEt_REGCONTEXT:
10731 TOPINT(nss,ix) = i;
10734 case SAVEt_AELEM: /* array element */
10735 sv = (SV*)POPPTR(ss,ix);
10736 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10738 TOPINT(nss,ix) = i;
10739 av = (AV*)POPPTR(ss,ix);
10740 TOPPTR(nss,ix) = av_dup_inc(av, param);
10743 ptr = POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = ptr;
10748 TOPINT(nss,ix) = i;
10749 ptr = POPPTR(ss,ix);
10752 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10753 HINTS_REFCNT_UNLOCK;
10755 TOPPTR(nss,ix) = ptr;
10756 if (i & HINT_LOCALIZE_HH) {
10757 hv = (HV*)POPPTR(ss,ix);
10758 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10762 longval = (long)POPLONG(ss,ix);
10763 TOPLONG(nss,ix) = longval;
10764 ptr = POPPTR(ss,ix);
10765 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10766 sv = (SV*)POPPTR(ss,ix);
10767 TOPPTR(nss,ix) = sv_dup(sv, param);
10770 ptr = POPPTR(ss,ix);
10771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10772 longval = (long)POPBOOL(ss,ix);
10773 TOPBOOL(nss,ix) = (bool)longval;
10775 case SAVEt_SET_SVFLAGS:
10777 TOPINT(nss,ix) = i;
10779 TOPINT(nss,ix) = i;
10780 sv = (SV*)POPPTR(ss,ix);
10781 TOPPTR(nss,ix) = sv_dup(sv, param);
10783 case SAVEt_RE_STATE:
10785 const struct re_save_state *const old_state
10786 = (struct re_save_state *)
10787 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10788 struct re_save_state *const new_state
10789 = (struct re_save_state *)
10790 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10792 Copy(old_state, new_state, 1, struct re_save_state);
10793 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10795 new_state->re_state_bostr
10796 = pv_dup(old_state->re_state_bostr);
10797 new_state->re_state_reginput
10798 = pv_dup(old_state->re_state_reginput);
10799 new_state->re_state_regeol
10800 = pv_dup(old_state->re_state_regeol);
10801 new_state->re_state_regoffs
10802 = (regexp_paren_pair*)
10803 any_dup(old_state->re_state_regoffs, proto_perl);
10804 new_state->re_state_reglastparen
10805 = (U32*) any_dup(old_state->re_state_reglastparen,
10807 new_state->re_state_reglastcloseparen
10808 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10810 /* XXX This just has to be broken. The old save_re_context
10811 code did SAVEGENERICPV(PL_reg_start_tmp);
10812 PL_reg_start_tmp is char **.
10813 Look above to what the dup code does for
10814 SAVEt_GENERIC_PVREF
10815 It can never have worked.
10816 So this is merely a faithful copy of the exiting bug: */
10817 new_state->re_state_reg_start_tmp
10818 = (char **) pv_dup((char *)
10819 old_state->re_state_reg_start_tmp);
10820 /* I assume that it only ever "worked" because no-one called
10821 (pseudo)fork while the regexp engine had re-entered itself.
10823 #ifdef PERL_OLD_COPY_ON_WRITE
10824 new_state->re_state_nrs
10825 = sv_dup(old_state->re_state_nrs, param);
10827 new_state->re_state_reg_magic
10828 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10830 new_state->re_state_reg_oldcurpm
10831 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10833 new_state->re_state_reg_curpm
10834 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10836 new_state->re_state_reg_oldsaved
10837 = pv_dup(old_state->re_state_reg_oldsaved);
10838 new_state->re_state_reg_poscache
10839 = pv_dup(old_state->re_state_reg_poscache);
10840 new_state->re_state_reg_starttry
10841 = pv_dup(old_state->re_state_reg_starttry);
10844 case SAVEt_COMPILE_WARNINGS:
10845 ptr = POPPTR(ss,ix);
10846 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10849 ptr = POPPTR(ss,ix);
10850 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10854 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10862 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10863 * flag to the result. This is done for each stash before cloning starts,
10864 * so we know which stashes want their objects cloned */
10867 do_mark_cloneable_stash(pTHX_ SV *sv)
10869 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10871 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10872 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10873 if (cloner && GvCV(cloner)) {
10880 XPUSHs(sv_2mortal(newSVhek(hvname)));
10882 call_sv((SV*)GvCV(cloner), G_SCALAR);
10889 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10897 =for apidoc perl_clone
10899 Create and return a new interpreter by cloning the current one.
10901 perl_clone takes these flags as parameters:
10903 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10904 without it we only clone the data and zero the stacks,
10905 with it we copy the stacks and the new perl interpreter is
10906 ready to run at the exact same point as the previous one.
10907 The pseudo-fork code uses COPY_STACKS while the
10908 threads->create doesn't.
10910 CLONEf_KEEP_PTR_TABLE
10911 perl_clone keeps a ptr_table with the pointer of the old
10912 variable as a key and the new variable as a value,
10913 this allows it to check if something has been cloned and not
10914 clone it again but rather just use the value and increase the
10915 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10916 the ptr_table using the function
10917 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10918 reason to keep it around is if you want to dup some of your own
10919 variable who are outside the graph perl scans, example of this
10920 code is in threads.xs create
10923 This is a win32 thing, it is ignored on unix, it tells perls
10924 win32host code (which is c++) to clone itself, this is needed on
10925 win32 if you want to run two threads at the same time,
10926 if you just want to do some stuff in a separate perl interpreter
10927 and then throw it away and return to the original one,
10928 you don't need to do anything.
10933 /* XXX the above needs expanding by someone who actually understands it ! */
10934 EXTERN_C PerlInterpreter *
10935 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10938 perl_clone(PerlInterpreter *proto_perl, UV flags)
10941 #ifdef PERL_IMPLICIT_SYS
10943 /* perlhost.h so we need to call into it
10944 to clone the host, CPerlHost should have a c interface, sky */
10946 if (flags & CLONEf_CLONE_HOST) {
10947 return perl_clone_host(proto_perl,flags);
10949 return perl_clone_using(proto_perl, flags,
10951 proto_perl->IMemShared,
10952 proto_perl->IMemParse,
10954 proto_perl->IStdIO,
10958 proto_perl->IProc);
10962 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10963 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10964 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10965 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10966 struct IPerlDir* ipD, struct IPerlSock* ipS,
10967 struct IPerlProc* ipP)
10969 /* XXX many of the string copies here can be optimized if they're
10970 * constants; they need to be allocated as common memory and just
10971 * their pointers copied. */
10974 CLONE_PARAMS clone_params;
10975 CLONE_PARAMS* const param = &clone_params;
10977 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10978 /* for each stash, determine whether its objects should be cloned */
10979 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10980 PERL_SET_THX(my_perl);
10983 PoisonNew(my_perl, 1, PerlInterpreter);
10989 PL_savestack_ix = 0;
10990 PL_savestack_max = -1;
10991 PL_sig_pending = 0;
10993 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10994 # else /* !DEBUGGING */
10995 Zero(my_perl, 1, PerlInterpreter);
10996 # endif /* DEBUGGING */
10998 /* host pointers */
11000 PL_MemShared = ipMS;
11001 PL_MemParse = ipMP;
11008 #else /* !PERL_IMPLICIT_SYS */
11010 CLONE_PARAMS clone_params;
11011 CLONE_PARAMS* param = &clone_params;
11012 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(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 */
11032 #endif /* PERL_IMPLICIT_SYS */
11033 param->flags = flags;
11034 param->proto_perl = proto_perl;
11036 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11038 PL_body_arenas = NULL;
11039 Zero(&PL_body_roots, 1, PL_body_roots);
11041 PL_nice_chunk = NULL;
11042 PL_nice_chunk_size = 0;
11044 PL_sv_objcount = 0;
11046 PL_sv_arenaroot = NULL;
11048 PL_debug = proto_perl->Idebug;
11050 PL_hash_seed = proto_perl->Ihash_seed;
11051 PL_rehash_seed = proto_perl->Irehash_seed;
11053 #ifdef USE_REENTRANT_API
11054 /* XXX: things like -Dm will segfault here in perlio, but doing
11055 * PERL_SET_CONTEXT(proto_perl);
11056 * breaks too many other things
11058 Perl_reentrant_init(aTHX);
11061 /* create SV map for pointer relocation */
11062 PL_ptr_table = ptr_table_new();
11064 /* initialize these special pointers as early as possible */
11065 SvANY(&PL_sv_undef) = NULL;
11066 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11067 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11068 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11070 SvANY(&PL_sv_no) = new_XPVNV();
11071 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11072 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11073 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11074 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11075 SvCUR_set(&PL_sv_no, 0);
11076 SvLEN_set(&PL_sv_no, 1);
11077 SvIV_set(&PL_sv_no, 0);
11078 SvNV_set(&PL_sv_no, 0);
11079 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11081 SvANY(&PL_sv_yes) = new_XPVNV();
11082 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11083 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11084 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11085 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11086 SvCUR_set(&PL_sv_yes, 1);
11087 SvLEN_set(&PL_sv_yes, 2);
11088 SvIV_set(&PL_sv_yes, 1);
11089 SvNV_set(&PL_sv_yes, 1);
11090 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11092 /* create (a non-shared!) shared string table */
11093 PL_strtab = newHV();
11094 HvSHAREKEYS_off(PL_strtab);
11095 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11096 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11098 PL_compiling = proto_perl->Icompiling;
11100 /* These two PVs will be free'd special way so must set them same way op.c does */
11101 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11102 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11104 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11105 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11107 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11108 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11109 if (PL_compiling.cop_hints_hash) {
11111 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11112 HINTS_REFCNT_UNLOCK;
11114 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11115 #ifdef PERL_DEBUG_READONLY_OPS
11120 /* pseudo environmental stuff */
11121 PL_origargc = proto_perl->Iorigargc;
11122 PL_origargv = proto_perl->Iorigargv;
11124 param->stashes = newAV(); /* Setup array of objects to call clone on */
11126 /* Set tainting stuff before PerlIO_debug can possibly get called */
11127 PL_tainting = proto_perl->Itainting;
11128 PL_taint_warn = proto_perl->Itaint_warn;
11130 #ifdef PERLIO_LAYERS
11131 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11132 PerlIO_clone(aTHX_ proto_perl, param);
11135 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11136 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11137 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11138 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11139 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11140 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11143 PL_minus_c = proto_perl->Iminus_c;
11144 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11145 PL_localpatches = proto_perl->Ilocalpatches;
11146 PL_splitstr = proto_perl->Isplitstr;
11147 PL_preprocess = proto_perl->Ipreprocess;
11148 PL_minus_n = proto_perl->Iminus_n;
11149 PL_minus_p = proto_perl->Iminus_p;
11150 PL_minus_l = proto_perl->Iminus_l;
11151 PL_minus_a = proto_perl->Iminus_a;
11152 PL_minus_E = proto_perl->Iminus_E;
11153 PL_minus_F = proto_perl->Iminus_F;
11154 PL_doswitches = proto_perl->Idoswitches;
11155 PL_dowarn = proto_perl->Idowarn;
11156 PL_doextract = proto_perl->Idoextract;
11157 PL_sawampersand = proto_perl->Isawampersand;
11158 PL_unsafe = proto_perl->Iunsafe;
11159 PL_inplace = SAVEPV(proto_perl->Iinplace);
11160 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11161 PL_perldb = proto_perl->Iperldb;
11162 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11163 PL_exit_flags = proto_perl->Iexit_flags;
11165 /* magical thingies */
11166 /* XXX time(&PL_basetime) when asked for? */
11167 PL_basetime = proto_perl->Ibasetime;
11168 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11170 PL_maxsysfd = proto_perl->Imaxsysfd;
11171 PL_statusvalue = proto_perl->Istatusvalue;
11173 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11175 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11177 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11179 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11180 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11181 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11184 /* RE engine related */
11185 Zero(&PL_reg_state, 1, struct re_save_state);
11186 PL_reginterp_cnt = 0;
11187 PL_regmatch_slab = NULL;
11189 /* Clone the regex array */
11190 PL_regex_padav = newAV();
11192 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11193 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11195 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11196 for(i = 1; i <= len; i++) {
11197 const SV * const regex = regexen[i];
11200 ? sv_dup_inc(regex, param)
11202 newSViv(PTR2IV(CALLREGDUPE(
11203 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11205 if (SvFLAGS(regex) & SVf_BREAK)
11206 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11207 av_push(PL_regex_padav, sv);
11210 PL_regex_pad = AvARRAY(PL_regex_padav);
11212 /* shortcuts to various I/O objects */
11213 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11214 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11215 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11216 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11217 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11218 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11220 /* shortcuts to regexp stuff */
11221 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11223 /* shortcuts to misc objects */
11224 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11226 /* shortcuts to debugging objects */
11227 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11228 PL_DBline = gv_dup(proto_perl->IDBline, param);
11229 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11230 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11231 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11232 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11233 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11235 /* symbol tables */
11236 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11237 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11238 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11239 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11240 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11242 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11243 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11244 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11245 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11246 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11247 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11248 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11249 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11251 PL_sub_generation = proto_perl->Isub_generation;
11252 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11254 /* funky return mechanisms */
11255 PL_forkprocess = proto_perl->Iforkprocess;
11257 /* subprocess state */
11258 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11260 /* internal state */
11261 PL_maxo = proto_perl->Imaxo;
11262 if (proto_perl->Iop_mask)
11263 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11266 /* PL_asserting = proto_perl->Iasserting; */
11268 /* current interpreter roots */
11269 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11271 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11273 PL_main_start = proto_perl->Imain_start;
11274 PL_eval_root = proto_perl->Ieval_root;
11275 PL_eval_start = proto_perl->Ieval_start;
11277 /* runtime control stuff */
11278 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11280 PL_filemode = proto_perl->Ifilemode;
11281 PL_lastfd = proto_perl->Ilastfd;
11282 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11285 PL_gensym = proto_perl->Igensym;
11286 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11287 PL_laststatval = proto_perl->Ilaststatval;
11288 PL_laststype = proto_perl->Ilaststype;
11291 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11293 /* interpreter atexit processing */
11294 PL_exitlistlen = proto_perl->Iexitlistlen;
11295 if (PL_exitlistlen) {
11296 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11297 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11300 PL_exitlist = (PerlExitListEntry*)NULL;
11302 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11303 if (PL_my_cxt_size) {
11304 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11305 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11306 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11307 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11308 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11312 PL_my_cxt_list = (void**)NULL;
11313 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11314 PL_my_cxt_keys = (const char**)NULL;
11317 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11318 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11319 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11321 PL_profiledata = NULL;
11323 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11325 PAD_CLONE_VARS(proto_perl, param);
11327 #ifdef HAVE_INTERP_INTERN
11328 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11331 /* more statics moved here */
11332 PL_generation = proto_perl->Igeneration;
11333 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11335 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11336 PL_in_clean_all = proto_perl->Iin_clean_all;
11338 PL_uid = proto_perl->Iuid;
11339 PL_euid = proto_perl->Ieuid;
11340 PL_gid = proto_perl->Igid;
11341 PL_egid = proto_perl->Iegid;
11342 PL_nomemok = proto_perl->Inomemok;
11343 PL_an = proto_perl->Ian;
11344 PL_evalseq = proto_perl->Ievalseq;
11345 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11346 PL_origalen = proto_perl->Iorigalen;
11347 #ifdef PERL_USES_PL_PIDSTATUS
11348 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11350 PL_osname = SAVEPV(proto_perl->Iosname);
11351 PL_sighandlerp = proto_perl->Isighandlerp;
11353 PL_runops = proto_perl->Irunops;
11355 PL_parser = parser_dup(proto_perl->Iparser, param);
11357 PL_subline = proto_perl->Isubline;
11358 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11361 PL_cryptseen = proto_perl->Icryptseen;
11364 PL_hints = proto_perl->Ihints;
11366 PL_amagic_generation = proto_perl->Iamagic_generation;
11368 #ifdef USE_LOCALE_COLLATE
11369 PL_collation_ix = proto_perl->Icollation_ix;
11370 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11371 PL_collation_standard = proto_perl->Icollation_standard;
11372 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11373 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11374 #endif /* USE_LOCALE_COLLATE */
11376 #ifdef USE_LOCALE_NUMERIC
11377 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11378 PL_numeric_standard = proto_perl->Inumeric_standard;
11379 PL_numeric_local = proto_perl->Inumeric_local;
11380 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11381 #endif /* !USE_LOCALE_NUMERIC */
11383 /* utf8 character classes */
11384 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11385 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11386 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11387 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11388 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11389 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11390 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11391 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11392 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11393 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11394 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11395 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11396 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11397 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11398 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11399 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11400 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11401 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11402 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11403 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11405 /* Did the locale setup indicate UTF-8? */
11406 PL_utf8locale = proto_perl->Iutf8locale;
11407 /* Unicode features (see perlrun/-C) */
11408 PL_unicode = proto_perl->Iunicode;
11410 /* Pre-5.8 signals control */
11411 PL_signals = proto_perl->Isignals;
11413 /* times() ticks per second */
11414 PL_clocktick = proto_perl->Iclocktick;
11416 /* Recursion stopper for PerlIO_find_layer */
11417 PL_in_load_module = proto_perl->Iin_load_module;
11419 /* sort() routine */
11420 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11422 /* Not really needed/useful since the reenrant_retint is "volatile",
11423 * but do it for consistency's sake. */
11424 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11426 /* Hooks to shared SVs and locks. */
11427 PL_sharehook = proto_perl->Isharehook;
11428 PL_lockhook = proto_perl->Ilockhook;
11429 PL_unlockhook = proto_perl->Iunlockhook;
11430 PL_threadhook = proto_perl->Ithreadhook;
11431 PL_destroyhook = proto_perl->Idestroyhook;
11433 #ifdef THREADS_HAVE_PIDS
11434 PL_ppid = proto_perl->Ippid;
11438 PL_last_swash_hv = NULL; /* reinits on demand */
11439 PL_last_swash_klen = 0;
11440 PL_last_swash_key[0]= '\0';
11441 PL_last_swash_tmps = (U8*)NULL;
11442 PL_last_swash_slen = 0;
11444 PL_glob_index = proto_perl->Iglob_index;
11445 PL_srand_called = proto_perl->Isrand_called;
11446 PL_bitcount = NULL; /* reinits on demand */
11448 if (proto_perl->Ipsig_pend) {
11449 Newxz(PL_psig_pend, SIG_SIZE, int);
11452 PL_psig_pend = (int*)NULL;
11455 if (proto_perl->Ipsig_ptr) {
11456 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11457 Newxz(PL_psig_name, SIG_SIZE, SV*);
11458 for (i = 1; i < SIG_SIZE; i++) {
11459 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11460 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11464 PL_psig_ptr = (SV**)NULL;
11465 PL_psig_name = (SV**)NULL;
11468 /* intrpvar.h stuff */
11470 if (flags & CLONEf_COPY_STACKS) {
11471 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11472 PL_tmps_ix = proto_perl->Itmps_ix;
11473 PL_tmps_max = proto_perl->Itmps_max;
11474 PL_tmps_floor = proto_perl->Itmps_floor;
11475 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11477 while (i <= PL_tmps_ix) {
11478 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11482 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11483 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11484 Newxz(PL_markstack, i, I32);
11485 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11486 - proto_perl->Imarkstack);
11487 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11488 - proto_perl->Imarkstack);
11489 Copy(proto_perl->Imarkstack, PL_markstack,
11490 PL_markstack_ptr - PL_markstack + 1, I32);
11492 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11493 * NOTE: unlike the others! */
11494 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11495 PL_scopestack_max = proto_perl->Iscopestack_max;
11496 Newxz(PL_scopestack, PL_scopestack_max, I32);
11497 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11499 /* NOTE: si_dup() looks at PL_markstack */
11500 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11502 /* PL_curstack = PL_curstackinfo->si_stack; */
11503 PL_curstack = av_dup(proto_perl->Icurstack, param);
11504 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11506 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11507 PL_stack_base = AvARRAY(PL_curstack);
11508 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11509 - proto_perl->Istack_base);
11510 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11512 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11513 * NOTE: unlike the others! */
11514 PL_savestack_ix = proto_perl->Isavestack_ix;
11515 PL_savestack_max = proto_perl->Isavestack_max;
11516 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11517 PL_savestack = ss_dup(proto_perl, param);
11521 ENTER; /* perl_destruct() wants to LEAVE; */
11523 /* although we're not duplicating the tmps stack, we should still
11524 * add entries for any SVs on the tmps stack that got cloned by a
11525 * non-refcount means (eg a temp in @_); otherwise they will be
11528 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11529 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11530 proto_perl->Itmps_stack[i]);
11531 if (nsv && !SvREFCNT(nsv)) {
11533 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11538 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11539 PL_top_env = &PL_start_env;
11541 PL_op = proto_perl->Iop;
11544 PL_Xpv = (XPV*)NULL;
11545 my_perl->Ina = proto_perl->Ina;
11547 PL_statbuf = proto_perl->Istatbuf;
11548 PL_statcache = proto_perl->Istatcache;
11549 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11550 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11552 PL_timesbuf = proto_perl->Itimesbuf;
11555 PL_tainted = proto_perl->Itainted;
11556 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11557 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11558 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11559 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11560 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11561 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11562 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11563 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11564 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11566 PL_restartop = proto_perl->Irestartop;
11567 PL_in_eval = proto_perl->Iin_eval;
11568 PL_delaymagic = proto_perl->Idelaymagic;
11569 PL_dirty = proto_perl->Idirty;
11570 PL_localizing = proto_perl->Ilocalizing;
11572 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11573 PL_hv_fetch_ent_mh = NULL;
11574 PL_modcount = proto_perl->Imodcount;
11575 PL_lastgotoprobe = NULL;
11576 PL_dumpindent = proto_perl->Idumpindent;
11578 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11579 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11580 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11581 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11582 PL_efloatbuf = NULL; /* reinits on demand */
11583 PL_efloatsize = 0; /* reinits on demand */
11587 PL_screamfirst = NULL;
11588 PL_screamnext = NULL;
11589 PL_maxscream = -1; /* reinits on demand */
11590 PL_lastscream = NULL;
11593 PL_regdummy = proto_perl->Iregdummy;
11594 PL_colorset = 0; /* reinits PL_colors[] */
11595 /*PL_colors[6] = {0,0,0,0,0,0};*/
11599 /* Pluggable optimizer */
11600 PL_peepp = proto_perl->Ipeepp;
11602 PL_stashcache = newHV();
11604 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11605 proto_perl->Iwatchaddr);
11606 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11607 if (PL_debug && PL_watchaddr) {
11608 PerlIO_printf(Perl_debug_log,
11609 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11610 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11611 PTR2UV(PL_watchok));
11614 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11615 ptr_table_free(PL_ptr_table);
11616 PL_ptr_table = NULL;
11619 /* Call the ->CLONE method, if it exists, for each of the stashes
11620 identified by sv_dup() above.
11622 while(av_len(param->stashes) != -1) {
11623 HV* const stash = (HV*) av_shift(param->stashes);
11624 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11625 if (cloner && GvCV(cloner)) {
11630 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11632 call_sv((SV*)GvCV(cloner), G_DISCARD);
11638 SvREFCNT_dec(param->stashes);
11640 /* orphaned? eg threads->new inside BEGIN or use */
11641 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11642 SvREFCNT_inc_simple_void(PL_compcv);
11643 SAVEFREESV(PL_compcv);
11649 #endif /* USE_ITHREADS */
11652 =head1 Unicode Support
11654 =for apidoc sv_recode_to_utf8
11656 The encoding is assumed to be an Encode object, on entry the PV
11657 of the sv is assumed to be octets in that encoding, and the sv
11658 will be converted into Unicode (and UTF-8).
11660 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11661 is not a reference, nothing is done to the sv. If the encoding is not
11662 an C<Encode::XS> Encoding object, bad things will happen.
11663 (See F<lib/encoding.pm> and L<Encode>).
11665 The PV of the sv is returned.
11670 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11673 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11687 Passing sv_yes is wrong - it needs to be or'ed set of constants
11688 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11689 remove converted chars from source.
11691 Both will default the value - let them.
11693 XPUSHs(&PL_sv_yes);
11696 call_method("decode", G_SCALAR);
11700 s = SvPV_const(uni, len);
11701 if (s != SvPVX_const(sv)) {
11702 SvGROW(sv, len + 1);
11703 Move(s, SvPVX(sv), len + 1, char);
11704 SvCUR_set(sv, len);
11711 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11715 =for apidoc sv_cat_decode
11717 The encoding is assumed to be an Encode object, the PV of the ssv is
11718 assumed to be octets in that encoding and decoding the input starts
11719 from the position which (PV + *offset) pointed to. The dsv will be
11720 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11721 when the string tstr appears in decoding output or the input ends on
11722 the PV of the ssv. The value which the offset points will be modified
11723 to the last input position on the ssv.
11725 Returns TRUE if the terminator was found, else returns FALSE.
11730 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11731 SV *ssv, int *offset, char *tstr, int tlen)
11735 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11746 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11747 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11749 call_method("cat_decode", G_SCALAR);
11751 ret = SvTRUE(TOPs);
11752 *offset = SvIV(offsv);
11758 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11763 /* ---------------------------------------------------------------------
11765 * support functions for report_uninit()
11768 /* the maxiumum size of array or hash where we will scan looking
11769 * for the undefined element that triggered the warning */
11771 #define FUV_MAX_SEARCH_SIZE 1000
11773 /* Look for an entry in the hash whose value has the same SV as val;
11774 * If so, return a mortal copy of the key. */
11777 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11780 register HE **array;
11783 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11784 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11787 array = HvARRAY(hv);
11789 for (i=HvMAX(hv); i>0; i--) {
11790 register HE *entry;
11791 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11792 if (HeVAL(entry) != val)
11794 if ( HeVAL(entry) == &PL_sv_undef ||
11795 HeVAL(entry) == &PL_sv_placeholder)
11799 if (HeKLEN(entry) == HEf_SVKEY)
11800 return sv_mortalcopy(HeKEY_sv(entry));
11801 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11807 /* Look for an entry in the array whose value has the same SV as val;
11808 * If so, return the index, otherwise return -1. */
11811 S_find_array_subscript(pTHX_ AV *av, SV* val)
11814 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11815 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11818 if (val != &PL_sv_undef) {
11819 SV ** const svp = AvARRAY(av);
11822 for (i=AvFILLp(av); i>=0; i--)
11829 /* S_varname(): return the name of a variable, optionally with a subscript.
11830 * If gv is non-zero, use the name of that global, along with gvtype (one
11831 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11832 * targ. Depending on the value of the subscript_type flag, return:
11835 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11836 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11837 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11838 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11841 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11842 SV* keyname, I32 aindex, int subscript_type)
11845 SV * const name = sv_newmortal();
11848 buffer[0] = gvtype;
11851 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11853 gv_fullname4(name, gv, buffer, 0);
11855 if ((unsigned int)SvPVX(name)[1] <= 26) {
11857 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11859 /* Swap the 1 unprintable control character for the 2 byte pretty
11860 version - ie substr($name, 1, 1) = $buffer; */
11861 sv_insert(name, 1, 1, buffer, 2);
11865 CV * const cv = find_runcv(NULL);
11869 if (!cv || !CvPADLIST(cv))
11871 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11872 sv = *av_fetch(av, targ, FALSE);
11873 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11876 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11877 SV * const sv = newSV(0);
11878 *SvPVX(name) = '$';
11879 Perl_sv_catpvf(aTHX_ name, "{%s}",
11880 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11883 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11884 *SvPVX(name) = '$';
11885 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11887 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11888 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11895 =for apidoc find_uninit_var
11897 Find the name of the undefined variable (if any) that caused the operator o
11898 to issue a "Use of uninitialized value" warning.
11899 If match is true, only return a name if it's value matches uninit_sv.
11900 So roughly speaking, if a unary operator (such as OP_COS) generates a
11901 warning, then following the direct child of the op may yield an
11902 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11903 other hand, with OP_ADD there are two branches to follow, so we only print
11904 the variable name if we get an exact match.
11906 The name is returned as a mortal SV.
11908 Assumes that PL_op is the op that originally triggered the error, and that
11909 PL_comppad/PL_curpad points to the currently executing pad.
11915 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11923 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11924 uninit_sv == &PL_sv_placeholder)))
11927 switch (obase->op_type) {
11934 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11935 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11938 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11940 if (pad) { /* @lex, %lex */
11941 sv = PAD_SVl(obase->op_targ);
11945 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11946 /* @global, %global */
11947 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11950 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11952 else /* @{expr}, %{expr} */
11953 return find_uninit_var(cUNOPx(obase)->op_first,
11957 /* attempt to find a match within the aggregate */
11959 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11961 subscript_type = FUV_SUBSCRIPT_HASH;
11964 index = find_array_subscript((AV*)sv, uninit_sv);
11966 subscript_type = FUV_SUBSCRIPT_ARRAY;
11969 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11972 return varname(gv, hash ? '%' : '@', obase->op_targ,
11973 keysv, index, subscript_type);
11977 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11979 return varname(NULL, '$', obase->op_targ,
11980 NULL, 0, FUV_SUBSCRIPT_NONE);
11983 gv = cGVOPx_gv(obase);
11984 if (!gv || (match && GvSV(gv) != uninit_sv))
11986 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11989 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11992 av = (AV*)PAD_SV(obase->op_targ);
11993 if (!av || SvRMAGICAL(av))
11995 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11996 if (!svp || *svp != uninit_sv)
11999 return varname(NULL, '$', obase->op_targ,
12000 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12003 gv = cGVOPx_gv(obase);
12009 if (!av || SvRMAGICAL(av))
12011 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12012 if (!svp || *svp != uninit_sv)
12015 return varname(gv, '$', 0,
12016 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12021 o = cUNOPx(obase)->op_first;
12022 if (!o || o->op_type != OP_NULL ||
12023 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12025 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12029 if (PL_op == obase)
12030 /* $a[uninit_expr] or $h{uninit_expr} */
12031 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12034 o = cBINOPx(obase)->op_first;
12035 kid = cBINOPx(obase)->op_last;
12037 /* get the av or hv, and optionally the gv */
12039 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12040 sv = PAD_SV(o->op_targ);
12042 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12043 && cUNOPo->op_first->op_type == OP_GV)
12045 gv = cGVOPx_gv(cUNOPo->op_first);
12048 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12053 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12054 /* index is constant */
12058 if (obase->op_type == OP_HELEM) {
12059 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12060 if (!he || HeVAL(he) != uninit_sv)
12064 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12065 if (!svp || *svp != uninit_sv)
12069 if (obase->op_type == OP_HELEM)
12070 return varname(gv, '%', o->op_targ,
12071 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12073 return varname(gv, '@', o->op_targ, NULL,
12074 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12077 /* index is an expression;
12078 * attempt to find a match within the aggregate */
12079 if (obase->op_type == OP_HELEM) {
12080 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12082 return varname(gv, '%', o->op_targ,
12083 keysv, 0, FUV_SUBSCRIPT_HASH);
12086 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12088 return varname(gv, '@', o->op_targ,
12089 NULL, index, FUV_SUBSCRIPT_ARRAY);
12094 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12096 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12101 /* only examine RHS */
12102 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12105 o = cUNOPx(obase)->op_first;
12106 if (o->op_type == OP_PUSHMARK)
12109 if (!o->op_sibling) {
12110 /* one-arg version of open is highly magical */
12112 if (o->op_type == OP_GV) { /* open FOO; */
12114 if (match && GvSV(gv) != uninit_sv)
12116 return varname(gv, '$', 0,
12117 NULL, 0, FUV_SUBSCRIPT_NONE);
12119 /* other possibilities not handled are:
12120 * open $x; or open my $x; should return '${*$x}'
12121 * open expr; should return '$'.expr ideally
12127 /* ops where $_ may be an implicit arg */
12131 if ( !(obase->op_flags & OPf_STACKED)) {
12132 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12133 ? PAD_SVl(obase->op_targ)
12136 sv = sv_newmortal();
12137 sv_setpvn(sv, "$_", 2);
12146 /* skip filehandle as it can't produce 'undef' warning */
12147 o = cUNOPx(obase)->op_first;
12148 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12149 o = o->op_sibling->op_sibling;
12155 match = 1; /* XS or custom code could trigger random warnings */
12160 /* XXX tmp hack: these two may call an XS sub, and currently
12161 XS subs don't have a SUB entry on the context stack, so CV and
12162 pad determination goes wrong, and BAD things happen. So, just
12163 don't try to determine the value under those circumstances.
12164 Need a better fix at dome point. DAPM 11/2007 */
12168 /* def-ness of rval pos() is independent of the def-ness of its arg */
12169 if ( !(obase->op_flags & OPf_MOD))
12174 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12175 return sv_2mortal(newSVpvs("${$/}"));
12180 if (!(obase->op_flags & OPf_KIDS))
12182 o = cUNOPx(obase)->op_first;
12188 /* if all except one arg are constant, or have no side-effects,
12189 * or are optimized away, then it's unambiguous */
12191 for (kid=o; kid; kid = kid->op_sibling) {
12193 const OPCODE type = kid->op_type;
12194 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12195 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12196 || (type == OP_PUSHMARK)
12200 if (o2) { /* more than one found */
12207 return find_uninit_var(o2, uninit_sv, match);
12209 /* scan all args */
12211 sv = find_uninit_var(o, uninit_sv, 1);
12223 =for apidoc report_uninit
12225 Print appropriate "Use of uninitialized variable" warning
12231 Perl_report_uninit(pTHX_ SV* uninit_sv)
12235 SV* varname = NULL;
12237 varname = find_uninit_var(PL_op, uninit_sv,0);
12239 sv_insert(varname, 0, 0, " ", 1);
12241 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12242 varname ? SvPV_nolen_const(varname) : "",
12243 " in ", OP_DESC(PL_op));
12246 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12252 * c-indentation-style: bsd
12253 * c-basic-offset: 4
12254 * indent-tabs-mode: t
12257 * ex: set ts=8 sts=4 sw=4 noet:
projects / p5sagit/p5-mst-13.2.git / blob