3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_ORANGE, FALSE, HADNV,
921 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
924 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
925 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
928 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
929 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
931 { sizeof(xpvav_allocated),
932 copy_length(XPVAV, xmg_stash)
933 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
934 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
935 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
937 { sizeof(xpvhv_allocated),
938 copy_length(XPVHV, xmg_stash)
939 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
940 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
941 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
944 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
945 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
946 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
948 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
949 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
950 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
952 /* XPVIO is 84 bytes, fits 48x */
953 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
954 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
957 #define new_body_type(sv_type) \
958 (void *)((char *)S_new_body(aTHX_ sv_type))
960 #define del_body_type(p, sv_type) \
961 del_body(p, &PL_body_roots[sv_type])
964 #define new_body_allocated(sv_type) \
965 (void *)((char *)S_new_body(aTHX_ sv_type) \
966 - bodies_by_type[sv_type].offset)
968 #define del_body_allocated(p, sv_type) \
969 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
972 #define my_safemalloc(s) (void*)safemalloc(s)
973 #define my_safecalloc(s) (void*)safecalloc(s, 1)
974 #define my_safefree(p) safefree((char*)p)
978 #define new_XNV() my_safemalloc(sizeof(XPVNV))
979 #define del_XNV(p) my_safefree(p)
981 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
982 #define del_XPVNV(p) my_safefree(p)
984 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
985 #define del_XPVAV(p) my_safefree(p)
987 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
988 #define del_XPVHV(p) my_safefree(p)
990 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
991 #define del_XPVMG(p) my_safefree(p)
993 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
994 #define del_XPVGV(p) my_safefree(p)
998 #define new_XNV() new_body_type(SVt_NV)
999 #define del_XNV(p) del_body_type(p, SVt_NV)
1001 #define new_XPVNV() new_body_type(SVt_PVNV)
1002 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1004 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1005 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1007 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1008 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1010 #define new_XPVMG() new_body_type(SVt_PVMG)
1011 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1013 #define new_XPVGV() new_body_type(SVt_PVGV)
1014 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1018 /* no arena for you! */
1020 #define new_NOARENA(details) \
1021 my_safemalloc((details)->body_size + (details)->offset)
1022 #define new_NOARENAZ(details) \
1023 my_safecalloc((details)->body_size + (details)->offset)
1026 S_more_bodies (pTHX_ svtype sv_type)
1029 void ** const root = &PL_body_roots[sv_type];
1030 const struct body_details * const bdp = &bodies_by_type[sv_type];
1031 const size_t body_size = bdp->body_size;
1034 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1035 static bool done_sanity_check;
1037 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1038 * variables like done_sanity_check. */
1039 if (!done_sanity_check) {
1040 unsigned int i = SVt_LAST;
1042 done_sanity_check = TRUE;
1045 assert (bodies_by_type[i].type == i);
1049 assert(bdp->arena_size);
1051 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1053 end = start + bdp->arena_size - body_size;
1055 /* computed count doesnt reflect the 1st slot reservation */
1056 DEBUG_m(PerlIO_printf(Perl_debug_log,
1057 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1058 (void*)start, (void*)end,
1059 (int)bdp->arena_size, sv_type, (int)body_size,
1060 (int)bdp->arena_size / (int)body_size));
1062 *root = (void *)start;
1064 while (start < end) {
1065 char * const next = start + body_size;
1066 *(void**) start = (void *)next;
1069 *(void **)start = 0;
1074 /* grab a new thing from the free list, allocating more if necessary.
1075 The inline version is used for speed in hot routines, and the
1076 function using it serves the rest (unless PURIFY).
1078 #define new_body_inline(xpv, sv_type) \
1080 void ** const r3wt = &PL_body_roots[sv_type]; \
1081 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1082 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1083 *(r3wt) = *(void**)(xpv); \
1089 S_new_body(pTHX_ svtype sv_type)
1093 new_body_inline(xpv, sv_type);
1099 static const struct body_details fake_rv =
1100 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1103 =for apidoc sv_upgrade
1105 Upgrade an SV to a more complex form. Generally adds a new body type to the
1106 SV, then copies across as much information as possible from the old body.
1107 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1113 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1118 const svtype old_type = SvTYPE(sv);
1119 const struct body_details *new_type_details;
1120 const struct body_details *old_type_details
1121 = bodies_by_type + old_type;
1122 SV *referant = NULL;
1124 if (new_type != SVt_PV && SvIsCOW(sv)) {
1125 sv_force_normal_flags(sv, 0);
1128 if (old_type == 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
1176 referant = SvRV(sv);
1177 old_type_details = &fake_rv;
1178 if (new_type == SVt_NV)
1179 new_type = SVt_PVNV;
1181 if (new_type < SVt_PVIV) {
1182 new_type = (new_type == SVt_NV)
1183 ? SVt_PVNV : SVt_PVIV;
1188 if (new_type < SVt_PVNV) {
1189 new_type = SVt_PVNV;
1193 assert(new_type > SVt_PV);
1194 assert(SVt_IV < SVt_PV);
1195 assert(SVt_NV < SVt_PV);
1202 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1203 there's no way that it can be safely upgraded, because perl.c
1204 expects to Safefree(SvANY(PL_mess_sv)) */
1205 assert(sv != PL_mess_sv);
1206 /* This flag bit is used to mean other things in other scalar types.
1207 Given that it only has meaning inside the pad, it shouldn't be set
1208 on anything that can get upgraded. */
1209 assert(!SvPAD_TYPED(sv));
1212 if (old_type_details->cant_upgrade)
1213 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1214 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1217 if (old_type > new_type)
1218 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1219 (int)old_type, (int)new_type);
1221 new_type_details = bodies_by_type + new_type;
1223 SvFLAGS(sv) &= ~SVTYPEMASK;
1224 SvFLAGS(sv) |= new_type;
1226 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1227 the return statements above will have triggered. */
1228 assert (new_type != SVt_NULL);
1231 assert(old_type == SVt_NULL);
1232 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1236 assert(old_type == SVt_NULL);
1237 SvANY(sv) = new_XNV();
1242 assert(new_type_details->body_size);
1245 assert(new_type_details->arena);
1246 assert(new_type_details->arena_size);
1247 /* This points to the start of the allocated area. */
1248 new_body_inline(new_body, new_type);
1249 Zero(new_body, new_type_details->body_size, char);
1250 new_body = ((char *)new_body) - new_type_details->offset;
1252 /* We always allocated the full length item with PURIFY. To do this
1253 we fake things so that arena is false for all 16 types.. */
1254 new_body = new_NOARENAZ(new_type_details);
1256 SvANY(sv) = new_body;
1257 if (new_type == SVt_PVAV) {
1261 if (old_type_details->body_size) {
1264 /* It will have been zeroed when the new body was allocated.
1265 Lets not write to it, in case it confuses a write-back
1271 #ifndef NODEFAULT_SHAREKEYS
1272 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1274 HvMAX(sv) = 7; /* (start with 8 buckets) */
1275 if (old_type_details->body_size) {
1278 /* It will have been zeroed when the new body was allocated.
1279 Lets not write to it, in case it confuses a write-back
1284 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1285 The target created by newSVrv also is, and it can have magic.
1286 However, it never has SvPVX set.
1288 if (old_type == SVt_IV) {
1290 } else if (old_type >= SVt_PV) {
1291 assert(SvPVX_const(sv) == 0);
1294 if (old_type >= SVt_PVMG) {
1295 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1296 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1298 sv->sv_u.svu_array = NULL; /* or svu_hash */
1304 /* XXX Is this still needed? Was it ever needed? Surely as there is
1305 no route from NV to PVIV, NOK can never be true */
1306 assert(!SvNOKp(sv));
1318 assert(new_type_details->body_size);
1319 /* We always allocated the full length item with PURIFY. To do this
1320 we fake things so that arena is false for all 16 types.. */
1321 if(new_type_details->arena) {
1322 /* This points to the start of the allocated area. */
1323 new_body_inline(new_body, new_type);
1324 Zero(new_body, new_type_details->body_size, char);
1325 new_body = ((char *)new_body) - new_type_details->offset;
1327 new_body = new_NOARENAZ(new_type_details);
1329 SvANY(sv) = new_body;
1331 if (old_type_details->copy) {
1332 /* There is now the potential for an upgrade from something without
1333 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1334 int offset = old_type_details->offset;
1335 int length = old_type_details->copy;
1337 if (new_type_details->offset > old_type_details->offset) {
1338 const int difference
1339 = new_type_details->offset - old_type_details->offset;
1340 offset += difference;
1341 length -= difference;
1343 assert (length >= 0);
1345 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1349 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1350 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1351 * correct 0.0 for us. Otherwise, if the old body didn't have an
1352 * NV slot, but the new one does, then we need to initialise the
1353 * freshly created NV slot with whatever the correct bit pattern is
1355 if (old_type_details->zero_nv && !new_type_details->zero_nv
1356 && !isGV_with_GP(sv))
1360 if (new_type == SVt_PVIO)
1361 IoPAGE_LEN(sv) = 60;
1362 if (old_type < SVt_PV) {
1363 /* referant will be NULL unless the old type was SVt_IV emulating
1365 sv->sv_u.svu_rv = referant;
1369 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1370 (unsigned long)new_type);
1373 if (old_type_details->arena) {
1374 /* If there was an old body, then we need to free it.
1375 Note that there is an assumption that all bodies of types that
1376 can be upgraded came from arenas. Only the more complex non-
1377 upgradable types are allowed to be directly malloc()ed. */
1379 my_safefree(old_body);
1381 del_body((void*)((char*)old_body + old_type_details->offset),
1382 &PL_body_roots[old_type]);
1388 =for apidoc sv_backoff
1390 Remove any string offset. You should normally use the C<SvOOK_off> macro
1397 Perl_sv_backoff(pTHX_ register SV *sv)
1399 PERL_UNUSED_CONTEXT;
1401 assert(SvTYPE(sv) != SVt_PVHV);
1402 assert(SvTYPE(sv) != SVt_PVAV);
1404 const char * const s = SvPVX_const(sv);
1405 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
1406 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
1408 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1410 SvFLAGS(sv) &= ~SVf_OOK;
1417 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1418 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1419 Use the C<SvGROW> wrapper instead.
1425 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1429 if (PL_madskills && newlen >= 0x100000) {
1430 PerlIO_printf(Perl_debug_log,
1431 "Allocation too large: %"UVxf"\n", (UV)newlen);
1433 #ifdef HAS_64K_LIMIT
1434 if (newlen >= 0x10000) {
1435 PerlIO_printf(Perl_debug_log,
1436 "Allocation too large: %"UVxf"\n", (UV)newlen);
1439 #endif /* HAS_64K_LIMIT */
1442 if (SvTYPE(sv) < SVt_PV) {
1443 sv_upgrade(sv, SVt_PV);
1444 s = SvPVX_mutable(sv);
1446 else if (SvOOK(sv)) { /* pv is offset? */
1448 s = SvPVX_mutable(sv);
1449 if (newlen > SvLEN(sv))
1450 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1451 #ifdef HAS_64K_LIMIT
1452 if (newlen >= 0x10000)
1457 s = SvPVX_mutable(sv);
1459 if (newlen > SvLEN(sv)) { /* need more room? */
1460 newlen = PERL_STRLEN_ROUNDUP(newlen);
1461 if (SvLEN(sv) && s) {
1463 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1469 s = (char*)saferealloc(s, newlen);
1472 s = (char*)safemalloc(newlen);
1473 if (SvPVX_const(sv) && SvCUR(sv)) {
1474 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1478 SvLEN_set(sv, newlen);
1484 =for apidoc sv_setiv
1486 Copies an integer into the given SV, upgrading first if necessary.
1487 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1493 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1496 SV_CHECK_THINKFIRST_COW_DROP(sv);
1497 switch (SvTYPE(sv)) {
1500 sv_upgrade(sv, SVt_IV);
1503 sv_upgrade(sv, SVt_PVIV);
1512 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1516 (void)SvIOK_only(sv); /* validate number */
1522 =for apidoc sv_setiv_mg
1524 Like C<sv_setiv>, but also handles 'set' magic.
1530 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1537 =for apidoc sv_setuv
1539 Copies an unsigned integer into the given SV, upgrading first if necessary.
1540 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1546 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1548 /* With these two if statements:
1549 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1552 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1554 If you wish to remove them, please benchmark to see what the effect is
1556 if (u <= (UV)IV_MAX) {
1557 sv_setiv(sv, (IV)u);
1566 =for apidoc sv_setuv_mg
1568 Like C<sv_setuv>, but also handles 'set' magic.
1574 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1581 =for apidoc sv_setnv
1583 Copies a double into the given SV, upgrading first if necessary.
1584 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1590 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1593 SV_CHECK_THINKFIRST_COW_DROP(sv);
1594 switch (SvTYPE(sv)) {
1597 sv_upgrade(sv, SVt_NV);
1601 sv_upgrade(sv, SVt_PVNV);
1610 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1615 (void)SvNOK_only(sv); /* validate number */
1620 =for apidoc sv_setnv_mg
1622 Like C<sv_setnv>, but also handles 'set' magic.
1628 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1634 /* Print an "isn't numeric" warning, using a cleaned-up,
1635 * printable version of the offending string
1639 S_not_a_number(pTHX_ SV *sv)
1647 dsv = sv_2mortal(newSVpvs(""));
1648 pv = sv_uni_display(dsv, sv, 10, 0);
1651 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1652 /* each *s can expand to 4 chars + "...\0",
1653 i.e. need room for 8 chars */
1655 const char *s = SvPVX_const(sv);
1656 const char * const end = s + SvCUR(sv);
1657 for ( ; s < end && d < limit; s++ ) {
1659 if (ch & 128 && !isPRINT_LC(ch)) {
1668 else if (ch == '\r') {
1672 else if (ch == '\f') {
1676 else if (ch == '\\') {
1680 else if (ch == '\0') {
1684 else if (isPRINT_LC(ch))
1701 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1702 "Argument \"%s\" isn't numeric in %s", pv,
1705 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706 "Argument \"%s\" isn't numeric", pv);
1710 =for apidoc looks_like_number
1712 Test if the content of an SV looks like a number (or is a number).
1713 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1714 non-numeric warning), even if your atof() doesn't grok them.
1720 Perl_looks_like_number(pTHX_ SV *sv)
1722 register const char *sbegin;
1726 sbegin = SvPVX_const(sv);
1729 else if (SvPOKp(sv))
1730 sbegin = SvPV_const(sv, len);
1732 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1733 return grok_number(sbegin, len, NULL);
1737 S_glob_2number(pTHX_ GV * const gv)
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 /* We know that all GVs stringify to something that is not-a-number,
1749 so no need to test that. */
1750 if (ckWARN(WARN_NUMERIC))
1751 not_a_number(buffer);
1752 /* We just want something true to return, so that S_sv_2iuv_common
1753 can tail call us and return true. */
1758 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1760 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1761 SV *const buffer = sv_newmortal();
1763 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1766 gv_efullname3(buffer, gv, "*");
1767 SvFLAGS(gv) |= wasfake;
1769 assert(SvPOK(buffer));
1771 *len = SvCUR(buffer);
1773 return SvPVX(buffer);
1776 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1777 until proven guilty, assume that things are not that bad... */
1782 As 64 bit platforms often have an NV that doesn't preserve all bits of
1783 an IV (an assumption perl has been based on to date) it becomes necessary
1784 to remove the assumption that the NV always carries enough precision to
1785 recreate the IV whenever needed, and that the NV is the canonical form.
1786 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1787 precision as a side effect of conversion (which would lead to insanity
1788 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1789 1) to distinguish between IV/UV/NV slots that have cached a valid
1790 conversion where precision was lost and IV/UV/NV slots that have a
1791 valid conversion which has lost no precision
1792 2) to ensure that if a numeric conversion to one form is requested that
1793 would lose precision, the precise conversion (or differently
1794 imprecise conversion) is also performed and cached, to prevent
1795 requests for different numeric formats on the same SV causing
1796 lossy conversion chains. (lossless conversion chains are perfectly
1801 SvIOKp is true if the IV slot contains a valid value
1802 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1803 SvNOKp is true if the NV slot contains a valid value
1804 SvNOK is true only if the NV value is accurate
1807 while converting from PV to NV, check to see if converting that NV to an
1808 IV(or UV) would lose accuracy over a direct conversion from PV to
1809 IV(or UV). If it would, cache both conversions, return NV, but mark
1810 SV as IOK NOKp (ie not NOK).
1812 While converting from PV to IV, check to see if converting that IV to an
1813 NV would lose accuracy over a direct conversion from PV to NV. If it
1814 would, cache both conversions, flag similarly.
1816 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1817 correctly because if IV & NV were set NV *always* overruled.
1818 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1819 changes - now IV and NV together means that the two are interchangeable:
1820 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1822 The benefit of this is that operations such as pp_add know that if
1823 SvIOK is true for both left and right operands, then integer addition
1824 can be used instead of floating point (for cases where the result won't
1825 overflow). Before, floating point was always used, which could lead to
1826 loss of precision compared with integer addition.
1828 * making IV and NV equal status should make maths accurate on 64 bit
1830 * may speed up maths somewhat if pp_add and friends start to use
1831 integers when possible instead of fp. (Hopefully the overhead in
1832 looking for SvIOK and checking for overflow will not outweigh the
1833 fp to integer speedup)
1834 * will slow down integer operations (callers of SvIV) on "inaccurate"
1835 values, as the change from SvIOK to SvIOKp will cause a call into
1836 sv_2iv each time rather than a macro access direct to the IV slot
1837 * should speed up number->string conversion on integers as IV is
1838 favoured when IV and NV are equally accurate
1840 ####################################################################
1841 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1842 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1843 On the other hand, SvUOK is true iff UV.
1844 ####################################################################
1846 Your mileage will vary depending your CPU's relative fp to integer
1850 #ifndef NV_PRESERVES_UV
1851 # define IS_NUMBER_UNDERFLOW_IV 1
1852 # define IS_NUMBER_UNDERFLOW_UV 2
1853 # define IS_NUMBER_IV_AND_UV 2
1854 # define IS_NUMBER_OVERFLOW_IV 4
1855 # define IS_NUMBER_OVERFLOW_UV 5
1857 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1859 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1861 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1864 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1865 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));
1866 if (SvNVX(sv) < (NV)IV_MIN) {
1867 (void)SvIOKp_on(sv);
1869 SvIV_set(sv, IV_MIN);
1870 return IS_NUMBER_UNDERFLOW_IV;
1872 if (SvNVX(sv) > (NV)UV_MAX) {
1873 (void)SvIOKp_on(sv);
1876 SvUV_set(sv, UV_MAX);
1877 return IS_NUMBER_OVERFLOW_UV;
1879 (void)SvIOKp_on(sv);
1881 /* Can't use strtol etc to convert this string. (See truth table in
1883 if (SvNVX(sv) <= (UV)IV_MAX) {
1884 SvIV_set(sv, I_V(SvNVX(sv)));
1885 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1886 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1888 /* Integer is imprecise. NOK, IOKp */
1890 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1893 SvUV_set(sv, U_V(SvNVX(sv)));
1894 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1895 if (SvUVX(sv) == UV_MAX) {
1896 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1897 possibly be preserved by NV. Hence, it must be overflow.
1899 return IS_NUMBER_OVERFLOW_UV;
1901 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1903 /* Integer is imprecise. NOK, IOKp */
1905 return IS_NUMBER_OVERFLOW_IV;
1907 #endif /* !NV_PRESERVES_UV*/
1910 S_sv_2iuv_common(pTHX_ SV *sv) {
1913 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1914 * without also getting a cached IV/UV from it at the same time
1915 * (ie PV->NV conversion should detect loss of accuracy and cache
1916 * IV or UV at same time to avoid this. */
1917 /* IV-over-UV optimisation - choose to cache IV if possible */
1919 if (SvTYPE(sv) == SVt_NV)
1920 sv_upgrade(sv, SVt_PVNV);
1922 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1923 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1924 certainly cast into the IV range at IV_MAX, whereas the correct
1925 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1927 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1928 if (Perl_isnan(SvNVX(sv))) {
1934 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1935 SvIV_set(sv, I_V(SvNVX(sv)));
1936 if (SvNVX(sv) == (NV) SvIVX(sv)
1937 #ifndef NV_PRESERVES_UV
1938 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1939 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1940 /* Don't flag it as "accurately an integer" if the number
1941 came from a (by definition imprecise) NV operation, and
1942 we're outside the range of NV integer precision */
1945 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1946 DEBUG_c(PerlIO_printf(Perl_debug_log,
1947 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1953 /* IV not precise. No need to convert from PV, as NV
1954 conversion would already have cached IV if it detected
1955 that PV->IV would be better than PV->NV->IV
1956 flags already correct - don't set public IOK. */
1957 DEBUG_c(PerlIO_printf(Perl_debug_log,
1958 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1963 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1964 but the cast (NV)IV_MIN rounds to a the value less (more
1965 negative) than IV_MIN which happens to be equal to SvNVX ??
1966 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1967 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1968 (NV)UVX == NVX are both true, but the values differ. :-(
1969 Hopefully for 2s complement IV_MIN is something like
1970 0x8000000000000000 which will be exact. NWC */
1973 SvUV_set(sv, U_V(SvNVX(sv)));
1975 (SvNVX(sv) == (NV) SvUVX(sv))
1976 #ifndef NV_PRESERVES_UV
1977 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1978 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1979 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1980 /* Don't flag it as "accurately an integer" if the number
1981 came from a (by definition imprecise) NV operation, and
1982 we're outside the range of NV integer precision */
1987 DEBUG_c(PerlIO_printf(Perl_debug_log,
1988 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1994 else if (SvPOKp(sv) && SvLEN(sv)) {
1996 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
1997 /* We want to avoid a possible problem when we cache an IV/ a UV which
1998 may be later translated to an NV, and the resulting NV is not
1999 the same as the direct translation of the initial string
2000 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2001 be careful to ensure that the value with the .456 is around if the
2002 NV value is requested in the future).
2004 This means that if we cache such an IV/a UV, we need to cache the
2005 NV as well. Moreover, we trade speed for space, and do not
2006 cache the NV if we are sure it's not needed.
2009 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2010 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2011 == IS_NUMBER_IN_UV) {
2012 /* It's definitely an integer, only upgrade to PVIV */
2013 if (SvTYPE(sv) < SVt_PVIV)
2014 sv_upgrade(sv, SVt_PVIV);
2016 } else if (SvTYPE(sv) < SVt_PVNV)
2017 sv_upgrade(sv, SVt_PVNV);
2019 /* If NVs preserve UVs then we only use the UV value if we know that
2020 we aren't going to call atof() below. If NVs don't preserve UVs
2021 then the value returned may have more precision than atof() will
2022 return, even though value isn't perfectly accurate. */
2023 if ((numtype & (IS_NUMBER_IN_UV
2024 #ifdef NV_PRESERVES_UV
2027 )) == IS_NUMBER_IN_UV) {
2028 /* This won't turn off the public IOK flag if it was set above */
2029 (void)SvIOKp_on(sv);
2031 if (!(numtype & IS_NUMBER_NEG)) {
2033 if (value <= (UV)IV_MAX) {
2034 SvIV_set(sv, (IV)value);
2036 /* it didn't overflow, and it was positive. */
2037 SvUV_set(sv, value);
2041 /* 2s complement assumption */
2042 if (value <= (UV)IV_MIN) {
2043 SvIV_set(sv, -(IV)value);
2045 /* Too negative for an IV. This is a double upgrade, but
2046 I'm assuming it will be rare. */
2047 if (SvTYPE(sv) < SVt_PVNV)
2048 sv_upgrade(sv, SVt_PVNV);
2052 SvNV_set(sv, -(NV)value);
2053 SvIV_set(sv, IV_MIN);
2057 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2058 will be in the previous block to set the IV slot, and the next
2059 block to set the NV slot. So no else here. */
2061 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2062 != IS_NUMBER_IN_UV) {
2063 /* It wasn't an (integer that doesn't overflow the UV). */
2064 SvNV_set(sv, Atof(SvPVX_const(sv)));
2066 if (! numtype && ckWARN(WARN_NUMERIC))
2069 #if defined(USE_LONG_DOUBLE)
2070 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2071 PTR2UV(sv), SvNVX(sv)));
2073 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2074 PTR2UV(sv), SvNVX(sv)));
2077 #ifdef NV_PRESERVES_UV
2078 (void)SvIOKp_on(sv);
2080 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2081 SvIV_set(sv, I_V(SvNVX(sv)));
2082 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2085 NOOP; /* Integer is imprecise. NOK, IOKp */
2087 /* UV will not work better than IV */
2089 if (SvNVX(sv) > (NV)UV_MAX) {
2091 /* Integer is inaccurate. NOK, IOKp, is UV */
2092 SvUV_set(sv, UV_MAX);
2094 SvUV_set(sv, U_V(SvNVX(sv)));
2095 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2096 NV preservse UV so can do correct comparison. */
2097 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2100 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2105 #else /* NV_PRESERVES_UV */
2106 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2107 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2108 /* The IV/UV slot will have been set from value returned by
2109 grok_number above. The NV slot has just been set using
2112 assert (SvIOKp(sv));
2114 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2115 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2116 /* Small enough to preserve all bits. */
2117 (void)SvIOKp_on(sv);
2119 SvIV_set(sv, I_V(SvNVX(sv)));
2120 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2122 /* Assumption: first non-preserved integer is < IV_MAX,
2123 this NV is in the preserved range, therefore: */
2124 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2126 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);
2130 0 0 already failed to read UV.
2131 0 1 already failed to read UV.
2132 1 0 you won't get here in this case. IV/UV
2133 slot set, public IOK, Atof() unneeded.
2134 1 1 already read UV.
2135 so there's no point in sv_2iuv_non_preserve() attempting
2136 to use atol, strtol, strtoul etc. */
2137 sv_2iuv_non_preserve (sv, numtype);
2140 #endif /* NV_PRESERVES_UV */
2144 if (isGV_with_GP(sv))
2145 return glob_2number((GV *)sv);
2147 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2148 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2151 if (SvTYPE(sv) < SVt_IV)
2152 /* Typically the caller expects that sv_any is not NULL now. */
2153 sv_upgrade(sv, SVt_IV);
2154 /* Return 0 from the caller. */
2161 =for apidoc sv_2iv_flags
2163 Return the integer value of an SV, doing any necessary string
2164 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2165 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2171 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2176 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2177 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2178 cache IVs just in case. In practice it seems that they never
2179 actually anywhere accessible by user Perl code, let alone get used
2180 in anything other than a string context. */
2181 if (flags & SV_GMAGIC)
2186 return I_V(SvNVX(sv));
2188 if (SvPOKp(sv) && SvLEN(sv)) {
2191 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2193 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2194 == IS_NUMBER_IN_UV) {
2195 /* It's definitely an integer */
2196 if (numtype & IS_NUMBER_NEG) {
2197 if (value < (UV)IV_MIN)
2200 if (value < (UV)IV_MAX)
2205 if (ckWARN(WARN_NUMERIC))
2208 return I_V(Atof(SvPVX_const(sv)));
2213 assert(SvTYPE(sv) >= SVt_PVMG);
2214 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2215 } else if (SvTHINKFIRST(sv)) {
2219 SV * const tmpstr=AMG_CALLun(sv,numer);
2220 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2221 return SvIV(tmpstr);
2224 return PTR2IV(SvRV(sv));
2227 sv_force_normal_flags(sv, 0);
2229 if (SvREADONLY(sv) && !SvOK(sv)) {
2230 if (ckWARN(WARN_UNINITIALIZED))
2236 if (S_sv_2iuv_common(aTHX_ sv))
2239 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2240 PTR2UV(sv),SvIVX(sv)));
2241 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2245 =for apidoc sv_2uv_flags
2247 Return the unsigned integer value of an SV, doing any necessary string
2248 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2249 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2255 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2260 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2261 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2262 cache IVs just in case. */
2263 if (flags & SV_GMAGIC)
2268 return U_V(SvNVX(sv));
2269 if (SvPOKp(sv) && SvLEN(sv)) {
2272 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2274 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2275 == IS_NUMBER_IN_UV) {
2276 /* It's definitely an integer */
2277 if (!(numtype & IS_NUMBER_NEG))
2281 if (ckWARN(WARN_NUMERIC))
2284 return U_V(Atof(SvPVX_const(sv)));
2289 assert(SvTYPE(sv) >= SVt_PVMG);
2290 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2291 } else if (SvTHINKFIRST(sv)) {
2295 SV *const tmpstr = AMG_CALLun(sv,numer);
2296 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2297 return SvUV(tmpstr);
2300 return PTR2UV(SvRV(sv));
2303 sv_force_normal_flags(sv, 0);
2305 if (SvREADONLY(sv) && !SvOK(sv)) {
2306 if (ckWARN(WARN_UNINITIALIZED))
2312 if (S_sv_2iuv_common(aTHX_ sv))
2316 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2317 PTR2UV(sv),SvUVX(sv)));
2318 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2324 Return the num value of an SV, doing any necessary string or integer
2325 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2332 Perl_sv_2nv(pTHX_ register SV *sv)
2337 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2338 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2339 cache IVs just in case. */
2343 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2344 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2345 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2347 return Atof(SvPVX_const(sv));
2351 return (NV)SvUVX(sv);
2353 return (NV)SvIVX(sv);
2358 assert(SvTYPE(sv) >= SVt_PVMG);
2359 /* This falls through to the report_uninit near the end of the
2361 } else if (SvTHINKFIRST(sv)) {
2365 SV *const tmpstr = AMG_CALLun(sv,numer);
2366 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2367 return SvNV(tmpstr);
2370 return PTR2NV(SvRV(sv));
2373 sv_force_normal_flags(sv, 0);
2375 if (SvREADONLY(sv) && !SvOK(sv)) {
2376 if (ckWARN(WARN_UNINITIALIZED))
2381 if (SvTYPE(sv) < SVt_NV) {
2382 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2383 sv_upgrade(sv, SVt_NV);
2384 #ifdef USE_LONG_DOUBLE
2386 STORE_NUMERIC_LOCAL_SET_STANDARD();
2387 PerlIO_printf(Perl_debug_log,
2388 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2389 PTR2UV(sv), SvNVX(sv));
2390 RESTORE_NUMERIC_LOCAL();
2394 STORE_NUMERIC_LOCAL_SET_STANDARD();
2395 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2396 PTR2UV(sv), SvNVX(sv));
2397 RESTORE_NUMERIC_LOCAL();
2401 else if (SvTYPE(sv) < SVt_PVNV)
2402 sv_upgrade(sv, SVt_PVNV);
2407 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2408 #ifdef NV_PRESERVES_UV
2411 /* Only set the public NV OK flag if this NV preserves the IV */
2412 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2413 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2414 : (SvIVX(sv) == I_V(SvNVX(sv))))
2420 else if (SvPOKp(sv) && SvLEN(sv)) {
2422 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2423 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2425 #ifdef NV_PRESERVES_UV
2426 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2427 == IS_NUMBER_IN_UV) {
2428 /* It's definitely an integer */
2429 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2431 SvNV_set(sv, Atof(SvPVX_const(sv)));
2434 SvNV_set(sv, Atof(SvPVX_const(sv)));
2435 /* Only set the public NV OK flag if this NV preserves the value in
2436 the PV at least as well as an IV/UV would.
2437 Not sure how to do this 100% reliably. */
2438 /* if that shift count is out of range then Configure's test is
2439 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2441 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2442 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2443 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2444 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2445 /* Can't use strtol etc to convert this string, so don't try.
2446 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2449 /* value has been set. It may not be precise. */
2450 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2451 /* 2s complement assumption for (UV)IV_MIN */
2452 SvNOK_on(sv); /* Integer is too negative. */
2457 if (numtype & IS_NUMBER_NEG) {
2458 SvIV_set(sv, -(IV)value);
2459 } else if (value <= (UV)IV_MAX) {
2460 SvIV_set(sv, (IV)value);
2462 SvUV_set(sv, value);
2466 if (numtype & IS_NUMBER_NOT_INT) {
2467 /* I believe that even if the original PV had decimals,
2468 they are lost beyond the limit of the FP precision.
2469 However, neither is canonical, so both only get p
2470 flags. NWC, 2000/11/25 */
2471 /* Both already have p flags, so do nothing */
2473 const NV nv = SvNVX(sv);
2474 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2475 if (SvIVX(sv) == I_V(nv)) {
2478 /* It had no "." so it must be integer. */
2482 /* between IV_MAX and NV(UV_MAX).
2483 Could be slightly > UV_MAX */
2485 if (numtype & IS_NUMBER_NOT_INT) {
2486 /* UV and NV both imprecise. */
2488 const UV nv_as_uv = U_V(nv);
2490 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2499 #endif /* NV_PRESERVES_UV */
2502 if (isGV_with_GP(sv)) {
2503 glob_2number((GV *)sv);
2507 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2509 assert (SvTYPE(sv) >= SVt_NV);
2510 /* Typically the caller expects that sv_any is not NULL now. */
2511 /* XXX Ilya implies that this is a bug in callers that assume this
2512 and ideally should be fixed. */
2515 #if defined(USE_LONG_DOUBLE)
2517 STORE_NUMERIC_LOCAL_SET_STANDARD();
2518 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2519 PTR2UV(sv), SvNVX(sv));
2520 RESTORE_NUMERIC_LOCAL();
2524 STORE_NUMERIC_LOCAL_SET_STANDARD();
2525 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2526 PTR2UV(sv), SvNVX(sv));
2527 RESTORE_NUMERIC_LOCAL();
2536 Return an SV with the numeric value of the source SV, doing any necessary
2537 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2538 access this function.
2544 Perl_sv_2num(pTHX_ register SV *sv)
2549 SV * const tmpsv = AMG_CALLun(sv,numer);
2550 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2551 return sv_2num(tmpsv);
2553 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2556 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2557 * UV as a string towards the end of buf, and return pointers to start and
2560 * We assume that buf is at least TYPE_CHARS(UV) long.
2564 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2566 char *ptr = buf + TYPE_CHARS(UV);
2567 char * const ebuf = ptr;
2580 *--ptr = '0' + (char)(uv % 10);
2589 =for apidoc sv_2pv_flags
2591 Returns a pointer to the string value of an SV, and sets *lp to its length.
2592 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2594 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2595 usually end up here too.
2601 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2611 if (SvGMAGICAL(sv)) {
2612 if (flags & SV_GMAGIC)
2617 if (flags & SV_MUTABLE_RETURN)
2618 return SvPVX_mutable(sv);
2619 if (flags & SV_CONST_RETURN)
2620 return (char *)SvPVX_const(sv);
2623 if (SvIOKp(sv) || SvNOKp(sv)) {
2624 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2629 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2630 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2632 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2639 #ifdef FIXNEGATIVEZERO
2640 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2646 SvUPGRADE(sv, SVt_PV);
2649 s = SvGROW_mutable(sv, len + 1);
2652 return (char*)memcpy(s, tbuf, len + 1);
2658 assert(SvTYPE(sv) >= SVt_PVMG);
2659 /* This falls through to the report_uninit near the end of the
2661 } else if (SvTHINKFIRST(sv)) {
2665 SV *const tmpstr = AMG_CALLun(sv,string);
2666 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2668 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2672 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2673 if (flags & SV_CONST_RETURN) {
2674 pv = (char *) SvPVX_const(tmpstr);
2676 pv = (flags & SV_MUTABLE_RETURN)
2677 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2680 *lp = SvCUR(tmpstr);
2682 pv = sv_2pv_flags(tmpstr, lp, flags);
2696 const SV *const referent = (SV*)SvRV(sv);
2700 retval = buffer = savepvn("NULLREF", len);
2701 } else if (SvTYPE(referent) == SVt_ORANGE
2702 && ((SvFLAGS(referent) &
2703 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
2704 == (SVs_OBJECT|SVs_SMG))
2705 && (mg = mg_find(referent, PERL_MAGIC_qr)))
2710 (str) = CALLREG_AS_STR(mg,lp,&flags,&haseval);
2715 PL_reginterp_cnt += haseval;
2718 const char *const typestr = sv_reftype(referent, 0);
2719 const STRLEN typelen = strlen(typestr);
2720 UV addr = PTR2UV(referent);
2721 const char *stashname = NULL;
2722 STRLEN stashnamelen = 0; /* hush, gcc */
2723 const char *buffer_end;
2725 if (SvOBJECT(referent)) {
2726 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2729 stashname = HEK_KEY(name);
2730 stashnamelen = HEK_LEN(name);
2732 if (HEK_UTF8(name)) {
2738 stashname = "__ANON__";
2741 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2742 + 2 * sizeof(UV) + 2 /* )\0 */;
2744 len = typelen + 3 /* (0x */
2745 + 2 * sizeof(UV) + 2 /* )\0 */;
2748 Newx(buffer, len, char);
2749 buffer_end = retval = buffer + len;
2751 /* Working backwards */
2755 *--retval = PL_hexdigit[addr & 15];
2756 } while (addr >>= 4);
2762 memcpy(retval, typestr, typelen);
2766 retval -= stashnamelen;
2767 memcpy(retval, stashname, stashnamelen);
2769 /* retval may not neccesarily have reached the start of the
2771 assert (retval >= buffer);
2773 len = buffer_end - retval - 1; /* -1 for that \0 */
2781 if (SvREADONLY(sv) && !SvOK(sv)) {
2782 if (ckWARN(WARN_UNINITIALIZED))
2789 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2790 /* I'm assuming that if both IV and NV are equally valid then
2791 converting the IV is going to be more efficient */
2792 const U32 isUIOK = SvIsUV(sv);
2793 char buf[TYPE_CHARS(UV)];
2797 if (SvTYPE(sv) < SVt_PVIV)
2798 sv_upgrade(sv, SVt_PVIV);
2799 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2801 /* inlined from sv_setpvn */
2802 s = SvGROW_mutable(sv, len + 1);
2803 Move(ptr, s, len, char);
2807 else if (SvNOKp(sv)) {
2808 const int olderrno = errno;
2809 if (SvTYPE(sv) < SVt_PVNV)
2810 sv_upgrade(sv, SVt_PVNV);
2811 /* The +20 is pure guesswork. Configure test needed. --jhi */
2812 s = SvGROW_mutable(sv, NV_DIG + 20);
2813 /* some Xenix systems wipe out errno here */
2815 if (SvNVX(sv) == 0.0)
2816 my_strlcpy(s, "0", SvLEN(sv));
2820 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2823 #ifdef FIXNEGATIVEZERO
2824 if (*s == '-' && s[1] == '0' && !s[2]) {
2836 if (isGV_with_GP(sv))
2837 return glob_2pv((GV *)sv, lp);
2839 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2843 if (SvTYPE(sv) < SVt_PV)
2844 /* Typically the caller expects that sv_any is not NULL now. */
2845 sv_upgrade(sv, SVt_PV);
2849 const STRLEN len = s - SvPVX_const(sv);
2855 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2856 PTR2UV(sv),SvPVX_const(sv)));
2857 if (flags & SV_CONST_RETURN)
2858 return (char *)SvPVX_const(sv);
2859 if (flags & SV_MUTABLE_RETURN)
2860 return SvPVX_mutable(sv);
2865 =for apidoc sv_copypv
2867 Copies a stringified representation of the source SV into the
2868 destination SV. Automatically performs any necessary mg_get and
2869 coercion of numeric values into strings. Guaranteed to preserve
2870 UTF8 flag even from overloaded objects. Similar in nature to
2871 sv_2pv[_flags] but operates directly on an SV instead of just the
2872 string. Mostly uses sv_2pv_flags to do its work, except when that
2873 would lose the UTF-8'ness of the PV.
2879 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2882 const char * const s = SvPV_const(ssv,len);
2883 sv_setpvn(dsv,s,len);
2891 =for apidoc sv_2pvbyte
2893 Return a pointer to the byte-encoded representation of the SV, and set *lp
2894 to its length. May cause the SV to be downgraded from UTF-8 as a
2897 Usually accessed via the C<SvPVbyte> macro.
2903 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2905 sv_utf8_downgrade(sv,0);
2906 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2910 =for apidoc sv_2pvutf8
2912 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2913 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2915 Usually accessed via the C<SvPVutf8> macro.
2921 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2923 sv_utf8_upgrade(sv);
2924 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2929 =for apidoc sv_2bool
2931 This function is only called on magical items, and is only used by
2932 sv_true() or its macro equivalent.
2938 Perl_sv_2bool(pTHX_ register SV *sv)
2947 SV * const tmpsv = AMG_CALLun(sv,bool_);
2948 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2949 return (bool)SvTRUE(tmpsv);
2951 return SvRV(sv) != 0;
2954 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2956 (*sv->sv_u.svu_pv > '0' ||
2957 Xpvtmp->xpv_cur > 1 ||
2958 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2965 return SvIVX(sv) != 0;
2968 return SvNVX(sv) != 0.0;
2970 if (isGV_with_GP(sv))
2980 =for apidoc sv_utf8_upgrade
2982 Converts the PV of an SV to its UTF-8-encoded form.
2983 Forces the SV to string form if it is not already.
2984 Always sets the SvUTF8 flag to avoid future validity checks even
2985 if all the bytes have hibit clear.
2987 This is not as a general purpose byte encoding to Unicode interface:
2988 use the Encode extension for that.
2990 =for apidoc sv_utf8_upgrade_flags
2992 Converts the PV of an SV to its UTF-8-encoded form.
2993 Forces the SV to string form if it is not already.
2994 Always sets the SvUTF8 flag to avoid future validity checks even
2995 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2996 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2997 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2999 This is not as a general purpose byte encoding to Unicode interface:
3000 use the Encode extension for that.
3006 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3009 if (sv == &PL_sv_undef)
3013 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3014 (void) sv_2pv_flags(sv,&len, flags);
3018 (void) SvPV_force(sv,len);
3027 sv_force_normal_flags(sv, 0);
3030 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3031 sv_recode_to_utf8(sv, PL_encoding);
3032 else { /* Assume Latin-1/EBCDIC */
3033 /* This function could be much more efficient if we
3034 * had a FLAG in SVs to signal if there are any hibit
3035 * chars in the PV. Given that there isn't such a flag
3036 * make the loop as fast as possible. */
3037 const U8 * const s = (U8 *) SvPVX_const(sv);
3038 const U8 * const e = (U8 *) SvEND(sv);
3043 /* Check for hi bit */
3044 if (!NATIVE_IS_INVARIANT(ch)) {
3045 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3046 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3048 SvPV_free(sv); /* No longer using what was there before. */
3049 SvPV_set(sv, (char*)recoded);
3050 SvCUR_set(sv, len - 1);
3051 SvLEN_set(sv, len); /* No longer know the real size. */
3055 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3062 =for apidoc sv_utf8_downgrade
3064 Attempts to convert the PV of an SV from characters to bytes.
3065 If the PV contains a character beyond byte, this conversion will fail;
3066 in this case, either returns false or, if C<fail_ok> is not
3069 This is not as a general purpose Unicode to byte encoding interface:
3070 use the Encode extension for that.
3076 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3079 if (SvPOKp(sv) && SvUTF8(sv)) {
3085 sv_force_normal_flags(sv, 0);
3087 s = (U8 *) SvPV(sv, len);
3088 if (!utf8_to_bytes(s, &len)) {
3093 Perl_croak(aTHX_ "Wide character in %s",
3096 Perl_croak(aTHX_ "Wide character");
3107 =for apidoc sv_utf8_encode
3109 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3110 flag off so that it looks like octets again.
3116 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3119 sv_force_normal_flags(sv, 0);
3121 if (SvREADONLY(sv)) {
3122 Perl_croak(aTHX_ PL_no_modify);
3124 (void) sv_utf8_upgrade(sv);
3129 =for apidoc sv_utf8_decode
3131 If the PV of the SV is an octet sequence in UTF-8
3132 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3133 so that it looks like a character. If the PV contains only single-byte
3134 characters, the C<SvUTF8> flag stays being off.
3135 Scans PV for validity and returns false if the PV is invalid UTF-8.
3141 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3147 /* The octets may have got themselves encoded - get them back as
3150 if (!sv_utf8_downgrade(sv, TRUE))
3153 /* it is actually just a matter of turning the utf8 flag on, but
3154 * we want to make sure everything inside is valid utf8 first.
3156 c = (const U8 *) SvPVX_const(sv);
3157 if (!is_utf8_string(c, SvCUR(sv)+1))
3159 e = (const U8 *) SvEND(sv);
3162 if (!UTF8_IS_INVARIANT(ch)) {
3172 =for apidoc sv_setsv
3174 Copies the contents of the source SV C<ssv> into the destination SV
3175 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3176 function if the source SV needs to be reused. Does not handle 'set' magic.
3177 Loosely speaking, it performs a copy-by-value, obliterating any previous
3178 content of the destination.
3180 You probably want to use one of the assortment of wrappers, such as
3181 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3182 C<SvSetMagicSV_nosteal>.
3184 =for apidoc sv_setsv_flags
3186 Copies the contents of the source SV C<ssv> into the destination SV
3187 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3188 function if the source SV needs to be reused. Does not handle 'set' magic.
3189 Loosely speaking, it performs a copy-by-value, obliterating any previous
3190 content of the destination.
3191 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3192 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3193 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3194 and C<sv_setsv_nomg> are implemented in terms of this function.
3196 You probably want to use one of the assortment of wrappers, such as
3197 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3198 C<SvSetMagicSV_nosteal>.
3200 This is the primary function for copying scalars, and most other
3201 copy-ish functions and macros use this underneath.
3207 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3209 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3211 if (dtype != SVt_PVGV) {
3212 const char * const name = GvNAME(sstr);
3213 const STRLEN len = GvNAMELEN(sstr);
3215 if (dtype >= SVt_PV) {
3221 SvUPGRADE(dstr, SVt_PVGV);
3222 (void)SvOK_off(dstr);
3223 /* FIXME - why are we doing this, then turning it off and on again
3225 isGV_with_GP_on(dstr);
3227 GvSTASH(dstr) = GvSTASH(sstr);
3229 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3230 gv_name_set((GV *)dstr, name, len, GV_ADD);
3231 SvFAKE_on(dstr); /* can coerce to non-glob */
3234 #ifdef GV_UNIQUE_CHECK
3235 if (GvUNIQUE((GV*)dstr)) {
3236 Perl_croak(aTHX_ PL_no_modify);
3240 if(GvGP((GV*)sstr)) {
3241 /* If source has method cache entry, clear it */
3243 SvREFCNT_dec(GvCV(sstr));
3247 /* If source has a real method, then a method is
3249 else if(GvCV((GV*)sstr)) {
3254 /* If dest already had a real method, that's a change as well */
3255 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3259 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3263 isGV_with_GP_off(dstr);
3264 (void)SvOK_off(dstr);
3265 isGV_with_GP_on(dstr);
3266 GvINTRO_off(dstr); /* one-shot flag */
3267 GvGP(dstr) = gp_ref(GvGP(sstr));
3268 if (SvTAINTED(sstr))
3270 if (GvIMPORTED(dstr) != GVf_IMPORTED
3271 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3273 GvIMPORTED_on(dstr);
3276 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3277 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3282 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3283 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3285 const int intro = GvINTRO(dstr);
3288 const U32 stype = SvTYPE(sref);
3291 #ifdef GV_UNIQUE_CHECK
3292 if (GvUNIQUE((GV*)dstr)) {
3293 Perl_croak(aTHX_ PL_no_modify);
3298 GvINTRO_off(dstr); /* one-shot flag */
3299 GvLINE(dstr) = CopLINE(PL_curcop);
3300 GvEGV(dstr) = (GV*)dstr;
3305 location = (SV **) &GvCV(dstr);
3306 import_flag = GVf_IMPORTED_CV;
3309 location = (SV **) &GvHV(dstr);
3310 import_flag = GVf_IMPORTED_HV;
3313 location = (SV **) &GvAV(dstr);
3314 import_flag = GVf_IMPORTED_AV;
3317 location = (SV **) &GvIOp(dstr);
3320 location = (SV **) &GvFORM(dstr);
3322 location = &GvSV(dstr);
3323 import_flag = GVf_IMPORTED_SV;
3326 if (stype == SVt_PVCV) {
3327 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3328 if (GvCVGEN(dstr)) {
3329 SvREFCNT_dec(GvCV(dstr));
3331 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3334 SAVEGENERICSV(*location);
3338 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3339 CV* const cv = (CV*)*location;
3341 if (!GvCVGEN((GV*)dstr) &&
3342 (CvROOT(cv) || CvXSUB(cv)))
3344 /* Redefining a sub - warning is mandatory if
3345 it was a const and its value changed. */
3346 if (CvCONST(cv) && CvCONST((CV*)sref)
3347 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3349 /* They are 2 constant subroutines generated from
3350 the same constant. This probably means that
3351 they are really the "same" proxy subroutine
3352 instantiated in 2 places. Most likely this is
3353 when a constant is exported twice. Don't warn.
3356 else if (ckWARN(WARN_REDEFINE)
3358 && (!CvCONST((CV*)sref)
3359 || sv_cmp(cv_const_sv(cv),
3360 cv_const_sv((CV*)sref))))) {
3361 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3364 ? "Constant subroutine %s::%s redefined"
3365 : "Subroutine %s::%s redefined"),
3366 HvNAME_get(GvSTASH((GV*)dstr)),
3367 GvENAME((GV*)dstr));
3371 cv_ckproto_len(cv, (GV*)dstr,
3372 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3373 SvPOK(sref) ? SvCUR(sref) : 0);
3375 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3376 GvASSUMECV_on(dstr);
3377 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3380 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3381 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3382 GvFLAGS(dstr) |= import_flag;
3387 if (SvTAINTED(sstr))
3393 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3396 register U32 sflags;
3398 register svtype stype;
3403 if (SvIS_FREED(dstr)) {
3404 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3405 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3407 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3409 sstr = &PL_sv_undef;
3410 if (SvIS_FREED(sstr)) {
3411 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3412 (void*)sstr, (void*)dstr);
3414 stype = SvTYPE(sstr);
3415 dtype = SvTYPE(dstr);
3417 (void)SvAMAGIC_off(dstr);
3420 /* need to nuke the magic */
3422 SvRMAGICAL_off(dstr);
3425 /* There's a lot of redundancy below but we're going for speed here */
3430 if (dtype != SVt_PVGV) {
3431 (void)SvOK_off(dstr);
3439 sv_upgrade(dstr, SVt_IV);
3443 sv_upgrade(dstr, SVt_PVIV);
3446 goto end_of_first_switch;
3448 (void)SvIOK_only(dstr);
3449 SvIV_set(dstr, SvIVX(sstr));
3452 /* SvTAINTED can only be true if the SV has taint magic, which in
3453 turn means that the SV type is PVMG (or greater). This is the
3454 case statement for SVt_IV, so this cannot be true (whatever gcov
3456 assert(!SvTAINTED(sstr));
3461 if (dtype < SVt_PV && dtype != SVt_IV)
3462 sv_upgrade(dstr, SVt_IV);
3470 sv_upgrade(dstr, SVt_NV);
3474 sv_upgrade(dstr, SVt_PVNV);
3477 goto end_of_first_switch;
3479 SvNV_set(dstr, SvNVX(sstr));
3480 (void)SvNOK_only(dstr);
3481 /* SvTAINTED can only be true if the SV has taint magic, which in
3482 turn means that the SV type is PVMG (or greater). This is the
3483 case statement for SVt_NV, so this cannot be true (whatever gcov
3485 assert(!SvTAINTED(sstr));
3491 #ifdef PERL_OLD_COPY_ON_WRITE
3492 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3493 if (dtype < SVt_PVIV)
3494 sv_upgrade(dstr, SVt_PVIV);
3501 sv_upgrade(dstr, SVt_PV);
3504 if (dtype < SVt_PVIV)
3505 sv_upgrade(dstr, SVt_PVIV);
3508 if (dtype < SVt_PVNV)
3509 sv_upgrade(dstr, SVt_PVNV);
3513 const char * const type = sv_reftype(sstr,0);
3515 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3517 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3521 /* case SVt_BIND: */
3524 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3525 glob_assign_glob(dstr, sstr, dtype);
3528 /* SvVALID means that this PVGV is playing at being an FBM. */
3532 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3534 if (SvTYPE(sstr) != stype) {
3535 stype = SvTYPE(sstr);
3536 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3537 glob_assign_glob(dstr, sstr, dtype);
3542 if (stype == SVt_PVLV)
3543 SvUPGRADE(dstr, SVt_PVNV);
3545 SvUPGRADE(dstr, (svtype)stype);
3547 end_of_first_switch:
3549 /* dstr may have been upgraded. */
3550 dtype = SvTYPE(dstr);
3551 sflags = SvFLAGS(sstr);
3553 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3554 /* Assigning to a subroutine sets the prototype. */
3557 const char *const ptr = SvPV_const(sstr, len);
3559 SvGROW(dstr, len + 1);
3560 Copy(ptr, SvPVX(dstr), len + 1, char);
3561 SvCUR_set(dstr, len);
3563 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3567 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3568 const char * const type = sv_reftype(dstr,0);
3570 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3572 Perl_croak(aTHX_ "Cannot copy to %s", type);
3573 } else if (sflags & SVf_ROK) {
3574 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3575 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3578 if (GvIMPORTED(dstr) != GVf_IMPORTED
3579 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3581 GvIMPORTED_on(dstr);
3586 glob_assign_glob(dstr, sstr, dtype);
3590 if (dtype >= SVt_PV) {
3591 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3592 glob_assign_ref(dstr, sstr);
3595 if (SvPVX_const(dstr)) {
3601 (void)SvOK_off(dstr);
3602 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3603 SvFLAGS(dstr) |= sflags & SVf_ROK;
3604 assert(!(sflags & SVp_NOK));
3605 assert(!(sflags & SVp_IOK));
3606 assert(!(sflags & SVf_NOK));
3607 assert(!(sflags & SVf_IOK));
3609 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3610 if (!(sflags & SVf_OK)) {
3611 if (ckWARN(WARN_MISC))
3612 Perl_warner(aTHX_ packWARN(WARN_MISC),
3613 "Undefined value assigned to typeglob");
3616 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3617 if (dstr != (SV*)gv) {
3620 GvGP(dstr) = gp_ref(GvGP(gv));
3624 else if (sflags & SVp_POK) {
3628 * Check to see if we can just swipe the string. If so, it's a
3629 * possible small lose on short strings, but a big win on long ones.
3630 * It might even be a win on short strings if SvPVX_const(dstr)
3631 * has to be allocated and SvPVX_const(sstr) has to be freed.
3632 * Likewise if we can set up COW rather than doing an actual copy, we
3633 * drop to the else clause, as the swipe code and the COW setup code
3634 * have much in common.
3637 /* Whichever path we take through the next code, we want this true,
3638 and doing it now facilitates the COW check. */
3639 (void)SvPOK_only(dstr);
3642 /* If we're already COW then this clause is not true, and if COW
3643 is allowed then we drop down to the else and make dest COW
3644 with us. If caller hasn't said that we're allowed to COW
3645 shared hash keys then we don't do the COW setup, even if the
3646 source scalar is a shared hash key scalar. */
3647 (((flags & SV_COW_SHARED_HASH_KEYS)
3648 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3649 : 1 /* If making a COW copy is forbidden then the behaviour we
3650 desire is as if the source SV isn't actually already
3651 COW, even if it is. So we act as if the source flags
3652 are not COW, rather than actually testing them. */
3654 #ifndef PERL_OLD_COPY_ON_WRITE
3655 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3656 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3657 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3658 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3659 but in turn, it's somewhat dead code, never expected to go
3660 live, but more kept as a placeholder on how to do it better
3661 in a newer implementation. */
3662 /* If we are COW and dstr is a suitable target then we drop down
3663 into the else and make dest a COW of us. */
3664 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3669 (sflags & SVs_TEMP) && /* slated for free anyway? */
3670 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3671 (!(flags & SV_NOSTEAL)) &&
3672 /* and we're allowed to steal temps */
3673 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3674 SvLEN(sstr) && /* and really is a string */
3675 /* and won't be needed again, potentially */
3676 !(PL_op && PL_op->op_type == OP_AASSIGN))
3677 #ifdef PERL_OLD_COPY_ON_WRITE
3678 && ((flags & SV_COW_SHARED_HASH_KEYS)
3679 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3680 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3681 && SvTYPE(sstr) >= SVt_PVIV))
3685 /* Failed the swipe test, and it's not a shared hash key either.
3686 Have to copy the string. */
3687 STRLEN len = SvCUR(sstr);
3688 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3689 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3690 SvCUR_set(dstr, len);
3691 *SvEND(dstr) = '\0';
3693 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3695 /* Either it's a shared hash key, or it's suitable for
3696 copy-on-write or we can swipe the string. */
3698 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3702 #ifdef PERL_OLD_COPY_ON_WRITE
3704 /* I believe I should acquire a global SV mutex if
3705 it's a COW sv (not a shared hash key) to stop
3706 it going un copy-on-write.
3707 If the source SV has gone un copy on write between up there
3708 and down here, then (assert() that) it is of the correct
3709 form to make it copy on write again */
3710 if ((sflags & (SVf_FAKE | SVf_READONLY))
3711 != (SVf_FAKE | SVf_READONLY)) {
3712 SvREADONLY_on(sstr);
3714 /* Make the source SV into a loop of 1.
3715 (about to become 2) */
3716 SV_COW_NEXT_SV_SET(sstr, sstr);
3720 /* Initial code is common. */
3721 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3726 /* making another shared SV. */
3727 STRLEN cur = SvCUR(sstr);
3728 STRLEN len = SvLEN(sstr);
3729 #ifdef PERL_OLD_COPY_ON_WRITE
3731 assert (SvTYPE(dstr) >= SVt_PVIV);
3732 /* SvIsCOW_normal */
3733 /* splice us in between source and next-after-source. */
3734 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3735 SV_COW_NEXT_SV_SET(sstr, dstr);
3736 SvPV_set(dstr, SvPVX_mutable(sstr));
3740 /* SvIsCOW_shared_hash */
3741 DEBUG_C(PerlIO_printf(Perl_debug_log,
3742 "Copy on write: Sharing hash\n"));
3744 assert (SvTYPE(dstr) >= SVt_PV);
3746 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3748 SvLEN_set(dstr, len);
3749 SvCUR_set(dstr, cur);
3750 SvREADONLY_on(dstr);
3752 /* Relesase a global SV mutex. */
3755 { /* Passes the swipe test. */
3756 SvPV_set(dstr, SvPVX_mutable(sstr));
3757 SvLEN_set(dstr, SvLEN(sstr));
3758 SvCUR_set(dstr, SvCUR(sstr));
3761 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3762 SvPV_set(sstr, NULL);
3768 if (sflags & SVp_NOK) {
3769 SvNV_set(dstr, SvNVX(sstr));
3771 if (sflags & SVp_IOK) {
3773 SvIV_set(dstr, SvIVX(sstr));
3774 /* Must do this otherwise some other overloaded use of 0x80000000
3775 gets confused. I guess SVpbm_VALID */
3776 if (sflags & SVf_IVisUV)
3779 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3781 const MAGIC * const smg = SvVSTRING_mg(sstr);
3783 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3784 smg->mg_ptr, smg->mg_len);
3785 SvRMAGICAL_on(dstr);
3789 else if (sflags & (SVp_IOK|SVp_NOK)) {
3790 (void)SvOK_off(dstr);
3791 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3792 if (sflags & SVp_IOK) {
3793 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3794 SvIV_set(dstr, SvIVX(sstr));
3796 if (sflags & SVp_NOK) {
3797 SvNV_set(dstr, SvNVX(sstr));
3801 if (isGV_with_GP(sstr)) {
3802 /* This stringification rule for globs is spread in 3 places.
3803 This feels bad. FIXME. */
3804 const U32 wasfake = sflags & SVf_FAKE;
3806 /* FAKE globs can get coerced, so need to turn this off
3807 temporarily if it is on. */
3809 gv_efullname3(dstr, (GV *)sstr, "*");
3810 SvFLAGS(sstr) |= wasfake;
3813 (void)SvOK_off(dstr);
3815 if (SvTAINTED(sstr))
3820 =for apidoc sv_setsv_mg
3822 Like C<sv_setsv>, but also handles 'set' magic.
3828 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3830 sv_setsv(dstr,sstr);
3834 #ifdef PERL_OLD_COPY_ON_WRITE
3836 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3838 STRLEN cur = SvCUR(sstr);
3839 STRLEN len = SvLEN(sstr);
3840 register char *new_pv;
3843 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3844 (void*)sstr, (void*)dstr);
3851 if (SvTHINKFIRST(dstr))
3852 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3853 else if (SvPVX_const(dstr))
3854 Safefree(SvPVX_const(dstr));
3858 SvUPGRADE(dstr, SVt_PVIV);
3860 assert (SvPOK(sstr));
3861 assert (SvPOKp(sstr));
3862 assert (!SvIOK(sstr));
3863 assert (!SvIOKp(sstr));
3864 assert (!SvNOK(sstr));
3865 assert (!SvNOKp(sstr));
3867 if (SvIsCOW(sstr)) {
3869 if (SvLEN(sstr) == 0) {
3870 /* source is a COW shared hash key. */
3871 DEBUG_C(PerlIO_printf(Perl_debug_log,
3872 "Fast copy on write: Sharing hash\n"));
3873 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3876 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3878 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3879 SvUPGRADE(sstr, SVt_PVIV);
3880 SvREADONLY_on(sstr);
3882 DEBUG_C(PerlIO_printf(Perl_debug_log,
3883 "Fast copy on write: Converting sstr to COW\n"));
3884 SV_COW_NEXT_SV_SET(dstr, sstr);
3886 SV_COW_NEXT_SV_SET(sstr, dstr);
3887 new_pv = SvPVX_mutable(sstr);
3890 SvPV_set(dstr, new_pv);
3891 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3894 SvLEN_set(dstr, len);
3895 SvCUR_set(dstr, cur);
3904 =for apidoc sv_setpvn
3906 Copies a string into an SV. The C<len> parameter indicates the number of
3907 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3908 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3914 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3917 register char *dptr;
3919 SV_CHECK_THINKFIRST_COW_DROP(sv);
3925 /* len is STRLEN which is unsigned, need to copy to signed */
3928 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3930 SvUPGRADE(sv, SVt_PV);
3932 dptr = SvGROW(sv, len + 1);
3933 Move(ptr,dptr,len,char);
3936 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3941 =for apidoc sv_setpvn_mg
3943 Like C<sv_setpvn>, but also handles 'set' magic.
3949 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3951 sv_setpvn(sv,ptr,len);
3956 =for apidoc sv_setpv
3958 Copies a string into an SV. The string must be null-terminated. Does not
3959 handle 'set' magic. See C<sv_setpv_mg>.
3965 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3968 register STRLEN len;
3970 SV_CHECK_THINKFIRST_COW_DROP(sv);
3976 SvUPGRADE(sv, SVt_PV);
3978 SvGROW(sv, len + 1);
3979 Move(ptr,SvPVX(sv),len+1,char);
3981 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3986 =for apidoc sv_setpv_mg
3988 Like C<sv_setpv>, but also handles 'set' magic.
3994 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4001 =for apidoc sv_usepvn_flags
4003 Tells an SV to use C<ptr> to find its string value. Normally the
4004 string is stored inside the SV but sv_usepvn allows the SV to use an
4005 outside string. The C<ptr> should point to memory that was allocated
4006 by C<malloc>. The string length, C<len>, must be supplied. By default
4007 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4008 so that pointer should not be freed or used by the programmer after
4009 giving it to sv_usepvn, and neither should any pointers from "behind"
4010 that pointer (e.g. ptr + 1) be used.
4012 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4013 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4014 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4015 C<len>, and already meets the requirements for storing in C<SvPVX>)
4021 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4025 SV_CHECK_THINKFIRST_COW_DROP(sv);
4026 SvUPGRADE(sv, SVt_PV);
4029 if (flags & SV_SMAGIC)
4033 if (SvPVX_const(sv))
4037 if (flags & SV_HAS_TRAILING_NUL)
4038 assert(ptr[len] == '\0');
4041 allocate = (flags & SV_HAS_TRAILING_NUL)
4042 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4043 if (flags & SV_HAS_TRAILING_NUL) {
4044 /* It's long enough - do nothing.
4045 Specfically Perl_newCONSTSUB is relying on this. */
4048 /* Force a move to shake out bugs in callers. */
4049 char *new_ptr = (char*)safemalloc(allocate);
4050 Copy(ptr, new_ptr, len, char);
4051 PoisonFree(ptr,len,char);
4055 ptr = (char*) saferealloc (ptr, allocate);
4060 SvLEN_set(sv, allocate);
4061 if (!(flags & SV_HAS_TRAILING_NUL)) {
4064 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4066 if (flags & SV_SMAGIC)
4070 #ifdef PERL_OLD_COPY_ON_WRITE
4071 /* Need to do this *after* making the SV normal, as we need the buffer
4072 pointer to remain valid until after we've copied it. If we let go too early,
4073 another thread could invalidate it by unsharing last of the same hash key
4074 (which it can do by means other than releasing copy-on-write Svs)
4075 or by changing the other copy-on-write SVs in the loop. */
4077 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4079 { /* this SV was SvIsCOW_normal(sv) */
4080 /* we need to find the SV pointing to us. */
4081 SV *current = SV_COW_NEXT_SV(after);
4083 if (current == sv) {
4084 /* The SV we point to points back to us (there were only two of us
4086 Hence other SV is no longer copy on write either. */
4088 SvREADONLY_off(after);
4090 /* We need to follow the pointers around the loop. */
4092 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4095 /* don't loop forever if the structure is bust, and we have
4096 a pointer into a closed loop. */
4097 assert (current != after);
4098 assert (SvPVX_const(current) == pvx);
4100 /* Make the SV before us point to the SV after us. */
4101 SV_COW_NEXT_SV_SET(current, after);
4107 =for apidoc sv_force_normal_flags
4109 Undo various types of fakery on an SV: if the PV is a shared string, make
4110 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4111 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4112 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4113 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4114 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4115 set to some other value.) In addition, the C<flags> parameter gets passed to
4116 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4117 with flags set to 0.
4123 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4126 #ifdef PERL_OLD_COPY_ON_WRITE
4127 if (SvREADONLY(sv)) {
4128 /* At this point I believe I should acquire a global SV mutex. */
4130 const char * const pvx = SvPVX_const(sv);
4131 const STRLEN len = SvLEN(sv);
4132 const STRLEN cur = SvCUR(sv);
4133 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4134 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4135 we'll fail an assertion. */
4136 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4139 PerlIO_printf(Perl_debug_log,
4140 "Copy on write: Force normal %ld\n",
4146 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4149 if (flags & SV_COW_DROP_PV) {
4150 /* OK, so we don't need to copy our buffer. */
4153 SvGROW(sv, cur + 1);
4154 Move(pvx,SvPVX(sv),cur,char);
4159 sv_release_COW(sv, pvx, next);
4161 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4167 else if (IN_PERL_RUNTIME)
4168 Perl_croak(aTHX_ PL_no_modify);
4169 /* At this point I believe that I can drop the global SV mutex. */
4172 if (SvREADONLY(sv)) {
4174 const char * const pvx = SvPVX_const(sv);
4175 const STRLEN len = SvCUR(sv);
4180 SvGROW(sv, len + 1);
4181 Move(pvx,SvPVX(sv),len,char);
4183 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4185 else if (IN_PERL_RUNTIME)
4186 Perl_croak(aTHX_ PL_no_modify);
4190 sv_unref_flags(sv, flags);
4191 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4198 Efficient removal of characters from the beginning of the string buffer.
4199 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4200 the string buffer. The C<ptr> becomes the first character of the adjusted
4201 string. Uses the "OOK hack".
4202 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4203 refer to the same chunk of data.
4209 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4211 register STRLEN delta;
4212 if (!ptr || !SvPOKp(sv))
4214 delta = ptr - SvPVX_const(sv);
4215 SV_CHECK_THINKFIRST(sv);
4216 if (SvTYPE(sv) < SVt_PVIV)
4217 sv_upgrade(sv,SVt_PVIV);
4220 if (!SvLEN(sv)) { /* make copy of shared string */
4221 const char *pvx = SvPVX_const(sv);
4222 const STRLEN len = SvCUR(sv);
4223 SvGROW(sv, len + 1);
4224 Move(pvx,SvPVX(sv),len,char);
4228 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4229 and we do that anyway inside the SvNIOK_off
4231 SvFLAGS(sv) |= SVf_OOK;
4234 SvLEN_set(sv, SvLEN(sv) - delta);
4235 SvCUR_set(sv, SvCUR(sv) - delta);
4236 SvPV_set(sv, SvPVX(sv) + delta);
4237 SvIV_set(sv, SvIVX(sv) + delta);
4241 =for apidoc sv_catpvn
4243 Concatenates the string onto the end of the string which is in the SV. The
4244 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4245 status set, then the bytes appended should be valid UTF-8.
4246 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4248 =for apidoc sv_catpvn_flags
4250 Concatenates the string onto the end of the string which is in the SV. The
4251 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4252 status set, then the bytes appended should be valid UTF-8.
4253 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4254 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4255 in terms of this function.
4261 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4265 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4267 SvGROW(dsv, dlen + slen + 1);
4269 sstr = SvPVX_const(dsv);
4270 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4271 SvCUR_set(dsv, SvCUR(dsv) + slen);
4273 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4275 if (flags & SV_SMAGIC)
4280 =for apidoc sv_catsv
4282 Concatenates the string from SV C<ssv> onto the end of the string in
4283 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4284 not 'set' magic. See C<sv_catsv_mg>.
4286 =for apidoc sv_catsv_flags
4288 Concatenates the string from SV C<ssv> onto the end of the string in
4289 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4290 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4291 and C<sv_catsv_nomg> are implemented in terms of this function.
4296 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4301 const char *spv = SvPV_const(ssv, slen);
4303 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4304 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4305 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4306 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4307 dsv->sv_flags doesn't have that bit set.
4308 Andy Dougherty 12 Oct 2001
4310 const I32 sutf8 = DO_UTF8(ssv);
4313 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4315 dutf8 = DO_UTF8(dsv);
4317 if (dutf8 != sutf8) {
4319 /* Not modifying source SV, so taking a temporary copy. */
4320 SV* const csv = sv_2mortal(newSVpvn(spv, slen));
4322 sv_utf8_upgrade(csv);
4323 spv = SvPV_const(csv, slen);
4326 sv_utf8_upgrade_nomg(dsv);
4328 sv_catpvn_nomg(dsv, spv, slen);
4331 if (flags & SV_SMAGIC)
4336 =for apidoc sv_catpv
4338 Concatenates the string onto the end of the string which is in the SV.
4339 If the SV has the UTF-8 status set, then the bytes appended should be
4340 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4345 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4348 register STRLEN len;
4354 junk = SvPV_force(sv, tlen);
4356 SvGROW(sv, tlen + len + 1);
4358 ptr = SvPVX_const(sv);
4359 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4360 SvCUR_set(sv, SvCUR(sv) + len);
4361 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4366 =for apidoc sv_catpv_mg
4368 Like C<sv_catpv>, but also handles 'set' magic.
4374 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4383 Creates a new SV. A non-zero C<len> parameter indicates the number of
4384 bytes of preallocated string space the SV should have. An extra byte for a
4385 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4386 space is allocated.) The reference count for the new SV is set to 1.
4388 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4389 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4390 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4391 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4392 modules supporting older perls.
4398 Perl_newSV(pTHX_ STRLEN len)
4405 sv_upgrade(sv, SVt_PV);
4406 SvGROW(sv, len + 1);
4411 =for apidoc sv_magicext
4413 Adds magic to an SV, upgrading it if necessary. Applies the
4414 supplied vtable and returns a pointer to the magic added.
4416 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4417 In particular, you can add magic to SvREADONLY SVs, and add more than
4418 one instance of the same 'how'.
4420 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4421 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4422 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4423 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4425 (This is now used as a subroutine by C<sv_magic>.)
4430 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4431 const char* name, I32 namlen)
4436 SvUPGRADE(sv, SVt_PVMG);
4437 Newxz(mg, 1, MAGIC);
4438 mg->mg_moremagic = SvMAGIC(sv);
4439 SvMAGIC_set(sv, mg);
4441 /* Sometimes a magic contains a reference loop, where the sv and
4442 object refer to each other. To prevent a reference loop that
4443 would prevent such objects being freed, we look for such loops
4444 and if we find one we avoid incrementing the object refcount.
4446 Note we cannot do this to avoid self-tie loops as intervening RV must
4447 have its REFCNT incremented to keep it in existence.
4450 if (!obj || obj == sv ||
4451 how == PERL_MAGIC_arylen ||
4452 how == PERL_MAGIC_qr ||
4453 how == PERL_MAGIC_symtab ||
4454 (SvTYPE(obj) == SVt_PVGV &&
4455 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4456 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4457 GvFORM(obj) == (CV*)sv)))
4462 mg->mg_obj = SvREFCNT_inc_simple(obj);
4463 mg->mg_flags |= MGf_REFCOUNTED;
4466 /* Normal self-ties simply pass a null object, and instead of
4467 using mg_obj directly, use the SvTIED_obj macro to produce a
4468 new RV as needed. For glob "self-ties", we are tieing the PVIO
4469 with an RV obj pointing to the glob containing the PVIO. In
4470 this case, to avoid a reference loop, we need to weaken the
4474 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4475 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4481 mg->mg_len = namlen;
4484 mg->mg_ptr = savepvn(name, namlen);
4485 else if (namlen == HEf_SVKEY)
4486 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4488 mg->mg_ptr = (char *) name;
4490 mg->mg_virtual = (MGVTBL *) vtable;
4494 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4499 =for apidoc sv_magic
4501 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4502 then adds a new magic item of type C<how> to the head of the magic list.
4504 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4505 handling of the C<name> and C<namlen> arguments.
4507 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4508 to add more than one instance of the same 'how'.
4514 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4517 const MGVTBL *vtable;
4520 #ifdef PERL_OLD_COPY_ON_WRITE
4522 sv_force_normal_flags(sv, 0);
4524 if (SvREADONLY(sv)) {
4526 /* its okay to attach magic to shared strings; the subsequent
4527 * upgrade to PVMG will unshare the string */
4528 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4531 && how != PERL_MAGIC_regex_global
4532 && how != PERL_MAGIC_bm
4533 && how != PERL_MAGIC_fm
4534 && how != PERL_MAGIC_sv
4535 && how != PERL_MAGIC_backref
4538 Perl_croak(aTHX_ PL_no_modify);
4541 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4542 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4543 /* sv_magic() refuses to add a magic of the same 'how' as an
4546 if (how == PERL_MAGIC_taint) {
4548 /* Any scalar which already had taint magic on which someone
4549 (erroneously?) did SvIOK_on() or similar will now be
4550 incorrectly sporting public "OK" flags. */
4551 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4559 vtable = &PL_vtbl_sv;
4561 case PERL_MAGIC_overload:
4562 vtable = &PL_vtbl_amagic;
4564 case PERL_MAGIC_overload_elem:
4565 vtable = &PL_vtbl_amagicelem;
4567 case PERL_MAGIC_overload_table:
4568 vtable = &PL_vtbl_ovrld;
4571 vtable = &PL_vtbl_bm;
4573 case PERL_MAGIC_regdata:
4574 vtable = &PL_vtbl_regdata;
4576 case PERL_MAGIC_regdatum:
4577 vtable = &PL_vtbl_regdatum;
4579 case PERL_MAGIC_env:
4580 vtable = &PL_vtbl_env;
4583 vtable = &PL_vtbl_fm;
4585 case PERL_MAGIC_envelem:
4586 vtable = &PL_vtbl_envelem;
4588 case PERL_MAGIC_regex_global:
4589 vtable = &PL_vtbl_mglob;
4591 case PERL_MAGIC_isa:
4592 vtable = &PL_vtbl_isa;
4594 case PERL_MAGIC_isaelem:
4595 vtable = &PL_vtbl_isaelem;
4597 case PERL_MAGIC_nkeys:
4598 vtable = &PL_vtbl_nkeys;
4600 case PERL_MAGIC_dbfile:
4603 case PERL_MAGIC_dbline:
4604 vtable = &PL_vtbl_dbline;
4606 #ifdef USE_LOCALE_COLLATE
4607 case PERL_MAGIC_collxfrm:
4608 vtable = &PL_vtbl_collxfrm;
4610 #endif /* USE_LOCALE_COLLATE */
4611 case PERL_MAGIC_tied:
4612 vtable = &PL_vtbl_pack;
4614 case PERL_MAGIC_tiedelem:
4615 case PERL_MAGIC_tiedscalar:
4616 vtable = &PL_vtbl_packelem;
4619 vtable = &PL_vtbl_regexp;
4621 case PERL_MAGIC_hints:
4622 /* As this vtable is all NULL, we can reuse it. */
4623 case PERL_MAGIC_sig:
4624 vtable = &PL_vtbl_sig;
4626 case PERL_MAGIC_sigelem:
4627 vtable = &PL_vtbl_sigelem;
4629 case PERL_MAGIC_taint:
4630 vtable = &PL_vtbl_taint;
4632 case PERL_MAGIC_uvar:
4633 vtable = &PL_vtbl_uvar;
4635 case PERL_MAGIC_vec:
4636 vtable = &PL_vtbl_vec;
4638 case PERL_MAGIC_arylen_p:
4639 case PERL_MAGIC_rhash:
4640 case PERL_MAGIC_symtab:
4641 case PERL_MAGIC_vstring:
4644 case PERL_MAGIC_utf8:
4645 vtable = &PL_vtbl_utf8;
4647 case PERL_MAGIC_substr:
4648 vtable = &PL_vtbl_substr;
4650 case PERL_MAGIC_defelem:
4651 vtable = &PL_vtbl_defelem;
4653 case PERL_MAGIC_arylen:
4654 vtable = &PL_vtbl_arylen;
4656 case PERL_MAGIC_pos:
4657 vtable = &PL_vtbl_pos;
4659 case PERL_MAGIC_backref:
4660 vtable = &PL_vtbl_backref;
4662 case PERL_MAGIC_hintselem:
4663 vtable = &PL_vtbl_hintselem;
4665 case PERL_MAGIC_ext:
4666 /* Reserved for use by extensions not perl internals. */
4667 /* Useful for attaching extension internal data to perl vars. */
4668 /* Note that multiple extensions may clash if magical scalars */
4669 /* etc holding private data from one are passed to another. */
4673 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4676 /* Rest of work is done else where */
4677 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4680 case PERL_MAGIC_taint:
4683 case PERL_MAGIC_ext:
4684 case PERL_MAGIC_dbfile:
4691 =for apidoc sv_unmagic
4693 Removes all magic of type C<type> from an SV.
4699 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4703 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4705 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4706 for (mg = *mgp; mg; mg = *mgp) {
4707 if (mg->mg_type == type) {
4708 const MGVTBL* const vtbl = mg->mg_virtual;
4709 *mgp = mg->mg_moremagic;
4710 if (vtbl && vtbl->svt_free)
4711 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4712 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4714 Safefree(mg->mg_ptr);
4715 else if (mg->mg_len == HEf_SVKEY)
4716 SvREFCNT_dec((SV*)mg->mg_ptr);
4717 else if (mg->mg_type == PERL_MAGIC_utf8)
4718 Safefree(mg->mg_ptr);
4720 if (mg->mg_flags & MGf_REFCOUNTED)
4721 SvREFCNT_dec(mg->mg_obj);
4725 mgp = &mg->mg_moremagic;
4729 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4730 SvMAGIC_set(sv, NULL);
4737 =for apidoc sv_rvweaken
4739 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4740 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4741 push a back-reference to this RV onto the array of backreferences
4742 associated with that magic. If the RV is magical, set magic will be
4743 called after the RV is cleared.
4749 Perl_sv_rvweaken(pTHX_ SV *sv)
4752 if (!SvOK(sv)) /* let undefs pass */
4755 Perl_croak(aTHX_ "Can't weaken a nonreference");
4756 else if (SvWEAKREF(sv)) {
4757 if (ckWARN(WARN_MISC))
4758 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4762 Perl_sv_add_backref(aTHX_ tsv, sv);
4768 /* Give tsv backref magic if it hasn't already got it, then push a
4769 * back-reference to sv onto the array associated with the backref magic.
4773 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4778 if (SvTYPE(tsv) == SVt_PVHV) {
4779 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4783 /* There is no AV in the offical place - try a fixup. */
4784 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4787 /* Aha. They've got it stowed in magic. Bring it back. */
4788 av = (AV*)mg->mg_obj;
4789 /* Stop mg_free decreasing the refernce count. */
4791 /* Stop mg_free even calling the destructor, given that
4792 there's no AV to free up. */
4794 sv_unmagic(tsv, PERL_MAGIC_backref);
4798 SvREFCNT_inc_simple_void(av);
4803 const MAGIC *const mg
4804 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4806 av = (AV*)mg->mg_obj;
4810 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4811 /* av now has a refcnt of 2, which avoids it getting freed
4812 * before us during global cleanup. The extra ref is removed
4813 * by magic_killbackrefs() when tsv is being freed */
4816 if (AvFILLp(av) >= AvMAX(av)) {
4817 av_extend(av, AvFILLp(av)+1);
4819 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4822 /* delete a back-reference to ourselves from the backref magic associated
4823 * with the SV we point to.
4827 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4834 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4835 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4836 /* We mustn't attempt to "fix up" the hash here by moving the
4837 backreference array back to the hv_aux structure, as that is stored
4838 in the main HvARRAY(), and hfreentries assumes that no-one
4839 reallocates HvARRAY() while it is running. */
4842 const MAGIC *const mg
4843 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4845 av = (AV *)mg->mg_obj;
4848 if (PL_in_clean_all)
4850 Perl_croak(aTHX_ "panic: del_backref");
4857 /* We shouldn't be in here more than once, but for paranoia reasons lets
4859 for (i = AvFILLp(av); i >= 0; i--) {
4861 const SSize_t fill = AvFILLp(av);
4863 /* We weren't the last entry.
4864 An unordered list has this property that you can take the
4865 last element off the end to fill the hole, and it's still
4866 an unordered list :-)
4871 AvFILLp(av) = fill - 1;
4877 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4879 SV **svp = AvARRAY(av);
4881 PERL_UNUSED_ARG(sv);
4883 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4884 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4885 if (svp && !SvIS_FREED(av)) {
4886 SV *const *const last = svp + AvFILLp(av);
4888 while (svp <= last) {
4890 SV *const referrer = *svp;
4891 if (SvWEAKREF(referrer)) {
4892 /* XXX Should we check that it hasn't changed? */
4893 SvRV_set(referrer, 0);
4895 SvWEAKREF_off(referrer);
4896 SvSETMAGIC(referrer);
4897 } else if (SvTYPE(referrer) == SVt_PVGV ||
4898 SvTYPE(referrer) == SVt_PVLV) {
4899 /* You lookin' at me? */
4900 assert(GvSTASH(referrer));
4901 assert(GvSTASH(referrer) == (HV*)sv);
4902 GvSTASH(referrer) = 0;
4905 "panic: magic_killbackrefs (flags=%"UVxf")",
4906 (UV)SvFLAGS(referrer));
4914 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4919 =for apidoc sv_insert
4921 Inserts a string at the specified offset/length within the SV. Similar to
4922 the Perl substr() function.
4928 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4933 register char *midend;
4934 register char *bigend;
4940 Perl_croak(aTHX_ "Can't modify non-existent substring");
4941 SvPV_force(bigstr, curlen);
4942 (void)SvPOK_only_UTF8(bigstr);
4943 if (offset + len > curlen) {
4944 SvGROW(bigstr, offset+len+1);
4945 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4946 SvCUR_set(bigstr, offset+len);
4950 i = littlelen - len;
4951 if (i > 0) { /* string might grow */
4952 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4953 mid = big + offset + len;
4954 midend = bigend = big + SvCUR(bigstr);
4957 while (midend > mid) /* shove everything down */
4958 *--bigend = *--midend;
4959 Move(little,big+offset,littlelen,char);
4960 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4965 Move(little,SvPVX(bigstr)+offset,len,char);
4970 big = SvPVX(bigstr);
4973 bigend = big + SvCUR(bigstr);
4975 if (midend > bigend)
4976 Perl_croak(aTHX_ "panic: sv_insert");
4978 if (mid - big > bigend - midend) { /* faster to shorten from end */
4980 Move(little, mid, littlelen,char);
4983 i = bigend - midend;
4985 Move(midend, mid, i,char);
4989 SvCUR_set(bigstr, mid - big);
4991 else if ((i = mid - big)) { /* faster from front */
4992 midend -= littlelen;
4994 sv_chop(bigstr,midend-i);
4999 Move(little, mid, littlelen,char);
5001 else if (littlelen) {
5002 midend -= littlelen;
5003 sv_chop(bigstr,midend);
5004 Move(little,midend,littlelen,char);
5007 sv_chop(bigstr,midend);
5013 =for apidoc sv_replace
5015 Make the first argument a copy of the second, then delete the original.
5016 The target SV physically takes over ownership of the body of the source SV
5017 and inherits its flags; however, the target keeps any magic it owns,
5018 and any magic in the source is discarded.
5019 Note that this is a rather specialist SV copying operation; most of the
5020 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5026 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5029 const U32 refcnt = SvREFCNT(sv);
5030 SV_CHECK_THINKFIRST_COW_DROP(sv);
5031 if (SvREFCNT(nsv) != 1) {
5032 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5033 UVuf " != 1)", (UV) SvREFCNT(nsv));
5035 if (SvMAGICAL(sv)) {
5039 sv_upgrade(nsv, SVt_PVMG);
5040 SvMAGIC_set(nsv, SvMAGIC(sv));
5041 SvFLAGS(nsv) |= SvMAGICAL(sv);
5043 SvMAGIC_set(sv, NULL);
5047 assert(!SvREFCNT(sv));
5048 #ifdef DEBUG_LEAKING_SCALARS
5049 sv->sv_flags = nsv->sv_flags;
5050 sv->sv_any = nsv->sv_any;
5051 sv->sv_refcnt = nsv->sv_refcnt;
5052 sv->sv_u = nsv->sv_u;
5054 StructCopy(nsv,sv,SV);
5056 if(SvTYPE(sv) == SVt_IV) {
5058 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5062 #ifdef PERL_OLD_COPY_ON_WRITE
5063 if (SvIsCOW_normal(nsv)) {
5064 /* We need to follow the pointers around the loop to make the
5065 previous SV point to sv, rather than nsv. */
5068 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5071 assert(SvPVX_const(current) == SvPVX_const(nsv));
5073 /* Make the SV before us point to the SV after us. */
5075 PerlIO_printf(Perl_debug_log, "previous is\n");
5077 PerlIO_printf(Perl_debug_log,
5078 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5079 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5081 SV_COW_NEXT_SV_SET(current, sv);
5084 SvREFCNT(sv) = refcnt;
5085 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5091 =for apidoc sv_clear
5093 Clear an SV: call any destructors, free up any memory used by the body,
5094 and free the body itself. The SV's head is I<not> freed, although
5095 its type is set to all 1's so that it won't inadvertently be assumed
5096 to be live during global destruction etc.
5097 This function should only be called when REFCNT is zero. Most of the time
5098 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5105 Perl_sv_clear(pTHX_ register SV *sv)
5108 const U32 type = SvTYPE(sv);
5109 const struct body_details *const sv_type_details
5110 = bodies_by_type + type;
5114 assert(SvREFCNT(sv) == 0);
5116 if (type <= SVt_IV) {
5117 /* See the comment in sv.h about the collusion between this early
5118 return and the overloading of the NULL and IV slots in the size
5121 SV * const target = SvRV(sv);
5123 sv_del_backref(target, sv);
5125 SvREFCNT_dec(target);
5127 SvFLAGS(sv) &= SVf_BREAK;
5128 SvFLAGS(sv) |= SVTYPEMASK;
5133 if (PL_defstash && /* Still have a symbol table? */
5140 stash = SvSTASH(sv);
5141 destructor = StashHANDLER(stash,DESTROY);
5143 SV* const tmpref = newRV(sv);
5144 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5146 PUSHSTACKi(PERLSI_DESTROY);
5151 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5157 if(SvREFCNT(tmpref) < 2) {
5158 /* tmpref is not kept alive! */
5160 SvRV_set(tmpref, NULL);
5163 SvREFCNT_dec(tmpref);
5165 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5169 if (PL_in_clean_objs)
5170 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5172 /* DESTROY gave object new lease on life */
5178 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5179 SvOBJECT_off(sv); /* Curse the object. */
5180 if (type != SVt_PVIO)
5181 --PL_sv_objcount; /* XXX Might want something more general */
5184 if (type >= SVt_PVMG) {
5185 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5186 SvREFCNT_dec(SvOURSTASH(sv));
5187 } else if (SvMAGIC(sv))
5189 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5190 SvREFCNT_dec(SvSTASH(sv));
5193 /* case SVt_BIND: */
5196 IoIFP(sv) != PerlIO_stdin() &&
5197 IoIFP(sv) != PerlIO_stdout() &&
5198 IoIFP(sv) != PerlIO_stderr())
5200 io_close((IO*)sv, FALSE);
5202 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5203 PerlDir_close(IoDIRP(sv));
5204 IoDIRP(sv) = (DIR*)NULL;
5205 Safefree(IoTOP_NAME(sv));
5206 Safefree(IoFMT_NAME(sv));
5207 Safefree(IoBOTTOM_NAME(sv));
5214 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5218 if (PL_comppad == (AV*)sv) {
5225 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5226 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5227 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5228 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5230 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5231 SvREFCNT_dec(LvTARG(sv));
5233 if (isGV_with_GP(sv)) {
5234 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5235 mro_method_changed_in(stash);
5238 unshare_hek(GvNAME_HEK(sv));
5239 /* If we're in a stash, we don't own a reference to it. However it does
5240 have a back reference to us, which needs to be cleared. */
5241 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5242 sv_del_backref((SV*)stash, sv);
5244 /* FIXME. There are probably more unreferenced pointers to SVs in the
5245 interpreter struct that we should check and tidy in a similar
5247 if ((GV*)sv == PL_last_in_gv)
5248 PL_last_in_gv = NULL;
5253 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5255 SvPV_set(sv, SvPVX_mutable(sv) - SvIVX(sv));
5256 /* Don't even bother with turning off the OOK flag. */
5260 SV * const target = SvRV(sv);
5262 sv_del_backref(target, sv);
5264 SvREFCNT_dec(target);
5266 #ifdef PERL_OLD_COPY_ON_WRITE
5267 else if (SvPVX_const(sv)) {
5269 /* I believe I need to grab the global SV mutex here and
5270 then recheck the COW status. */
5272 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5276 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5278 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5281 /* And drop it here. */
5283 } else if (SvLEN(sv)) {
5284 Safefree(SvPVX_const(sv));
5288 else if (SvPVX_const(sv) && SvLEN(sv))
5289 Safefree(SvPVX_mutable(sv));
5290 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5291 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5300 SvFLAGS(sv) &= SVf_BREAK;
5301 SvFLAGS(sv) |= SVTYPEMASK;
5303 if (sv_type_details->arena) {
5304 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5305 &PL_body_roots[type]);
5307 else if (sv_type_details->body_size) {
5308 my_safefree(SvANY(sv));
5313 =for apidoc sv_newref
5315 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5322 Perl_sv_newref(pTHX_ SV *sv)
5324 PERL_UNUSED_CONTEXT;
5333 Decrement an SV's reference count, and if it drops to zero, call
5334 C<sv_clear> to invoke destructors and free up any memory used by
5335 the body; finally, deallocate the SV's head itself.
5336 Normally called via a wrapper macro C<SvREFCNT_dec>.
5342 Perl_sv_free(pTHX_ SV *sv)
5347 if (SvREFCNT(sv) == 0) {
5348 if (SvFLAGS(sv) & SVf_BREAK)
5349 /* this SV's refcnt has been artificially decremented to
5350 * trigger cleanup */
5352 if (PL_in_clean_all) /* All is fair */
5354 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5355 /* make sure SvREFCNT(sv)==0 happens very seldom */
5356 SvREFCNT(sv) = (~(U32)0)/2;
5359 if (ckWARN_d(WARN_INTERNAL)) {
5360 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5361 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5362 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5363 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5364 Perl_dump_sv_child(aTHX_ sv);
5366 #ifdef DEBUG_LEAKING_SCALARS
5373 if (--(SvREFCNT(sv)) > 0)
5375 Perl_sv_free2(aTHX_ sv);
5379 Perl_sv_free2(pTHX_ SV *sv)
5384 if (ckWARN_d(WARN_DEBUGGING))
5385 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5386 "Attempt to free temp prematurely: SV 0x%"UVxf
5387 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5391 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5392 /* make sure SvREFCNT(sv)==0 happens very seldom */
5393 SvREFCNT(sv) = (~(U32)0)/2;
5404 Returns the length of the string in the SV. Handles magic and type
5405 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5411 Perl_sv_len(pTHX_ register SV *sv)
5419 len = mg_length(sv);
5421 (void)SvPV_const(sv, len);
5426 =for apidoc sv_len_utf8
5428 Returns the number of characters in the string in an SV, counting wide
5429 UTF-8 bytes as a single character. Handles magic and type coercion.
5435 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5436 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5437 * (Note that the mg_len is not the length of the mg_ptr field.
5438 * This allows the cache to store the character length of the string without
5439 * needing to malloc() extra storage to attach to the mg_ptr.)
5444 Perl_sv_len_utf8(pTHX_ register SV *sv)
5450 return mg_length(sv);
5454 const U8 *s = (U8*)SvPV_const(sv, len);
5458 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5460 if (mg && mg->mg_len != -1) {
5462 if (PL_utf8cache < 0) {
5463 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5465 /* Need to turn the assertions off otherwise we may
5466 recurse infinitely while printing error messages.
5468 SAVEI8(PL_utf8cache);
5470 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5471 " real %"UVuf" for %"SVf,
5472 (UV) ulen, (UV) real, SVfARG(sv));
5477 ulen = Perl_utf8_length(aTHX_ s, s + len);
5478 if (!SvREADONLY(sv)) {
5480 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5481 &PL_vtbl_utf8, 0, 0);
5489 return Perl_utf8_length(aTHX_ s, s + len);
5493 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5496 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5499 const U8 *s = start;
5501 while (s < send && uoffset--)
5504 /* This is the existing behaviour. Possibly it should be a croak, as
5505 it's actually a bounds error */
5511 /* Given the length of the string in both bytes and UTF-8 characters, decide
5512 whether to walk forwards or backwards to find the byte corresponding to
5513 the passed in UTF-8 offset. */
5515 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5516 STRLEN uoffset, STRLEN uend)
5518 STRLEN backw = uend - uoffset;
5519 if (uoffset < 2 * backw) {
5520 /* The assumption is that going forwards is twice the speed of going
5521 forward (that's where the 2 * backw comes from).
5522 (The real figure of course depends on the UTF-8 data.) */
5523 return sv_pos_u2b_forwards(start, send, uoffset);
5528 while (UTF8_IS_CONTINUATION(*send))
5531 return send - start;
5534 /* For the string representation of the given scalar, find the byte
5535 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5536 give another position in the string, *before* the sought offset, which
5537 (which is always true, as 0, 0 is a valid pair of positions), which should
5538 help reduce the amount of linear searching.
5539 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5540 will be used to reduce the amount of linear searching. The cache will be
5541 created if necessary, and the found value offered to it for update. */
5543 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5544 const U8 *const send, STRLEN uoffset,
5545 STRLEN uoffset0, STRLEN boffset0) {
5546 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5549 assert (uoffset >= uoffset0);
5551 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5552 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5553 if ((*mgp)->mg_ptr) {
5554 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5555 if (cache[0] == uoffset) {
5556 /* An exact match. */
5559 if (cache[2] == uoffset) {
5560 /* An exact match. */
5564 if (cache[0] < uoffset) {
5565 /* The cache already knows part of the way. */
5566 if (cache[0] > uoffset0) {
5567 /* The cache knows more than the passed in pair */
5568 uoffset0 = cache[0];
5569 boffset0 = cache[1];
5571 if ((*mgp)->mg_len != -1) {
5572 /* And we know the end too. */
5574 + sv_pos_u2b_midway(start + boffset0, send,
5576 (*mgp)->mg_len - uoffset0);
5579 + sv_pos_u2b_forwards(start + boffset0,
5580 send, uoffset - uoffset0);
5583 else if (cache[2] < uoffset) {
5584 /* We're between the two cache entries. */
5585 if (cache[2] > uoffset0) {
5586 /* and the cache knows more than the passed in pair */
5587 uoffset0 = cache[2];
5588 boffset0 = cache[3];
5592 + sv_pos_u2b_midway(start + boffset0,
5595 cache[0] - uoffset0);
5598 + sv_pos_u2b_midway(start + boffset0,
5601 cache[2] - uoffset0);
5605 else if ((*mgp)->mg_len != -1) {
5606 /* If we can take advantage of a passed in offset, do so. */
5607 /* In fact, offset0 is either 0, or less than offset, so don't
5608 need to worry about the other possibility. */
5610 + sv_pos_u2b_midway(start + boffset0, send,
5612 (*mgp)->mg_len - uoffset0);
5617 if (!found || PL_utf8cache < 0) {
5618 const STRLEN real_boffset
5619 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5620 send, uoffset - uoffset0);
5622 if (found && PL_utf8cache < 0) {
5623 if (real_boffset != boffset) {
5624 /* Need to turn the assertions off otherwise we may recurse
5625 infinitely while printing error messages. */
5626 SAVEI8(PL_utf8cache);
5628 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5629 " real %"UVuf" for %"SVf,
5630 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5633 boffset = real_boffset;
5636 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5642 =for apidoc sv_pos_u2b
5644 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5645 the start of the string, to a count of the equivalent number of bytes; if
5646 lenp is non-zero, it does the same to lenp, but this time starting from
5647 the offset, rather than from the start of the string. Handles magic and
5654 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5655 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5656 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5661 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5669 start = (U8*)SvPV_const(sv, len);
5671 STRLEN uoffset = (STRLEN) *offsetp;
5672 const U8 * const send = start + len;
5674 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5677 *offsetp = (I32) boffset;
5680 /* Convert the relative offset to absolute. */
5681 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5682 const STRLEN boffset2
5683 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5684 uoffset, boffset) - boffset;
5698 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5699 byte length pairing. The (byte) length of the total SV is passed in too,
5700 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5701 may not have updated SvCUR, so we can't rely on reading it directly.
5703 The proffered utf8/byte length pairing isn't used if the cache already has
5704 two pairs, and swapping either for the proffered pair would increase the
5705 RMS of the intervals between known byte offsets.
5707 The cache itself consists of 4 STRLEN values
5708 0: larger UTF-8 offset
5709 1: corresponding byte offset
5710 2: smaller UTF-8 offset
5711 3: corresponding byte offset
5713 Unused cache pairs have the value 0, 0.
5714 Keeping the cache "backwards" means that the invariant of
5715 cache[0] >= cache[2] is maintained even with empty slots, which means that
5716 the code that uses it doesn't need to worry if only 1 entry has actually
5717 been set to non-zero. It also makes the "position beyond the end of the
5718 cache" logic much simpler, as the first slot is always the one to start
5722 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5730 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5732 (*mgp)->mg_len = -1;
5736 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5737 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5738 (*mgp)->mg_ptr = (char *) cache;
5742 if (PL_utf8cache < 0) {
5743 const U8 *start = (const U8 *) SvPVX_const(sv);
5744 const STRLEN realutf8 = utf8_length(start, start + byte);
5746 if (realutf8 != utf8) {
5747 /* Need to turn the assertions off otherwise we may recurse
5748 infinitely while printing error messages. */
5749 SAVEI8(PL_utf8cache);
5751 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5752 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5756 /* Cache is held with the later position first, to simplify the code
5757 that deals with unbounded ends. */
5759 ASSERT_UTF8_CACHE(cache);
5760 if (cache[1] == 0) {
5761 /* Cache is totally empty */
5764 } else if (cache[3] == 0) {
5765 if (byte > cache[1]) {
5766 /* New one is larger, so goes first. */
5767 cache[2] = cache[0];
5768 cache[3] = cache[1];
5776 #define THREEWAY_SQUARE(a,b,c,d) \
5777 ((float)((d) - (c))) * ((float)((d) - (c))) \
5778 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5779 + ((float)((b) - (a))) * ((float)((b) - (a)))
5781 /* Cache has 2 slots in use, and we know three potential pairs.
5782 Keep the two that give the lowest RMS distance. Do the
5783 calcualation in bytes simply because we always know the byte
5784 length. squareroot has the same ordering as the positive value,
5785 so don't bother with the actual square root. */
5786 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5787 if (byte > cache[1]) {
5788 /* New position is after the existing pair of pairs. */
5789 const float keep_earlier
5790 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5791 const float keep_later
5792 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5794 if (keep_later < keep_earlier) {
5795 if (keep_later < existing) {
5796 cache[2] = cache[0];
5797 cache[3] = cache[1];
5803 if (keep_earlier < existing) {
5809 else if (byte > cache[3]) {
5810 /* New position is between the existing pair of pairs. */
5811 const float keep_earlier
5812 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5813 const float keep_later
5814 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5816 if (keep_later < keep_earlier) {
5817 if (keep_later < existing) {
5823 if (keep_earlier < existing) {
5830 /* New position is before the existing pair of pairs. */
5831 const float keep_earlier
5832 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5833 const float keep_later
5834 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5836 if (keep_later < keep_earlier) {
5837 if (keep_later < existing) {
5843 if (keep_earlier < existing) {
5844 cache[0] = cache[2];
5845 cache[1] = cache[3];
5852 ASSERT_UTF8_CACHE(cache);
5855 /* We already know all of the way, now we may be able to walk back. The same
5856 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5857 backward is half the speed of walking forward. */
5859 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5862 const STRLEN forw = target - s;
5863 STRLEN backw = end - target;
5865 if (forw < 2 * backw) {
5866 return utf8_length(s, target);
5869 while (end > target) {
5871 while (UTF8_IS_CONTINUATION(*end)) {
5880 =for apidoc sv_pos_b2u
5882 Converts the value pointed to by offsetp from a count of bytes from the
5883 start of the string, to a count of the equivalent number of UTF-8 chars.
5884 Handles magic and type coercion.
5890 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5891 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5896 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5899 const STRLEN byte = *offsetp;
5900 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5909 s = (const U8*)SvPV_const(sv, blen);
5912 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5916 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5917 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5919 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5920 if (cache[1] == byte) {
5921 /* An exact match. */
5922 *offsetp = cache[0];
5925 if (cache[3] == byte) {
5926 /* An exact match. */
5927 *offsetp = cache[2];
5931 if (cache[1] < byte) {
5932 /* We already know part of the way. */
5933 if (mg->mg_len != -1) {
5934 /* Actually, we know the end too. */
5936 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5937 s + blen, mg->mg_len - cache[0]);
5939 len = cache[0] + utf8_length(s + cache[1], send);
5942 else if (cache[3] < byte) {
5943 /* We're between the two cached pairs, so we do the calculation
5944 offset by the byte/utf-8 positions for the earlier pair,
5945 then add the utf-8 characters from the string start to
5947 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5948 s + cache[1], cache[0] - cache[2])
5952 else { /* cache[3] > byte */
5953 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5957 ASSERT_UTF8_CACHE(cache);
5959 } else if (mg->mg_len != -1) {
5960 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
5964 if (!found || PL_utf8cache < 0) {
5965 const STRLEN real_len = utf8_length(s, send);
5967 if (found && PL_utf8cache < 0) {
5968 if (len != real_len) {
5969 /* Need to turn the assertions off otherwise we may recurse
5970 infinitely while printing error messages. */
5971 SAVEI8(PL_utf8cache);
5973 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
5974 " real %"UVuf" for %"SVf,
5975 (UV) len, (UV) real_len, SVfARG(sv));
5982 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
5988 Returns a boolean indicating whether the strings in the two SVs are
5989 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5990 coerce its args to strings if necessary.
5996 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6005 SV* svrecode = NULL;
6012 /* if pv1 and pv2 are the same, second SvPV_const call may
6013 * invalidate pv1, so we may need to make a copy */
6014 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6015 pv1 = SvPV_const(sv1, cur1);
6016 sv1 = sv_2mortal(newSVpvn(pv1, cur1));
6017 if (SvUTF8(sv2)) SvUTF8_on(sv1);
6019 pv1 = SvPV_const(sv1, cur1);
6027 pv2 = SvPV_const(sv2, cur2);
6029 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6030 /* Differing utf8ness.
6031 * Do not UTF8size the comparands as a side-effect. */
6034 svrecode = newSVpvn(pv2, cur2);
6035 sv_recode_to_utf8(svrecode, PL_encoding);
6036 pv2 = SvPV_const(svrecode, cur2);
6039 svrecode = newSVpvn(pv1, cur1);
6040 sv_recode_to_utf8(svrecode, PL_encoding);
6041 pv1 = SvPV_const(svrecode, cur1);
6043 /* Now both are in UTF-8. */
6045 SvREFCNT_dec(svrecode);
6050 bool is_utf8 = TRUE;
6053 /* sv1 is the UTF-8 one,
6054 * if is equal it must be downgrade-able */
6055 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6061 /* sv2 is the UTF-8 one,
6062 * if is equal it must be downgrade-able */
6063 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6069 /* Downgrade not possible - cannot be eq */
6077 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6079 SvREFCNT_dec(svrecode);
6089 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6090 string in C<sv1> is less than, equal to, or greater than the string in
6091 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6092 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6098 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6102 const char *pv1, *pv2;
6105 SV *svrecode = NULL;
6112 pv1 = SvPV_const(sv1, cur1);
6119 pv2 = SvPV_const(sv2, cur2);
6121 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6122 /* Differing utf8ness.
6123 * Do not UTF8size the comparands as a side-effect. */
6126 svrecode = newSVpvn(pv2, cur2);
6127 sv_recode_to_utf8(svrecode, PL_encoding);
6128 pv2 = SvPV_const(svrecode, cur2);
6131 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6136 svrecode = newSVpvn(pv1, cur1);
6137 sv_recode_to_utf8(svrecode, PL_encoding);
6138 pv1 = SvPV_const(svrecode, cur1);
6141 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6147 cmp = cur2 ? -1 : 0;
6151 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6154 cmp = retval < 0 ? -1 : 1;
6155 } else if (cur1 == cur2) {
6158 cmp = cur1 < cur2 ? -1 : 1;
6162 SvREFCNT_dec(svrecode);
6170 =for apidoc sv_cmp_locale
6172 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6173 'use bytes' aware, handles get magic, and will coerce its args to strings
6174 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6180 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6183 #ifdef USE_LOCALE_COLLATE
6189 if (PL_collation_standard)
6193 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6195 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6197 if (!pv1 || !len1) {
6208 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6211 return retval < 0 ? -1 : 1;
6214 * When the result of collation is equality, that doesn't mean
6215 * that there are no differences -- some locales exclude some
6216 * characters from consideration. So to avoid false equalities,
6217 * we use the raw string as a tiebreaker.
6223 #endif /* USE_LOCALE_COLLATE */
6225 return sv_cmp(sv1, sv2);
6229 #ifdef USE_LOCALE_COLLATE
6232 =for apidoc sv_collxfrm
6234 Add Collate Transform magic to an SV if it doesn't already have it.
6236 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6237 scalar data of the variable, but transformed to such a format that a normal
6238 memory comparison can be used to compare the data according to the locale
6245 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6250 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6251 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6257 Safefree(mg->mg_ptr);
6258 s = SvPV_const(sv, len);
6259 if ((xf = mem_collxfrm(s, len, &xlen))) {
6260 if (SvREADONLY(sv)) {
6263 return xf + sizeof(PL_collation_ix);
6266 #ifdef PERL_OLD_COPY_ON_WRITE
6268 sv_force_normal_flags(sv, 0);
6270 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6284 if (mg && mg->mg_ptr) {
6286 return mg->mg_ptr + sizeof(PL_collation_ix);
6294 #endif /* USE_LOCALE_COLLATE */
6299 Get a line from the filehandle and store it into the SV, optionally
6300 appending to the currently-stored string.
6306 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6311 register STDCHAR rslast;
6312 register STDCHAR *bp;
6317 if (SvTHINKFIRST(sv))
6318 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6319 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6321 However, perlbench says it's slower, because the existing swipe code
6322 is faster than copy on write.
6323 Swings and roundabouts. */
6324 SvUPGRADE(sv, SVt_PV);
6329 if (PerlIO_isutf8(fp)) {
6331 sv_utf8_upgrade_nomg(sv);
6332 sv_pos_u2b(sv,&append,0);
6334 } else if (SvUTF8(sv)) {
6335 SV * const tsv = newSV(0);
6336 sv_gets(tsv, fp, 0);
6337 sv_utf8_upgrade_nomg(tsv);
6338 SvCUR_set(sv,append);
6341 goto return_string_or_null;
6346 if (PerlIO_isutf8(fp))
6349 if (IN_PERL_COMPILETIME) {
6350 /* we always read code in line mode */
6354 else if (RsSNARF(PL_rs)) {
6355 /* If it is a regular disk file use size from stat() as estimate
6356 of amount we are going to read -- may result in mallocing
6357 more memory than we really need if the layers below reduce
6358 the size we read (e.g. CRLF or a gzip layer).
6361 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6362 const Off_t offset = PerlIO_tell(fp);
6363 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6364 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6370 else if (RsRECORD(PL_rs)) {
6375 /* Grab the size of the record we're getting */
6376 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6377 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6380 /* VMS wants read instead of fread, because fread doesn't respect */
6381 /* RMS record boundaries. This is not necessarily a good thing to be */
6382 /* doing, but we've got no other real choice - except avoid stdio
6383 as implementation - perhaps write a :vms layer ?
6385 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6387 bytesread = PerlIO_read(fp, buffer, recsize);
6391 SvCUR_set(sv, bytesread += append);
6392 buffer[bytesread] = '\0';
6393 goto return_string_or_null;
6395 else if (RsPARA(PL_rs)) {
6401 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6402 if (PerlIO_isutf8(fp)) {
6403 rsptr = SvPVutf8(PL_rs, rslen);
6406 if (SvUTF8(PL_rs)) {
6407 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6408 Perl_croak(aTHX_ "Wide character in $/");
6411 rsptr = SvPV_const(PL_rs, rslen);
6415 rslast = rslen ? rsptr[rslen - 1] : '\0';
6417 if (rspara) { /* have to do this both before and after */
6418 do { /* to make sure file boundaries work right */
6421 i = PerlIO_getc(fp);
6425 PerlIO_ungetc(fp,i);
6431 /* See if we know enough about I/O mechanism to cheat it ! */
6433 /* This used to be #ifdef test - it is made run-time test for ease
6434 of abstracting out stdio interface. One call should be cheap
6435 enough here - and may even be a macro allowing compile
6439 if (PerlIO_fast_gets(fp)) {
6442 * We're going to steal some values from the stdio struct
6443 * and put EVERYTHING in the innermost loop into registers.
6445 register STDCHAR *ptr;
6449 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6450 /* An ungetc()d char is handled separately from the regular
6451 * buffer, so we getc() it back out and stuff it in the buffer.
6453 i = PerlIO_getc(fp);
6454 if (i == EOF) return 0;
6455 *(--((*fp)->_ptr)) = (unsigned char) i;
6459 /* Here is some breathtakingly efficient cheating */
6461 cnt = PerlIO_get_cnt(fp); /* get count into register */
6462 /* make sure we have the room */
6463 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6464 /* Not room for all of it
6465 if we are looking for a separator and room for some
6467 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6468 /* just process what we have room for */
6469 shortbuffered = cnt - SvLEN(sv) + append + 1;
6470 cnt -= shortbuffered;
6474 /* remember that cnt can be negative */
6475 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6480 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6481 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6482 DEBUG_P(PerlIO_printf(Perl_debug_log,
6483 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6484 DEBUG_P(PerlIO_printf(Perl_debug_log,
6485 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6486 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6487 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6492 while (cnt > 0) { /* this | eat */
6494 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6495 goto thats_all_folks; /* screams | sed :-) */
6499 Copy(ptr, bp, cnt, char); /* this | eat */
6500 bp += cnt; /* screams | dust */
6501 ptr += cnt; /* louder | sed :-) */
6506 if (shortbuffered) { /* oh well, must extend */
6507 cnt = shortbuffered;
6509 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6511 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6512 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6516 DEBUG_P(PerlIO_printf(Perl_debug_log,
6517 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6518 PTR2UV(ptr),(long)cnt));
6519 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6521 DEBUG_P(PerlIO_printf(Perl_debug_log,
6522 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6523 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6524 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6526 /* This used to call 'filbuf' in stdio form, but as that behaves like
6527 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6528 another abstraction. */
6529 i = PerlIO_getc(fp); /* get more characters */
6531 DEBUG_P(PerlIO_printf(Perl_debug_log,
6532 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6533 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6534 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6536 cnt = PerlIO_get_cnt(fp);
6537 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6538 DEBUG_P(PerlIO_printf(Perl_debug_log,
6539 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6541 if (i == EOF) /* all done for ever? */
6542 goto thats_really_all_folks;
6544 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6546 SvGROW(sv, bpx + cnt + 2);
6547 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6549 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6551 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6552 goto thats_all_folks;
6556 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6557 memNE((char*)bp - rslen, rsptr, rslen))
6558 goto screamer; /* go back to the fray */
6559 thats_really_all_folks:
6561 cnt += shortbuffered;
6562 DEBUG_P(PerlIO_printf(Perl_debug_log,
6563 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6564 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6565 DEBUG_P(PerlIO_printf(Perl_debug_log,
6566 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6567 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6568 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6570 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6571 DEBUG_P(PerlIO_printf(Perl_debug_log,
6572 "Screamer: done, len=%ld, string=|%.*s|\n",
6573 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6577 /*The big, slow, and stupid way. */
6578 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6579 STDCHAR *buf = NULL;
6580 Newx(buf, 8192, STDCHAR);
6588 register const STDCHAR * const bpe = buf + sizeof(buf);
6590 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6591 ; /* keep reading */
6595 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6596 /* Accomodate broken VAXC compiler, which applies U8 cast to
6597 * both args of ?: operator, causing EOF to change into 255
6600 i = (U8)buf[cnt - 1];
6606 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6608 sv_catpvn(sv, (char *) buf, cnt);
6610 sv_setpvn(sv, (char *) buf, cnt);
6612 if (i != EOF && /* joy */
6614 SvCUR(sv) < rslen ||
6615 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6619 * If we're reading from a TTY and we get a short read,
6620 * indicating that the user hit his EOF character, we need
6621 * to notice it now, because if we try to read from the TTY
6622 * again, the EOF condition will disappear.
6624 * The comparison of cnt to sizeof(buf) is an optimization
6625 * that prevents unnecessary calls to feof().
6629 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6633 #ifdef USE_HEAP_INSTEAD_OF_STACK
6638 if (rspara) { /* have to do this both before and after */
6639 while (i != EOF) { /* to make sure file boundaries work right */
6640 i = PerlIO_getc(fp);
6642 PerlIO_ungetc(fp,i);
6648 return_string_or_null:
6649 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6655 Auto-increment of the value in the SV, doing string to numeric conversion
6656 if necessary. Handles 'get' magic.
6662 Perl_sv_inc(pTHX_ register SV *sv)
6671 if (SvTHINKFIRST(sv)) {
6673 sv_force_normal_flags(sv, 0);
6674 if (SvREADONLY(sv)) {
6675 if (IN_PERL_RUNTIME)
6676 Perl_croak(aTHX_ PL_no_modify);
6680 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6682 i = PTR2IV(SvRV(sv));
6687 flags = SvFLAGS(sv);
6688 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6689 /* It's (privately or publicly) a float, but not tested as an
6690 integer, so test it to see. */
6692 flags = SvFLAGS(sv);
6694 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6695 /* It's publicly an integer, or privately an integer-not-float */
6696 #ifdef PERL_PRESERVE_IVUV
6700 if (SvUVX(sv) == UV_MAX)
6701 sv_setnv(sv, UV_MAX_P1);
6703 (void)SvIOK_only_UV(sv);
6704 SvUV_set(sv, SvUVX(sv) + 1);
6706 if (SvIVX(sv) == IV_MAX)
6707 sv_setuv(sv, (UV)IV_MAX + 1);
6709 (void)SvIOK_only(sv);
6710 SvIV_set(sv, SvIVX(sv) + 1);
6715 if (flags & SVp_NOK) {
6716 (void)SvNOK_only(sv);
6717 SvNV_set(sv, SvNVX(sv) + 1.0);
6721 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6722 if ((flags & SVTYPEMASK) < SVt_PVIV)
6723 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6724 (void)SvIOK_only(sv);
6729 while (isALPHA(*d)) d++;
6730 while (isDIGIT(*d)) d++;
6732 #ifdef PERL_PRESERVE_IVUV
6733 /* Got to punt this as an integer if needs be, but we don't issue
6734 warnings. Probably ought to make the sv_iv_please() that does
6735 the conversion if possible, and silently. */
6736 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6737 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6738 /* Need to try really hard to see if it's an integer.
6739 9.22337203685478e+18 is an integer.
6740 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6741 so $a="9.22337203685478e+18"; $a+0; $a++
6742 needs to be the same as $a="9.22337203685478e+18"; $a++
6749 /* sv_2iv *should* have made this an NV */
6750 if (flags & SVp_NOK) {
6751 (void)SvNOK_only(sv);
6752 SvNV_set(sv, SvNVX(sv) + 1.0);
6755 /* I don't think we can get here. Maybe I should assert this
6756 And if we do get here I suspect that sv_setnv will croak. NWC
6758 #if defined(USE_LONG_DOUBLE)
6759 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",
6760 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6762 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6763 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6766 #endif /* PERL_PRESERVE_IVUV */
6767 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6771 while (d >= SvPVX_const(sv)) {
6779 /* MKS: The original code here died if letters weren't consecutive.
6780 * at least it didn't have to worry about non-C locales. The
6781 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6782 * arranged in order (although not consecutively) and that only
6783 * [A-Za-z] are accepted by isALPHA in the C locale.
6785 if (*d != 'z' && *d != 'Z') {
6786 do { ++*d; } while (!isALPHA(*d));
6789 *(d--) -= 'z' - 'a';
6794 *(d--) -= 'z' - 'a' + 1;
6798 /* oh,oh, the number grew */
6799 SvGROW(sv, SvCUR(sv) + 2);
6800 SvCUR_set(sv, SvCUR(sv) + 1);
6801 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6812 Auto-decrement of the value in the SV, doing string to numeric conversion
6813 if necessary. Handles 'get' magic.
6819 Perl_sv_dec(pTHX_ register SV *sv)
6827 if (SvTHINKFIRST(sv)) {
6829 sv_force_normal_flags(sv, 0);
6830 if (SvREADONLY(sv)) {
6831 if (IN_PERL_RUNTIME)
6832 Perl_croak(aTHX_ PL_no_modify);
6836 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6838 i = PTR2IV(SvRV(sv));
6843 /* Unlike sv_inc we don't have to worry about string-never-numbers
6844 and keeping them magic. But we mustn't warn on punting */
6845 flags = SvFLAGS(sv);
6846 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6847 /* It's publicly an integer, or privately an integer-not-float */
6848 #ifdef PERL_PRESERVE_IVUV
6852 if (SvUVX(sv) == 0) {
6853 (void)SvIOK_only(sv);
6857 (void)SvIOK_only_UV(sv);
6858 SvUV_set(sv, SvUVX(sv) - 1);
6861 if (SvIVX(sv) == IV_MIN)
6862 sv_setnv(sv, (NV)IV_MIN - 1.0);
6864 (void)SvIOK_only(sv);
6865 SvIV_set(sv, SvIVX(sv) - 1);
6870 if (flags & SVp_NOK) {
6871 SvNV_set(sv, SvNVX(sv) - 1.0);
6872 (void)SvNOK_only(sv);
6875 if (!(flags & SVp_POK)) {
6876 if ((flags & SVTYPEMASK) < SVt_PVIV)
6877 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6879 (void)SvIOK_only(sv);
6882 #ifdef PERL_PRESERVE_IVUV
6884 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6885 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6886 /* Need to try really hard to see if it's an integer.
6887 9.22337203685478e+18 is an integer.
6888 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6889 so $a="9.22337203685478e+18"; $a+0; $a--
6890 needs to be the same as $a="9.22337203685478e+18"; $a--
6897 /* sv_2iv *should* have made this an NV */
6898 if (flags & SVp_NOK) {
6899 (void)SvNOK_only(sv);
6900 SvNV_set(sv, SvNVX(sv) - 1.0);
6903 /* I don't think we can get here. Maybe I should assert this
6904 And if we do get here I suspect that sv_setnv will croak. NWC
6906 #if defined(USE_LONG_DOUBLE)
6907 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",
6908 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6910 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6911 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6915 #endif /* PERL_PRESERVE_IVUV */
6916 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6920 =for apidoc sv_mortalcopy
6922 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6923 The new SV is marked as mortal. It will be destroyed "soon", either by an
6924 explicit call to FREETMPS, or by an implicit call at places such as
6925 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6930 /* Make a string that will exist for the duration of the expression
6931 * evaluation. Actually, it may have to last longer than that, but
6932 * hopefully we won't free it until it has been assigned to a
6933 * permanent location. */
6936 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6942 sv_setsv(sv,oldstr);
6944 PL_tmps_stack[++PL_tmps_ix] = sv;
6950 =for apidoc sv_newmortal
6952 Creates a new null SV which is mortal. The reference count of the SV is
6953 set to 1. It will be destroyed "soon", either by an explicit call to
6954 FREETMPS, or by an implicit call at places such as statement boundaries.
6955 See also C<sv_mortalcopy> and C<sv_2mortal>.
6961 Perl_sv_newmortal(pTHX)
6967 SvFLAGS(sv) = SVs_TEMP;
6969 PL_tmps_stack[++PL_tmps_ix] = sv;
6974 =for apidoc sv_2mortal
6976 Marks an existing SV as mortal. The SV will be destroyed "soon", either
6977 by an explicit call to FREETMPS, or by an implicit call at places such as
6978 statement boundaries. SvTEMP() is turned on which means that the SV's
6979 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
6980 and C<sv_mortalcopy>.
6986 Perl_sv_2mortal(pTHX_ register SV *sv)
6991 if (SvREADONLY(sv) && SvIMMORTAL(sv))
6994 PL_tmps_stack[++PL_tmps_ix] = sv;
7002 Creates a new SV and copies a string into it. The reference count for the
7003 SV is set to 1. If C<len> is zero, Perl will compute the length using
7004 strlen(). For efficiency, consider using C<newSVpvn> instead.
7010 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7016 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7021 =for apidoc newSVpvn
7023 Creates a new SV and copies a string into it. The reference count for the
7024 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7025 string. You are responsible for ensuring that the source string is at least
7026 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7032 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7038 sv_setpvn(sv,s,len);
7044 =for apidoc newSVhek
7046 Creates a new SV from the hash key structure. It will generate scalars that
7047 point to the shared string table where possible. Returns a new (undefined)
7048 SV if the hek is NULL.
7054 Perl_newSVhek(pTHX_ const HEK *hek)
7064 if (HEK_LEN(hek) == HEf_SVKEY) {
7065 return newSVsv(*(SV**)HEK_KEY(hek));
7067 const int flags = HEK_FLAGS(hek);
7068 if (flags & HVhek_WASUTF8) {
7070 Andreas would like keys he put in as utf8 to come back as utf8
7072 STRLEN utf8_len = HEK_LEN(hek);
7073 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7074 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7077 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7079 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7080 /* We don't have a pointer to the hv, so we have to replicate the
7081 flag into every HEK. This hv is using custom a hasing
7082 algorithm. Hence we can't return a shared string scalar, as
7083 that would contain the (wrong) hash value, and might get passed
7084 into an hv routine with a regular hash.
7085 Similarly, a hash that isn't using shared hash keys has to have
7086 the flag in every key so that we know not to try to call
7087 share_hek_kek on it. */
7089 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7094 /* This will be overwhelminly the most common case. */
7096 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7097 more efficient than sharepvn(). */
7101 sv_upgrade(sv, SVt_PV);
7102 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7103 SvCUR_set(sv, HEK_LEN(hek));
7116 =for apidoc newSVpvn_share
7118 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7119 table. If the string does not already exist in the table, it is created
7120 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7121 value is used; otherwise the hash is computed. The string's hash can be later
7122 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7123 that as the string table is used for shared hash keys these strings will have
7124 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7130 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7134 bool is_utf8 = FALSE;
7135 const char *const orig_src = src;
7138 STRLEN tmplen = -len;
7140 /* See the note in hv.c:hv_fetch() --jhi */
7141 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7145 PERL_HASH(hash, src, len);
7147 sv_upgrade(sv, SVt_PV);
7148 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7156 if (src != orig_src)
7162 #if defined(PERL_IMPLICIT_CONTEXT)
7164 /* pTHX_ magic can't cope with varargs, so this is a no-context
7165 * version of the main function, (which may itself be aliased to us).
7166 * Don't access this version directly.
7170 Perl_newSVpvf_nocontext(const char* pat, ...)
7175 va_start(args, pat);
7176 sv = vnewSVpvf(pat, &args);
7183 =for apidoc newSVpvf
7185 Creates a new SV and initializes it with the string formatted like
7192 Perl_newSVpvf(pTHX_ const char* pat, ...)
7196 va_start(args, pat);
7197 sv = vnewSVpvf(pat, &args);
7202 /* backend for newSVpvf() and newSVpvf_nocontext() */
7205 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7210 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7217 Creates a new SV and copies a floating point value into it.
7218 The reference count for the SV is set to 1.
7224 Perl_newSVnv(pTHX_ NV n)
7237 Creates a new SV and copies an integer into it. The reference count for the
7244 Perl_newSViv(pTHX_ IV i)
7257 Creates a new SV and copies an unsigned integer into it.
7258 The reference count for the SV is set to 1.
7264 Perl_newSVuv(pTHX_ UV u)
7275 =for apidoc newSV_type
7277 Creates a new SV, of the type specified. The reference count for the new SV
7284 Perl_newSV_type(pTHX_ svtype type)
7289 sv_upgrade(sv, type);
7294 =for apidoc newRV_noinc
7296 Creates an RV wrapper for an SV. The reference count for the original
7297 SV is B<not> incremented.
7303 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7306 register SV *sv = newSV_type(SVt_IV);
7308 SvRV_set(sv, tmpRef);
7313 /* newRV_inc is the official function name to use now.
7314 * newRV_inc is in fact #defined to newRV in sv.h
7318 Perl_newRV(pTHX_ SV *sv)
7321 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7327 Creates a new SV which is an exact duplicate of the original SV.
7334 Perl_newSVsv(pTHX_ register SV *old)
7341 if (SvTYPE(old) == SVTYPEMASK) {
7342 if (ckWARN_d(WARN_INTERNAL))
7343 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7347 /* SV_GMAGIC is the default for sv_setv()
7348 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7349 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7350 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7355 =for apidoc sv_reset
7357 Underlying implementation for the C<reset> Perl function.
7358 Note that the perl-level function is vaguely deprecated.
7364 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7367 char todo[PERL_UCHAR_MAX+1];
7372 if (!*s) { /* reset ?? searches */
7373 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7375 const U32 count = mg->mg_len / sizeof(PMOP**);
7376 PMOP **pmp = (PMOP**) mg->mg_ptr;
7377 PMOP *const *const end = pmp + count;
7381 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7383 (*pmp)->op_pmflags &= ~PMf_USED;
7391 /* reset variables */
7393 if (!HvARRAY(stash))
7396 Zero(todo, 256, char);
7399 I32 i = (unsigned char)*s;
7403 max = (unsigned char)*s++;
7404 for ( ; i <= max; i++) {
7407 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7409 for (entry = HvARRAY(stash)[i];
7411 entry = HeNEXT(entry))
7416 if (!todo[(U8)*HeKEY(entry)])
7418 gv = (GV*)HeVAL(entry);
7421 if (SvTHINKFIRST(sv)) {
7422 if (!SvREADONLY(sv) && SvROK(sv))
7424 /* XXX Is this continue a bug? Why should THINKFIRST
7425 exempt us from resetting arrays and hashes? */
7429 if (SvTYPE(sv) >= SVt_PV) {
7431 if (SvPVX_const(sv) != NULL)
7439 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7441 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7444 # if defined(USE_ENVIRON_ARRAY)
7447 # endif /* USE_ENVIRON_ARRAY */
7458 Using various gambits, try to get an IO from an SV: the IO slot if its a
7459 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7460 named after the PV if we're a string.
7466 Perl_sv_2io(pTHX_ SV *sv)
7471 switch (SvTYPE(sv)) {
7479 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7483 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7485 return sv_2io(SvRV(sv));
7486 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7492 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7501 Using various gambits, try to get a CV from an SV; in addition, try if
7502 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7503 The flags in C<lref> are passed to sv_fetchsv.
7509 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7520 switch (SvTYPE(sv)) {
7539 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7540 tryAMAGICunDEREF(to_cv);
7543 if (SvTYPE(sv) == SVt_PVCV) {
7552 Perl_croak(aTHX_ "Not a subroutine reference");
7557 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7563 /* Some flags to gv_fetchsv mean don't really create the GV */
7564 if (SvTYPE(gv) != SVt_PVGV) {
7570 if (lref && !GvCVu(gv)) {
7574 gv_efullname3(tmpsv, gv, NULL);
7575 /* XXX this is probably not what they think they're getting.
7576 * It has the same effect as "sub name;", i.e. just a forward
7578 newSUB(start_subparse(FALSE, 0),
7579 newSVOP(OP_CONST, 0, tmpsv),
7583 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7593 Returns true if the SV has a true value by Perl's rules.
7594 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7595 instead use an in-line version.
7601 Perl_sv_true(pTHX_ register SV *sv)
7606 register const XPV* const tXpv = (XPV*)SvANY(sv);
7608 (tXpv->xpv_cur > 1 ||
7609 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7616 return SvIVX(sv) != 0;
7619 return SvNVX(sv) != 0.0;
7621 return sv_2bool(sv);
7627 =for apidoc sv_pvn_force
7629 Get a sensible string out of the SV somehow.
7630 A private implementation of the C<SvPV_force> macro for compilers which
7631 can't cope with complex macro expressions. Always use the macro instead.
7633 =for apidoc sv_pvn_force_flags
7635 Get a sensible string out of the SV somehow.
7636 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7637 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7638 implemented in terms of this function.
7639 You normally want to use the various wrapper macros instead: see
7640 C<SvPV_force> and C<SvPV_force_nomg>
7646 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7649 if (SvTHINKFIRST(sv) && !SvROK(sv))
7650 sv_force_normal_flags(sv, 0);
7660 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7661 const char * const ref = sv_reftype(sv,0);
7663 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7664 ref, OP_NAME(PL_op));
7666 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7668 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7669 || isGV_with_GP(sv))
7670 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7672 s = sv_2pv_flags(sv, &len, flags);
7676 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7679 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7680 SvGROW(sv, len + 1);
7681 Move(s,SvPVX(sv),len,char);
7683 SvPVX(sv)[len] = '\0';
7686 SvPOK_on(sv); /* validate pointer */
7688 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7689 PTR2UV(sv),SvPVX_const(sv)));
7692 return SvPVX_mutable(sv);
7696 =for apidoc sv_pvbyten_force
7698 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7704 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7706 sv_pvn_force(sv,lp);
7707 sv_utf8_downgrade(sv,0);
7713 =for apidoc sv_pvutf8n_force
7715 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7721 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7723 sv_pvn_force(sv,lp);
7724 sv_utf8_upgrade(sv);
7730 =for apidoc sv_reftype
7732 Returns a string describing what the SV is a reference to.
7738 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7740 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7741 inside return suggests a const propagation bug in g++. */
7742 if (ob && SvOBJECT(sv)) {
7743 char * const name = HvNAME_get(SvSTASH(sv));
7744 return name ? name : (char *) "__ANON__";
7747 switch (SvTYPE(sv)) {
7762 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7763 /* tied lvalues should appear to be
7764 * scalars for backwards compatitbility */
7765 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7766 ? "SCALAR" : "LVALUE");
7767 case SVt_PVAV: return "ARRAY";
7768 case SVt_PVHV: return "HASH";
7769 case SVt_PVCV: return "CODE";
7770 case SVt_PVGV: return "GLOB";
7771 case SVt_PVFM: return "FORMAT";
7772 case SVt_PVIO: return "IO";
7773 case SVt_BIND: return "BIND";
7774 case SVt_ORANGE: return "ORANGE";
7775 default: return "UNKNOWN";
7781 =for apidoc sv_isobject
7783 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7784 object. If the SV is not an RV, or if the object is not blessed, then this
7791 Perl_sv_isobject(pTHX_ SV *sv)
7807 Returns a boolean indicating whether the SV is blessed into the specified
7808 class. This does not check for subtypes; use C<sv_derived_from> to verify
7809 an inheritance relationship.
7815 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7826 hvname = HvNAME_get(SvSTASH(sv));
7830 return strEQ(hvname, name);
7836 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7837 it will be upgraded to one. If C<classname> is non-null then the new SV will
7838 be blessed in the specified package. The new SV is returned and its
7839 reference count is 1.
7845 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7852 SV_CHECK_THINKFIRST_COW_DROP(rv);
7853 (void)SvAMAGIC_off(rv);
7855 if (SvTYPE(rv) >= SVt_PVMG) {
7856 const U32 refcnt = SvREFCNT(rv);
7860 SvREFCNT(rv) = refcnt;
7862 sv_upgrade(rv, SVt_IV);
7863 } else if (SvROK(rv)) {
7864 SvREFCNT_dec(SvRV(rv));
7866 prepare_SV_for_RV(rv);
7874 HV* const stash = gv_stashpv(classname, GV_ADD);
7875 (void)sv_bless(rv, stash);
7881 =for apidoc sv_setref_pv
7883 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7884 argument will be upgraded to an RV. That RV will be modified to point to
7885 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7886 into the SV. The C<classname> argument indicates the package for the
7887 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7888 will have a reference count of 1, and the RV will be returned.
7890 Do not use with other Perl types such as HV, AV, SV, CV, because those
7891 objects will become corrupted by the pointer copy process.
7893 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7899 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7903 sv_setsv(rv, &PL_sv_undef);
7907 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7912 =for apidoc sv_setref_iv
7914 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7915 argument will be upgraded to an RV. That RV will be modified to point to
7916 the new SV. The C<classname> argument indicates the package for the
7917 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7918 will have a reference count of 1, and the RV will be returned.
7924 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7926 sv_setiv(newSVrv(rv,classname), iv);
7931 =for apidoc sv_setref_uv
7933 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7934 argument will be upgraded to an RV. That RV will be modified to point to
7935 the new SV. The C<classname> argument indicates the package for the
7936 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7937 will have a reference count of 1, and the RV will be returned.
7943 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7945 sv_setuv(newSVrv(rv,classname), uv);
7950 =for apidoc sv_setref_nv
7952 Copies a double into a new SV, optionally blessing the SV. The C<rv>
7953 argument will be upgraded to an RV. That RV will be modified to point to
7954 the new SV. The C<classname> argument indicates the package for the
7955 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7956 will have a reference count of 1, and the RV will be returned.
7962 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
7964 sv_setnv(newSVrv(rv,classname), nv);
7969 =for apidoc sv_setref_pvn
7971 Copies a string into a new SV, optionally blessing the SV. The length of the
7972 string must be specified with C<n>. The C<rv> argument will be upgraded to
7973 an RV. That RV will be modified to point to the new SV. The C<classname>
7974 argument indicates the package for the blessing. Set C<classname> to
7975 C<NULL> to avoid the blessing. The new SV will have a reference count
7976 of 1, and the RV will be returned.
7978 Note that C<sv_setref_pv> copies the pointer while this copies the string.
7984 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
7986 sv_setpvn(newSVrv(rv,classname), pv, n);
7991 =for apidoc sv_bless
7993 Blesses an SV into a specified package. The SV must be an RV. The package
7994 must be designated by its stash (see C<gv_stashpv()>). The reference count
7995 of the SV is unaffected.
8001 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8006 Perl_croak(aTHX_ "Can't bless non-reference value");
8008 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8009 if (SvIsCOW(tmpRef))
8010 sv_force_normal_flags(tmpRef, 0);
8011 if (SvREADONLY(tmpRef))
8012 Perl_croak(aTHX_ PL_no_modify);
8013 if (SvOBJECT(tmpRef)) {
8014 if (SvTYPE(tmpRef) != SVt_PVIO)
8016 SvREFCNT_dec(SvSTASH(tmpRef));
8019 SvOBJECT_on(tmpRef);
8020 if (SvTYPE(tmpRef) != SVt_PVIO)
8022 SvUPGRADE(tmpRef, SVt_PVMG);
8023 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8028 (void)SvAMAGIC_off(sv);
8030 if(SvSMAGICAL(tmpRef))
8031 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8039 /* Downgrades a PVGV to a PVMG.
8043 S_sv_unglob(pTHX_ SV *sv)
8048 SV * const temp = sv_newmortal();
8050 assert(SvTYPE(sv) == SVt_PVGV);
8052 gv_efullname3(temp, (GV *) sv, "*");
8055 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8056 mro_method_changed_in(stash);
8060 sv_del_backref((SV*)GvSTASH(sv), sv);
8064 if (GvNAME_HEK(sv)) {
8065 unshare_hek(GvNAME_HEK(sv));
8067 isGV_with_GP_off(sv);
8069 /* need to keep SvANY(sv) in the right arena */
8070 xpvmg = new_XPVMG();
8071 StructCopy(SvANY(sv), xpvmg, XPVMG);
8072 del_XPVGV(SvANY(sv));
8075 SvFLAGS(sv) &= ~SVTYPEMASK;
8076 SvFLAGS(sv) |= SVt_PVMG;
8078 /* Intentionally not calling any local SET magic, as this isn't so much a
8079 set operation as merely an internal storage change. */
8080 sv_setsv_flags(sv, temp, 0);
8084 =for apidoc sv_unref_flags
8086 Unsets the RV status of the SV, and decrements the reference count of
8087 whatever was being referenced by the RV. This can almost be thought of
8088 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8089 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8090 (otherwise the decrementing is conditional on the reference count being
8091 different from one or the reference being a readonly SV).
8098 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8100 SV* const target = SvRV(ref);
8102 if (SvWEAKREF(ref)) {
8103 sv_del_backref(target, ref);
8105 SvRV_set(ref, NULL);
8108 SvRV_set(ref, NULL);
8110 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8111 assigned to as BEGIN {$a = \"Foo"} will fail. */
8112 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8113 SvREFCNT_dec(target);
8114 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8115 sv_2mortal(target); /* Schedule for freeing later */
8119 =for apidoc sv_untaint
8121 Untaint an SV. Use C<SvTAINTED_off> instead.
8126 Perl_sv_untaint(pTHX_ SV *sv)
8128 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8129 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8136 =for apidoc sv_tainted
8138 Test an SV for taintedness. Use C<SvTAINTED> instead.
8143 Perl_sv_tainted(pTHX_ SV *sv)
8145 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8146 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8147 if (mg && (mg->mg_len & 1) )
8154 =for apidoc sv_setpviv
8156 Copies an integer into the given SV, also updating its string value.
8157 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8163 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8165 char buf[TYPE_CHARS(UV)];
8167 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8169 sv_setpvn(sv, ptr, ebuf - ptr);
8173 =for apidoc sv_setpviv_mg
8175 Like C<sv_setpviv>, but also handles 'set' magic.
8181 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8187 #if defined(PERL_IMPLICIT_CONTEXT)
8189 /* pTHX_ magic can't cope with varargs, so this is a no-context
8190 * version of the main function, (which may itself be aliased to us).
8191 * Don't access this version directly.
8195 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8199 va_start(args, pat);
8200 sv_vsetpvf(sv, pat, &args);
8204 /* pTHX_ magic can't cope with varargs, so this is a no-context
8205 * version of the main function, (which may itself be aliased to us).
8206 * Don't access this version directly.
8210 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8214 va_start(args, pat);
8215 sv_vsetpvf_mg(sv, pat, &args);
8221 =for apidoc sv_setpvf
8223 Works like C<sv_catpvf> but copies the text into the SV instead of
8224 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8230 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8233 va_start(args, pat);
8234 sv_vsetpvf(sv, pat, &args);
8239 =for apidoc sv_vsetpvf
8241 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8242 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8244 Usually used via its frontend C<sv_setpvf>.
8250 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8252 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8256 =for apidoc sv_setpvf_mg
8258 Like C<sv_setpvf>, but also handles 'set' magic.
8264 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8267 va_start(args, pat);
8268 sv_vsetpvf_mg(sv, pat, &args);
8273 =for apidoc sv_vsetpvf_mg
8275 Like C<sv_vsetpvf>, but also handles 'set' magic.
8277 Usually used via its frontend C<sv_setpvf_mg>.
8283 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8285 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8289 #if defined(PERL_IMPLICIT_CONTEXT)
8291 /* pTHX_ magic can't cope with varargs, so this is a no-context
8292 * version of the main function, (which may itself be aliased to us).
8293 * Don't access this version directly.
8297 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8301 va_start(args, pat);
8302 sv_vcatpvf(sv, pat, &args);
8306 /* pTHX_ magic can't cope with varargs, so this is a no-context
8307 * version of the main function, (which may itself be aliased to us).
8308 * Don't access this version directly.
8312 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8316 va_start(args, pat);
8317 sv_vcatpvf_mg(sv, pat, &args);
8323 =for apidoc sv_catpvf
8325 Processes its arguments like C<sprintf> and appends the formatted
8326 output to an SV. If the appended data contains "wide" characters
8327 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8328 and characters >255 formatted with %c), the original SV might get
8329 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8330 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8331 valid UTF-8; if the original SV was bytes, the pattern should be too.
8336 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8339 va_start(args, pat);
8340 sv_vcatpvf(sv, pat, &args);
8345 =for apidoc sv_vcatpvf
8347 Processes its arguments like C<vsprintf> and appends the formatted output
8348 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8350 Usually used via its frontend C<sv_catpvf>.
8356 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8358 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8362 =for apidoc sv_catpvf_mg
8364 Like C<sv_catpvf>, but also handles 'set' magic.
8370 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8373 va_start(args, pat);
8374 sv_vcatpvf_mg(sv, pat, &args);
8379 =for apidoc sv_vcatpvf_mg
8381 Like C<sv_vcatpvf>, but also handles 'set' magic.
8383 Usually used via its frontend C<sv_catpvf_mg>.
8389 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8391 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8396 =for apidoc sv_vsetpvfn
8398 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8401 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8407 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8409 sv_setpvn(sv, "", 0);
8410 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8414 S_expect_number(pTHX_ char** pattern)
8418 switch (**pattern) {
8419 case '1': case '2': case '3':
8420 case '4': case '5': case '6':
8421 case '7': case '8': case '9':
8422 var = *(*pattern)++ - '0';
8423 while (isDIGIT(**pattern)) {
8424 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8426 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8434 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8436 const int neg = nv < 0;
8445 if (uv & 1 && uv == nv)
8446 uv--; /* Round to even */
8448 const unsigned dig = uv % 10;
8461 =for apidoc sv_vcatpvfn
8463 Processes its arguments like C<vsprintf> and appends the formatted output
8464 to an SV. Uses an array of SVs if the C style variable argument list is
8465 missing (NULL). When running with taint checks enabled, indicates via
8466 C<maybe_tainted> if results are untrustworthy (often due to the use of
8469 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8475 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8476 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8477 vec_utf8 = DO_UTF8(vecsv);
8479 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8482 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8490 static const char nullstr[] = "(null)";
8492 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8493 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8495 /* Times 4: a decimal digit takes more than 3 binary digits.
8496 * NV_DIG: mantissa takes than many decimal digits.
8497 * Plus 32: Playing safe. */
8498 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8499 /* large enough for "%#.#f" --chip */
8500 /* what about long double NVs? --jhi */
8502 PERL_UNUSED_ARG(maybe_tainted);
8504 /* no matter what, this is a string now */
8505 (void)SvPV_force(sv, origlen);
8507 /* special-case "", "%s", and "%-p" (SVf - see below) */
8510 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8512 const char * const s = va_arg(*args, char*);
8513 sv_catpv(sv, s ? s : nullstr);
8515 else if (svix < svmax) {
8516 sv_catsv(sv, *svargs);
8520 if (args && patlen == 3 && pat[0] == '%' &&
8521 pat[1] == '-' && pat[2] == 'p') {
8522 argsv = (SV*)va_arg(*args, void*);
8523 sv_catsv(sv, argsv);
8527 #ifndef USE_LONG_DOUBLE
8528 /* special-case "%.<number>[gf]" */
8529 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8530 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8531 unsigned digits = 0;
8535 while (*pp >= '0' && *pp <= '9')
8536 digits = 10 * digits + (*pp++ - '0');
8537 if (pp - pat == (int)patlen - 1) {
8545 /* Add check for digits != 0 because it seems that some
8546 gconverts are buggy in this case, and we don't yet have
8547 a Configure test for this. */
8548 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8549 /* 0, point, slack */
8550 Gconvert(nv, (int)digits, 0, ebuf);
8552 if (*ebuf) /* May return an empty string for digits==0 */
8555 } else if (!digits) {
8558 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8559 sv_catpvn(sv, p, l);
8565 #endif /* !USE_LONG_DOUBLE */
8567 if (!args && svix < svmax && DO_UTF8(*svargs))
8570 patend = (char*)pat + patlen;
8571 for (p = (char*)pat; p < patend; p = q) {
8574 bool vectorize = FALSE;
8575 bool vectorarg = FALSE;
8576 bool vec_utf8 = FALSE;
8582 bool has_precis = FALSE;
8584 const I32 osvix = svix;
8585 bool is_utf8 = FALSE; /* is this item utf8? */
8586 #ifdef HAS_LDBL_SPRINTF_BUG
8587 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8588 with sfio - Allen <allens@cpan.org> */
8589 bool fix_ldbl_sprintf_bug = FALSE;
8593 U8 utf8buf[UTF8_MAXBYTES+1];
8594 STRLEN esignlen = 0;
8596 const char *eptr = NULL;
8599 const U8 *vecstr = NULL;
8606 /* we need a long double target in case HAS_LONG_DOUBLE but
8609 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8617 const char *dotstr = ".";
8618 STRLEN dotstrlen = 1;
8619 I32 efix = 0; /* explicit format parameter index */
8620 I32 ewix = 0; /* explicit width index */
8621 I32 epix = 0; /* explicit precision index */
8622 I32 evix = 0; /* explicit vector index */
8623 bool asterisk = FALSE;
8625 /* echo everything up to the next format specification */
8626 for (q = p; q < patend && *q != '%'; ++q) ;
8628 if (has_utf8 && !pat_utf8)
8629 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8631 sv_catpvn(sv, p, q - p);
8638 We allow format specification elements in this order:
8639 \d+\$ explicit format parameter index
8641 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8642 0 flag (as above): repeated to allow "v02"
8643 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8644 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8646 [%bcdefginopsuxDFOUX] format (mandatory)
8651 As of perl5.9.3, printf format checking is on by default.
8652 Internally, perl uses %p formats to provide an escape to
8653 some extended formatting. This block deals with those
8654 extensions: if it does not match, (char*)q is reset and
8655 the normal format processing code is used.
8657 Currently defined extensions are:
8658 %p include pointer address (standard)
8659 %-p (SVf) include an SV (previously %_)
8660 %-<num>p include an SV with precision <num>
8661 %<num>p reserved for future extensions
8663 Robin Barker 2005-07-14
8665 %1p (VDf) removed. RMB 2007-10-19
8672 n = expect_number(&q);
8679 argsv = (SV*)va_arg(*args, void*);
8680 eptr = SvPV_const(argsv, elen);
8686 if (ckWARN_d(WARN_INTERNAL))
8687 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8688 "internal %%<num>p might conflict with future printf extensions");
8694 if ( (width = expect_number(&q)) ) {
8709 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8738 if ( (ewix = expect_number(&q)) )
8747 if ((vectorarg = asterisk)) {
8760 width = expect_number(&q);
8766 vecsv = va_arg(*args, SV*);
8768 vecsv = (evix > 0 && evix <= svmax)
8769 ? svargs[evix-1] : &PL_sv_undef;
8771 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8773 dotstr = SvPV_const(vecsv, dotstrlen);
8774 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8775 bad with tied or overloaded values that return UTF8. */
8778 else if (has_utf8) {
8779 vecsv = sv_mortalcopy(vecsv);
8780 sv_utf8_upgrade(vecsv);
8781 dotstr = SvPV_const(vecsv, dotstrlen);
8788 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8789 vecsv = svargs[efix ? efix-1 : svix++];
8790 vecstr = (U8*)SvPV_const(vecsv,veclen);
8791 vec_utf8 = DO_UTF8(vecsv);
8793 /* if this is a version object, we need to convert
8794 * back into v-string notation and then let the
8795 * vectorize happen normally
8797 if (sv_derived_from(vecsv, "version")) {
8798 char *version = savesvpv(vecsv);
8799 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8800 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8801 "vector argument not supported with alpha versions");
8804 vecsv = sv_newmortal();
8805 scan_vstring(version, version + veclen, vecsv);
8806 vecstr = (U8*)SvPV_const(vecsv, veclen);
8807 vec_utf8 = DO_UTF8(vecsv);
8819 i = va_arg(*args, int);
8821 i = (ewix ? ewix <= svmax : svix < svmax) ?
8822 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8824 width = (i < 0) ? -i : i;
8834 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8836 /* XXX: todo, support specified precision parameter */
8840 i = va_arg(*args, int);
8842 i = (ewix ? ewix <= svmax : svix < svmax)
8843 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8845 has_precis = !(i < 0);
8850 precis = precis * 10 + (*q++ - '0');
8859 case 'I': /* Ix, I32x, and I64x */
8861 if (q[1] == '6' && q[2] == '4') {
8867 if (q[1] == '3' && q[2] == '2') {
8877 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8888 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8889 if (*(q + 1) == 'l') { /* lld, llf */
8915 if (!vectorize && !args) {
8917 const I32 i = efix-1;
8918 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8920 argsv = (svix >= 0 && svix < svmax)
8921 ? svargs[svix++] : &PL_sv_undef;
8932 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
8934 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
8936 eptr = (char*)utf8buf;
8937 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
8951 eptr = va_arg(*args, char*);
8953 #ifdef MACOS_TRADITIONAL
8954 /* On MacOS, %#s format is used for Pascal strings */
8959 elen = strlen(eptr);
8961 eptr = (char *)nullstr;
8962 elen = sizeof nullstr - 1;
8966 eptr = SvPV_const(argsv, elen);
8967 if (DO_UTF8(argsv)) {
8968 I32 old_precis = precis;
8969 if (has_precis && precis < elen) {
8971 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
8974 if (width) { /* fudge width (can't fudge elen) */
8975 if (has_precis && precis < elen)
8976 width += precis - old_precis;
8978 width += elen - sv_len_utf8(argsv);
8985 if (has_precis && elen > precis)
8992 if (alt || vectorize)
8994 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9015 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9024 esignbuf[esignlen++] = plus;
9028 case 'h': iv = (short)va_arg(*args, int); break;
9029 case 'l': iv = va_arg(*args, long); break;
9030 case 'V': iv = va_arg(*args, IV); break;
9031 default: iv = va_arg(*args, int); break;
9033 case 'q': iv = va_arg(*args, Quad_t); break;
9038 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9040 case 'h': iv = (short)tiv; break;
9041 case 'l': iv = (long)tiv; break;
9043 default: iv = tiv; break;
9045 case 'q': iv = (Quad_t)tiv; break;
9049 if ( !vectorize ) /* we already set uv above */
9054 esignbuf[esignlen++] = plus;
9058 esignbuf[esignlen++] = '-';
9102 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9113 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9114 case 'l': uv = va_arg(*args, unsigned long); break;
9115 case 'V': uv = va_arg(*args, UV); break;
9116 default: uv = va_arg(*args, unsigned); break;
9118 case 'q': uv = va_arg(*args, Uquad_t); break;
9123 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9125 case 'h': uv = (unsigned short)tuv; break;
9126 case 'l': uv = (unsigned long)tuv; break;
9128 default: uv = tuv; break;
9130 case 'q': uv = (Uquad_t)tuv; break;
9137 char *ptr = ebuf + sizeof ebuf;
9138 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9144 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9150 esignbuf[esignlen++] = '0';
9151 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9159 if (alt && *ptr != '0')
9168 esignbuf[esignlen++] = '0';
9169 esignbuf[esignlen++] = c;
9172 default: /* it had better be ten or less */
9176 } while (uv /= base);
9179 elen = (ebuf + sizeof ebuf) - ptr;
9183 zeros = precis - elen;
9184 else if (precis == 0 && elen == 1 && *eptr == '0'
9185 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9188 /* a precision nullifies the 0 flag. */
9195 /* FLOATING POINT */
9198 c = 'f'; /* maybe %F isn't supported here */
9206 /* This is evil, but floating point is even more evil */
9208 /* for SV-style calling, we can only get NV
9209 for C-style calling, we assume %f is double;
9210 for simplicity we allow any of %Lf, %llf, %qf for long double
9214 #if defined(USE_LONG_DOUBLE)
9218 /* [perl #20339] - we should accept and ignore %lf rather than die */
9222 #if defined(USE_LONG_DOUBLE)
9223 intsize = args ? 0 : 'q';
9227 #if defined(HAS_LONG_DOUBLE)
9236 /* now we need (long double) if intsize == 'q', else (double) */
9238 #if LONG_DOUBLESIZE > DOUBLESIZE
9240 va_arg(*args, long double) :
9241 va_arg(*args, double)
9243 va_arg(*args, double)
9248 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9249 else. frexp() has some unspecified behaviour for those three */
9250 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9252 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9253 will cast our (long double) to (double) */
9254 (void)Perl_frexp(nv, &i);
9255 if (i == PERL_INT_MIN)
9256 Perl_die(aTHX_ "panic: frexp");
9258 need = BIT_DIGITS(i);
9260 need += has_precis ? precis : 6; /* known default */
9265 #ifdef HAS_LDBL_SPRINTF_BUG
9266 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9267 with sfio - Allen <allens@cpan.org> */
9270 # define MY_DBL_MAX DBL_MAX
9271 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9272 # if DOUBLESIZE >= 8
9273 # define MY_DBL_MAX 1.7976931348623157E+308L
9275 # define MY_DBL_MAX 3.40282347E+38L
9279 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9280 # define MY_DBL_MAX_BUG 1L
9282 # define MY_DBL_MAX_BUG MY_DBL_MAX
9286 # define MY_DBL_MIN DBL_MIN
9287 # else /* XXX guessing! -Allen */
9288 # if DOUBLESIZE >= 8
9289 # define MY_DBL_MIN 2.2250738585072014E-308L
9291 # define MY_DBL_MIN 1.17549435E-38L
9295 if ((intsize == 'q') && (c == 'f') &&
9296 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9298 /* it's going to be short enough that
9299 * long double precision is not needed */
9301 if ((nv <= 0L) && (nv >= -0L))
9302 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9304 /* would use Perl_fp_class as a double-check but not
9305 * functional on IRIX - see perl.h comments */
9307 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9308 /* It's within the range that a double can represent */
9309 #if defined(DBL_MAX) && !defined(DBL_MIN)
9310 if ((nv >= ((long double)1/DBL_MAX)) ||
9311 (nv <= (-(long double)1/DBL_MAX)))
9313 fix_ldbl_sprintf_bug = TRUE;
9316 if (fix_ldbl_sprintf_bug == TRUE) {
9326 # undef MY_DBL_MAX_BUG
9329 #endif /* HAS_LDBL_SPRINTF_BUG */
9331 need += 20; /* fudge factor */
9332 if (PL_efloatsize < need) {
9333 Safefree(PL_efloatbuf);
9334 PL_efloatsize = need + 20; /* more fudge */
9335 Newx(PL_efloatbuf, PL_efloatsize, char);
9336 PL_efloatbuf[0] = '\0';
9339 if ( !(width || left || plus || alt) && fill != '0'
9340 && has_precis && intsize != 'q' ) { /* Shortcuts */
9341 /* See earlier comment about buggy Gconvert when digits,
9343 if ( c == 'g' && precis) {
9344 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9345 /* May return an empty string for digits==0 */
9346 if (*PL_efloatbuf) {
9347 elen = strlen(PL_efloatbuf);
9348 goto float_converted;
9350 } else if ( c == 'f' && !precis) {
9351 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9356 char *ptr = ebuf + sizeof ebuf;
9359 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9360 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9361 if (intsize == 'q') {
9362 /* Copy the one or more characters in a long double
9363 * format before the 'base' ([efgEFG]) character to
9364 * the format string. */
9365 static char const prifldbl[] = PERL_PRIfldbl;
9366 char const *p = prifldbl + sizeof(prifldbl) - 3;
9367 while (p >= prifldbl) { *--ptr = *p--; }
9372 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9377 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9389 /* No taint. Otherwise we are in the strange situation
9390 * where printf() taints but print($float) doesn't.
9392 #if defined(HAS_LONG_DOUBLE)
9393 elen = ((intsize == 'q')
9394 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9395 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9397 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9401 eptr = PL_efloatbuf;
9409 i = SvCUR(sv) - origlen;
9412 case 'h': *(va_arg(*args, short*)) = i; break;
9413 default: *(va_arg(*args, int*)) = i; break;
9414 case 'l': *(va_arg(*args, long*)) = i; break;
9415 case 'V': *(va_arg(*args, IV*)) = i; break;
9417 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9422 sv_setuv_mg(argsv, (UV)i);
9423 continue; /* not "break" */
9430 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9431 && ckWARN(WARN_PRINTF))
9433 SV * const msg = sv_newmortal();
9434 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9435 (PL_op->op_type == OP_PRTF) ? "" : "s");
9438 Perl_sv_catpvf(aTHX_ msg,
9439 "\"%%%c\"", c & 0xFF);
9441 Perl_sv_catpvf(aTHX_ msg,
9442 "\"%%\\%03"UVof"\"",
9445 sv_catpvs(msg, "end of string");
9446 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9449 /* output mangled stuff ... */
9455 /* ... right here, because formatting flags should not apply */
9456 SvGROW(sv, SvCUR(sv) + elen + 1);
9458 Copy(eptr, p, elen, char);
9461 SvCUR_set(sv, p - SvPVX_const(sv));
9463 continue; /* not "break" */
9466 if (is_utf8 != has_utf8) {
9469 sv_utf8_upgrade(sv);
9472 const STRLEN old_elen = elen;
9473 SV * const nsv = sv_2mortal(newSVpvn(eptr, elen));
9474 sv_utf8_upgrade(nsv);
9475 eptr = SvPVX_const(nsv);
9478 if (width) { /* fudge width (can't fudge elen) */
9479 width += elen - old_elen;
9485 have = esignlen + zeros + elen;
9487 Perl_croak_nocontext(PL_memory_wrap);
9489 need = (have > width ? have : width);
9492 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9493 Perl_croak_nocontext(PL_memory_wrap);
9494 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9496 if (esignlen && fill == '0') {
9498 for (i = 0; i < (int)esignlen; i++)
9502 memset(p, fill, gap);
9505 if (esignlen && fill != '0') {
9507 for (i = 0; i < (int)esignlen; i++)
9512 for (i = zeros; i; i--)
9516 Copy(eptr, p, elen, char);
9520 memset(p, ' ', gap);
9525 Copy(dotstr, p, dotstrlen, char);
9529 vectorize = FALSE; /* done iterating over vecstr */
9536 SvCUR_set(sv, p - SvPVX_const(sv));
9544 /* =========================================================================
9546 =head1 Cloning an interpreter
9548 All the macros and functions in this section are for the private use of
9549 the main function, perl_clone().
9551 The foo_dup() functions make an exact copy of an existing foo thingy.
9552 During the course of a cloning, a hash table is used to map old addresses
9553 to new addresses. The table is created and manipulated with the
9554 ptr_table_* functions.
9558 ============================================================================*/
9561 #if defined(USE_ITHREADS)
9563 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9564 #ifndef GpREFCNT_inc
9565 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9569 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9570 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9571 If this changes, please unmerge ss_dup. */
9572 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9573 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9574 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9575 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9576 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9577 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9578 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9579 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9580 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9581 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9582 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9583 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9584 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9585 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9587 /* clone a parser */
9590 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9597 /* look for it in the table first */
9598 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9602 /* create anew and remember what it is */
9603 Newxz(parser, 1, yy_parser);
9604 ptr_table_store(PL_ptr_table, proto, parser);
9606 parser->yyerrstatus = 0;
9607 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9609 /* XXX these not yet duped */
9610 parser->old_parser = NULL;
9611 parser->stack = NULL;
9613 parser->stack_size = 0;
9614 /* XXX parser->stack->state = 0; */
9616 /* XXX eventually, just Copy() most of the parser struct ? */
9618 parser->lex_brackets = proto->lex_brackets;
9619 parser->lex_casemods = proto->lex_casemods;
9620 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9621 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9622 parser->lex_casestack = savepvn(proto->lex_casestack,
9623 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9624 parser->lex_defer = proto->lex_defer;
9625 parser->lex_dojoin = proto->lex_dojoin;
9626 parser->lex_expect = proto->lex_expect;
9627 parser->lex_formbrack = proto->lex_formbrack;
9628 parser->lex_inpat = proto->lex_inpat;
9629 parser->lex_inwhat = proto->lex_inwhat;
9630 parser->lex_op = proto->lex_op;
9631 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9632 parser->lex_starts = proto->lex_starts;
9633 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9634 parser->multi_close = proto->multi_close;
9635 parser->multi_open = proto->multi_open;
9636 parser->multi_start = proto->multi_start;
9637 parser->multi_end = proto->multi_end;
9638 parser->pending_ident = proto->pending_ident;
9639 parser->preambled = proto->preambled;
9640 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9641 parser->linestr = sv_dup_inc(proto->linestr, param);
9642 parser->expect = proto->expect;
9643 parser->copline = proto->copline;
9644 parser->last_lop_op = proto->last_lop_op;
9645 parser->lex_state = proto->lex_state;
9646 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9647 /* rsfp_filters entries have fake IoDIRP() */
9648 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9649 parser->in_my = proto->in_my;
9650 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9651 parser->error_count = proto->error_count;
9654 parser->linestr = sv_dup_inc(proto->linestr, param);
9657 char * const ols = SvPVX(proto->linestr);
9658 char * const ls = SvPVX(parser->linestr);
9660 parser->bufptr = ls + (proto->bufptr >= ols ?
9661 proto->bufptr - ols : 0);
9662 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9663 proto->oldbufptr - ols : 0);
9664 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9665 proto->oldoldbufptr - ols : 0);
9666 parser->linestart = ls + (proto->linestart >= ols ?
9667 proto->linestart - ols : 0);
9668 parser->last_uni = ls + (proto->last_uni >= ols ?
9669 proto->last_uni - ols : 0);
9670 parser->last_lop = ls + (proto->last_lop >= ols ?
9671 proto->last_lop - ols : 0);
9673 parser->bufend = ls + SvCUR(parser->linestr);
9676 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9680 parser->endwhite = proto->endwhite;
9681 parser->faketokens = proto->faketokens;
9682 parser->lasttoke = proto->lasttoke;
9683 parser->nextwhite = proto->nextwhite;
9684 parser->realtokenstart = proto->realtokenstart;
9685 parser->skipwhite = proto->skipwhite;
9686 parser->thisclose = proto->thisclose;
9687 parser->thismad = proto->thismad;
9688 parser->thisopen = proto->thisopen;
9689 parser->thisstuff = proto->thisstuff;
9690 parser->thistoken = proto->thistoken;
9691 parser->thiswhite = proto->thiswhite;
9693 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9694 parser->curforce = proto->curforce;
9696 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9697 Copy(proto->nexttype, parser->nexttype, 5, I32);
9698 parser->nexttoke = proto->nexttoke;
9704 /* duplicate a file handle */
9707 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9711 PERL_UNUSED_ARG(type);
9714 return (PerlIO*)NULL;
9716 /* look for it in the table first */
9717 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9721 /* create anew and remember what it is */
9722 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9723 ptr_table_store(PL_ptr_table, fp, ret);
9727 /* duplicate a directory handle */
9730 Perl_dirp_dup(pTHX_ DIR *dp)
9732 PERL_UNUSED_CONTEXT;
9739 /* duplicate a typeglob */
9742 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9748 /* look for it in the table first */
9749 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9753 /* create anew and remember what it is */
9755 ptr_table_store(PL_ptr_table, gp, ret);
9758 ret->gp_refcnt = 0; /* must be before any other dups! */
9759 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9760 ret->gp_io = io_dup_inc(gp->gp_io, param);
9761 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9762 ret->gp_av = av_dup_inc(gp->gp_av, param);
9763 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9764 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9765 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9766 ret->gp_cvgen = gp->gp_cvgen;
9767 ret->gp_line = gp->gp_line;
9768 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9772 /* duplicate a chain of magic */
9775 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9777 MAGIC *mgprev = (MAGIC*)NULL;
9780 return (MAGIC*)NULL;
9781 /* look for it in the table first */
9782 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9786 for (; mg; mg = mg->mg_moremagic) {
9788 Newxz(nmg, 1, MAGIC);
9790 mgprev->mg_moremagic = nmg;
9793 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9794 nmg->mg_private = mg->mg_private;
9795 nmg->mg_type = mg->mg_type;
9796 nmg->mg_flags = mg->mg_flags;
9797 if (mg->mg_type == PERL_MAGIC_qr) {
9798 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9800 else if(mg->mg_type == PERL_MAGIC_backref) {
9801 /* The backref AV has its reference count deliberately bumped by
9803 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9806 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9807 ? sv_dup_inc(mg->mg_obj, param)
9808 : sv_dup(mg->mg_obj, param);
9810 nmg->mg_len = mg->mg_len;
9811 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9812 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9813 if (mg->mg_len > 0) {
9814 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9815 if (mg->mg_type == PERL_MAGIC_overload_table &&
9816 AMT_AMAGIC((AMT*)mg->mg_ptr))
9818 const AMT * const amtp = (AMT*)mg->mg_ptr;
9819 AMT * const namtp = (AMT*)nmg->mg_ptr;
9821 for (i = 1; i < NofAMmeth; i++) {
9822 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9826 else if (mg->mg_len == HEf_SVKEY)
9827 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9829 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9830 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9837 #endif /* USE_ITHREADS */
9839 /* create a new pointer-mapping table */
9842 Perl_ptr_table_new(pTHX)
9845 PERL_UNUSED_CONTEXT;
9847 Newxz(tbl, 1, PTR_TBL_t);
9850 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9854 #define PTR_TABLE_HASH(ptr) \
9855 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9858 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9859 following define) and at call to new_body_inline made below in
9860 Perl_ptr_table_store()
9863 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9865 /* map an existing pointer using a table */
9867 STATIC PTR_TBL_ENT_t *
9868 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9869 PTR_TBL_ENT_t *tblent;
9870 const UV hash = PTR_TABLE_HASH(sv);
9872 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9873 for (; tblent; tblent = tblent->next) {
9874 if (tblent->oldval == sv)
9881 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9883 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9884 PERL_UNUSED_CONTEXT;
9885 return tblent ? tblent->newval : NULL;
9888 /* add a new entry to a pointer-mapping table */
9891 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9893 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9894 PERL_UNUSED_CONTEXT;
9897 tblent->newval = newsv;
9899 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9901 new_body_inline(tblent, PTE_SVSLOT);
9903 tblent->oldval = oldsv;
9904 tblent->newval = newsv;
9905 tblent->next = tbl->tbl_ary[entry];
9906 tbl->tbl_ary[entry] = tblent;
9908 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9909 ptr_table_split(tbl);
9913 /* double the hash bucket size of an existing ptr table */
9916 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9918 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9919 const UV oldsize = tbl->tbl_max + 1;
9920 UV newsize = oldsize * 2;
9922 PERL_UNUSED_CONTEXT;
9924 Renew(ary, newsize, PTR_TBL_ENT_t*);
9925 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9926 tbl->tbl_max = --newsize;
9928 for (i=0; i < oldsize; i++, ary++) {
9929 PTR_TBL_ENT_t **curentp, **entp, *ent;
9932 curentp = ary + oldsize;
9933 for (entp = ary, ent = *ary; ent; ent = *entp) {
9934 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
9936 ent->next = *curentp;
9946 /* remove all the entries from a ptr table */
9949 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9951 if (tbl && tbl->tbl_items) {
9952 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
9953 UV riter = tbl->tbl_max;
9956 PTR_TBL_ENT_t *entry = array[riter];
9959 PTR_TBL_ENT_t * const oentry = entry;
9960 entry = entry->next;
9969 /* clear and free a ptr table */
9972 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9977 ptr_table_clear(tbl);
9978 Safefree(tbl->tbl_ary);
9982 #if defined(USE_ITHREADS)
9985 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
9988 SvRV_set(dstr, SvWEAKREF(sstr)
9989 ? sv_dup(SvRV(sstr), param)
9990 : sv_dup_inc(SvRV(sstr), param));
9993 else if (SvPVX_const(sstr)) {
9994 /* Has something there */
9996 /* Normal PV - clone whole allocated space */
9997 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
9998 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9999 /* Not that normal - actually sstr is copy on write.
10000 But we are a true, independant SV, so: */
10001 SvREADONLY_off(dstr);
10006 /* Special case - not normally malloced for some reason */
10007 if (isGV_with_GP(sstr)) {
10008 /* Don't need to do anything here. */
10010 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10011 /* A "shared" PV - clone it as "shared" PV */
10013 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10017 /* Some other special case - random pointer */
10018 SvPV_set(dstr, SvPVX(sstr));
10023 /* Copy the NULL */
10024 SvPV_set(dstr, NULL);
10028 /* duplicate an SV of any type (including AV, HV etc) */
10031 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10036 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10038 /* look for it in the table first */
10039 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10043 if(param->flags & CLONEf_JOIN_IN) {
10044 /** We are joining here so we don't want do clone
10045 something that is bad **/
10046 if (SvTYPE(sstr) == SVt_PVHV) {
10047 const HEK * const hvname = HvNAME_HEK(sstr);
10049 /** don't clone stashes if they already exist **/
10050 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10054 /* create anew and remember what it is */
10057 #ifdef DEBUG_LEAKING_SCALARS
10058 dstr->sv_debug_optype = sstr->sv_debug_optype;
10059 dstr->sv_debug_line = sstr->sv_debug_line;
10060 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10061 dstr->sv_debug_cloned = 1;
10062 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10065 ptr_table_store(PL_ptr_table, sstr, dstr);
10068 SvFLAGS(dstr) = SvFLAGS(sstr);
10069 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10070 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10073 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10074 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10075 (void*)PL_watch_pvx, SvPVX_const(sstr));
10078 /* don't clone objects whose class has asked us not to */
10079 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10084 switch (SvTYPE(sstr)) {
10086 SvANY(dstr) = NULL;
10089 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10091 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10093 SvIV_set(dstr, SvIVX(sstr));
10097 SvANY(dstr) = new_XNV();
10098 SvNV_set(dstr, SvNVX(sstr));
10100 /* case SVt_BIND: */
10103 /* These are all the types that need complex bodies allocating. */
10105 const svtype sv_type = SvTYPE(sstr);
10106 const struct body_details *const sv_type_details
10107 = bodies_by_type + sv_type;
10111 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10115 if (GvUNIQUE((GV*)sstr)) {
10116 NOOP; /* Do sharing here, and fall through */
10128 assert(sv_type_details->body_size);
10129 if (sv_type_details->arena) {
10130 new_body_inline(new_body, sv_type);
10132 = (void*)((char*)new_body - sv_type_details->offset);
10134 new_body = new_NOARENA(sv_type_details);
10138 SvANY(dstr) = new_body;
10141 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10142 ((char*)SvANY(dstr)) + sv_type_details->offset,
10143 sv_type_details->copy, char);
10145 Copy(((char*)SvANY(sstr)),
10146 ((char*)SvANY(dstr)),
10147 sv_type_details->body_size + sv_type_details->offset, char);
10150 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10151 && !isGV_with_GP(dstr))
10152 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10154 /* The Copy above means that all the source (unduplicated) pointers
10155 are now in the destination. We can check the flags and the
10156 pointers in either, but it's possible that there's less cache
10157 missing by always going for the destination.
10158 FIXME - instrument and check that assumption */
10159 if (sv_type >= SVt_PVMG) {
10160 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10161 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10162 } else if (SvMAGIC(dstr))
10163 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10165 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10168 /* The cast silences a GCC warning about unhandled types. */
10169 switch ((int)sv_type) {
10179 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10180 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10181 LvTARG(dstr) = dstr;
10182 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10183 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10185 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10187 if(isGV_with_GP(sstr)) {
10188 if (GvNAME_HEK(dstr))
10189 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10190 /* Don't call sv_add_backref here as it's going to be
10191 created as part of the magic cloning of the symbol
10193 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10194 at the point of this comment. */
10195 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10196 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10197 (void)GpREFCNT_inc(GvGP(dstr));
10199 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10202 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10203 if (IoOFP(dstr) == IoIFP(sstr))
10204 IoOFP(dstr) = IoIFP(dstr);
10206 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10207 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10208 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10209 /* I have no idea why fake dirp (rsfps)
10210 should be treated differently but otherwise
10211 we end up with leaks -- sky*/
10212 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10213 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10214 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10216 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10217 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10218 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10219 if (IoDIRP(dstr)) {
10220 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10223 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10226 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10227 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10228 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10231 if (AvARRAY((AV*)sstr)) {
10232 SV **dst_ary, **src_ary;
10233 SSize_t items = AvFILLp((AV*)sstr) + 1;
10235 src_ary = AvARRAY((AV*)sstr);
10236 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10237 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10238 AvARRAY((AV*)dstr) = dst_ary;
10239 AvALLOC((AV*)dstr) = dst_ary;
10240 if (AvREAL((AV*)sstr)) {
10241 while (items-- > 0)
10242 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10245 while (items-- > 0)
10246 *dst_ary++ = sv_dup(*src_ary++, param);
10248 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10249 while (items-- > 0) {
10250 *dst_ary++ = &PL_sv_undef;
10254 AvARRAY((AV*)dstr) = NULL;
10255 AvALLOC((AV*)dstr) = (SV**)NULL;
10259 if (HvARRAY((HV*)sstr)) {
10261 const bool sharekeys = !!HvSHAREKEYS(sstr);
10262 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10263 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10265 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10266 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10268 HvARRAY(dstr) = (HE**)darray;
10269 while (i <= sxhv->xhv_max) {
10270 const HE * const source = HvARRAY(sstr)[i];
10271 HvARRAY(dstr)[i] = source
10272 ? he_dup(source, sharekeys, param) : 0;
10277 const struct xpvhv_aux * const saux = HvAUX(sstr);
10278 struct xpvhv_aux * const daux = HvAUX(dstr);
10279 /* This flag isn't copied. */
10280 /* SvOOK_on(hv) attacks the IV flags. */
10281 SvFLAGS(dstr) |= SVf_OOK;
10283 hvname = saux->xhv_name;
10284 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10286 daux->xhv_riter = saux->xhv_riter;
10287 daux->xhv_eiter = saux->xhv_eiter
10288 ? he_dup(saux->xhv_eiter,
10289 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10290 daux->xhv_backreferences =
10291 saux->xhv_backreferences
10292 ? (AV*) SvREFCNT_inc(
10293 sv_dup((SV*)saux->xhv_backreferences, param))
10296 daux->xhv_mro_meta = saux->xhv_mro_meta
10297 ? mro_meta_dup(saux->xhv_mro_meta, param)
10300 /* Record stashes for possible cloning in Perl_clone(). */
10302 av_push(param->stashes, dstr);
10306 HvARRAY((HV*)dstr) = NULL;
10309 if (!(param->flags & CLONEf_COPY_STACKS)) {
10313 /* NOTE: not refcounted */
10314 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10316 if (!CvISXSUB(dstr))
10317 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10319 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10320 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10321 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10322 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10324 /* don't dup if copying back - CvGV isn't refcounted, so the
10325 * duped GV may never be freed. A bit of a hack! DAPM */
10326 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10327 NULL : gv_dup(CvGV(dstr), param) ;
10328 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10330 CvWEAKOUTSIDE(sstr)
10331 ? cv_dup( CvOUTSIDE(dstr), param)
10332 : cv_dup_inc(CvOUTSIDE(dstr), param);
10333 if (!CvISXSUB(dstr))
10334 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10340 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10346 /* duplicate a context */
10349 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10351 PERL_CONTEXT *ncxs;
10354 return (PERL_CONTEXT*)NULL;
10356 /* look for it in the table first */
10357 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10361 /* create anew and remember what it is */
10362 Newxz(ncxs, max + 1, PERL_CONTEXT);
10363 ptr_table_store(PL_ptr_table, cxs, ncxs);
10366 PERL_CONTEXT * const cx = &cxs[ix];
10367 PERL_CONTEXT * const ncx = &ncxs[ix];
10368 ncx->cx_type = cx->cx_type;
10369 if (CxTYPE(cx) == CXt_SUBST) {
10370 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10373 ncx->blk_oldsp = cx->blk_oldsp;
10374 ncx->blk_oldcop = cx->blk_oldcop;
10375 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10376 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10377 ncx->blk_oldpm = cx->blk_oldpm;
10378 ncx->blk_gimme = cx->blk_gimme;
10379 switch (CxTYPE(cx)) {
10381 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10382 ? cv_dup_inc(cx->blk_sub.cv, param)
10383 : cv_dup(cx->blk_sub.cv,param));
10384 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10385 ? av_dup_inc(cx->blk_sub.argarray, param)
10387 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10388 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10389 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10390 ncx->blk_sub.lval = cx->blk_sub.lval;
10391 ncx->blk_sub.retop = cx->blk_sub.retop;
10392 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10393 cx->blk_sub.oldcomppad);
10396 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10397 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10398 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10399 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10400 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10401 ncx->blk_eval.retop = cx->blk_eval.retop;
10404 ncx->blk_loop.label = cx->blk_loop.label;
10405 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10406 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10407 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10408 ? cx->blk_loop.iterdata
10409 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10410 ncx->blk_loop.oldcomppad
10411 = (PAD*)ptr_table_fetch(PL_ptr_table,
10412 cx->blk_loop.oldcomppad);
10413 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10414 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10415 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10416 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10417 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10420 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10421 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10422 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10423 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10424 ncx->blk_sub.retop = cx->blk_sub.retop;
10436 /* duplicate a stack info structure */
10439 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10444 return (PERL_SI*)NULL;
10446 /* look for it in the table first */
10447 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10451 /* create anew and remember what it is */
10452 Newxz(nsi, 1, PERL_SI);
10453 ptr_table_store(PL_ptr_table, si, nsi);
10455 nsi->si_stack = av_dup_inc(si->si_stack, param);
10456 nsi->si_cxix = si->si_cxix;
10457 nsi->si_cxmax = si->si_cxmax;
10458 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10459 nsi->si_type = si->si_type;
10460 nsi->si_prev = si_dup(si->si_prev, param);
10461 nsi->si_next = si_dup(si->si_next, param);
10462 nsi->si_markoff = si->si_markoff;
10467 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10468 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10469 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10470 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10471 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10472 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10473 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10474 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10475 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10476 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10477 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10478 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10479 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10480 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10483 #define pv_dup_inc(p) SAVEPV(p)
10484 #define pv_dup(p) SAVEPV(p)
10485 #define svp_dup_inc(p,pp) any_dup(p,pp)
10487 /* map any object to the new equivent - either something in the
10488 * ptr table, or something in the interpreter structure
10492 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10497 return (void*)NULL;
10499 /* look for it in the table first */
10500 ret = ptr_table_fetch(PL_ptr_table, v);
10504 /* see if it is part of the interpreter structure */
10505 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10506 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10514 /* duplicate the save stack */
10517 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10520 ANY * const ss = proto_perl->Isavestack;
10521 const I32 max = proto_perl->Isavestack_max;
10522 I32 ix = proto_perl->Isavestack_ix;
10535 void (*dptr) (void*);
10536 void (*dxptr) (pTHX_ void*);
10538 Newxz(nss, max, ANY);
10541 const I32 type = POPINT(ss,ix);
10542 TOPINT(nss,ix) = type;
10544 case SAVEt_HELEM: /* hash element */
10545 sv = (SV*)POPPTR(ss,ix);
10546 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10548 case SAVEt_ITEM: /* normal string */
10549 case SAVEt_SV: /* scalar reference */
10550 sv = (SV*)POPPTR(ss,ix);
10551 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10554 case SAVEt_MORTALIZESV:
10555 sv = (SV*)POPPTR(ss,ix);
10556 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10558 case SAVEt_SHARED_PVREF: /* char* in shared space */
10559 c = (char*)POPPTR(ss,ix);
10560 TOPPTR(nss,ix) = savesharedpv(c);
10561 ptr = POPPTR(ss,ix);
10562 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10564 case SAVEt_GENERIC_SVREF: /* generic sv */
10565 case SAVEt_SVREF: /* scalar reference */
10566 sv = (SV*)POPPTR(ss,ix);
10567 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10568 ptr = POPPTR(ss,ix);
10569 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10571 case SAVEt_HV: /* hash reference */
10572 case SAVEt_AV: /* array reference */
10573 sv = (SV*) POPPTR(ss,ix);
10574 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10576 case SAVEt_COMPPAD:
10578 sv = (SV*) POPPTR(ss,ix);
10579 TOPPTR(nss,ix) = sv_dup(sv, param);
10581 case SAVEt_INT: /* int reference */
10582 ptr = POPPTR(ss,ix);
10583 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10584 intval = (int)POPINT(ss,ix);
10585 TOPINT(nss,ix) = intval;
10587 case SAVEt_LONG: /* long reference */
10588 ptr = POPPTR(ss,ix);
10589 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10591 case SAVEt_CLEARSV:
10592 longval = (long)POPLONG(ss,ix);
10593 TOPLONG(nss,ix) = longval;
10595 case SAVEt_I32: /* I32 reference */
10596 case SAVEt_I16: /* I16 reference */
10597 case SAVEt_I8: /* I8 reference */
10598 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10599 ptr = POPPTR(ss,ix);
10600 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10602 TOPINT(nss,ix) = i;
10604 case SAVEt_IV: /* IV reference */
10605 ptr = POPPTR(ss,ix);
10606 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10608 TOPIV(nss,ix) = iv;
10610 case SAVEt_HPTR: /* HV* reference */
10611 case SAVEt_APTR: /* AV* reference */
10612 case SAVEt_SPTR: /* SV* reference */
10613 ptr = POPPTR(ss,ix);
10614 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10615 sv = (SV*)POPPTR(ss,ix);
10616 TOPPTR(nss,ix) = sv_dup(sv, param);
10618 case SAVEt_VPTR: /* random* reference */
10619 ptr = POPPTR(ss,ix);
10620 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10621 ptr = POPPTR(ss,ix);
10622 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10624 case SAVEt_GENERIC_PVREF: /* generic char* */
10625 case SAVEt_PPTR: /* char* reference */
10626 ptr = POPPTR(ss,ix);
10627 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10628 c = (char*)POPPTR(ss,ix);
10629 TOPPTR(nss,ix) = pv_dup(c);
10631 case SAVEt_GP: /* scalar reference */
10632 gp = (GP*)POPPTR(ss,ix);
10633 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10634 (void)GpREFCNT_inc(gp);
10635 gv = (GV*)POPPTR(ss,ix);
10636 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10639 ptr = POPPTR(ss,ix);
10640 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10641 /* these are assumed to be refcounted properly */
10643 switch (((OP*)ptr)->op_type) {
10645 case OP_LEAVESUBLV:
10649 case OP_LEAVEWRITE:
10650 TOPPTR(nss,ix) = ptr;
10653 (void) OpREFCNT_inc(o);
10657 TOPPTR(nss,ix) = NULL;
10662 TOPPTR(nss,ix) = NULL;
10665 c = (char*)POPPTR(ss,ix);
10666 TOPPTR(nss,ix) = pv_dup_inc(c);
10669 hv = (HV*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10671 c = (char*)POPPTR(ss,ix);
10672 TOPPTR(nss,ix) = pv_dup_inc(c);
10674 case SAVEt_STACK_POS: /* Position on Perl stack */
10676 TOPINT(nss,ix) = i;
10678 case SAVEt_DESTRUCTOR:
10679 ptr = POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10681 dptr = POPDPTR(ss,ix);
10682 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10683 any_dup(FPTR2DPTR(void *, dptr),
10686 case SAVEt_DESTRUCTOR_X:
10687 ptr = POPPTR(ss,ix);
10688 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10689 dxptr = POPDXPTR(ss,ix);
10690 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10691 any_dup(FPTR2DPTR(void *, dxptr),
10694 case SAVEt_REGCONTEXT:
10697 TOPINT(nss,ix) = i;
10700 case SAVEt_AELEM: /* array element */
10701 sv = (SV*)POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10704 TOPINT(nss,ix) = i;
10705 av = (AV*)POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = av_dup_inc(av, param);
10709 ptr = POPPTR(ss,ix);
10710 TOPPTR(nss,ix) = ptr;
10714 TOPINT(nss,ix) = i;
10715 ptr = POPPTR(ss,ix);
10718 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10719 HINTS_REFCNT_UNLOCK;
10721 TOPPTR(nss,ix) = ptr;
10722 if (i & HINT_LOCALIZE_HH) {
10723 hv = (HV*)POPPTR(ss,ix);
10724 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10728 longval = (long)POPLONG(ss,ix);
10729 TOPLONG(nss,ix) = longval;
10730 ptr = POPPTR(ss,ix);
10731 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10732 sv = (SV*)POPPTR(ss,ix);
10733 TOPPTR(nss,ix) = sv_dup(sv, param);
10736 ptr = POPPTR(ss,ix);
10737 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10738 longval = (long)POPBOOL(ss,ix);
10739 TOPBOOL(nss,ix) = (bool)longval;
10741 case SAVEt_SET_SVFLAGS:
10743 TOPINT(nss,ix) = i;
10745 TOPINT(nss,ix) = i;
10746 sv = (SV*)POPPTR(ss,ix);
10747 TOPPTR(nss,ix) = sv_dup(sv, param);
10749 case SAVEt_RE_STATE:
10751 const struct re_save_state *const old_state
10752 = (struct re_save_state *)
10753 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10754 struct re_save_state *const new_state
10755 = (struct re_save_state *)
10756 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10758 Copy(old_state, new_state, 1, struct re_save_state);
10759 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10761 new_state->re_state_bostr
10762 = pv_dup(old_state->re_state_bostr);
10763 new_state->re_state_reginput
10764 = pv_dup(old_state->re_state_reginput);
10765 new_state->re_state_regeol
10766 = pv_dup(old_state->re_state_regeol);
10767 new_state->re_state_regoffs
10768 = (regexp_paren_pair*)
10769 any_dup(old_state->re_state_regoffs, proto_perl);
10770 new_state->re_state_reglastparen
10771 = (U32*) any_dup(old_state->re_state_reglastparen,
10773 new_state->re_state_reglastcloseparen
10774 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10776 /* XXX This just has to be broken. The old save_re_context
10777 code did SAVEGENERICPV(PL_reg_start_tmp);
10778 PL_reg_start_tmp is char **.
10779 Look above to what the dup code does for
10780 SAVEt_GENERIC_PVREF
10781 It can never have worked.
10782 So this is merely a faithful copy of the exiting bug: */
10783 new_state->re_state_reg_start_tmp
10784 = (char **) pv_dup((char *)
10785 old_state->re_state_reg_start_tmp);
10786 /* I assume that it only ever "worked" because no-one called
10787 (pseudo)fork while the regexp engine had re-entered itself.
10789 #ifdef PERL_OLD_COPY_ON_WRITE
10790 new_state->re_state_nrs
10791 = sv_dup(old_state->re_state_nrs, param);
10793 new_state->re_state_reg_magic
10794 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10796 new_state->re_state_reg_oldcurpm
10797 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10799 new_state->re_state_reg_curpm
10800 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10802 new_state->re_state_reg_oldsaved
10803 = pv_dup(old_state->re_state_reg_oldsaved);
10804 new_state->re_state_reg_poscache
10805 = pv_dup(old_state->re_state_reg_poscache);
10806 new_state->re_state_reg_starttry
10807 = pv_dup(old_state->re_state_reg_starttry);
10810 case SAVEt_COMPILE_WARNINGS:
10811 ptr = POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10815 ptr = POPPTR(ss,ix);
10816 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10820 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10828 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10829 * flag to the result. This is done for each stash before cloning starts,
10830 * so we know which stashes want their objects cloned */
10833 do_mark_cloneable_stash(pTHX_ SV *sv)
10835 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10837 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10838 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10839 if (cloner && GvCV(cloner)) {
10846 XPUSHs(sv_2mortal(newSVhek(hvname)));
10848 call_sv((SV*)GvCV(cloner), G_SCALAR);
10855 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10863 =for apidoc perl_clone
10865 Create and return a new interpreter by cloning the current one.
10867 perl_clone takes these flags as parameters:
10869 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10870 without it we only clone the data and zero the stacks,
10871 with it we copy the stacks and the new perl interpreter is
10872 ready to run at the exact same point as the previous one.
10873 The pseudo-fork code uses COPY_STACKS while the
10874 threads->create doesn't.
10876 CLONEf_KEEP_PTR_TABLE
10877 perl_clone keeps a ptr_table with the pointer of the old
10878 variable as a key and the new variable as a value,
10879 this allows it to check if something has been cloned and not
10880 clone it again but rather just use the value and increase the
10881 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10882 the ptr_table using the function
10883 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10884 reason to keep it around is if you want to dup some of your own
10885 variable who are outside the graph perl scans, example of this
10886 code is in threads.xs create
10889 This is a win32 thing, it is ignored on unix, it tells perls
10890 win32host code (which is c++) to clone itself, this is needed on
10891 win32 if you want to run two threads at the same time,
10892 if you just want to do some stuff in a separate perl interpreter
10893 and then throw it away and return to the original one,
10894 you don't need to do anything.
10899 /* XXX the above needs expanding by someone who actually understands it ! */
10900 EXTERN_C PerlInterpreter *
10901 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10904 perl_clone(PerlInterpreter *proto_perl, UV flags)
10907 #ifdef PERL_IMPLICIT_SYS
10909 /* perlhost.h so we need to call into it
10910 to clone the host, CPerlHost should have a c interface, sky */
10912 if (flags & CLONEf_CLONE_HOST) {
10913 return perl_clone_host(proto_perl,flags);
10915 return perl_clone_using(proto_perl, flags,
10917 proto_perl->IMemShared,
10918 proto_perl->IMemParse,
10920 proto_perl->IStdIO,
10924 proto_perl->IProc);
10928 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10929 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10930 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10931 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10932 struct IPerlDir* ipD, struct IPerlSock* ipS,
10933 struct IPerlProc* ipP)
10935 /* XXX many of the string copies here can be optimized if they're
10936 * constants; they need to be allocated as common memory and just
10937 * their pointers copied. */
10940 CLONE_PARAMS clone_params;
10941 CLONE_PARAMS* const param = &clone_params;
10943 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
10944 /* for each stash, determine whether its objects should be cloned */
10945 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10946 PERL_SET_THX(my_perl);
10949 PoisonNew(my_perl, 1, PerlInterpreter);
10955 PL_savestack_ix = 0;
10956 PL_savestack_max = -1;
10957 PL_sig_pending = 0;
10959 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10960 # else /* !DEBUGGING */
10961 Zero(my_perl, 1, PerlInterpreter);
10962 # endif /* DEBUGGING */
10964 /* host pointers */
10966 PL_MemShared = ipMS;
10967 PL_MemParse = ipMP;
10974 #else /* !PERL_IMPLICIT_SYS */
10976 CLONE_PARAMS clone_params;
10977 CLONE_PARAMS* param = &clone_params;
10978 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
10979 /* for each stash, determine whether its objects should be cloned */
10980 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
10981 PERL_SET_THX(my_perl);
10984 PoisonNew(my_perl, 1, PerlInterpreter);
10990 PL_savestack_ix = 0;
10991 PL_savestack_max = -1;
10992 PL_sig_pending = 0;
10994 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
10995 # else /* !DEBUGGING */
10996 Zero(my_perl, 1, PerlInterpreter);
10997 # endif /* DEBUGGING */
10998 #endif /* PERL_IMPLICIT_SYS */
10999 param->flags = flags;
11000 param->proto_perl = proto_perl;
11002 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11004 PL_body_arenas = NULL;
11005 Zero(&PL_body_roots, 1, PL_body_roots);
11007 PL_nice_chunk = NULL;
11008 PL_nice_chunk_size = 0;
11010 PL_sv_objcount = 0;
11012 PL_sv_arenaroot = NULL;
11014 PL_debug = proto_perl->Idebug;
11016 PL_hash_seed = proto_perl->Ihash_seed;
11017 PL_rehash_seed = proto_perl->Irehash_seed;
11019 #ifdef USE_REENTRANT_API
11020 /* XXX: things like -Dm will segfault here in perlio, but doing
11021 * PERL_SET_CONTEXT(proto_perl);
11022 * breaks too many other things
11024 Perl_reentrant_init(aTHX);
11027 /* create SV map for pointer relocation */
11028 PL_ptr_table = ptr_table_new();
11030 /* initialize these special pointers as early as possible */
11031 SvANY(&PL_sv_undef) = NULL;
11032 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11033 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11034 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11036 SvANY(&PL_sv_no) = new_XPVNV();
11037 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11038 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11039 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11040 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11041 SvCUR_set(&PL_sv_no, 0);
11042 SvLEN_set(&PL_sv_no, 1);
11043 SvIV_set(&PL_sv_no, 0);
11044 SvNV_set(&PL_sv_no, 0);
11045 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11047 SvANY(&PL_sv_yes) = new_XPVNV();
11048 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11049 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11050 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11051 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11052 SvCUR_set(&PL_sv_yes, 1);
11053 SvLEN_set(&PL_sv_yes, 2);
11054 SvIV_set(&PL_sv_yes, 1);
11055 SvNV_set(&PL_sv_yes, 1);
11056 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11058 /* create (a non-shared!) shared string table */
11059 PL_strtab = newHV();
11060 HvSHAREKEYS_off(PL_strtab);
11061 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11062 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11064 PL_compiling = proto_perl->Icompiling;
11066 /* These two PVs will be free'd special way so must set them same way op.c does */
11067 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11068 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11070 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11071 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11073 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11074 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11075 if (PL_compiling.cop_hints_hash) {
11077 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11078 HINTS_REFCNT_UNLOCK;
11080 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11081 #ifdef PERL_DEBUG_READONLY_OPS
11086 /* pseudo environmental stuff */
11087 PL_origargc = proto_perl->Iorigargc;
11088 PL_origargv = proto_perl->Iorigargv;
11090 param->stashes = newAV(); /* Setup array of objects to call clone on */
11092 /* Set tainting stuff before PerlIO_debug can possibly get called */
11093 PL_tainting = proto_perl->Itainting;
11094 PL_taint_warn = proto_perl->Itaint_warn;
11096 #ifdef PERLIO_LAYERS
11097 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11098 PerlIO_clone(aTHX_ proto_perl, param);
11101 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11102 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11103 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11104 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11105 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11106 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11109 PL_minus_c = proto_perl->Iminus_c;
11110 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11111 PL_localpatches = proto_perl->Ilocalpatches;
11112 PL_splitstr = proto_perl->Isplitstr;
11113 PL_preprocess = proto_perl->Ipreprocess;
11114 PL_minus_n = proto_perl->Iminus_n;
11115 PL_minus_p = proto_perl->Iminus_p;
11116 PL_minus_l = proto_perl->Iminus_l;
11117 PL_minus_a = proto_perl->Iminus_a;
11118 PL_minus_E = proto_perl->Iminus_E;
11119 PL_minus_F = proto_perl->Iminus_F;
11120 PL_doswitches = proto_perl->Idoswitches;
11121 PL_dowarn = proto_perl->Idowarn;
11122 PL_doextract = proto_perl->Idoextract;
11123 PL_sawampersand = proto_perl->Isawampersand;
11124 PL_unsafe = proto_perl->Iunsafe;
11125 PL_inplace = SAVEPV(proto_perl->Iinplace);
11126 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11127 PL_perldb = proto_perl->Iperldb;
11128 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11129 PL_exit_flags = proto_perl->Iexit_flags;
11131 /* magical thingies */
11132 /* XXX time(&PL_basetime) when asked for? */
11133 PL_basetime = proto_perl->Ibasetime;
11134 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11136 PL_maxsysfd = proto_perl->Imaxsysfd;
11137 PL_statusvalue = proto_perl->Istatusvalue;
11139 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11141 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11143 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11145 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11146 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11147 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11150 /* RE engine related */
11151 Zero(&PL_reg_state, 1, struct re_save_state);
11152 PL_reginterp_cnt = 0;
11153 PL_regmatch_slab = NULL;
11155 /* Clone the regex array */
11156 PL_regex_padav = newAV();
11158 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11159 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11161 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11162 for(i = 1; i <= len; i++) {
11163 const SV * const regex = regexen[i];
11166 ? sv_dup_inc(regex, param)
11168 newSViv(PTR2IV(CALLREGDUPE(
11169 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11171 if (SvFLAGS(regex) & SVf_BREAK)
11172 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11173 av_push(PL_regex_padav, sv);
11176 PL_regex_pad = AvARRAY(PL_regex_padav);
11178 /* shortcuts to various I/O objects */
11179 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11180 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11181 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11182 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11183 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11184 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11186 /* shortcuts to regexp stuff */
11187 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11189 /* shortcuts to misc objects */
11190 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11192 /* shortcuts to debugging objects */
11193 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11194 PL_DBline = gv_dup(proto_perl->IDBline, param);
11195 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11196 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11197 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11198 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11199 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11201 /* symbol tables */
11202 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11203 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11204 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11205 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11206 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11208 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11209 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11210 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11211 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11212 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11213 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11214 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11215 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11217 PL_sub_generation = proto_perl->Isub_generation;
11218 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11220 /* funky return mechanisms */
11221 PL_forkprocess = proto_perl->Iforkprocess;
11223 /* subprocess state */
11224 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11226 /* internal state */
11227 PL_maxo = proto_perl->Imaxo;
11228 if (proto_perl->Iop_mask)
11229 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11232 /* PL_asserting = proto_perl->Iasserting; */
11234 /* current interpreter roots */
11235 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11237 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11239 PL_main_start = proto_perl->Imain_start;
11240 PL_eval_root = proto_perl->Ieval_root;
11241 PL_eval_start = proto_perl->Ieval_start;
11243 /* runtime control stuff */
11244 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11246 PL_filemode = proto_perl->Ifilemode;
11247 PL_lastfd = proto_perl->Ilastfd;
11248 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11251 PL_gensym = proto_perl->Igensym;
11252 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11253 PL_laststatval = proto_perl->Ilaststatval;
11254 PL_laststype = proto_perl->Ilaststype;
11257 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11259 /* interpreter atexit processing */
11260 PL_exitlistlen = proto_perl->Iexitlistlen;
11261 if (PL_exitlistlen) {
11262 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11263 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11266 PL_exitlist = (PerlExitListEntry*)NULL;
11268 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11269 if (PL_my_cxt_size) {
11270 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11271 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11272 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11273 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11274 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11278 PL_my_cxt_list = (void**)NULL;
11279 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11280 PL_my_cxt_keys = (const char**)NULL;
11283 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11284 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11285 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11287 PL_profiledata = NULL;
11289 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11291 PAD_CLONE_VARS(proto_perl, param);
11293 #ifdef HAVE_INTERP_INTERN
11294 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11297 /* more statics moved here */
11298 PL_generation = proto_perl->Igeneration;
11299 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11301 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11302 PL_in_clean_all = proto_perl->Iin_clean_all;
11304 PL_uid = proto_perl->Iuid;
11305 PL_euid = proto_perl->Ieuid;
11306 PL_gid = proto_perl->Igid;
11307 PL_egid = proto_perl->Iegid;
11308 PL_nomemok = proto_perl->Inomemok;
11309 PL_an = proto_perl->Ian;
11310 PL_evalseq = proto_perl->Ievalseq;
11311 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11312 PL_origalen = proto_perl->Iorigalen;
11313 #ifdef PERL_USES_PL_PIDSTATUS
11314 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11316 PL_osname = SAVEPV(proto_perl->Iosname);
11317 PL_sighandlerp = proto_perl->Isighandlerp;
11319 PL_runops = proto_perl->Irunops;
11321 PL_parser = parser_dup(proto_perl->Iparser, param);
11323 PL_subline = proto_perl->Isubline;
11324 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11327 PL_cryptseen = proto_perl->Icryptseen;
11330 PL_hints = proto_perl->Ihints;
11332 PL_amagic_generation = proto_perl->Iamagic_generation;
11334 #ifdef USE_LOCALE_COLLATE
11335 PL_collation_ix = proto_perl->Icollation_ix;
11336 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11337 PL_collation_standard = proto_perl->Icollation_standard;
11338 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11339 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11340 #endif /* USE_LOCALE_COLLATE */
11342 #ifdef USE_LOCALE_NUMERIC
11343 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11344 PL_numeric_standard = proto_perl->Inumeric_standard;
11345 PL_numeric_local = proto_perl->Inumeric_local;
11346 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11347 #endif /* !USE_LOCALE_NUMERIC */
11349 /* utf8 character classes */
11350 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11351 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11352 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11353 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11354 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11355 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11356 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11357 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11358 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11359 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11360 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11361 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11362 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11363 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11364 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11365 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11366 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11367 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11368 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11369 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11371 /* Did the locale setup indicate UTF-8? */
11372 PL_utf8locale = proto_perl->Iutf8locale;
11373 /* Unicode features (see perlrun/-C) */
11374 PL_unicode = proto_perl->Iunicode;
11376 /* Pre-5.8 signals control */
11377 PL_signals = proto_perl->Isignals;
11379 /* times() ticks per second */
11380 PL_clocktick = proto_perl->Iclocktick;
11382 /* Recursion stopper for PerlIO_find_layer */
11383 PL_in_load_module = proto_perl->Iin_load_module;
11385 /* sort() routine */
11386 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11388 /* Not really needed/useful since the reenrant_retint is "volatile",
11389 * but do it for consistency's sake. */
11390 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11392 /* Hooks to shared SVs and locks. */
11393 PL_sharehook = proto_perl->Isharehook;
11394 PL_lockhook = proto_perl->Ilockhook;
11395 PL_unlockhook = proto_perl->Iunlockhook;
11396 PL_threadhook = proto_perl->Ithreadhook;
11397 PL_destroyhook = proto_perl->Idestroyhook;
11399 #ifdef THREADS_HAVE_PIDS
11400 PL_ppid = proto_perl->Ippid;
11404 PL_last_swash_hv = NULL; /* reinits on demand */
11405 PL_last_swash_klen = 0;
11406 PL_last_swash_key[0]= '\0';
11407 PL_last_swash_tmps = (U8*)NULL;
11408 PL_last_swash_slen = 0;
11410 PL_glob_index = proto_perl->Iglob_index;
11411 PL_srand_called = proto_perl->Isrand_called;
11412 PL_bitcount = NULL; /* reinits on demand */
11414 if (proto_perl->Ipsig_pend) {
11415 Newxz(PL_psig_pend, SIG_SIZE, int);
11418 PL_psig_pend = (int*)NULL;
11421 if (proto_perl->Ipsig_ptr) {
11422 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11423 Newxz(PL_psig_name, SIG_SIZE, SV*);
11424 for (i = 1; i < SIG_SIZE; i++) {
11425 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11426 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11430 PL_psig_ptr = (SV**)NULL;
11431 PL_psig_name = (SV**)NULL;
11434 /* intrpvar.h stuff */
11436 if (flags & CLONEf_COPY_STACKS) {
11437 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11438 PL_tmps_ix = proto_perl->Itmps_ix;
11439 PL_tmps_max = proto_perl->Itmps_max;
11440 PL_tmps_floor = proto_perl->Itmps_floor;
11441 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11443 while (i <= PL_tmps_ix) {
11444 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11448 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11449 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11450 Newxz(PL_markstack, i, I32);
11451 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11452 - proto_perl->Imarkstack);
11453 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11454 - proto_perl->Imarkstack);
11455 Copy(proto_perl->Imarkstack, PL_markstack,
11456 PL_markstack_ptr - PL_markstack + 1, I32);
11458 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11459 * NOTE: unlike the others! */
11460 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11461 PL_scopestack_max = proto_perl->Iscopestack_max;
11462 Newxz(PL_scopestack, PL_scopestack_max, I32);
11463 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11465 /* NOTE: si_dup() looks at PL_markstack */
11466 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11468 /* PL_curstack = PL_curstackinfo->si_stack; */
11469 PL_curstack = av_dup(proto_perl->Icurstack, param);
11470 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11472 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11473 PL_stack_base = AvARRAY(PL_curstack);
11474 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11475 - proto_perl->Istack_base);
11476 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11478 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11479 * NOTE: unlike the others! */
11480 PL_savestack_ix = proto_perl->Isavestack_ix;
11481 PL_savestack_max = proto_perl->Isavestack_max;
11482 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11483 PL_savestack = ss_dup(proto_perl, param);
11487 ENTER; /* perl_destruct() wants to LEAVE; */
11489 /* although we're not duplicating the tmps stack, we should still
11490 * add entries for any SVs on the tmps stack that got cloned by a
11491 * non-refcount means (eg a temp in @_); otherwise they will be
11494 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11495 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11496 proto_perl->Itmps_stack[i]);
11497 if (nsv && !SvREFCNT(nsv)) {
11499 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11504 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11505 PL_top_env = &PL_start_env;
11507 PL_op = proto_perl->Iop;
11510 PL_Xpv = (XPV*)NULL;
11511 my_perl->Ina = proto_perl->Ina;
11513 PL_statbuf = proto_perl->Istatbuf;
11514 PL_statcache = proto_perl->Istatcache;
11515 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11516 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11518 PL_timesbuf = proto_perl->Itimesbuf;
11521 PL_tainted = proto_perl->Itainted;
11522 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11523 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11524 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11525 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11526 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11527 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11528 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11529 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11530 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11532 PL_restartop = proto_perl->Irestartop;
11533 PL_in_eval = proto_perl->Iin_eval;
11534 PL_delaymagic = proto_perl->Idelaymagic;
11535 PL_dirty = proto_perl->Idirty;
11536 PL_localizing = proto_perl->Ilocalizing;
11538 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11539 PL_hv_fetch_ent_mh = NULL;
11540 PL_modcount = proto_perl->Imodcount;
11541 PL_lastgotoprobe = NULL;
11542 PL_dumpindent = proto_perl->Idumpindent;
11544 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11545 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11546 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11547 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11548 PL_efloatbuf = NULL; /* reinits on demand */
11549 PL_efloatsize = 0; /* reinits on demand */
11553 PL_screamfirst = NULL;
11554 PL_screamnext = NULL;
11555 PL_maxscream = -1; /* reinits on demand */
11556 PL_lastscream = NULL;
11559 PL_regdummy = proto_perl->Iregdummy;
11560 PL_colorset = 0; /* reinits PL_colors[] */
11561 /*PL_colors[6] = {0,0,0,0,0,0};*/
11565 /* Pluggable optimizer */
11566 PL_peepp = proto_perl->Ipeepp;
11568 PL_stashcache = newHV();
11570 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11571 proto_perl->Iwatchaddr);
11572 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11573 if (PL_debug && PL_watchaddr) {
11574 PerlIO_printf(Perl_debug_log,
11575 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11576 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11577 PTR2UV(PL_watchok));
11580 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11581 ptr_table_free(PL_ptr_table);
11582 PL_ptr_table = NULL;
11585 /* Call the ->CLONE method, if it exists, for each of the stashes
11586 identified by sv_dup() above.
11588 while(av_len(param->stashes) != -1) {
11589 HV* const stash = (HV*) av_shift(param->stashes);
11590 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11591 if (cloner && GvCV(cloner)) {
11596 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
11598 call_sv((SV*)GvCV(cloner), G_DISCARD);
11604 SvREFCNT_dec(param->stashes);
11606 /* orphaned? eg threads->new inside BEGIN or use */
11607 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11608 SvREFCNT_inc_simple_void(PL_compcv);
11609 SAVEFREESV(PL_compcv);
11615 #endif /* USE_ITHREADS */
11618 =head1 Unicode Support
11620 =for apidoc sv_recode_to_utf8
11622 The encoding is assumed to be an Encode object, on entry the PV
11623 of the sv is assumed to be octets in that encoding, and the sv
11624 will be converted into Unicode (and UTF-8).
11626 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11627 is not a reference, nothing is done to the sv. If the encoding is not
11628 an C<Encode::XS> Encoding object, bad things will happen.
11629 (See F<lib/encoding.pm> and L<Encode>).
11631 The PV of the sv is returned.
11636 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11639 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11653 Passing sv_yes is wrong - it needs to be or'ed set of constants
11654 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11655 remove converted chars from source.
11657 Both will default the value - let them.
11659 XPUSHs(&PL_sv_yes);
11662 call_method("decode", G_SCALAR);
11666 s = SvPV_const(uni, len);
11667 if (s != SvPVX_const(sv)) {
11668 SvGROW(sv, len + 1);
11669 Move(s, SvPVX(sv), len + 1, char);
11670 SvCUR_set(sv, len);
11677 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11681 =for apidoc sv_cat_decode
11683 The encoding is assumed to be an Encode object, the PV of the ssv is
11684 assumed to be octets in that encoding and decoding the input starts
11685 from the position which (PV + *offset) pointed to. The dsv will be
11686 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11687 when the string tstr appears in decoding output or the input ends on
11688 the PV of the ssv. The value which the offset points will be modified
11689 to the last input position on the ssv.
11691 Returns TRUE if the terminator was found, else returns FALSE.
11696 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11697 SV *ssv, int *offset, char *tstr, int tlen)
11701 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11712 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11713 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11715 call_method("cat_decode", G_SCALAR);
11717 ret = SvTRUE(TOPs);
11718 *offset = SvIV(offsv);
11724 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11729 /* ---------------------------------------------------------------------
11731 * support functions for report_uninit()
11734 /* the maxiumum size of array or hash where we will scan looking
11735 * for the undefined element that triggered the warning */
11737 #define FUV_MAX_SEARCH_SIZE 1000
11739 /* Look for an entry in the hash whose value has the same SV as val;
11740 * If so, return a mortal copy of the key. */
11743 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11746 register HE **array;
11749 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11750 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11753 array = HvARRAY(hv);
11755 for (i=HvMAX(hv); i>0; i--) {
11756 register HE *entry;
11757 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11758 if (HeVAL(entry) != val)
11760 if ( HeVAL(entry) == &PL_sv_undef ||
11761 HeVAL(entry) == &PL_sv_placeholder)
11765 if (HeKLEN(entry) == HEf_SVKEY)
11766 return sv_mortalcopy(HeKEY_sv(entry));
11767 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
11773 /* Look for an entry in the array whose value has the same SV as val;
11774 * If so, return the index, otherwise return -1. */
11777 S_find_array_subscript(pTHX_ AV *av, SV* val)
11780 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11781 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11784 if (val != &PL_sv_undef) {
11785 SV ** const svp = AvARRAY(av);
11788 for (i=AvFILLp(av); i>=0; i--)
11795 /* S_varname(): return the name of a variable, optionally with a subscript.
11796 * If gv is non-zero, use the name of that global, along with gvtype (one
11797 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11798 * targ. Depending on the value of the subscript_type flag, return:
11801 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11802 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11803 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11804 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11807 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11808 SV* keyname, I32 aindex, int subscript_type)
11811 SV * const name = sv_newmortal();
11814 buffer[0] = gvtype;
11817 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11819 gv_fullname4(name, gv, buffer, 0);
11821 if ((unsigned int)SvPVX(name)[1] <= 26) {
11823 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11825 /* Swap the 1 unprintable control character for the 2 byte pretty
11826 version - ie substr($name, 1, 1) = $buffer; */
11827 sv_insert(name, 1, 1, buffer, 2);
11831 CV * const cv = find_runcv(NULL);
11835 if (!cv || !CvPADLIST(cv))
11837 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11838 sv = *av_fetch(av, targ, FALSE);
11839 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11842 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11843 SV * const sv = newSV(0);
11844 *SvPVX(name) = '$';
11845 Perl_sv_catpvf(aTHX_ name, "{%s}",
11846 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11849 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11850 *SvPVX(name) = '$';
11851 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11853 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11854 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11861 =for apidoc find_uninit_var
11863 Find the name of the undefined variable (if any) that caused the operator o
11864 to issue a "Use of uninitialized value" warning.
11865 If match is true, only return a name if it's value matches uninit_sv.
11866 So roughly speaking, if a unary operator (such as OP_COS) generates a
11867 warning, then following the direct child of the op may yield an
11868 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11869 other hand, with OP_ADD there are two branches to follow, so we only print
11870 the variable name if we get an exact match.
11872 The name is returned as a mortal SV.
11874 Assumes that PL_op is the op that originally triggered the error, and that
11875 PL_comppad/PL_curpad points to the currently executing pad.
11881 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11889 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11890 uninit_sv == &PL_sv_placeholder)))
11893 switch (obase->op_type) {
11900 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11901 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11904 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11906 if (pad) { /* @lex, %lex */
11907 sv = PAD_SVl(obase->op_targ);
11911 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11912 /* @global, %global */
11913 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
11916 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
11918 else /* @{expr}, %{expr} */
11919 return find_uninit_var(cUNOPx(obase)->op_first,
11923 /* attempt to find a match within the aggregate */
11925 keysv = find_hash_subscript((HV*)sv, uninit_sv);
11927 subscript_type = FUV_SUBSCRIPT_HASH;
11930 index = find_array_subscript((AV*)sv, uninit_sv);
11932 subscript_type = FUV_SUBSCRIPT_ARRAY;
11935 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
11938 return varname(gv, hash ? '%' : '@', obase->op_targ,
11939 keysv, index, subscript_type);
11943 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
11945 return varname(NULL, '$', obase->op_targ,
11946 NULL, 0, FUV_SUBSCRIPT_NONE);
11949 gv = cGVOPx_gv(obase);
11950 if (!gv || (match && GvSV(gv) != uninit_sv))
11952 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
11955 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
11958 av = (AV*)PAD_SV(obase->op_targ);
11959 if (!av || SvRMAGICAL(av))
11961 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11962 if (!svp || *svp != uninit_sv)
11965 return varname(NULL, '$', obase->op_targ,
11966 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11969 gv = cGVOPx_gv(obase);
11975 if (!av || SvRMAGICAL(av))
11977 svp = av_fetch(av, (I32)obase->op_private, FALSE);
11978 if (!svp || *svp != uninit_sv)
11981 return varname(gv, '$', 0,
11982 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
11987 o = cUNOPx(obase)->op_first;
11988 if (!o || o->op_type != OP_NULL ||
11989 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
11991 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
11995 if (PL_op == obase)
11996 /* $a[uninit_expr] or $h{uninit_expr} */
11997 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12000 o = cBINOPx(obase)->op_first;
12001 kid = cBINOPx(obase)->op_last;
12003 /* get the av or hv, and optionally the gv */
12005 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12006 sv = PAD_SV(o->op_targ);
12008 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12009 && cUNOPo->op_first->op_type == OP_GV)
12011 gv = cGVOPx_gv(cUNOPo->op_first);
12014 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12019 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12020 /* index is constant */
12024 if (obase->op_type == OP_HELEM) {
12025 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12026 if (!he || HeVAL(he) != uninit_sv)
12030 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12031 if (!svp || *svp != uninit_sv)
12035 if (obase->op_type == OP_HELEM)
12036 return varname(gv, '%', o->op_targ,
12037 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12039 return varname(gv, '@', o->op_targ, NULL,
12040 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12043 /* index is an expression;
12044 * attempt to find a match within the aggregate */
12045 if (obase->op_type == OP_HELEM) {
12046 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12048 return varname(gv, '%', o->op_targ,
12049 keysv, 0, FUV_SUBSCRIPT_HASH);
12052 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12054 return varname(gv, '@', o->op_targ,
12055 NULL, index, FUV_SUBSCRIPT_ARRAY);
12060 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12062 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12067 /* only examine RHS */
12068 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12071 o = cUNOPx(obase)->op_first;
12072 if (o->op_type == OP_PUSHMARK)
12075 if (!o->op_sibling) {
12076 /* one-arg version of open is highly magical */
12078 if (o->op_type == OP_GV) { /* open FOO; */
12080 if (match && GvSV(gv) != uninit_sv)
12082 return varname(gv, '$', 0,
12083 NULL, 0, FUV_SUBSCRIPT_NONE);
12085 /* other possibilities not handled are:
12086 * open $x; or open my $x; should return '${*$x}'
12087 * open expr; should return '$'.expr ideally
12093 /* ops where $_ may be an implicit arg */
12097 if ( !(obase->op_flags & OPf_STACKED)) {
12098 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12099 ? PAD_SVl(obase->op_targ)
12102 sv = sv_newmortal();
12103 sv_setpvn(sv, "$_", 2);
12112 /* skip filehandle as it can't produce 'undef' warning */
12113 o = cUNOPx(obase)->op_first;
12114 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12115 o = o->op_sibling->op_sibling;
12121 match = 1; /* XS or custom code could trigger random warnings */
12126 /* XXX tmp hack: these two may call an XS sub, and currently
12127 XS subs don't have a SUB entry on the context stack, so CV and
12128 pad determination goes wrong, and BAD things happen. So, just
12129 don't try to determine the value under those circumstances.
12130 Need a better fix at dome point. DAPM 11/2007 */
12134 /* def-ness of rval pos() is independent of the def-ness of its arg */
12135 if ( !(obase->op_flags & OPf_MOD))
12140 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12141 return sv_2mortal(newSVpvs("${$/}"));
12146 if (!(obase->op_flags & OPf_KIDS))
12148 o = cUNOPx(obase)->op_first;
12154 /* if all except one arg are constant, or have no side-effects,
12155 * or are optimized away, then it's unambiguous */
12157 for (kid=o; kid; kid = kid->op_sibling) {
12159 const OPCODE type = kid->op_type;
12160 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12161 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12162 || (type == OP_PUSHMARK)
12166 if (o2) { /* more than one found */
12173 return find_uninit_var(o2, uninit_sv, match);
12175 /* scan all args */
12177 sv = find_uninit_var(o, uninit_sv, 1);
12189 =for apidoc report_uninit
12191 Print appropriate "Use of uninitialized variable" warning
12197 Perl_report_uninit(pTHX_ SV* uninit_sv)
12201 SV* varname = NULL;
12203 varname = find_uninit_var(PL_op, uninit_sv,0);
12205 sv_insert(varname, 0, 0, " ", 1);
12207 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12208 varname ? SvPV_nolen_const(varname) : "",
12209 " in ", OP_DESC(PL_op));
12212 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12218 * c-indentation-style: bsd
12219 * c-basic-offset: 4
12220 * indent-tabs-mode: t
12223 * ex: set ts=8 sts=4 sw=4 noet: