3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* RVs are in the head now. */
898 { 0, 0, 0, SVt_RV, FALSE, NONV, NOARENA, 0 },
900 /* 8 bytes on most ILP32 with IEEE doubles */
901 { sizeof(xpv_allocated),
902 copy_length(XPV, xpv_len)
903 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
904 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
905 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
908 { sizeof(xpviv_allocated),
909 copy_length(XPVIV, xiv_u)
910 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
911 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
912 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
915 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
916 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
919 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
920 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
923 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
924 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
927 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
930 { sizeof(xpvav_allocated),
931 copy_length(XPVAV, xmg_stash)
932 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
933 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
934 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
936 { sizeof(xpvhv_allocated),
937 copy_length(XPVHV, xmg_stash)
938 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
939 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
940 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
943 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
944 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
945 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
947 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
948 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
949 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
951 /* XPVIO is 84 bytes, fits 48x */
952 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
953 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
956 #define new_body_type(sv_type) \
957 (void *)((char *)S_new_body(aTHX_ sv_type))
959 #define del_body_type(p, sv_type) \
960 del_body(p, &PL_body_roots[sv_type])
963 #define new_body_allocated(sv_type) \
964 (void *)((char *)S_new_body(aTHX_ sv_type) \
965 - bodies_by_type[sv_type].offset)
967 #define del_body_allocated(p, sv_type) \
968 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
971 #define my_safemalloc(s) (void*)safemalloc(s)
972 #define my_safecalloc(s) (void*)safecalloc(s, 1)
973 #define my_safefree(p) safefree((char*)p)
977 #define new_XNV() my_safemalloc(sizeof(XPVNV))
978 #define del_XNV(p) my_safefree(p)
980 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
981 #define del_XPVNV(p) my_safefree(p)
983 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
984 #define del_XPVAV(p) my_safefree(p)
986 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
987 #define del_XPVHV(p) my_safefree(p)
989 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
990 #define del_XPVMG(p) my_safefree(p)
992 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
993 #define del_XPVGV(p) my_safefree(p)
997 #define new_XNV() new_body_type(SVt_NV)
998 #define del_XNV(p) del_body_type(p, SVt_NV)
1000 #define new_XPVNV() new_body_type(SVt_PVNV)
1001 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1003 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1004 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1006 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1007 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1009 #define new_XPVMG() new_body_type(SVt_PVMG)
1010 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1012 #define new_XPVGV() new_body_type(SVt_PVGV)
1013 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1017 /* no arena for you! */
1019 #define new_NOARENA(details) \
1020 my_safemalloc((details)->body_size + (details)->offset)
1021 #define new_NOARENAZ(details) \
1022 my_safecalloc((details)->body_size + (details)->offset)
1025 S_more_bodies (pTHX_ svtype sv_type)
1028 void ** const root = &PL_body_roots[sv_type];
1029 const struct body_details * const bdp = &bodies_by_type[sv_type];
1030 const size_t body_size = bdp->body_size;
1033 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1034 static bool done_sanity_check;
1036 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1037 * variables like done_sanity_check. */
1038 if (!done_sanity_check) {
1039 unsigned int i = SVt_LAST;
1041 done_sanity_check = TRUE;
1044 assert (bodies_by_type[i].type == i);
1048 assert(bdp->arena_size);
1050 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1052 end = start + bdp->arena_size - body_size;
1054 /* computed count doesnt reflect the 1st slot reservation */
1055 DEBUG_m(PerlIO_printf(Perl_debug_log,
1056 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1057 (void*)start, (void*)end,
1058 (int)bdp->arena_size, sv_type, (int)body_size,
1059 (int)bdp->arena_size / (int)body_size));
1061 *root = (void *)start;
1063 while (start < end) {
1064 char * const next = start + body_size;
1065 *(void**) start = (void *)next;
1068 *(void **)start = 0;
1073 /* grab a new thing from the free list, allocating more if necessary.
1074 The inline version is used for speed in hot routines, and the
1075 function using it serves the rest (unless PURIFY).
1077 #define new_body_inline(xpv, sv_type) \
1079 void ** const r3wt = &PL_body_roots[sv_type]; \
1080 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1081 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1082 *(r3wt) = *(void**)(xpv); \
1088 S_new_body(pTHX_ svtype sv_type)
1092 new_body_inline(xpv, sv_type);
1099 =for apidoc sv_upgrade
1101 Upgrade an SV to a more complex form. Generally adds a new body type to the
1102 SV, then copies across as much information as possible from the old body.
1103 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1109 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1114 const svtype old_type = SvTYPE(sv);
1115 const struct body_details *new_type_details;
1116 const struct body_details *const old_type_details
1117 = bodies_by_type + old_type;
1119 if (new_type != SVt_PV && SvIsCOW(sv)) {
1120 sv_force_normal_flags(sv, 0);
1123 if (old_type == new_type)
1126 if (old_type > new_type)
1127 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1128 (int)old_type, (int)new_type);
1131 old_body = SvANY(sv);
1133 /* Copying structures onto other structures that have been neatly zeroed
1134 has a subtle gotcha. Consider XPVMG
1136 +------+------+------+------+------+-------+-------+
1137 | NV | CUR | LEN | IV | MAGIC | STASH |
1138 +------+------+------+------+------+-------+-------+
1139 0 4 8 12 16 20 24 28
1141 where NVs are aligned to 8 bytes, so that sizeof that structure is
1142 actually 32 bytes long, with 4 bytes of padding at the end:
1144 +------+------+------+------+------+-------+-------+------+
1145 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1146 +------+------+------+------+------+-------+-------+------+
1147 0 4 8 12 16 20 24 28 32
1149 so what happens if you allocate memory for this structure:
1151 +------+------+------+------+------+-------+-------+------+------+...
1152 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1153 +------+------+------+------+------+-------+-------+------+------+...
1154 0 4 8 12 16 20 24 28 32 36
1156 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1157 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1158 started out as zero once, but it's quite possible that it isn't. So now,
1159 rather than a nicely zeroed GP, you have it pointing somewhere random.
1162 (In fact, GP ends up pointing at a previous GP structure, because the
1163 principle cause of the padding in XPVMG getting garbage is a copy of
1164 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1165 this happens to be moot because XPVGV has been re-ordered, with GP
1166 no longer after STASH)
1168 So we are careful and work out the size of used parts of all the
1175 if (new_type < SVt_PVIV) {
1176 new_type = (new_type == SVt_NV)
1177 ? SVt_PVNV : SVt_PVIV;
1181 if (new_type < SVt_PVNV) {
1182 new_type = SVt_PVNV;
1188 assert(new_type > SVt_PV);
1189 assert(SVt_IV < SVt_PV);
1190 assert(SVt_NV < SVt_PV);
1197 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1198 there's no way that it can be safely upgraded, because perl.c
1199 expects to Safefree(SvANY(PL_mess_sv)) */
1200 assert(sv != PL_mess_sv);
1201 /* This flag bit is used to mean other things in other scalar types.
1202 Given that it only has meaning inside the pad, it shouldn't be set
1203 on anything that can get upgraded. */
1204 assert(!SvPAD_TYPED(sv));
1207 if (old_type_details->cant_upgrade)
1208 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1209 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1211 new_type_details = bodies_by_type + new_type;
1213 SvFLAGS(sv) &= ~SVTYPEMASK;
1214 SvFLAGS(sv) |= new_type;
1216 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1217 the return statements above will have triggered. */
1218 assert (new_type != SVt_NULL);
1221 assert(old_type == SVt_NULL);
1222 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1226 assert(old_type == SVt_NULL);
1227 SvANY(sv) = new_XNV();
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = &sv->sv_u.svu_rv;
1237 assert(new_type_details->body_size);
1240 assert(new_type_details->arena);
1241 assert(new_type_details->arena_size);
1242 /* This points to the start of the allocated area. */
1243 new_body_inline(new_body, new_type);
1244 Zero(new_body, new_type_details->body_size, char);
1245 new_body = ((char *)new_body) - new_type_details->offset;
1247 /* We always allocated the full length item with PURIFY. To do this
1248 we fake things so that arena is false for all 16 types.. */
1249 new_body = new_NOARENAZ(new_type_details);
1251 SvANY(sv) = new_body;
1252 if (new_type == SVt_PVAV) {
1256 if (old_type >= SVt_RV) {
1259 /* It will have been zeroed when the new body was allocated.
1260 Lets not write to it, in case it confuses a write-back
1265 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1266 The target created by newSVrv also is, and it can have magic.
1267 However, it never has SvPVX set.
1269 if (old_type >= SVt_RV) {
1270 assert(SvPVX_const(sv) == 0);
1273 if (old_type >= SVt_PVMG) {
1274 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1275 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1277 sv->sv_u.svu_array = NULL; /* or svu_hash */
1283 /* XXX Is this still needed? Was it ever needed? Surely as there is
1284 no route from NV to PVIV, NOK can never be true */
1285 assert(!SvNOKp(sv));
1296 assert(new_type_details->body_size);
1297 /* We always allocated the full length item with PURIFY. To do this
1298 we fake things so that arena is false for all 16 types.. */
1299 if(new_type_details->arena) {
1300 /* This points to the start of the allocated area. */
1301 new_body_inline(new_body, new_type);
1302 Zero(new_body, new_type_details->body_size, char);
1303 new_body = ((char *)new_body) - new_type_details->offset;
1305 new_body = new_NOARENAZ(new_type_details);
1307 SvANY(sv) = new_body;
1309 if (old_type_details->copy) {
1310 /* There is now the potential for an upgrade from something without
1311 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1312 int offset = old_type_details->offset;
1313 int length = old_type_details->copy;
1315 if (new_type_details->offset > old_type_details->offset) {
1316 const int difference
1317 = new_type_details->offset - old_type_details->offset;
1318 offset += difference;
1319 length -= difference;
1321 assert (length >= 0);
1323 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1327 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1328 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1329 * correct 0.0 for us. Otherwise, if the old body didn't have an
1330 * NV slot, but the new one does, then we need to initialise the
1331 * freshly created NV slot with whatever the correct bit pattern is
1333 if (old_type_details->zero_nv && !new_type_details->zero_nv
1334 && !isGV_with_GP(sv))
1338 if (new_type == SVt_PVIO)
1339 IoPAGE_LEN(sv) = 60;
1340 if (old_type < SVt_RV)
1344 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1345 (unsigned long)new_type);
1348 if (old_type_details->arena) {
1349 /* If there was an old body, then we need to free it.
1350 Note that there is an assumption that all bodies of types that
1351 can be upgraded came from arenas. Only the more complex non-
1352 upgradable types are allowed to be directly malloc()ed. */
1354 my_safefree(old_body);
1356 del_body((void*)((char*)old_body + old_type_details->offset),
1357 &PL_body_roots[old_type]);
1363 =for apidoc sv_backoff
1365 Remove any string offset. You should normally use the C<SvOOK_off> macro
1372 Perl_sv_backoff(pTHX_ register SV *sv)
1374 PERL_UNUSED_CONTEXT;
1376 assert(SvTYPE(sv) != SVt_PVHV);
1377 assert(SvTYPE(sv) != SVt_PVAV);
1379 const char * const s = SvPVX_const(sv);
1380 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1381 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1383 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1385 SvFLAGS(sv) &= ~SVf_OOK;
1392 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1393 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1394 Use the C<SvGROW> wrapper instead.
1400 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1404 if (PL_madskills && newlen >= 0x100000) {
1405 PerlIO_printf(Perl_debug_log,
1406 "Allocation too large: %"UVxf"\n", (UV)newlen);
1408 #ifdef HAS_64K_LIMIT
1409 if (newlen >= 0x10000) {
1410 PerlIO_printf(Perl_debug_log,
1411 "Allocation too large: %"UVxf"\n", (UV)newlen);
1414 #endif /* HAS_64K_LIMIT */
1417 if (SvTYPE(sv) < SVt_PV) {
1418 sv_upgrade(sv, SVt_PV);
1419 s = SvPVX_mutable(sv);
1421 else if (SvOOK(sv)) { /* pv is offset? */
1423 s = SvPVX_mutable(sv);
1424 if (newlen > SvLEN(sv))
1425 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1426 #ifdef HAS_64K_LIMIT
1427 if (newlen >= 0x10000)
1432 s = SvPVX_mutable(sv);
1434 if (newlen > SvLEN(sv)) { /* need more room? */
1435 newlen = PERL_STRLEN_ROUNDUP(newlen);
1436 if (SvLEN(sv) && s) {
1438 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1444 s = (char*)saferealloc(s, newlen);
1447 s = (char*)safemalloc(newlen);
1448 if (SvPVX_const(sv) && SvCUR(sv)) {
1449 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1453 SvLEN_set(sv, newlen);
1459 =for apidoc sv_setiv
1461 Copies an integer into the given SV, upgrading first if necessary.
1462 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1468 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1471 SV_CHECK_THINKFIRST_COW_DROP(sv);
1472 switch (SvTYPE(sv)) {
1474 sv_upgrade(sv, SVt_IV);
1477 sv_upgrade(sv, SVt_PVNV);
1481 sv_upgrade(sv, SVt_PVIV);
1490 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1494 (void)SvIOK_only(sv); /* validate number */
1500 =for apidoc sv_setiv_mg
1502 Like C<sv_setiv>, but also handles 'set' magic.
1508 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1515 =for apidoc sv_setuv
1517 Copies an unsigned integer into the given SV, upgrading first if necessary.
1518 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1524 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1526 /* With these two if statements:
1527 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1530 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1532 If you wish to remove them, please benchmark to see what the effect is
1534 if (u <= (UV)IV_MAX) {
1535 sv_setiv(sv, (IV)u);
1544 =for apidoc sv_setuv_mg
1546 Like C<sv_setuv>, but also handles 'set' magic.
1552 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1559 =for apidoc sv_setnv
1561 Copies a double into the given SV, upgrading first if necessary.
1562 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1568 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1571 SV_CHECK_THINKFIRST_COW_DROP(sv);
1572 switch (SvTYPE(sv)) {
1575 sv_upgrade(sv, SVt_NV);
1580 sv_upgrade(sv, SVt_PVNV);
1589 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1594 (void)SvNOK_only(sv); /* validate number */
1599 =for apidoc sv_setnv_mg
1601 Like C<sv_setnv>, but also handles 'set' magic.
1607 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1613 /* Print an "isn't numeric" warning, using a cleaned-up,
1614 * printable version of the offending string
1618 S_not_a_number(pTHX_ SV *sv)
1626 dsv = sv_2mortal(newSVpvs(""));
1627 pv = sv_uni_display(dsv, sv, 10, 0);
1630 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1631 /* each *s can expand to 4 chars + "...\0",
1632 i.e. need room for 8 chars */
1634 const char *s = SvPVX_const(sv);
1635 const char * const end = s + SvCUR(sv);
1636 for ( ; s < end && d < limit; s++ ) {
1638 if (ch & 128 && !isPRINT_LC(ch)) {
1647 else if (ch == '\r') {
1651 else if (ch == '\f') {
1655 else if (ch == '\\') {
1659 else if (ch == '\0') {
1663 else if (isPRINT_LC(ch))
1680 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1681 "Argument \"%s\" isn't numeric in %s", pv,
1684 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1685 "Argument \"%s\" isn't numeric", pv);
1689 =for apidoc looks_like_number
1691 Test if the content of an SV looks like a number (or is a number).
1692 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1693 non-numeric warning), even if your atof() doesn't grok them.
1699 Perl_looks_like_number(pTHX_ SV *sv)
1701 register const char *sbegin;
1705 sbegin = SvPVX_const(sv);
1708 else if (SvPOKp(sv))
1709 sbegin = SvPV_const(sv, len);
1711 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1712 return grok_number(sbegin, len, NULL);
1716 S_glob_2number(pTHX_ GV * const gv)
1718 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1719 SV *const buffer = sv_newmortal();
1721 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1724 gv_efullname3(buffer, gv, "*");
1725 SvFLAGS(gv) |= wasfake;
1727 /* We know that all GVs stringify to something that is not-a-number,
1728 so no need to test that. */
1729 if (ckWARN(WARN_NUMERIC))
1730 not_a_number(buffer);
1731 /* We just want something true to return, so that S_sv_2iuv_common
1732 can tail call us and return true. */
1737 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1739 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1740 SV *const buffer = sv_newmortal();
1742 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1745 gv_efullname3(buffer, gv, "*");
1746 SvFLAGS(gv) |= wasfake;
1748 assert(SvPOK(buffer));
1750 *len = SvCUR(buffer);
1752 return SvPVX(buffer);
1755 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1756 until proven guilty, assume that things are not that bad... */
1761 As 64 bit platforms often have an NV that doesn't preserve all bits of
1762 an IV (an assumption perl has been based on to date) it becomes necessary
1763 to remove the assumption that the NV always carries enough precision to
1764 recreate the IV whenever needed, and that the NV is the canonical form.
1765 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1766 precision as a side effect of conversion (which would lead to insanity
1767 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1768 1) to distinguish between IV/UV/NV slots that have cached a valid
1769 conversion where precision was lost and IV/UV/NV slots that have a
1770 valid conversion which has lost no precision
1771 2) to ensure that if a numeric conversion to one form is requested that
1772 would lose precision, the precise conversion (or differently
1773 imprecise conversion) is also performed and cached, to prevent
1774 requests for different numeric formats on the same SV causing
1775 lossy conversion chains. (lossless conversion chains are perfectly
1780 SvIOKp is true if the IV slot contains a valid value
1781 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1782 SvNOKp is true if the NV slot contains a valid value
1783 SvNOK is true only if the NV value is accurate
1786 while converting from PV to NV, check to see if converting that NV to an
1787 IV(or UV) would lose accuracy over a direct conversion from PV to
1788 IV(or UV). If it would, cache both conversions, return NV, but mark
1789 SV as IOK NOKp (ie not NOK).
1791 While converting from PV to IV, check to see if converting that IV to an
1792 NV would lose accuracy over a direct conversion from PV to NV. If it
1793 would, cache both conversions, flag similarly.
1795 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1796 correctly because if IV & NV were set NV *always* overruled.
1797 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1798 changes - now IV and NV together means that the two are interchangeable:
1799 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1801 The benefit of this is that operations such as pp_add know that if
1802 SvIOK is true for both left and right operands, then integer addition
1803 can be used instead of floating point (for cases where the result won't
1804 overflow). Before, floating point was always used, which could lead to
1805 loss of precision compared with integer addition.
1807 * making IV and NV equal status should make maths accurate on 64 bit
1809 * may speed up maths somewhat if pp_add and friends start to use
1810 integers when possible instead of fp. (Hopefully the overhead in
1811 looking for SvIOK and checking for overflow will not outweigh the
1812 fp to integer speedup)
1813 * will slow down integer operations (callers of SvIV) on "inaccurate"
1814 values, as the change from SvIOK to SvIOKp will cause a call into
1815 sv_2iv each time rather than a macro access direct to the IV slot
1816 * should speed up number->string conversion on integers as IV is
1817 favoured when IV and NV are equally accurate
1819 ####################################################################
1820 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1821 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1822 On the other hand, SvUOK is true iff UV.
1823 ####################################################################
1825 Your mileage will vary depending your CPU's relative fp to integer
1829 #ifndef NV_PRESERVES_UV
1830 # define IS_NUMBER_UNDERFLOW_IV 1
1831 # define IS_NUMBER_UNDERFLOW_UV 2
1832 # define IS_NUMBER_IV_AND_UV 2
1833 # define IS_NUMBER_OVERFLOW_IV 4
1834 # define IS_NUMBER_OVERFLOW_UV 5
1836 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1838 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1840 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1843 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1844 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));
1845 if (SvNVX(sv) < (NV)IV_MIN) {
1846 (void)SvIOKp_on(sv);
1848 SvIV_set(sv, IV_MIN);
1849 return IS_NUMBER_UNDERFLOW_IV;
1851 if (SvNVX(sv) > (NV)UV_MAX) {
1852 (void)SvIOKp_on(sv);
1855 SvUV_set(sv, UV_MAX);
1856 return IS_NUMBER_OVERFLOW_UV;
1858 (void)SvIOKp_on(sv);
1860 /* Can't use strtol etc to convert this string. (See truth table in
1862 if (SvNVX(sv) <= (UV)IV_MAX) {
1863 SvIV_set(sv, I_V(SvNVX(sv)));
1864 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1865 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1867 /* Integer is imprecise. NOK, IOKp */
1869 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1872 SvUV_set(sv, U_V(SvNVX(sv)));
1873 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1874 if (SvUVX(sv) == UV_MAX) {
1875 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1876 possibly be preserved by NV. Hence, it must be overflow.
1878 return IS_NUMBER_OVERFLOW_UV;
1880 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1882 /* Integer is imprecise. NOK, IOKp */
1884 return IS_NUMBER_OVERFLOW_IV;
1886 #endif /* !NV_PRESERVES_UV*/
1889 S_sv_2iuv_common(pTHX_ SV *sv) {
1892 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1893 * without also getting a cached IV/UV from it at the same time
1894 * (ie PV->NV conversion should detect loss of accuracy and cache
1895 * IV or UV at same time to avoid this. */
1896 /* IV-over-UV optimisation - choose to cache IV if possible */
1898 if (SvTYPE(sv) == SVt_NV)
1899 sv_upgrade(sv, SVt_PVNV);
1901 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1902 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1903 certainly cast into the IV range at IV_MAX, whereas the correct
1904 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1906 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1907 if (Perl_isnan(SvNVX(sv))) {
1913 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1914 SvIV_set(sv, I_V(SvNVX(sv)));
1915 if (SvNVX(sv) == (NV) SvIVX(sv)
1916 #ifndef NV_PRESERVES_UV
1917 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1918 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1919 /* Don't flag it as "accurately an integer" if the number
1920 came from a (by definition imprecise) NV operation, and
1921 we're outside the range of NV integer precision */
1924 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1925 DEBUG_c(PerlIO_printf(Perl_debug_log,
1926 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1932 /* IV not precise. No need to convert from PV, as NV
1933 conversion would already have cached IV if it detected
1934 that PV->IV would be better than PV->NV->IV
1935 flags already correct - don't set public IOK. */
1936 DEBUG_c(PerlIO_printf(Perl_debug_log,
1937 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1942 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1943 but the cast (NV)IV_MIN rounds to a the value less (more
1944 negative) than IV_MIN which happens to be equal to SvNVX ??
1945 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1946 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1947 (NV)UVX == NVX are both true, but the values differ. :-(
1948 Hopefully for 2s complement IV_MIN is something like
1949 0x8000000000000000 which will be exact. NWC */
1952 SvUV_set(sv, U_V(SvNVX(sv)));
1954 (SvNVX(sv) == (NV) SvUVX(sv))
1955 #ifndef NV_PRESERVES_UV
1956 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1957 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1958 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1959 /* Don't flag it as "accurately an integer" if the number
1960 came from a (by definition imprecise) NV operation, and
1961 we're outside the range of NV integer precision */
1966 DEBUG_c(PerlIO_printf(Perl_debug_log,
1967 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1973 else if (SvPOKp(sv) && SvLEN(sv)) {
1975 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1976 /* We want to avoid a possible problem when we cache an IV/ a UV which
1977 may be later translated to an NV, and the resulting NV is not
1978 the same as the direct translation of the initial string
1979 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
1980 be careful to ensure that the value with the .456 is around if the
1981 NV value is requested in the future).
1983 This means that if we cache such an IV/a UV, we need to cache the
1984 NV as well. Moreover, we trade speed for space, and do not
1985 cache the NV if we are sure it's not needed.
1988 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
1989 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
1990 == IS_NUMBER_IN_UV) {
1991 /* It's definitely an integer, only upgrade to PVIV */
1992 if (SvTYPE(sv) < SVt_PVIV)
1993 sv_upgrade(sv, SVt_PVIV);
1995 } else if (SvTYPE(sv) < SVt_PVNV)
1996 sv_upgrade(sv, SVt_PVNV);
1998 /* If NVs preserve UVs then we only use the UV value if we know that
1999 we aren't going to call atof() below. If NVs don't preserve UVs
2000 then the value returned may have more precision than atof() will
2001 return, even though value isn't perfectly accurate. */
2002 if ((numtype & (IS_NUMBER_IN_UV
2003 #ifdef NV_PRESERVES_UV
2006 )) == IS_NUMBER_IN_UV) {
2007 /* This won't turn off the public IOK flag if it was set above */
2008 (void)SvIOKp_on(sv);
2010 if (!(numtype & IS_NUMBER_NEG)) {
2012 if (value <= (UV)IV_MAX) {
2013 SvIV_set(sv, (IV)value);
2015 /* it didn't overflow, and it was positive. */
2016 SvUV_set(sv, value);
2020 /* 2s complement assumption */
2021 if (value <= (UV)IV_MIN) {
2022 SvIV_set(sv, -(IV)value);
2024 /* Too negative for an IV. This is a double upgrade, but
2025 I'm assuming it will be rare. */
2026 if (SvTYPE(sv) < SVt_PVNV)
2027 sv_upgrade(sv, SVt_PVNV);
2031 SvNV_set(sv, -(NV)value);
2032 SvIV_set(sv, IV_MIN);
2036 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2037 will be in the previous block to set the IV slot, and the next
2038 block to set the NV slot. So no else here. */
2040 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2041 != IS_NUMBER_IN_UV) {
2042 /* It wasn't an (integer that doesn't overflow the UV). */
2043 SvNV_set(sv, Atof(SvPVX_const(sv)));
2045 if (! numtype && ckWARN(WARN_NUMERIC))
2048 #if defined(USE_LONG_DOUBLE)
2049 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2050 PTR2UV(sv), SvNVX(sv)));
2052 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2053 PTR2UV(sv), SvNVX(sv)));
2056 #ifdef NV_PRESERVES_UV
2057 (void)SvIOKp_on(sv);
2059 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2060 SvIV_set(sv, I_V(SvNVX(sv)));
2061 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2064 NOOP; /* Integer is imprecise. NOK, IOKp */
2066 /* UV will not work better than IV */
2068 if (SvNVX(sv) > (NV)UV_MAX) {
2070 /* Integer is inaccurate. NOK, IOKp, is UV */
2071 SvUV_set(sv, UV_MAX);
2073 SvUV_set(sv, U_V(SvNVX(sv)));
2074 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2075 NV preservse UV so can do correct comparison. */
2076 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2079 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2084 #else /* NV_PRESERVES_UV */
2085 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2086 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2087 /* The IV/UV slot will have been set from value returned by
2088 grok_number above. The NV slot has just been set using
2091 assert (SvIOKp(sv));
2093 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2094 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2095 /* Small enough to preserve all bits. */
2096 (void)SvIOKp_on(sv);
2098 SvIV_set(sv, I_V(SvNVX(sv)));
2099 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2101 /* Assumption: first non-preserved integer is < IV_MAX,
2102 this NV is in the preserved range, therefore: */
2103 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2105 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);
2109 0 0 already failed to read UV.
2110 0 1 already failed to read UV.
2111 1 0 you won't get here in this case. IV/UV
2112 slot set, public IOK, Atof() unneeded.
2113 1 1 already read UV.
2114 so there's no point in sv_2iuv_non_preserve() attempting
2115 to use atol, strtol, strtoul etc. */
2116 sv_2iuv_non_preserve (sv, numtype);
2119 #endif /* NV_PRESERVES_UV */
2123 if (isGV_with_GP(sv))
2124 return glob_2number((GV *)sv);
2126 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2127 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2130 if (SvTYPE(sv) < SVt_IV)
2131 /* Typically the caller expects that sv_any is not NULL now. */
2132 sv_upgrade(sv, SVt_IV);
2133 /* Return 0 from the caller. */
2140 =for apidoc sv_2iv_flags
2142 Return the integer value of an SV, doing any necessary string
2143 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2144 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2150 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2155 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2156 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2157 cache IVs just in case. In practice it seems that they never
2158 actually anywhere accessible by user Perl code, let alone get used
2159 in anything other than a string context. */
2160 if (flags & SV_GMAGIC)
2165 return I_V(SvNVX(sv));
2167 if (SvPOKp(sv) && SvLEN(sv)) {
2170 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2172 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2173 == IS_NUMBER_IN_UV) {
2174 /* It's definitely an integer */
2175 if (numtype & IS_NUMBER_NEG) {
2176 if (value < (UV)IV_MIN)
2179 if (value < (UV)IV_MAX)
2184 if (ckWARN(WARN_NUMERIC))
2187 return I_V(Atof(SvPVX_const(sv)));
2192 assert(SvTYPE(sv) >= SVt_PVMG);
2193 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2194 } else if (SvTHINKFIRST(sv)) {
2198 SV * const tmpstr=AMG_CALLun(sv,numer);
2199 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2200 return SvIV(tmpstr);
2203 return PTR2IV(SvRV(sv));
2206 sv_force_normal_flags(sv, 0);
2208 if (SvREADONLY(sv) && !SvOK(sv)) {
2209 if (ckWARN(WARN_UNINITIALIZED))
2215 if (S_sv_2iuv_common(aTHX_ sv))
2218 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2219 PTR2UV(sv),SvIVX(sv)));
2220 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2224 =for apidoc sv_2uv_flags
2226 Return the unsigned integer value of an SV, doing any necessary string
2227 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2228 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2234 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2239 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2240 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2241 cache IVs just in case. */
2242 if (flags & SV_GMAGIC)
2247 return U_V(SvNVX(sv));
2248 if (SvPOKp(sv) && SvLEN(sv)) {
2251 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2253 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2254 == IS_NUMBER_IN_UV) {
2255 /* It's definitely an integer */
2256 if (!(numtype & IS_NUMBER_NEG))
2260 if (ckWARN(WARN_NUMERIC))
2263 return U_V(Atof(SvPVX_const(sv)));
2268 assert(SvTYPE(sv) >= SVt_PVMG);
2269 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2270 } else if (SvTHINKFIRST(sv)) {
2274 SV *const tmpstr = AMG_CALLun(sv,numer);
2275 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2276 return SvUV(tmpstr);
2279 return PTR2UV(SvRV(sv));
2282 sv_force_normal_flags(sv, 0);
2284 if (SvREADONLY(sv) && !SvOK(sv)) {
2285 if (ckWARN(WARN_UNINITIALIZED))
2291 if (S_sv_2iuv_common(aTHX_ sv))
2295 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2296 PTR2UV(sv),SvUVX(sv)));
2297 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2303 Return the num value of an SV, doing any necessary string or integer
2304 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2311 Perl_sv_2nv(pTHX_ register SV *sv)
2316 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2317 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2318 cache IVs just in case. */
2322 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2323 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2324 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2326 return Atof(SvPVX_const(sv));
2330 return (NV)SvUVX(sv);
2332 return (NV)SvIVX(sv);
2337 assert(SvTYPE(sv) >= SVt_PVMG);
2338 /* This falls through to the report_uninit near the end of the
2340 } else if (SvTHINKFIRST(sv)) {
2344 SV *const tmpstr = AMG_CALLun(sv,numer);
2345 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2346 return SvNV(tmpstr);
2349 return PTR2NV(SvRV(sv));
2352 sv_force_normal_flags(sv, 0);
2354 if (SvREADONLY(sv) && !SvOK(sv)) {
2355 if (ckWARN(WARN_UNINITIALIZED))
2360 if (SvTYPE(sv) < SVt_NV) {
2361 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2362 sv_upgrade(sv, SVt_NV);
2363 #ifdef USE_LONG_DOUBLE
2365 STORE_NUMERIC_LOCAL_SET_STANDARD();
2366 PerlIO_printf(Perl_debug_log,
2367 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2368 PTR2UV(sv), SvNVX(sv));
2369 RESTORE_NUMERIC_LOCAL();
2373 STORE_NUMERIC_LOCAL_SET_STANDARD();
2374 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2375 PTR2UV(sv), SvNVX(sv));
2376 RESTORE_NUMERIC_LOCAL();
2380 else if (SvTYPE(sv) < SVt_PVNV)
2381 sv_upgrade(sv, SVt_PVNV);
2386 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2387 #ifdef NV_PRESERVES_UV
2390 /* Only set the public NV OK flag if this NV preserves the IV */
2391 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2392 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2393 : (SvIVX(sv) == I_V(SvNVX(sv))))
2399 else if (SvPOKp(sv) && SvLEN(sv)) {
2401 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2402 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2404 #ifdef NV_PRESERVES_UV
2405 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2406 == IS_NUMBER_IN_UV) {
2407 /* It's definitely an integer */
2408 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2410 SvNV_set(sv, Atof(SvPVX_const(sv)));
2413 SvNV_set(sv, Atof(SvPVX_const(sv)));
2414 /* Only set the public NV OK flag if this NV preserves the value in
2415 the PV at least as well as an IV/UV would.
2416 Not sure how to do this 100% reliably. */
2417 /* if that shift count is out of range then Configure's test is
2418 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2420 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2421 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2422 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2423 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2424 /* Can't use strtol etc to convert this string, so don't try.
2425 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2428 /* value has been set. It may not be precise. */
2429 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2430 /* 2s complement assumption for (UV)IV_MIN */
2431 SvNOK_on(sv); /* Integer is too negative. */
2436 if (numtype & IS_NUMBER_NEG) {
2437 SvIV_set(sv, -(IV)value);
2438 } else if (value <= (UV)IV_MAX) {
2439 SvIV_set(sv, (IV)value);
2441 SvUV_set(sv, value);
2445 if (numtype & IS_NUMBER_NOT_INT) {
2446 /* I believe that even if the original PV had decimals,
2447 they are lost beyond the limit of the FP precision.
2448 However, neither is canonical, so both only get p
2449 flags. NWC, 2000/11/25 */
2450 /* Both already have p flags, so do nothing */
2452 const NV nv = SvNVX(sv);
2453 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2454 if (SvIVX(sv) == I_V(nv)) {
2457 /* It had no "." so it must be integer. */
2461 /* between IV_MAX and NV(UV_MAX).
2462 Could be slightly > UV_MAX */
2464 if (numtype & IS_NUMBER_NOT_INT) {
2465 /* UV and NV both imprecise. */
2467 const UV nv_as_uv = U_V(nv);
2469 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2478 #endif /* NV_PRESERVES_UV */
2481 if (isGV_with_GP(sv)) {
2482 glob_2number((GV *)sv);
2486 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2488 assert (SvTYPE(sv) >= SVt_NV);
2489 /* Typically the caller expects that sv_any is not NULL now. */
2490 /* XXX Ilya implies that this is a bug in callers that assume this
2491 and ideally should be fixed. */
2494 #if defined(USE_LONG_DOUBLE)
2496 STORE_NUMERIC_LOCAL_SET_STANDARD();
2497 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2498 PTR2UV(sv), SvNVX(sv));
2499 RESTORE_NUMERIC_LOCAL();
2503 STORE_NUMERIC_LOCAL_SET_STANDARD();
2504 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2505 PTR2UV(sv), SvNVX(sv));
2506 RESTORE_NUMERIC_LOCAL();
2515 Return an SV with the numeric value of the source SV, doing any necessary
2516 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2517 access this function.
2523 Perl_sv_2num(pTHX_ register SV *sv)
2528 SV * const tmpsv = AMG_CALLun(sv,numer);
2529 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2530 return sv_2num(tmpsv);
2532 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2535 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2536 * UV as a string towards the end of buf, and return pointers to start and
2539 * We assume that buf is at least TYPE_CHARS(UV) long.
2543 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2545 char *ptr = buf + TYPE_CHARS(UV);
2546 char * const ebuf = ptr;
2559 *--ptr = '0' + (char)(uv % 10);
2568 =for apidoc sv_2pv_flags
2570 Returns a pointer to the string value of an SV, and sets *lp to its length.
2571 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2573 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2574 usually end up here too.
2580 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2590 if (SvGMAGICAL(sv)) {
2591 if (flags & SV_GMAGIC)
2596 if (flags & SV_MUTABLE_RETURN)
2597 return SvPVX_mutable(sv);
2598 if (flags & SV_CONST_RETURN)
2599 return (char *)SvPVX_const(sv);
2602 if (SvIOKp(sv) || SvNOKp(sv)) {
2603 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2608 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2609 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2611 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2618 #ifdef FIXNEGATIVEZERO
2619 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2625 SvUPGRADE(sv, SVt_PV);
2628 s = SvGROW_mutable(sv, len + 1);
2631 return (char*)memcpy(s, tbuf, len + 1);
2637 assert(SvTYPE(sv) >= SVt_PVMG);
2638 /* This falls through to the report_uninit near the end of the
2640 } else if (SvTHINKFIRST(sv)) {
2644 SV *const tmpstr = AMG_CALLun(sv,string);
2645 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2647 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2651 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2652 if (flags & SV_CONST_RETURN) {
2653 pv = (char *) SvPVX_const(tmpstr);
2655 pv = (flags & SV_MUTABLE_RETURN)
2656 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2659 *lp = SvCUR(tmpstr);
2661 pv = sv_2pv_flags(tmpstr, lp, flags);
2675 const SV *const referent = (SV*)SvRV(sv);
2679 retval = buffer = savepvn("NULLREF", len);
2680 } else if (SvTYPE(referent) == SVt_PVMG
2681 && ((SvFLAGS(referent) &
2682 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2683 == (SVs_OBJECT|SVs_SMG))
2684 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2689 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2694 PL_reginterp_cnt += haseval;
2697 const char *const typestr = sv_reftype(referent, 0);
2698 const STRLEN typelen = strlen(typestr);
2699 UV addr = PTR2UV(referent);
2700 const char *stashname = NULL;
2701 STRLEN stashnamelen = 0; /* hush, gcc */
2702 const char *buffer_end;
2704 if (SvOBJECT(referent)) {
2705 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2708 stashname = HEK_KEY(name);
2709 stashnamelen = HEK_LEN(name);
2711 if (HEK_UTF8(name)) {
2717 stashname = "__ANON__";
2720 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2721 + 2 * sizeof(UV) + 2 /* )\0 */;
2723 len = typelen + 3 /* (0x */
2724 + 2 * sizeof(UV) + 2 /* )\0 */;
2727 Newx(buffer, len, char);
2728 buffer_end = retval = buffer + len;
2730 /* Working backwards */
2734 *--retval = PL_hexdigit[addr & 15];
2735 } while (addr >>= 4);
2741 memcpy(retval, typestr, typelen);
2745 retval -= stashnamelen;
2746 memcpy(retval, stashname, stashnamelen);
2748 /* retval may not neccesarily have reached the start of the
2750 assert (retval >= buffer);
2752 len = buffer_end - retval - 1; /* -1 for that \0 */
2760 if (SvREADONLY(sv) && !SvOK(sv)) {
2761 if (ckWARN(WARN_UNINITIALIZED))
2768 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2769 /* I'm assuming that if both IV and NV are equally valid then
2770 converting the IV is going to be more efficient */
2771 const U32 isUIOK = SvIsUV(sv);
2772 char buf[TYPE_CHARS(UV)];
2776 if (SvTYPE(sv) < SVt_PVIV)
2777 sv_upgrade(sv, SVt_PVIV);
2778 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2780 /* inlined from sv_setpvn */
2781 s = SvGROW_mutable(sv, len + 1);
2782 Move(ptr, s, len, char);
2786 else if (SvNOKp(sv)) {
2787 const int olderrno = errno;
2788 if (SvTYPE(sv) < SVt_PVNV)
2789 sv_upgrade(sv, SVt_PVNV);
2790 /* The +20 is pure guesswork. Configure test needed. --jhi */
2791 s = SvGROW_mutable(sv, NV_DIG + 20);
2792 /* some Xenix systems wipe out errno here */
2794 if (SvNVX(sv) == 0.0)
2795 my_strlcpy(s, "0", SvLEN(sv));
2799 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2802 #ifdef FIXNEGATIVEZERO
2803 if (*s == '-' && s[1] == '0' && !s[2]) {
2815 if (isGV_with_GP(sv))
2816 return glob_2pv((GV *)sv, lp);
2818 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2822 if (SvTYPE(sv) < SVt_PV)
2823 /* Typically the caller expects that sv_any is not NULL now. */
2824 sv_upgrade(sv, SVt_PV);
2828 const STRLEN len = s - SvPVX_const(sv);
2834 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2835 PTR2UV(sv),SvPVX_const(sv)));
2836 if (flags & SV_CONST_RETURN)
2837 return (char *)SvPVX_const(sv);
2838 if (flags & SV_MUTABLE_RETURN)
2839 return SvPVX_mutable(sv);
2844 =for apidoc sv_copypv
2846 Copies a stringified representation of the source SV into the
2847 destination SV. Automatically performs any necessary mg_get and
2848 coercion of numeric values into strings. Guaranteed to preserve
2849 UTF8 flag even from overloaded objects. Similar in nature to
2850 sv_2pv[_flags] but operates directly on an SV instead of just the
2851 string. Mostly uses sv_2pv_flags to do its work, except when that
2852 would lose the UTF-8'ness of the PV.
2858 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2861 const char * const s = SvPV_const(ssv,len);
2862 sv_setpvn(dsv,s,len);
2870 =for apidoc sv_2pvbyte
2872 Return a pointer to the byte-encoded representation of the SV, and set *lp
2873 to its length. May cause the SV to be downgraded from UTF-8 as a
2876 Usually accessed via the C<SvPVbyte> macro.
2882 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2884 sv_utf8_downgrade(sv,0);
2885 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2889 =for apidoc sv_2pvutf8
2891 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2892 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2894 Usually accessed via the C<SvPVutf8> macro.
2900 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2902 sv_utf8_upgrade(sv);
2903 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2908 =for apidoc sv_2bool
2910 This function is only called on magical items, and is only used by
2911 sv_true() or its macro equivalent.
2917 Perl_sv_2bool(pTHX_ register SV *sv)
2926 SV * const tmpsv = AMG_CALLun(sv,bool_);
2927 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2928 return (bool)SvTRUE(tmpsv);
2930 return SvRV(sv) != 0;
2933 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2935 (*sv->sv_u.svu_pv > '0' ||
2936 Xpvtmp->xpv_cur > 1 ||
2937 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2944 return SvIVX(sv) != 0;
2947 return SvNVX(sv) != 0.0;
2949 if (isGV_with_GP(sv))
2959 =for apidoc sv_utf8_upgrade
2961 Converts the PV of an SV to its UTF-8-encoded form.
2962 Forces the SV to string form if it is not already.
2963 Always sets the SvUTF8 flag to avoid future validity checks even
2964 if all the bytes have hibit clear.
2966 This is not as a general purpose byte encoding to Unicode interface:
2967 use the Encode extension for that.
2969 =for apidoc sv_utf8_upgrade_flags
2971 Converts the PV of an SV to its UTF-8-encoded form.
2972 Forces the SV to string form if it is not already.
2973 Always sets the SvUTF8 flag to avoid future validity checks even
2974 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2975 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2976 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2978 This is not as a general purpose byte encoding to Unicode interface:
2979 use the Encode extension for that.
2985 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
2988 if (sv == &PL_sv_undef)
2992 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
2993 (void) sv_2pv_flags(sv,&len, flags);
2997 (void) SvPV_force(sv,len);
3006 sv_force_normal_flags(sv, 0);
3009 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3010 sv_recode_to_utf8(sv, PL_encoding);
3011 else { /* Assume Latin-1/EBCDIC */
3012 /* This function could be much more efficient if we
3013 * had a FLAG in SVs to signal if there are any hibit
3014 * chars in the PV. Given that there isn't such a flag
3015 * make the loop as fast as possible. */
3016 const U8 * const s = (U8 *) SvPVX_const(sv);
3017 const U8 * const e = (U8 *) SvEND(sv);
3022 /* Check for hi bit */
3023 if (!NATIVE_IS_INVARIANT(ch)) {
3024 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3025 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3027 SvPV_free(sv); /* No longer using what was there before. */
3028 SvPV_set(sv, (char*)recoded);
3029 SvCUR_set(sv, len - 1);
3030 SvLEN_set(sv, len); /* No longer know the real size. */
3034 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3041 =for apidoc sv_utf8_downgrade
3043 Attempts to convert the PV of an SV from characters to bytes.
3044 If the PV contains a character beyond byte, this conversion will fail;
3045 in this case, either returns false or, if C<fail_ok> is not
3048 This is not as a general purpose Unicode to byte encoding interface:
3049 use the Encode extension for that.
3055 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3058 if (SvPOKp(sv) && SvUTF8(sv)) {
3064 sv_force_normal_flags(sv, 0);
3066 s = (U8 *) SvPV(sv, len);
3067 if (!utf8_to_bytes(s, &len)) {
3072 Perl_croak(aTHX_ "Wide character in %s",
3075 Perl_croak(aTHX_ "Wide character");
3086 =for apidoc sv_utf8_encode
3088 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3089 flag off so that it looks like octets again.
3095 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3098 sv_force_normal_flags(sv, 0);
3100 if (SvREADONLY(sv)) {
3101 Perl_croak(aTHX_ PL_no_modify);
3103 (void) sv_utf8_upgrade(sv);
3108 =for apidoc sv_utf8_decode
3110 If the PV of the SV is an octet sequence in UTF-8
3111 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3112 so that it looks like a character. If the PV contains only single-byte
3113 characters, the C<SvUTF8> flag stays being off.
3114 Scans PV for validity and returns false if the PV is invalid UTF-8.
3120 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3126 /* The octets may have got themselves encoded - get them back as
3129 if (!sv_utf8_downgrade(sv, TRUE))
3132 /* it is actually just a matter of turning the utf8 flag on, but
3133 * we want to make sure everything inside is valid utf8 first.
3135 c = (const U8 *) SvPVX_const(sv);
3136 if (!is_utf8_string(c, SvCUR(sv)+1))
3138 e = (const U8 *) SvEND(sv);
3141 if (!UTF8_IS_INVARIANT(ch)) {
3151 =for apidoc sv_setsv
3153 Copies the contents of the source SV C<ssv> into the destination SV
3154 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3155 function if the source SV needs to be reused. Does not handle 'set' magic.
3156 Loosely speaking, it performs a copy-by-value, obliterating any previous
3157 content of the destination.
3159 You probably want to use one of the assortment of wrappers, such as
3160 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3161 C<SvSetMagicSV_nosteal>.
3163 =for apidoc sv_setsv_flags
3165 Copies the contents of the source SV C<ssv> into the destination SV
3166 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3167 function if the source SV needs to be reused. Does not handle 'set' magic.
3168 Loosely speaking, it performs a copy-by-value, obliterating any previous
3169 content of the destination.
3170 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3171 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3172 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3173 and C<sv_setsv_nomg> are implemented in terms of this function.
3175 You probably want to use one of the assortment of wrappers, such as
3176 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3177 C<SvSetMagicSV_nosteal>.
3179 This is the primary function for copying scalars, and most other
3180 copy-ish functions and macros use this underneath.
3186 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3188 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3190 if (dtype != SVt_PVGV) {
3191 const char * const name = GvNAME(sstr);
3192 const STRLEN len = GvNAMELEN(sstr);
3194 if (dtype >= SVt_PV) {
3200 SvUPGRADE(dstr, SVt_PVGV);
3201 (void)SvOK_off(dstr);
3202 /* FIXME - why are we doing this, then turning it off and on again
3204 isGV_with_GP_on(dstr);
3206 GvSTASH(dstr) = GvSTASH(sstr);
3208 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3209 gv_name_set((GV *)dstr, name, len, GV_ADD);
3210 SvFAKE_on(dstr); /* can coerce to non-glob */
3213 #ifdef GV_UNIQUE_CHECK
3214 if (GvUNIQUE((GV*)dstr)) {
3215 Perl_croak(aTHX_ PL_no_modify);
3219 if(GvGP((GV*)sstr)) {
3220 /* If source has method cache entry, clear it */
3222 SvREFCNT_dec(GvCV(sstr));
3226 /* If source has a real method, then a method is
3228 else if(GvCV((GV*)sstr)) {
3233 /* If dest already had a real method, that's a change as well */
3234 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3238 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3242 isGV_with_GP_off(dstr);
3243 (void)SvOK_off(dstr);
3244 isGV_with_GP_on(dstr);
3245 GvINTRO_off(dstr); /* one-shot flag */
3246 GvGP(dstr) = gp_ref(GvGP(sstr));
3247 if (SvTAINTED(sstr))
3249 if (GvIMPORTED(dstr) != GVf_IMPORTED
3250 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3252 GvIMPORTED_on(dstr);
3255 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3256 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3261 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3262 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3264 const int intro = GvINTRO(dstr);
3267 const U32 stype = SvTYPE(sref);
3270 #ifdef GV_UNIQUE_CHECK
3271 if (GvUNIQUE((GV*)dstr)) {
3272 Perl_croak(aTHX_ PL_no_modify);
3277 GvINTRO_off(dstr); /* one-shot flag */
3278 GvLINE(dstr) = CopLINE(PL_curcop);
3279 GvEGV(dstr) = (GV*)dstr;
3284 location = (SV **) &GvCV(dstr);
3285 import_flag = GVf_IMPORTED_CV;
3288 location = (SV **) &GvHV(dstr);
3289 import_flag = GVf_IMPORTED_HV;
3292 location = (SV **) &GvAV(dstr);
3293 import_flag = GVf_IMPORTED_AV;
3296 location = (SV **) &GvIOp(dstr);
3299 location = (SV **) &GvFORM(dstr);
3301 location = &GvSV(dstr);
3302 import_flag = GVf_IMPORTED_SV;
3305 if (stype == SVt_PVCV) {
3306 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3307 if (GvCVGEN(dstr)) {
3308 SvREFCNT_dec(GvCV(dstr));
3310 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3313 SAVEGENERICSV(*location);
3317 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3318 CV* const cv = (CV*)*location;
3320 if (!GvCVGEN((GV*)dstr) &&
3321 (CvROOT(cv) || CvXSUB(cv)))
3323 /* Redefining a sub - warning is mandatory if
3324 it was a const and its value changed. */
3325 if (CvCONST(cv) && CvCONST((CV*)sref)
3326 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3328 /* They are 2 constant subroutines generated from
3329 the same constant. This probably means that
3330 they are really the "same" proxy subroutine
3331 instantiated in 2 places. Most likely this is
3332 when a constant is exported twice. Don't warn.
3335 else if (ckWARN(WARN_REDEFINE)
3337 && (!CvCONST((CV*)sref)
3338 || sv_cmp(cv_const_sv(cv),
3339 cv_const_sv((CV*)sref))))) {
3340 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3343 ? "Constant subroutine %s::%s redefined"
3344 : "Subroutine %s::%s redefined"),
3345 HvNAME_get(GvSTASH((GV*)dstr)),
3346 GvENAME((GV*)dstr));
3350 cv_ckproto_len(cv, (GV*)dstr,
3351 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3352 SvPOK(sref) ? SvCUR(sref) : 0);
3354 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3355 GvASSUMECV_on(dstr);
3356 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3359 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3360 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3361 GvFLAGS(dstr) |= import_flag;
3366 if (SvTAINTED(sstr))
3372 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3375 register U32 sflags;
3377 register svtype stype;
3382 if (SvIS_FREED(dstr)) {
3383 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3384 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3386 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3388 sstr = &PL_sv_undef;
3389 if (SvIS_FREED(sstr)) {
3390 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3391 (void*)sstr, (void*)dstr);
3393 stype = SvTYPE(sstr);
3394 dtype = SvTYPE(dstr);
3396 (void)SvAMAGIC_off(dstr);
3399 /* need to nuke the magic */
3401 SvRMAGICAL_off(dstr);
3404 /* There's a lot of redundancy below but we're going for speed here */
3409 if (dtype != SVt_PVGV) {
3410 (void)SvOK_off(dstr);
3418 sv_upgrade(dstr, SVt_IV);
3423 sv_upgrade(dstr, SVt_PVIV);
3426 goto end_of_first_switch;
3428 (void)SvIOK_only(dstr);
3429 SvIV_set(dstr, SvIVX(sstr));
3432 /* SvTAINTED can only be true if the SV has taint magic, which in
3433 turn means that the SV type is PVMG (or greater). This is the
3434 case statement for SVt_IV, so this cannot be true (whatever gcov
3436 assert(!SvTAINTED(sstr));
3446 sv_upgrade(dstr, SVt_NV);
3451 sv_upgrade(dstr, SVt_PVNV);
3454 goto end_of_first_switch;
3456 SvNV_set(dstr, SvNVX(sstr));
3457 (void)SvNOK_only(dstr);
3458 /* SvTAINTED can only be true if the SV has taint magic, which in
3459 turn means that the SV type is PVMG (or greater). This is the
3460 case statement for SVt_NV, so this cannot be true (whatever gcov
3462 assert(!SvTAINTED(sstr));
3469 sv_upgrade(dstr, SVt_RV);
3472 #ifdef PERL_OLD_COPY_ON_WRITE
3473 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3474 if (dtype < SVt_PVIV)
3475 sv_upgrade(dstr, SVt_PVIV);
3482 sv_upgrade(dstr, SVt_PV);
3485 if (dtype < SVt_PVIV)
3486 sv_upgrade(dstr, SVt_PVIV);
3489 if (dtype < SVt_PVNV)
3490 sv_upgrade(dstr, SVt_PVNV);
3494 const char * const type = sv_reftype(sstr,0);
3496 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3498 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3502 /* case SVt_BIND: */
3505 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3506 glob_assign_glob(dstr, sstr, dtype);
3509 /* SvVALID means that this PVGV is playing at being an FBM. */
3513 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3515 if (SvTYPE(sstr) != stype) {
3516 stype = SvTYPE(sstr);
3517 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3518 glob_assign_glob(dstr, sstr, dtype);
3523 if (stype == SVt_PVLV)
3524 SvUPGRADE(dstr, SVt_PVNV);
3526 SvUPGRADE(dstr, (svtype)stype);
3528 end_of_first_switch:
3530 /* dstr may have been upgraded. */
3531 dtype = SvTYPE(dstr);
3532 sflags = SvFLAGS(sstr);
3534 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3535 /* Assigning to a subroutine sets the prototype. */
3538 const char *const ptr = SvPV_const(sstr, len);
3540 SvGROW(dstr, len + 1);
3541 Copy(ptr, SvPVX(dstr), len + 1, char);
3542 SvCUR_set(dstr, len);
3544 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3548 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3549 const char * const type = sv_reftype(dstr,0);
3551 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3553 Perl_croak(aTHX_ "Cannot copy to %s", type);
3554 } else if (sflags & SVf_ROK) {
3555 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3556 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3559 if (GvIMPORTED(dstr) != GVf_IMPORTED
3560 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3562 GvIMPORTED_on(dstr);
3567 glob_assign_glob(dstr, sstr, dtype);
3571 if (dtype >= SVt_PV) {
3572 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3573 glob_assign_ref(dstr, sstr);
3576 if (SvPVX_const(dstr)) {
3582 (void)SvOK_off(dstr);
3583 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3584 SvFLAGS(dstr) |= sflags & SVf_ROK;
3585 assert(!(sflags & SVp_NOK));
3586 assert(!(sflags & SVp_IOK));
3587 assert(!(sflags & SVf_NOK));
3588 assert(!(sflags & SVf_IOK));
3590 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3591 if (!(sflags & SVf_OK)) {
3592 if (ckWARN(WARN_MISC))
3593 Perl_warner(aTHX_ packWARN(WARN_MISC),
3594 "Undefined value assigned to typeglob");
3597 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3598 if (dstr != (SV*)gv) {
3601 GvGP(dstr) = gp_ref(GvGP(gv));
3605 else if (sflags & SVp_POK) {
3609 * Check to see if we can just swipe the string. If so, it's a
3610 * possible small lose on short strings, but a big win on long ones.
3611 * It might even be a win on short strings if SvPVX_const(dstr)
3612 * has to be allocated and SvPVX_const(sstr) has to be freed.
3613 * Likewise if we can set up COW rather than doing an actual copy, we
3614 * drop to the else clause, as the swipe code and the COW setup code
3615 * have much in common.
3618 /* Whichever path we take through the next code, we want this true,
3619 and doing it now facilitates the COW check. */
3620 (void)SvPOK_only(dstr);
3623 /* If we're already COW then this clause is not true, and if COW
3624 is allowed then we drop down to the else and make dest COW
3625 with us. If caller hasn't said that we're allowed to COW
3626 shared hash keys then we don't do the COW setup, even if the
3627 source scalar is a shared hash key scalar. */
3628 (((flags & SV_COW_SHARED_HASH_KEYS)
3629 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3630 : 1 /* If making a COW copy is forbidden then the behaviour we
3631 desire is as if the source SV isn't actually already
3632 COW, even if it is. So we act as if the source flags
3633 are not COW, rather than actually testing them. */
3635 #ifndef PERL_OLD_COPY_ON_WRITE
3636 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3637 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3638 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3639 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3640 but in turn, it's somewhat dead code, never expected to go
3641 live, but more kept as a placeholder on how to do it better
3642 in a newer implementation. */
3643 /* If we are COW and dstr is a suitable target then we drop down
3644 into the else and make dest a COW of us. */
3645 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3650 (sflags & SVs_TEMP) && /* slated for free anyway? */
3651 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3652 (!(flags & SV_NOSTEAL)) &&
3653 /* and we're allowed to steal temps */
3654 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3655 SvLEN(sstr) && /* and really is a string */
3656 /* and won't be needed again, potentially */
3657 !(PL_op && PL_op->op_type == OP_AASSIGN))
3658 #ifdef PERL_OLD_COPY_ON_WRITE
3659 && ((flags & SV_COW_SHARED_HASH_KEYS)
3660 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3661 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3662 && SvTYPE(sstr) >= SVt_PVIV))
3666 /* Failed the swipe test, and it's not a shared hash key either.
3667 Have to copy the string. */
3668 STRLEN len = SvCUR(sstr);
3669 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3670 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3671 SvCUR_set(dstr, len);
3672 *SvEND(dstr) = '\0';
3674 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3676 /* Either it's a shared hash key, or it's suitable for
3677 copy-on-write or we can swipe the string. */
3679 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3683 #ifdef PERL_OLD_COPY_ON_WRITE
3685 /* I believe I should acquire a global SV mutex if
3686 it's a COW sv (not a shared hash key) to stop
3687 it going un copy-on-write.
3688 If the source SV has gone un copy on write between up there
3689 and down here, then (assert() that) it is of the correct
3690 form to make it copy on write again */
3691 if ((sflags & (SVf_FAKE | SVf_READONLY))
3692 != (SVf_FAKE | SVf_READONLY)) {
3693 SvREADONLY_on(sstr);
3695 /* Make the source SV into a loop of 1.
3696 (about to become 2) */
3697 SV_COW_NEXT_SV_SET(sstr, sstr);
3701 /* Initial code is common. */
3702 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3707 /* making another shared SV. */
3708 STRLEN cur = SvCUR(sstr);
3709 STRLEN len = SvLEN(sstr);
3710 #ifdef PERL_OLD_COPY_ON_WRITE
3712 assert (SvTYPE(dstr) >= SVt_PVIV);
3713 /* SvIsCOW_normal */
3714 /* splice us in between source and next-after-source. */
3715 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3716 SV_COW_NEXT_SV_SET(sstr, dstr);
3717 SvPV_set(dstr, SvPVX_mutable(sstr));
3721 /* SvIsCOW_shared_hash */
3722 DEBUG_C(PerlIO_printf(Perl_debug_log,
3723 "Copy on write: Sharing hash\n"));
3725 assert (SvTYPE(dstr) >= SVt_PV);
3727 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3729 SvLEN_set(dstr, len);
3730 SvCUR_set(dstr, cur);
3731 SvREADONLY_on(dstr);
3733 /* Relesase a global SV mutex. */
3736 { /* Passes the swipe test. */
3737 SvPV_set(dstr, SvPVX_mutable(sstr));
3738 SvLEN_set(dstr, SvLEN(sstr));
3739 SvCUR_set(dstr, SvCUR(sstr));
3742 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3743 SvPV_set(sstr, NULL);
3749 if (sflags & SVp_NOK) {
3750 SvNV_set(dstr, SvNVX(sstr));
3752 if (sflags & SVp_IOK) {
3754 SvIV_set(dstr, SvIVX(sstr));
3755 /* Must do this otherwise some other overloaded use of 0x80000000
3756 gets confused. I guess SVpbm_VALID */
3757 if (sflags & SVf_IVisUV)
3760 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3762 const MAGIC * const smg = SvVSTRING_mg(sstr);
3764 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3765 smg->mg_ptr, smg->mg_len);
3766 SvRMAGICAL_on(dstr);
3770 else if (sflags & (SVp_IOK|SVp_NOK)) {
3771 (void)SvOK_off(dstr);
3772 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3773 if (sflags & SVp_IOK) {
3774 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3775 SvIV_set(dstr, SvIVX(sstr));
3777 if (sflags & SVp_NOK) {
3778 SvNV_set(dstr, SvNVX(sstr));
3782 if (isGV_with_GP(sstr)) {
3783 /* This stringification rule for globs is spread in 3 places.
3784 This feels bad. FIXME. */
3785 const U32 wasfake = sflags & SVf_FAKE;
3787 /* FAKE globs can get coerced, so need to turn this off
3788 temporarily if it is on. */
3790 gv_efullname3(dstr, (GV *)sstr, "*");
3791 SvFLAGS(sstr) |= wasfake;
3794 (void)SvOK_off(dstr);
3796 if (SvTAINTED(sstr))
3801 =for apidoc sv_setsv_mg
3803 Like C<sv_setsv>, but also handles 'set' magic.
3809 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3811 sv_setsv(dstr,sstr);
3815 #ifdef PERL_OLD_COPY_ON_WRITE
3817 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3819 STRLEN cur = SvCUR(sstr);
3820 STRLEN len = SvLEN(sstr);
3821 register char *new_pv;
3824 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3825 (void*)sstr, (void*)dstr);
3832 if (SvTHINKFIRST(dstr))
3833 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3834 else if (SvPVX_const(dstr))
3835 Safefree(SvPVX_const(dstr));
3839 SvUPGRADE(dstr, SVt_PVIV);
3841 assert (SvPOK(sstr));
3842 assert (SvPOKp(sstr));
3843 assert (!SvIOK(sstr));
3844 assert (!SvIOKp(sstr));
3845 assert (!SvNOK(sstr));
3846 assert (!SvNOKp(sstr));
3848 if (SvIsCOW(sstr)) {
3850 if (SvLEN(sstr) == 0) {
3851 /* source is a COW shared hash key. */
3852 DEBUG_C(PerlIO_printf(Perl_debug_log,
3853 "Fast copy on write: Sharing hash\n"));
3854 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3857 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3859 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3860 SvUPGRADE(sstr, SVt_PVIV);
3861 SvREADONLY_on(sstr);
3863 DEBUG_C(PerlIO_printf(Perl_debug_log,
3864 "Fast copy on write: Converting sstr to COW\n"));
3865 SV_COW_NEXT_SV_SET(dstr, sstr);
3867 SV_COW_NEXT_SV_SET(sstr, dstr);
3868 new_pv = SvPVX_mutable(sstr);
3871 SvPV_set(dstr, new_pv);
3872 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3875 SvLEN_set(dstr, len);
3876 SvCUR_set(dstr, cur);
3885 =for apidoc sv_setpvn
3887 Copies a string into an SV. The C<len> parameter indicates the number of
3888 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3889 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3895 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3898 register char *dptr;
3900 SV_CHECK_THINKFIRST_COW_DROP(sv);
3906 /* len is STRLEN which is unsigned, need to copy to signed */
3909 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3911 SvUPGRADE(sv, SVt_PV);
3913 dptr = SvGROW(sv, len + 1);
3914 Move(ptr,dptr,len,char);
3917 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3922 =for apidoc sv_setpvn_mg
3924 Like C<sv_setpvn>, but also handles 'set' magic.
3930 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3932 sv_setpvn(sv,ptr,len);
3937 =for apidoc sv_setpv
3939 Copies a string into an SV. The string must be null-terminated. Does not
3940 handle 'set' magic. See C<sv_setpv_mg>.
3946 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3949 register STRLEN len;
3951 SV_CHECK_THINKFIRST_COW_DROP(sv);
3957 SvUPGRADE(sv, SVt_PV);
3959 SvGROW(sv, len + 1);
3960 Move(ptr,SvPVX(sv),len+1,char);
3962 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3967 =for apidoc sv_setpv_mg
3969 Like C<sv_setpv>, but also handles 'set' magic.
3975 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3982 =for apidoc sv_usepvn_flags
3984 Tells an SV to use C<ptr> to find its string value. Normally the
3985 string is stored inside the SV but sv_usepvn allows the SV to use an
3986 outside string. The C<ptr> should point to memory that was allocated
3987 by C<malloc>. The string length, C<len>, must be supplied. By default
3988 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
3989 so that pointer should not be freed or used by the programmer after
3990 giving it to sv_usepvn, and neither should any pointers from "behind"
3991 that pointer (e.g. ptr + 1) be used.
3993 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
3994 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
3995 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
3996 C<len>, and already meets the requirements for storing in C<SvPVX>)
4002 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4006 SV_CHECK_THINKFIRST_COW_DROP(sv);
4007 SvUPGRADE(sv, SVt_PV);
4010 if (flags & SV_SMAGIC)
4014 if (SvPVX_const(sv))
4018 if (flags & SV_HAS_TRAILING_NUL)
4019 assert(ptr[len] == '\0');
4022 allocate = (flags & SV_HAS_TRAILING_NUL)
4023 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4024 if (flags & SV_HAS_TRAILING_NUL) {
4025 /* It's long enough - do nothing.
4026 Specfically Perl_newCONSTSUB is relying on this. */
4029 /* Force a move to shake out bugs in callers. */
4030 char *new_ptr = (char*)safemalloc(allocate);
4031 Copy(ptr, new_ptr, len, char);
4032 PoisonFree(ptr,len,char);
4036 ptr = (char*) saferealloc (ptr, allocate);
4041 SvLEN_set(sv, allocate);
4042 if (!(flags & SV_HAS_TRAILING_NUL)) {
4045 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4047 if (flags & SV_SMAGIC)
4051 #ifdef PERL_OLD_COPY_ON_WRITE
4052 /* Need to do this *after* making the SV normal, as we need the buffer
4053 pointer to remain valid until after we've copied it. If we let go too early,
4054 another thread could invalidate it by unsharing last of the same hash key
4055 (which it can do by means other than releasing copy-on-write Svs)
4056 or by changing the other copy-on-write SVs in the loop. */
4058 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4060 { /* this SV was SvIsCOW_normal(sv) */
4061 /* we need to find the SV pointing to us. */
4062 SV *current = SV_COW_NEXT_SV(after);
4064 if (current == sv) {
4065 /* The SV we point to points back to us (there were only two of us
4067 Hence other SV is no longer copy on write either. */
4069 SvREADONLY_off(after);
4071 /* We need to follow the pointers around the loop. */
4073 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4076 /* don't loop forever if the structure is bust, and we have
4077 a pointer into a closed loop. */
4078 assert (current != after);
4079 assert (SvPVX_const(current) == pvx);
4081 /* Make the SV before us point to the SV after us. */
4082 SV_COW_NEXT_SV_SET(current, after);
4088 =for apidoc sv_force_normal_flags
4090 Undo various types of fakery on an SV: if the PV is a shared string, make
4091 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4092 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4093 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4094 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4095 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4096 set to some other value.) In addition, the C<flags> parameter gets passed to
4097 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4098 with flags set to 0.
4104 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4107 #ifdef PERL_OLD_COPY_ON_WRITE
4108 if (SvREADONLY(sv)) {
4109 /* At this point I believe I should acquire a global SV mutex. */
4111 const char * const pvx = SvPVX_const(sv);
4112 const STRLEN len = SvLEN(sv);
4113 const STRLEN cur = SvCUR(sv);
4114 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4115 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4116 we'll fail an assertion. */
4117 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4120 PerlIO_printf(Perl_debug_log,
4121 "Copy on write: Force normal %ld\n",
4127 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4130 if (flags & SV_COW_DROP_PV) {
4131 /* OK, so we don't need to copy our buffer. */
4134 SvGROW(sv, cur + 1);
4135 Move(pvx,SvPVX(sv),cur,char);
4140 sv_release_COW(sv, pvx, next);
4142 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4148 else if (IN_PERL_RUNTIME)
4149 Perl_croak(aTHX_ PL_no_modify);
4150 /* At this point I believe that I can drop the global SV mutex. */
4153 if (SvREADONLY(sv)) {
4155 const char * const pvx = SvPVX_const(sv);
4156 const STRLEN len = SvCUR(sv);
4161 SvGROW(sv, len + 1);
4162 Move(pvx,SvPVX(sv),len,char);
4164 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4166 else if (IN_PERL_RUNTIME)
4167 Perl_croak(aTHX_ PL_no_modify);
4171 sv_unref_flags(sv, flags);
4172 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4179 Efficient removal of characters from the beginning of the string buffer.
4180 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4181 the string buffer. The C<ptr> becomes the first character of the adjusted
4182 string. Uses the "OOK hack".
4183 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4184 refer to the same chunk of data.
4190 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4192 register STRLEN delta;
4193 if (!ptr || !SvPOKp(sv))
4195 delta = ptr - SvPVX_const(sv);
4196 SV_CHECK_THINKFIRST(sv);
4197 if (SvTYPE(sv) < SVt_PVIV)
4198 sv_upgrade(sv,SVt_PVIV);
4201 if (!SvLEN(sv)) { /* make copy of shared string */
4202 const char *pvx = SvPVX_const(sv);
4203 const STRLEN len = SvCUR(sv);
4204 SvGROW(sv, len + 1);
4205 Move(pvx,SvPVX(sv),len,char);
4209 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4210 and we do that anyway inside the SvNIOK_off
4212 SvFLAGS(sv) |= SVf_OOK;
4215 SvLEN_set(sv, SvLEN(sv) - delta);
4216 SvCUR_set(sv, SvCUR(sv) - delta);
4217 SvPV_set(sv, SvPVX(sv) + delta);
4218 SvIV_set(sv, SvIVX(sv) + delta);
4222 =for apidoc sv_catpvn
4224 Concatenates the string onto the end of the string which is in the SV. The
4225 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4226 status set, then the bytes appended should be valid UTF-8.
4227 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4229 =for apidoc sv_catpvn_flags
4231 Concatenates the string onto the end of the string which is in the SV. The
4232 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4233 status set, then the bytes appended should be valid UTF-8.
4234 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4235 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4236 in terms of this function.
4242 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4246 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4248 SvGROW(dsv, dlen + slen + 1);
4250 sstr = SvPVX_const(dsv);
4251 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4252 SvCUR_set(dsv, SvCUR(dsv) + slen);
4254 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4256 if (flags & SV_SMAGIC)
4261 =for apidoc sv_catsv
4263 Concatenates the string from SV C<ssv> onto the end of the string in
4264 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4265 not 'set' magic. See C<sv_catsv_mg>.
4267 =for apidoc sv_catsv_flags
4269 Concatenates the string from SV C<ssv> onto the end of the string in
4270 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4271 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4272 and C<sv_catsv_nomg> are implemented in terms of this function.
4277 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4282 const char *spv = SvPV_const(ssv, slen);
4284 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4285 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4286 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4287 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4288 dsv->sv_flags doesn't have that bit set.
4289 Andy Dougherty 12 Oct 2001
4291 const I32 sutf8 = DO_UTF8(ssv);
4294 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4296 dutf8 = DO_UTF8(dsv);
4298 if (dutf8 != sutf8) {
4300 /* Not modifying source SV, so taking a temporary copy. */
4301 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4303 sv_utf8_upgrade(csv);
4304 spv = SvPV_const(csv, slen);
4307 sv_utf8_upgrade_nomg(dsv);
4309 sv_catpvn_nomg(dsv, spv, slen);
4312 if (flags & SV_SMAGIC)
4317 =for apidoc sv_catpv
4319 Concatenates the string onto the end of the string which is in the SV.
4320 If the SV has the UTF-8 status set, then the bytes appended should be
4321 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4326 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4329 register STRLEN len;
4335 junk = SvPV_force(sv, tlen);
4337 SvGROW(sv, tlen + len + 1);
4339 ptr = SvPVX_const(sv);
4340 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4341 SvCUR_set(sv, SvCUR(sv) + len);
4342 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4347 =for apidoc sv_catpv_mg
4349 Like C<sv_catpv>, but also handles 'set' magic.
4355 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4364 Creates a new SV. A non-zero C<len> parameter indicates the number of
4365 bytes of preallocated string space the SV should have. An extra byte for a
4366 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4367 space is allocated.) The reference count for the new SV is set to 1.
4369 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4370 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4371 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4372 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4373 modules supporting older perls.
4379 Perl_newSV(pTHX_ STRLEN len)
4386 sv_upgrade(sv, SVt_PV);
4387 SvGROW(sv, len + 1);
4392 =for apidoc sv_magicext
4394 Adds magic to an SV, upgrading it if necessary. Applies the
4395 supplied vtable and returns a pointer to the magic added.
4397 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4398 In particular, you can add magic to SvREADONLY SVs, and add more than
4399 one instance of the same 'how'.
4401 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4402 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4403 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4404 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4406 (This is now used as a subroutine by C<sv_magic>.)
4411 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4412 const char* name, I32 namlen)
4417 SvUPGRADE(sv, SVt_PVMG);
4418 Newxz(mg, 1, MAGIC);
4419 mg->mg_moremagic = SvMAGIC(sv);
4420 SvMAGIC_set(sv, mg);
4422 /* Sometimes a magic contains a reference loop, where the sv and
4423 object refer to each other. To prevent a reference loop that
4424 would prevent such objects being freed, we look for such loops
4425 and if we find one we avoid incrementing the object refcount.
4427 Note we cannot do this to avoid self-tie loops as intervening RV must
4428 have its REFCNT incremented to keep it in existence.
4431 if (!obj || obj == sv ||
4432 how == PERL_MAGIC_arylen ||
4433 how == PERL_MAGIC_qr ||
4434 how == PERL_MAGIC_symtab ||
4435 (SvTYPE(obj) == SVt_PVGV &&
4436 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4437 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4438 GvFORM(obj) == (CV*)sv)))
4443 mg->mg_obj = SvREFCNT_inc_simple(obj);
4444 mg->mg_flags |= MGf_REFCOUNTED;
4447 /* Normal self-ties simply pass a null object, and instead of
4448 using mg_obj directly, use the SvTIED_obj macro to produce a
4449 new RV as needed. For glob "self-ties", we are tieing the PVIO
4450 with an RV obj pointing to the glob containing the PVIO. In
4451 this case, to avoid a reference loop, we need to weaken the
4455 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4456 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4462 mg->mg_len = namlen;
4465 mg->mg_ptr = savepvn(name, namlen);
4466 else if (namlen == HEf_SVKEY)
4467 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4469 mg->mg_ptr = (char *) name;
4471 mg->mg_virtual = (MGVTBL *) vtable;
4475 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4480 =for apidoc sv_magic
4482 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4483 then adds a new magic item of type C<how> to the head of the magic list.
4485 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4486 handling of the C<name> and C<namlen> arguments.
4488 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4489 to add more than one instance of the same 'how'.
4495 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4498 const MGVTBL *vtable;
4501 #ifdef PERL_OLD_COPY_ON_WRITE
4503 sv_force_normal_flags(sv, 0);
4505 if (SvREADONLY(sv)) {
4507 /* its okay to attach magic to shared strings; the subsequent
4508 * upgrade to PVMG will unshare the string */
4509 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4512 && how != PERL_MAGIC_regex_global
4513 && how != PERL_MAGIC_bm
4514 && how != PERL_MAGIC_fm
4515 && how != PERL_MAGIC_sv
4516 && how != PERL_MAGIC_backref
4519 Perl_croak(aTHX_ PL_no_modify);
4522 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4523 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4524 /* sv_magic() refuses to add a magic of the same 'how' as an
4527 if (how == PERL_MAGIC_taint) {
4529 /* Any scalar which already had taint magic on which someone
4530 (erroneously?) did SvIOK_on() or similar will now be
4531 incorrectly sporting public "OK" flags. */
4532 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4540 vtable = &PL_vtbl_sv;
4542 case PERL_MAGIC_overload:
4543 vtable = &PL_vtbl_amagic;
4545 case PERL_MAGIC_overload_elem:
4546 vtable = &PL_vtbl_amagicelem;
4548 case PERL_MAGIC_overload_table:
4549 vtable = &PL_vtbl_ovrld;
4552 vtable = &PL_vtbl_bm;
4554 case PERL_MAGIC_regdata:
4555 vtable = &PL_vtbl_regdata;
4557 case PERL_MAGIC_regdatum:
4558 vtable = &PL_vtbl_regdatum;
4560 case PERL_MAGIC_env:
4561 vtable = &PL_vtbl_env;
4564 vtable = &PL_vtbl_fm;
4566 case PERL_MAGIC_envelem:
4567 vtable = &PL_vtbl_envelem;
4569 case PERL_MAGIC_regex_global:
4570 vtable = &PL_vtbl_mglob;
4572 case PERL_MAGIC_isa:
4573 vtable = &PL_vtbl_isa;
4575 case PERL_MAGIC_isaelem:
4576 vtable = &PL_vtbl_isaelem;
4578 case PERL_MAGIC_nkeys:
4579 vtable = &PL_vtbl_nkeys;
4581 case PERL_MAGIC_dbfile:
4584 case PERL_MAGIC_dbline:
4585 vtable = &PL_vtbl_dbline;
4587 #ifdef USE_LOCALE_COLLATE
4588 case PERL_MAGIC_collxfrm:
4589 vtable = &PL_vtbl_collxfrm;
4591 #endif /* USE_LOCALE_COLLATE */
4592 case PERL_MAGIC_tied:
4593 vtable = &PL_vtbl_pack;
4595 case PERL_MAGIC_tiedelem:
4596 case PERL_MAGIC_tiedscalar:
4597 vtable = &PL_vtbl_packelem;
4600 vtable = &PL_vtbl_regexp;
4602 case PERL_MAGIC_hints:
4603 /* As this vtable is all NULL, we can reuse it. */
4604 case PERL_MAGIC_sig:
4605 vtable = &PL_vtbl_sig;
4607 case PERL_MAGIC_sigelem:
4608 vtable = &PL_vtbl_sigelem;
4610 case PERL_MAGIC_taint:
4611 vtable = &PL_vtbl_taint;
4613 case PERL_MAGIC_uvar:
4614 vtable = &PL_vtbl_uvar;
4616 case PERL_MAGIC_vec:
4617 vtable = &PL_vtbl_vec;
4619 case PERL_MAGIC_arylen_p:
4620 case PERL_MAGIC_rhash:
4621 case PERL_MAGIC_symtab:
4622 case PERL_MAGIC_vstring:
4625 case PERL_MAGIC_utf8:
4626 vtable = &PL_vtbl_utf8;
4628 case PERL_MAGIC_substr:
4629 vtable = &PL_vtbl_substr;
4631 case PERL_MAGIC_defelem:
4632 vtable = &PL_vtbl_defelem;
4634 case PERL_MAGIC_arylen:
4635 vtable = &PL_vtbl_arylen;
4637 case PERL_MAGIC_pos:
4638 vtable = &PL_vtbl_pos;
4640 case PERL_MAGIC_backref:
4641 vtable = &PL_vtbl_backref;
4643 case PERL_MAGIC_hintselem:
4644 vtable = &PL_vtbl_hintselem;
4646 case PERL_MAGIC_ext:
4647 /* Reserved for use by extensions not perl internals. */
4648 /* Useful for attaching extension internal data to perl vars. */
4649 /* Note that multiple extensions may clash if magical scalars */
4650 /* etc holding private data from one are passed to another. */
4654 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4657 /* Rest of work is done else where */
4658 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4661 case PERL_MAGIC_taint:
4664 case PERL_MAGIC_ext:
4665 case PERL_MAGIC_dbfile:
4672 =for apidoc sv_unmagic
4674 Removes all magic of type C<type> from an SV.
4680 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4684 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4686 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4687 for (mg = *mgp; mg; mg = *mgp) {
4688 if (mg->mg_type == type) {
4689 const MGVTBL* const vtbl = mg->mg_virtual;
4690 *mgp = mg->mg_moremagic;
4691 if (vtbl && vtbl->svt_free)
4692 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4693 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4695 Safefree(mg->mg_ptr);
4696 else if (mg->mg_len == HEf_SVKEY)
4697 SvREFCNT_dec((SV*)mg->mg_ptr);
4698 else if (mg->mg_type == PERL_MAGIC_utf8)
4699 Safefree(mg->mg_ptr);
4701 if (mg->mg_flags & MGf_REFCOUNTED)
4702 SvREFCNT_dec(mg->mg_obj);
4706 mgp = &mg->mg_moremagic;
4710 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4711 SvMAGIC_set(sv, NULL);
4718 =for apidoc sv_rvweaken
4720 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4721 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4722 push a back-reference to this RV onto the array of backreferences
4723 associated with that magic. If the RV is magical, set magic will be
4724 called after the RV is cleared.
4730 Perl_sv_rvweaken(pTHX_ SV *sv)
4733 if (!SvOK(sv)) /* let undefs pass */
4736 Perl_croak(aTHX_ "Can't weaken a nonreference");
4737 else if (SvWEAKREF(sv)) {
4738 if (ckWARN(WARN_MISC))
4739 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4743 Perl_sv_add_backref(aTHX_ tsv, sv);
4749 /* Give tsv backref magic if it hasn't already got it, then push a
4750 * back-reference to sv onto the array associated with the backref magic.
4754 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4759 if (SvTYPE(tsv) == SVt_PVHV) {
4760 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4764 /* There is no AV in the offical place - try a fixup. */
4765 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4768 /* Aha. They've got it stowed in magic. Bring it back. */
4769 av = (AV*)mg->mg_obj;
4770 /* Stop mg_free decreasing the refernce count. */
4772 /* Stop mg_free even calling the destructor, given that
4773 there's no AV to free up. */
4775 sv_unmagic(tsv, PERL_MAGIC_backref);
4779 SvREFCNT_inc_simple_void(av);
4784 const MAGIC *const mg
4785 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4787 av = (AV*)mg->mg_obj;
4791 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4792 /* av now has a refcnt of 2, which avoids it getting freed
4793 * before us during global cleanup. The extra ref is removed
4794 * by magic_killbackrefs() when tsv is being freed */
4797 if (AvFILLp(av) >= AvMAX(av)) {
4798 av_extend(av, AvFILLp(av)+1);
4800 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4803 /* delete a back-reference to ourselves from the backref magic associated
4804 * with the SV we point to.
4808 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4815 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4816 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4817 /* We mustn't attempt to "fix up" the hash here by moving the
4818 backreference array back to the hv_aux structure, as that is stored
4819 in the main HvARRAY(), and hfreentries assumes that no-one
4820 reallocates HvARRAY() while it is running. */
4823 const MAGIC *const mg
4824 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4826 av = (AV *)mg->mg_obj;
4829 if (PL_in_clean_all)
4831 Perl_croak(aTHX_ "panic: del_backref");
4838 /* We shouldn't be in here more than once, but for paranoia reasons lets
4840 for (i = AvFILLp(av); i >= 0; i--) {
4842 const SSize_t fill = AvFILLp(av);
4844 /* We weren't the last entry.
4845 An unordered list has this property that you can take the
4846 last element off the end to fill the hole, and it's still
4847 an unordered list :-)
4852 AvFILLp(av) = fill - 1;
4858 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4860 SV **svp = AvARRAY(av);
4862 PERL_UNUSED_ARG(sv);
4864 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4865 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4866 if (svp && !SvIS_FREED(av)) {
4867 SV *const *const last = svp + AvFILLp(av);
4869 while (svp <= last) {
4871 SV *const referrer = *svp;
4872 if (SvWEAKREF(referrer)) {
4873 /* XXX Should we check that it hasn't changed? */
4874 SvRV_set(referrer, 0);
4876 SvWEAKREF_off(referrer);
4877 SvSETMAGIC(referrer);
4878 } else if (SvTYPE(referrer) == SVt_PVGV ||
4879 SvTYPE(referrer) == SVt_PVLV) {
4880 /* You lookin' at me? */
4881 assert(GvSTASH(referrer));
4882 assert(GvSTASH(referrer) == (HV*)sv);
4883 GvSTASH(referrer) = 0;
4886 "panic: magic_killbackrefs (flags=%"UVxf")",
4887 (UV)SvFLAGS(referrer));
4895 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4900 =for apidoc sv_insert
4902 Inserts a string at the specified offset/length within the SV. Similar to
4903 the Perl substr() function.
4909 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4914 register char *midend;
4915 register char *bigend;
4921 Perl_croak(aTHX_ "Can't modify non-existent substring");
4922 SvPV_force(bigstr, curlen);
4923 (void)SvPOK_only_UTF8(bigstr);
4924 if (offset + len > curlen) {
4925 SvGROW(bigstr, offset+len+1);
4926 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4927 SvCUR_set(bigstr, offset+len);
4931 i = littlelen - len;
4932 if (i > 0) { /* string might grow */
4933 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4934 mid = big + offset + len;
4935 midend = bigend = big + SvCUR(bigstr);
4938 while (midend > mid) /* shove everything down */
4939 *--bigend = *--midend;
4940 Move(little,big+offset,littlelen,char);
4941 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4946 Move(little,SvPVX(bigstr)+offset,len,char);
4951 big = SvPVX(bigstr);
4954 bigend = big + SvCUR(bigstr);
4956 if (midend > bigend)
4957 Perl_croak(aTHX_ "panic: sv_insert");
4959 if (mid - big > bigend - midend) { /* faster to shorten from end */
4961 Move(little, mid, littlelen,char);
4964 i = bigend - midend;
4966 Move(midend, mid, i,char);
4970 SvCUR_set(bigstr, mid - big);
4972 else if ((i = mid - big)) { /* faster from front */
4973 midend -= littlelen;
4975 sv_chop(bigstr,midend-i);
4980 Move(little, mid, littlelen,char);
4982 else if (littlelen) {
4983 midend -= littlelen;
4984 sv_chop(bigstr,midend);
4985 Move(little,midend,littlelen,char);
4988 sv_chop(bigstr,midend);
4994 =for apidoc sv_replace
4996 Make the first argument a copy of the second, then delete the original.
4997 The target SV physically takes over ownership of the body of the source SV
4998 and inherits its flags; however, the target keeps any magic it owns,
4999 and any magic in the source is discarded.
5000 Note that this is a rather specialist SV copying operation; most of the
5001 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5007 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5010 const U32 refcnt = SvREFCNT(sv);
5011 SV_CHECK_THINKFIRST_COW_DROP(sv);
5012 if (SvREFCNT(nsv) != 1) {
5013 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5014 UVuf " != 1)", (UV) SvREFCNT(nsv));
5016 if (SvMAGICAL(sv)) {
5020 sv_upgrade(nsv, SVt_PVMG);
5021 SvMAGIC_set(nsv, SvMAGIC(sv));
5022 SvFLAGS(nsv) |= SvMAGICAL(sv);
5024 SvMAGIC_set(sv, NULL);
5028 assert(!SvREFCNT(sv));
5029 #ifdef DEBUG_LEAKING_SCALARS
5030 sv->sv_flags = nsv->sv_flags;
5031 sv->sv_any = nsv->sv_any;
5032 sv->sv_refcnt = nsv->sv_refcnt;
5033 sv->sv_u = nsv->sv_u;
5035 StructCopy(nsv,sv,SV);
5037 /* Currently could join these into one piece of pointer arithmetic, but
5038 it would be unclear. */
5039 if(SvTYPE(sv) == SVt_IV)
5041 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5042 else if (SvTYPE(sv) == SVt_RV) {
5043 SvANY(sv) = &sv->sv_u.svu_rv;
5047 #ifdef PERL_OLD_COPY_ON_WRITE
5048 if (SvIsCOW_normal(nsv)) {
5049 /* We need to follow the pointers around the loop to make the
5050 previous SV point to sv, rather than nsv. */
5053 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5056 assert(SvPVX_const(current) == SvPVX_const(nsv));
5058 /* Make the SV before us point to the SV after us. */
5060 PerlIO_printf(Perl_debug_log, "previous is\n");
5062 PerlIO_printf(Perl_debug_log,
5063 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5064 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5066 SV_COW_NEXT_SV_SET(current, sv);
5069 SvREFCNT(sv) = refcnt;
5070 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5076 =for apidoc sv_clear
5078 Clear an SV: call any destructors, free up any memory used by the body,
5079 and free the body itself. The SV's head is I<not> freed, although
5080 its type is set to all 1's so that it won't inadvertently be assumed
5081 to be live during global destruction etc.
5082 This function should only be called when REFCNT is zero. Most of the time
5083 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5090 Perl_sv_clear(pTHX_ register SV *sv)
5093 const U32 type = SvTYPE(sv);
5094 const struct body_details *const sv_type_details
5095 = bodies_by_type + type;
5099 assert(SvREFCNT(sv) == 0);
5101 if (type <= SVt_IV) {
5102 /* See the comment in sv.h about the collusion between this early
5103 return and the overloading of the NULL and IV slots in the size
5109 if (PL_defstash && /* Still have a symbol table? */
5116 stash = SvSTASH(sv);
5117 destructor = StashHANDLER(stash,DESTROY);
5119 SV* const tmpref = newRV(sv);
5120 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5122 PUSHSTACKi(PERLSI_DESTROY);
5127 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5133 if(SvREFCNT(tmpref) < 2) {
5134 /* tmpref is not kept alive! */
5136 SvRV_set(tmpref, NULL);
5139 SvREFCNT_dec(tmpref);
5141 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5145 if (PL_in_clean_objs)
5146 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5148 /* DESTROY gave object new lease on life */
5154 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5155 SvOBJECT_off(sv); /* Curse the object. */
5156 if (type != SVt_PVIO)
5157 --PL_sv_objcount; /* XXX Might want something more general */
5160 if (type >= SVt_PVMG) {
5161 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5162 SvREFCNT_dec(SvOURSTASH(sv));
5163 } else if (SvMAGIC(sv))
5165 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5166 SvREFCNT_dec(SvSTASH(sv));
5169 /* case SVt_BIND: */
5172 IoIFP(sv) != PerlIO_stdin() &&
5173 IoIFP(sv) != PerlIO_stdout() &&
5174 IoIFP(sv) != PerlIO_stderr())
5176 io_close((IO*)sv, FALSE);
5178 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5179 PerlDir_close(IoDIRP(sv));
5180 IoDIRP(sv) = (DIR*)NULL;
5181 Safefree(IoTOP_NAME(sv));
5182 Safefree(IoFMT_NAME(sv));
5183 Safefree(IoBOTTOM_NAME(sv));
5190 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5194 if (PL_comppad == (AV*)sv) {
5201 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5202 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5203 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5204 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5206 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5207 SvREFCNT_dec(LvTARG(sv));
5209 if (isGV_with_GP(sv)) {
5210 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5211 mro_method_changed_in(stash);
5214 unshare_hek(GvNAME_HEK(sv));
5215 /* If we're in a stash, we don't own a reference to it. However it does
5216 have a back reference to us, which needs to be cleared. */
5217 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5218 sv_del_backref((SV*)stash, sv);
5220 /* FIXME. There are probably more unreferenced pointers to SVs in the
5221 interpreter struct that we should check and tidy in a similar
5223 if ((GV*)sv == PL_last_in_gv)
5224 PL_last_in_gv = NULL;
5229 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5231 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5232 /* Don't even bother with turning off the OOK flag. */
5237 SV * const target = SvRV(sv);
5239 sv_del_backref(target, sv);
5241 SvREFCNT_dec(target);
5243 #ifdef PERL_OLD_COPY_ON_WRITE
5244 else if (SvPVX_const(sv)) {
5246 /* I believe I need to grab the global SV mutex here and
5247 then recheck the COW status. */
5249 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5253 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5255 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5258 /* And drop it here. */
5260 } else if (SvLEN(sv)) {
5261 Safefree(SvPVX_const(sv));
5265 else if (SvPVX_const(sv) && SvLEN(sv))
5266 Safefree(SvPVX_mutable(sv));
5267 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5268 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5277 SvFLAGS(sv) &= SVf_BREAK;
5278 SvFLAGS(sv) |= SVTYPEMASK;
5280 if (sv_type_details->arena) {
5281 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5282 &PL_body_roots[type]);
5284 else if (sv_type_details->body_size) {
5285 my_safefree(SvANY(sv));
5290 =for apidoc sv_newref
5292 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5299 Perl_sv_newref(pTHX_ SV *sv)
5301 PERL_UNUSED_CONTEXT;
5310 Decrement an SV's reference count, and if it drops to zero, call
5311 C<sv_clear> to invoke destructors and free up any memory used by
5312 the body; finally, deallocate the SV's head itself.
5313 Normally called via a wrapper macro C<SvREFCNT_dec>.
5319 Perl_sv_free(pTHX_ SV *sv)
5324 if (SvREFCNT(sv) == 0) {
5325 if (SvFLAGS(sv) & SVf_BREAK)
5326 /* this SV's refcnt has been artificially decremented to
5327 * trigger cleanup */
5329 if (PL_in_clean_all) /* All is fair */
5331 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5332 /* make sure SvREFCNT(sv)==0 happens very seldom */
5333 SvREFCNT(sv) = (~(U32)0)/2;
5336 if (ckWARN_d(WARN_INTERNAL)) {
5337 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5338 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5339 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5340 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5341 Perl_dump_sv_child(aTHX_ sv);
5343 #ifdef DEBUG_LEAKING_SCALARS
5350 if (--(SvREFCNT(sv)) > 0)
5352 Perl_sv_free2(aTHX_ sv);
5356 Perl_sv_free2(pTHX_ SV *sv)
5361 if (ckWARN_d(WARN_DEBUGGING))
5362 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5363 "Attempt to free temp prematurely: SV 0x%"UVxf
5364 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5368 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5369 /* make sure SvREFCNT(sv)==0 happens very seldom */
5370 SvREFCNT(sv) = (~(U32)0)/2;
5381 Returns the length of the string in the SV. Handles magic and type
5382 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5388 Perl_sv_len(pTHX_ register SV *sv)
5396 len = mg_length(sv);
5398 (void)SvPV_const(sv, len);
5403 =for apidoc sv_len_utf8
5405 Returns the number of characters in the string in an SV, counting wide
5406 UTF-8 bytes as a single character. Handles magic and type coercion.
5412 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5413 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5414 * (Note that the mg_len is not the length of the mg_ptr field.
5415 * This allows the cache to store the character length of the string without
5416 * needing to malloc() extra storage to attach to the mg_ptr.)
5421 Perl_sv_len_utf8(pTHX_ register SV *sv)
5427 return mg_length(sv);
5431 const U8 *s = (U8*)SvPV_const(sv, len);
5435 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5437 if (mg && mg->mg_len != -1) {
5439 if (PL_utf8cache < 0) {
5440 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5442 /* Need to turn the assertions off otherwise we may
5443 recurse infinitely while printing error messages.
5445 SAVEI8(PL_utf8cache);
5447 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5448 " real %"UVuf" for %"SVf,
5449 (UV) ulen, (UV) real, SVfARG(sv));
5454 ulen = Perl_utf8_length(aTHX_ s, s + len);
5455 if (!SvREADONLY(sv)) {
5457 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5458 &PL_vtbl_utf8, 0, 0);
5466 return Perl_utf8_length(aTHX_ s, s + len);
5470 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5473 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5476 const U8 *s = start;
5478 while (s < send && uoffset--)
5481 /* This is the existing behaviour. Possibly it should be a croak, as
5482 it's actually a bounds error */
5488 /* Given the length of the string in both bytes and UTF-8 characters, decide
5489 whether to walk forwards or backwards to find the byte corresponding to
5490 the passed in UTF-8 offset. */
5492 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5493 STRLEN uoffset, STRLEN uend)
5495 STRLEN backw = uend - uoffset;
5496 if (uoffset < 2 * backw) {
5497 /* The assumption is that going forwards is twice the speed of going
5498 forward (that's where the 2 * backw comes from).
5499 (The real figure of course depends on the UTF-8 data.) */
5500 return sv_pos_u2b_forwards(start, send, uoffset);
5505 while (UTF8_IS_CONTINUATION(*send))
5508 return send - start;
5511 /* For the string representation of the given scalar, find the byte
5512 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5513 give another position in the string, *before* the sought offset, which
5514 (which is always true, as 0, 0 is a valid pair of positions), which should
5515 help reduce the amount of linear searching.
5516 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5517 will be used to reduce the amount of linear searching. The cache will be
5518 created if necessary, and the found value offered to it for update. */
5520 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5521 const U8 *const send, STRLEN uoffset,
5522 STRLEN uoffset0, STRLEN boffset0) {
5523 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5526 assert (uoffset >= uoffset0);
5528 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5529 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5530 if ((*mgp)->mg_ptr) {
5531 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5532 if (cache[0] == uoffset) {
5533 /* An exact match. */
5536 if (cache[2] == uoffset) {
5537 /* An exact match. */
5541 if (cache[0] < uoffset) {
5542 /* The cache already knows part of the way. */
5543 if (cache[0] > uoffset0) {
5544 /* The cache knows more than the passed in pair */
5545 uoffset0 = cache[0];
5546 boffset0 = cache[1];
5548 if ((*mgp)->mg_len != -1) {
5549 /* And we know the end too. */
5551 + sv_pos_u2b_midway(start + boffset0, send,
5553 (*mgp)->mg_len - uoffset0);
5556 + sv_pos_u2b_forwards(start + boffset0,
5557 send, uoffset - uoffset0);
5560 else if (cache[2] < uoffset) {
5561 /* We're between the two cache entries. */
5562 if (cache[2] > uoffset0) {
5563 /* and the cache knows more than the passed in pair */
5564 uoffset0 = cache[2];
5565 boffset0 = cache[3];
5569 + sv_pos_u2b_midway(start + boffset0,
5572 cache[0] - uoffset0);
5575 + sv_pos_u2b_midway(start + boffset0,
5578 cache[2] - uoffset0);
5582 else if ((*mgp)->mg_len != -1) {
5583 /* If we can take advantage of a passed in offset, do so. */
5584 /* In fact, offset0 is either 0, or less than offset, so don't
5585 need to worry about the other possibility. */
5587 + sv_pos_u2b_midway(start + boffset0, send,
5589 (*mgp)->mg_len - uoffset0);
5594 if (!found || PL_utf8cache < 0) {
5595 const STRLEN real_boffset
5596 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5597 send, uoffset - uoffset0);
5599 if (found && PL_utf8cache < 0) {
5600 if (real_boffset != boffset) {
5601 /* Need to turn the assertions off otherwise we may recurse
5602 infinitely while printing error messages. */
5603 SAVEI8(PL_utf8cache);
5605 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5606 " real %"UVuf" for %"SVf,
5607 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5610 boffset = real_boffset;
5613 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5619 =for apidoc sv_pos_u2b
5621 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5622 the start of the string, to a count of the equivalent number of bytes; if
5623 lenp is non-zero, it does the same to lenp, but this time starting from
5624 the offset, rather than from the start of the string. Handles magic and
5631 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5632 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5633 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5638 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5646 start = (U8*)SvPV_const(sv, len);
5648 STRLEN uoffset = (STRLEN) *offsetp;
5649 const U8 * const send = start + len;
5651 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5654 *offsetp = (I32) boffset;
5657 /* Convert the relative offset to absolute. */
5658 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5659 const STRLEN boffset2
5660 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5661 uoffset, boffset) - boffset;
5675 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5676 byte length pairing. The (byte) length of the total SV is passed in too,
5677 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5678 may not have updated SvCUR, so we can't rely on reading it directly.
5680 The proffered utf8/byte length pairing isn't used if the cache already has
5681 two pairs, and swapping either for the proffered pair would increase the
5682 RMS of the intervals between known byte offsets.
5684 The cache itself consists of 4 STRLEN values
5685 0: larger UTF-8 offset
5686 1: corresponding byte offset
5687 2: smaller UTF-8 offset
5688 3: corresponding byte offset
5690 Unused cache pairs have the value 0, 0.
5691 Keeping the cache "backwards" means that the invariant of
5692 cache[0] >= cache[2] is maintained even with empty slots, which means that
5693 the code that uses it doesn't need to worry if only 1 entry has actually
5694 been set to non-zero. It also makes the "position beyond the end of the
5695 cache" logic much simpler, as the first slot is always the one to start
5699 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5707 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5709 (*mgp)->mg_len = -1;
5713 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5714 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5715 (*mgp)->mg_ptr = (char *) cache;
5719 if (PL_utf8cache < 0) {
5720 const U8 *start = (const U8 *) SvPVX_const(sv);
5721 const STRLEN realutf8 = utf8_length(start, start + byte);
5723 if (realutf8 != utf8) {
5724 /* Need to turn the assertions off otherwise we may recurse
5725 infinitely while printing error messages. */
5726 SAVEI8(PL_utf8cache);
5728 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5729 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5733 /* Cache is held with the later position first, to simplify the code
5734 that deals with unbounded ends. */
5736 ASSERT_UTF8_CACHE(cache);
5737 if (cache[1] == 0) {
5738 /* Cache is totally empty */
5741 } else if (cache[3] == 0) {
5742 if (byte > cache[1]) {
5743 /* New one is larger, so goes first. */
5744 cache[2] = cache[0];
5745 cache[3] = cache[1];
5753 #define THREEWAY_SQUARE(a,b,c,d) \
5754 ((float)((d) - (c))) * ((float)((d) - (c))) \
5755 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5756 + ((float)((b) - (a))) * ((float)((b) - (a)))
5758 /* Cache has 2 slots in use, and we know three potential pairs.
5759 Keep the two that give the lowest RMS distance. Do the
5760 calcualation in bytes simply because we always know the byte
5761 length. squareroot has the same ordering as the positive value,
5762 so don't bother with the actual square root. */
5763 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5764 if (byte > cache[1]) {
5765 /* New position is after the existing pair of pairs. */
5766 const float keep_earlier
5767 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5768 const float keep_later
5769 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5771 if (keep_later < keep_earlier) {
5772 if (keep_later < existing) {
5773 cache[2] = cache[0];
5774 cache[3] = cache[1];
5780 if (keep_earlier < existing) {
5786 else if (byte > cache[3]) {
5787 /* New position is between the existing pair of pairs. */
5788 const float keep_earlier
5789 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5790 const float keep_later
5791 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5793 if (keep_later < keep_earlier) {
5794 if (keep_later < existing) {
5800 if (keep_earlier < existing) {
5807 /* New position is before the existing pair of pairs. */
5808 const float keep_earlier
5809 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5810 const float keep_later
5811 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5813 if (keep_later < keep_earlier) {
5814 if (keep_later < existing) {
5820 if (keep_earlier < existing) {
5821 cache[0] = cache[2];
5822 cache[1] = cache[3];
5829 ASSERT_UTF8_CACHE(cache);
5832 /* We already know all of the way, now we may be able to walk back. The same
5833 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5834 backward is half the speed of walking forward. */
5836 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5839 const STRLEN forw = target - s;
5840 STRLEN backw = end - target;
5842 if (forw < 2 * backw) {
5843 return utf8_length(s, target);
5846 while (end > target) {
5848 while (UTF8_IS_CONTINUATION(*end)) {
5857 =for apidoc sv_pos_b2u
5859 Converts the value pointed to by offsetp from a count of bytes from the
5860 start of the string, to a count of the equivalent number of UTF-8 chars.
5861 Handles magic and type coercion.
5867 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5868 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5873 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5876 const STRLEN byte = *offsetp;
5877 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5886 s = (const U8*)SvPV_const(sv, blen);
5889 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5893 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5894 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5896 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5897 if (cache[1] == byte) {
5898 /* An exact match. */
5899 *offsetp = cache[0];
5902 if (cache[3] == byte) {
5903 /* An exact match. */
5904 *offsetp = cache[2];
5908 if (cache[1] < byte) {
5909 /* We already know part of the way. */
5910 if (mg->mg_len != -1) {
5911 /* Actually, we know the end too. */
5913 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5914 s + blen, mg->mg_len - cache[0]);
5916 len = cache[0] + utf8_length(s + cache[1], send);
5919 else if (cache[3] < byte) {
5920 /* We're between the two cached pairs, so we do the calculation
5921 offset by the byte/utf-8 positions for the earlier pair,
5922 then add the utf-8 characters from the string start to
5924 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5925 s + cache[1], cache[0] - cache[2])
5929 else { /* cache[3] > byte */
5930 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5934 ASSERT_UTF8_CACHE(cache);
5936 } else if (mg->mg_len != -1) {
5937 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5941 if (!found || PL_utf8cache < 0) {
5942 const STRLEN real_len = utf8_length(s, send);
5944 if (found && PL_utf8cache < 0) {
5945 if (len != real_len) {
5946 /* Need to turn the assertions off otherwise we may recurse
5947 infinitely while printing error messages. */
5948 SAVEI8(PL_utf8cache);
5950 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5951 " real %"UVuf" for %"SVf,
5952 (UV) len, (UV) real_len, SVfARG(sv));
5959 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5965 Returns a boolean indicating whether the strings in the two SVs are
5966 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5967 coerce its args to strings if necessary.
5973 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
5982 SV* svrecode = NULL;
5989 /* if pv1 and pv2 are the same, second SvPV_const call may
5990 * invalidate pv1, so we may need to make a copy */
5991 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
5992 pv1 = SvPV_const(sv1, cur1);
5993 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
5994 if (SvUTF8(sv2)) SvUTF8_on(sv1);
5996 pv1 = SvPV_const(sv1, cur1);
6004 pv2 = SvPV_const(sv2, cur2);
6006 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6007 /* Differing utf8ness.
6008 * Do not UTF8size the comparands as a side-effect. */
6011 svrecode = newSVpvn(pv2, cur2);
6012 sv_recode_to_utf8(svrecode, PL_encoding);
6013 pv2 = SvPV_const(svrecode, cur2);
6016 svrecode = newSVpvn(pv1, cur1);
6017 sv_recode_to_utf8(svrecode, PL_encoding);
6018 pv1 = SvPV_const(svrecode, cur1);
6020 /* Now both are in UTF-8. */
6022 SvREFCNT_dec(svrecode);
6027 bool is_utf8 = TRUE;
6030 /* sv1 is the UTF-8 one,
6031 * if is equal it must be downgrade-able */
6032 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6038 /* sv2 is the UTF-8 one,
6039 * if is equal it must be downgrade-able */
6040 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6046 /* Downgrade not possible - cannot be eq */
6054 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6056 SvREFCNT_dec(svrecode);
6066 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6067 string in C<sv1> is less than, equal to, or greater than the string in
6068 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6069 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6075 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6079 const char *pv1, *pv2;
6082 SV *svrecode = NULL;
6089 pv1 = SvPV_const(sv1, cur1);
6096 pv2 = SvPV_const(sv2, cur2);
6098 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6099 /* Differing utf8ness.
6100 * Do not UTF8size the comparands as a side-effect. */
6103 svrecode = newSVpvn(pv2, cur2);
6104 sv_recode_to_utf8(svrecode, PL_encoding);
6105 pv2 = SvPV_const(svrecode, cur2);
6108 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6113 svrecode = newSVpvn(pv1, cur1);
6114 sv_recode_to_utf8(svrecode, PL_encoding);
6115 pv1 = SvPV_const(svrecode, cur1);
6118 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6124 cmp = cur2 ? -1 : 0;
6128 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6131 cmp = retval < 0 ? -1 : 1;
6132 } else if (cur1 == cur2) {
6135 cmp = cur1 < cur2 ? -1 : 1;
6139 SvREFCNT_dec(svrecode);
6147 =for apidoc sv_cmp_locale
6149 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6150 'use bytes' aware, handles get magic, and will coerce its args to strings
6151 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6157 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6160 #ifdef USE_LOCALE_COLLATE
6166 if (PL_collation_standard)
6170 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6172 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6174 if (!pv1 || !len1) {
6185 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6188 return retval < 0 ? -1 : 1;
6191 * When the result of collation is equality, that doesn't mean
6192 * that there are no differences -- some locales exclude some
6193 * characters from consideration. So to avoid false equalities,
6194 * we use the raw string as a tiebreaker.
6200 #endif /* USE_LOCALE_COLLATE */
6202 return sv_cmp(sv1, sv2);
6206 #ifdef USE_LOCALE_COLLATE
6209 =for apidoc sv_collxfrm
6211 Add Collate Transform magic to an SV if it doesn't already have it.
6213 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6214 scalar data of the variable, but transformed to such a format that a normal
6215 memory comparison can be used to compare the data according to the locale
6222 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6227 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6228 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6234 Safefree(mg->mg_ptr);
6235 s = SvPV_const(sv, len);
6236 if ((xf = mem_collxfrm(s, len, &xlen))) {
6237 if (SvREADONLY(sv)) {
6240 return xf + sizeof(PL_collation_ix);
6243 #ifdef PERL_OLD_COPY_ON_WRITE
6245 sv_force_normal_flags(sv, 0);
6247 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6261 if (mg && mg->mg_ptr) {
6263 return mg->mg_ptr + sizeof(PL_collation_ix);
6271 #endif /* USE_LOCALE_COLLATE */
6276 Get a line from the filehandle and store it into the SV, optionally
6277 appending to the currently-stored string.
6283 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6288 register STDCHAR rslast;
6289 register STDCHAR *bp;
6294 if (SvTHINKFIRST(sv))
6295 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6296 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6298 However, perlbench says it's slower, because the existing swipe code
6299 is faster than copy on write.
6300 Swings and roundabouts. */
6301 SvUPGRADE(sv, SVt_PV);
6306 if (PerlIO_isutf8(fp)) {
6308 sv_utf8_upgrade_nomg(sv);
6309 sv_pos_u2b(sv,&append,0);
6311 } else if (SvUTF8(sv)) {
6312 SV * const tsv = newSV(0);
6313 sv_gets(tsv, fp, 0);
6314 sv_utf8_upgrade_nomg(tsv);
6315 SvCUR_set(sv,append);
6318 goto return_string_or_null;
6323 if (PerlIO_isutf8(fp))
6326 if (IN_PERL_COMPILETIME) {
6327 /* we always read code in line mode */
6331 else if (RsSNARF(PL_rs)) {
6332 /* If it is a regular disk file use size from stat() as estimate
6333 of amount we are going to read -- may result in mallocing
6334 more memory than we really need if the layers below reduce
6335 the size we read (e.g. CRLF or a gzip layer).
6338 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6339 const Off_t offset = PerlIO_tell(fp);
6340 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6341 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6347 else if (RsRECORD(PL_rs)) {
6352 /* Grab the size of the record we're getting */
6353 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6354 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6357 /* VMS wants read instead of fread, because fread doesn't respect */
6358 /* RMS record boundaries. This is not necessarily a good thing to be */
6359 /* doing, but we've got no other real choice - except avoid stdio
6360 as implementation - perhaps write a :vms layer ?
6362 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6364 bytesread = PerlIO_read(fp, buffer, recsize);
6368 SvCUR_set(sv, bytesread += append);
6369 buffer[bytesread] = '\0';
6370 goto return_string_or_null;
6372 else if (RsPARA(PL_rs)) {
6378 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6379 if (PerlIO_isutf8(fp)) {
6380 rsptr = SvPVutf8(PL_rs, rslen);
6383 if (SvUTF8(PL_rs)) {
6384 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6385 Perl_croak(aTHX_ "Wide character in $/");
6388 rsptr = SvPV_const(PL_rs, rslen);
6392 rslast = rslen ? rsptr[rslen - 1] : '\0';
6394 if (rspara) { /* have to do this both before and after */
6395 do { /* to make sure file boundaries work right */
6398 i = PerlIO_getc(fp);
6402 PerlIO_ungetc(fp,i);
6408 /* See if we know enough about I/O mechanism to cheat it ! */
6410 /* This used to be #ifdef test - it is made run-time test for ease
6411 of abstracting out stdio interface. One call should be cheap
6412 enough here - and may even be a macro allowing compile
6416 if (PerlIO_fast_gets(fp)) {
6419 * We're going to steal some values from the stdio struct
6420 * and put EVERYTHING in the innermost loop into registers.
6422 register STDCHAR *ptr;
6426 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6427 /* An ungetc()d char is handled separately from the regular
6428 * buffer, so we getc() it back out and stuff it in the buffer.
6430 i = PerlIO_getc(fp);
6431 if (i == EOF) return 0;
6432 *(--((*fp)->_ptr)) = (unsigned char) i;
6436 /* Here is some breathtakingly efficient cheating */
6438 cnt = PerlIO_get_cnt(fp); /* get count into register */
6439 /* make sure we have the room */
6440 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6441 /* Not room for all of it
6442 if we are looking for a separator and room for some
6444 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6445 /* just process what we have room for */
6446 shortbuffered = cnt - SvLEN(sv) + append + 1;
6447 cnt -= shortbuffered;
6451 /* remember that cnt can be negative */
6452 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6457 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6458 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6459 DEBUG_P(PerlIO_printf(Perl_debug_log,
6460 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6461 DEBUG_P(PerlIO_printf(Perl_debug_log,
6462 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6463 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6464 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6469 while (cnt > 0) { /* this | eat */
6471 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6472 goto thats_all_folks; /* screams | sed :-) */
6476 Copy(ptr, bp, cnt, char); /* this | eat */
6477 bp += cnt; /* screams | dust */
6478 ptr += cnt; /* louder | sed :-) */
6483 if (shortbuffered) { /* oh well, must extend */
6484 cnt = shortbuffered;
6486 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6488 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6489 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6493 DEBUG_P(PerlIO_printf(Perl_debug_log,
6494 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6495 PTR2UV(ptr),(long)cnt));
6496 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6498 DEBUG_P(PerlIO_printf(Perl_debug_log,
6499 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6500 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6501 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6503 /* This used to call 'filbuf' in stdio form, but as that behaves like
6504 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6505 another abstraction. */
6506 i = PerlIO_getc(fp); /* get more characters */
6508 DEBUG_P(PerlIO_printf(Perl_debug_log,
6509 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6510 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6511 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6513 cnt = PerlIO_get_cnt(fp);
6514 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6515 DEBUG_P(PerlIO_printf(Perl_debug_log,
6516 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6518 if (i == EOF) /* all done for ever? */
6519 goto thats_really_all_folks;
6521 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6523 SvGROW(sv, bpx + cnt + 2);
6524 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6526 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6528 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6529 goto thats_all_folks;
6533 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6534 memNE((char*)bp - rslen, rsptr, rslen))
6535 goto screamer; /* go back to the fray */
6536 thats_really_all_folks:
6538 cnt += shortbuffered;
6539 DEBUG_P(PerlIO_printf(Perl_debug_log,
6540 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6541 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6542 DEBUG_P(PerlIO_printf(Perl_debug_log,
6543 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6544 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6545 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6547 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6548 DEBUG_P(PerlIO_printf(Perl_debug_log,
6549 "Screamer: done, len=%ld, string=|%.*s|\n",
6550 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6554 /*The big, slow, and stupid way. */
6555 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6556 STDCHAR *buf = NULL;
6557 Newx(buf, 8192, STDCHAR);
6565 register const STDCHAR * const bpe = buf + sizeof(buf);
6567 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6568 ; /* keep reading */
6572 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6573 /* Accomodate broken VAXC compiler, which applies U8 cast to
6574 * both args of ?: operator, causing EOF to change into 255
6577 i = (U8)buf[cnt - 1];
6583 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6585 sv_catpvn(sv, (char *) buf, cnt);
6587 sv_setpvn(sv, (char *) buf, cnt);
6589 if (i != EOF && /* joy */
6591 SvCUR(sv) < rslen ||
6592 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6596 * If we're reading from a TTY and we get a short read,
6597 * indicating that the user hit his EOF character, we need
6598 * to notice it now, because if we try to read from the TTY
6599 * again, the EOF condition will disappear.
6601 * The comparison of cnt to sizeof(buf) is an optimization
6602 * that prevents unnecessary calls to feof().
6606 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6610 #ifdef USE_HEAP_INSTEAD_OF_STACK
6615 if (rspara) { /* have to do this both before and after */
6616 while (i != EOF) { /* to make sure file boundaries work right */
6617 i = PerlIO_getc(fp);
6619 PerlIO_ungetc(fp,i);
6625 return_string_or_null:
6626 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6632 Auto-increment of the value in the SV, doing string to numeric conversion
6633 if necessary. Handles 'get' magic.
6639 Perl_sv_inc(pTHX_ register SV *sv)
6648 if (SvTHINKFIRST(sv)) {
6650 sv_force_normal_flags(sv, 0);
6651 if (SvREADONLY(sv)) {
6652 if (IN_PERL_RUNTIME)
6653 Perl_croak(aTHX_ PL_no_modify);
6657 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6659 i = PTR2IV(SvRV(sv));
6664 flags = SvFLAGS(sv);
6665 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6666 /* It's (privately or publicly) a float, but not tested as an
6667 integer, so test it to see. */
6669 flags = SvFLAGS(sv);
6671 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6672 /* It's publicly an integer, or privately an integer-not-float */
6673 #ifdef PERL_PRESERVE_IVUV
6677 if (SvUVX(sv) == UV_MAX)
6678 sv_setnv(sv, UV_MAX_P1);
6680 (void)SvIOK_only_UV(sv);
6681 SvUV_set(sv, SvUVX(sv) + 1);
6683 if (SvIVX(sv) == IV_MAX)
6684 sv_setuv(sv, (UV)IV_MAX + 1);
6686 (void)SvIOK_only(sv);
6687 SvIV_set(sv, SvIVX(sv) + 1);
6692 if (flags & SVp_NOK) {
6693 (void)SvNOK_only(sv);
6694 SvNV_set(sv, SvNVX(sv) + 1.0);
6698 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6699 if ((flags & SVTYPEMASK) < SVt_PVIV)
6700 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6701 (void)SvIOK_only(sv);
6706 while (isALPHA(*d)) d++;
6707 while (isDIGIT(*d)) d++;
6709 #ifdef PERL_PRESERVE_IVUV
6710 /* Got to punt this as an integer if needs be, but we don't issue
6711 warnings. Probably ought to make the sv_iv_please() that does
6712 the conversion if possible, and silently. */
6713 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6714 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6715 /* Need to try really hard to see if it's an integer.
6716 9.22337203685478e+18 is an integer.
6717 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6718 so $a="9.22337203685478e+18"; $a+0; $a++
6719 needs to be the same as $a="9.22337203685478e+18"; $a++
6726 /* sv_2iv *should* have made this an NV */
6727 if (flags & SVp_NOK) {
6728 (void)SvNOK_only(sv);
6729 SvNV_set(sv, SvNVX(sv) + 1.0);
6732 /* I don't think we can get here. Maybe I should assert this
6733 And if we do get here I suspect that sv_setnv will croak. NWC
6735 #if defined(USE_LONG_DOUBLE)
6736 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",
6737 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6739 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6740 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6743 #endif /* PERL_PRESERVE_IVUV */
6744 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6748 while (d >= SvPVX_const(sv)) {
6756 /* MKS: The original code here died if letters weren't consecutive.
6757 * at least it didn't have to worry about non-C locales. The
6758 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6759 * arranged in order (although not consecutively) and that only
6760 * [A-Za-z] are accepted by isALPHA in the C locale.
6762 if (*d != 'z' && *d != 'Z') {
6763 do { ++*d; } while (!isALPHA(*d));
6766 *(d--) -= 'z' - 'a';
6771 *(d--) -= 'z' - 'a' + 1;
6775 /* oh,oh, the number grew */
6776 SvGROW(sv, SvCUR(sv) + 2);
6777 SvCUR_set(sv, SvCUR(sv) + 1);
6778 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6789 Auto-decrement of the value in the SV, doing string to numeric conversion
6790 if necessary. Handles 'get' magic.
6796 Perl_sv_dec(pTHX_ register SV *sv)
6804 if (SvTHINKFIRST(sv)) {
6806 sv_force_normal_flags(sv, 0);
6807 if (SvREADONLY(sv)) {
6808 if (IN_PERL_RUNTIME)
6809 Perl_croak(aTHX_ PL_no_modify);
6813 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6815 i = PTR2IV(SvRV(sv));
6820 /* Unlike sv_inc we don't have to worry about string-never-numbers
6821 and keeping them magic. But we mustn't warn on punting */
6822 flags = SvFLAGS(sv);
6823 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6824 /* It's publicly an integer, or privately an integer-not-float */
6825 #ifdef PERL_PRESERVE_IVUV
6829 if (SvUVX(sv) == 0) {
6830 (void)SvIOK_only(sv);
6834 (void)SvIOK_only_UV(sv);
6835 SvUV_set(sv, SvUVX(sv) - 1);
6838 if (SvIVX(sv) == IV_MIN)
6839 sv_setnv(sv, (NV)IV_MIN - 1.0);
6841 (void)SvIOK_only(sv);
6842 SvIV_set(sv, SvIVX(sv) - 1);
6847 if (flags & SVp_NOK) {
6848 SvNV_set(sv, SvNVX(sv) - 1.0);
6849 (void)SvNOK_only(sv);
6852 if (!(flags & SVp_POK)) {
6853 if ((flags & SVTYPEMASK) < SVt_PVIV)
6854 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6856 (void)SvIOK_only(sv);
6859 #ifdef PERL_PRESERVE_IVUV
6861 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6862 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6863 /* Need to try really hard to see if it's an integer.
6864 9.22337203685478e+18 is an integer.
6865 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6866 so $a="9.22337203685478e+18"; $a+0; $a--
6867 needs to be the same as $a="9.22337203685478e+18"; $a--
6874 /* sv_2iv *should* have made this an NV */
6875 if (flags & SVp_NOK) {
6876 (void)SvNOK_only(sv);
6877 SvNV_set(sv, SvNVX(sv) - 1.0);
6880 /* I don't think we can get here. Maybe I should assert this
6881 And if we do get here I suspect that sv_setnv will croak. NWC
6883 #if defined(USE_LONG_DOUBLE)
6884 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",
6885 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6887 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6888 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6892 #endif /* PERL_PRESERVE_IVUV */
6893 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6897 =for apidoc sv_mortalcopy
6899 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6900 The new SV is marked as mortal. It will be destroyed "soon", either by an
6901 explicit call to FREETMPS, or by an implicit call at places such as
6902 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6907 /* Make a string that will exist for the duration of the expression
6908 * evaluation. Actually, it may have to last longer than that, but
6909 * hopefully we won't free it until it has been assigned to a
6910 * permanent location. */
6913 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6919 sv_setsv(sv,oldstr);
6921 PL_tmps_stack[++PL_tmps_ix] = sv;
6927 =for apidoc sv_newmortal
6929 Creates a new null SV which is mortal. The reference count of the SV is
6930 set to 1. It will be destroyed "soon", either by an explicit call to
6931 FREETMPS, or by an implicit call at places such as statement boundaries.
6932 See also C<sv_mortalcopy> and C<sv_2mortal>.
6938 Perl_sv_newmortal(pTHX)
6944 SvFLAGS(sv) = SVs_TEMP;
6946 PL_tmps_stack[++PL_tmps_ix] = sv;
6951 =for apidoc sv_2mortal
6953 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6954 by an explicit call to FREETMPS, or by an implicit call at places such as
6955 statement boundaries. SvTEMP() is turned on which means that the SV's
6956 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6957 and C<sv_mortalcopy>.
6963 Perl_sv_2mortal(pTHX_ register SV *sv)
6968 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6971 PL_tmps_stack[++PL_tmps_ix] = sv;
6979 Creates a new SV and copies a string into it. The reference count for the
6980 SV is set to 1. If C<len> is zero, Perl will compute the length using
6981 strlen(). For efficiency, consider using C<newSVpvn> instead.
6987 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
6993 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
6998 =for apidoc newSVpvn
7000 Creates a new SV and copies a string into it. The reference count for the
7001 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7002 string. You are responsible for ensuring that the source string is at least
7003 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7009 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7015 sv_setpvn(sv,s,len);
7021 =for apidoc newSVhek
7023 Creates a new SV from the hash key structure. It will generate scalars that
7024 point to the shared string table where possible. Returns a new (undefined)
7025 SV if the hek is NULL.
7031 Perl_newSVhek(pTHX_ const HEK *hek)
7041 if (HEK_LEN(hek) == HEf_SVKEY) {
7042 return newSVsv(*(SV**)HEK_KEY(hek));
7044 const int flags = HEK_FLAGS(hek);
7045 if (flags & HVhek_WASUTF8) {
7047 Andreas would like keys he put in as utf8 to come back as utf8
7049 STRLEN utf8_len = HEK_LEN(hek);
7050 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7051 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7054 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7056 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7057 /* We don't have a pointer to the hv, so we have to replicate the
7058 flag into every HEK. This hv is using custom a hasing
7059 algorithm. Hence we can't return a shared string scalar, as
7060 that would contain the (wrong) hash value, and might get passed
7061 into an hv routine with a regular hash.
7062 Similarly, a hash that isn't using shared hash keys has to have
7063 the flag in every key so that we know not to try to call
7064 share_hek_kek on it. */
7066 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7071 /* This will be overwhelminly the most common case. */
7073 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7074 more efficient than sharepvn(). */
7078 sv_upgrade(sv, SVt_PV);
7079 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7080 SvCUR_set(sv, HEK_LEN(hek));
7093 =for apidoc newSVpvn_share
7095 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7096 table. If the string does not already exist in the table, it is created
7097 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7098 value is used; otherwise the hash is computed. The string's hash can be later
7099 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7100 that as the string table is used for shared hash keys these strings will have
7101 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7107 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7111 bool is_utf8 = FALSE;
7112 const char *const orig_src = src;
7115 STRLEN tmplen = -len;
7117 /* See the note in hv.c:hv_fetch() --jhi */
7118 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7122 PERL_HASH(hash, src, len);
7124 sv_upgrade(sv, SVt_PV);
7125 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7133 if (src != orig_src)
7139 #if defined(PERL_IMPLICIT_CONTEXT)
7141 /* pTHX_ magic can't cope with varargs, so this is a no-context
7142 * version of the main function, (which may itself be aliased to us).
7143 * Don't access this version directly.
7147 Perl_newSVpvf_nocontext(const char* pat, ...)
7152 va_start(args, pat);
7153 sv = vnewSVpvf(pat, &args);
7160 =for apidoc newSVpvf
7162 Creates a new SV and initializes it with the string formatted like
7169 Perl_newSVpvf(pTHX_ const char* pat, ...)
7173 va_start(args, pat);
7174 sv = vnewSVpvf(pat, &args);
7179 /* backend for newSVpvf() and newSVpvf_nocontext() */
7182 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7187 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7194 Creates a new SV and copies a floating point value into it.
7195 The reference count for the SV is set to 1.
7201 Perl_newSVnv(pTHX_ NV n)
7214 Creates a new SV and copies an integer into it. The reference count for the
7221 Perl_newSViv(pTHX_ IV i)
7234 Creates a new SV and copies an unsigned integer into it.
7235 The reference count for the SV is set to 1.
7241 Perl_newSVuv(pTHX_ UV u)
7252 =for apidoc newSV_type
7254 Creates a new SV, of the type specified. The reference count for the new SV
7261 Perl_newSV_type(pTHX_ svtype type)
7266 sv_upgrade(sv, type);
7271 =for apidoc newRV_noinc
7273 Creates an RV wrapper for an SV. The reference count for the original
7274 SV is B<not> incremented.
7280 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7283 register SV *sv = newSV_type(SVt_RV);
7285 SvRV_set(sv, tmpRef);
7290 /* newRV_inc is the official function name to use now.
7291 * newRV_inc is in fact #defined to newRV in sv.h
7295 Perl_newRV(pTHX_ SV *sv)
7298 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7304 Creates a new SV which is an exact duplicate of the original SV.
7311 Perl_newSVsv(pTHX_ register SV *old)
7318 if (SvTYPE(old) == SVTYPEMASK) {
7319 if (ckWARN_d(WARN_INTERNAL))
7320 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7324 /* SV_GMAGIC is the default for sv_setv()
7325 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7326 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7327 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7332 =for apidoc sv_reset
7334 Underlying implementation for the C<reset> Perl function.
7335 Note that the perl-level function is vaguely deprecated.
7341 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7344 char todo[PERL_UCHAR_MAX+1];
7349 if (!*s) { /* reset ?? searches */
7350 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7352 const U32 count = mg->mg_len / sizeof(PMOP**);
7353 PMOP **pmp = (PMOP**) mg->mg_ptr;
7354 PMOP *const *const end = pmp + count;
7358 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7360 (*pmp)->op_pmflags &= ~PMf_USED;
7368 /* reset variables */
7370 if (!HvARRAY(stash))
7373 Zero(todo, 256, char);
7376 I32 i = (unsigned char)*s;
7380 max = (unsigned char)*s++;
7381 for ( ; i <= max; i++) {
7384 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7386 for (entry = HvARRAY(stash)[i];
7388 entry = HeNEXT(entry))
7393 if (!todo[(U8)*HeKEY(entry)])
7395 gv = (GV*)HeVAL(entry);
7398 if (SvTHINKFIRST(sv)) {
7399 if (!SvREADONLY(sv) && SvROK(sv))
7401 /* XXX Is this continue a bug? Why should THINKFIRST
7402 exempt us from resetting arrays and hashes? */
7406 if (SvTYPE(sv) >= SVt_PV) {
7408 if (SvPVX_const(sv) != NULL)
7416 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7418 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7421 # if defined(USE_ENVIRON_ARRAY)
7424 # endif /* USE_ENVIRON_ARRAY */
7435 Using various gambits, try to get an IO from an SV: the IO slot if its a
7436 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7437 named after the PV if we're a string.
7443 Perl_sv_2io(pTHX_ SV *sv)
7448 switch (SvTYPE(sv)) {
7456 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7460 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7462 return sv_2io(SvRV(sv));
7463 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7469 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7478 Using various gambits, try to get a CV from an SV; in addition, try if
7479 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7480 The flags in C<lref> are passed to sv_fetchsv.
7486 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7497 switch (SvTYPE(sv)) {
7516 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7517 tryAMAGICunDEREF(to_cv);
7520 if (SvTYPE(sv) == SVt_PVCV) {
7529 Perl_croak(aTHX_ "Not a subroutine reference");
7534 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7540 /* Some flags to gv_fetchsv mean don't really create the GV */
7541 if (SvTYPE(gv) != SVt_PVGV) {
7547 if (lref && !GvCVu(gv)) {
7551 gv_efullname3(tmpsv, gv, NULL);
7552 /* XXX this is probably not what they think they're getting.
7553 * It has the same effect as "sub name;", i.e. just a forward
7555 newSUB(start_subparse(FALSE, 0),
7556 newSVOP(OP_CONST, 0, tmpsv),
7560 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7570 Returns true if the SV has a true value by Perl's rules.
7571 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7572 instead use an in-line version.
7578 Perl_sv_true(pTHX_ register SV *sv)
7583 register const XPV* const tXpv = (XPV*)SvANY(sv);
7585 (tXpv->xpv_cur > 1 ||
7586 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7593 return SvIVX(sv) != 0;
7596 return SvNVX(sv) != 0.0;
7598 return sv_2bool(sv);
7604 =for apidoc sv_pvn_force
7606 Get a sensible string out of the SV somehow.
7607 A private implementation of the C<SvPV_force> macro for compilers which
7608 can't cope with complex macro expressions. Always use the macro instead.
7610 =for apidoc sv_pvn_force_flags
7612 Get a sensible string out of the SV somehow.
7613 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7614 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7615 implemented in terms of this function.
7616 You normally want to use the various wrapper macros instead: see
7617 C<SvPV_force> and C<SvPV_force_nomg>
7623 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7626 if (SvTHINKFIRST(sv) && !SvROK(sv))
7627 sv_force_normal_flags(sv, 0);
7637 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7638 const char * const ref = sv_reftype(sv,0);
7640 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7641 ref, OP_NAME(PL_op));
7643 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7645 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7646 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7648 s = sv_2pv_flags(sv, &len, flags);
7652 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7655 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7656 SvGROW(sv, len + 1);
7657 Move(s,SvPVX(sv),len,char);
7659 SvPVX(sv)[len] = '\0';
7662 SvPOK_on(sv); /* validate pointer */
7664 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7665 PTR2UV(sv),SvPVX_const(sv)));
7668 return SvPVX_mutable(sv);
7672 =for apidoc sv_pvbyten_force
7674 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7680 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7682 sv_pvn_force(sv,lp);
7683 sv_utf8_downgrade(sv,0);
7689 =for apidoc sv_pvutf8n_force
7691 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7697 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7699 sv_pvn_force(sv,lp);
7700 sv_utf8_upgrade(sv);
7706 =for apidoc sv_reftype
7708 Returns a string describing what the SV is a reference to.
7714 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7716 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7717 inside return suggests a const propagation bug in g++. */
7718 if (ob && SvOBJECT(sv)) {
7719 char * const name = HvNAME_get(SvSTASH(sv));
7720 return name ? name : (char *) "__ANON__";
7723 switch (SvTYPE(sv)) {
7739 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7740 /* tied lvalues should appear to be
7741 * scalars for backwards compatitbility */
7742 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7743 ? "SCALAR" : "LVALUE");
7744 case SVt_PVAV: return "ARRAY";
7745 case SVt_PVHV: return "HASH";
7746 case SVt_PVCV: return "CODE";
7747 case SVt_PVGV: return "GLOB";
7748 case SVt_PVFM: return "FORMAT";
7749 case SVt_PVIO: return "IO";
7750 case SVt_BIND: return "BIND";
7751 default: return "UNKNOWN";
7757 =for apidoc sv_isobject
7759 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7760 object. If the SV is not an RV, or if the object is not blessed, then this
7767 Perl_sv_isobject(pTHX_ SV *sv)
7783 Returns a boolean indicating whether the SV is blessed into the specified
7784 class. This does not check for subtypes; use C<sv_derived_from> to verify
7785 an inheritance relationship.
7791 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7802 hvname = HvNAME_get(SvSTASH(sv));
7806 return strEQ(hvname, name);
7812 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7813 it will be upgraded to one. If C<classname> is non-null then the new SV will
7814 be blessed in the specified package. The new SV is returned and its
7815 reference count is 1.
7821 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7828 SV_CHECK_THINKFIRST_COW_DROP(rv);
7829 (void)SvAMAGIC_off(rv);
7831 if (SvTYPE(rv) >= SVt_PVMG) {
7832 const U32 refcnt = SvREFCNT(rv);
7836 SvREFCNT(rv) = refcnt;
7838 sv_upgrade(rv, SVt_RV);
7839 } else if (SvROK(rv)) {
7840 SvREFCNT_dec(SvRV(rv));
7841 } else if (SvTYPE(rv) < SVt_RV)
7842 sv_upgrade(rv, SVt_RV);
7843 else if (SvTYPE(rv) > SVt_RV) {
7854 HV* const stash = gv_stashpv(classname, GV_ADD);
7855 (void)sv_bless(rv, stash);
7861 =for apidoc sv_setref_pv
7863 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7864 argument will be upgraded to an RV. That RV will be modified to point to
7865 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7866 into the SV. The C<classname> argument indicates the package for the
7867 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7868 will have a reference count of 1, and the RV will be returned.
7870 Do not use with other Perl types such as HV, AV, SV, CV, because those
7871 objects will become corrupted by the pointer copy process.
7873 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7879 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7883 sv_setsv(rv, &PL_sv_undef);
7887 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7892 =for apidoc sv_setref_iv
7894 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7895 argument will be upgraded to an RV. That RV will be modified to point to
7896 the new SV. The C<classname> argument indicates the package for the
7897 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7898 will have a reference count of 1, and the RV will be returned.
7904 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7906 sv_setiv(newSVrv(rv,classname), iv);
7911 =for apidoc sv_setref_uv
7913 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7914 argument will be upgraded to an RV. That RV will be modified to point to
7915 the new SV. The C<classname> argument indicates the package for the
7916 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7917 will have a reference count of 1, and the RV will be returned.
7923 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7925 sv_setuv(newSVrv(rv,classname), uv);
7930 =for apidoc sv_setref_nv
7932 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7933 argument will be upgraded to an RV. That RV will be modified to point to
7934 the new SV. The C<classname> argument indicates the package for the
7935 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7936 will have a reference count of 1, and the RV will be returned.
7942 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7944 sv_setnv(newSVrv(rv,classname), nv);
7949 =for apidoc sv_setref_pvn
7951 Copies a string into a new SV, optionally blessing the SV. The length of the
7952 string must be specified with C<n>. The C<rv> argument will be upgraded to
7953 an RV. That RV will be modified to point to the new SV. The C<classname>
7954 argument indicates the package for the blessing. Set C<classname> to
7955 C<NULL> to avoid the blessing. The new SV will have a reference count
7956 of 1, and the RV will be returned.
7958 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7964 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7966 sv_setpvn(newSVrv(rv,classname), pv, n);
7971 =for apidoc sv_bless
7973 Blesses an SV into a specified package. The SV must be an RV. The package
7974 must be designated by its stash (see C<gv_stashpv()>). The reference count
7975 of the SV is unaffected.
7981 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
7986 Perl_croak(aTHX_ "Can't bless non-reference value");
7988 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7989 if (SvIsCOW(tmpRef))
7990 sv_force_normal_flags(tmpRef, 0);
7991 if (SvREADONLY(tmpRef))
7992 Perl_croak(aTHX_ PL_no_modify);
7993 if (SvOBJECT(tmpRef)) {
7994 if (SvTYPE(tmpRef) != SVt_PVIO)
7996 SvREFCNT_dec(SvSTASH(tmpRef));
7999 SvOBJECT_on(tmpRef);
8000 if (SvTYPE(tmpRef) != SVt_PVIO)
8002 SvUPGRADE(tmpRef, SVt_PVMG);
8003 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8008 (void)SvAMAGIC_off(sv);
8010 if(SvSMAGICAL(tmpRef))
8011 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8019 /* Downgrades a PVGV to a PVMG.
8023 S_sv_unglob(pTHX_ SV *sv)
8028 SV * const temp = sv_newmortal();
8030 assert(SvTYPE(sv) == SVt_PVGV);
8032 gv_efullname3(temp, (GV *) sv, "*");
8035 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8036 mro_method_changed_in(stash);
8040 sv_del_backref((SV*)GvSTASH(sv), sv);
8044 if (GvNAME_HEK(sv)) {
8045 unshare_hek(GvNAME_HEK(sv));
8047 isGV_with_GP_off(sv);
8049 /* need to keep SvANY(sv) in the right arena */
8050 xpvmg = new_XPVMG();
8051 StructCopy(SvANY(sv), xpvmg, XPVMG);
8052 del_XPVGV(SvANY(sv));
8055 SvFLAGS(sv) &= ~SVTYPEMASK;
8056 SvFLAGS(sv) |= SVt_PVMG;
8058 /* Intentionally not calling any local SET magic, as this isn't so much a
8059 set operation as merely an internal storage change. */
8060 sv_setsv_flags(sv, temp, 0);
8064 =for apidoc sv_unref_flags
8066 Unsets the RV status of the SV, and decrements the reference count of
8067 whatever was being referenced by the RV. This can almost be thought of
8068 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8069 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8070 (otherwise the decrementing is conditional on the reference count being
8071 different from one or the reference being a readonly SV).
8078 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8080 SV* const target = SvRV(ref);
8082 if (SvWEAKREF(ref)) {
8083 sv_del_backref(target, ref);
8085 SvRV_set(ref, NULL);
8088 SvRV_set(ref, NULL);
8090 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8091 assigned to as BEGIN {$a = \"Foo"} will fail. */
8092 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8093 SvREFCNT_dec(target);
8094 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8095 sv_2mortal(target); /* Schedule for freeing later */
8099 =for apidoc sv_untaint
8101 Untaint an SV. Use C<SvTAINTED_off> instead.
8106 Perl_sv_untaint(pTHX_ SV *sv)
8108 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8109 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8116 =for apidoc sv_tainted
8118 Test an SV for taintedness. Use C<SvTAINTED> instead.
8123 Perl_sv_tainted(pTHX_ SV *sv)
8125 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8126 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8127 if (mg && (mg->mg_len & 1) )
8134 =for apidoc sv_setpviv
8136 Copies an integer into the given SV, also updating its string value.
8137 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8143 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8145 char buf[TYPE_CHARS(UV)];
8147 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8149 sv_setpvn(sv, ptr, ebuf - ptr);
8153 =for apidoc sv_setpviv_mg
8155 Like C<sv_setpviv>, but also handles 'set' magic.
8161 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8167 #if defined(PERL_IMPLICIT_CONTEXT)
8169 /* pTHX_ magic can't cope with varargs, so this is a no-context
8170 * version of the main function, (which may itself be aliased to us).
8171 * Don't access this version directly.
8175 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8179 va_start(args, pat);
8180 sv_vsetpvf(sv, pat, &args);
8184 /* pTHX_ magic can't cope with varargs, so this is a no-context
8185 * version of the main function, (which may itself be aliased to us).
8186 * Don't access this version directly.
8190 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8194 va_start(args, pat);
8195 sv_vsetpvf_mg(sv, pat, &args);
8201 =for apidoc sv_setpvf
8203 Works like C<sv_catpvf> but copies the text into the SV instead of
8204 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8210 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8213 va_start(args, pat);
8214 sv_vsetpvf(sv, pat, &args);
8219 =for apidoc sv_vsetpvf
8221 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8222 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8224 Usually used via its frontend C<sv_setpvf>.
8230 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8232 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8236 =for apidoc sv_setpvf_mg
8238 Like C<sv_setpvf>, but also handles 'set' magic.
8244 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8247 va_start(args, pat);
8248 sv_vsetpvf_mg(sv, pat, &args);
8253 =for apidoc sv_vsetpvf_mg
8255 Like C<sv_vsetpvf>, but also handles 'set' magic.
8257 Usually used via its frontend C<sv_setpvf_mg>.
8263 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8265 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8269 #if defined(PERL_IMPLICIT_CONTEXT)
8271 /* pTHX_ magic can't cope with varargs, so this is a no-context
8272 * version of the main function, (which may itself be aliased to us).
8273 * Don't access this version directly.
8277 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8281 va_start(args, pat);
8282 sv_vcatpvf(sv, pat, &args);
8286 /* pTHX_ magic can't cope with varargs, so this is a no-context
8287 * version of the main function, (which may itself be aliased to us).
8288 * Don't access this version directly.
8292 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8296 va_start(args, pat);
8297 sv_vcatpvf_mg(sv, pat, &args);
8303 =for apidoc sv_catpvf
8305 Processes its arguments like C<sprintf> and appends the formatted
8306 output to an SV. If the appended data contains "wide" characters
8307 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8308 and characters >255 formatted with %c), the original SV might get
8309 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8310 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8311 valid UTF-8; if the original SV was bytes, the pattern should be too.
8316 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8319 va_start(args, pat);
8320 sv_vcatpvf(sv, pat, &args);
8325 =for apidoc sv_vcatpvf
8327 Processes its arguments like C<vsprintf> and appends the formatted output
8328 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8330 Usually used via its frontend C<sv_catpvf>.
8336 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8338 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8342 =for apidoc sv_catpvf_mg
8344 Like C<sv_catpvf>, but also handles 'set' magic.
8350 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8353 va_start(args, pat);
8354 sv_vcatpvf_mg(sv, pat, &args);
8359 =for apidoc sv_vcatpvf_mg
8361 Like C<sv_vcatpvf>, but also handles 'set' magic.
8363 Usually used via its frontend C<sv_catpvf_mg>.
8369 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8371 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8376 =for apidoc sv_vsetpvfn
8378 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8381 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8387 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8389 sv_setpvn(sv, "", 0);
8390 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8394 S_expect_number(pTHX_ char** pattern)
8398 switch (**pattern) {
8399 case '1': case '2': case '3':
8400 case '4': case '5': case '6':
8401 case '7': case '8': case '9':
8402 var = *(*pattern)++ - '0';
8403 while (isDIGIT(**pattern)) {
8404 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8406 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8414 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8416 const int neg = nv < 0;
8425 if (uv & 1 && uv == nv)
8426 uv--; /* Round to even */
8428 const unsigned dig = uv % 10;
8441 =for apidoc sv_vcatpvfn
8443 Processes its arguments like C<vsprintf> and appends the formatted output
8444 to an SV. Uses an array of SVs if the C style variable argument list is
8445 missing (NULL). When running with taint checks enabled, indicates via
8446 C<maybe_tainted> if results are untrustworthy (often due to the use of
8449 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8455 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8456 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8457 vec_utf8 = DO_UTF8(vecsv);
8459 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8462 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8470 static const char nullstr[] = "(null)";
8472 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8473 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8475 /* Times 4: a decimal digit takes more than 3 binary digits.
8476 * NV_DIG: mantissa takes than many decimal digits.
8477 * Plus 32: Playing safe. */
8478 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8479 /* large enough for "%#.#f" --chip */
8480 /* what about long double NVs? --jhi */
8482 PERL_UNUSED_ARG(maybe_tainted);
8484 /* no matter what, this is a string now */
8485 (void)SvPV_force(sv, origlen);
8487 /* special-case "", "%s", and "%-p" (SVf - see below) */
8490 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8492 const char * const s = va_arg(*args, char*);
8493 sv_catpv(sv, s ? s : nullstr);
8495 else if (svix < svmax) {
8496 sv_catsv(sv, *svargs);
8500 if (args && patlen == 3 && pat[0] == '%' &&
8501 pat[1] == '-' && pat[2] == 'p') {
8502 argsv = (SV*)va_arg(*args, void*);
8503 sv_catsv(sv, argsv);
8507 #ifndef USE_LONG_DOUBLE
8508 /* special-case "%.<number>[gf]" */
8509 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8510 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8511 unsigned digits = 0;
8515 while (*pp >= '0' && *pp <= '9')
8516 digits = 10 * digits + (*pp++ - '0');
8517 if (pp - pat == (int)patlen - 1) {
8525 /* Add check for digits != 0 because it seems that some
8526 gconverts are buggy in this case, and we don't yet have
8527 a Configure test for this. */
8528 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8529 /* 0, point, slack */
8530 Gconvert(nv, (int)digits, 0, ebuf);
8532 if (*ebuf) /* May return an empty string for digits==0 */
8535 } else if (!digits) {
8538 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8539 sv_catpvn(sv, p, l);
8545 #endif /* !USE_LONG_DOUBLE */
8547 if (!args && svix < svmax && DO_UTF8(*svargs))
8550 patend = (char*)pat + patlen;
8551 for (p = (char*)pat; p < patend; p = q) {
8554 bool vectorize = FALSE;
8555 bool vectorarg = FALSE;
8556 bool vec_utf8 = FALSE;
8562 bool has_precis = FALSE;
8564 const I32 osvix = svix;
8565 bool is_utf8 = FALSE; /* is this item utf8? */
8566 #ifdef HAS_LDBL_SPRINTF_BUG
8567 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8568 with sfio - Allen <allens@cpan.org> */
8569 bool fix_ldbl_sprintf_bug = FALSE;
8573 U8 utf8buf[UTF8_MAXBYTES+1];
8574 STRLEN esignlen = 0;
8576 const char *eptr = NULL;
8579 const U8 *vecstr = NULL;
8586 /* we need a long double target in case HAS_LONG_DOUBLE but
8589 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8597 const char *dotstr = ".";
8598 STRLEN dotstrlen = 1;
8599 I32 efix = 0; /* explicit format parameter index */
8600 I32 ewix = 0; /* explicit width index */
8601 I32 epix = 0; /* explicit precision index */
8602 I32 evix = 0; /* explicit vector index */
8603 bool asterisk = FALSE;
8605 /* echo everything up to the next format specification */
8606 for (q = p; q < patend && *q != '%'; ++q) ;
8608 if (has_utf8 && !pat_utf8)
8609 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8611 sv_catpvn(sv, p, q - p);
8618 We allow format specification elements in this order:
8619 \d+\$ explicit format parameter index
8621 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8622 0 flag (as above): repeated to allow "v02"
8623 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8624 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8626 [%bcdefginopsuxDFOUX] format (mandatory)
8631 As of perl5.9.3, printf format checking is on by default.
8632 Internally, perl uses %p formats to provide an escape to
8633 some extended formatting. This block deals with those
8634 extensions: if it does not match, (char*)q is reset and
8635 the normal format processing code is used.
8637 Currently defined extensions are:
8638 %p include pointer address (standard)
8639 %-p (SVf) include an SV (previously %_)
8640 %-<num>p include an SV with precision <num>
8641 %<num>p reserved for future extensions
8643 Robin Barker 2005-07-14
8645 %1p (VDf) removed. RMB 2007-10-19
8652 n = expect_number(&q);
8659 argsv = (SV*)va_arg(*args, void*);
8660 eptr = SvPV_const(argsv, elen);
8666 if (ckWARN_d(WARN_INTERNAL))
8667 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8668 "internal %%<num>p might conflict with future printf extensions");
8674 if ( (width = expect_number(&q)) ) {
8689 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8718 if ( (ewix = expect_number(&q)) )
8727 if ((vectorarg = asterisk)) {
8740 width = expect_number(&q);
8746 vecsv = va_arg(*args, SV*);
8748 vecsv = (evix > 0 && evix <= svmax)
8749 ? svargs[evix-1] : &PL_sv_undef;
8751 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8753 dotstr = SvPV_const(vecsv, dotstrlen);
8754 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8755 bad with tied or overloaded values that return UTF8. */
8758 else if (has_utf8) {
8759 vecsv = sv_mortalcopy(vecsv);
8760 sv_utf8_upgrade(vecsv);
8761 dotstr = SvPV_const(vecsv, dotstrlen);
8768 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8769 vecsv = svargs[efix ? efix-1 : svix++];
8770 vecstr = (U8*)SvPV_const(vecsv,veclen);
8771 vec_utf8 = DO_UTF8(vecsv);
8773 /* if this is a version object, we need to convert
8774 * back into v-string notation and then let the
8775 * vectorize happen normally
8777 if (sv_derived_from(vecsv, "version")) {
8778 char *version = savesvpv(vecsv);
8779 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8780 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8781 "vector argument not supported with alpha versions");
8784 vecsv = sv_newmortal();
8785 scan_vstring(version, version + veclen, vecsv);
8786 vecstr = (U8*)SvPV_const(vecsv, veclen);
8787 vec_utf8 = DO_UTF8(vecsv);
8799 i = va_arg(*args, int);
8801 i = (ewix ? ewix <= svmax : svix < svmax) ?
8802 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8804 width = (i < 0) ? -i : i;
8814 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8816 /* XXX: todo, support specified precision parameter */
8820 i = va_arg(*args, int);
8822 i = (ewix ? ewix <= svmax : svix < svmax)
8823 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8825 has_precis = !(i < 0);
8830 precis = precis * 10 + (*q++ - '0');
8839 case 'I': /* Ix, I32x, and I64x */
8841 if (q[1] == '6' && q[2] == '4') {
8847 if (q[1] == '3' && q[2] == '2') {
8857 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8868 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8869 if (*(q + 1) == 'l') { /* lld, llf */
8895 if (!vectorize && !args) {
8897 const I32 i = efix-1;
8898 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8900 argsv = (svix >= 0 && svix < svmax)
8901 ? svargs[svix++] : &PL_sv_undef;
8912 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8914 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8916 eptr = (char*)utf8buf;
8917 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8931 eptr = va_arg(*args, char*);
8933 #ifdef MACOS_TRADITIONAL
8934 /* On MacOS, %#s format is used for Pascal strings */
8939 elen = strlen(eptr);
8941 eptr = (char *)nullstr;
8942 elen = sizeof nullstr - 1;
8946 eptr = SvPV_const(argsv, elen);
8947 if (DO_UTF8(argsv)) {
8948 I32 old_precis = precis;
8949 if (has_precis && precis < elen) {
8951 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8954 if (width) { /* fudge width (can't fudge elen) */
8955 if (has_precis && precis < elen)
8956 width += precis - old_precis;
8958 width += elen - sv_len_utf8(argsv);
8965 if (has_precis && elen > precis)
8972 if (alt || vectorize)
8974 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
8995 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9004 esignbuf[esignlen++] = plus;
9008 case 'h': iv = (short)va_arg(*args, int); break;
9009 case 'l': iv = va_arg(*args, long); break;
9010 case 'V': iv = va_arg(*args, IV); break;
9011 default: iv = va_arg(*args, int); break;
9013 case 'q': iv = va_arg(*args, Quad_t); break;
9018 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9020 case 'h': iv = (short)tiv; break;
9021 case 'l': iv = (long)tiv; break;
9023 default: iv = tiv; break;
9025 case 'q': iv = (Quad_t)tiv; break;
9029 if ( !vectorize ) /* we already set uv above */
9034 esignbuf[esignlen++] = plus;
9038 esignbuf[esignlen++] = '-';
9082 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9093 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9094 case 'l': uv = va_arg(*args, unsigned long); break;
9095 case 'V': uv = va_arg(*args, UV); break;
9096 default: uv = va_arg(*args, unsigned); break;
9098 case 'q': uv = va_arg(*args, Uquad_t); break;
9103 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9105 case 'h': uv = (unsigned short)tuv; break;
9106 case 'l': uv = (unsigned long)tuv; break;
9108 default: uv = tuv; break;
9110 case 'q': uv = (Uquad_t)tuv; break;
9117 char *ptr = ebuf + sizeof ebuf;
9118 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9124 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9130 esignbuf[esignlen++] = '0';
9131 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9139 if (alt && *ptr != '0')
9148 esignbuf[esignlen++] = '0';
9149 esignbuf[esignlen++] = c;
9152 default: /* it had better be ten or less */
9156 } while (uv /= base);
9159 elen = (ebuf + sizeof ebuf) - ptr;
9163 zeros = precis - elen;
9164 else if (precis == 0 && elen == 1 && *eptr == '0'
9165 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9168 /* a precision nullifies the 0 flag. */
9175 /* FLOATING POINT */
9178 c = 'f'; /* maybe %F isn't supported here */
9186 /* This is evil, but floating point is even more evil */
9188 /* for SV-style calling, we can only get NV
9189 for C-style calling, we assume %f is double;
9190 for simplicity we allow any of %Lf, %llf, %qf for long double
9194 #if defined(USE_LONG_DOUBLE)
9198 /* [perl #20339] - we should accept and ignore %lf rather than die */
9202 #if defined(USE_LONG_DOUBLE)
9203 intsize = args ? 0 : 'q';
9207 #if defined(HAS_LONG_DOUBLE)
9216 /* now we need (long double) if intsize == 'q', else (double) */
9218 #if LONG_DOUBLESIZE > DOUBLESIZE
9220 va_arg(*args, long double) :
9221 va_arg(*args, double)
9223 va_arg(*args, double)
9228 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9229 else. frexp() has some unspecified behaviour for those three */
9230 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9232 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9233 will cast our (long double) to (double) */
9234 (void)Perl_frexp(nv, &i);
9235 if (i == PERL_INT_MIN)
9236 Perl_die(aTHX_ "panic: frexp");
9238 need = BIT_DIGITS(i);
9240 need += has_precis ? precis : 6; /* known default */
9245 #ifdef HAS_LDBL_SPRINTF_BUG
9246 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9247 with sfio - Allen <allens@cpan.org> */
9250 # define MY_DBL_MAX DBL_MAX
9251 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9252 # if DOUBLESIZE >= 8
9253 # define MY_DBL_MAX 1.7976931348623157E+308L
9255 # define MY_DBL_MAX 3.40282347E+38L
9259 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9260 # define MY_DBL_MAX_BUG 1L
9262 # define MY_DBL_MAX_BUG MY_DBL_MAX
9266 # define MY_DBL_MIN DBL_MIN
9267 # else /* XXX guessing! -Allen */
9268 # if DOUBLESIZE >= 8
9269 # define MY_DBL_MIN 2.2250738585072014E-308L
9271 # define MY_DBL_MIN 1.17549435E-38L
9275 if ((intsize == 'q') && (c == 'f') &&
9276 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9278 /* it's going to be short enough that
9279 * long double precision is not needed */
9281 if ((nv <= 0L) && (nv >= -0L))
9282 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9284 /* would use Perl_fp_class as a double-check but not
9285 * functional on IRIX - see perl.h comments */
9287 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9288 /* It's within the range that a double can represent */
9289 #if defined(DBL_MAX) && !defined(DBL_MIN)
9290 if ((nv >= ((long double)1/DBL_MAX)) ||
9291 (nv <= (-(long double)1/DBL_MAX)))
9293 fix_ldbl_sprintf_bug = TRUE;
9296 if (fix_ldbl_sprintf_bug == TRUE) {
9306 # undef MY_DBL_MAX_BUG
9309 #endif /* HAS_LDBL_SPRINTF_BUG */
9311 need += 20; /* fudge factor */
9312 if (PL_efloatsize < need) {
9313 Safefree(PL_efloatbuf);
9314 PL_efloatsize = need + 20; /* more fudge */
9315 Newx(PL_efloatbuf, PL_efloatsize, char);
9316 PL_efloatbuf[0] = '\0';
9319 if ( !(width || left || plus || alt) && fill != '0'
9320 && has_precis && intsize != 'q' ) { /* Shortcuts */
9321 /* See earlier comment about buggy Gconvert when digits,
9323 if ( c == 'g' && precis) {
9324 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9325 /* May return an empty string for digits==0 */
9326 if (*PL_efloatbuf) {
9327 elen = strlen(PL_efloatbuf);
9328 goto float_converted;
9330 } else if ( c == 'f' && !precis) {
9331 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9336 char *ptr = ebuf + sizeof ebuf;
9339 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9340 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9341 if (intsize == 'q') {
9342 /* Copy the one or more characters in a long double
9343 * format before the 'base' ([efgEFG]) character to
9344 * the format string. */
9345 static char const prifldbl[] = PERL_PRIfldbl;
9346 char const *p = prifldbl + sizeof(prifldbl) - 3;
9347 while (p >= prifldbl) { *--ptr = *p--; }
9352 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9357 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9369 /* No taint. Otherwise we are in the strange situation
9370 * where printf() taints but print($float) doesn't.
9372 #if defined(HAS_LONG_DOUBLE)
9373 elen = ((intsize == 'q')
9374 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9375 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9377 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9381 eptr = PL_efloatbuf;
9389 i = SvCUR(sv) - origlen;
9392 case 'h': *(va_arg(*args, short*)) = i; break;
9393 default: *(va_arg(*args, int*)) = i; break;
9394 case 'l': *(va_arg(*args, long*)) = i; break;
9395 case 'V': *(va_arg(*args, IV*)) = i; break;
9397 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9402 sv_setuv_mg(argsv, (UV)i);
9403 continue; /* not "break" */
9410 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9411 && ckWARN(WARN_PRINTF))
9413 SV * const msg = sv_newmortal();
9414 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9415 (PL_op->op_type == OP_PRTF) ? "" : "s");
9418 Perl_sv_catpvf(aTHX_ msg,
9419 "\"%%%c\"", c & 0xFF);
9421 Perl_sv_catpvf(aTHX_ msg,
9422 "\"%%\\%03"UVof"\"",
9425 sv_catpvs(msg, "end of string");
9426 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9429 /* output mangled stuff ... */
9435 /* ... right here, because formatting flags should not apply */
9436 SvGROW(sv, SvCUR(sv) + elen + 1);
9438 Copy(eptr, p, elen, char);
9441 SvCUR_set(sv, p - SvPVX_const(sv));
9443 continue; /* not "break" */
9446 if (is_utf8 != has_utf8) {
9449 sv_utf8_upgrade(sv);
9452 const STRLEN old_elen = elen;
9453 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9454 sv_utf8_upgrade(nsv);
9455 eptr = SvPVX_const(nsv);
9458 if (width) { /* fudge width (can't fudge elen) */
9459 width += elen - old_elen;
9465 have = esignlen + zeros + elen;
9467 Perl_croak_nocontext(PL_memory_wrap);
9469 need = (have > width ? have : width);
9472 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9473 Perl_croak_nocontext(PL_memory_wrap);
9474 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9476 if (esignlen && fill == '0') {
9478 for (i = 0; i < (int)esignlen; i++)
9482 memset(p, fill, gap);
9485 if (esignlen && fill != '0') {
9487 for (i = 0; i < (int)esignlen; i++)
9492 for (i = zeros; i; i--)
9496 Copy(eptr, p, elen, char);
9500 memset(p, ' ', gap);
9505 Copy(dotstr, p, dotstrlen, char);
9509 vectorize = FALSE; /* done iterating over vecstr */
9516 SvCUR_set(sv, p - SvPVX_const(sv));
9524 /* =========================================================================
9526 =head1 Cloning an interpreter
9528 All the macros and functions in this section are for the private use of
9529 the main function, perl_clone().
9531 The foo_dup() functions make an exact copy of an existing foo thingy.
9532 During the course of a cloning, a hash table is used to map old addresses
9533 to new addresses. The table is created and manipulated with the
9534 ptr_table_* functions.
9538 ============================================================================*/
9541 #if defined(USE_ITHREADS)
9543 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9544 #ifndef GpREFCNT_inc
9545 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9549 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9550 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9551 If this changes, please unmerge ss_dup. */
9552 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9553 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9554 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9555 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9556 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9557 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9558 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9559 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9560 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9561 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9562 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9563 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9564 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9565 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9567 /* clone a parser */
9570 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9577 /* look for it in the table first */
9578 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9582 /* create anew and remember what it is */
9583 Newxz(parser, 1, yy_parser);
9584 ptr_table_store(PL_ptr_table, proto, parser);
9586 parser->yyerrstatus = 0;
9587 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9589 /* XXX these not yet duped */
9590 parser->old_parser = NULL;
9591 parser->stack = NULL;
9593 parser->stack_size = 0;
9594 /* XXX parser->stack->state = 0; */
9596 /* XXX eventually, just Copy() most of the parser struct ? */
9598 parser->lex_brackets = proto->lex_brackets;
9599 parser->lex_casemods = proto->lex_casemods;
9600 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9601 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9602 parser->lex_casestack = savepvn(proto->lex_casestack,
9603 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9604 parser->lex_defer = proto->lex_defer;
9605 parser->lex_dojoin = proto->lex_dojoin;
9606 parser->lex_expect = proto->lex_expect;
9607 parser->lex_formbrack = proto->lex_formbrack;
9608 parser->lex_inpat = proto->lex_inpat;
9609 parser->lex_inwhat = proto->lex_inwhat;
9610 parser->lex_op = proto->lex_op;
9611 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9612 parser->lex_starts = proto->lex_starts;
9613 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9614 parser->multi_close = proto->multi_close;
9615 parser->multi_open = proto->multi_open;
9616 parser->multi_start = proto->multi_start;
9617 parser->multi_end = proto->multi_end;
9618 parser->pending_ident = proto->pending_ident;
9619 parser->preambled = proto->preambled;
9620 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9621 parser->linestr = sv_dup_inc(proto->linestr, param);
9622 parser->expect = proto->expect;
9623 parser->copline = proto->copline;
9624 parser->last_lop_op = proto->last_lop_op;
9625 parser->lex_state = proto->lex_state;
9626 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9627 /* rsfp_filters entries have fake IoDIRP() */
9628 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9629 parser->in_my = proto->in_my;
9630 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9631 parser->error_count = proto->error_count;
9634 parser->linestr = sv_dup_inc(proto->linestr, param);
9637 char * const ols = SvPVX(proto->linestr);
9638 char * const ls = SvPVX(parser->linestr);
9640 parser->bufptr = ls + (proto->bufptr >= ols ?
9641 proto->bufptr - ols : 0);
9642 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9643 proto->oldbufptr - ols : 0);
9644 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9645 proto->oldoldbufptr - ols : 0);
9646 parser->linestart = ls + (proto->linestart >= ols ?
9647 proto->linestart - ols : 0);
9648 parser->last_uni = ls + (proto->last_uni >= ols ?
9649 proto->last_uni - ols : 0);
9650 parser->last_lop = ls + (proto->last_lop >= ols ?
9651 proto->last_lop - ols : 0);
9653 parser->bufend = ls + SvCUR(parser->linestr);
9656 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9660 parser->endwhite = proto->endwhite;
9661 parser->faketokens = proto->faketokens;
9662 parser->lasttoke = proto->lasttoke;
9663 parser->nextwhite = proto->nextwhite;
9664 parser->realtokenstart = proto->realtokenstart;
9665 parser->skipwhite = proto->skipwhite;
9666 parser->thisclose = proto->thisclose;
9667 parser->thismad = proto->thismad;
9668 parser->thisopen = proto->thisopen;
9669 parser->thisstuff = proto->thisstuff;
9670 parser->thistoken = proto->thistoken;
9671 parser->thiswhite = proto->thiswhite;
9673 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9674 parser->curforce = proto->curforce;
9676 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9677 Copy(proto->nexttype, parser->nexttype, 5, I32);
9678 parser->nexttoke = proto->nexttoke;
9684 /* duplicate a file handle */
9687 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9691 PERL_UNUSED_ARG(type);
9694 return (PerlIO*)NULL;
9696 /* look for it in the table first */
9697 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9701 /* create anew and remember what it is */
9702 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9703 ptr_table_store(PL_ptr_table, fp, ret);
9707 /* duplicate a directory handle */
9710 Perl_dirp_dup(pTHX_ DIR *dp)
9712 PERL_UNUSED_CONTEXT;
9719 /* duplicate a typeglob */
9722 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9728 /* look for it in the table first */
9729 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9733 /* create anew and remember what it is */
9735 ptr_table_store(PL_ptr_table, gp, ret);
9738 ret->gp_refcnt = 0; /* must be before any other dups! */
9739 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9740 ret->gp_io = io_dup_inc(gp->gp_io, param);
9741 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9742 ret->gp_av = av_dup_inc(gp->gp_av, param);
9743 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9744 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9745 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9746 ret->gp_cvgen = gp->gp_cvgen;
9747 ret->gp_line = gp->gp_line;
9748 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9752 /* duplicate a chain of magic */
9755 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9757 MAGIC *mgprev = (MAGIC*)NULL;
9760 return (MAGIC*)NULL;
9761 /* look for it in the table first */
9762 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9766 for (; mg; mg = mg->mg_moremagic) {
9768 Newxz(nmg, 1, MAGIC);
9770 mgprev->mg_moremagic = nmg;
9773 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9774 nmg->mg_private = mg->mg_private;
9775 nmg->mg_type = mg->mg_type;
9776 nmg->mg_flags = mg->mg_flags;
9777 if (mg->mg_type == PERL_MAGIC_qr) {
9778 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9780 else if(mg->mg_type == PERL_MAGIC_backref) {
9781 /* The backref AV has its reference count deliberately bumped by
9783 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9786 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9787 ? sv_dup_inc(mg->mg_obj, param)
9788 : sv_dup(mg->mg_obj, param);
9790 nmg->mg_len = mg->mg_len;
9791 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9792 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9793 if (mg->mg_len > 0) {
9794 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9795 if (mg->mg_type == PERL_MAGIC_overload_table &&
9796 AMT_AMAGIC((AMT*)mg->mg_ptr))
9798 const AMT * const amtp = (AMT*)mg->mg_ptr;
9799 AMT * const namtp = (AMT*)nmg->mg_ptr;
9801 for (i = 1; i < NofAMmeth; i++) {
9802 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9806 else if (mg->mg_len == HEf_SVKEY)
9807 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9809 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9810 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9817 #endif /* USE_ITHREADS */
9819 /* create a new pointer-mapping table */
9822 Perl_ptr_table_new(pTHX)
9825 PERL_UNUSED_CONTEXT;
9827 Newxz(tbl, 1, PTR_TBL_t);
9830 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9834 #define PTR_TABLE_HASH(ptr) \
9835 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9838 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9839 following define) and at call to new_body_inline made below in
9840 Perl_ptr_table_store()
9843 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9845 /* map an existing pointer using a table */
9847 STATIC PTR_TBL_ENT_t *
9848 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9849 PTR_TBL_ENT_t *tblent;
9850 const UV hash = PTR_TABLE_HASH(sv);
9852 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9853 for (; tblent; tblent = tblent->next) {
9854 if (tblent->oldval == sv)
9861 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9863 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9864 PERL_UNUSED_CONTEXT;
9865 return tblent ? tblent->newval : NULL;
9868 /* add a new entry to a pointer-mapping table */
9871 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9873 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9874 PERL_UNUSED_CONTEXT;
9877 tblent->newval = newsv;
9879 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9881 new_body_inline(tblent, PTE_SVSLOT);
9883 tblent->oldval = oldsv;
9884 tblent->newval = newsv;
9885 tblent->next = tbl->tbl_ary[entry];
9886 tbl->tbl_ary[entry] = tblent;
9888 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9889 ptr_table_split(tbl);
9893 /* double the hash bucket size of an existing ptr table */
9896 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9898 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9899 const UV oldsize = tbl->tbl_max + 1;
9900 UV newsize = oldsize * 2;
9902 PERL_UNUSED_CONTEXT;
9904 Renew(ary, newsize, PTR_TBL_ENT_t*);
9905 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9906 tbl->tbl_max = --newsize;
9908 for (i=0; i < oldsize; i++, ary++) {
9909 PTR_TBL_ENT_t **curentp, **entp, *ent;
9912 curentp = ary + oldsize;
9913 for (entp = ary, ent = *ary; ent; ent = *entp) {
9914 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9916 ent->next = *curentp;
9926 /* remove all the entries from a ptr table */
9929 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9931 if (tbl && tbl->tbl_items) {
9932 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9933 UV riter = tbl->tbl_max;
9936 PTR_TBL_ENT_t *entry = array[riter];
9939 PTR_TBL_ENT_t * const oentry = entry;
9940 entry = entry->next;
9949 /* clear and free a ptr table */
9952 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9957 ptr_table_clear(tbl);
9958 Safefree(tbl->tbl_ary);
9962 #if defined(USE_ITHREADS)
9965 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9968 SvRV_set(dstr, SvWEAKREF(sstr)
9969 ? sv_dup(SvRV(sstr), param)
9970 : sv_dup_inc(SvRV(sstr), param));
9973 else if (SvPVX_const(sstr)) {
9974 /* Has something there */
9976 /* Normal PV - clone whole allocated space */
9977 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9978 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9979 /* Not that normal - actually sstr is copy on write.
9980 But we are a true, independant SV, so: */
9981 SvREADONLY_off(dstr);
9986 /* Special case - not normally malloced for some reason */
9987 if (isGV_with_GP(sstr)) {
9988 /* Don't need to do anything here. */
9990 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
9991 /* A "shared" PV - clone it as "shared" PV */
9993 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
9997 /* Some other special case - random pointer */
9998 SvPV_set(dstr, SvPVX(sstr));
10003 /* Copy the NULL */
10004 if (SvTYPE(dstr) == SVt_RV)
10005 SvRV_set(dstr, NULL);
10007 SvPV_set(dstr, NULL);
10011 /* duplicate an SV of any type (including AV, HV etc) */
10014 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10019 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10021 /* look for it in the table first */
10022 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10026 if(param->flags & CLONEf_JOIN_IN) {
10027 /** We are joining here so we don't want do clone
10028 something that is bad **/
10029 if (SvTYPE(sstr) == SVt_PVHV) {
10030 const HEK * const hvname = HvNAME_HEK(sstr);
10032 /** don't clone stashes if they already exist **/
10033 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10037 /* create anew and remember what it is */
10040 #ifdef DEBUG_LEAKING_SCALARS
10041 dstr->sv_debug_optype = sstr->sv_debug_optype;
10042 dstr->sv_debug_line = sstr->sv_debug_line;
10043 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10044 dstr->sv_debug_cloned = 1;
10045 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10048 ptr_table_store(PL_ptr_table, sstr, dstr);
10051 SvFLAGS(dstr) = SvFLAGS(sstr);
10052 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10053 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10056 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10057 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10058 (void*)PL_watch_pvx, SvPVX_const(sstr));
10061 /* don't clone objects whose class has asked us not to */
10062 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10067 switch (SvTYPE(sstr)) {
10069 SvANY(dstr) = NULL;
10072 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10073 SvIV_set(dstr, SvIVX(sstr));
10076 SvANY(dstr) = new_XNV();
10077 SvNV_set(dstr, SvNVX(sstr));
10080 SvANY(dstr) = &(dstr->sv_u.svu_rv);
10081 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10083 /* case SVt_BIND: */
10086 /* These are all the types that need complex bodies allocating. */
10088 const svtype sv_type = SvTYPE(sstr);
10089 const struct body_details *const sv_type_details
10090 = bodies_by_type + sv_type;
10094 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10098 if (GvUNIQUE((GV*)sstr)) {
10099 NOOP; /* Do sharing here, and fall through */
10111 assert(sv_type_details->body_size);
10112 if (sv_type_details->arena) {
10113 new_body_inline(new_body, sv_type);
10115 = (void*)((char*)new_body - sv_type_details->offset);
10117 new_body = new_NOARENA(sv_type_details);
10121 SvANY(dstr) = new_body;
10124 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10125 ((char*)SvANY(dstr)) + sv_type_details->offset,
10126 sv_type_details->copy, char);
10128 Copy(((char*)SvANY(sstr)),
10129 ((char*)SvANY(dstr)),
10130 sv_type_details->body_size + sv_type_details->offset, char);
10133 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10134 && !isGV_with_GP(dstr))
10135 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10137 /* The Copy above means that all the source (unduplicated) pointers
10138 are now in the destination. We can check the flags and the
10139 pointers in either, but it's possible that there's less cache
10140 missing by always going for the destination.
10141 FIXME - instrument and check that assumption */
10142 if (sv_type >= SVt_PVMG) {
10143 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10144 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10145 } else if (SvMAGIC(dstr))
10146 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10148 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10151 /* The cast silences a GCC warning about unhandled types. */
10152 switch ((int)sv_type) {
10162 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10163 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10164 LvTARG(dstr) = dstr;
10165 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10166 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10168 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10170 if(isGV_with_GP(sstr)) {
10171 if (GvNAME_HEK(dstr))
10172 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10173 /* Don't call sv_add_backref here as it's going to be
10174 created as part of the magic cloning of the symbol
10176 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10177 at the point of this comment. */
10178 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10179 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10180 (void)GpREFCNT_inc(GvGP(dstr));
10182 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10185 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10186 if (IoOFP(dstr) == IoIFP(sstr))
10187 IoOFP(dstr) = IoIFP(dstr);
10189 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10190 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10191 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10192 /* I have no idea why fake dirp (rsfps)
10193 should be treated differently but otherwise
10194 we end up with leaks -- sky*/
10195 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10196 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10197 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10199 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10200 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10201 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10202 if (IoDIRP(dstr)) {
10203 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10206 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10209 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10210 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10211 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10214 if (AvARRAY((AV*)sstr)) {
10215 SV **dst_ary, **src_ary;
10216 SSize_t items = AvFILLp((AV*)sstr) + 1;
10218 src_ary = AvARRAY((AV*)sstr);
10219 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10220 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10221 AvARRAY((AV*)dstr) = dst_ary;
10222 AvALLOC((AV*)dstr) = dst_ary;
10223 if (AvREAL((AV*)sstr)) {
10224 while (items-- > 0)
10225 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10228 while (items-- > 0)
10229 *dst_ary++ = sv_dup(*src_ary++, param);
10231 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10232 while (items-- > 0) {
10233 *dst_ary++ = &PL_sv_undef;
10237 AvARRAY((AV*)dstr) = NULL;
10238 AvALLOC((AV*)dstr) = (SV**)NULL;
10242 if (HvARRAY((HV*)sstr)) {
10244 const bool sharekeys = !!HvSHAREKEYS(sstr);
10245 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10246 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10248 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10249 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10251 HvARRAY(dstr) = (HE**)darray;
10252 while (i <= sxhv->xhv_max) {
10253 const HE * const source = HvARRAY(sstr)[i];
10254 HvARRAY(dstr)[i] = source
10255 ? he_dup(source, sharekeys, param) : 0;
10260 const struct xpvhv_aux * const saux = HvAUX(sstr);
10261 struct xpvhv_aux * const daux = HvAUX(dstr);
10262 /* This flag isn't copied. */
10263 /* SvOOK_on(hv) attacks the IV flags. */
10264 SvFLAGS(dstr) |= SVf_OOK;
10266 hvname = saux->xhv_name;
10267 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10269 daux->xhv_riter = saux->xhv_riter;
10270 daux->xhv_eiter = saux->xhv_eiter
10271 ? he_dup(saux->xhv_eiter,
10272 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10273 daux->xhv_backreferences =
10274 saux->xhv_backreferences
10275 ? (AV*) SvREFCNT_inc(
10276 sv_dup((SV*)saux->xhv_backreferences, param))
10279 daux->xhv_mro_meta = saux->xhv_mro_meta
10280 ? mro_meta_dup(saux->xhv_mro_meta, param)
10283 /* Record stashes for possible cloning in Perl_clone(). */
10285 av_push(param->stashes, dstr);
10289 HvARRAY((HV*)dstr) = NULL;
10292 if (!(param->flags & CLONEf_COPY_STACKS)) {
10296 /* NOTE: not refcounted */
10297 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10299 if (!CvISXSUB(dstr))
10300 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10302 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10303 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10304 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10305 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10307 /* don't dup if copying back - CvGV isn't refcounted, so the
10308 * duped GV may never be freed. A bit of a hack! DAPM */
10309 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10310 NULL : gv_dup(CvGV(dstr), param) ;
10311 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10313 CvWEAKOUTSIDE(sstr)
10314 ? cv_dup( CvOUTSIDE(dstr), param)
10315 : cv_dup_inc(CvOUTSIDE(dstr), param);
10316 if (!CvISXSUB(dstr))
10317 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10323 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10329 /* duplicate a context */
10332 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10334 PERL_CONTEXT *ncxs;
10337 return (PERL_CONTEXT*)NULL;
10339 /* look for it in the table first */
10340 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10344 /* create anew and remember what it is */
10345 Newxz(ncxs, max + 1, PERL_CONTEXT);
10346 ptr_table_store(PL_ptr_table, cxs, ncxs);
10349 PERL_CONTEXT * const cx = &cxs[ix];
10350 PERL_CONTEXT * const ncx = &ncxs[ix];
10351 ncx->cx_type = cx->cx_type;
10352 if (CxTYPE(cx) == CXt_SUBST) {
10353 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10356 ncx->blk_oldsp = cx->blk_oldsp;
10357 ncx->blk_oldcop = cx->blk_oldcop;
10358 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10359 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10360 ncx->blk_oldpm = cx->blk_oldpm;
10361 ncx->blk_gimme = cx->blk_gimme;
10362 switch (CxTYPE(cx)) {
10364 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10365 ? cv_dup_inc(cx->blk_sub.cv, param)
10366 : cv_dup(cx->blk_sub.cv,param));
10367 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10368 ? av_dup_inc(cx->blk_sub.argarray, param)
10370 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10371 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10372 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10373 ncx->blk_sub.lval = cx->blk_sub.lval;
10374 ncx->blk_sub.retop = cx->blk_sub.retop;
10375 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10376 cx->blk_sub.oldcomppad);
10379 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10380 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10381 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10382 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10383 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10384 ncx->blk_eval.retop = cx->blk_eval.retop;
10387 ncx->blk_loop.label = cx->blk_loop.label;
10388 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10389 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10390 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10391 ? cx->blk_loop.iterdata
10392 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10393 ncx->blk_loop.oldcomppad
10394 = (PAD*)ptr_table_fetch(PL_ptr_table,
10395 cx->blk_loop.oldcomppad);
10396 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10397 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10398 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10399 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10400 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10403 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10404 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10405 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10406 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10407 ncx->blk_sub.retop = cx->blk_sub.retop;
10419 /* duplicate a stack info structure */
10422 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10427 return (PERL_SI*)NULL;
10429 /* look for it in the table first */
10430 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10434 /* create anew and remember what it is */
10435 Newxz(nsi, 1, PERL_SI);
10436 ptr_table_store(PL_ptr_table, si, nsi);
10438 nsi->si_stack = av_dup_inc(si->si_stack, param);
10439 nsi->si_cxix = si->si_cxix;
10440 nsi->si_cxmax = si->si_cxmax;
10441 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10442 nsi->si_type = si->si_type;
10443 nsi->si_prev = si_dup(si->si_prev, param);
10444 nsi->si_next = si_dup(si->si_next, param);
10445 nsi->si_markoff = si->si_markoff;
10450 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10451 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10452 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10453 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10454 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10455 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10456 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10457 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10458 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10459 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10460 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10461 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10462 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10463 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10466 #define pv_dup_inc(p) SAVEPV(p)
10467 #define pv_dup(p) SAVEPV(p)
10468 #define svp_dup_inc(p,pp) any_dup(p,pp)
10470 /* map any object to the new equivent - either something in the
10471 * ptr table, or something in the interpreter structure
10475 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10480 return (void*)NULL;
10482 /* look for it in the table first */
10483 ret = ptr_table_fetch(PL_ptr_table, v);
10487 /* see if it is part of the interpreter structure */
10488 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10489 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10497 /* duplicate the save stack */
10500 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10503 ANY * const ss = proto_perl->Isavestack;
10504 const I32 max = proto_perl->Isavestack_max;
10505 I32 ix = proto_perl->Isavestack_ix;
10518 void (*dptr) (void*);
10519 void (*dxptr) (pTHX_ void*);
10521 Newxz(nss, max, ANY);
10524 const I32 type = POPINT(ss,ix);
10525 TOPINT(nss,ix) = type;
10527 case SAVEt_HELEM: /* hash element */
10528 sv = (SV*)POPPTR(ss,ix);
10529 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10531 case SAVEt_ITEM: /* normal string */
10532 case SAVEt_SV: /* scalar reference */
10533 sv = (SV*)POPPTR(ss,ix);
10534 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10537 case SAVEt_MORTALIZESV:
10538 sv = (SV*)POPPTR(ss,ix);
10539 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10541 case SAVEt_SHARED_PVREF: /* char* in shared space */
10542 c = (char*)POPPTR(ss,ix);
10543 TOPPTR(nss,ix) = savesharedpv(c);
10544 ptr = POPPTR(ss,ix);
10545 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10547 case SAVEt_GENERIC_SVREF: /* generic sv */
10548 case SAVEt_SVREF: /* scalar reference */
10549 sv = (SV*)POPPTR(ss,ix);
10550 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10551 ptr = POPPTR(ss,ix);
10552 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10554 case SAVEt_HV: /* hash reference */
10555 case SAVEt_AV: /* array reference */
10556 sv = (SV*) POPPTR(ss,ix);
10557 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10559 case SAVEt_COMPPAD:
10561 sv = (SV*) POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = sv_dup(sv, param);
10564 case SAVEt_INT: /* int reference */
10565 ptr = POPPTR(ss,ix);
10566 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10567 intval = (int)POPINT(ss,ix);
10568 TOPINT(nss,ix) = intval;
10570 case SAVEt_LONG: /* long reference */
10571 ptr = POPPTR(ss,ix);
10572 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10574 case SAVEt_CLEARSV:
10575 longval = (long)POPLONG(ss,ix);
10576 TOPLONG(nss,ix) = longval;
10578 case SAVEt_I32: /* I32 reference */
10579 case SAVEt_I16: /* I16 reference */
10580 case SAVEt_I8: /* I8 reference */
10581 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10582 ptr = POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10585 TOPINT(nss,ix) = i;
10587 case SAVEt_IV: /* IV reference */
10588 ptr = POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 TOPIV(nss,ix) = iv;
10593 case SAVEt_HPTR: /* HV* reference */
10594 case SAVEt_APTR: /* AV* reference */
10595 case SAVEt_SPTR: /* SV* reference */
10596 ptr = POPPTR(ss,ix);
10597 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10598 sv = (SV*)POPPTR(ss,ix);
10599 TOPPTR(nss,ix) = sv_dup(sv, param);
10601 case SAVEt_VPTR: /* random* reference */
10602 ptr = POPPTR(ss,ix);
10603 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10604 ptr = POPPTR(ss,ix);
10605 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10607 case SAVEt_GENERIC_PVREF: /* generic char* */
10608 case SAVEt_PPTR: /* char* reference */
10609 ptr = POPPTR(ss,ix);
10610 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10611 c = (char*)POPPTR(ss,ix);
10612 TOPPTR(nss,ix) = pv_dup(c);
10614 case SAVEt_GP: /* scalar reference */
10615 gp = (GP*)POPPTR(ss,ix);
10616 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10617 (void)GpREFCNT_inc(gp);
10618 gv = (GV*)POPPTR(ss,ix);
10619 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10622 ptr = POPPTR(ss,ix);
10623 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10624 /* these are assumed to be refcounted properly */
10626 switch (((OP*)ptr)->op_type) {
10628 case OP_LEAVESUBLV:
10632 case OP_LEAVEWRITE:
10633 TOPPTR(nss,ix) = ptr;
10636 (void) OpREFCNT_inc(o);
10640 TOPPTR(nss,ix) = NULL;
10645 TOPPTR(nss,ix) = NULL;
10648 c = (char*)POPPTR(ss,ix);
10649 TOPPTR(nss,ix) = pv_dup_inc(c);
10652 hv = (HV*)POPPTR(ss,ix);
10653 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10654 c = (char*)POPPTR(ss,ix);
10655 TOPPTR(nss,ix) = pv_dup_inc(c);
10657 case SAVEt_STACK_POS: /* Position on Perl stack */
10659 TOPINT(nss,ix) = i;
10661 case SAVEt_DESTRUCTOR:
10662 ptr = POPPTR(ss,ix);
10663 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10664 dptr = POPDPTR(ss,ix);
10665 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10666 any_dup(FPTR2DPTR(void *, dptr),
10669 case SAVEt_DESTRUCTOR_X:
10670 ptr = POPPTR(ss,ix);
10671 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10672 dxptr = POPDXPTR(ss,ix);
10673 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10674 any_dup(FPTR2DPTR(void *, dxptr),
10677 case SAVEt_REGCONTEXT:
10680 TOPINT(nss,ix) = i;
10683 case SAVEt_AELEM: /* array element */
10684 sv = (SV*)POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10687 TOPINT(nss,ix) = i;
10688 av = (AV*)POPPTR(ss,ix);
10689 TOPPTR(nss,ix) = av_dup_inc(av, param);
10692 ptr = POPPTR(ss,ix);
10693 TOPPTR(nss,ix) = ptr;
10697 TOPINT(nss,ix) = i;
10698 ptr = POPPTR(ss,ix);
10701 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10702 HINTS_REFCNT_UNLOCK;
10704 TOPPTR(nss,ix) = ptr;
10705 if (i & HINT_LOCALIZE_HH) {
10706 hv = (HV*)POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10711 longval = (long)POPLONG(ss,ix);
10712 TOPLONG(nss,ix) = longval;
10713 ptr = POPPTR(ss,ix);
10714 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10715 sv = (SV*)POPPTR(ss,ix);
10716 TOPPTR(nss,ix) = sv_dup(sv, param);
10719 ptr = POPPTR(ss,ix);
10720 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10721 longval = (long)POPBOOL(ss,ix);
10722 TOPBOOL(nss,ix) = (bool)longval;
10724 case SAVEt_SET_SVFLAGS:
10726 TOPINT(nss,ix) = i;
10728 TOPINT(nss,ix) = i;
10729 sv = (SV*)POPPTR(ss,ix);
10730 TOPPTR(nss,ix) = sv_dup(sv, param);
10732 case SAVEt_RE_STATE:
10734 const struct re_save_state *const old_state
10735 = (struct re_save_state *)
10736 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10737 struct re_save_state *const new_state
10738 = (struct re_save_state *)
10739 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10741 Copy(old_state, new_state, 1, struct re_save_state);
10742 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10744 new_state->re_state_bostr
10745 = pv_dup(old_state->re_state_bostr);
10746 new_state->re_state_reginput
10747 = pv_dup(old_state->re_state_reginput);
10748 new_state->re_state_regeol
10749 = pv_dup(old_state->re_state_regeol);
10750 new_state->re_state_regoffs
10751 = (regexp_paren_pair*)
10752 any_dup(old_state->re_state_regoffs, proto_perl);
10753 new_state->re_state_reglastparen
10754 = (U32*) any_dup(old_state->re_state_reglastparen,
10756 new_state->re_state_reglastcloseparen
10757 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10759 /* XXX This just has to be broken. The old save_re_context
10760 code did SAVEGENERICPV(PL_reg_start_tmp);
10761 PL_reg_start_tmp is char **.
10762 Look above to what the dup code does for
10763 SAVEt_GENERIC_PVREF
10764 It can never have worked.
10765 So this is merely a faithful copy of the exiting bug: */
10766 new_state->re_state_reg_start_tmp
10767 = (char **) pv_dup((char *)
10768 old_state->re_state_reg_start_tmp);
10769 /* I assume that it only ever "worked" because no-one called
10770 (pseudo)fork while the regexp engine had re-entered itself.
10772 #ifdef PERL_OLD_COPY_ON_WRITE
10773 new_state->re_state_nrs
10774 = sv_dup(old_state->re_state_nrs, param);
10776 new_state->re_state_reg_magic
10777 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10779 new_state->re_state_reg_oldcurpm
10780 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10782 new_state->re_state_reg_curpm
10783 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10785 new_state->re_state_reg_oldsaved
10786 = pv_dup(old_state->re_state_reg_oldsaved);
10787 new_state->re_state_reg_poscache
10788 = pv_dup(old_state->re_state_reg_poscache);
10789 new_state->re_state_reg_starttry
10790 = pv_dup(old_state->re_state_reg_starttry);
10793 case SAVEt_COMPILE_WARNINGS:
10794 ptr = POPPTR(ss,ix);
10795 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10798 ptr = POPPTR(ss,ix);
10799 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10803 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10811 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10812 * flag to the result. This is done for each stash before cloning starts,
10813 * so we know which stashes want their objects cloned */
10816 do_mark_cloneable_stash(pTHX_ SV *sv)
10818 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10820 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10821 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10822 if (cloner && GvCV(cloner)) {
10829 XPUSHs(sv_2mortal(newSVhek(hvname)));
10831 call_sv((SV*)GvCV(cloner), G_SCALAR);
10838 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10846 =for apidoc perl_clone
10848 Create and return a new interpreter by cloning the current one.
10850 perl_clone takes these flags as parameters:
10852 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10853 without it we only clone the data and zero the stacks,
10854 with it we copy the stacks and the new perl interpreter is
10855 ready to run at the exact same point as the previous one.
10856 The pseudo-fork code uses COPY_STACKS while the
10857 threads->create doesn't.
10859 CLONEf_KEEP_PTR_TABLE
10860 perl_clone keeps a ptr_table with the pointer of the old
10861 variable as a key and the new variable as a value,
10862 this allows it to check if something has been cloned and not
10863 clone it again but rather just use the value and increase the
10864 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10865 the ptr_table using the function
10866 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10867 reason to keep it around is if you want to dup some of your own
10868 variable who are outside the graph perl scans, example of this
10869 code is in threads.xs create
10872 This is a win32 thing, it is ignored on unix, it tells perls
10873 win32host code (which is c++) to clone itself, this is needed on
10874 win32 if you want to run two threads at the same time,
10875 if you just want to do some stuff in a separate perl interpreter
10876 and then throw it away and return to the original one,
10877 you don't need to do anything.
10882 /* XXX the above needs expanding by someone who actually understands it ! */
10883 EXTERN_C PerlInterpreter *
10884 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10887 perl_clone(PerlInterpreter *proto_perl, UV flags)
10890 #ifdef PERL_IMPLICIT_SYS
10892 /* perlhost.h so we need to call into it
10893 to clone the host, CPerlHost should have a c interface, sky */
10895 if (flags & CLONEf_CLONE_HOST) {
10896 return perl_clone_host(proto_perl,flags);
10898 return perl_clone_using(proto_perl, flags,
10900 proto_perl->IMemShared,
10901 proto_perl->IMemParse,
10903 proto_perl->IStdIO,
10907 proto_perl->IProc);
10911 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10912 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10913 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10914 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10915 struct IPerlDir* ipD, struct IPerlSock* ipS,
10916 struct IPerlProc* ipP)
10918 /* XXX many of the string copies here can be optimized if they're
10919 * constants; they need to be allocated as common memory and just
10920 * their pointers copied. */
10923 CLONE_PARAMS clone_params;
10924 CLONE_PARAMS* const param = &clone_params;
10926 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10927 /* for each stash, determine whether its objects should be cloned */
10928 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10929 PERL_SET_THX(my_perl);
10932 PoisonNew(my_perl, 1, PerlInterpreter);
10938 PL_savestack_ix = 0;
10939 PL_savestack_max = -1;
10940 PL_sig_pending = 0;
10942 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10943 # else /* !DEBUGGING */
10944 Zero(my_perl, 1, PerlInterpreter);
10945 # endif /* DEBUGGING */
10947 /* host pointers */
10949 PL_MemShared = ipMS;
10950 PL_MemParse = ipMP;
10957 #else /* !PERL_IMPLICIT_SYS */
10959 CLONE_PARAMS clone_params;
10960 CLONE_PARAMS* param = &clone_params;
10961 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10962 /* for each stash, determine whether its objects should be cloned */
10963 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10964 PERL_SET_THX(my_perl);
10967 PoisonNew(my_perl, 1, PerlInterpreter);
10973 PL_savestack_ix = 0;
10974 PL_savestack_max = -1;
10975 PL_sig_pending = 0;
10977 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10978 # else /* !DEBUGGING */
10979 Zero(my_perl, 1, PerlInterpreter);
10980 # endif /* DEBUGGING */
10981 #endif /* PERL_IMPLICIT_SYS */
10982 param->flags = flags;
10983 param->proto_perl = proto_perl;
10985 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
10987 PL_body_arenas = NULL;
10988 Zero(&PL_body_roots, 1, PL_body_roots);
10990 PL_nice_chunk = NULL;
10991 PL_nice_chunk_size = 0;
10993 PL_sv_objcount = 0;
10995 PL_sv_arenaroot = NULL;
10997 PL_debug = proto_perl->Idebug;
10999 PL_hash_seed = proto_perl->Ihash_seed;
11000 PL_rehash_seed = proto_perl->Irehash_seed;
11002 #ifdef USE_REENTRANT_API
11003 /* XXX: things like -Dm will segfault here in perlio, but doing
11004 * PERL_SET_CONTEXT(proto_perl);
11005 * breaks too many other things
11007 Perl_reentrant_init(aTHX);
11010 /* create SV map for pointer relocation */
11011 PL_ptr_table = ptr_table_new();
11013 /* initialize these special pointers as early as possible */
11014 SvANY(&PL_sv_undef) = NULL;
11015 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11016 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11017 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11019 SvANY(&PL_sv_no) = new_XPVNV();
11020 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11021 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11022 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11023 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11024 SvCUR_set(&PL_sv_no, 0);
11025 SvLEN_set(&PL_sv_no, 1);
11026 SvIV_set(&PL_sv_no, 0);
11027 SvNV_set(&PL_sv_no, 0);
11028 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11030 SvANY(&PL_sv_yes) = new_XPVNV();
11031 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11032 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11033 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11034 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11035 SvCUR_set(&PL_sv_yes, 1);
11036 SvLEN_set(&PL_sv_yes, 2);
11037 SvIV_set(&PL_sv_yes, 1);
11038 SvNV_set(&PL_sv_yes, 1);
11039 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11041 /* create (a non-shared!) shared string table */
11042 PL_strtab = newHV();
11043 HvSHAREKEYS_off(PL_strtab);
11044 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11045 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11047 PL_compiling = proto_perl->Icompiling;
11049 /* These two PVs will be free'd special way so must set them same way op.c does */
11050 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11051 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11053 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11054 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11056 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11057 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11058 if (PL_compiling.cop_hints_hash) {
11060 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11061 HINTS_REFCNT_UNLOCK;
11063 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11064 #ifdef PERL_DEBUG_READONLY_OPS
11069 /* pseudo environmental stuff */
11070 PL_origargc = proto_perl->Iorigargc;
11071 PL_origargv = proto_perl->Iorigargv;
11073 param->stashes = newAV(); /* Setup array of objects to call clone on */
11075 /* Set tainting stuff before PerlIO_debug can possibly get called */
11076 PL_tainting = proto_perl->Itainting;
11077 PL_taint_warn = proto_perl->Itaint_warn;
11079 #ifdef PERLIO_LAYERS
11080 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11081 PerlIO_clone(aTHX_ proto_perl, param);
11084 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11085 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11086 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11087 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11088 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11089 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11092 PL_minus_c = proto_perl->Iminus_c;
11093 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11094 PL_localpatches = proto_perl->Ilocalpatches;
11095 PL_splitstr = proto_perl->Isplitstr;
11096 PL_preprocess = proto_perl->Ipreprocess;
11097 PL_minus_n = proto_perl->Iminus_n;
11098 PL_minus_p = proto_perl->Iminus_p;
11099 PL_minus_l = proto_perl->Iminus_l;
11100 PL_minus_a = proto_perl->Iminus_a;
11101 PL_minus_E = proto_perl->Iminus_E;
11102 PL_minus_F = proto_perl->Iminus_F;
11103 PL_doswitches = proto_perl->Idoswitches;
11104 PL_dowarn = proto_perl->Idowarn;
11105 PL_doextract = proto_perl->Idoextract;
11106 PL_sawampersand = proto_perl->Isawampersand;
11107 PL_unsafe = proto_perl->Iunsafe;
11108 PL_inplace = SAVEPV(proto_perl->Iinplace);
11109 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11110 PL_perldb = proto_perl->Iperldb;
11111 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11112 PL_exit_flags = proto_perl->Iexit_flags;
11114 /* magical thingies */
11115 /* XXX time(&PL_basetime) when asked for? */
11116 PL_basetime = proto_perl->Ibasetime;
11117 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11119 PL_maxsysfd = proto_perl->Imaxsysfd;
11120 PL_statusvalue = proto_perl->Istatusvalue;
11122 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11124 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11126 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11128 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11129 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11130 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11133 /* RE engine related */
11134 Zero(&PL_reg_state, 1, struct re_save_state);
11135 PL_reginterp_cnt = 0;
11136 PL_regmatch_slab = NULL;
11138 /* Clone the regex array */
11139 PL_regex_padav = newAV();
11141 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11142 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11144 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11145 for(i = 1; i <= len; i++) {
11146 const SV * const regex = regexen[i];
11149 ? sv_dup_inc(regex, param)
11151 newSViv(PTR2IV(CALLREGDUPE(
11152 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11154 if (SvFLAGS(regex) & SVf_BREAK)
11155 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11156 av_push(PL_regex_padav, sv);
11159 PL_regex_pad = AvARRAY(PL_regex_padav);
11161 /* shortcuts to various I/O objects */
11162 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11163 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11164 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11165 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11166 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11167 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11169 /* shortcuts to regexp stuff */
11170 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11172 /* shortcuts to misc objects */
11173 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11175 /* shortcuts to debugging objects */
11176 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11177 PL_DBline = gv_dup(proto_perl->IDBline, param);
11178 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11179 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11180 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11181 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11182 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11184 /* symbol tables */
11185 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11186 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11187 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11188 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11189 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11191 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11192 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11193 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11194 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11195 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11196 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11197 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11198 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11200 PL_sub_generation = proto_perl->Isub_generation;
11201 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11203 /* funky return mechanisms */
11204 PL_forkprocess = proto_perl->Iforkprocess;
11206 /* subprocess state */
11207 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11209 /* internal state */
11210 PL_maxo = proto_perl->Imaxo;
11211 if (proto_perl->Iop_mask)
11212 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11215 /* PL_asserting = proto_perl->Iasserting; */
11217 /* current interpreter roots */
11218 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11220 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11222 PL_main_start = proto_perl->Imain_start;
11223 PL_eval_root = proto_perl->Ieval_root;
11224 PL_eval_start = proto_perl->Ieval_start;
11226 /* runtime control stuff */
11227 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11229 PL_filemode = proto_perl->Ifilemode;
11230 PL_lastfd = proto_perl->Ilastfd;
11231 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11234 PL_gensym = proto_perl->Igensym;
11235 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11236 PL_laststatval = proto_perl->Ilaststatval;
11237 PL_laststype = proto_perl->Ilaststype;
11240 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11242 /* interpreter atexit processing */
11243 PL_exitlistlen = proto_perl->Iexitlistlen;
11244 if (PL_exitlistlen) {
11245 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11246 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11249 PL_exitlist = (PerlExitListEntry*)NULL;
11251 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11252 if (PL_my_cxt_size) {
11253 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11254 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11255 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11256 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11257 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11261 PL_my_cxt_list = (void**)NULL;
11262 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11263 PL_my_cxt_keys = (const char**)NULL;
11266 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11267 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11268 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11270 PL_profiledata = NULL;
11272 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11274 PAD_CLONE_VARS(proto_perl, param);
11276 #ifdef HAVE_INTERP_INTERN
11277 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11280 /* more statics moved here */
11281 PL_generation = proto_perl->Igeneration;
11282 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11284 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11285 PL_in_clean_all = proto_perl->Iin_clean_all;
11287 PL_uid = proto_perl->Iuid;
11288 PL_euid = proto_perl->Ieuid;
11289 PL_gid = proto_perl->Igid;
11290 PL_egid = proto_perl->Iegid;
11291 PL_nomemok = proto_perl->Inomemok;
11292 PL_an = proto_perl->Ian;
11293 PL_evalseq = proto_perl->Ievalseq;
11294 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11295 PL_origalen = proto_perl->Iorigalen;
11296 #ifdef PERL_USES_PL_PIDSTATUS
11297 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11299 PL_osname = SAVEPV(proto_perl->Iosname);
11300 PL_sighandlerp = proto_perl->Isighandlerp;
11302 PL_runops = proto_perl->Irunops;
11304 PL_parser = parser_dup(proto_perl->Iparser, param);
11306 PL_subline = proto_perl->Isubline;
11307 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11310 PL_cryptseen = proto_perl->Icryptseen;
11313 PL_hints = proto_perl->Ihints;
11315 PL_amagic_generation = proto_perl->Iamagic_generation;
11317 #ifdef USE_LOCALE_COLLATE
11318 PL_collation_ix = proto_perl->Icollation_ix;
11319 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11320 PL_collation_standard = proto_perl->Icollation_standard;
11321 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11322 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11323 #endif /* USE_LOCALE_COLLATE */
11325 #ifdef USE_LOCALE_NUMERIC
11326 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11327 PL_numeric_standard = proto_perl->Inumeric_standard;
11328 PL_numeric_local = proto_perl->Inumeric_local;
11329 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11330 #endif /* !USE_LOCALE_NUMERIC */
11332 /* utf8 character classes */
11333 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11334 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11335 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11336 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11337 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11338 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11339 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11340 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11341 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11342 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11343 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11344 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11345 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11346 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11347 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11348 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11349 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11350 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11351 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11352 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11354 /* Did the locale setup indicate UTF-8? */
11355 PL_utf8locale = proto_perl->Iutf8locale;
11356 /* Unicode features (see perlrun/-C) */
11357 PL_unicode = proto_perl->Iunicode;
11359 /* Pre-5.8 signals control */
11360 PL_signals = proto_perl->Isignals;
11362 /* times() ticks per second */
11363 PL_clocktick = proto_perl->Iclocktick;
11365 /* Recursion stopper for PerlIO_find_layer */
11366 PL_in_load_module = proto_perl->Iin_load_module;
11368 /* sort() routine */
11369 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11371 /* Not really needed/useful since the reenrant_retint is "volatile",
11372 * but do it for consistency's sake. */
11373 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11375 /* Hooks to shared SVs and locks. */
11376 PL_sharehook = proto_perl->Isharehook;
11377 PL_lockhook = proto_perl->Ilockhook;
11378 PL_unlockhook = proto_perl->Iunlockhook;
11379 PL_threadhook = proto_perl->Ithreadhook;
11380 PL_destroyhook = proto_perl->Idestroyhook;
11382 #ifdef THREADS_HAVE_PIDS
11383 PL_ppid = proto_perl->Ippid;
11387 PL_last_swash_hv = NULL; /* reinits on demand */
11388 PL_last_swash_klen = 0;
11389 PL_last_swash_key[0]= '\0';
11390 PL_last_swash_tmps = (U8*)NULL;
11391 PL_last_swash_slen = 0;
11393 PL_glob_index = proto_perl->Iglob_index;
11394 PL_srand_called = proto_perl->Isrand_called;
11395 PL_bitcount = NULL; /* reinits on demand */
11397 if (proto_perl->Ipsig_pend) {
11398 Newxz(PL_psig_pend, SIG_SIZE, int);
11401 PL_psig_pend = (int*)NULL;
11404 if (proto_perl->Ipsig_ptr) {
11405 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11406 Newxz(PL_psig_name, SIG_SIZE, SV*);
11407 for (i = 1; i < SIG_SIZE; i++) {
11408 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11409 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11413 PL_psig_ptr = (SV**)NULL;
11414 PL_psig_name = (SV**)NULL;
11417 /* intrpvar.h stuff */
11419 if (flags & CLONEf_COPY_STACKS) {
11420 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11421 PL_tmps_ix = proto_perl->Itmps_ix;
11422 PL_tmps_max = proto_perl->Itmps_max;
11423 PL_tmps_floor = proto_perl->Itmps_floor;
11424 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11426 while (i <= PL_tmps_ix) {
11427 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11431 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11432 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11433 Newxz(PL_markstack, i, I32);
11434 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11435 - proto_perl->Imarkstack);
11436 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11437 - proto_perl->Imarkstack);
11438 Copy(proto_perl->Imarkstack, PL_markstack,
11439 PL_markstack_ptr - PL_markstack + 1, I32);
11441 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11442 * NOTE: unlike the others! */
11443 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11444 PL_scopestack_max = proto_perl->Iscopestack_max;
11445 Newxz(PL_scopestack, PL_scopestack_max, I32);
11446 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11448 /* NOTE: si_dup() looks at PL_markstack */
11449 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11451 /* PL_curstack = PL_curstackinfo->si_stack; */
11452 PL_curstack = av_dup(proto_perl->Icurstack, param);
11453 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11455 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11456 PL_stack_base = AvARRAY(PL_curstack);
11457 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11458 - proto_perl->Istack_base);
11459 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11461 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11462 * NOTE: unlike the others! */
11463 PL_savestack_ix = proto_perl->Isavestack_ix;
11464 PL_savestack_max = proto_perl->Isavestack_max;
11465 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11466 PL_savestack = ss_dup(proto_perl, param);
11470 ENTER; /* perl_destruct() wants to LEAVE; */
11472 /* although we're not duplicating the tmps stack, we should still
11473 * add entries for any SVs on the tmps stack that got cloned by a
11474 * non-refcount means (eg a temp in @_); otherwise they will be
11477 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11478 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11479 proto_perl->Itmps_stack[i]);
11480 if (nsv && !SvREFCNT(nsv)) {
11482 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11487 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11488 PL_top_env = &PL_start_env;
11490 PL_op = proto_perl->Iop;
11493 PL_Xpv = (XPV*)NULL;
11494 PL_na = proto_perl->Ina;
11496 PL_statbuf = proto_perl->Istatbuf;
11497 PL_statcache = proto_perl->Istatcache;
11498 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11499 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11501 PL_timesbuf = proto_perl->Itimesbuf;
11504 PL_tainted = proto_perl->Itainted;
11505 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11506 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11507 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11508 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11509 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11510 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11511 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11512 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11513 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11515 PL_restartop = proto_perl->Irestartop;
11516 PL_in_eval = proto_perl->Iin_eval;
11517 PL_delaymagic = proto_perl->Idelaymagic;
11518 PL_dirty = proto_perl->Idirty;
11519 PL_localizing = proto_perl->Ilocalizing;
11521 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11522 PL_hv_fetch_ent_mh = NULL;
11523 PL_modcount = proto_perl->Imodcount;
11524 PL_lastgotoprobe = NULL;
11525 PL_dumpindent = proto_perl->Idumpindent;
11527 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11528 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11529 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11530 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11531 PL_efloatbuf = NULL; /* reinits on demand */
11532 PL_efloatsize = 0; /* reinits on demand */
11536 PL_screamfirst = NULL;
11537 PL_screamnext = NULL;
11538 PL_maxscream = -1; /* reinits on demand */
11539 PL_lastscream = NULL;
11542 PL_regdummy = proto_perl->Iregdummy;
11543 PL_colorset = 0; /* reinits PL_colors[] */
11544 /*PL_colors[6] = {0,0,0,0,0,0};*/
11548 /* Pluggable optimizer */
11549 PL_peepp = proto_perl->Ipeepp;
11551 PL_stashcache = newHV();
11553 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11554 proto_perl->Iwatchaddr);
11555 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11556 if (PL_debug && PL_watchaddr) {
11557 PerlIO_printf(Perl_debug_log,
11558 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11559 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11560 PTR2UV(PL_watchok));
11563 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11564 ptr_table_free(PL_ptr_table);
11565 PL_ptr_table = NULL;
11568 /* Call the ->CLONE method, if it exists, for each of the stashes
11569 identified by sv_dup() above.
11571 while(av_len(param->stashes) != -1) {
11572 HV* const stash = (HV*) av_shift(param->stashes);
11573 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11574 if (cloner && GvCV(cloner)) {
11579 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11581 call_sv((SV*)GvCV(cloner), G_DISCARD);
11587 SvREFCNT_dec(param->stashes);
11589 /* orphaned? eg threads->new inside BEGIN or use */
11590 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11591 SvREFCNT_inc_simple_void(PL_compcv);
11592 SAVEFREESV(PL_compcv);
11598 #endif /* USE_ITHREADS */
11601 =head1 Unicode Support
11603 =for apidoc sv_recode_to_utf8
11605 The encoding is assumed to be an Encode object, on entry the PV
11606 of the sv is assumed to be octets in that encoding, and the sv
11607 will be converted into Unicode (and UTF-8).
11609 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11610 is not a reference, nothing is done to the sv. If the encoding is not
11611 an C<Encode::XS> Encoding object, bad things will happen.
11612 (See F<lib/encoding.pm> and L<Encode>).
11614 The PV of the sv is returned.
11619 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11622 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11636 Passing sv_yes is wrong - it needs to be or'ed set of constants
11637 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11638 remove converted chars from source.
11640 Both will default the value - let them.
11642 XPUSHs(&PL_sv_yes);
11645 call_method("decode", G_SCALAR);
11649 s = SvPV_const(uni, len);
11650 if (s != SvPVX_const(sv)) {
11651 SvGROW(sv, len + 1);
11652 Move(s, SvPVX(sv), len + 1, char);
11653 SvCUR_set(sv, len);
11660 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11664 =for apidoc sv_cat_decode
11666 The encoding is assumed to be an Encode object, the PV of the ssv is
11667 assumed to be octets in that encoding and decoding the input starts
11668 from the position which (PV + *offset) pointed to. The dsv will be
11669 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11670 when the string tstr appears in decoding output or the input ends on
11671 the PV of the ssv. The value which the offset points will be modified
11672 to the last input position on the ssv.
11674 Returns TRUE if the terminator was found, else returns FALSE.
11679 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11680 SV *ssv, int *offset, char *tstr, int tlen)
11684 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11695 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11696 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11698 call_method("cat_decode", G_SCALAR);
11700 ret = SvTRUE(TOPs);
11701 *offset = SvIV(offsv);
11707 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11712 /* ---------------------------------------------------------------------
11714 * support functions for report_uninit()
11717 /* the maxiumum size of array or hash where we will scan looking
11718 * for the undefined element that triggered the warning */
11720 #define FUV_MAX_SEARCH_SIZE 1000
11722 /* Look for an entry in the hash whose value has the same SV as val;
11723 * If so, return a mortal copy of the key. */
11726 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11729 register HE **array;
11732 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11733 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11736 array = HvARRAY(hv);
11738 for (i=HvMAX(hv); i>0; i--) {
11739 register HE *entry;
11740 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11741 if (HeVAL(entry) != val)
11743 if ( HeVAL(entry) == &PL_sv_undef ||
11744 HeVAL(entry) == &PL_sv_placeholder)
11748 if (HeKLEN(entry) == HEf_SVKEY)
11749 return sv_mortalcopy(HeKEY_sv(entry));
11750 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11756 /* Look for an entry in the array whose value has the same SV as val;
11757 * If so, return the index, otherwise return -1. */
11760 S_find_array_subscript(pTHX_ AV *av, SV* val)
11763 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11764 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11767 if (val != &PL_sv_undef) {
11768 SV ** const svp = AvARRAY(av);
11771 for (i=AvFILLp(av); i>=0; i--)
11778 /* S_varname(): return the name of a variable, optionally with a subscript.
11779 * If gv is non-zero, use the name of that global, along with gvtype (one
11780 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11781 * targ. Depending on the value of the subscript_type flag, return:
11784 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11785 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11786 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11787 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11790 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11791 SV* keyname, I32 aindex, int subscript_type)
11794 SV * const name = sv_newmortal();
11797 buffer[0] = gvtype;
11800 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11802 gv_fullname4(name, gv, buffer, 0);
11804 if ((unsigned int)SvPVX(name)[1] <= 26) {
11806 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11808 /* Swap the 1 unprintable control character for the 2 byte pretty
11809 version - ie substr($name, 1, 1) = $buffer; */
11810 sv_insert(name, 1, 1, buffer, 2);
11814 CV * const cv = find_runcv(NULL);
11818 if (!cv || !CvPADLIST(cv))
11820 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11821 sv = *av_fetch(av, targ, FALSE);
11822 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11825 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11826 SV * const sv = newSV(0);
11827 *SvPVX(name) = '$';
11828 Perl_sv_catpvf(aTHX_ name, "{%s}",
11829 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11832 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11833 *SvPVX(name) = '$';
11834 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11836 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11837 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11844 =for apidoc find_uninit_var
11846 Find the name of the undefined variable (if any) that caused the operator o
11847 to issue a "Use of uninitialized value" warning.
11848 If match is true, only return a name if it's value matches uninit_sv.
11849 So roughly speaking, if a unary operator (such as OP_COS) generates a
11850 warning, then following the direct child of the op may yield an
11851 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11852 other hand, with OP_ADD there are two branches to follow, so we only print
11853 the variable name if we get an exact match.
11855 The name is returned as a mortal SV.
11857 Assumes that PL_op is the op that originally triggered the error, and that
11858 PL_comppad/PL_curpad points to the currently executing pad.
11864 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11872 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11873 uninit_sv == &PL_sv_placeholder)))
11876 switch (obase->op_type) {
11883 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11884 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11887 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11889 if (pad) { /* @lex, %lex */
11890 sv = PAD_SVl(obase->op_targ);
11894 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11895 /* @global, %global */
11896 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11899 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11901 else /* @{expr}, %{expr} */
11902 return find_uninit_var(cUNOPx(obase)->op_first,
11906 /* attempt to find a match within the aggregate */
11908 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11910 subscript_type = FUV_SUBSCRIPT_HASH;
11913 index = find_array_subscript((AV*)sv, uninit_sv);
11915 subscript_type = FUV_SUBSCRIPT_ARRAY;
11918 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11921 return varname(gv, hash ? '%' : '@', obase->op_targ,
11922 keysv, index, subscript_type);
11926 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11928 return varname(NULL, '$', obase->op_targ,
11929 NULL, 0, FUV_SUBSCRIPT_NONE);
11932 gv = cGVOPx_gv(obase);
11933 if (!gv || (match && GvSV(gv) != uninit_sv))
11935 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11938 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11941 av = (AV*)PAD_SV(obase->op_targ);
11942 if (!av || SvRMAGICAL(av))
11944 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11945 if (!svp || *svp != uninit_sv)
11948 return varname(NULL, '$', obase->op_targ,
11949 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11952 gv = cGVOPx_gv(obase);
11958 if (!av || SvRMAGICAL(av))
11960 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11961 if (!svp || *svp != uninit_sv)
11964 return varname(gv, '$', 0,
11965 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11970 o = cUNOPx(obase)->op_first;
11971 if (!o || o->op_type != OP_NULL ||
11972 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11974 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11978 if (PL_op == obase)
11979 /* $a[uninit_expr] or $h{uninit_expr} */
11980 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
11983 o = cBINOPx(obase)->op_first;
11984 kid = cBINOPx(obase)->op_last;
11986 /* get the av or hv, and optionally the gv */
11988 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
11989 sv = PAD_SV(o->op_targ);
11991 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
11992 && cUNOPo->op_first->op_type == OP_GV)
11994 gv = cGVOPx_gv(cUNOPo->op_first);
11997 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12002 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12003 /* index is constant */
12007 if (obase->op_type == OP_HELEM) {
12008 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12009 if (!he || HeVAL(he) != uninit_sv)
12013 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12014 if (!svp || *svp != uninit_sv)
12018 if (obase->op_type == OP_HELEM)
12019 return varname(gv, '%', o->op_targ,
12020 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12022 return varname(gv, '@', o->op_targ, NULL,
12023 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12026 /* index is an expression;
12027 * attempt to find a match within the aggregate */
12028 if (obase->op_type == OP_HELEM) {
12029 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12031 return varname(gv, '%', o->op_targ,
12032 keysv, 0, FUV_SUBSCRIPT_HASH);
12035 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12037 return varname(gv, '@', o->op_targ,
12038 NULL, index, FUV_SUBSCRIPT_ARRAY);
12043 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12045 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12050 /* only examine RHS */
12051 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12054 o = cUNOPx(obase)->op_first;
12055 if (o->op_type == OP_PUSHMARK)
12058 if (!o->op_sibling) {
12059 /* one-arg version of open is highly magical */
12061 if (o->op_type == OP_GV) { /* open FOO; */
12063 if (match && GvSV(gv) != uninit_sv)
12065 return varname(gv, '$', 0,
12066 NULL, 0, FUV_SUBSCRIPT_NONE);
12068 /* other possibilities not handled are:
12069 * open $x; or open my $x; should return '${*$x}'
12070 * open expr; should return '$'.expr ideally
12076 /* ops where $_ may be an implicit arg */
12080 if ( !(obase->op_flags & OPf_STACKED)) {
12081 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12082 ? PAD_SVl(obase->op_targ)
12085 sv = sv_newmortal();
12086 sv_setpvn(sv, "$_", 2);
12095 /* skip filehandle as it can't produce 'undef' warning */
12096 o = cUNOPx(obase)->op_first;
12097 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12098 o = o->op_sibling->op_sibling;
12104 match = 1; /* XS or custom code could trigger random warnings */
12109 /* XXX tmp hack: these two may call an XS sub, and currently
12110 XS subs don't have a SUB entry on the context stack, so CV and
12111 pad determination goes wrong, and BAD things happen. So, just
12112 don't try to determine the value under those circumstances.
12113 Need a better fix at dome point. DAPM 11/2007 */
12117 /* def-ness of rval pos() is independent of the def-ness of its arg */
12118 if ( !(obase->op_flags & OPf_MOD))
12123 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12124 return sv_2mortal(newSVpvs("${$/}"));
12129 if (!(obase->op_flags & OPf_KIDS))
12131 o = cUNOPx(obase)->op_first;
12137 /* if all except one arg are constant, or have no side-effects,
12138 * or are optimized away, then it's unambiguous */
12140 for (kid=o; kid; kid = kid->op_sibling) {
12142 const OPCODE type = kid->op_type;
12143 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12144 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12145 || (type == OP_PUSHMARK)
12149 if (o2) { /* more than one found */
12156 return find_uninit_var(o2, uninit_sv, match);
12158 /* scan all args */
12160 sv = find_uninit_var(o, uninit_sv, 1);
12172 =for apidoc report_uninit
12174 Print appropriate "Use of uninitialized variable" warning
12180 Perl_report_uninit(pTHX_ SV* uninit_sv)
12184 SV* varname = NULL;
12186 varname = find_uninit_var(PL_op, uninit_sv,0);
12188 sv_insert(varname, 0, 0, " ", 1);
12190 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12191 varname ? SvPV_nolen_const(varname) : "",
12192 " in ", OP_DESC(PL_op));
12195 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12201 * c-indentation-style: bsd
12202 * c-basic-offset: 4
12203 * indent-tabs-mode: t
12206 * ex: set ts=8 sts=4 sw=4 noet: