3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(struct regexp), sizeof(struct regexp), 0,
921 SVt_REGEXP, FALSE, HADNV, HASARENA, FIT_ARENA(0, sizeof(struct regexp))
925 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
926 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
929 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
930 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
932 { sizeof(xpvav_allocated),
933 copy_length(XPVAV, xmg_stash)
934 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
935 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
936 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
938 { sizeof(xpvhv_allocated),
939 copy_length(XPVHV, xmg_stash)
940 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
941 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
942 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
945 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
946 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
947 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
949 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
950 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
951 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
953 /* XPVIO is 84 bytes, fits 48x */
954 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
955 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
958 #define new_body_type(sv_type) \
959 (void *)((char *)S_new_body(aTHX_ sv_type))
961 #define del_body_type(p, sv_type) \
962 del_body(p, &PL_body_roots[sv_type])
965 #define new_body_allocated(sv_type) \
966 (void *)((char *)S_new_body(aTHX_ sv_type) \
967 - bodies_by_type[sv_type].offset)
969 #define del_body_allocated(p, sv_type) \
970 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
973 #define my_safemalloc(s) (void*)safemalloc(s)
974 #define my_safecalloc(s) (void*)safecalloc(s, 1)
975 #define my_safefree(p) safefree((char*)p)
979 #define new_XNV() my_safemalloc(sizeof(XPVNV))
980 #define del_XNV(p) my_safefree(p)
982 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
983 #define del_XPVNV(p) my_safefree(p)
985 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
986 #define del_XPVAV(p) my_safefree(p)
988 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
989 #define del_XPVHV(p) my_safefree(p)
991 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
992 #define del_XPVMG(p) my_safefree(p)
994 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
995 #define del_XPVGV(p) my_safefree(p)
999 #define new_XNV() new_body_type(SVt_NV)
1000 #define del_XNV(p) del_body_type(p, SVt_NV)
1002 #define new_XPVNV() new_body_type(SVt_PVNV)
1003 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1005 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1006 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1008 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1009 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1011 #define new_XPVMG() new_body_type(SVt_PVMG)
1012 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1014 #define new_XPVGV() new_body_type(SVt_PVGV)
1015 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1019 /* no arena for you! */
1021 #define new_NOARENA(details) \
1022 my_safemalloc((details)->body_size + (details)->offset)
1023 #define new_NOARENAZ(details) \
1024 my_safecalloc((details)->body_size + (details)->offset)
1027 S_more_bodies (pTHX_ svtype sv_type)
1030 void ** const root = &PL_body_roots[sv_type];
1031 const struct body_details * const bdp = &bodies_by_type[sv_type];
1032 const size_t body_size = bdp->body_size;
1035 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1036 static bool done_sanity_check;
1038 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1039 * variables like done_sanity_check. */
1040 if (!done_sanity_check) {
1041 unsigned int i = SVt_LAST;
1043 done_sanity_check = TRUE;
1046 assert (bodies_by_type[i].type == i);
1050 assert(bdp->arena_size);
1052 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1054 end = start + bdp->arena_size - body_size;
1056 /* computed count doesnt reflect the 1st slot reservation */
1057 DEBUG_m(PerlIO_printf(Perl_debug_log,
1058 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1059 (void*)start, (void*)end,
1060 (int)bdp->arena_size, sv_type, (int)body_size,
1061 (int)bdp->arena_size / (int)body_size));
1063 *root = (void *)start;
1065 while (start < end) {
1066 char * const next = start + body_size;
1067 *(void**) start = (void *)next;
1070 *(void **)start = 0;
1075 /* grab a new thing from the free list, allocating more if necessary.
1076 The inline version is used for speed in hot routines, and the
1077 function using it serves the rest (unless PURIFY).
1079 #define new_body_inline(xpv, sv_type) \
1081 void ** const r3wt = &PL_body_roots[sv_type]; \
1082 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1083 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1084 *(r3wt) = *(void**)(xpv); \
1090 S_new_body(pTHX_ svtype sv_type)
1094 new_body_inline(xpv, sv_type);
1100 static const struct body_details fake_rv =
1101 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1104 =for apidoc sv_upgrade
1106 Upgrade an SV to a more complex form. Generally adds a new body type to the
1107 SV, then copies across as much information as possible from the old body.
1108 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1114 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1119 const svtype old_type = SvTYPE(sv);
1120 const struct body_details *new_type_details;
1121 const struct body_details *old_type_details
1122 = bodies_by_type + old_type;
1123 SV *referant = NULL;
1125 if (new_type != SVt_PV && SvIsCOW(sv)) {
1126 sv_force_normal_flags(sv, 0);
1129 if (old_type == new_type)
1132 old_body = SvANY(sv);
1134 /* Copying structures onto other structures that have been neatly zeroed
1135 has a subtle gotcha. Consider XPVMG
1137 +------+------+------+------+------+-------+-------+
1138 | NV | CUR | LEN | IV | MAGIC | STASH |
1139 +------+------+------+------+------+-------+-------+
1140 0 4 8 12 16 20 24 28
1142 where NVs are aligned to 8 bytes, so that sizeof that structure is
1143 actually 32 bytes long, with 4 bytes of padding at the end:
1145 +------+------+------+------+------+-------+-------+------+
1146 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1147 +------+------+------+------+------+-------+-------+------+
1148 0 4 8 12 16 20 24 28 32
1150 so what happens if you allocate memory for this structure:
1152 +------+------+------+------+------+-------+-------+------+------+...
1153 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 0 4 8 12 16 20 24 28 32 36
1157 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1158 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1159 started out as zero once, but it's quite possible that it isn't. So now,
1160 rather than a nicely zeroed GP, you have it pointing somewhere random.
1163 (In fact, GP ends up pointing at a previous GP structure, because the
1164 principle cause of the padding in XPVMG getting garbage is a copy of
1165 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1166 this happens to be moot because XPVGV has been re-ordered, with GP
1167 no longer after STASH)
1169 So we are careful and work out the size of used parts of all the
1177 referant = SvRV(sv);
1178 old_type_details = &fake_rv;
1179 if (new_type == SVt_NV)
1180 new_type = SVt_PVNV;
1182 if (new_type < SVt_PVIV) {
1183 new_type = (new_type == SVt_NV)
1184 ? SVt_PVNV : SVt_PVIV;
1189 if (new_type < SVt_PVNV) {
1190 new_type = SVt_PVNV;
1194 assert(new_type > SVt_PV);
1195 assert(SVt_IV < SVt_PV);
1196 assert(SVt_NV < SVt_PV);
1203 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1204 there's no way that it can be safely upgraded, because perl.c
1205 expects to Safefree(SvANY(PL_mess_sv)) */
1206 assert(sv != PL_mess_sv);
1207 /* This flag bit is used to mean other things in other scalar types.
1208 Given that it only has meaning inside the pad, it shouldn't be set
1209 on anything that can get upgraded. */
1210 assert(!SvPAD_TYPED(sv));
1213 if (old_type_details->cant_upgrade)
1214 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1215 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1218 if (old_type > new_type)
1219 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1220 (int)old_type, (int)new_type);
1222 new_type_details = bodies_by_type + new_type;
1224 SvFLAGS(sv) &= ~SVTYPEMASK;
1225 SvFLAGS(sv) |= new_type;
1227 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1228 the return statements above will have triggered. */
1229 assert (new_type != SVt_NULL);
1232 assert(old_type == SVt_NULL);
1233 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1237 assert(old_type == SVt_NULL);
1238 SvANY(sv) = new_XNV();
1243 assert(new_type_details->body_size);
1246 assert(new_type_details->arena);
1247 assert(new_type_details->arena_size);
1248 /* This points to the start of the allocated area. */
1249 new_body_inline(new_body, new_type);
1250 Zero(new_body, new_type_details->body_size, char);
1251 new_body = ((char *)new_body) - new_type_details->offset;
1253 /* We always allocated the full length item with PURIFY. To do this
1254 we fake things so that arena is false for all 16 types.. */
1255 new_body = new_NOARENAZ(new_type_details);
1257 SvANY(sv) = new_body;
1258 if (new_type == SVt_PVAV) {
1262 if (old_type_details->body_size) {
1265 /* It will have been zeroed when the new body was allocated.
1266 Lets not write to it, in case it confuses a write-back
1272 #ifndef NODEFAULT_SHAREKEYS
1273 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1275 HvMAX(sv) = 7; /* (start with 8 buckets) */
1276 if (old_type_details->body_size) {
1279 /* It will have been zeroed when the new body was allocated.
1280 Lets not write to it, in case it confuses a write-back
1285 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1286 The target created by newSVrv also is, and it can have magic.
1287 However, it never has SvPVX set.
1289 if (old_type == SVt_IV) {
1291 } else if (old_type >= SVt_PV) {
1292 assert(SvPVX_const(sv) == 0);
1295 if (old_type >= SVt_PVMG) {
1296 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1297 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1299 sv->sv_u.svu_array = NULL; /* or svu_hash */
1305 /* XXX Is this still needed? Was it ever needed? Surely as there is
1306 no route from NV to PVIV, NOK can never be true */
1307 assert(!SvNOKp(sv));
1319 assert(new_type_details->body_size);
1320 /* We always allocated the full length item with PURIFY. To do this
1321 we fake things so that arena is false for all 16 types.. */
1322 if(new_type_details->arena) {
1323 /* This points to the start of the allocated area. */
1324 new_body_inline(new_body, new_type);
1325 Zero(new_body, new_type_details->body_size, char);
1326 new_body = ((char *)new_body) - new_type_details->offset;
1328 new_body = new_NOARENAZ(new_type_details);
1330 SvANY(sv) = new_body;
1332 if (old_type_details->copy) {
1333 /* There is now the potential for an upgrade from something without
1334 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1335 int offset = old_type_details->offset;
1336 int length = old_type_details->copy;
1338 if (new_type_details->offset > old_type_details->offset) {
1339 const int difference
1340 = new_type_details->offset - old_type_details->offset;
1341 offset += difference;
1342 length -= difference;
1344 assert (length >= 0);
1346 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1350 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1351 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1352 * correct 0.0 for us. Otherwise, if the old body didn't have an
1353 * NV slot, but the new one does, then we need to initialise the
1354 * freshly created NV slot with whatever the correct bit pattern is
1356 if (old_type_details->zero_nv && !new_type_details->zero_nv
1357 && !isGV_with_GP(sv))
1361 if (new_type == SVt_PVIO)
1362 IoPAGE_LEN(sv) = 60;
1363 if (old_type < SVt_PV) {
1364 /* referant will be NULL unless the old type was SVt_IV emulating
1366 sv->sv_u.svu_rv = referant;
1370 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1371 (unsigned long)new_type);
1374 if (old_type_details->arena) {
1375 /* If there was an old body, then we need to free it.
1376 Note that there is an assumption that all bodies of types that
1377 can be upgraded came from arenas. Only the more complex non-
1378 upgradable types are allowed to be directly malloc()ed. */
1380 my_safefree(old_body);
1382 del_body((void*)((char*)old_body + old_type_details->offset),
1383 &PL_body_roots[old_type]);
1389 =for apidoc sv_backoff
1391 Remove any string offset. You should normally use the C<SvOOK_off> macro
1398 Perl_sv_backoff(pTHX_ register SV *sv)
1400 UV delta = sv_read_offset(sv);
1401 const char * const s = SvPVX_const(sv);
1402 PERL_UNUSED_CONTEXT;
1404 assert(SvTYPE(sv) != SVt_PVHV);
1405 assert(SvTYPE(sv) != SVt_PVAV);
1407 SvLEN_set(sv, SvLEN(sv) + delta);
1408 SvPV_set(sv, SvPVX(sv) - delta);
1409 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 = newSVpvs_flags("", SVs_TEMP);
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);
2695 const SV *const referent = (SV*)SvRV(sv);
2699 retval = buffer = savepvn("NULLREF", len);
2700 } else if (SvTYPE(referent) == SVt_REGEXP) {
2705 /* FIXME - get rid of this cast away of const, or work out
2706 how to do it better. */
2707 temp.mg_obj = (SV *)referent;
2708 assert(temp.mg_obj);
2709 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2714 PL_reginterp_cnt += haseval;
2717 const char *const typestr = sv_reftype(referent, 0);
2718 const STRLEN typelen = strlen(typestr);
2719 UV addr = PTR2UV(referent);
2720 const char *stashname = NULL;
2721 STRLEN stashnamelen = 0; /* hush, gcc */
2722 const char *buffer_end;
2724 if (SvOBJECT(referent)) {
2725 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2728 stashname = HEK_KEY(name);
2729 stashnamelen = HEK_LEN(name);
2731 if (HEK_UTF8(name)) {
2737 stashname = "__ANON__";
2740 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2741 + 2 * sizeof(UV) + 2 /* )\0 */;
2743 len = typelen + 3 /* (0x */
2744 + 2 * sizeof(UV) + 2 /* )\0 */;
2747 Newx(buffer, len, char);
2748 buffer_end = retval = buffer + len;
2750 /* Working backwards */
2754 *--retval = PL_hexdigit[addr & 15];
2755 } while (addr >>= 4);
2761 memcpy(retval, typestr, typelen);
2765 retval -= stashnamelen;
2766 memcpy(retval, stashname, stashnamelen);
2768 /* retval may not neccesarily have reached the start of the
2770 assert (retval >= buffer);
2772 len = buffer_end - retval - 1; /* -1 for that \0 */
2780 if (SvREADONLY(sv) && !SvOK(sv)) {
2781 if (ckWARN(WARN_UNINITIALIZED))
2788 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2789 /* I'm assuming that if both IV and NV are equally valid then
2790 converting the IV is going to be more efficient */
2791 const U32 isUIOK = SvIsUV(sv);
2792 char buf[TYPE_CHARS(UV)];
2796 if (SvTYPE(sv) < SVt_PVIV)
2797 sv_upgrade(sv, SVt_PVIV);
2798 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2800 /* inlined from sv_setpvn */
2801 s = SvGROW_mutable(sv, len + 1);
2802 Move(ptr, s, len, char);
2806 else if (SvNOKp(sv)) {
2807 const int olderrno = errno;
2808 if (SvTYPE(sv) < SVt_PVNV)
2809 sv_upgrade(sv, SVt_PVNV);
2810 /* The +20 is pure guesswork. Configure test needed. --jhi */
2811 s = SvGROW_mutable(sv, NV_DIG + 20);
2812 /* some Xenix systems wipe out errno here */
2814 if (SvNVX(sv) == 0.0)
2815 my_strlcpy(s, "0", SvLEN(sv));
2819 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2822 #ifdef FIXNEGATIVEZERO
2823 if (*s == '-' && s[1] == '0' && !s[2]) {
2835 if (isGV_with_GP(sv))
2836 return glob_2pv((GV *)sv, lp);
2838 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2842 if (SvTYPE(sv) < SVt_PV)
2843 /* Typically the caller expects that sv_any is not NULL now. */
2844 sv_upgrade(sv, SVt_PV);
2848 const STRLEN len = s - SvPVX_const(sv);
2854 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2855 PTR2UV(sv),SvPVX_const(sv)));
2856 if (flags & SV_CONST_RETURN)
2857 return (char *)SvPVX_const(sv);
2858 if (flags & SV_MUTABLE_RETURN)
2859 return SvPVX_mutable(sv);
2864 =for apidoc sv_copypv
2866 Copies a stringified representation of the source SV into the
2867 destination SV. Automatically performs any necessary mg_get and
2868 coercion of numeric values into strings. Guaranteed to preserve
2869 UTF8 flag even from overloaded objects. Similar in nature to
2870 sv_2pv[_flags] but operates directly on an SV instead of just the
2871 string. Mostly uses sv_2pv_flags to do its work, except when that
2872 would lose the UTF-8'ness of the PV.
2878 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2881 const char * const s = SvPV_const(ssv,len);
2882 sv_setpvn(dsv,s,len);
2890 =for apidoc sv_2pvbyte
2892 Return a pointer to the byte-encoded representation of the SV, and set *lp
2893 to its length. May cause the SV to be downgraded from UTF-8 as a
2896 Usually accessed via the C<SvPVbyte> macro.
2902 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2904 sv_utf8_downgrade(sv,0);
2905 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2909 =for apidoc sv_2pvutf8
2911 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2912 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2914 Usually accessed via the C<SvPVutf8> macro.
2920 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2922 sv_utf8_upgrade(sv);
2923 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2928 =for apidoc sv_2bool
2930 This function is only called on magical items, and is only used by
2931 sv_true() or its macro equivalent.
2937 Perl_sv_2bool(pTHX_ register SV *sv)
2946 SV * const tmpsv = AMG_CALLun(sv,bool_);
2947 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2948 return (bool)SvTRUE(tmpsv);
2950 return SvRV(sv) != 0;
2953 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2955 (*sv->sv_u.svu_pv > '0' ||
2956 Xpvtmp->xpv_cur > 1 ||
2957 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2964 return SvIVX(sv) != 0;
2967 return SvNVX(sv) != 0.0;
2969 if (isGV_with_GP(sv))
2979 =for apidoc sv_utf8_upgrade
2981 Converts the PV of an SV to its UTF-8-encoded form.
2982 Forces the SV to string form if it is not already.
2983 Always sets the SvUTF8 flag to avoid future validity checks even
2984 if all the bytes have hibit clear.
2986 This is not as a general purpose byte encoding to Unicode interface:
2987 use the Encode extension for that.
2989 =for apidoc sv_utf8_upgrade_flags
2991 Converts the PV of an SV to its UTF-8-encoded form.
2992 Forces the SV to string form if it is not already.
2993 Always sets the SvUTF8 flag to avoid future validity checks even
2994 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2995 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
2996 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
2998 This is not as a general purpose byte encoding to Unicode interface:
2999 use the Encode extension for that.
3005 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3008 if (sv == &PL_sv_undef)
3012 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3013 (void) sv_2pv_flags(sv,&len, flags);
3017 (void) SvPV_force(sv,len);
3026 sv_force_normal_flags(sv, 0);
3029 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3030 sv_recode_to_utf8(sv, PL_encoding);
3031 else { /* Assume Latin-1/EBCDIC */
3032 /* This function could be much more efficient if we
3033 * had a FLAG in SVs to signal if there are any hibit
3034 * chars in the PV. Given that there isn't such a flag
3035 * make the loop as fast as possible. */
3036 const U8 * const s = (U8 *) SvPVX_const(sv);
3037 const U8 * const e = (U8 *) SvEND(sv);
3042 /* Check for hi bit */
3043 if (!NATIVE_IS_INVARIANT(ch)) {
3044 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3045 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3047 SvPV_free(sv); /* No longer using what was there before. */
3048 SvPV_set(sv, (char*)recoded);
3049 SvCUR_set(sv, len - 1);
3050 SvLEN_set(sv, len); /* No longer know the real size. */
3054 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3061 =for apidoc sv_utf8_downgrade
3063 Attempts to convert the PV of an SV from characters to bytes.
3064 If the PV contains a character beyond byte, this conversion will fail;
3065 in this case, either returns false or, if C<fail_ok> is not
3068 This is not as a general purpose Unicode to byte encoding interface:
3069 use the Encode extension for that.
3075 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3078 if (SvPOKp(sv) && SvUTF8(sv)) {
3084 sv_force_normal_flags(sv, 0);
3086 s = (U8 *) SvPV(sv, len);
3087 if (!utf8_to_bytes(s, &len)) {
3092 Perl_croak(aTHX_ "Wide character in %s",
3095 Perl_croak(aTHX_ "Wide character");
3106 =for apidoc sv_utf8_encode
3108 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3109 flag off so that it looks like octets again.
3115 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3118 sv_force_normal_flags(sv, 0);
3120 if (SvREADONLY(sv)) {
3121 Perl_croak(aTHX_ PL_no_modify);
3123 (void) sv_utf8_upgrade(sv);
3128 =for apidoc sv_utf8_decode
3130 If the PV of the SV is an octet sequence in UTF-8
3131 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3132 so that it looks like a character. If the PV contains only single-byte
3133 characters, the C<SvUTF8> flag stays being off.
3134 Scans PV for validity and returns false if the PV is invalid UTF-8.
3140 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3146 /* The octets may have got themselves encoded - get them back as
3149 if (!sv_utf8_downgrade(sv, TRUE))
3152 /* it is actually just a matter of turning the utf8 flag on, but
3153 * we want to make sure everything inside is valid utf8 first.
3155 c = (const U8 *) SvPVX_const(sv);
3156 if (!is_utf8_string(c, SvCUR(sv)+1))
3158 e = (const U8 *) SvEND(sv);
3161 if (!UTF8_IS_INVARIANT(ch)) {
3171 =for apidoc sv_setsv
3173 Copies the contents of the source SV C<ssv> into the destination SV
3174 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3175 function if the source SV needs to be reused. Does not handle 'set' magic.
3176 Loosely speaking, it performs a copy-by-value, obliterating any previous
3177 content of the destination.
3179 You probably want to use one of the assortment of wrappers, such as
3180 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3181 C<SvSetMagicSV_nosteal>.
3183 =for apidoc sv_setsv_flags
3185 Copies the contents of the source SV C<ssv> into the destination SV
3186 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3187 function if the source SV needs to be reused. Does not handle 'set' magic.
3188 Loosely speaking, it performs a copy-by-value, obliterating any previous
3189 content of the destination.
3190 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3191 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3192 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3193 and C<sv_setsv_nomg> are implemented in terms of this function.
3195 You probably want to use one of the assortment of wrappers, such as
3196 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3197 C<SvSetMagicSV_nosteal>.
3199 This is the primary function for copying scalars, and most other
3200 copy-ish functions and macros use this underneath.
3206 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3208 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3210 if (dtype != SVt_PVGV) {
3211 const char * const name = GvNAME(sstr);
3212 const STRLEN len = GvNAMELEN(sstr);
3214 if (dtype >= SVt_PV) {
3220 SvUPGRADE(dstr, SVt_PVGV);
3221 (void)SvOK_off(dstr);
3222 /* FIXME - why are we doing this, then turning it off and on again
3224 isGV_with_GP_on(dstr);
3226 GvSTASH(dstr) = GvSTASH(sstr);
3228 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3229 gv_name_set((GV *)dstr, name, len, GV_ADD);
3230 SvFAKE_on(dstr); /* can coerce to non-glob */
3233 #ifdef GV_UNIQUE_CHECK
3234 if (GvUNIQUE((GV*)dstr)) {
3235 Perl_croak(aTHX_ PL_no_modify);
3239 if(GvGP((GV*)sstr)) {
3240 /* If source has method cache entry, clear it */
3242 SvREFCNT_dec(GvCV(sstr));
3246 /* If source has a real method, then a method is
3248 else if(GvCV((GV*)sstr)) {
3253 /* If dest already had a real method, that's a change as well */
3254 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3258 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3262 isGV_with_GP_off(dstr);
3263 (void)SvOK_off(dstr);
3264 isGV_with_GP_on(dstr);
3265 GvINTRO_off(dstr); /* one-shot flag */
3266 GvGP(dstr) = gp_ref(GvGP(sstr));
3267 if (SvTAINTED(sstr))
3269 if (GvIMPORTED(dstr) != GVf_IMPORTED
3270 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3272 GvIMPORTED_on(dstr);
3275 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3276 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3281 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3282 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3284 const int intro = GvINTRO(dstr);
3287 const U32 stype = SvTYPE(sref);
3290 #ifdef GV_UNIQUE_CHECK
3291 if (GvUNIQUE((GV*)dstr)) {
3292 Perl_croak(aTHX_ PL_no_modify);
3297 GvINTRO_off(dstr); /* one-shot flag */
3298 GvLINE(dstr) = CopLINE(PL_curcop);
3299 GvEGV(dstr) = (GV*)dstr;
3304 location = (SV **) &GvCV(dstr);
3305 import_flag = GVf_IMPORTED_CV;
3308 location = (SV **) &GvHV(dstr);
3309 import_flag = GVf_IMPORTED_HV;
3312 location = (SV **) &GvAV(dstr);
3313 import_flag = GVf_IMPORTED_AV;
3316 location = (SV **) &GvIOp(dstr);
3319 location = (SV **) &GvFORM(dstr);
3321 location = &GvSV(dstr);
3322 import_flag = GVf_IMPORTED_SV;
3325 if (stype == SVt_PVCV) {
3326 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3327 if (GvCVGEN(dstr)) {
3328 SvREFCNT_dec(GvCV(dstr));
3330 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3333 SAVEGENERICSV(*location);
3337 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3338 CV* const cv = (CV*)*location;
3340 if (!GvCVGEN((GV*)dstr) &&
3341 (CvROOT(cv) || CvXSUB(cv)))
3343 /* Redefining a sub - warning is mandatory if
3344 it was a const and its value changed. */
3345 if (CvCONST(cv) && CvCONST((CV*)sref)
3346 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3348 /* They are 2 constant subroutines generated from
3349 the same constant. This probably means that
3350 they are really the "same" proxy subroutine
3351 instantiated in 2 places. Most likely this is
3352 when a constant is exported twice. Don't warn.
3355 else if (ckWARN(WARN_REDEFINE)
3357 && (!CvCONST((CV*)sref)
3358 || sv_cmp(cv_const_sv(cv),
3359 cv_const_sv((CV*)sref))))) {
3360 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3363 ? "Constant subroutine %s::%s redefined"
3364 : "Subroutine %s::%s redefined"),
3365 HvNAME_get(GvSTASH((GV*)dstr)),
3366 GvENAME((GV*)dstr));
3370 cv_ckproto_len(cv, (GV*)dstr,
3371 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3372 SvPOK(sref) ? SvCUR(sref) : 0);
3374 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3375 GvASSUMECV_on(dstr);
3376 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3379 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3380 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3381 GvFLAGS(dstr) |= import_flag;
3386 if (SvTAINTED(sstr))
3392 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3395 register U32 sflags;
3397 register svtype stype;
3402 if (SvIS_FREED(dstr)) {
3403 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3404 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3406 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3408 sstr = &PL_sv_undef;
3409 if (SvIS_FREED(sstr)) {
3410 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3411 (void*)sstr, (void*)dstr);
3413 stype = SvTYPE(sstr);
3414 dtype = SvTYPE(dstr);
3416 (void)SvAMAGIC_off(dstr);
3419 /* need to nuke the magic */
3421 SvRMAGICAL_off(dstr);
3424 /* There's a lot of redundancy below but we're going for speed here */
3429 if (dtype != SVt_PVGV) {
3430 (void)SvOK_off(dstr);
3438 sv_upgrade(dstr, SVt_IV);
3442 sv_upgrade(dstr, SVt_PVIV);
3445 goto end_of_first_switch;
3447 (void)SvIOK_only(dstr);
3448 SvIV_set(dstr, SvIVX(sstr));
3451 /* SvTAINTED can only be true if the SV has taint magic, which in
3452 turn means that the SV type is PVMG (or greater). This is the
3453 case statement for SVt_IV, so this cannot be true (whatever gcov
3455 assert(!SvTAINTED(sstr));
3460 if (dtype < SVt_PV && dtype != SVt_IV)
3461 sv_upgrade(dstr, SVt_IV);
3469 sv_upgrade(dstr, SVt_NV);
3473 sv_upgrade(dstr, SVt_PVNV);
3476 goto end_of_first_switch;
3478 SvNV_set(dstr, SvNVX(sstr));
3479 (void)SvNOK_only(dstr);
3480 /* SvTAINTED can only be true if the SV has taint magic, which in
3481 turn means that the SV type is PVMG (or greater). This is the
3482 case statement for SVt_NV, so this cannot be true (whatever gcov
3484 assert(!SvTAINTED(sstr));
3490 #ifdef PERL_OLD_COPY_ON_WRITE
3491 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3492 if (dtype < SVt_PVIV)
3493 sv_upgrade(dstr, SVt_PVIV);
3500 sv_upgrade(dstr, SVt_PV);
3503 if (dtype < SVt_PVIV)
3504 sv_upgrade(dstr, SVt_PVIV);
3507 if (dtype < SVt_PVNV)
3508 sv_upgrade(dstr, SVt_PVNV);
3512 const char * const type = sv_reftype(sstr,0);
3514 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3516 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3520 /* case SVt_BIND: */
3523 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3524 glob_assign_glob(dstr, sstr, dtype);
3527 /* SvVALID means that this PVGV is playing at being an FBM. */
3531 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3533 if (SvTYPE(sstr) != stype) {
3534 stype = SvTYPE(sstr);
3535 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3536 glob_assign_glob(dstr, sstr, dtype);
3541 if (stype == SVt_PVLV)
3542 SvUPGRADE(dstr, SVt_PVNV);
3544 SvUPGRADE(dstr, (svtype)stype);
3546 end_of_first_switch:
3548 /* dstr may have been upgraded. */
3549 dtype = SvTYPE(dstr);
3550 sflags = SvFLAGS(sstr);
3552 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3553 /* Assigning to a subroutine sets the prototype. */
3556 const char *const ptr = SvPV_const(sstr, len);
3558 SvGROW(dstr, len + 1);
3559 Copy(ptr, SvPVX(dstr), len + 1, char);
3560 SvCUR_set(dstr, len);
3562 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3566 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3567 const char * const type = sv_reftype(dstr,0);
3569 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3571 Perl_croak(aTHX_ "Cannot copy to %s", type);
3572 } else if (sflags & SVf_ROK) {
3573 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3574 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3577 if (GvIMPORTED(dstr) != GVf_IMPORTED
3578 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3580 GvIMPORTED_on(dstr);
3585 glob_assign_glob(dstr, sstr, dtype);
3589 if (dtype >= SVt_PV) {
3590 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3591 glob_assign_ref(dstr, sstr);
3594 if (SvPVX_const(dstr)) {
3600 (void)SvOK_off(dstr);
3601 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3602 SvFLAGS(dstr) |= sflags & SVf_ROK;
3603 assert(!(sflags & SVp_NOK));
3604 assert(!(sflags & SVp_IOK));
3605 assert(!(sflags & SVf_NOK));
3606 assert(!(sflags & SVf_IOK));
3608 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3609 if (!(sflags & SVf_OK)) {
3610 if (ckWARN(WARN_MISC))
3611 Perl_warner(aTHX_ packWARN(WARN_MISC),
3612 "Undefined value assigned to typeglob");
3615 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3616 if (dstr != (SV*)gv) {
3619 GvGP(dstr) = gp_ref(GvGP(gv));
3623 else if (sflags & SVp_POK) {
3627 * Check to see if we can just swipe the string. If so, it's a
3628 * possible small lose on short strings, but a big win on long ones.
3629 * It might even be a win on short strings if SvPVX_const(dstr)
3630 * has to be allocated and SvPVX_const(sstr) has to be freed.
3631 * Likewise if we can set up COW rather than doing an actual copy, we
3632 * drop to the else clause, as the swipe code and the COW setup code
3633 * have much in common.
3636 /* Whichever path we take through the next code, we want this true,
3637 and doing it now facilitates the COW check. */
3638 (void)SvPOK_only(dstr);
3641 /* If we're already COW then this clause is not true, and if COW
3642 is allowed then we drop down to the else and make dest COW
3643 with us. If caller hasn't said that we're allowed to COW
3644 shared hash keys then we don't do the COW setup, even if the
3645 source scalar is a shared hash key scalar. */
3646 (((flags & SV_COW_SHARED_HASH_KEYS)
3647 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3648 : 1 /* If making a COW copy is forbidden then the behaviour we
3649 desire is as if the source SV isn't actually already
3650 COW, even if it is. So we act as if the source flags
3651 are not COW, rather than actually testing them. */
3653 #ifndef PERL_OLD_COPY_ON_WRITE
3654 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3655 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3656 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3657 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3658 but in turn, it's somewhat dead code, never expected to go
3659 live, but more kept as a placeholder on how to do it better
3660 in a newer implementation. */
3661 /* If we are COW and dstr is a suitable target then we drop down
3662 into the else and make dest a COW of us. */
3663 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3668 (sflags & SVs_TEMP) && /* slated for free anyway? */
3669 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3670 (!(flags & SV_NOSTEAL)) &&
3671 /* and we're allowed to steal temps */
3672 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3673 SvLEN(sstr) && /* and really is a string */
3674 /* and won't be needed again, potentially */
3675 !(PL_op && PL_op->op_type == OP_AASSIGN))
3676 #ifdef PERL_OLD_COPY_ON_WRITE
3677 && ((flags & SV_COW_SHARED_HASH_KEYS)
3678 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3679 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3680 && SvTYPE(sstr) >= SVt_PVIV))
3684 /* Failed the swipe test, and it's not a shared hash key either.
3685 Have to copy the string. */
3686 STRLEN len = SvCUR(sstr);
3687 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3688 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3689 SvCUR_set(dstr, len);
3690 *SvEND(dstr) = '\0';
3692 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3694 /* Either it's a shared hash key, or it's suitable for
3695 copy-on-write or we can swipe the string. */
3697 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3701 #ifdef PERL_OLD_COPY_ON_WRITE
3703 /* I believe I should acquire a global SV mutex if
3704 it's a COW sv (not a shared hash key) to stop
3705 it going un copy-on-write.
3706 If the source SV has gone un copy on write between up there
3707 and down here, then (assert() that) it is of the correct
3708 form to make it copy on write again */
3709 if ((sflags & (SVf_FAKE | SVf_READONLY))
3710 != (SVf_FAKE | SVf_READONLY)) {
3711 SvREADONLY_on(sstr);
3713 /* Make the source SV into a loop of 1.
3714 (about to become 2) */
3715 SV_COW_NEXT_SV_SET(sstr, sstr);
3719 /* Initial code is common. */
3720 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3725 /* making another shared SV. */
3726 STRLEN cur = SvCUR(sstr);
3727 STRLEN len = SvLEN(sstr);
3728 #ifdef PERL_OLD_COPY_ON_WRITE
3730 assert (SvTYPE(dstr) >= SVt_PVIV);
3731 /* SvIsCOW_normal */
3732 /* splice us in between source and next-after-source. */
3733 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3734 SV_COW_NEXT_SV_SET(sstr, dstr);
3735 SvPV_set(dstr, SvPVX_mutable(sstr));
3739 /* SvIsCOW_shared_hash */
3740 DEBUG_C(PerlIO_printf(Perl_debug_log,
3741 "Copy on write: Sharing hash\n"));
3743 assert (SvTYPE(dstr) >= SVt_PV);
3745 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3747 SvLEN_set(dstr, len);
3748 SvCUR_set(dstr, cur);
3749 SvREADONLY_on(dstr);
3751 /* Relesase a global SV mutex. */
3754 { /* Passes the swipe test. */
3755 SvPV_set(dstr, SvPVX_mutable(sstr));
3756 SvLEN_set(dstr, SvLEN(sstr));
3757 SvCUR_set(dstr, SvCUR(sstr));
3760 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3761 SvPV_set(sstr, NULL);
3767 if (sflags & SVp_NOK) {
3768 SvNV_set(dstr, SvNVX(sstr));
3770 if (sflags & SVp_IOK) {
3771 SvIV_set(dstr, SvIVX(sstr));
3772 /* Must do this otherwise some other overloaded use of 0x80000000
3773 gets confused. I guess SVpbm_VALID */
3774 if (sflags & SVf_IVisUV)
3777 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3779 const MAGIC * const smg = SvVSTRING_mg(sstr);
3781 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3782 smg->mg_ptr, smg->mg_len);
3783 SvRMAGICAL_on(dstr);
3787 else if (sflags & (SVp_IOK|SVp_NOK)) {
3788 (void)SvOK_off(dstr);
3789 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3790 if (sflags & SVp_IOK) {
3791 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3792 SvIV_set(dstr, SvIVX(sstr));
3794 if (sflags & SVp_NOK) {
3795 SvNV_set(dstr, SvNVX(sstr));
3799 if (isGV_with_GP(sstr)) {
3800 /* This stringification rule for globs is spread in 3 places.
3801 This feels bad. FIXME. */
3802 const U32 wasfake = sflags & SVf_FAKE;
3804 /* FAKE globs can get coerced, so need to turn this off
3805 temporarily if it is on. */
3807 gv_efullname3(dstr, (GV *)sstr, "*");
3808 SvFLAGS(sstr) |= wasfake;
3811 (void)SvOK_off(dstr);
3813 if (SvTAINTED(sstr))
3818 =for apidoc sv_setsv_mg
3820 Like C<sv_setsv>, but also handles 'set' magic.
3826 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3828 sv_setsv(dstr,sstr);
3832 #ifdef PERL_OLD_COPY_ON_WRITE
3834 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3836 STRLEN cur = SvCUR(sstr);
3837 STRLEN len = SvLEN(sstr);
3838 register char *new_pv;
3841 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3842 (void*)sstr, (void*)dstr);
3849 if (SvTHINKFIRST(dstr))
3850 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3851 else if (SvPVX_const(dstr))
3852 Safefree(SvPVX_const(dstr));
3856 SvUPGRADE(dstr, SVt_PVIV);
3858 assert (SvPOK(sstr));
3859 assert (SvPOKp(sstr));
3860 assert (!SvIOK(sstr));
3861 assert (!SvIOKp(sstr));
3862 assert (!SvNOK(sstr));
3863 assert (!SvNOKp(sstr));
3865 if (SvIsCOW(sstr)) {
3867 if (SvLEN(sstr) == 0) {
3868 /* source is a COW shared hash key. */
3869 DEBUG_C(PerlIO_printf(Perl_debug_log,
3870 "Fast copy on write: Sharing hash\n"));
3871 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3874 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3876 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3877 SvUPGRADE(sstr, SVt_PVIV);
3878 SvREADONLY_on(sstr);
3880 DEBUG_C(PerlIO_printf(Perl_debug_log,
3881 "Fast copy on write: Converting sstr to COW\n"));
3882 SV_COW_NEXT_SV_SET(dstr, sstr);
3884 SV_COW_NEXT_SV_SET(sstr, dstr);
3885 new_pv = SvPVX_mutable(sstr);
3888 SvPV_set(dstr, new_pv);
3889 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3892 SvLEN_set(dstr, len);
3893 SvCUR_set(dstr, cur);
3902 =for apidoc sv_setpvn
3904 Copies a string into an SV. The C<len> parameter indicates the number of
3905 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3906 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3912 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3915 register char *dptr;
3917 SV_CHECK_THINKFIRST_COW_DROP(sv);
3923 /* len is STRLEN which is unsigned, need to copy to signed */
3926 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3928 SvUPGRADE(sv, SVt_PV);
3930 dptr = SvGROW(sv, len + 1);
3931 Move(ptr,dptr,len,char);
3934 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3939 =for apidoc sv_setpvn_mg
3941 Like C<sv_setpvn>, but also handles 'set' magic.
3947 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3949 sv_setpvn(sv,ptr,len);
3954 =for apidoc sv_setpv
3956 Copies a string into an SV. The string must be null-terminated. Does not
3957 handle 'set' magic. See C<sv_setpv_mg>.
3963 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3966 register STRLEN len;
3968 SV_CHECK_THINKFIRST_COW_DROP(sv);
3974 SvUPGRADE(sv, SVt_PV);
3976 SvGROW(sv, len + 1);
3977 Move(ptr,SvPVX(sv),len+1,char);
3979 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3984 =for apidoc sv_setpv_mg
3986 Like C<sv_setpv>, but also handles 'set' magic.
3992 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
3999 =for apidoc sv_usepvn_flags
4001 Tells an SV to use C<ptr> to find its string value. Normally the
4002 string is stored inside the SV but sv_usepvn allows the SV to use an
4003 outside string. The C<ptr> should point to memory that was allocated
4004 by C<malloc>. The string length, C<len>, must be supplied. By default
4005 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4006 so that pointer should not be freed or used by the programmer after
4007 giving it to sv_usepvn, and neither should any pointers from "behind"
4008 that pointer (e.g. ptr + 1) be used.
4010 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4011 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4012 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4013 C<len>, and already meets the requirements for storing in C<SvPVX>)
4019 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4023 SV_CHECK_THINKFIRST_COW_DROP(sv);
4024 SvUPGRADE(sv, SVt_PV);
4027 if (flags & SV_SMAGIC)
4031 if (SvPVX_const(sv))
4035 if (flags & SV_HAS_TRAILING_NUL)
4036 assert(ptr[len] == '\0');
4039 allocate = (flags & SV_HAS_TRAILING_NUL)
4040 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4041 if (flags & SV_HAS_TRAILING_NUL) {
4042 /* It's long enough - do nothing.
4043 Specfically Perl_newCONSTSUB is relying on this. */
4046 /* Force a move to shake out bugs in callers. */
4047 char *new_ptr = (char*)safemalloc(allocate);
4048 Copy(ptr, new_ptr, len, char);
4049 PoisonFree(ptr,len,char);
4053 ptr = (char*) saferealloc (ptr, allocate);
4058 SvLEN_set(sv, allocate);
4059 if (!(flags & SV_HAS_TRAILING_NUL)) {
4062 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4064 if (flags & SV_SMAGIC)
4068 #ifdef PERL_OLD_COPY_ON_WRITE
4069 /* Need to do this *after* making the SV normal, as we need the buffer
4070 pointer to remain valid until after we've copied it. If we let go too early,
4071 another thread could invalidate it by unsharing last of the same hash key
4072 (which it can do by means other than releasing copy-on-write Svs)
4073 or by changing the other copy-on-write SVs in the loop. */
4075 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4077 { /* this SV was SvIsCOW_normal(sv) */
4078 /* we need to find the SV pointing to us. */
4079 SV *current = SV_COW_NEXT_SV(after);
4081 if (current == sv) {
4082 /* The SV we point to points back to us (there were only two of us
4084 Hence other SV is no longer copy on write either. */
4086 SvREADONLY_off(after);
4088 /* We need to follow the pointers around the loop. */
4090 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4093 /* don't loop forever if the structure is bust, and we have
4094 a pointer into a closed loop. */
4095 assert (current != after);
4096 assert (SvPVX_const(current) == pvx);
4098 /* Make the SV before us point to the SV after us. */
4099 SV_COW_NEXT_SV_SET(current, after);
4105 =for apidoc sv_force_normal_flags
4107 Undo various types of fakery on an SV: if the PV is a shared string, make
4108 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4109 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4110 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4111 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4112 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4113 set to some other value.) In addition, the C<flags> parameter gets passed to
4114 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4115 with flags set to 0.
4121 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4124 #ifdef PERL_OLD_COPY_ON_WRITE
4125 if (SvREADONLY(sv)) {
4126 /* At this point I believe I should acquire a global SV mutex. */
4128 const char * const pvx = SvPVX_const(sv);
4129 const STRLEN len = SvLEN(sv);
4130 const STRLEN cur = SvCUR(sv);
4131 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4132 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4133 we'll fail an assertion. */
4134 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4137 PerlIO_printf(Perl_debug_log,
4138 "Copy on write: Force normal %ld\n",
4144 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4147 if (flags & SV_COW_DROP_PV) {
4148 /* OK, so we don't need to copy our buffer. */
4151 SvGROW(sv, cur + 1);
4152 Move(pvx,SvPVX(sv),cur,char);
4157 sv_release_COW(sv, pvx, next);
4159 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4165 else if (IN_PERL_RUNTIME)
4166 Perl_croak(aTHX_ PL_no_modify);
4167 /* At this point I believe that I can drop the global SV mutex. */
4170 if (SvREADONLY(sv)) {
4172 const char * const pvx = SvPVX_const(sv);
4173 const STRLEN len = SvCUR(sv);
4178 SvGROW(sv, len + 1);
4179 Move(pvx,SvPVX(sv),len,char);
4181 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4183 else if (IN_PERL_RUNTIME)
4184 Perl_croak(aTHX_ PL_no_modify);
4188 sv_unref_flags(sv, flags);
4189 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4194 Perl_sv_read_offset(pTHX_ const SV *const sv) {
4201 p = (U8*)SvPVX_const(sv);
4207 while ((c & 0x80)) {
4208 UV const last_delta = delta;
4210 if (delta < last_delta)
4211 Perl_croak(aTHX_ "panic: overflow in sv_read_offset from %"UVuf
4212 " to %"UVuf, last_delta, delta);
4218 /* Validate the preceding buffer's sentinels to verify that no-one is
4220 const U8 *const real_start = (U8 *) SvPVX_const(sv) - delta;
4221 while (p > real_start) {
4223 assert (*p == (U8)PTR2UV(p));
4233 Efficient removal of characters from the beginning of the string buffer.
4234 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4235 the string buffer. The C<ptr> becomes the first character of the adjusted
4236 string. Uses the "OOK hack".
4237 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4238 refer to the same chunk of data.
4244 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4246 register STRLEN delta;
4250 const U8 *real_start;
4253 if (!ptr || !SvPOKp(sv))
4255 delta = ptr - SvPVX_const(sv);
4257 /* Nothing to do. */
4260 assert(ptr > SvPVX_const(sv));
4261 SV_CHECK_THINKFIRST(sv);
4264 if (!SvLEN(sv)) { /* make copy of shared string */
4265 const char *pvx = SvPVX_const(sv);
4266 const STRLEN len = SvCUR(sv);
4267 SvGROW(sv, len + 1);
4268 Move(pvx,SvPVX(sv),len,char);
4271 SvFLAGS(sv) |= SVf_OOK;
4274 old_delta = sv_read_offset(sv);
4276 SvLEN_set(sv, SvLEN(sv) - delta);
4277 SvCUR_set(sv, SvCUR(sv) - delta);
4278 SvPV_set(sv, SvPVX(sv) + delta);
4280 p = (U8 *)SvPVX_const(sv);
4285 real_start = p - delta;
4291 /* Code lovingly ripped from pp_pack.c: */
4292 U8 buf[(sizeof(UV)*CHAR_BIT)/7+1];
4296 *in++ = (U8)((delta & 0x7f) | 0x80);
4299 buf[0] &= 0x7f; /* clear continue bit */
4303 Copy(buf, p, len, U8);
4307 /* Fill the preceding buffer with sentinals to verify that no-one is
4309 while (p > real_start) {
4317 =for apidoc sv_catpvn
4319 Concatenates the string onto the end of the string which is in the SV. The
4320 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4321 status set, then the bytes appended should be valid UTF-8.
4322 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4324 =for apidoc sv_catpvn_flags
4326 Concatenates the string onto the end of the string which is in the SV. The
4327 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4328 status set, then the bytes appended should be valid UTF-8.
4329 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4330 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4331 in terms of this function.
4337 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4341 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4343 SvGROW(dsv, dlen + slen + 1);
4345 sstr = SvPVX_const(dsv);
4346 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4347 SvCUR_set(dsv, SvCUR(dsv) + slen);
4349 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4351 if (flags & SV_SMAGIC)
4356 =for apidoc sv_catsv
4358 Concatenates the string from SV C<ssv> onto the end of the string in
4359 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4360 not 'set' magic. See C<sv_catsv_mg>.
4362 =for apidoc sv_catsv_flags
4364 Concatenates the string from SV C<ssv> onto the end of the string in
4365 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4366 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4367 and C<sv_catsv_nomg> are implemented in terms of this function.
4372 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4377 const char *spv = SvPV_const(ssv, slen);
4379 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4380 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4381 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4382 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4383 dsv->sv_flags doesn't have that bit set.
4384 Andy Dougherty 12 Oct 2001
4386 const I32 sutf8 = DO_UTF8(ssv);
4389 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4391 dutf8 = DO_UTF8(dsv);
4393 if (dutf8 != sutf8) {
4395 /* Not modifying source SV, so taking a temporary copy. */
4396 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4398 sv_utf8_upgrade(csv);
4399 spv = SvPV_const(csv, slen);
4402 sv_utf8_upgrade_nomg(dsv);
4404 sv_catpvn_nomg(dsv, spv, slen);
4407 if (flags & SV_SMAGIC)
4412 =for apidoc sv_catpv
4414 Concatenates the string onto the end of the string which is in the SV.
4415 If the SV has the UTF-8 status set, then the bytes appended should be
4416 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4421 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4424 register STRLEN len;
4430 junk = SvPV_force(sv, tlen);
4432 SvGROW(sv, tlen + len + 1);
4434 ptr = SvPVX_const(sv);
4435 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4436 SvCUR_set(sv, SvCUR(sv) + len);
4437 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4442 =for apidoc sv_catpv_mg
4444 Like C<sv_catpv>, but also handles 'set' magic.
4450 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4459 Creates a new SV. A non-zero C<len> parameter indicates the number of
4460 bytes of preallocated string space the SV should have. An extra byte for a
4461 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4462 space is allocated.) The reference count for the new SV is set to 1.
4464 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4465 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4466 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4467 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4468 modules supporting older perls.
4474 Perl_newSV(pTHX_ STRLEN len)
4481 sv_upgrade(sv, SVt_PV);
4482 SvGROW(sv, len + 1);
4487 =for apidoc sv_magicext
4489 Adds magic to an SV, upgrading it if necessary. Applies the
4490 supplied vtable and returns a pointer to the magic added.
4492 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4493 In particular, you can add magic to SvREADONLY SVs, and add more than
4494 one instance of the same 'how'.
4496 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4497 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4498 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4499 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4501 (This is now used as a subroutine by C<sv_magic>.)
4506 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4507 const char* name, I32 namlen)
4512 SvUPGRADE(sv, SVt_PVMG);
4513 Newxz(mg, 1, MAGIC);
4514 mg->mg_moremagic = SvMAGIC(sv);
4515 SvMAGIC_set(sv, mg);
4517 /* Sometimes a magic contains a reference loop, where the sv and
4518 object refer to each other. To prevent a reference loop that
4519 would prevent such objects being freed, we look for such loops
4520 and if we find one we avoid incrementing the object refcount.
4522 Note we cannot do this to avoid self-tie loops as intervening RV must
4523 have its REFCNT incremented to keep it in existence.
4526 if (!obj || obj == sv ||
4527 how == PERL_MAGIC_arylen ||
4528 how == PERL_MAGIC_symtab ||
4529 (SvTYPE(obj) == SVt_PVGV &&
4530 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4531 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4532 GvFORM(obj) == (CV*)sv)))
4537 mg->mg_obj = SvREFCNT_inc_simple(obj);
4538 mg->mg_flags |= MGf_REFCOUNTED;
4541 /* Normal self-ties simply pass a null object, and instead of
4542 using mg_obj directly, use the SvTIED_obj macro to produce a
4543 new RV as needed. For glob "self-ties", we are tieing the PVIO
4544 with an RV obj pointing to the glob containing the PVIO. In
4545 this case, to avoid a reference loop, we need to weaken the
4549 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4550 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4556 mg->mg_len = namlen;
4559 mg->mg_ptr = savepvn(name, namlen);
4560 else if (namlen == HEf_SVKEY)
4561 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4563 mg->mg_ptr = (char *) name;
4565 mg->mg_virtual = (MGVTBL *) vtable;
4569 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4574 =for apidoc sv_magic
4576 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4577 then adds a new magic item of type C<how> to the head of the magic list.
4579 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4580 handling of the C<name> and C<namlen> arguments.
4582 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4583 to add more than one instance of the same 'how'.
4589 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4592 const MGVTBL *vtable;
4595 #ifdef PERL_OLD_COPY_ON_WRITE
4597 sv_force_normal_flags(sv, 0);
4599 if (SvREADONLY(sv)) {
4601 /* its okay to attach magic to shared strings; the subsequent
4602 * upgrade to PVMG will unshare the string */
4603 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4606 && how != PERL_MAGIC_regex_global
4607 && how != PERL_MAGIC_bm
4608 && how != PERL_MAGIC_fm
4609 && how != PERL_MAGIC_sv
4610 && how != PERL_MAGIC_backref
4613 Perl_croak(aTHX_ PL_no_modify);
4616 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4617 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4618 /* sv_magic() refuses to add a magic of the same 'how' as an
4621 if (how == PERL_MAGIC_taint) {
4623 /* Any scalar which already had taint magic on which someone
4624 (erroneously?) did SvIOK_on() or similar will now be
4625 incorrectly sporting public "OK" flags. */
4626 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4634 vtable = &PL_vtbl_sv;
4636 case PERL_MAGIC_overload:
4637 vtable = &PL_vtbl_amagic;
4639 case PERL_MAGIC_overload_elem:
4640 vtable = &PL_vtbl_amagicelem;
4642 case PERL_MAGIC_overload_table:
4643 vtable = &PL_vtbl_ovrld;
4646 vtable = &PL_vtbl_bm;
4648 case PERL_MAGIC_regdata:
4649 vtable = &PL_vtbl_regdata;
4651 case PERL_MAGIC_regdatum:
4652 vtable = &PL_vtbl_regdatum;
4654 case PERL_MAGIC_env:
4655 vtable = &PL_vtbl_env;
4658 vtable = &PL_vtbl_fm;
4660 case PERL_MAGIC_envelem:
4661 vtable = &PL_vtbl_envelem;
4663 case PERL_MAGIC_regex_global:
4664 vtable = &PL_vtbl_mglob;
4666 case PERL_MAGIC_isa:
4667 vtable = &PL_vtbl_isa;
4669 case PERL_MAGIC_isaelem:
4670 vtable = &PL_vtbl_isaelem;
4672 case PERL_MAGIC_nkeys:
4673 vtable = &PL_vtbl_nkeys;
4675 case PERL_MAGIC_dbfile:
4678 case PERL_MAGIC_dbline:
4679 vtable = &PL_vtbl_dbline;
4681 #ifdef USE_LOCALE_COLLATE
4682 case PERL_MAGIC_collxfrm:
4683 vtable = &PL_vtbl_collxfrm;
4685 #endif /* USE_LOCALE_COLLATE */
4686 case PERL_MAGIC_tied:
4687 vtable = &PL_vtbl_pack;
4689 case PERL_MAGIC_tiedelem:
4690 case PERL_MAGIC_tiedscalar:
4691 vtable = &PL_vtbl_packelem;
4694 vtable = &PL_vtbl_regexp;
4696 case PERL_MAGIC_hints:
4697 /* As this vtable is all NULL, we can reuse it. */
4698 case PERL_MAGIC_sig:
4699 vtable = &PL_vtbl_sig;
4701 case PERL_MAGIC_sigelem:
4702 vtable = &PL_vtbl_sigelem;
4704 case PERL_MAGIC_taint:
4705 vtable = &PL_vtbl_taint;
4707 case PERL_MAGIC_uvar:
4708 vtable = &PL_vtbl_uvar;
4710 case PERL_MAGIC_vec:
4711 vtable = &PL_vtbl_vec;
4713 case PERL_MAGIC_arylen_p:
4714 case PERL_MAGIC_rhash:
4715 case PERL_MAGIC_symtab:
4716 case PERL_MAGIC_vstring:
4719 case PERL_MAGIC_utf8:
4720 vtable = &PL_vtbl_utf8;
4722 case PERL_MAGIC_substr:
4723 vtable = &PL_vtbl_substr;
4725 case PERL_MAGIC_defelem:
4726 vtable = &PL_vtbl_defelem;
4728 case PERL_MAGIC_arylen:
4729 vtable = &PL_vtbl_arylen;
4731 case PERL_MAGIC_pos:
4732 vtable = &PL_vtbl_pos;
4734 case PERL_MAGIC_backref:
4735 vtable = &PL_vtbl_backref;
4737 case PERL_MAGIC_hintselem:
4738 vtable = &PL_vtbl_hintselem;
4740 case PERL_MAGIC_ext:
4741 /* Reserved for use by extensions not perl internals. */
4742 /* Useful for attaching extension internal data to perl vars. */
4743 /* Note that multiple extensions may clash if magical scalars */
4744 /* etc holding private data from one are passed to another. */
4748 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4751 /* Rest of work is done else where */
4752 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4755 case PERL_MAGIC_taint:
4758 case PERL_MAGIC_ext:
4759 case PERL_MAGIC_dbfile:
4766 =for apidoc sv_unmagic
4768 Removes all magic of type C<type> from an SV.
4774 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4778 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4780 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4781 for (mg = *mgp; mg; mg = *mgp) {
4782 if (mg->mg_type == type) {
4783 const MGVTBL* const vtbl = mg->mg_virtual;
4784 *mgp = mg->mg_moremagic;
4785 if (vtbl && vtbl->svt_free)
4786 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4787 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4789 Safefree(mg->mg_ptr);
4790 else if (mg->mg_len == HEf_SVKEY)
4791 SvREFCNT_dec((SV*)mg->mg_ptr);
4792 else if (mg->mg_type == PERL_MAGIC_utf8)
4793 Safefree(mg->mg_ptr);
4795 if (mg->mg_flags & MGf_REFCOUNTED)
4796 SvREFCNT_dec(mg->mg_obj);
4800 mgp = &mg->mg_moremagic;
4804 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4805 SvMAGIC_set(sv, NULL);
4812 =for apidoc sv_rvweaken
4814 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4815 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4816 push a back-reference to this RV onto the array of backreferences
4817 associated with that magic. If the RV is magical, set magic will be
4818 called after the RV is cleared.
4824 Perl_sv_rvweaken(pTHX_ SV *sv)
4827 if (!SvOK(sv)) /* let undefs pass */
4830 Perl_croak(aTHX_ "Can't weaken a nonreference");
4831 else if (SvWEAKREF(sv)) {
4832 if (ckWARN(WARN_MISC))
4833 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4837 Perl_sv_add_backref(aTHX_ tsv, sv);
4843 /* Give tsv backref magic if it hasn't already got it, then push a
4844 * back-reference to sv onto the array associated with the backref magic.
4848 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4853 if (SvTYPE(tsv) == SVt_PVHV) {
4854 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4858 /* There is no AV in the offical place - try a fixup. */
4859 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4862 /* Aha. They've got it stowed in magic. Bring it back. */
4863 av = (AV*)mg->mg_obj;
4864 /* Stop mg_free decreasing the refernce count. */
4866 /* Stop mg_free even calling the destructor, given that
4867 there's no AV to free up. */
4869 sv_unmagic(tsv, PERL_MAGIC_backref);
4873 SvREFCNT_inc_simple_void(av);
4878 const MAGIC *const mg
4879 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4881 av = (AV*)mg->mg_obj;
4885 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4886 /* av now has a refcnt of 2, which avoids it getting freed
4887 * before us during global cleanup. The extra ref is removed
4888 * by magic_killbackrefs() when tsv is being freed */
4891 if (AvFILLp(av) >= AvMAX(av)) {
4892 av_extend(av, AvFILLp(av)+1);
4894 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4897 /* delete a back-reference to ourselves from the backref magic associated
4898 * with the SV we point to.
4902 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4909 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4910 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4911 /* We mustn't attempt to "fix up" the hash here by moving the
4912 backreference array back to the hv_aux structure, as that is stored
4913 in the main HvARRAY(), and hfreentries assumes that no-one
4914 reallocates HvARRAY() while it is running. */
4917 const MAGIC *const mg
4918 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4920 av = (AV *)mg->mg_obj;
4923 if (PL_in_clean_all)
4925 Perl_croak(aTHX_ "panic: del_backref");
4932 /* We shouldn't be in here more than once, but for paranoia reasons lets
4934 for (i = AvFILLp(av); i >= 0; i--) {
4936 const SSize_t fill = AvFILLp(av);
4938 /* We weren't the last entry.
4939 An unordered list has this property that you can take the
4940 last element off the end to fill the hole, and it's still
4941 an unordered list :-)
4946 AvFILLp(av) = fill - 1;
4952 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4954 SV **svp = AvARRAY(av);
4956 PERL_UNUSED_ARG(sv);
4958 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4959 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4960 if (svp && !SvIS_FREED(av)) {
4961 SV *const *const last = svp + AvFILLp(av);
4963 while (svp <= last) {
4965 SV *const referrer = *svp;
4966 if (SvWEAKREF(referrer)) {
4967 /* XXX Should we check that it hasn't changed? */
4968 SvRV_set(referrer, 0);
4970 SvWEAKREF_off(referrer);
4971 SvSETMAGIC(referrer);
4972 } else if (SvTYPE(referrer) == SVt_PVGV ||
4973 SvTYPE(referrer) == SVt_PVLV) {
4974 /* You lookin' at me? */
4975 assert(GvSTASH(referrer));
4976 assert(GvSTASH(referrer) == (HV*)sv);
4977 GvSTASH(referrer) = 0;
4980 "panic: magic_killbackrefs (flags=%"UVxf")",
4981 (UV)SvFLAGS(referrer));
4989 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4994 =for apidoc sv_insert
4996 Inserts a string at the specified offset/length within the SV. Similar to
4997 the Perl substr() function.
5003 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5008 register char *midend;
5009 register char *bigend;
5015 Perl_croak(aTHX_ "Can't modify non-existent substring");
5016 SvPV_force(bigstr, curlen);
5017 (void)SvPOK_only_UTF8(bigstr);
5018 if (offset + len > curlen) {
5019 SvGROW(bigstr, offset+len+1);
5020 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5021 SvCUR_set(bigstr, offset+len);
5025 i = littlelen - len;
5026 if (i > 0) { /* string might grow */
5027 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5028 mid = big + offset + len;
5029 midend = bigend = big + SvCUR(bigstr);
5032 while (midend > mid) /* shove everything down */
5033 *--bigend = *--midend;
5034 Move(little,big+offset,littlelen,char);
5035 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5040 Move(little,SvPVX(bigstr)+offset,len,char);
5045 big = SvPVX(bigstr);
5048 bigend = big + SvCUR(bigstr);
5050 if (midend > bigend)
5051 Perl_croak(aTHX_ "panic: sv_insert");
5053 if (mid - big > bigend - midend) { /* faster to shorten from end */
5055 Move(little, mid, littlelen,char);
5058 i = bigend - midend;
5060 Move(midend, mid, i,char);
5064 SvCUR_set(bigstr, mid - big);
5066 else if ((i = mid - big)) { /* faster from front */
5067 midend -= littlelen;
5069 Move(big, midend - i, i, char);
5070 sv_chop(bigstr,midend-i);
5072 Move(little, mid, littlelen,char);
5074 else if (littlelen) {
5075 midend -= littlelen;
5076 sv_chop(bigstr,midend);
5077 Move(little,midend,littlelen,char);
5080 sv_chop(bigstr,midend);
5086 =for apidoc sv_replace
5088 Make the first argument a copy of the second, then delete the original.
5089 The target SV physically takes over ownership of the body of the source SV
5090 and inherits its flags; however, the target keeps any magic it owns,
5091 and any magic in the source is discarded.
5092 Note that this is a rather specialist SV copying operation; most of the
5093 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5099 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5102 const U32 refcnt = SvREFCNT(sv);
5103 SV_CHECK_THINKFIRST_COW_DROP(sv);
5104 if (SvREFCNT(nsv) != 1) {
5105 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5106 UVuf " != 1)", (UV) SvREFCNT(nsv));
5108 if (SvMAGICAL(sv)) {
5112 sv_upgrade(nsv, SVt_PVMG);
5113 SvMAGIC_set(nsv, SvMAGIC(sv));
5114 SvFLAGS(nsv) |= SvMAGICAL(sv);
5116 SvMAGIC_set(sv, NULL);
5120 assert(!SvREFCNT(sv));
5121 #ifdef DEBUG_LEAKING_SCALARS
5122 sv->sv_flags = nsv->sv_flags;
5123 sv->sv_any = nsv->sv_any;
5124 sv->sv_refcnt = nsv->sv_refcnt;
5125 sv->sv_u = nsv->sv_u;
5127 StructCopy(nsv,sv,SV);
5129 if(SvTYPE(sv) == SVt_IV) {
5131 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5135 #ifdef PERL_OLD_COPY_ON_WRITE
5136 if (SvIsCOW_normal(nsv)) {
5137 /* We need to follow the pointers around the loop to make the
5138 previous SV point to sv, rather than nsv. */
5141 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5144 assert(SvPVX_const(current) == SvPVX_const(nsv));
5146 /* Make the SV before us point to the SV after us. */
5148 PerlIO_printf(Perl_debug_log, "previous is\n");
5150 PerlIO_printf(Perl_debug_log,
5151 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5152 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5154 SV_COW_NEXT_SV_SET(current, sv);
5157 SvREFCNT(sv) = refcnt;
5158 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5164 =for apidoc sv_clear
5166 Clear an SV: call any destructors, free up any memory used by the body,
5167 and free the body itself. The SV's head is I<not> freed, although
5168 its type is set to all 1's so that it won't inadvertently be assumed
5169 to be live during global destruction etc.
5170 This function should only be called when REFCNT is zero. Most of the time
5171 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5178 Perl_sv_clear(pTHX_ register SV *sv)
5181 const U32 type = SvTYPE(sv);
5182 const struct body_details *const sv_type_details
5183 = bodies_by_type + type;
5187 assert(SvREFCNT(sv) == 0);
5188 assert(SvTYPE(sv) != SVTYPEMASK);
5190 if (type <= SVt_IV) {
5191 /* See the comment in sv.h about the collusion between this early
5192 return and the overloading of the NULL and IV slots in the size
5195 SV * const target = SvRV(sv);
5197 sv_del_backref(target, sv);
5199 SvREFCNT_dec(target);
5201 SvFLAGS(sv) &= SVf_BREAK;
5202 SvFLAGS(sv) |= SVTYPEMASK;
5207 if (PL_defstash && /* Still have a symbol table? */
5214 stash = SvSTASH(sv);
5215 destructor = StashHANDLER(stash,DESTROY);
5217 SV* const tmpref = newRV(sv);
5218 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5220 PUSHSTACKi(PERLSI_DESTROY);
5225 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5231 if(SvREFCNT(tmpref) < 2) {
5232 /* tmpref is not kept alive! */
5234 SvRV_set(tmpref, NULL);
5237 SvREFCNT_dec(tmpref);
5239 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5243 if (PL_in_clean_objs)
5244 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5246 /* DESTROY gave object new lease on life */
5252 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5253 SvOBJECT_off(sv); /* Curse the object. */
5254 if (type != SVt_PVIO)
5255 --PL_sv_objcount; /* XXX Might want something more general */
5258 if (type >= SVt_PVMG) {
5259 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5260 SvREFCNT_dec(SvOURSTASH(sv));
5261 } else if (SvMAGIC(sv))
5263 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5264 SvREFCNT_dec(SvSTASH(sv));
5267 /* case SVt_BIND: */
5270 IoIFP(sv) != PerlIO_stdin() &&
5271 IoIFP(sv) != PerlIO_stdout() &&
5272 IoIFP(sv) != PerlIO_stderr())
5274 io_close((IO*)sv, FALSE);
5276 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5277 PerlDir_close(IoDIRP(sv));
5278 IoDIRP(sv) = (DIR*)NULL;
5279 Safefree(IoTOP_NAME(sv));
5280 Safefree(IoFMT_NAME(sv));
5281 Safefree(IoBOTTOM_NAME(sv));
5284 /* FIXME for plugins */
5292 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5296 if (PL_comppad == (AV*)sv) {
5303 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5304 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5305 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5306 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5308 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5309 SvREFCNT_dec(LvTARG(sv));
5311 if (isGV_with_GP(sv)) {
5312 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5313 mro_method_changed_in(stash);
5316 unshare_hek(GvNAME_HEK(sv));
5317 /* If we're in a stash, we don't own a reference to it. However it does
5318 have a back reference to us, which needs to be cleared. */
5319 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5320 sv_del_backref((SV*)stash, sv);
5322 /* FIXME. There are probably more unreferenced pointers to SVs in the
5323 interpreter struct that we should check and tidy in a similar
5325 if ((GV*)sv == PL_last_in_gv)
5326 PL_last_in_gv = NULL;
5332 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5334 SvPV_set(sv, SvPVX_mutable(sv) - sv_read_offset(sv));
5335 /* Don't even bother with turning off the OOK flag. */
5338 SV * const target = SvRV(sv);
5340 sv_del_backref(target, sv);
5342 SvREFCNT_dec(target);
5344 #ifdef PERL_OLD_COPY_ON_WRITE
5345 else if (SvPVX_const(sv)) {
5347 /* I believe I need to grab the global SV mutex here and
5348 then recheck the COW status. */
5350 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5354 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5356 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5359 /* And drop it here. */
5361 } else if (SvLEN(sv)) {
5362 Safefree(SvPVX_const(sv));
5366 else if (SvPVX_const(sv) && SvLEN(sv))
5367 Safefree(SvPVX_mutable(sv));
5368 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5369 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5378 SvFLAGS(sv) &= SVf_BREAK;
5379 SvFLAGS(sv) |= SVTYPEMASK;
5381 if (sv_type_details->arena) {
5382 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5383 &PL_body_roots[type]);
5385 else if (sv_type_details->body_size) {
5386 my_safefree(SvANY(sv));
5391 =for apidoc sv_newref
5393 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5400 Perl_sv_newref(pTHX_ SV *sv)
5402 PERL_UNUSED_CONTEXT;
5411 Decrement an SV's reference count, and if it drops to zero, call
5412 C<sv_clear> to invoke destructors and free up any memory used by
5413 the body; finally, deallocate the SV's head itself.
5414 Normally called via a wrapper macro C<SvREFCNT_dec>.
5420 Perl_sv_free(pTHX_ SV *sv)
5425 if (SvREFCNT(sv) == 0) {
5426 if (SvFLAGS(sv) & SVf_BREAK)
5427 /* this SV's refcnt has been artificially decremented to
5428 * trigger cleanup */
5430 if (PL_in_clean_all) /* All is fair */
5432 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5433 /* make sure SvREFCNT(sv)==0 happens very seldom */
5434 SvREFCNT(sv) = (~(U32)0)/2;
5437 if (ckWARN_d(WARN_INTERNAL)) {
5438 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5439 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5440 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5441 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5442 Perl_dump_sv_child(aTHX_ sv);
5444 #ifdef DEBUG_LEAKING_SCALARS
5451 if (--(SvREFCNT(sv)) > 0)
5453 Perl_sv_free2(aTHX_ sv);
5457 Perl_sv_free2(pTHX_ SV *sv)
5462 if (ckWARN_d(WARN_DEBUGGING))
5463 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5464 "Attempt to free temp prematurely: SV 0x%"UVxf
5465 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5469 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5470 /* make sure SvREFCNT(sv)==0 happens very seldom */
5471 SvREFCNT(sv) = (~(U32)0)/2;
5482 Returns the length of the string in the SV. Handles magic and type
5483 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5489 Perl_sv_len(pTHX_ register SV *sv)
5497 len = mg_length(sv);
5499 (void)SvPV_const(sv, len);
5504 =for apidoc sv_len_utf8
5506 Returns the number of characters in the string in an SV, counting wide
5507 UTF-8 bytes as a single character. Handles magic and type coercion.
5513 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5514 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5515 * (Note that the mg_len is not the length of the mg_ptr field.
5516 * This allows the cache to store the character length of the string without
5517 * needing to malloc() extra storage to attach to the mg_ptr.)
5522 Perl_sv_len_utf8(pTHX_ register SV *sv)
5528 return mg_length(sv);
5532 const U8 *s = (U8*)SvPV_const(sv, len);
5536 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5538 if (mg && mg->mg_len != -1) {
5540 if (PL_utf8cache < 0) {
5541 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5543 /* Need to turn the assertions off otherwise we may
5544 recurse infinitely while printing error messages.
5546 SAVEI8(PL_utf8cache);
5548 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5549 " real %"UVuf" for %"SVf,
5550 (UV) ulen, (UV) real, SVfARG(sv));
5555 ulen = Perl_utf8_length(aTHX_ s, s + len);
5556 if (!SvREADONLY(sv)) {
5558 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5559 &PL_vtbl_utf8, 0, 0);
5567 return Perl_utf8_length(aTHX_ s, s + len);
5571 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5574 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5577 const U8 *s = start;
5579 while (s < send && uoffset--)
5582 /* This is the existing behaviour. Possibly it should be a croak, as
5583 it's actually a bounds error */
5589 /* Given the length of the string in both bytes and UTF-8 characters, decide
5590 whether to walk forwards or backwards to find the byte corresponding to
5591 the passed in UTF-8 offset. */
5593 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5594 STRLEN uoffset, STRLEN uend)
5596 STRLEN backw = uend - uoffset;
5597 if (uoffset < 2 * backw) {
5598 /* The assumption is that going forwards is twice the speed of going
5599 forward (that's where the 2 * backw comes from).
5600 (The real figure of course depends on the UTF-8 data.) */
5601 return sv_pos_u2b_forwards(start, send, uoffset);
5606 while (UTF8_IS_CONTINUATION(*send))
5609 return send - start;
5612 /* For the string representation of the given scalar, find the byte
5613 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5614 give another position in the string, *before* the sought offset, which
5615 (which is always true, as 0, 0 is a valid pair of positions), which should
5616 help reduce the amount of linear searching.
5617 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5618 will be used to reduce the amount of linear searching. The cache will be
5619 created if necessary, and the found value offered to it for update. */
5621 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5622 const U8 *const send, STRLEN uoffset,
5623 STRLEN uoffset0, STRLEN boffset0) {
5624 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5627 assert (uoffset >= uoffset0);
5629 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5630 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5631 if ((*mgp)->mg_ptr) {
5632 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5633 if (cache[0] == uoffset) {
5634 /* An exact match. */
5637 if (cache[2] == uoffset) {
5638 /* An exact match. */
5642 if (cache[0] < uoffset) {
5643 /* The cache already knows part of the way. */
5644 if (cache[0] > uoffset0) {
5645 /* The cache knows more than the passed in pair */
5646 uoffset0 = cache[0];
5647 boffset0 = cache[1];
5649 if ((*mgp)->mg_len != -1) {
5650 /* And we know the end too. */
5652 + sv_pos_u2b_midway(start + boffset0, send,
5654 (*mgp)->mg_len - uoffset0);
5657 + sv_pos_u2b_forwards(start + boffset0,
5658 send, uoffset - uoffset0);
5661 else if (cache[2] < uoffset) {
5662 /* We're between the two cache entries. */
5663 if (cache[2] > uoffset0) {
5664 /* and the cache knows more than the passed in pair */
5665 uoffset0 = cache[2];
5666 boffset0 = cache[3];
5670 + sv_pos_u2b_midway(start + boffset0,
5673 cache[0] - uoffset0);
5676 + sv_pos_u2b_midway(start + boffset0,
5679 cache[2] - uoffset0);
5683 else if ((*mgp)->mg_len != -1) {
5684 /* If we can take advantage of a passed in offset, do so. */
5685 /* In fact, offset0 is either 0, or less than offset, so don't
5686 need to worry about the other possibility. */
5688 + sv_pos_u2b_midway(start + boffset0, send,
5690 (*mgp)->mg_len - uoffset0);
5695 if (!found || PL_utf8cache < 0) {
5696 const STRLEN real_boffset
5697 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5698 send, uoffset - uoffset0);
5700 if (found && PL_utf8cache < 0) {
5701 if (real_boffset != boffset) {
5702 /* Need to turn the assertions off otherwise we may recurse
5703 infinitely while printing error messages. */
5704 SAVEI8(PL_utf8cache);
5706 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5707 " real %"UVuf" for %"SVf,
5708 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5711 boffset = real_boffset;
5714 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5720 =for apidoc sv_pos_u2b
5722 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5723 the start of the string, to a count of the equivalent number of bytes; if
5724 lenp is non-zero, it does the same to lenp, but this time starting from
5725 the offset, rather than from the start of the string. Handles magic and
5732 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5733 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5734 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5739 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5747 start = (U8*)SvPV_const(sv, len);
5749 STRLEN uoffset = (STRLEN) *offsetp;
5750 const U8 * const send = start + len;
5752 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5755 *offsetp = (I32) boffset;
5758 /* Convert the relative offset to absolute. */
5759 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5760 const STRLEN boffset2
5761 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5762 uoffset, boffset) - boffset;
5776 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5777 byte length pairing. The (byte) length of the total SV is passed in too,
5778 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5779 may not have updated SvCUR, so we can't rely on reading it directly.
5781 The proffered utf8/byte length pairing isn't used if the cache already has
5782 two pairs, and swapping either for the proffered pair would increase the
5783 RMS of the intervals between known byte offsets.
5785 The cache itself consists of 4 STRLEN values
5786 0: larger UTF-8 offset
5787 1: corresponding byte offset
5788 2: smaller UTF-8 offset
5789 3: corresponding byte offset
5791 Unused cache pairs have the value 0, 0.
5792 Keeping the cache "backwards" means that the invariant of
5793 cache[0] >= cache[2] is maintained even with empty slots, which means that
5794 the code that uses it doesn't need to worry if only 1 entry has actually
5795 been set to non-zero. It also makes the "position beyond the end of the
5796 cache" logic much simpler, as the first slot is always the one to start
5800 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5808 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5810 (*mgp)->mg_len = -1;
5814 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5815 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5816 (*mgp)->mg_ptr = (char *) cache;
5820 if (PL_utf8cache < 0) {
5821 const U8 *start = (const U8 *) SvPVX_const(sv);
5822 const STRLEN realutf8 = utf8_length(start, start + byte);
5824 if (realutf8 != utf8) {
5825 /* Need to turn the assertions off otherwise we may recurse
5826 infinitely while printing error messages. */
5827 SAVEI8(PL_utf8cache);
5829 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5830 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5834 /* Cache is held with the later position first, to simplify the code
5835 that deals with unbounded ends. */
5837 ASSERT_UTF8_CACHE(cache);
5838 if (cache[1] == 0) {
5839 /* Cache is totally empty */
5842 } else if (cache[3] == 0) {
5843 if (byte > cache[1]) {
5844 /* New one is larger, so goes first. */
5845 cache[2] = cache[0];
5846 cache[3] = cache[1];
5854 #define THREEWAY_SQUARE(a,b,c,d) \
5855 ((float)((d) - (c))) * ((float)((d) - (c))) \
5856 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5857 + ((float)((b) - (a))) * ((float)((b) - (a)))
5859 /* Cache has 2 slots in use, and we know three potential pairs.
5860 Keep the two that give the lowest RMS distance. Do the
5861 calcualation in bytes simply because we always know the byte
5862 length. squareroot has the same ordering as the positive value,
5863 so don't bother with the actual square root. */
5864 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5865 if (byte > cache[1]) {
5866 /* New position is after the existing pair of pairs. */
5867 const float keep_earlier
5868 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5869 const float keep_later
5870 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5872 if (keep_later < keep_earlier) {
5873 if (keep_later < existing) {
5874 cache[2] = cache[0];
5875 cache[3] = cache[1];
5881 if (keep_earlier < existing) {
5887 else if (byte > cache[3]) {
5888 /* New position is between the existing pair of pairs. */
5889 const float keep_earlier
5890 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5891 const float keep_later
5892 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5894 if (keep_later < keep_earlier) {
5895 if (keep_later < existing) {
5901 if (keep_earlier < existing) {
5908 /* New position is before the existing pair of pairs. */
5909 const float keep_earlier
5910 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5911 const float keep_later
5912 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5914 if (keep_later < keep_earlier) {
5915 if (keep_later < existing) {
5921 if (keep_earlier < existing) {
5922 cache[0] = cache[2];
5923 cache[1] = cache[3];
5930 ASSERT_UTF8_CACHE(cache);
5933 /* We already know all of the way, now we may be able to walk back. The same
5934 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5935 backward is half the speed of walking forward. */
5937 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5940 const STRLEN forw = target - s;
5941 STRLEN backw = end - target;
5943 if (forw < 2 * backw) {
5944 return utf8_length(s, target);
5947 while (end > target) {
5949 while (UTF8_IS_CONTINUATION(*end)) {
5958 =for apidoc sv_pos_b2u
5960 Converts the value pointed to by offsetp from a count of bytes from the
5961 start of the string, to a count of the equivalent number of UTF-8 chars.
5962 Handles magic and type coercion.
5968 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5969 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5974 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5977 const STRLEN byte = *offsetp;
5978 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5987 s = (const U8*)SvPV_const(sv, blen);
5990 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5994 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5995 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5997 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5998 if (cache[1] == byte) {
5999 /* An exact match. */
6000 *offsetp = cache[0];
6003 if (cache[3] == byte) {
6004 /* An exact match. */
6005 *offsetp = cache[2];
6009 if (cache[1] < byte) {
6010 /* We already know part of the way. */
6011 if (mg->mg_len != -1) {
6012 /* Actually, we know the end too. */
6014 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6015 s + blen, mg->mg_len - cache[0]);
6017 len = cache[0] + utf8_length(s + cache[1], send);
6020 else if (cache[3] < byte) {
6021 /* We're between the two cached pairs, so we do the calculation
6022 offset by the byte/utf-8 positions for the earlier pair,
6023 then add the utf-8 characters from the string start to
6025 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6026 s + cache[1], cache[0] - cache[2])
6030 else { /* cache[3] > byte */
6031 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6035 ASSERT_UTF8_CACHE(cache);
6037 } else if (mg->mg_len != -1) {
6038 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6042 if (!found || PL_utf8cache < 0) {
6043 const STRLEN real_len = utf8_length(s, send);
6045 if (found && PL_utf8cache < 0) {
6046 if (len != real_len) {
6047 /* Need to turn the assertions off otherwise we may recurse
6048 infinitely while printing error messages. */
6049 SAVEI8(PL_utf8cache);
6051 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6052 " real %"UVuf" for %"SVf,
6053 (UV) len, (UV) real_len, SVfARG(sv));
6060 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6066 Returns a boolean indicating whether the strings in the two SVs are
6067 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6068 coerce its args to strings if necessary.
6074 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6083 SV* svrecode = NULL;
6090 /* if pv1 and pv2 are the same, second SvPV_const call may
6091 * invalidate pv1, so we may need to make a copy */
6092 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6093 pv1 = SvPV_const(sv1, cur1);
6094 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6096 pv1 = SvPV_const(sv1, cur1);
6104 pv2 = SvPV_const(sv2, cur2);
6106 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6107 /* Differing utf8ness.
6108 * Do not UTF8size the comparands as a side-effect. */
6111 svrecode = newSVpvn(pv2, cur2);
6112 sv_recode_to_utf8(svrecode, PL_encoding);
6113 pv2 = SvPV_const(svrecode, cur2);
6116 svrecode = newSVpvn(pv1, cur1);
6117 sv_recode_to_utf8(svrecode, PL_encoding);
6118 pv1 = SvPV_const(svrecode, cur1);
6120 /* Now both are in UTF-8. */
6122 SvREFCNT_dec(svrecode);
6127 bool is_utf8 = TRUE;
6130 /* sv1 is the UTF-8 one,
6131 * if is equal it must be downgrade-able */
6132 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6138 /* sv2 is the UTF-8 one,
6139 * if is equal it must be downgrade-able */
6140 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6146 /* Downgrade not possible - cannot be eq */
6154 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6156 SvREFCNT_dec(svrecode);
6166 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6167 string in C<sv1> is less than, equal to, or greater than the string in
6168 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6169 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6175 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6179 const char *pv1, *pv2;
6182 SV *svrecode = NULL;
6189 pv1 = SvPV_const(sv1, cur1);
6196 pv2 = SvPV_const(sv2, cur2);
6198 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6199 /* Differing utf8ness.
6200 * Do not UTF8size the comparands as a side-effect. */
6203 svrecode = newSVpvn(pv2, cur2);
6204 sv_recode_to_utf8(svrecode, PL_encoding);
6205 pv2 = SvPV_const(svrecode, cur2);
6208 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6213 svrecode = newSVpvn(pv1, cur1);
6214 sv_recode_to_utf8(svrecode, PL_encoding);
6215 pv1 = SvPV_const(svrecode, cur1);
6218 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6224 cmp = cur2 ? -1 : 0;
6228 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6231 cmp = retval < 0 ? -1 : 1;
6232 } else if (cur1 == cur2) {
6235 cmp = cur1 < cur2 ? -1 : 1;
6239 SvREFCNT_dec(svrecode);
6247 =for apidoc sv_cmp_locale
6249 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6250 'use bytes' aware, handles get magic, and will coerce its args to strings
6251 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6257 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6260 #ifdef USE_LOCALE_COLLATE
6266 if (PL_collation_standard)
6270 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6272 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6274 if (!pv1 || !len1) {
6285 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6288 return retval < 0 ? -1 : 1;
6291 * When the result of collation is equality, that doesn't mean
6292 * that there are no differences -- some locales exclude some
6293 * characters from consideration. So to avoid false equalities,
6294 * we use the raw string as a tiebreaker.
6300 #endif /* USE_LOCALE_COLLATE */
6302 return sv_cmp(sv1, sv2);
6306 #ifdef USE_LOCALE_COLLATE
6309 =for apidoc sv_collxfrm
6311 Add Collate Transform magic to an SV if it doesn't already have it.
6313 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6314 scalar data of the variable, but transformed to such a format that a normal
6315 memory comparison can be used to compare the data according to the locale
6322 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6327 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6328 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6334 Safefree(mg->mg_ptr);
6335 s = SvPV_const(sv, len);
6336 if ((xf = mem_collxfrm(s, len, &xlen))) {
6337 if (SvREADONLY(sv)) {
6340 return xf + sizeof(PL_collation_ix);
6343 #ifdef PERL_OLD_COPY_ON_WRITE
6345 sv_force_normal_flags(sv, 0);
6347 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6361 if (mg && mg->mg_ptr) {
6363 return mg->mg_ptr + sizeof(PL_collation_ix);
6371 #endif /* USE_LOCALE_COLLATE */
6376 Get a line from the filehandle and store it into the SV, optionally
6377 appending to the currently-stored string.
6383 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6388 register STDCHAR rslast;
6389 register STDCHAR *bp;
6394 if (SvTHINKFIRST(sv))
6395 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6396 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6398 However, perlbench says it's slower, because the existing swipe code
6399 is faster than copy on write.
6400 Swings and roundabouts. */
6401 SvUPGRADE(sv, SVt_PV);
6406 if (PerlIO_isutf8(fp)) {
6408 sv_utf8_upgrade_nomg(sv);
6409 sv_pos_u2b(sv,&append,0);
6411 } else if (SvUTF8(sv)) {
6412 SV * const tsv = newSV(0);
6413 sv_gets(tsv, fp, 0);
6414 sv_utf8_upgrade_nomg(tsv);
6415 SvCUR_set(sv,append);
6418 goto return_string_or_null;
6423 if (PerlIO_isutf8(fp))
6426 if (IN_PERL_COMPILETIME) {
6427 /* we always read code in line mode */
6431 else if (RsSNARF(PL_rs)) {
6432 /* If it is a regular disk file use size from stat() as estimate
6433 of amount we are going to read -- may result in mallocing
6434 more memory than we really need if the layers below reduce
6435 the size we read (e.g. CRLF or a gzip layer).
6438 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6439 const Off_t offset = PerlIO_tell(fp);
6440 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6441 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6447 else if (RsRECORD(PL_rs)) {
6452 /* Grab the size of the record we're getting */
6453 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6454 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6457 /* VMS wants read instead of fread, because fread doesn't respect */
6458 /* RMS record boundaries. This is not necessarily a good thing to be */
6459 /* doing, but we've got no other real choice - except avoid stdio
6460 as implementation - perhaps write a :vms layer ?
6462 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6464 bytesread = PerlIO_read(fp, buffer, recsize);
6468 SvCUR_set(sv, bytesread += append);
6469 buffer[bytesread] = '\0';
6470 goto return_string_or_null;
6472 else if (RsPARA(PL_rs)) {
6478 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6479 if (PerlIO_isutf8(fp)) {
6480 rsptr = SvPVutf8(PL_rs, rslen);
6483 if (SvUTF8(PL_rs)) {
6484 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6485 Perl_croak(aTHX_ "Wide character in $/");
6488 rsptr = SvPV_const(PL_rs, rslen);
6492 rslast = rslen ? rsptr[rslen - 1] : '\0';
6494 if (rspara) { /* have to do this both before and after */
6495 do { /* to make sure file boundaries work right */
6498 i = PerlIO_getc(fp);
6502 PerlIO_ungetc(fp,i);
6508 /* See if we know enough about I/O mechanism to cheat it ! */
6510 /* This used to be #ifdef test - it is made run-time test for ease
6511 of abstracting out stdio interface. One call should be cheap
6512 enough here - and may even be a macro allowing compile
6516 if (PerlIO_fast_gets(fp)) {
6519 * We're going to steal some values from the stdio struct
6520 * and put EVERYTHING in the innermost loop into registers.
6522 register STDCHAR *ptr;
6526 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6527 /* An ungetc()d char is handled separately from the regular
6528 * buffer, so we getc() it back out and stuff it in the buffer.
6530 i = PerlIO_getc(fp);
6531 if (i == EOF) return 0;
6532 *(--((*fp)->_ptr)) = (unsigned char) i;
6536 /* Here is some breathtakingly efficient cheating */
6538 cnt = PerlIO_get_cnt(fp); /* get count into register */
6539 /* make sure we have the room */
6540 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6541 /* Not room for all of it
6542 if we are looking for a separator and room for some
6544 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6545 /* just process what we have room for */
6546 shortbuffered = cnt - SvLEN(sv) + append + 1;
6547 cnt -= shortbuffered;
6551 /* remember that cnt can be negative */
6552 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6557 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6558 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6559 DEBUG_P(PerlIO_printf(Perl_debug_log,
6560 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6561 DEBUG_P(PerlIO_printf(Perl_debug_log,
6562 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6563 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6564 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6569 while (cnt > 0) { /* this | eat */
6571 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6572 goto thats_all_folks; /* screams | sed :-) */
6576 Copy(ptr, bp, cnt, char); /* this | eat */
6577 bp += cnt; /* screams | dust */
6578 ptr += cnt; /* louder | sed :-) */
6583 if (shortbuffered) { /* oh well, must extend */
6584 cnt = shortbuffered;
6586 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6588 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6589 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6593 DEBUG_P(PerlIO_printf(Perl_debug_log,
6594 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6595 PTR2UV(ptr),(long)cnt));
6596 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6598 DEBUG_P(PerlIO_printf(Perl_debug_log,
6599 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6600 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6601 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6603 /* This used to call 'filbuf' in stdio form, but as that behaves like
6604 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6605 another abstraction. */
6606 i = PerlIO_getc(fp); /* get more characters */
6608 DEBUG_P(PerlIO_printf(Perl_debug_log,
6609 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6610 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6611 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6613 cnt = PerlIO_get_cnt(fp);
6614 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6615 DEBUG_P(PerlIO_printf(Perl_debug_log,
6616 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6618 if (i == EOF) /* all done for ever? */
6619 goto thats_really_all_folks;
6621 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6623 SvGROW(sv, bpx + cnt + 2);
6624 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6626 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6628 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6629 goto thats_all_folks;
6633 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6634 memNE((char*)bp - rslen, rsptr, rslen))
6635 goto screamer; /* go back to the fray */
6636 thats_really_all_folks:
6638 cnt += shortbuffered;
6639 DEBUG_P(PerlIO_printf(Perl_debug_log,
6640 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6641 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6642 DEBUG_P(PerlIO_printf(Perl_debug_log,
6643 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6644 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6645 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6647 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6648 DEBUG_P(PerlIO_printf(Perl_debug_log,
6649 "Screamer: done, len=%ld, string=|%.*s|\n",
6650 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6654 /*The big, slow, and stupid way. */
6655 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6656 STDCHAR *buf = NULL;
6657 Newx(buf, 8192, STDCHAR);
6665 register const STDCHAR * const bpe = buf + sizeof(buf);
6667 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6668 ; /* keep reading */
6672 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6673 /* Accomodate broken VAXC compiler, which applies U8 cast to
6674 * both args of ?: operator, causing EOF to change into 255
6677 i = (U8)buf[cnt - 1];
6683 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6685 sv_catpvn(sv, (char *) buf, cnt);
6687 sv_setpvn(sv, (char *) buf, cnt);
6689 if (i != EOF && /* joy */
6691 SvCUR(sv) < rslen ||
6692 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6696 * If we're reading from a TTY and we get a short read,
6697 * indicating that the user hit his EOF character, we need
6698 * to notice it now, because if we try to read from the TTY
6699 * again, the EOF condition will disappear.
6701 * The comparison of cnt to sizeof(buf) is an optimization
6702 * that prevents unnecessary calls to feof().
6706 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6710 #ifdef USE_HEAP_INSTEAD_OF_STACK
6715 if (rspara) { /* have to do this both before and after */
6716 while (i != EOF) { /* to make sure file boundaries work right */
6717 i = PerlIO_getc(fp);
6719 PerlIO_ungetc(fp,i);
6725 return_string_or_null:
6726 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6732 Auto-increment of the value in the SV, doing string to numeric conversion
6733 if necessary. Handles 'get' magic.
6739 Perl_sv_inc(pTHX_ register SV *sv)
6748 if (SvTHINKFIRST(sv)) {
6750 sv_force_normal_flags(sv, 0);
6751 if (SvREADONLY(sv)) {
6752 if (IN_PERL_RUNTIME)
6753 Perl_croak(aTHX_ PL_no_modify);
6757 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6759 i = PTR2IV(SvRV(sv));
6764 flags = SvFLAGS(sv);
6765 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6766 /* It's (privately or publicly) a float, but not tested as an
6767 integer, so test it to see. */
6769 flags = SvFLAGS(sv);
6771 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6772 /* It's publicly an integer, or privately an integer-not-float */
6773 #ifdef PERL_PRESERVE_IVUV
6777 if (SvUVX(sv) == UV_MAX)
6778 sv_setnv(sv, UV_MAX_P1);
6780 (void)SvIOK_only_UV(sv);
6781 SvUV_set(sv, SvUVX(sv) + 1);
6783 if (SvIVX(sv) == IV_MAX)
6784 sv_setuv(sv, (UV)IV_MAX + 1);
6786 (void)SvIOK_only(sv);
6787 SvIV_set(sv, SvIVX(sv) + 1);
6792 if (flags & SVp_NOK) {
6793 (void)SvNOK_only(sv);
6794 SvNV_set(sv, SvNVX(sv) + 1.0);
6798 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6799 if ((flags & SVTYPEMASK) < SVt_PVIV)
6800 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6801 (void)SvIOK_only(sv);
6806 while (isALPHA(*d)) d++;
6807 while (isDIGIT(*d)) d++;
6809 #ifdef PERL_PRESERVE_IVUV
6810 /* Got to punt this as an integer if needs be, but we don't issue
6811 warnings. Probably ought to make the sv_iv_please() that does
6812 the conversion if possible, and silently. */
6813 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6814 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6815 /* Need to try really hard to see if it's an integer.
6816 9.22337203685478e+18 is an integer.
6817 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6818 so $a="9.22337203685478e+18"; $a+0; $a++
6819 needs to be the same as $a="9.22337203685478e+18"; $a++
6826 /* sv_2iv *should* have made this an NV */
6827 if (flags & SVp_NOK) {
6828 (void)SvNOK_only(sv);
6829 SvNV_set(sv, SvNVX(sv) + 1.0);
6832 /* I don't think we can get here. Maybe I should assert this
6833 And if we do get here I suspect that sv_setnv will croak. NWC
6835 #if defined(USE_LONG_DOUBLE)
6836 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",
6837 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6839 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6840 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6843 #endif /* PERL_PRESERVE_IVUV */
6844 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6848 while (d >= SvPVX_const(sv)) {
6856 /* MKS: The original code here died if letters weren't consecutive.
6857 * at least it didn't have to worry about non-C locales. The
6858 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6859 * arranged in order (although not consecutively) and that only
6860 * [A-Za-z] are accepted by isALPHA in the C locale.
6862 if (*d != 'z' && *d != 'Z') {
6863 do { ++*d; } while (!isALPHA(*d));
6866 *(d--) -= 'z' - 'a';
6871 *(d--) -= 'z' - 'a' + 1;
6875 /* oh,oh, the number grew */
6876 SvGROW(sv, SvCUR(sv) + 2);
6877 SvCUR_set(sv, SvCUR(sv) + 1);
6878 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6889 Auto-decrement of the value in the SV, doing string to numeric conversion
6890 if necessary. Handles 'get' magic.
6896 Perl_sv_dec(pTHX_ register SV *sv)
6904 if (SvTHINKFIRST(sv)) {
6906 sv_force_normal_flags(sv, 0);
6907 if (SvREADONLY(sv)) {
6908 if (IN_PERL_RUNTIME)
6909 Perl_croak(aTHX_ PL_no_modify);
6913 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6915 i = PTR2IV(SvRV(sv));
6920 /* Unlike sv_inc we don't have to worry about string-never-numbers
6921 and keeping them magic. But we mustn't warn on punting */
6922 flags = SvFLAGS(sv);
6923 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6924 /* It's publicly an integer, or privately an integer-not-float */
6925 #ifdef PERL_PRESERVE_IVUV
6929 if (SvUVX(sv) == 0) {
6930 (void)SvIOK_only(sv);
6934 (void)SvIOK_only_UV(sv);
6935 SvUV_set(sv, SvUVX(sv) - 1);
6938 if (SvIVX(sv) == IV_MIN)
6939 sv_setnv(sv, (NV)IV_MIN - 1.0);
6941 (void)SvIOK_only(sv);
6942 SvIV_set(sv, SvIVX(sv) - 1);
6947 if (flags & SVp_NOK) {
6948 SvNV_set(sv, SvNVX(sv) - 1.0);
6949 (void)SvNOK_only(sv);
6952 if (!(flags & SVp_POK)) {
6953 if ((flags & SVTYPEMASK) < SVt_PVIV)
6954 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6956 (void)SvIOK_only(sv);
6959 #ifdef PERL_PRESERVE_IVUV
6961 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6962 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6963 /* Need to try really hard to see if it's an integer.
6964 9.22337203685478e+18 is an integer.
6965 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6966 so $a="9.22337203685478e+18"; $a+0; $a--
6967 needs to be the same as $a="9.22337203685478e+18"; $a--
6974 /* sv_2iv *should* have made this an NV */
6975 if (flags & SVp_NOK) {
6976 (void)SvNOK_only(sv);
6977 SvNV_set(sv, SvNVX(sv) - 1.0);
6980 /* I don't think we can get here. Maybe I should assert this
6981 And if we do get here I suspect that sv_setnv will croak. NWC
6983 #if defined(USE_LONG_DOUBLE)
6984 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",
6985 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6987 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6988 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6992 #endif /* PERL_PRESERVE_IVUV */
6993 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6997 =for apidoc sv_mortalcopy
6999 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7000 The new SV is marked as mortal. It will be destroyed "soon", either by an
7001 explicit call to FREETMPS, or by an implicit call at places such as
7002 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7007 /* Make a string that will exist for the duration of the expression
7008 * evaluation. Actually, it may have to last longer than that, but
7009 * hopefully we won't free it until it has been assigned to a
7010 * permanent location. */
7013 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7019 sv_setsv(sv,oldstr);
7021 PL_tmps_stack[++PL_tmps_ix] = sv;
7027 =for apidoc sv_newmortal
7029 Creates a new null SV which is mortal. The reference count of the SV is
7030 set to 1. It will be destroyed "soon", either by an explicit call to
7031 FREETMPS, or by an implicit call at places such as statement boundaries.
7032 See also C<sv_mortalcopy> and C<sv_2mortal>.
7038 Perl_sv_newmortal(pTHX)
7044 SvFLAGS(sv) = SVs_TEMP;
7046 PL_tmps_stack[++PL_tmps_ix] = sv;
7052 =for apidoc newSVpvn_flags
7054 Creates a new SV and copies a string into it. The reference count for the
7055 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7056 string. You are responsible for ensuring that the source string is at least
7057 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7058 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7059 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7060 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7061 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7063 #define newSVpvn_utf8(s, len, u) \
7064 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7070 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7075 /* All the flags we don't support must be zero.
7076 And we're new code so I'm going to assert this from the start. */
7077 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7079 sv_setpvn(sv,s,len);
7080 SvFLAGS(sv) |= (flags & SVf_UTF8);
7081 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7085 =for apidoc sv_2mortal
7087 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7088 by an explicit call to FREETMPS, or by an implicit call at places such as
7089 statement boundaries. SvTEMP() is turned on which means that the SV's
7090 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7091 and C<sv_mortalcopy>.
7097 Perl_sv_2mortal(pTHX_ register SV *sv)
7102 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7105 PL_tmps_stack[++PL_tmps_ix] = sv;
7113 Creates a new SV and copies a string into it. The reference count for the
7114 SV is set to 1. If C<len> is zero, Perl will compute the length using
7115 strlen(). For efficiency, consider using C<newSVpvn> instead.
7121 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7127 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7132 =for apidoc newSVpvn
7134 Creates a new SV and copies a string into it. The reference count for the
7135 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7136 string. You are responsible for ensuring that the source string is at least
7137 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7143 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7149 sv_setpvn(sv,s,len);
7154 =for apidoc newSVhek
7156 Creates a new SV from the hash key structure. It will generate scalars that
7157 point to the shared string table where possible. Returns a new (undefined)
7158 SV if the hek is NULL.
7164 Perl_newSVhek(pTHX_ const HEK *hek)
7174 if (HEK_LEN(hek) == HEf_SVKEY) {
7175 return newSVsv(*(SV**)HEK_KEY(hek));
7177 const int flags = HEK_FLAGS(hek);
7178 if (flags & HVhek_WASUTF8) {
7180 Andreas would like keys he put in as utf8 to come back as utf8
7182 STRLEN utf8_len = HEK_LEN(hek);
7183 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7184 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7187 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7189 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7190 /* We don't have a pointer to the hv, so we have to replicate the
7191 flag into every HEK. This hv is using custom a hasing
7192 algorithm. Hence we can't return a shared string scalar, as
7193 that would contain the (wrong) hash value, and might get passed
7194 into an hv routine with a regular hash.
7195 Similarly, a hash that isn't using shared hash keys has to have
7196 the flag in every key so that we know not to try to call
7197 share_hek_kek on it. */
7199 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7204 /* This will be overwhelminly the most common case. */
7206 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7207 more efficient than sharepvn(). */
7211 sv_upgrade(sv, SVt_PV);
7212 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7213 SvCUR_set(sv, HEK_LEN(hek));
7226 =for apidoc newSVpvn_share
7228 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7229 table. If the string does not already exist in the table, it is created
7230 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7231 value is used; otherwise the hash is computed. The string's hash can be later
7232 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7233 that as the string table is used for shared hash keys these strings will have
7234 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7240 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7244 bool is_utf8 = FALSE;
7245 const char *const orig_src = src;
7248 STRLEN tmplen = -len;
7250 /* See the note in hv.c:hv_fetch() --jhi */
7251 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7255 PERL_HASH(hash, src, len);
7257 sv_upgrade(sv, SVt_PV);
7258 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7266 if (src != orig_src)
7272 #if defined(PERL_IMPLICIT_CONTEXT)
7274 /* pTHX_ magic can't cope with varargs, so this is a no-context
7275 * version of the main function, (which may itself be aliased to us).
7276 * Don't access this version directly.
7280 Perl_newSVpvf_nocontext(const char* pat, ...)
7285 va_start(args, pat);
7286 sv = vnewSVpvf(pat, &args);
7293 =for apidoc newSVpvf
7295 Creates a new SV and initializes it with the string formatted like
7302 Perl_newSVpvf(pTHX_ const char* pat, ...)
7306 va_start(args, pat);
7307 sv = vnewSVpvf(pat, &args);
7312 /* backend for newSVpvf() and newSVpvf_nocontext() */
7315 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7320 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7327 Creates a new SV and copies a floating point value into it.
7328 The reference count for the SV is set to 1.
7334 Perl_newSVnv(pTHX_ NV n)
7347 Creates a new SV and copies an integer into it. The reference count for the
7354 Perl_newSViv(pTHX_ IV i)
7367 Creates a new SV and copies an unsigned integer into it.
7368 The reference count for the SV is set to 1.
7374 Perl_newSVuv(pTHX_ UV u)
7385 =for apidoc newSV_type
7387 Creates a new SV, of the type specified. The reference count for the new SV
7394 Perl_newSV_type(pTHX_ svtype type)
7399 sv_upgrade(sv, type);
7404 =for apidoc newRV_noinc
7406 Creates an RV wrapper for an SV. The reference count for the original
7407 SV is B<not> incremented.
7413 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7416 register SV *sv = newSV_type(SVt_IV);
7418 SvRV_set(sv, tmpRef);
7423 /* newRV_inc is the official function name to use now.
7424 * newRV_inc is in fact #defined to newRV in sv.h
7428 Perl_newRV(pTHX_ SV *sv)
7431 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7437 Creates a new SV which is an exact duplicate of the original SV.
7444 Perl_newSVsv(pTHX_ register SV *old)
7451 if (SvTYPE(old) == SVTYPEMASK) {
7452 if (ckWARN_d(WARN_INTERNAL))
7453 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7457 /* SV_GMAGIC is the default for sv_setv()
7458 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7459 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7460 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7465 =for apidoc sv_reset
7467 Underlying implementation for the C<reset> Perl function.
7468 Note that the perl-level function is vaguely deprecated.
7474 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7477 char todo[PERL_UCHAR_MAX+1];
7482 if (!*s) { /* reset ?? searches */
7483 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7485 const U32 count = mg->mg_len / sizeof(PMOP**);
7486 PMOP **pmp = (PMOP**) mg->mg_ptr;
7487 PMOP *const *const end = pmp + count;
7491 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7493 (*pmp)->op_pmflags &= ~PMf_USED;
7501 /* reset variables */
7503 if (!HvARRAY(stash))
7506 Zero(todo, 256, char);
7509 I32 i = (unsigned char)*s;
7513 max = (unsigned char)*s++;
7514 for ( ; i <= max; i++) {
7517 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7519 for (entry = HvARRAY(stash)[i];
7521 entry = HeNEXT(entry))
7526 if (!todo[(U8)*HeKEY(entry)])
7528 gv = (GV*)HeVAL(entry);
7531 if (SvTHINKFIRST(sv)) {
7532 if (!SvREADONLY(sv) && SvROK(sv))
7534 /* XXX Is this continue a bug? Why should THINKFIRST
7535 exempt us from resetting arrays and hashes? */
7539 if (SvTYPE(sv) >= SVt_PV) {
7541 if (SvPVX_const(sv) != NULL)
7549 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7551 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7554 # if defined(USE_ENVIRON_ARRAY)
7557 # endif /* USE_ENVIRON_ARRAY */
7568 Using various gambits, try to get an IO from an SV: the IO slot if its a
7569 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7570 named after the PV if we're a string.
7576 Perl_sv_2io(pTHX_ SV *sv)
7581 switch (SvTYPE(sv)) {
7589 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7593 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7595 return sv_2io(SvRV(sv));
7596 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7602 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7611 Using various gambits, try to get a CV from an SV; in addition, try if
7612 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7613 The flags in C<lref> are passed to sv_fetchsv.
7619 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7630 switch (SvTYPE(sv)) {
7649 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7650 tryAMAGICunDEREF(to_cv);
7653 if (SvTYPE(sv) == SVt_PVCV) {
7662 Perl_croak(aTHX_ "Not a subroutine reference");
7667 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7673 /* Some flags to gv_fetchsv mean don't really create the GV */
7674 if (SvTYPE(gv) != SVt_PVGV) {
7680 if (lref && !GvCVu(gv)) {
7684 gv_efullname3(tmpsv, gv, NULL);
7685 /* XXX this is probably not what they think they're getting.
7686 * It has the same effect as "sub name;", i.e. just a forward
7688 newSUB(start_subparse(FALSE, 0),
7689 newSVOP(OP_CONST, 0, tmpsv),
7693 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7703 Returns true if the SV has a true value by Perl's rules.
7704 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7705 instead use an in-line version.
7711 Perl_sv_true(pTHX_ register SV *sv)
7716 register const XPV* const tXpv = (XPV*)SvANY(sv);
7718 (tXpv->xpv_cur > 1 ||
7719 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7726 return SvIVX(sv) != 0;
7729 return SvNVX(sv) != 0.0;
7731 return sv_2bool(sv);
7737 =for apidoc sv_pvn_force
7739 Get a sensible string out of the SV somehow.
7740 A private implementation of the C<SvPV_force> macro for compilers which
7741 can't cope with complex macro expressions. Always use the macro instead.
7743 =for apidoc sv_pvn_force_flags
7745 Get a sensible string out of the SV somehow.
7746 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7747 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7748 implemented in terms of this function.
7749 You normally want to use the various wrapper macros instead: see
7750 C<SvPV_force> and C<SvPV_force_nomg>
7756 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7759 if (SvTHINKFIRST(sv) && !SvROK(sv))
7760 sv_force_normal_flags(sv, 0);
7770 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7771 const char * const ref = sv_reftype(sv,0);
7773 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7774 ref, OP_NAME(PL_op));
7776 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7778 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7779 || isGV_with_GP(sv))
7780 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7782 s = sv_2pv_flags(sv, &len, flags);
7786 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7789 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7790 SvGROW(sv, len + 1);
7791 Move(s,SvPVX(sv),len,char);
7793 SvPVX(sv)[len] = '\0';
7796 SvPOK_on(sv); /* validate pointer */
7798 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7799 PTR2UV(sv),SvPVX_const(sv)));
7802 return SvPVX_mutable(sv);
7806 =for apidoc sv_pvbyten_force
7808 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7814 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7816 sv_pvn_force(sv,lp);
7817 sv_utf8_downgrade(sv,0);
7823 =for apidoc sv_pvutf8n_force
7825 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7831 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7833 sv_pvn_force(sv,lp);
7834 sv_utf8_upgrade(sv);
7840 =for apidoc sv_reftype
7842 Returns a string describing what the SV is a reference to.
7848 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7850 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7851 inside return suggests a const propagation bug in g++. */
7852 if (ob && SvOBJECT(sv)) {
7853 char * const name = HvNAME_get(SvSTASH(sv));
7854 return name ? name : (char *) "__ANON__";
7857 switch (SvTYPE(sv)) {
7872 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7873 /* tied lvalues should appear to be
7874 * scalars for backwards compatitbility */
7875 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7876 ? "SCALAR" : "LVALUE");
7877 case SVt_PVAV: return "ARRAY";
7878 case SVt_PVHV: return "HASH";
7879 case SVt_PVCV: return "CODE";
7880 case SVt_PVGV: return "GLOB";
7881 case SVt_PVFM: return "FORMAT";
7882 case SVt_PVIO: return "IO";
7883 case SVt_BIND: return "BIND";
7884 case SVt_REGEXP: return "Regexp"; /* FIXME? to "REGEXP" */
7885 default: return "UNKNOWN";
7891 =for apidoc sv_isobject
7893 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7894 object. If the SV is not an RV, or if the object is not blessed, then this
7901 Perl_sv_isobject(pTHX_ SV *sv)
7917 Returns a boolean indicating whether the SV is blessed into the specified
7918 class. This does not check for subtypes; use C<sv_derived_from> to verify
7919 an inheritance relationship.
7925 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7936 hvname = HvNAME_get(SvSTASH(sv));
7940 return strEQ(hvname, name);
7946 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7947 it will be upgraded to one. If C<classname> is non-null then the new SV will
7948 be blessed in the specified package. The new SV is returned and its
7949 reference count is 1.
7955 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7962 SV_CHECK_THINKFIRST_COW_DROP(rv);
7963 (void)SvAMAGIC_off(rv);
7965 if (SvTYPE(rv) >= SVt_PVMG) {
7966 const U32 refcnt = SvREFCNT(rv);
7970 SvREFCNT(rv) = refcnt;
7972 sv_upgrade(rv, SVt_IV);
7973 } else if (SvROK(rv)) {
7974 SvREFCNT_dec(SvRV(rv));
7976 prepare_SV_for_RV(rv);
7984 HV* const stash = gv_stashpv(classname, GV_ADD);
7985 (void)sv_bless(rv, stash);
7991 =for apidoc sv_setref_pv
7993 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7994 argument will be upgraded to an RV. That RV will be modified to point to
7995 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7996 into the SV. The C<classname> argument indicates the package for the
7997 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7998 will have a reference count of 1, and the RV will be returned.
8000 Do not use with other Perl types such as HV, AV, SV, CV, because those
8001 objects will become corrupted by the pointer copy process.
8003 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8009 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8013 sv_setsv(rv, &PL_sv_undef);
8017 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8022 =for apidoc sv_setref_iv
8024 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8025 argument will be upgraded to an RV. That RV will be modified to point to
8026 the new SV. The C<classname> argument indicates the package for the
8027 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8028 will have a reference count of 1, and the RV will be returned.
8034 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8036 sv_setiv(newSVrv(rv,classname), iv);
8041 =for apidoc sv_setref_uv
8043 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8044 argument will be upgraded to an RV. That RV will be modified to point to
8045 the new SV. The C<classname> argument indicates the package for the
8046 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8047 will have a reference count of 1, and the RV will be returned.
8053 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8055 sv_setuv(newSVrv(rv,classname), uv);
8060 =for apidoc sv_setref_nv
8062 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8063 argument will be upgraded to an RV. That RV will be modified to point to
8064 the new SV. The C<classname> argument indicates the package for the
8065 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8066 will have a reference count of 1, and the RV will be returned.
8072 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8074 sv_setnv(newSVrv(rv,classname), nv);
8079 =for apidoc sv_setref_pvn
8081 Copies a string into a new SV, optionally blessing the SV. The length of the
8082 string must be specified with C<n>. The C<rv> argument will be upgraded to
8083 an RV. That RV will be modified to point to the new SV. The C<classname>
8084 argument indicates the package for the blessing. Set C<classname> to
8085 C<NULL> to avoid the blessing. The new SV will have a reference count
8086 of 1, and the RV will be returned.
8088 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8094 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8096 sv_setpvn(newSVrv(rv,classname), pv, n);
8101 =for apidoc sv_bless
8103 Blesses an SV into a specified package. The SV must be an RV. The package
8104 must be designated by its stash (see C<gv_stashpv()>). The reference count
8105 of the SV is unaffected.
8111 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8116 Perl_croak(aTHX_ "Can't bless non-reference value");
8118 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8119 if (SvIsCOW(tmpRef))
8120 sv_force_normal_flags(tmpRef, 0);
8121 if (SvREADONLY(tmpRef))
8122 Perl_croak(aTHX_ PL_no_modify);
8123 if (SvOBJECT(tmpRef)) {
8124 if (SvTYPE(tmpRef) != SVt_PVIO)
8126 SvREFCNT_dec(SvSTASH(tmpRef));
8129 SvOBJECT_on(tmpRef);
8130 if (SvTYPE(tmpRef) != SVt_PVIO)
8132 SvUPGRADE(tmpRef, SVt_PVMG);
8133 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8138 (void)SvAMAGIC_off(sv);
8140 if(SvSMAGICAL(tmpRef))
8141 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8149 /* Downgrades a PVGV to a PVMG.
8153 S_sv_unglob(pTHX_ SV *sv)
8158 SV * const temp = sv_newmortal();
8160 assert(SvTYPE(sv) == SVt_PVGV);
8162 gv_efullname3(temp, (GV *) sv, "*");
8165 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8166 mro_method_changed_in(stash);
8170 sv_del_backref((SV*)GvSTASH(sv), sv);
8174 if (GvNAME_HEK(sv)) {
8175 unshare_hek(GvNAME_HEK(sv));
8177 isGV_with_GP_off(sv);
8179 /* need to keep SvANY(sv) in the right arena */
8180 xpvmg = new_XPVMG();
8181 StructCopy(SvANY(sv), xpvmg, XPVMG);
8182 del_XPVGV(SvANY(sv));
8185 SvFLAGS(sv) &= ~SVTYPEMASK;
8186 SvFLAGS(sv) |= SVt_PVMG;
8188 /* Intentionally not calling any local SET magic, as this isn't so much a
8189 set operation as merely an internal storage change. */
8190 sv_setsv_flags(sv, temp, 0);
8194 =for apidoc sv_unref_flags
8196 Unsets the RV status of the SV, and decrements the reference count of
8197 whatever was being referenced by the RV. This can almost be thought of
8198 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8199 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8200 (otherwise the decrementing is conditional on the reference count being
8201 different from one or the reference being a readonly SV).
8208 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8210 SV* const target = SvRV(ref);
8212 if (SvWEAKREF(ref)) {
8213 sv_del_backref(target, ref);
8215 SvRV_set(ref, NULL);
8218 SvRV_set(ref, NULL);
8220 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8221 assigned to as BEGIN {$a = \"Foo"} will fail. */
8222 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8223 SvREFCNT_dec(target);
8224 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8225 sv_2mortal(target); /* Schedule for freeing later */
8229 =for apidoc sv_untaint
8231 Untaint an SV. Use C<SvTAINTED_off> instead.
8236 Perl_sv_untaint(pTHX_ SV *sv)
8238 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8239 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8246 =for apidoc sv_tainted
8248 Test an SV for taintedness. Use C<SvTAINTED> instead.
8253 Perl_sv_tainted(pTHX_ SV *sv)
8255 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8256 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8257 if (mg && (mg->mg_len & 1) )
8264 =for apidoc sv_setpviv
8266 Copies an integer into the given SV, also updating its string value.
8267 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8273 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8275 char buf[TYPE_CHARS(UV)];
8277 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8279 sv_setpvn(sv, ptr, ebuf - ptr);
8283 =for apidoc sv_setpviv_mg
8285 Like C<sv_setpviv>, but also handles 'set' magic.
8291 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8297 #if defined(PERL_IMPLICIT_CONTEXT)
8299 /* pTHX_ magic can't cope with varargs, so this is a no-context
8300 * version of the main function, (which may itself be aliased to us).
8301 * Don't access this version directly.
8305 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8309 va_start(args, pat);
8310 sv_vsetpvf(sv, pat, &args);
8314 /* pTHX_ magic can't cope with varargs, so this is a no-context
8315 * version of the main function, (which may itself be aliased to us).
8316 * Don't access this version directly.
8320 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8324 va_start(args, pat);
8325 sv_vsetpvf_mg(sv, pat, &args);
8331 =for apidoc sv_setpvf
8333 Works like C<sv_catpvf> but copies the text into the SV instead of
8334 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8340 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8343 va_start(args, pat);
8344 sv_vsetpvf(sv, pat, &args);
8349 =for apidoc sv_vsetpvf
8351 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8352 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8354 Usually used via its frontend C<sv_setpvf>.
8360 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8362 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8366 =for apidoc sv_setpvf_mg
8368 Like C<sv_setpvf>, but also handles 'set' magic.
8374 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8377 va_start(args, pat);
8378 sv_vsetpvf_mg(sv, pat, &args);
8383 =for apidoc sv_vsetpvf_mg
8385 Like C<sv_vsetpvf>, but also handles 'set' magic.
8387 Usually used via its frontend C<sv_setpvf_mg>.
8393 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8395 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8399 #if defined(PERL_IMPLICIT_CONTEXT)
8401 /* pTHX_ magic can't cope with varargs, so this is a no-context
8402 * version of the main function, (which may itself be aliased to us).
8403 * Don't access this version directly.
8407 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8411 va_start(args, pat);
8412 sv_vcatpvf(sv, pat, &args);
8416 /* pTHX_ magic can't cope with varargs, so this is a no-context
8417 * version of the main function, (which may itself be aliased to us).
8418 * Don't access this version directly.
8422 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8426 va_start(args, pat);
8427 sv_vcatpvf_mg(sv, pat, &args);
8433 =for apidoc sv_catpvf
8435 Processes its arguments like C<sprintf> and appends the formatted
8436 output to an SV. If the appended data contains "wide" characters
8437 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8438 and characters >255 formatted with %c), the original SV might get
8439 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8440 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8441 valid UTF-8; if the original SV was bytes, the pattern should be too.
8446 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8449 va_start(args, pat);
8450 sv_vcatpvf(sv, pat, &args);
8455 =for apidoc sv_vcatpvf
8457 Processes its arguments like C<vsprintf> and appends the formatted output
8458 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8460 Usually used via its frontend C<sv_catpvf>.
8466 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8468 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8472 =for apidoc sv_catpvf_mg
8474 Like C<sv_catpvf>, but also handles 'set' magic.
8480 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8483 va_start(args, pat);
8484 sv_vcatpvf_mg(sv, pat, &args);
8489 =for apidoc sv_vcatpvf_mg
8491 Like C<sv_vcatpvf>, but also handles 'set' magic.
8493 Usually used via its frontend C<sv_catpvf_mg>.
8499 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8501 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8506 =for apidoc sv_vsetpvfn
8508 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8511 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8517 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8519 sv_setpvn(sv, "", 0);
8520 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8524 S_expect_number(pTHX_ char** pattern)
8528 switch (**pattern) {
8529 case '1': case '2': case '3':
8530 case '4': case '5': case '6':
8531 case '7': case '8': case '9':
8532 var = *(*pattern)++ - '0';
8533 while (isDIGIT(**pattern)) {
8534 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8536 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8544 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8546 const int neg = nv < 0;
8555 if (uv & 1 && uv == nv)
8556 uv--; /* Round to even */
8558 const unsigned dig = uv % 10;
8571 =for apidoc sv_vcatpvfn
8573 Processes its arguments like C<vsprintf> and appends the formatted output
8574 to an SV. Uses an array of SVs if the C style variable argument list is
8575 missing (NULL). When running with taint checks enabled, indicates via
8576 C<maybe_tainted> if results are untrustworthy (often due to the use of
8579 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8585 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8586 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8587 vec_utf8 = DO_UTF8(vecsv);
8589 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8592 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8600 static const char nullstr[] = "(null)";
8602 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8603 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8605 /* Times 4: a decimal digit takes more than 3 binary digits.
8606 * NV_DIG: mantissa takes than many decimal digits.
8607 * Plus 32: Playing safe. */
8608 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8609 /* large enough for "%#.#f" --chip */
8610 /* what about long double NVs? --jhi */
8612 PERL_UNUSED_ARG(maybe_tainted);
8614 /* no matter what, this is a string now */
8615 (void)SvPV_force(sv, origlen);
8617 /* special-case "", "%s", and "%-p" (SVf - see below) */
8620 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8622 const char * const s = va_arg(*args, char*);
8623 sv_catpv(sv, s ? s : nullstr);
8625 else if (svix < svmax) {
8626 sv_catsv(sv, *svargs);
8630 if (args && patlen == 3 && pat[0] == '%' &&
8631 pat[1] == '-' && pat[2] == 'p') {
8632 argsv = (SV*)va_arg(*args, void*);
8633 sv_catsv(sv, argsv);
8637 #ifndef USE_LONG_DOUBLE
8638 /* special-case "%.<number>[gf]" */
8639 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8640 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8641 unsigned digits = 0;
8645 while (*pp >= '0' && *pp <= '9')
8646 digits = 10 * digits + (*pp++ - '0');
8647 if (pp - pat == (int)patlen - 1) {
8655 /* Add check for digits != 0 because it seems that some
8656 gconverts are buggy in this case, and we don't yet have
8657 a Configure test for this. */
8658 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8659 /* 0, point, slack */
8660 Gconvert(nv, (int)digits, 0, ebuf);
8662 if (*ebuf) /* May return an empty string for digits==0 */
8665 } else if (!digits) {
8668 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8669 sv_catpvn(sv, p, l);
8675 #endif /* !USE_LONG_DOUBLE */
8677 if (!args && svix < svmax && DO_UTF8(*svargs))
8680 patend = (char*)pat + patlen;
8681 for (p = (char*)pat; p < patend; p = q) {
8684 bool vectorize = FALSE;
8685 bool vectorarg = FALSE;
8686 bool vec_utf8 = FALSE;
8692 bool has_precis = FALSE;
8694 const I32 osvix = svix;
8695 bool is_utf8 = FALSE; /* is this item utf8? */
8696 #ifdef HAS_LDBL_SPRINTF_BUG
8697 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8698 with sfio - Allen <allens@cpan.org> */
8699 bool fix_ldbl_sprintf_bug = FALSE;
8703 U8 utf8buf[UTF8_MAXBYTES+1];
8704 STRLEN esignlen = 0;
8706 const char *eptr = NULL;
8709 const U8 *vecstr = NULL;
8716 /* we need a long double target in case HAS_LONG_DOUBLE but
8719 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8727 const char *dotstr = ".";
8728 STRLEN dotstrlen = 1;
8729 I32 efix = 0; /* explicit format parameter index */
8730 I32 ewix = 0; /* explicit width index */
8731 I32 epix = 0; /* explicit precision index */
8732 I32 evix = 0; /* explicit vector index */
8733 bool asterisk = FALSE;
8735 /* echo everything up to the next format specification */
8736 for (q = p; q < patend && *q != '%'; ++q) ;
8738 if (has_utf8 && !pat_utf8)
8739 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8741 sv_catpvn(sv, p, q - p);
8748 We allow format specification elements in this order:
8749 \d+\$ explicit format parameter index
8751 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8752 0 flag (as above): repeated to allow "v02"
8753 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8754 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8756 [%bcdefginopsuxDFOUX] format (mandatory)
8761 As of perl5.9.3, printf format checking is on by default.
8762 Internally, perl uses %p formats to provide an escape to
8763 some extended formatting. This block deals with those
8764 extensions: if it does not match, (char*)q is reset and
8765 the normal format processing code is used.
8767 Currently defined extensions are:
8768 %p include pointer address (standard)
8769 %-p (SVf) include an SV (previously %_)
8770 %-<num>p include an SV with precision <num>
8771 %<num>p reserved for future extensions
8773 Robin Barker 2005-07-14
8775 %1p (VDf) removed. RMB 2007-10-19
8782 n = expect_number(&q);
8789 argsv = (SV*)va_arg(*args, void*);
8790 eptr = SvPV_const(argsv, elen);
8796 if (ckWARN_d(WARN_INTERNAL))
8797 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8798 "internal %%<num>p might conflict with future printf extensions");
8804 if ( (width = expect_number(&q)) ) {
8819 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8848 if ( (ewix = expect_number(&q)) )
8857 if ((vectorarg = asterisk)) {
8870 width = expect_number(&q);
8876 vecsv = va_arg(*args, SV*);
8878 vecsv = (evix > 0 && evix <= svmax)
8879 ? svargs[evix-1] : &PL_sv_undef;
8881 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8883 dotstr = SvPV_const(vecsv, dotstrlen);
8884 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8885 bad with tied or overloaded values that return UTF8. */
8888 else if (has_utf8) {
8889 vecsv = sv_mortalcopy(vecsv);
8890 sv_utf8_upgrade(vecsv);
8891 dotstr = SvPV_const(vecsv, dotstrlen);
8898 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8899 vecsv = svargs[efix ? efix-1 : svix++];
8900 vecstr = (U8*)SvPV_const(vecsv,veclen);
8901 vec_utf8 = DO_UTF8(vecsv);
8903 /* if this is a version object, we need to convert
8904 * back into v-string notation and then let the
8905 * vectorize happen normally
8907 if (sv_derived_from(vecsv, "version")) {
8908 char *version = savesvpv(vecsv);
8909 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8910 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8911 "vector argument not supported with alpha versions");
8914 vecsv = sv_newmortal();
8915 scan_vstring(version, version + veclen, vecsv);
8916 vecstr = (U8*)SvPV_const(vecsv, veclen);
8917 vec_utf8 = DO_UTF8(vecsv);
8929 i = va_arg(*args, int);
8931 i = (ewix ? ewix <= svmax : svix < svmax) ?
8932 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8934 width = (i < 0) ? -i : i;
8944 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8946 /* XXX: todo, support specified precision parameter */
8950 i = va_arg(*args, int);
8952 i = (ewix ? ewix <= svmax : svix < svmax)
8953 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8955 has_precis = !(i < 0);
8960 precis = precis * 10 + (*q++ - '0');
8969 case 'I': /* Ix, I32x, and I64x */
8971 if (q[1] == '6' && q[2] == '4') {
8977 if (q[1] == '3' && q[2] == '2') {
8987 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8998 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8999 if (*(q + 1) == 'l') { /* lld, llf */
9025 if (!vectorize && !args) {
9027 const I32 i = efix-1;
9028 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9030 argsv = (svix >= 0 && svix < svmax)
9031 ? svargs[svix++] : &PL_sv_undef;
9042 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9044 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9046 eptr = (char*)utf8buf;
9047 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9061 eptr = va_arg(*args, char*);
9063 #ifdef MACOS_TRADITIONAL
9064 /* On MacOS, %#s format is used for Pascal strings */
9069 elen = strlen(eptr);
9071 eptr = (char *)nullstr;
9072 elen = sizeof nullstr - 1;
9076 eptr = SvPV_const(argsv, elen);
9077 if (DO_UTF8(argsv)) {
9078 I32 old_precis = precis;
9079 if (has_precis && precis < elen) {
9081 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9084 if (width) { /* fudge width (can't fudge elen) */
9085 if (has_precis && precis < elen)
9086 width += precis - old_precis;
9088 width += elen - sv_len_utf8(argsv);
9095 if (has_precis && elen > precis)
9102 if (alt || vectorize)
9104 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9125 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9134 esignbuf[esignlen++] = plus;
9138 case 'h': iv = (short)va_arg(*args, int); break;
9139 case 'l': iv = va_arg(*args, long); break;
9140 case 'V': iv = va_arg(*args, IV); break;
9141 default: iv = va_arg(*args, int); break;
9143 case 'q': iv = va_arg(*args, Quad_t); break;
9148 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9150 case 'h': iv = (short)tiv; break;
9151 case 'l': iv = (long)tiv; break;
9153 default: iv = tiv; break;
9155 case 'q': iv = (Quad_t)tiv; break;
9159 if ( !vectorize ) /* we already set uv above */
9164 esignbuf[esignlen++] = plus;
9168 esignbuf[esignlen++] = '-';
9212 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9223 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9224 case 'l': uv = va_arg(*args, unsigned long); break;
9225 case 'V': uv = va_arg(*args, UV); break;
9226 default: uv = va_arg(*args, unsigned); break;
9228 case 'q': uv = va_arg(*args, Uquad_t); break;
9233 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9235 case 'h': uv = (unsigned short)tuv; break;
9236 case 'l': uv = (unsigned long)tuv; break;
9238 default: uv = tuv; break;
9240 case 'q': uv = (Uquad_t)tuv; break;
9247 char *ptr = ebuf + sizeof ebuf;
9248 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9254 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9260 esignbuf[esignlen++] = '0';
9261 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9269 if (alt && *ptr != '0')
9278 esignbuf[esignlen++] = '0';
9279 esignbuf[esignlen++] = c;
9282 default: /* it had better be ten or less */
9286 } while (uv /= base);
9289 elen = (ebuf + sizeof ebuf) - ptr;
9293 zeros = precis - elen;
9294 else if (precis == 0 && elen == 1 && *eptr == '0'
9295 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9298 /* a precision nullifies the 0 flag. */
9305 /* FLOATING POINT */
9308 c = 'f'; /* maybe %F isn't supported here */
9316 /* This is evil, but floating point is even more evil */
9318 /* for SV-style calling, we can only get NV
9319 for C-style calling, we assume %f is double;
9320 for simplicity we allow any of %Lf, %llf, %qf for long double
9324 #if defined(USE_LONG_DOUBLE)
9328 /* [perl #20339] - we should accept and ignore %lf rather than die */
9332 #if defined(USE_LONG_DOUBLE)
9333 intsize = args ? 0 : 'q';
9337 #if defined(HAS_LONG_DOUBLE)
9346 /* now we need (long double) if intsize == 'q', else (double) */
9348 #if LONG_DOUBLESIZE > DOUBLESIZE
9350 va_arg(*args, long double) :
9351 va_arg(*args, double)
9353 va_arg(*args, double)
9358 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9359 else. frexp() has some unspecified behaviour for those three */
9360 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9362 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9363 will cast our (long double) to (double) */
9364 (void)Perl_frexp(nv, &i);
9365 if (i == PERL_INT_MIN)
9366 Perl_die(aTHX_ "panic: frexp");
9368 need = BIT_DIGITS(i);
9370 need += has_precis ? precis : 6; /* known default */
9375 #ifdef HAS_LDBL_SPRINTF_BUG
9376 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9377 with sfio - Allen <allens@cpan.org> */
9380 # define MY_DBL_MAX DBL_MAX
9381 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9382 # if DOUBLESIZE >= 8
9383 # define MY_DBL_MAX 1.7976931348623157E+308L
9385 # define MY_DBL_MAX 3.40282347E+38L
9389 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9390 # define MY_DBL_MAX_BUG 1L
9392 # define MY_DBL_MAX_BUG MY_DBL_MAX
9396 # define MY_DBL_MIN DBL_MIN
9397 # else /* XXX guessing! -Allen */
9398 # if DOUBLESIZE >= 8
9399 # define MY_DBL_MIN 2.2250738585072014E-308L
9401 # define MY_DBL_MIN 1.17549435E-38L
9405 if ((intsize == 'q') && (c == 'f') &&
9406 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9408 /* it's going to be short enough that
9409 * long double precision is not needed */
9411 if ((nv <= 0L) && (nv >= -0L))
9412 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9414 /* would use Perl_fp_class as a double-check but not
9415 * functional on IRIX - see perl.h comments */
9417 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9418 /* It's within the range that a double can represent */
9419 #if defined(DBL_MAX) && !defined(DBL_MIN)
9420 if ((nv >= ((long double)1/DBL_MAX)) ||
9421 (nv <= (-(long double)1/DBL_MAX)))
9423 fix_ldbl_sprintf_bug = TRUE;
9426 if (fix_ldbl_sprintf_bug == TRUE) {
9436 # undef MY_DBL_MAX_BUG
9439 #endif /* HAS_LDBL_SPRINTF_BUG */
9441 need += 20; /* fudge factor */
9442 if (PL_efloatsize < need) {
9443 Safefree(PL_efloatbuf);
9444 PL_efloatsize = need + 20; /* more fudge */
9445 Newx(PL_efloatbuf, PL_efloatsize, char);
9446 PL_efloatbuf[0] = '\0';
9449 if ( !(width || left || plus || alt) && fill != '0'
9450 && has_precis && intsize != 'q' ) { /* Shortcuts */
9451 /* See earlier comment about buggy Gconvert when digits,
9453 if ( c == 'g' && precis) {
9454 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9455 /* May return an empty string for digits==0 */
9456 if (*PL_efloatbuf) {
9457 elen = strlen(PL_efloatbuf);
9458 goto float_converted;
9460 } else if ( c == 'f' && !precis) {
9461 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9466 char *ptr = ebuf + sizeof ebuf;
9469 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9470 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9471 if (intsize == 'q') {
9472 /* Copy the one or more characters in a long double
9473 * format before the 'base' ([efgEFG]) character to
9474 * the format string. */
9475 static char const prifldbl[] = PERL_PRIfldbl;
9476 char const *p = prifldbl + sizeof(prifldbl) - 3;
9477 while (p >= prifldbl) { *--ptr = *p--; }
9482 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9487 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9499 /* No taint. Otherwise we are in the strange situation
9500 * where printf() taints but print($float) doesn't.
9502 #if defined(HAS_LONG_DOUBLE)
9503 elen = ((intsize == 'q')
9504 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9505 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9507 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9511 eptr = PL_efloatbuf;
9519 i = SvCUR(sv) - origlen;
9522 case 'h': *(va_arg(*args, short*)) = i; break;
9523 default: *(va_arg(*args, int*)) = i; break;
9524 case 'l': *(va_arg(*args, long*)) = i; break;
9525 case 'V': *(va_arg(*args, IV*)) = i; break;
9527 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9532 sv_setuv_mg(argsv, (UV)i);
9533 continue; /* not "break" */
9540 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9541 && ckWARN(WARN_PRINTF))
9543 SV * const msg = sv_newmortal();
9544 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9545 (PL_op->op_type == OP_PRTF) ? "" : "s");
9548 Perl_sv_catpvf(aTHX_ msg,
9549 "\"%%%c\"", c & 0xFF);
9551 Perl_sv_catpvf(aTHX_ msg,
9552 "\"%%\\%03"UVof"\"",
9555 sv_catpvs(msg, "end of string");
9556 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9559 /* output mangled stuff ... */
9565 /* ... right here, because formatting flags should not apply */
9566 SvGROW(sv, SvCUR(sv) + elen + 1);
9568 Copy(eptr, p, elen, char);
9571 SvCUR_set(sv, p - SvPVX_const(sv));
9573 continue; /* not "break" */
9576 if (is_utf8 != has_utf8) {
9579 sv_utf8_upgrade(sv);
9582 const STRLEN old_elen = elen;
9583 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9584 sv_utf8_upgrade(nsv);
9585 eptr = SvPVX_const(nsv);
9588 if (width) { /* fudge width (can't fudge elen) */
9589 width += elen - old_elen;
9595 have = esignlen + zeros + elen;
9597 Perl_croak_nocontext(PL_memory_wrap);
9599 need = (have > width ? have : width);
9602 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9603 Perl_croak_nocontext(PL_memory_wrap);
9604 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9606 if (esignlen && fill == '0') {
9608 for (i = 0; i < (int)esignlen; i++)
9612 memset(p, fill, gap);
9615 if (esignlen && fill != '0') {
9617 for (i = 0; i < (int)esignlen; i++)
9622 for (i = zeros; i; i--)
9626 Copy(eptr, p, elen, char);
9630 memset(p, ' ', gap);
9635 Copy(dotstr, p, dotstrlen, char);
9639 vectorize = FALSE; /* done iterating over vecstr */
9646 SvCUR_set(sv, p - SvPVX_const(sv));
9654 /* =========================================================================
9656 =head1 Cloning an interpreter
9658 All the macros and functions in this section are for the private use of
9659 the main function, perl_clone().
9661 The foo_dup() functions make an exact copy of an existing foo thingy.
9662 During the course of a cloning, a hash table is used to map old addresses
9663 to new addresses. The table is created and manipulated with the
9664 ptr_table_* functions.
9668 ============================================================================*/
9671 #if defined(USE_ITHREADS)
9673 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9674 #ifndef GpREFCNT_inc
9675 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9679 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9680 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9681 If this changes, please unmerge ss_dup. */
9682 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9683 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9684 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9685 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9686 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9687 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9688 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9689 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9690 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9691 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9692 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9693 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9694 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9695 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9697 /* clone a parser */
9700 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9707 /* look for it in the table first */
9708 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9712 /* create anew and remember what it is */
9713 Newxz(parser, 1, yy_parser);
9714 ptr_table_store(PL_ptr_table, proto, parser);
9716 parser->yyerrstatus = 0;
9717 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9719 /* XXX these not yet duped */
9720 parser->old_parser = NULL;
9721 parser->stack = NULL;
9723 parser->stack_size = 0;
9724 /* XXX parser->stack->state = 0; */
9726 /* XXX eventually, just Copy() most of the parser struct ? */
9728 parser->lex_brackets = proto->lex_brackets;
9729 parser->lex_casemods = proto->lex_casemods;
9730 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9731 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9732 parser->lex_casestack = savepvn(proto->lex_casestack,
9733 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9734 parser->lex_defer = proto->lex_defer;
9735 parser->lex_dojoin = proto->lex_dojoin;
9736 parser->lex_expect = proto->lex_expect;
9737 parser->lex_formbrack = proto->lex_formbrack;
9738 parser->lex_inpat = proto->lex_inpat;
9739 parser->lex_inwhat = proto->lex_inwhat;
9740 parser->lex_op = proto->lex_op;
9741 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9742 parser->lex_starts = proto->lex_starts;
9743 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9744 parser->multi_close = proto->multi_close;
9745 parser->multi_open = proto->multi_open;
9746 parser->multi_start = proto->multi_start;
9747 parser->multi_end = proto->multi_end;
9748 parser->pending_ident = proto->pending_ident;
9749 parser->preambled = proto->preambled;
9750 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9751 parser->linestr = sv_dup_inc(proto->linestr, param);
9752 parser->expect = proto->expect;
9753 parser->copline = proto->copline;
9754 parser->last_lop_op = proto->last_lop_op;
9755 parser->lex_state = proto->lex_state;
9756 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9757 /* rsfp_filters entries have fake IoDIRP() */
9758 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9759 parser->in_my = proto->in_my;
9760 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9761 parser->error_count = proto->error_count;
9764 parser->linestr = sv_dup_inc(proto->linestr, param);
9767 char * const ols = SvPVX(proto->linestr);
9768 char * const ls = SvPVX(parser->linestr);
9770 parser->bufptr = ls + (proto->bufptr >= ols ?
9771 proto->bufptr - ols : 0);
9772 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9773 proto->oldbufptr - ols : 0);
9774 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9775 proto->oldoldbufptr - ols : 0);
9776 parser->linestart = ls + (proto->linestart >= ols ?
9777 proto->linestart - ols : 0);
9778 parser->last_uni = ls + (proto->last_uni >= ols ?
9779 proto->last_uni - ols : 0);
9780 parser->last_lop = ls + (proto->last_lop >= ols ?
9781 proto->last_lop - ols : 0);
9783 parser->bufend = ls + SvCUR(parser->linestr);
9786 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9790 parser->endwhite = proto->endwhite;
9791 parser->faketokens = proto->faketokens;
9792 parser->lasttoke = proto->lasttoke;
9793 parser->nextwhite = proto->nextwhite;
9794 parser->realtokenstart = proto->realtokenstart;
9795 parser->skipwhite = proto->skipwhite;
9796 parser->thisclose = proto->thisclose;
9797 parser->thismad = proto->thismad;
9798 parser->thisopen = proto->thisopen;
9799 parser->thisstuff = proto->thisstuff;
9800 parser->thistoken = proto->thistoken;
9801 parser->thiswhite = proto->thiswhite;
9803 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9804 parser->curforce = proto->curforce;
9806 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9807 Copy(proto->nexttype, parser->nexttype, 5, I32);
9808 parser->nexttoke = proto->nexttoke;
9814 /* duplicate a file handle */
9817 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9821 PERL_UNUSED_ARG(type);
9824 return (PerlIO*)NULL;
9826 /* look for it in the table first */
9827 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9831 /* create anew and remember what it is */
9832 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9833 ptr_table_store(PL_ptr_table, fp, ret);
9837 /* duplicate a directory handle */
9840 Perl_dirp_dup(pTHX_ DIR *dp)
9842 PERL_UNUSED_CONTEXT;
9849 /* duplicate a typeglob */
9852 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9858 /* look for it in the table first */
9859 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9863 /* create anew and remember what it is */
9865 ptr_table_store(PL_ptr_table, gp, ret);
9868 ret->gp_refcnt = 0; /* must be before any other dups! */
9869 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9870 ret->gp_io = io_dup_inc(gp->gp_io, param);
9871 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9872 ret->gp_av = av_dup_inc(gp->gp_av, param);
9873 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9874 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9875 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9876 ret->gp_cvgen = gp->gp_cvgen;
9877 ret->gp_line = gp->gp_line;
9878 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9882 /* duplicate a chain of magic */
9885 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9887 MAGIC *mgprev = (MAGIC*)NULL;
9890 return (MAGIC*)NULL;
9891 /* look for it in the table first */
9892 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9896 for (; mg; mg = mg->mg_moremagic) {
9898 Newxz(nmg, 1, MAGIC);
9900 mgprev->mg_moremagic = nmg;
9903 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9904 nmg->mg_private = mg->mg_private;
9905 nmg->mg_type = mg->mg_type;
9906 nmg->mg_flags = mg->mg_flags;
9907 /* FIXME for plugins
9908 if (mg->mg_type == PERL_MAGIC_qr) {
9909 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9913 if(mg->mg_type == PERL_MAGIC_backref) {
9914 /* The backref AV has its reference count deliberately bumped by
9916 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9919 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9920 ? sv_dup_inc(mg->mg_obj, param)
9921 : sv_dup(mg->mg_obj, param);
9923 nmg->mg_len = mg->mg_len;
9924 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9925 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9926 if (mg->mg_len > 0) {
9927 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9928 if (mg->mg_type == PERL_MAGIC_overload_table &&
9929 AMT_AMAGIC((AMT*)mg->mg_ptr))
9931 const AMT * const amtp = (AMT*)mg->mg_ptr;
9932 AMT * const namtp = (AMT*)nmg->mg_ptr;
9934 for (i = 1; i < NofAMmeth; i++) {
9935 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9939 else if (mg->mg_len == HEf_SVKEY)
9940 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9942 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9943 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9950 #endif /* USE_ITHREADS */
9952 /* create a new pointer-mapping table */
9955 Perl_ptr_table_new(pTHX)
9958 PERL_UNUSED_CONTEXT;
9960 Newxz(tbl, 1, PTR_TBL_t);
9963 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9967 #define PTR_TABLE_HASH(ptr) \
9968 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9971 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9972 following define) and at call to new_body_inline made below in
9973 Perl_ptr_table_store()
9976 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9978 /* map an existing pointer using a table */
9980 STATIC PTR_TBL_ENT_t *
9981 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9982 PTR_TBL_ENT_t *tblent;
9983 const UV hash = PTR_TABLE_HASH(sv);
9985 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9986 for (; tblent; tblent = tblent->next) {
9987 if (tblent->oldval == sv)
9994 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9996 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9997 PERL_UNUSED_CONTEXT;
9998 return tblent ? tblent->newval : NULL;
10001 /* add a new entry to a pointer-mapping table */
10004 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10006 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10007 PERL_UNUSED_CONTEXT;
10010 tblent->newval = newsv;
10012 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10014 new_body_inline(tblent, PTE_SVSLOT);
10016 tblent->oldval = oldsv;
10017 tblent->newval = newsv;
10018 tblent->next = tbl->tbl_ary[entry];
10019 tbl->tbl_ary[entry] = tblent;
10021 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10022 ptr_table_split(tbl);
10026 /* double the hash bucket size of an existing ptr table */
10029 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10031 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10032 const UV oldsize = tbl->tbl_max + 1;
10033 UV newsize = oldsize * 2;
10035 PERL_UNUSED_CONTEXT;
10037 Renew(ary, newsize, PTR_TBL_ENT_t*);
10038 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10039 tbl->tbl_max = --newsize;
10040 tbl->tbl_ary = ary;
10041 for (i=0; i < oldsize; i++, ary++) {
10042 PTR_TBL_ENT_t **curentp, **entp, *ent;
10045 curentp = ary + oldsize;
10046 for (entp = ary, ent = *ary; ent; ent = *entp) {
10047 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10049 ent->next = *curentp;
10059 /* remove all the entries from a ptr table */
10062 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10064 if (tbl && tbl->tbl_items) {
10065 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10066 UV riter = tbl->tbl_max;
10069 PTR_TBL_ENT_t *entry = array[riter];
10072 PTR_TBL_ENT_t * const oentry = entry;
10073 entry = entry->next;
10078 tbl->tbl_items = 0;
10082 /* clear and free a ptr table */
10085 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10090 ptr_table_clear(tbl);
10091 Safefree(tbl->tbl_ary);
10095 #if defined(USE_ITHREADS)
10098 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10101 SvRV_set(dstr, SvWEAKREF(sstr)
10102 ? sv_dup(SvRV(sstr), param)
10103 : sv_dup_inc(SvRV(sstr), param));
10106 else if (SvPVX_const(sstr)) {
10107 /* Has something there */
10109 /* Normal PV - clone whole allocated space */
10110 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10111 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10112 /* Not that normal - actually sstr is copy on write.
10113 But we are a true, independant SV, so: */
10114 SvREADONLY_off(dstr);
10119 /* Special case - not normally malloced for some reason */
10120 if (isGV_with_GP(sstr)) {
10121 /* Don't need to do anything here. */
10123 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10124 /* A "shared" PV - clone it as "shared" PV */
10126 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10130 /* Some other special case - random pointer */
10131 SvPV_set(dstr, SvPVX(sstr));
10136 /* Copy the NULL */
10137 SvPV_set(dstr, NULL);
10141 /* duplicate an SV of any type (including AV, HV etc) */
10144 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10149 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10151 /* look for it in the table first */
10152 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10156 if(param->flags & CLONEf_JOIN_IN) {
10157 /** We are joining here so we don't want do clone
10158 something that is bad **/
10159 if (SvTYPE(sstr) == SVt_PVHV) {
10160 const HEK * const hvname = HvNAME_HEK(sstr);
10162 /** don't clone stashes if they already exist **/
10163 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10167 /* create anew and remember what it is */
10170 #ifdef DEBUG_LEAKING_SCALARS
10171 dstr->sv_debug_optype = sstr->sv_debug_optype;
10172 dstr->sv_debug_line = sstr->sv_debug_line;
10173 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10174 dstr->sv_debug_cloned = 1;
10175 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10178 ptr_table_store(PL_ptr_table, sstr, dstr);
10181 SvFLAGS(dstr) = SvFLAGS(sstr);
10182 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10183 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10186 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10187 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10188 (void*)PL_watch_pvx, SvPVX_const(sstr));
10191 /* don't clone objects whose class has asked us not to */
10192 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10197 switch (SvTYPE(sstr)) {
10199 SvANY(dstr) = NULL;
10202 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10204 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10206 SvIV_set(dstr, SvIVX(sstr));
10210 SvANY(dstr) = new_XNV();
10211 SvNV_set(dstr, SvNVX(sstr));
10213 /* case SVt_BIND: */
10216 /* These are all the types that need complex bodies allocating. */
10218 const svtype sv_type = SvTYPE(sstr);
10219 const struct body_details *const sv_type_details
10220 = bodies_by_type + sv_type;
10224 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10228 if (GvUNIQUE((GV*)sstr)) {
10229 NOOP; /* Do sharing here, and fall through */
10242 assert(sv_type_details->body_size);
10243 if (sv_type_details->arena) {
10244 new_body_inline(new_body, sv_type);
10246 = (void*)((char*)new_body - sv_type_details->offset);
10248 new_body = new_NOARENA(sv_type_details);
10252 SvANY(dstr) = new_body;
10255 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10256 ((char*)SvANY(dstr)) + sv_type_details->offset,
10257 sv_type_details->copy, char);
10259 Copy(((char*)SvANY(sstr)),
10260 ((char*)SvANY(dstr)),
10261 sv_type_details->body_size + sv_type_details->offset, char);
10264 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10265 && !isGV_with_GP(dstr))
10266 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10268 /* The Copy above means that all the source (unduplicated) pointers
10269 are now in the destination. We can check the flags and the
10270 pointers in either, but it's possible that there's less cache
10271 missing by always going for the destination.
10272 FIXME - instrument and check that assumption */
10273 if (sv_type >= SVt_PVMG) {
10274 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10275 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10276 } else if (SvMAGIC(dstr))
10277 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10279 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10282 /* The cast silences a GCC warning about unhandled types. */
10283 switch ((int)sv_type) {
10293 /* FIXME for plugins */
10294 re_dup_guts(sstr, dstr, param);
10297 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10298 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10299 LvTARG(dstr) = dstr;
10300 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10301 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10303 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10305 if(isGV_with_GP(sstr)) {
10306 if (GvNAME_HEK(dstr))
10307 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10308 /* Don't call sv_add_backref here as it's going to be
10309 created as part of the magic cloning of the symbol
10311 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10312 at the point of this comment. */
10313 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10314 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10315 (void)GpREFCNT_inc(GvGP(dstr));
10317 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10320 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10321 if (IoOFP(dstr) == IoIFP(sstr))
10322 IoOFP(dstr) = IoIFP(dstr);
10324 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10325 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10326 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10327 /* I have no idea why fake dirp (rsfps)
10328 should be treated differently but otherwise
10329 we end up with leaks -- sky*/
10330 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10331 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10332 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10334 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10335 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10336 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10337 if (IoDIRP(dstr)) {
10338 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10341 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10344 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10345 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10346 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10349 if (AvARRAY((AV*)sstr)) {
10350 SV **dst_ary, **src_ary;
10351 SSize_t items = AvFILLp((AV*)sstr) + 1;
10353 src_ary = AvARRAY((AV*)sstr);
10354 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10355 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10356 AvARRAY((AV*)dstr) = dst_ary;
10357 AvALLOC((AV*)dstr) = dst_ary;
10358 if (AvREAL((AV*)sstr)) {
10359 while (items-- > 0)
10360 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10363 while (items-- > 0)
10364 *dst_ary++ = sv_dup(*src_ary++, param);
10366 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10367 while (items-- > 0) {
10368 *dst_ary++ = &PL_sv_undef;
10372 AvARRAY((AV*)dstr) = NULL;
10373 AvALLOC((AV*)dstr) = (SV**)NULL;
10377 if (HvARRAY((HV*)sstr)) {
10379 const bool sharekeys = !!HvSHAREKEYS(sstr);
10380 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10381 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10383 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10384 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10386 HvARRAY(dstr) = (HE**)darray;
10387 while (i <= sxhv->xhv_max) {
10388 const HE * const source = HvARRAY(sstr)[i];
10389 HvARRAY(dstr)[i] = source
10390 ? he_dup(source, sharekeys, param) : 0;
10395 const struct xpvhv_aux * const saux = HvAUX(sstr);
10396 struct xpvhv_aux * const daux = HvAUX(dstr);
10397 /* This flag isn't copied. */
10398 /* SvOOK_on(hv) attacks the IV flags. */
10399 SvFLAGS(dstr) |= SVf_OOK;
10401 hvname = saux->xhv_name;
10402 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10404 daux->xhv_riter = saux->xhv_riter;
10405 daux->xhv_eiter = saux->xhv_eiter
10406 ? he_dup(saux->xhv_eiter,
10407 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10408 daux->xhv_backreferences =
10409 saux->xhv_backreferences
10410 ? (AV*) SvREFCNT_inc(
10411 sv_dup((SV*)saux->xhv_backreferences, param))
10414 daux->xhv_mro_meta = saux->xhv_mro_meta
10415 ? mro_meta_dup(saux->xhv_mro_meta, param)
10418 /* Record stashes for possible cloning in Perl_clone(). */
10420 av_push(param->stashes, dstr);
10424 HvARRAY((HV*)dstr) = NULL;
10427 if (!(param->flags & CLONEf_COPY_STACKS)) {
10431 /* NOTE: not refcounted */
10432 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10434 if (!CvISXSUB(dstr))
10435 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10437 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10438 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10439 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10440 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10442 /* don't dup if copying back - CvGV isn't refcounted, so the
10443 * duped GV may never be freed. A bit of a hack! DAPM */
10444 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10445 NULL : gv_dup(CvGV(dstr), param) ;
10446 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10448 CvWEAKOUTSIDE(sstr)
10449 ? cv_dup( CvOUTSIDE(dstr), param)
10450 : cv_dup_inc(CvOUTSIDE(dstr), param);
10451 if (!CvISXSUB(dstr))
10452 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10458 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10464 /* duplicate a context */
10467 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10469 PERL_CONTEXT *ncxs;
10472 return (PERL_CONTEXT*)NULL;
10474 /* look for it in the table first */
10475 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10479 /* create anew and remember what it is */
10480 Newxz(ncxs, max + 1, PERL_CONTEXT);
10481 ptr_table_store(PL_ptr_table, cxs, ncxs);
10484 PERL_CONTEXT * const cx = &cxs[ix];
10485 PERL_CONTEXT * const ncx = &ncxs[ix];
10486 ncx->cx_type = cx->cx_type;
10487 if (CxTYPE(cx) == CXt_SUBST) {
10488 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10491 ncx->blk_oldsp = cx->blk_oldsp;
10492 ncx->blk_oldcop = cx->blk_oldcop;
10493 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10494 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10495 ncx->blk_oldpm = cx->blk_oldpm;
10496 ncx->blk_gimme = cx->blk_gimme;
10497 switch (CxTYPE(cx)) {
10499 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10500 ? cv_dup_inc(cx->blk_sub.cv, param)
10501 : cv_dup(cx->blk_sub.cv,param));
10502 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10503 ? av_dup_inc(cx->blk_sub.argarray, param)
10505 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10506 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10507 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10508 ncx->blk_sub.lval = cx->blk_sub.lval;
10509 ncx->blk_sub.retop = cx->blk_sub.retop;
10510 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10511 cx->blk_sub.oldcomppad);
10514 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10515 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10516 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10517 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10518 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10519 ncx->blk_eval.retop = cx->blk_eval.retop;
10522 ncx->blk_loop.label = cx->blk_loop.label;
10523 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10524 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10525 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10526 ? cx->blk_loop.iterdata
10527 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10528 ncx->blk_loop.oldcomppad
10529 = (PAD*)ptr_table_fetch(PL_ptr_table,
10530 cx->blk_loop.oldcomppad);
10531 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10532 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10533 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10534 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10535 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10538 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10539 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10540 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10541 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10542 ncx->blk_sub.retop = cx->blk_sub.retop;
10554 /* duplicate a stack info structure */
10557 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10562 return (PERL_SI*)NULL;
10564 /* look for it in the table first */
10565 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10569 /* create anew and remember what it is */
10570 Newxz(nsi, 1, PERL_SI);
10571 ptr_table_store(PL_ptr_table, si, nsi);
10573 nsi->si_stack = av_dup_inc(si->si_stack, param);
10574 nsi->si_cxix = si->si_cxix;
10575 nsi->si_cxmax = si->si_cxmax;
10576 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10577 nsi->si_type = si->si_type;
10578 nsi->si_prev = si_dup(si->si_prev, param);
10579 nsi->si_next = si_dup(si->si_next, param);
10580 nsi->si_markoff = si->si_markoff;
10585 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10586 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10587 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10588 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10589 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10590 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10591 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10592 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10593 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10594 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10595 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10596 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10597 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10598 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10601 #define pv_dup_inc(p) SAVEPV(p)
10602 #define pv_dup(p) SAVEPV(p)
10603 #define svp_dup_inc(p,pp) any_dup(p,pp)
10605 /* map any object to the new equivent - either something in the
10606 * ptr table, or something in the interpreter structure
10610 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10615 return (void*)NULL;
10617 /* look for it in the table first */
10618 ret = ptr_table_fetch(PL_ptr_table, v);
10622 /* see if it is part of the interpreter structure */
10623 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10624 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10632 /* duplicate the save stack */
10635 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10638 ANY * const ss = proto_perl->Isavestack;
10639 const I32 max = proto_perl->Isavestack_max;
10640 I32 ix = proto_perl->Isavestack_ix;
10653 void (*dptr) (void*);
10654 void (*dxptr) (pTHX_ void*);
10656 Newxz(nss, max, ANY);
10659 const I32 type = POPINT(ss,ix);
10660 TOPINT(nss,ix) = type;
10662 case SAVEt_HELEM: /* hash element */
10663 sv = (SV*)POPPTR(ss,ix);
10664 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10666 case SAVEt_ITEM: /* normal string */
10667 case SAVEt_SV: /* scalar reference */
10668 sv = (SV*)POPPTR(ss,ix);
10669 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10672 case SAVEt_MORTALIZESV:
10673 sv = (SV*)POPPTR(ss,ix);
10674 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10676 case SAVEt_SHARED_PVREF: /* char* in shared space */
10677 c = (char*)POPPTR(ss,ix);
10678 TOPPTR(nss,ix) = savesharedpv(c);
10679 ptr = POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10682 case SAVEt_GENERIC_SVREF: /* generic sv */
10683 case SAVEt_SVREF: /* scalar reference */
10684 sv = (SV*)POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10686 ptr = POPPTR(ss,ix);
10687 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10689 case SAVEt_HV: /* hash reference */
10690 case SAVEt_AV: /* array reference */
10691 sv = (SV*) POPPTR(ss,ix);
10692 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10694 case SAVEt_COMPPAD:
10696 sv = (SV*) POPPTR(ss,ix);
10697 TOPPTR(nss,ix) = sv_dup(sv, param);
10699 case SAVEt_INT: /* int reference */
10700 ptr = POPPTR(ss,ix);
10701 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10702 intval = (int)POPINT(ss,ix);
10703 TOPINT(nss,ix) = intval;
10705 case SAVEt_LONG: /* long reference */
10706 ptr = POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10709 case SAVEt_CLEARSV:
10710 longval = (long)POPLONG(ss,ix);
10711 TOPLONG(nss,ix) = longval;
10713 case SAVEt_I32: /* I32 reference */
10714 case SAVEt_I16: /* I16 reference */
10715 case SAVEt_I8: /* I8 reference */
10716 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10717 ptr = POPPTR(ss,ix);
10718 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10720 TOPINT(nss,ix) = i;
10722 case SAVEt_IV: /* IV reference */
10723 ptr = POPPTR(ss,ix);
10724 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10726 TOPIV(nss,ix) = iv;
10728 case SAVEt_HPTR: /* HV* reference */
10729 case SAVEt_APTR: /* AV* reference */
10730 case SAVEt_SPTR: /* SV* reference */
10731 ptr = POPPTR(ss,ix);
10732 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10733 sv = (SV*)POPPTR(ss,ix);
10734 TOPPTR(nss,ix) = sv_dup(sv, param);
10736 case SAVEt_VPTR: /* random* reference */
10737 ptr = POPPTR(ss,ix);
10738 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10739 ptr = POPPTR(ss,ix);
10740 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10742 case SAVEt_GENERIC_PVREF: /* generic char* */
10743 case SAVEt_PPTR: /* char* reference */
10744 ptr = POPPTR(ss,ix);
10745 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10746 c = (char*)POPPTR(ss,ix);
10747 TOPPTR(nss,ix) = pv_dup(c);
10749 case SAVEt_GP: /* scalar reference */
10750 gp = (GP*)POPPTR(ss,ix);
10751 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10752 (void)GpREFCNT_inc(gp);
10753 gv = (GV*)POPPTR(ss,ix);
10754 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10757 ptr = POPPTR(ss,ix);
10758 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10759 /* these are assumed to be refcounted properly */
10761 switch (((OP*)ptr)->op_type) {
10763 case OP_LEAVESUBLV:
10767 case OP_LEAVEWRITE:
10768 TOPPTR(nss,ix) = ptr;
10771 (void) OpREFCNT_inc(o);
10775 TOPPTR(nss,ix) = NULL;
10780 TOPPTR(nss,ix) = NULL;
10783 c = (char*)POPPTR(ss,ix);
10784 TOPPTR(nss,ix) = pv_dup_inc(c);
10787 hv = (HV*)POPPTR(ss,ix);
10788 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10789 c = (char*)POPPTR(ss,ix);
10790 TOPPTR(nss,ix) = pv_dup_inc(c);
10792 case SAVEt_STACK_POS: /* Position on Perl stack */
10794 TOPINT(nss,ix) = i;
10796 case SAVEt_DESTRUCTOR:
10797 ptr = POPPTR(ss,ix);
10798 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10799 dptr = POPDPTR(ss,ix);
10800 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10801 any_dup(FPTR2DPTR(void *, dptr),
10804 case SAVEt_DESTRUCTOR_X:
10805 ptr = POPPTR(ss,ix);
10806 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10807 dxptr = POPDXPTR(ss,ix);
10808 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10809 any_dup(FPTR2DPTR(void *, dxptr),
10812 case SAVEt_REGCONTEXT:
10815 TOPINT(nss,ix) = i;
10818 case SAVEt_AELEM: /* array element */
10819 sv = (SV*)POPPTR(ss,ix);
10820 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10822 TOPINT(nss,ix) = i;
10823 av = (AV*)POPPTR(ss,ix);
10824 TOPPTR(nss,ix) = av_dup_inc(av, param);
10827 ptr = POPPTR(ss,ix);
10828 TOPPTR(nss,ix) = ptr;
10832 TOPINT(nss,ix) = i;
10833 ptr = POPPTR(ss,ix);
10836 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10837 HINTS_REFCNT_UNLOCK;
10839 TOPPTR(nss,ix) = ptr;
10840 if (i & HINT_LOCALIZE_HH) {
10841 hv = (HV*)POPPTR(ss,ix);
10842 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10846 longval = (long)POPLONG(ss,ix);
10847 TOPLONG(nss,ix) = longval;
10848 ptr = POPPTR(ss,ix);
10849 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10850 sv = (SV*)POPPTR(ss,ix);
10851 TOPPTR(nss,ix) = sv_dup(sv, param);
10854 ptr = POPPTR(ss,ix);
10855 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10856 longval = (long)POPBOOL(ss,ix);
10857 TOPBOOL(nss,ix) = (bool)longval;
10859 case SAVEt_SET_SVFLAGS:
10861 TOPINT(nss,ix) = i;
10863 TOPINT(nss,ix) = i;
10864 sv = (SV*)POPPTR(ss,ix);
10865 TOPPTR(nss,ix) = sv_dup(sv, param);
10867 case SAVEt_RE_STATE:
10869 const struct re_save_state *const old_state
10870 = (struct re_save_state *)
10871 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10872 struct re_save_state *const new_state
10873 = (struct re_save_state *)
10874 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10876 Copy(old_state, new_state, 1, struct re_save_state);
10877 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10879 new_state->re_state_bostr
10880 = pv_dup(old_state->re_state_bostr);
10881 new_state->re_state_reginput
10882 = pv_dup(old_state->re_state_reginput);
10883 new_state->re_state_regeol
10884 = pv_dup(old_state->re_state_regeol);
10885 new_state->re_state_regoffs
10886 = (regexp_paren_pair*)
10887 any_dup(old_state->re_state_regoffs, proto_perl);
10888 new_state->re_state_reglastparen
10889 = (U32*) any_dup(old_state->re_state_reglastparen,
10891 new_state->re_state_reglastcloseparen
10892 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10894 /* XXX This just has to be broken. The old save_re_context
10895 code did SAVEGENERICPV(PL_reg_start_tmp);
10896 PL_reg_start_tmp is char **.
10897 Look above to what the dup code does for
10898 SAVEt_GENERIC_PVREF
10899 It can never have worked.
10900 So this is merely a faithful copy of the exiting bug: */
10901 new_state->re_state_reg_start_tmp
10902 = (char **) pv_dup((char *)
10903 old_state->re_state_reg_start_tmp);
10904 /* I assume that it only ever "worked" because no-one called
10905 (pseudo)fork while the regexp engine had re-entered itself.
10907 #ifdef PERL_OLD_COPY_ON_WRITE
10908 new_state->re_state_nrs
10909 = sv_dup(old_state->re_state_nrs, param);
10911 new_state->re_state_reg_magic
10912 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10914 new_state->re_state_reg_oldcurpm
10915 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10917 new_state->re_state_reg_curpm
10918 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10920 new_state->re_state_reg_oldsaved
10921 = pv_dup(old_state->re_state_reg_oldsaved);
10922 new_state->re_state_reg_poscache
10923 = pv_dup(old_state->re_state_reg_poscache);
10924 new_state->re_state_reg_starttry
10925 = pv_dup(old_state->re_state_reg_starttry);
10928 case SAVEt_COMPILE_WARNINGS:
10929 ptr = POPPTR(ss,ix);
10930 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10933 ptr = POPPTR(ss,ix);
10934 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10938 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10946 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10947 * flag to the result. This is done for each stash before cloning starts,
10948 * so we know which stashes want their objects cloned */
10951 do_mark_cloneable_stash(pTHX_ SV *sv)
10953 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10955 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10956 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10957 if (cloner && GvCV(cloner)) {
10964 mXPUSHs(newSVhek(hvname));
10966 call_sv((SV*)GvCV(cloner), G_SCALAR);
10973 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10981 =for apidoc perl_clone
10983 Create and return a new interpreter by cloning the current one.
10985 perl_clone takes these flags as parameters:
10987 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10988 without it we only clone the data and zero the stacks,
10989 with it we copy the stacks and the new perl interpreter is
10990 ready to run at the exact same point as the previous one.
10991 The pseudo-fork code uses COPY_STACKS while the
10992 threads->create doesn't.
10994 CLONEf_KEEP_PTR_TABLE
10995 perl_clone keeps a ptr_table with the pointer of the old
10996 variable as a key and the new variable as a value,
10997 this allows it to check if something has been cloned and not
10998 clone it again but rather just use the value and increase the
10999 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11000 the ptr_table using the function
11001 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11002 reason to keep it around is if you want to dup some of your own
11003 variable who are outside the graph perl scans, example of this
11004 code is in threads.xs create
11007 This is a win32 thing, it is ignored on unix, it tells perls
11008 win32host code (which is c++) to clone itself, this is needed on
11009 win32 if you want to run two threads at the same time,
11010 if you just want to do some stuff in a separate perl interpreter
11011 and then throw it away and return to the original one,
11012 you don't need to do anything.
11017 /* XXX the above needs expanding by someone who actually understands it ! */
11018 EXTERN_C PerlInterpreter *
11019 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11022 perl_clone(PerlInterpreter *proto_perl, UV flags)
11025 #ifdef PERL_IMPLICIT_SYS
11027 /* perlhost.h so we need to call into it
11028 to clone the host, CPerlHost should have a c interface, sky */
11030 if (flags & CLONEf_CLONE_HOST) {
11031 return perl_clone_host(proto_perl,flags);
11033 return perl_clone_using(proto_perl, flags,
11035 proto_perl->IMemShared,
11036 proto_perl->IMemParse,
11038 proto_perl->IStdIO,
11042 proto_perl->IProc);
11046 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11047 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11048 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11049 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11050 struct IPerlDir* ipD, struct IPerlSock* ipS,
11051 struct IPerlProc* ipP)
11053 /* XXX many of the string copies here can be optimized if they're
11054 * constants; they need to be allocated as common memory and just
11055 * their pointers copied. */
11058 CLONE_PARAMS clone_params;
11059 CLONE_PARAMS* const param = &clone_params;
11061 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11062 /* for each stash, determine whether its objects should be cloned */
11063 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11064 PERL_SET_THX(my_perl);
11067 PoisonNew(my_perl, 1, PerlInterpreter);
11073 PL_savestack_ix = 0;
11074 PL_savestack_max = -1;
11075 PL_sig_pending = 0;
11077 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11078 # else /* !DEBUGGING */
11079 Zero(my_perl, 1, PerlInterpreter);
11080 # endif /* DEBUGGING */
11082 /* host pointers */
11084 PL_MemShared = ipMS;
11085 PL_MemParse = ipMP;
11092 #else /* !PERL_IMPLICIT_SYS */
11094 CLONE_PARAMS clone_params;
11095 CLONE_PARAMS* param = &clone_params;
11096 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11097 /* for each stash, determine whether its objects should be cloned */
11098 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11099 PERL_SET_THX(my_perl);
11102 PoisonNew(my_perl, 1, PerlInterpreter);
11108 PL_savestack_ix = 0;
11109 PL_savestack_max = -1;
11110 PL_sig_pending = 0;
11112 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11113 # else /* !DEBUGGING */
11114 Zero(my_perl, 1, PerlInterpreter);
11115 # endif /* DEBUGGING */
11116 #endif /* PERL_IMPLICIT_SYS */
11117 param->flags = flags;
11118 param->proto_perl = proto_perl;
11120 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11122 PL_body_arenas = NULL;
11123 Zero(&PL_body_roots, 1, PL_body_roots);
11125 PL_nice_chunk = NULL;
11126 PL_nice_chunk_size = 0;
11128 PL_sv_objcount = 0;
11130 PL_sv_arenaroot = NULL;
11132 PL_debug = proto_perl->Idebug;
11134 PL_hash_seed = proto_perl->Ihash_seed;
11135 PL_rehash_seed = proto_perl->Irehash_seed;
11137 #ifdef USE_REENTRANT_API
11138 /* XXX: things like -Dm will segfault here in perlio, but doing
11139 * PERL_SET_CONTEXT(proto_perl);
11140 * breaks too many other things
11142 Perl_reentrant_init(aTHX);
11145 /* create SV map for pointer relocation */
11146 PL_ptr_table = ptr_table_new();
11148 /* initialize these special pointers as early as possible */
11149 SvANY(&PL_sv_undef) = NULL;
11150 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11151 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11152 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11154 SvANY(&PL_sv_no) = new_XPVNV();
11155 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11156 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11157 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11158 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11159 SvCUR_set(&PL_sv_no, 0);
11160 SvLEN_set(&PL_sv_no, 1);
11161 SvIV_set(&PL_sv_no, 0);
11162 SvNV_set(&PL_sv_no, 0);
11163 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11165 SvANY(&PL_sv_yes) = new_XPVNV();
11166 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11167 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11168 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11169 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11170 SvCUR_set(&PL_sv_yes, 1);
11171 SvLEN_set(&PL_sv_yes, 2);
11172 SvIV_set(&PL_sv_yes, 1);
11173 SvNV_set(&PL_sv_yes, 1);
11174 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11176 /* create (a non-shared!) shared string table */
11177 PL_strtab = newHV();
11178 HvSHAREKEYS_off(PL_strtab);
11179 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11180 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11182 PL_compiling = proto_perl->Icompiling;
11184 /* These two PVs will be free'd special way so must set them same way op.c does */
11185 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11186 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11188 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11189 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11191 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11192 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11193 if (PL_compiling.cop_hints_hash) {
11195 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11196 HINTS_REFCNT_UNLOCK;
11198 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11199 #ifdef PERL_DEBUG_READONLY_OPS
11204 /* pseudo environmental stuff */
11205 PL_origargc = proto_perl->Iorigargc;
11206 PL_origargv = proto_perl->Iorigargv;
11208 param->stashes = newAV(); /* Setup array of objects to call clone on */
11210 /* Set tainting stuff before PerlIO_debug can possibly get called */
11211 PL_tainting = proto_perl->Itainting;
11212 PL_taint_warn = proto_perl->Itaint_warn;
11214 #ifdef PERLIO_LAYERS
11215 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11216 PerlIO_clone(aTHX_ proto_perl, param);
11219 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11220 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11221 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11222 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11223 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11224 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11227 PL_minus_c = proto_perl->Iminus_c;
11228 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11229 PL_localpatches = proto_perl->Ilocalpatches;
11230 PL_splitstr = proto_perl->Isplitstr;
11231 PL_preprocess = proto_perl->Ipreprocess;
11232 PL_minus_n = proto_perl->Iminus_n;
11233 PL_minus_p = proto_perl->Iminus_p;
11234 PL_minus_l = proto_perl->Iminus_l;
11235 PL_minus_a = proto_perl->Iminus_a;
11236 PL_minus_E = proto_perl->Iminus_E;
11237 PL_minus_F = proto_perl->Iminus_F;
11238 PL_doswitches = proto_perl->Idoswitches;
11239 PL_dowarn = proto_perl->Idowarn;
11240 PL_doextract = proto_perl->Idoextract;
11241 PL_sawampersand = proto_perl->Isawampersand;
11242 PL_unsafe = proto_perl->Iunsafe;
11243 PL_inplace = SAVEPV(proto_perl->Iinplace);
11244 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11245 PL_perldb = proto_perl->Iperldb;
11246 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11247 PL_exit_flags = proto_perl->Iexit_flags;
11249 /* magical thingies */
11250 /* XXX time(&PL_basetime) when asked for? */
11251 PL_basetime = proto_perl->Ibasetime;
11252 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11254 PL_maxsysfd = proto_perl->Imaxsysfd;
11255 PL_statusvalue = proto_perl->Istatusvalue;
11257 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11259 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11261 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11263 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11264 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11265 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11268 /* RE engine related */
11269 Zero(&PL_reg_state, 1, struct re_save_state);
11270 PL_reginterp_cnt = 0;
11271 PL_regmatch_slab = NULL;
11273 /* Clone the regex array */
11274 PL_regex_padav = newAV();
11276 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11277 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11279 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11280 for(i = 1; i <= len; i++) {
11281 const SV * const regex = regexen[i];
11282 /* FIXME for plugins
11283 newSViv(PTR2IV(CALLREGDUPE(
11284 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11286 /* And while we're at it, can we FIXME on the whole hiding
11287 pointer inside an IV hack? */
11290 ? sv_dup_inc(regex, param)
11292 newSViv(PTR2IV(sv_dup_inc(INT2PTR(REGEXP *, SvIVX(regex)), param))))
11294 if (SvFLAGS(regex) & SVf_BREAK)
11295 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11296 av_push(PL_regex_padav, sv);
11299 PL_regex_pad = AvARRAY(PL_regex_padav);
11301 /* shortcuts to various I/O objects */
11302 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11303 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11304 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11305 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11306 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11307 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11309 /* shortcuts to regexp stuff */
11310 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11312 /* shortcuts to misc objects */
11313 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11315 /* shortcuts to debugging objects */
11316 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11317 PL_DBline = gv_dup(proto_perl->IDBline, param);
11318 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11319 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11320 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11321 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11322 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11324 /* symbol tables */
11325 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11326 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11327 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11328 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11329 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11331 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11332 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11333 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11334 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11335 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11336 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11337 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11338 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11340 PL_sub_generation = proto_perl->Isub_generation;
11341 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11343 /* funky return mechanisms */
11344 PL_forkprocess = proto_perl->Iforkprocess;
11346 /* subprocess state */
11347 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11349 /* internal state */
11350 PL_maxo = proto_perl->Imaxo;
11351 if (proto_perl->Iop_mask)
11352 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11355 /* PL_asserting = proto_perl->Iasserting; */
11357 /* current interpreter roots */
11358 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11360 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11362 PL_main_start = proto_perl->Imain_start;
11363 PL_eval_root = proto_perl->Ieval_root;
11364 PL_eval_start = proto_perl->Ieval_start;
11366 /* runtime control stuff */
11367 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11369 PL_filemode = proto_perl->Ifilemode;
11370 PL_lastfd = proto_perl->Ilastfd;
11371 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11374 PL_gensym = proto_perl->Igensym;
11375 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11376 PL_laststatval = proto_perl->Ilaststatval;
11377 PL_laststype = proto_perl->Ilaststype;
11380 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11382 /* interpreter atexit processing */
11383 PL_exitlistlen = proto_perl->Iexitlistlen;
11384 if (PL_exitlistlen) {
11385 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11386 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11389 PL_exitlist = (PerlExitListEntry*)NULL;
11391 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11392 if (PL_my_cxt_size) {
11393 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11394 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11395 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11396 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11397 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11401 PL_my_cxt_list = (void**)NULL;
11402 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11403 PL_my_cxt_keys = (const char**)NULL;
11406 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11407 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11408 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11410 PL_profiledata = NULL;
11412 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11414 PAD_CLONE_VARS(proto_perl, param);
11416 #ifdef HAVE_INTERP_INTERN
11417 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11420 /* more statics moved here */
11421 PL_generation = proto_perl->Igeneration;
11422 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11424 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11425 PL_in_clean_all = proto_perl->Iin_clean_all;
11427 PL_uid = proto_perl->Iuid;
11428 PL_euid = proto_perl->Ieuid;
11429 PL_gid = proto_perl->Igid;
11430 PL_egid = proto_perl->Iegid;
11431 PL_nomemok = proto_perl->Inomemok;
11432 PL_an = proto_perl->Ian;
11433 PL_evalseq = proto_perl->Ievalseq;
11434 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11435 PL_origalen = proto_perl->Iorigalen;
11436 #ifdef PERL_USES_PL_PIDSTATUS
11437 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11439 PL_osname = SAVEPV(proto_perl->Iosname);
11440 PL_sighandlerp = proto_perl->Isighandlerp;
11442 PL_runops = proto_perl->Irunops;
11444 PL_parser = parser_dup(proto_perl->Iparser, param);
11446 PL_subline = proto_perl->Isubline;
11447 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11450 PL_cryptseen = proto_perl->Icryptseen;
11453 PL_hints = proto_perl->Ihints;
11455 PL_amagic_generation = proto_perl->Iamagic_generation;
11457 #ifdef USE_LOCALE_COLLATE
11458 PL_collation_ix = proto_perl->Icollation_ix;
11459 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11460 PL_collation_standard = proto_perl->Icollation_standard;
11461 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11462 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11463 #endif /* USE_LOCALE_COLLATE */
11465 #ifdef USE_LOCALE_NUMERIC
11466 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11467 PL_numeric_standard = proto_perl->Inumeric_standard;
11468 PL_numeric_local = proto_perl->Inumeric_local;
11469 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11470 #endif /* !USE_LOCALE_NUMERIC */
11472 /* utf8 character classes */
11473 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11474 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11475 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11476 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11477 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11478 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11479 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11480 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11481 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11482 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11483 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11484 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11485 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11486 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11487 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11488 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11489 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11490 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11491 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11492 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11494 /* Did the locale setup indicate UTF-8? */
11495 PL_utf8locale = proto_perl->Iutf8locale;
11496 /* Unicode features (see perlrun/-C) */
11497 PL_unicode = proto_perl->Iunicode;
11499 /* Pre-5.8 signals control */
11500 PL_signals = proto_perl->Isignals;
11502 /* times() ticks per second */
11503 PL_clocktick = proto_perl->Iclocktick;
11505 /* Recursion stopper for PerlIO_find_layer */
11506 PL_in_load_module = proto_perl->Iin_load_module;
11508 /* sort() routine */
11509 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11511 /* Not really needed/useful since the reenrant_retint is "volatile",
11512 * but do it for consistency's sake. */
11513 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11515 /* Hooks to shared SVs and locks. */
11516 PL_sharehook = proto_perl->Isharehook;
11517 PL_lockhook = proto_perl->Ilockhook;
11518 PL_unlockhook = proto_perl->Iunlockhook;
11519 PL_threadhook = proto_perl->Ithreadhook;
11520 PL_destroyhook = proto_perl->Idestroyhook;
11522 #ifdef THREADS_HAVE_PIDS
11523 PL_ppid = proto_perl->Ippid;
11527 PL_last_swash_hv = NULL; /* reinits on demand */
11528 PL_last_swash_klen = 0;
11529 PL_last_swash_key[0]= '\0';
11530 PL_last_swash_tmps = (U8*)NULL;
11531 PL_last_swash_slen = 0;
11533 PL_glob_index = proto_perl->Iglob_index;
11534 PL_srand_called = proto_perl->Isrand_called;
11535 PL_bitcount = NULL; /* reinits on demand */
11537 if (proto_perl->Ipsig_pend) {
11538 Newxz(PL_psig_pend, SIG_SIZE, int);
11541 PL_psig_pend = (int*)NULL;
11544 if (proto_perl->Ipsig_ptr) {
11545 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11546 Newxz(PL_psig_name, SIG_SIZE, SV*);
11547 for (i = 1; i < SIG_SIZE; i++) {
11548 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11549 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11553 PL_psig_ptr = (SV**)NULL;
11554 PL_psig_name = (SV**)NULL;
11557 /* intrpvar.h stuff */
11559 if (flags & CLONEf_COPY_STACKS) {
11560 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11561 PL_tmps_ix = proto_perl->Itmps_ix;
11562 PL_tmps_max = proto_perl->Itmps_max;
11563 PL_tmps_floor = proto_perl->Itmps_floor;
11564 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11566 while (i <= PL_tmps_ix) {
11567 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11571 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11572 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11573 Newxz(PL_markstack, i, I32);
11574 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11575 - proto_perl->Imarkstack);
11576 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11577 - proto_perl->Imarkstack);
11578 Copy(proto_perl->Imarkstack, PL_markstack,
11579 PL_markstack_ptr - PL_markstack + 1, I32);
11581 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11582 * NOTE: unlike the others! */
11583 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11584 PL_scopestack_max = proto_perl->Iscopestack_max;
11585 Newxz(PL_scopestack, PL_scopestack_max, I32);
11586 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11588 /* NOTE: si_dup() looks at PL_markstack */
11589 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11591 /* PL_curstack = PL_curstackinfo->si_stack; */
11592 PL_curstack = av_dup(proto_perl->Icurstack, param);
11593 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11595 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11596 PL_stack_base = AvARRAY(PL_curstack);
11597 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11598 - proto_perl->Istack_base);
11599 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11601 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11602 * NOTE: unlike the others! */
11603 PL_savestack_ix = proto_perl->Isavestack_ix;
11604 PL_savestack_max = proto_perl->Isavestack_max;
11605 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11606 PL_savestack = ss_dup(proto_perl, param);
11610 ENTER; /* perl_destruct() wants to LEAVE; */
11612 /* although we're not duplicating the tmps stack, we should still
11613 * add entries for any SVs on the tmps stack that got cloned by a
11614 * non-refcount means (eg a temp in @_); otherwise they will be
11617 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11618 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11619 proto_perl->Itmps_stack[i]);
11620 if (nsv && !SvREFCNT(nsv)) {
11622 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11627 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11628 PL_top_env = &PL_start_env;
11630 PL_op = proto_perl->Iop;
11633 PL_Xpv = (XPV*)NULL;
11634 my_perl->Ina = proto_perl->Ina;
11636 PL_statbuf = proto_perl->Istatbuf;
11637 PL_statcache = proto_perl->Istatcache;
11638 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11639 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11641 PL_timesbuf = proto_perl->Itimesbuf;
11644 PL_tainted = proto_perl->Itainted;
11645 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11646 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11647 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11648 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11649 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11650 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11651 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11652 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11653 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11655 PL_restartop = proto_perl->Irestartop;
11656 PL_in_eval = proto_perl->Iin_eval;
11657 PL_delaymagic = proto_perl->Idelaymagic;
11658 PL_dirty = proto_perl->Idirty;
11659 PL_localizing = proto_perl->Ilocalizing;
11661 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11662 PL_hv_fetch_ent_mh = NULL;
11663 PL_modcount = proto_perl->Imodcount;
11664 PL_lastgotoprobe = NULL;
11665 PL_dumpindent = proto_perl->Idumpindent;
11667 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11668 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11669 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11670 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11671 PL_efloatbuf = NULL; /* reinits on demand */
11672 PL_efloatsize = 0; /* reinits on demand */
11676 PL_screamfirst = NULL;
11677 PL_screamnext = NULL;
11678 PL_maxscream = -1; /* reinits on demand */
11679 PL_lastscream = NULL;
11682 PL_regdummy = proto_perl->Iregdummy;
11683 PL_colorset = 0; /* reinits PL_colors[] */
11684 /*PL_colors[6] = {0,0,0,0,0,0};*/
11688 /* Pluggable optimizer */
11689 PL_peepp = proto_perl->Ipeepp;
11691 PL_stashcache = newHV();
11693 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11694 proto_perl->Iwatchaddr);
11695 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11696 if (PL_debug && PL_watchaddr) {
11697 PerlIO_printf(Perl_debug_log,
11698 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11699 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11700 PTR2UV(PL_watchok));
11703 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11704 ptr_table_free(PL_ptr_table);
11705 PL_ptr_table = NULL;
11708 /* Call the ->CLONE method, if it exists, for each of the stashes
11709 identified by sv_dup() above.
11711 while(av_len(param->stashes) != -1) {
11712 HV* const stash = (HV*) av_shift(param->stashes);
11713 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11714 if (cloner && GvCV(cloner)) {
11719 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11721 call_sv((SV*)GvCV(cloner), G_DISCARD);
11727 SvREFCNT_dec(param->stashes);
11729 /* orphaned? eg threads->new inside BEGIN or use */
11730 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11731 SvREFCNT_inc_simple_void(PL_compcv);
11732 SAVEFREESV(PL_compcv);
11738 #endif /* USE_ITHREADS */
11741 =head1 Unicode Support
11743 =for apidoc sv_recode_to_utf8
11745 The encoding is assumed to be an Encode object, on entry the PV
11746 of the sv is assumed to be octets in that encoding, and the sv
11747 will be converted into Unicode (and UTF-8).
11749 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11750 is not a reference, nothing is done to the sv. If the encoding is not
11751 an C<Encode::XS> Encoding object, bad things will happen.
11752 (See F<lib/encoding.pm> and L<Encode>).
11754 The PV of the sv is returned.
11759 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11762 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11776 Passing sv_yes is wrong - it needs to be or'ed set of constants
11777 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11778 remove converted chars from source.
11780 Both will default the value - let them.
11782 XPUSHs(&PL_sv_yes);
11785 call_method("decode", G_SCALAR);
11789 s = SvPV_const(uni, len);
11790 if (s != SvPVX_const(sv)) {
11791 SvGROW(sv, len + 1);
11792 Move(s, SvPVX(sv), len + 1, char);
11793 SvCUR_set(sv, len);
11800 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11804 =for apidoc sv_cat_decode
11806 The encoding is assumed to be an Encode object, the PV of the ssv is
11807 assumed to be octets in that encoding and decoding the input starts
11808 from the position which (PV + *offset) pointed to. The dsv will be
11809 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11810 when the string tstr appears in decoding output or the input ends on
11811 the PV of the ssv. The value which the offset points will be modified
11812 to the last input position on the ssv.
11814 Returns TRUE if the terminator was found, else returns FALSE.
11819 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11820 SV *ssv, int *offset, char *tstr, int tlen)
11824 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11835 offsv = newSViv(*offset);
11837 mXPUSHp(tstr, tlen);
11839 call_method("cat_decode", G_SCALAR);
11841 ret = SvTRUE(TOPs);
11842 *offset = SvIV(offsv);
11848 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11853 /* ---------------------------------------------------------------------
11855 * support functions for report_uninit()
11858 /* the maxiumum size of array or hash where we will scan looking
11859 * for the undefined element that triggered the warning */
11861 #define FUV_MAX_SEARCH_SIZE 1000
11863 /* Look for an entry in the hash whose value has the same SV as val;
11864 * If so, return a mortal copy of the key. */
11867 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11870 register HE **array;
11873 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11874 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11877 array = HvARRAY(hv);
11879 for (i=HvMAX(hv); i>0; i--) {
11880 register HE *entry;
11881 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11882 if (HeVAL(entry) != val)
11884 if ( HeVAL(entry) == &PL_sv_undef ||
11885 HeVAL(entry) == &PL_sv_placeholder)
11889 if (HeKLEN(entry) == HEf_SVKEY)
11890 return sv_mortalcopy(HeKEY_sv(entry));
11891 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11897 /* Look for an entry in the array whose value has the same SV as val;
11898 * If so, return the index, otherwise return -1. */
11901 S_find_array_subscript(pTHX_ AV *av, SV* val)
11904 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11905 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11908 if (val != &PL_sv_undef) {
11909 SV ** const svp = AvARRAY(av);
11912 for (i=AvFILLp(av); i>=0; i--)
11919 /* S_varname(): return the name of a variable, optionally with a subscript.
11920 * If gv is non-zero, use the name of that global, along with gvtype (one
11921 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11922 * targ. Depending on the value of the subscript_type flag, return:
11925 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11926 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11927 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11928 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11931 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11932 SV* keyname, I32 aindex, int subscript_type)
11935 SV * const name = sv_newmortal();
11938 buffer[0] = gvtype;
11941 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11943 gv_fullname4(name, gv, buffer, 0);
11945 if ((unsigned int)SvPVX(name)[1] <= 26) {
11947 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11949 /* Swap the 1 unprintable control character for the 2 byte pretty
11950 version - ie substr($name, 1, 1) = $buffer; */
11951 sv_insert(name, 1, 1, buffer, 2);
11955 CV * const cv = find_runcv(NULL);
11959 if (!cv || !CvPADLIST(cv))
11961 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11962 sv = *av_fetch(av, targ, FALSE);
11963 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11966 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11967 SV * const sv = newSV(0);
11968 *SvPVX(name) = '$';
11969 Perl_sv_catpvf(aTHX_ name, "{%s}",
11970 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11973 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11974 *SvPVX(name) = '$';
11975 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11977 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11978 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11985 =for apidoc find_uninit_var
11987 Find the name of the undefined variable (if any) that caused the operator o
11988 to issue a "Use of uninitialized value" warning.
11989 If match is true, only return a name if it's value matches uninit_sv.
11990 So roughly speaking, if a unary operator (such as OP_COS) generates a
11991 warning, then following the direct child of the op may yield an
11992 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11993 other hand, with OP_ADD there are two branches to follow, so we only print
11994 the variable name if we get an exact match.
11996 The name is returned as a mortal SV.
11998 Assumes that PL_op is the op that originally triggered the error, and that
11999 PL_comppad/PL_curpad points to the currently executing pad.
12005 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12013 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12014 uninit_sv == &PL_sv_placeholder)))
12017 switch (obase->op_type) {
12024 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12025 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12028 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12030 if (pad) { /* @lex, %lex */
12031 sv = PAD_SVl(obase->op_targ);
12035 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12036 /* @global, %global */
12037 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12040 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12042 else /* @{expr}, %{expr} */
12043 return find_uninit_var(cUNOPx(obase)->op_first,
12047 /* attempt to find a match within the aggregate */
12049 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12051 subscript_type = FUV_SUBSCRIPT_HASH;
12054 index = find_array_subscript((AV*)sv, uninit_sv);
12056 subscript_type = FUV_SUBSCRIPT_ARRAY;
12059 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12062 return varname(gv, hash ? '%' : '@', obase->op_targ,
12063 keysv, index, subscript_type);
12067 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12069 return varname(NULL, '$', obase->op_targ,
12070 NULL, 0, FUV_SUBSCRIPT_NONE);
12073 gv = cGVOPx_gv(obase);
12074 if (!gv || (match && GvSV(gv) != uninit_sv))
12076 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12079 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12082 av = (AV*)PAD_SV(obase->op_targ);
12083 if (!av || SvRMAGICAL(av))
12085 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12086 if (!svp || *svp != uninit_sv)
12089 return varname(NULL, '$', obase->op_targ,
12090 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12093 gv = cGVOPx_gv(obase);
12099 if (!av || SvRMAGICAL(av))
12101 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12102 if (!svp || *svp != uninit_sv)
12105 return varname(gv, '$', 0,
12106 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12111 o = cUNOPx(obase)->op_first;
12112 if (!o || o->op_type != OP_NULL ||
12113 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12115 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12119 if (PL_op == obase)
12120 /* $a[uninit_expr] or $h{uninit_expr} */
12121 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12124 o = cBINOPx(obase)->op_first;
12125 kid = cBINOPx(obase)->op_last;
12127 /* get the av or hv, and optionally the gv */
12129 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12130 sv = PAD_SV(o->op_targ);
12132 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12133 && cUNOPo->op_first->op_type == OP_GV)
12135 gv = cGVOPx_gv(cUNOPo->op_first);
12138 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12143 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12144 /* index is constant */
12148 if (obase->op_type == OP_HELEM) {
12149 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12150 if (!he || HeVAL(he) != uninit_sv)
12154 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12155 if (!svp || *svp != uninit_sv)
12159 if (obase->op_type == OP_HELEM)
12160 return varname(gv, '%', o->op_targ,
12161 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12163 return varname(gv, '@', o->op_targ, NULL,
12164 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12167 /* index is an expression;
12168 * attempt to find a match within the aggregate */
12169 if (obase->op_type == OP_HELEM) {
12170 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12172 return varname(gv, '%', o->op_targ,
12173 keysv, 0, FUV_SUBSCRIPT_HASH);
12176 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12178 return varname(gv, '@', o->op_targ,
12179 NULL, index, FUV_SUBSCRIPT_ARRAY);
12184 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12186 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12191 /* only examine RHS */
12192 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12195 o = cUNOPx(obase)->op_first;
12196 if (o->op_type == OP_PUSHMARK)
12199 if (!o->op_sibling) {
12200 /* one-arg version of open is highly magical */
12202 if (o->op_type == OP_GV) { /* open FOO; */
12204 if (match && GvSV(gv) != uninit_sv)
12206 return varname(gv, '$', 0,
12207 NULL, 0, FUV_SUBSCRIPT_NONE);
12209 /* other possibilities not handled are:
12210 * open $x; or open my $x; should return '${*$x}'
12211 * open expr; should return '$'.expr ideally
12217 /* ops where $_ may be an implicit arg */
12221 if ( !(obase->op_flags & OPf_STACKED)) {
12222 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12223 ? PAD_SVl(obase->op_targ)
12226 sv = sv_newmortal();
12227 sv_setpvn(sv, "$_", 2);
12236 /* skip filehandle as it can't produce 'undef' warning */
12237 o = cUNOPx(obase)->op_first;
12238 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12239 o = o->op_sibling->op_sibling;
12245 match = 1; /* XS or custom code could trigger random warnings */
12250 /* XXX tmp hack: these two may call an XS sub, and currently
12251 XS subs don't have a SUB entry on the context stack, so CV and
12252 pad determination goes wrong, and BAD things happen. So, just
12253 don't try to determine the value under those circumstances.
12254 Need a better fix at dome point. DAPM 11/2007 */
12258 /* def-ness of rval pos() is independent of the def-ness of its arg */
12259 if ( !(obase->op_flags & OPf_MOD))
12264 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12265 return newSVpvs_flags("${$/}", SVs_TEMP);
12270 if (!(obase->op_flags & OPf_KIDS))
12272 o = cUNOPx(obase)->op_first;
12278 /* if all except one arg are constant, or have no side-effects,
12279 * or are optimized away, then it's unambiguous */
12281 for (kid=o; kid; kid = kid->op_sibling) {
12283 const OPCODE type = kid->op_type;
12284 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12285 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12286 || (type == OP_PUSHMARK)
12290 if (o2) { /* more than one found */
12297 return find_uninit_var(o2, uninit_sv, match);
12299 /* scan all args */
12301 sv = find_uninit_var(o, uninit_sv, 1);
12313 =for apidoc report_uninit
12315 Print appropriate "Use of uninitialized variable" warning
12321 Perl_report_uninit(pTHX_ SV* uninit_sv)
12325 SV* varname = NULL;
12327 varname = find_uninit_var(PL_op, uninit_sv,0);
12329 sv_insert(varname, 0, 0, " ", 1);
12331 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12332 varname ? SvPV_nolen_const(varname) : "",
12333 " in ", OP_DESC(PL_op));
12336 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12342 * c-indentation-style: bsd
12343 * c-basic-offset: 4
12344 * indent-tabs-mode: t
12347 * ex: set ts=8 sts=4 sw=4 noet: