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_allocated), sizeof(struct regexp_allocated),
921 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
922 SVt_REGEXP, FALSE, NONV, HASARENA,
923 FIT_ARENA(0, sizeof(struct regexp_allocated))
927 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
934 { sizeof(xpvav_allocated),
935 copy_length(XPVAV, xmg_stash)
936 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
937 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
938 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
940 { sizeof(xpvhv_allocated),
941 copy_length(XPVHV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
943 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
944 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
947 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
948 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
949 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
951 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
952 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
953 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
955 /* XPVIO is 84 bytes, fits 48x */
956 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
957 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
960 #define new_body_type(sv_type) \
961 (void *)((char *)S_new_body(aTHX_ sv_type))
963 #define del_body_type(p, sv_type) \
964 del_body(p, &PL_body_roots[sv_type])
967 #define new_body_allocated(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type) \
969 - bodies_by_type[sv_type].offset)
971 #define del_body_allocated(p, sv_type) \
972 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
975 #define my_safemalloc(s) (void*)safemalloc(s)
976 #define my_safecalloc(s) (void*)safecalloc(s, 1)
977 #define my_safefree(p) safefree((char*)p)
981 #define new_XNV() my_safemalloc(sizeof(XPVNV))
982 #define del_XNV(p) my_safefree(p)
984 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
985 #define del_XPVNV(p) my_safefree(p)
987 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
988 #define del_XPVAV(p) my_safefree(p)
990 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
991 #define del_XPVHV(p) my_safefree(p)
993 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
994 #define del_XPVMG(p) my_safefree(p)
996 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
997 #define del_XPVGV(p) my_safefree(p)
1001 #define new_XNV() new_body_type(SVt_NV)
1002 #define del_XNV(p) del_body_type(p, SVt_NV)
1004 #define new_XPVNV() new_body_type(SVt_PVNV)
1005 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1007 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1008 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1010 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1011 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1013 #define new_XPVMG() new_body_type(SVt_PVMG)
1014 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1016 #define new_XPVGV() new_body_type(SVt_PVGV)
1017 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1021 /* no arena for you! */
1023 #define new_NOARENA(details) \
1024 my_safemalloc((details)->body_size + (details)->offset)
1025 #define new_NOARENAZ(details) \
1026 my_safecalloc((details)->body_size + (details)->offset)
1029 S_more_bodies (pTHX_ svtype sv_type)
1032 void ** const root = &PL_body_roots[sv_type];
1033 const struct body_details * const bdp = &bodies_by_type[sv_type];
1034 const size_t body_size = bdp->body_size;
1037 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1038 static bool done_sanity_check;
1040 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1041 * variables like done_sanity_check. */
1042 if (!done_sanity_check) {
1043 unsigned int i = SVt_LAST;
1045 done_sanity_check = TRUE;
1048 assert (bodies_by_type[i].type == i);
1052 assert(bdp->arena_size);
1054 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1056 end = start + bdp->arena_size - body_size;
1058 /* computed count doesnt reflect the 1st slot reservation */
1059 DEBUG_m(PerlIO_printf(Perl_debug_log,
1060 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1061 (void*)start, (void*)end,
1062 (int)bdp->arena_size, sv_type, (int)body_size,
1063 (int)bdp->arena_size / (int)body_size));
1065 *root = (void *)start;
1067 while (start < end) {
1068 char * const next = start + body_size;
1069 *(void**) start = (void *)next;
1072 *(void **)start = 0;
1077 /* grab a new thing from the free list, allocating more if necessary.
1078 The inline version is used for speed in hot routines, and the
1079 function using it serves the rest (unless PURIFY).
1081 #define new_body_inline(xpv, sv_type) \
1083 void ** const r3wt = &PL_body_roots[sv_type]; \
1084 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1085 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1086 *(r3wt) = *(void**)(xpv); \
1092 S_new_body(pTHX_ svtype sv_type)
1096 new_body_inline(xpv, sv_type);
1102 static const struct body_details fake_rv =
1103 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1106 =for apidoc sv_upgrade
1108 Upgrade an SV to a more complex form. Generally adds a new body type to the
1109 SV, then copies across as much information as possible from the old body.
1110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1116 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1121 const svtype old_type = SvTYPE(sv);
1122 const struct body_details *new_type_details;
1123 const struct body_details *old_type_details
1124 = bodies_by_type + old_type;
1125 SV *referant = NULL;
1127 if (new_type != SVt_PV && SvIsCOW(sv)) {
1128 sv_force_normal_flags(sv, 0);
1131 if (old_type == new_type)
1134 old_body = SvANY(sv);
1136 /* Copying structures onto other structures that have been neatly zeroed
1137 has a subtle gotcha. Consider XPVMG
1139 +------+------+------+------+------+-------+-------+
1140 | NV | CUR | LEN | IV | MAGIC | STASH |
1141 +------+------+------+------+------+-------+-------+
1142 0 4 8 12 16 20 24 28
1144 where NVs are aligned to 8 bytes, so that sizeof that structure is
1145 actually 32 bytes long, with 4 bytes of padding at the end:
1147 +------+------+------+------+------+-------+-------+------+
1148 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1149 +------+------+------+------+------+-------+-------+------+
1150 0 4 8 12 16 20 24 28 32
1152 so what happens if you allocate memory for this structure:
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1156 +------+------+------+------+------+-------+-------+------+------+...
1157 0 4 8 12 16 20 24 28 32 36
1159 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1160 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1161 started out as zero once, but it's quite possible that it isn't. So now,
1162 rather than a nicely zeroed GP, you have it pointing somewhere random.
1165 (In fact, GP ends up pointing at a previous GP structure, because the
1166 principle cause of the padding in XPVMG getting garbage is a copy of
1167 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1168 this happens to be moot because XPVGV has been re-ordered, with GP
1169 no longer after STASH)
1171 So we are careful and work out the size of used parts of all the
1179 referant = SvRV(sv);
1180 old_type_details = &fake_rv;
1181 if (new_type == SVt_NV)
1182 new_type = SVt_PVNV;
1184 if (new_type < SVt_PVIV) {
1185 new_type = (new_type == SVt_NV)
1186 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1196 assert(new_type > SVt_PV);
1197 assert(SVt_IV < SVt_PV);
1198 assert(SVt_NV < SVt_PV);
1205 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1206 there's no way that it can be safely upgraded, because perl.c
1207 expects to Safefree(SvANY(PL_mess_sv)) */
1208 assert(sv != PL_mess_sv);
1209 /* This flag bit is used to mean other things in other scalar types.
1210 Given that it only has meaning inside the pad, it shouldn't be set
1211 on anything that can get upgraded. */
1212 assert(!SvPAD_TYPED(sv));
1215 if (old_type_details->cant_upgrade)
1216 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1217 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1220 if (old_type > new_type)
1221 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1222 (int)old_type, (int)new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1245 assert(new_type_details->body_size);
1248 assert(new_type_details->arena);
1249 assert(new_type_details->arena_size);
1250 /* This points to the start of the allocated area. */
1251 new_body_inline(new_body, new_type);
1252 Zero(new_body, new_type_details->body_size, char);
1253 new_body = ((char *)new_body) - new_type_details->offset;
1255 /* We always allocated the full length item with PURIFY. To do this
1256 we fake things so that arena is false for all 16 types.. */
1257 new_body = new_NOARENAZ(new_type_details);
1259 SvANY(sv) = new_body;
1260 if (new_type == SVt_PVAV) {
1264 if (old_type_details->body_size) {
1267 /* It will have been zeroed when the new body was allocated.
1268 Lets not write to it, in case it confuses a write-back
1274 #ifndef NODEFAULT_SHAREKEYS
1275 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1277 HvMAX(sv) = 7; /* (start with 8 buckets) */
1278 if (old_type_details->body_size) {
1281 /* It will have been zeroed when the new body was allocated.
1282 Lets not write to it, in case it confuses a write-back
1287 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1288 The target created by newSVrv also is, and it can have magic.
1289 However, it never has SvPVX set.
1291 if (old_type == SVt_IV) {
1293 } else if (old_type >= SVt_PV) {
1294 assert(SvPVX_const(sv) == 0);
1297 if (old_type >= SVt_PVMG) {
1298 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1299 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1301 sv->sv_u.svu_array = NULL; /* or svu_hash */
1307 /* XXX Is this still needed? Was it ever needed? Surely as there is
1308 no route from NV to PVIV, NOK can never be true */
1309 assert(!SvNOKp(sv));
1321 assert(new_type_details->body_size);
1322 /* We always allocated the full length item with PURIFY. To do this
1323 we fake things so that arena is false for all 16 types.. */
1324 if(new_type_details->arena) {
1325 /* This points to the start of the allocated area. */
1326 new_body_inline(new_body, new_type);
1327 Zero(new_body, new_type_details->body_size, char);
1328 new_body = ((char *)new_body) - new_type_details->offset;
1330 new_body = new_NOARENAZ(new_type_details);
1332 SvANY(sv) = new_body;
1334 if (old_type_details->copy) {
1335 /* There is now the potential for an upgrade from something without
1336 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1337 int offset = old_type_details->offset;
1338 int length = old_type_details->copy;
1340 if (new_type_details->offset > old_type_details->offset) {
1341 const int difference
1342 = new_type_details->offset - old_type_details->offset;
1343 offset += difference;
1344 length -= difference;
1346 assert (length >= 0);
1348 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354 * correct 0.0 for us. Otherwise, if the old body didn't have an
1355 * NV slot, but the new one does, then we need to initialise the
1356 * freshly created NV slot with whatever the correct bit pattern is
1358 if (old_type_details->zero_nv && !new_type_details->zero_nv
1359 && !isGV_with_GP(sv))
1363 if (new_type == SVt_PVIO)
1364 IoPAGE_LEN(sv) = 60;
1365 if (old_type < SVt_PV) {
1366 /* referant will be NULL unless the old type was SVt_IV emulating
1368 sv->sv_u.svu_rv = referant;
1372 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1373 (unsigned long)new_type);
1376 if (old_type_details->arena) {
1377 /* If there was an old body, then we need to free it.
1378 Note that there is an assumption that all bodies of types that
1379 can be upgraded came from arenas. Only the more complex non-
1380 upgradable types are allowed to be directly malloc()ed. */
1382 my_safefree(old_body);
1384 del_body((void*)((char*)old_body + old_type_details->offset),
1385 &PL_body_roots[old_type]);
1391 =for apidoc sv_backoff
1393 Remove any string offset. You should normally use the C<SvOOK_off> macro
1400 Perl_sv_backoff(pTHX_ register SV *sv)
1403 const char * const s = SvPVX_const(sv);
1404 PERL_UNUSED_CONTEXT;
1406 assert(SvTYPE(sv) != SVt_PVHV);
1407 assert(SvTYPE(sv) != SVt_PVAV);
1409 SvOOK_offset(sv, delta);
1411 SvLEN_set(sv, SvLEN(sv) + delta);
1412 SvPV_set(sv, SvPVX(sv) - delta);
1413 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1414 SvFLAGS(sv) &= ~SVf_OOK;
1421 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1422 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1423 Use the C<SvGROW> wrapper instead.
1429 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1433 if (PL_madskills && newlen >= 0x100000) {
1434 PerlIO_printf(Perl_debug_log,
1435 "Allocation too large: %"UVxf"\n", (UV)newlen);
1437 #ifdef HAS_64K_LIMIT
1438 if (newlen >= 0x10000) {
1439 PerlIO_printf(Perl_debug_log,
1440 "Allocation too large: %"UVxf"\n", (UV)newlen);
1443 #endif /* HAS_64K_LIMIT */
1446 if (SvTYPE(sv) < SVt_PV) {
1447 sv_upgrade(sv, SVt_PV);
1448 s = SvPVX_mutable(sv);
1450 else if (SvOOK(sv)) { /* pv is offset? */
1452 s = SvPVX_mutable(sv);
1453 if (newlen > SvLEN(sv))
1454 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1455 #ifdef HAS_64K_LIMIT
1456 if (newlen >= 0x10000)
1461 s = SvPVX_mutable(sv);
1463 if (newlen > SvLEN(sv)) { /* need more room? */
1464 newlen = PERL_STRLEN_ROUNDUP(newlen);
1465 if (SvLEN(sv) && s) {
1467 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1473 s = (char*)saferealloc(s, newlen);
1476 s = (char*)safemalloc(newlen);
1477 if (SvPVX_const(sv) && SvCUR(sv)) {
1478 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1482 SvLEN_set(sv, newlen);
1488 =for apidoc sv_setiv
1490 Copies an integer into the given SV, upgrading first if necessary.
1491 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1497 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1500 SV_CHECK_THINKFIRST_COW_DROP(sv);
1501 switch (SvTYPE(sv)) {
1504 sv_upgrade(sv, SVt_IV);
1507 sv_upgrade(sv, SVt_PVIV);
1516 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1520 (void)SvIOK_only(sv); /* validate number */
1526 =for apidoc sv_setiv_mg
1528 Like C<sv_setiv>, but also handles 'set' magic.
1534 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1541 =for apidoc sv_setuv
1543 Copies an unsigned integer into the given SV, upgrading first if necessary.
1544 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1550 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1552 /* With these two if statements:
1553 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1556 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1558 If you wish to remove them, please benchmark to see what the effect is
1560 if (u <= (UV)IV_MAX) {
1561 sv_setiv(sv, (IV)u);
1570 =for apidoc sv_setuv_mg
1572 Like C<sv_setuv>, but also handles 'set' magic.
1578 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1585 =for apidoc sv_setnv
1587 Copies a double into the given SV, upgrading first if necessary.
1588 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1594 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1597 SV_CHECK_THINKFIRST_COW_DROP(sv);
1598 switch (SvTYPE(sv)) {
1601 sv_upgrade(sv, SVt_NV);
1605 sv_upgrade(sv, SVt_PVNV);
1614 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1619 (void)SvNOK_only(sv); /* validate number */
1624 =for apidoc sv_setnv_mg
1626 Like C<sv_setnv>, but also handles 'set' magic.
1632 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1638 /* Print an "isn't numeric" warning, using a cleaned-up,
1639 * printable version of the offending string
1643 S_not_a_number(pTHX_ SV *sv)
1651 dsv = newSVpvs_flags("", SVs_TEMP);
1652 pv = sv_uni_display(dsv, sv, 10, 0);
1655 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1656 /* each *s can expand to 4 chars + "...\0",
1657 i.e. need room for 8 chars */
1659 const char *s = SvPVX_const(sv);
1660 const char * const end = s + SvCUR(sv);
1661 for ( ; s < end && d < limit; s++ ) {
1663 if (ch & 128 && !isPRINT_LC(ch)) {
1672 else if (ch == '\r') {
1676 else if (ch == '\f') {
1680 else if (ch == '\\') {
1684 else if (ch == '\0') {
1688 else if (isPRINT_LC(ch))
1705 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706 "Argument \"%s\" isn't numeric in %s", pv,
1709 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1710 "Argument \"%s\" isn't numeric", pv);
1714 =for apidoc looks_like_number
1716 Test if the content of an SV looks like a number (or is a number).
1717 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1718 non-numeric warning), even if your atof() doesn't grok them.
1724 Perl_looks_like_number(pTHX_ SV *sv)
1726 register const char *sbegin;
1730 sbegin = SvPVX_const(sv);
1733 else if (SvPOKp(sv))
1734 sbegin = SvPV_const(sv, len);
1736 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1737 return grok_number(sbegin, len, NULL);
1741 S_glob_2number(pTHX_ GV * const gv)
1743 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1744 SV *const buffer = sv_newmortal();
1746 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1749 gv_efullname3(buffer, gv, "*");
1750 SvFLAGS(gv) |= wasfake;
1752 /* We know that all GVs stringify to something that is not-a-number,
1753 so no need to test that. */
1754 if (ckWARN(WARN_NUMERIC))
1755 not_a_number(buffer);
1756 /* We just want something true to return, so that S_sv_2iuv_common
1757 can tail call us and return true. */
1762 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1764 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1765 SV *const buffer = sv_newmortal();
1767 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1770 gv_efullname3(buffer, gv, "*");
1771 SvFLAGS(gv) |= wasfake;
1773 assert(SvPOK(buffer));
1775 *len = SvCUR(buffer);
1777 return SvPVX(buffer);
1780 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1781 until proven guilty, assume that things are not that bad... */
1786 As 64 bit platforms often have an NV that doesn't preserve all bits of
1787 an IV (an assumption perl has been based on to date) it becomes necessary
1788 to remove the assumption that the NV always carries enough precision to
1789 recreate the IV whenever needed, and that the NV is the canonical form.
1790 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1791 precision as a side effect of conversion (which would lead to insanity
1792 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1793 1) to distinguish between IV/UV/NV slots that have cached a valid
1794 conversion where precision was lost and IV/UV/NV slots that have a
1795 valid conversion which has lost no precision
1796 2) to ensure that if a numeric conversion to one form is requested that
1797 would lose precision, the precise conversion (or differently
1798 imprecise conversion) is also performed and cached, to prevent
1799 requests for different numeric formats on the same SV causing
1800 lossy conversion chains. (lossless conversion chains are perfectly
1805 SvIOKp is true if the IV slot contains a valid value
1806 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1807 SvNOKp is true if the NV slot contains a valid value
1808 SvNOK is true only if the NV value is accurate
1811 while converting from PV to NV, check to see if converting that NV to an
1812 IV(or UV) would lose accuracy over a direct conversion from PV to
1813 IV(or UV). If it would, cache both conversions, return NV, but mark
1814 SV as IOK NOKp (ie not NOK).
1816 While converting from PV to IV, check to see if converting that IV to an
1817 NV would lose accuracy over a direct conversion from PV to NV. If it
1818 would, cache both conversions, flag similarly.
1820 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1821 correctly because if IV & NV were set NV *always* overruled.
1822 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1823 changes - now IV and NV together means that the two are interchangeable:
1824 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1826 The benefit of this is that operations such as pp_add know that if
1827 SvIOK is true for both left and right operands, then integer addition
1828 can be used instead of floating point (for cases where the result won't
1829 overflow). Before, floating point was always used, which could lead to
1830 loss of precision compared with integer addition.
1832 * making IV and NV equal status should make maths accurate on 64 bit
1834 * may speed up maths somewhat if pp_add and friends start to use
1835 integers when possible instead of fp. (Hopefully the overhead in
1836 looking for SvIOK and checking for overflow will not outweigh the
1837 fp to integer speedup)
1838 * will slow down integer operations (callers of SvIV) on "inaccurate"
1839 values, as the change from SvIOK to SvIOKp will cause a call into
1840 sv_2iv each time rather than a macro access direct to the IV slot
1841 * should speed up number->string conversion on integers as IV is
1842 favoured when IV and NV are equally accurate
1844 ####################################################################
1845 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1846 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1847 On the other hand, SvUOK is true iff UV.
1848 ####################################################################
1850 Your mileage will vary depending your CPU's relative fp to integer
1854 #ifndef NV_PRESERVES_UV
1855 # define IS_NUMBER_UNDERFLOW_IV 1
1856 # define IS_NUMBER_UNDERFLOW_UV 2
1857 # define IS_NUMBER_IV_AND_UV 2
1858 # define IS_NUMBER_OVERFLOW_IV 4
1859 # define IS_NUMBER_OVERFLOW_UV 5
1861 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1863 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1865 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1868 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1869 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));
1870 if (SvNVX(sv) < (NV)IV_MIN) {
1871 (void)SvIOKp_on(sv);
1873 SvIV_set(sv, IV_MIN);
1874 return IS_NUMBER_UNDERFLOW_IV;
1876 if (SvNVX(sv) > (NV)UV_MAX) {
1877 (void)SvIOKp_on(sv);
1880 SvUV_set(sv, UV_MAX);
1881 return IS_NUMBER_OVERFLOW_UV;
1883 (void)SvIOKp_on(sv);
1885 /* Can't use strtol etc to convert this string. (See truth table in
1887 if (SvNVX(sv) <= (UV)IV_MAX) {
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1890 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1892 /* Integer is imprecise. NOK, IOKp */
1894 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1897 SvUV_set(sv, U_V(SvNVX(sv)));
1898 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1899 if (SvUVX(sv) == UV_MAX) {
1900 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1901 possibly be preserved by NV. Hence, it must be overflow.
1903 return IS_NUMBER_OVERFLOW_UV;
1905 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1907 /* Integer is imprecise. NOK, IOKp */
1909 return IS_NUMBER_OVERFLOW_IV;
1911 #endif /* !NV_PRESERVES_UV*/
1914 S_sv_2iuv_common(pTHX_ SV *sv) {
1917 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1918 * without also getting a cached IV/UV from it at the same time
1919 * (ie PV->NV conversion should detect loss of accuracy and cache
1920 * IV or UV at same time to avoid this. */
1921 /* IV-over-UV optimisation - choose to cache IV if possible */
1923 if (SvTYPE(sv) == SVt_NV)
1924 sv_upgrade(sv, SVt_PVNV);
1926 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1927 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1928 certainly cast into the IV range at IV_MAX, whereas the correct
1929 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1931 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1932 if (Perl_isnan(SvNVX(sv))) {
1938 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1939 SvIV_set(sv, I_V(SvNVX(sv)));
1940 if (SvNVX(sv) == (NV) SvIVX(sv)
1941 #ifndef NV_PRESERVES_UV
1942 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1943 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1944 /* Don't flag it as "accurately an integer" if the number
1945 came from a (by definition imprecise) NV operation, and
1946 we're outside the range of NV integer precision */
1950 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1952 /* scalar has trailing garbage, eg "42a" */
1954 DEBUG_c(PerlIO_printf(Perl_debug_log,
1955 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1961 /* IV not precise. No need to convert from PV, as NV
1962 conversion would already have cached IV if it detected
1963 that PV->IV would be better than PV->NV->IV
1964 flags already correct - don't set public IOK. */
1965 DEBUG_c(PerlIO_printf(Perl_debug_log,
1966 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1971 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1972 but the cast (NV)IV_MIN rounds to a the value less (more
1973 negative) than IV_MIN which happens to be equal to SvNVX ??
1974 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1975 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1976 (NV)UVX == NVX are both true, but the values differ. :-(
1977 Hopefully for 2s complement IV_MIN is something like
1978 0x8000000000000000 which will be exact. NWC */
1981 SvUV_set(sv, U_V(SvNVX(sv)));
1983 (SvNVX(sv) == (NV) SvUVX(sv))
1984 #ifndef NV_PRESERVES_UV
1985 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1986 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1987 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1988 /* Don't flag it as "accurately an integer" if the number
1989 came from a (by definition imprecise) NV operation, and
1990 we're outside the range of NV integer precision */
1996 DEBUG_c(PerlIO_printf(Perl_debug_log,
1997 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2003 else if (SvPOKp(sv) && SvLEN(sv)) {
2005 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2006 /* We want to avoid a possible problem when we cache an IV/ a UV which
2007 may be later translated to an NV, and the resulting NV is not
2008 the same as the direct translation of the initial string
2009 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2010 be careful to ensure that the value with the .456 is around if the
2011 NV value is requested in the future).
2013 This means that if we cache such an IV/a UV, we need to cache the
2014 NV as well. Moreover, we trade speed for space, and do not
2015 cache the NV if we are sure it's not needed.
2018 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2019 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2020 == IS_NUMBER_IN_UV) {
2021 /* It's definitely an integer, only upgrade to PVIV */
2022 if (SvTYPE(sv) < SVt_PVIV)
2023 sv_upgrade(sv, SVt_PVIV);
2025 } else if (SvTYPE(sv) < SVt_PVNV)
2026 sv_upgrade(sv, SVt_PVNV);
2028 /* If NVs preserve UVs then we only use the UV value if we know that
2029 we aren't going to call atof() below. If NVs don't preserve UVs
2030 then the value returned may have more precision than atof() will
2031 return, even though value isn't perfectly accurate. */
2032 if ((numtype & (IS_NUMBER_IN_UV
2033 #ifdef NV_PRESERVES_UV
2036 )) == IS_NUMBER_IN_UV) {
2037 /* This won't turn off the public IOK flag if it was set above */
2038 (void)SvIOKp_on(sv);
2040 if (!(numtype & IS_NUMBER_NEG)) {
2042 if (value <= (UV)IV_MAX) {
2043 SvIV_set(sv, (IV)value);
2045 /* it didn't overflow, and it was positive. */
2046 SvUV_set(sv, value);
2050 /* 2s complement assumption */
2051 if (value <= (UV)IV_MIN) {
2052 SvIV_set(sv, -(IV)value);
2054 /* Too negative for an IV. This is a double upgrade, but
2055 I'm assuming it will be rare. */
2056 if (SvTYPE(sv) < SVt_PVNV)
2057 sv_upgrade(sv, SVt_PVNV);
2061 SvNV_set(sv, -(NV)value);
2062 SvIV_set(sv, IV_MIN);
2066 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2067 will be in the previous block to set the IV slot, and the next
2068 block to set the NV slot. So no else here. */
2070 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071 != IS_NUMBER_IN_UV) {
2072 /* It wasn't an (integer that doesn't overflow the UV). */
2073 SvNV_set(sv, Atof(SvPVX_const(sv)));
2075 if (! numtype && ckWARN(WARN_NUMERIC))
2078 #if defined(USE_LONG_DOUBLE)
2079 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2080 PTR2UV(sv), SvNVX(sv)));
2082 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2083 PTR2UV(sv), SvNVX(sv)));
2086 #ifdef NV_PRESERVES_UV
2087 (void)SvIOKp_on(sv);
2089 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2094 NOOP; /* Integer is imprecise. NOK, IOKp */
2096 /* UV will not work better than IV */
2098 if (SvNVX(sv) > (NV)UV_MAX) {
2100 /* Integer is inaccurate. NOK, IOKp, is UV */
2101 SvUV_set(sv, UV_MAX);
2103 SvUV_set(sv, U_V(SvNVX(sv)));
2104 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2105 NV preservse UV so can do correct comparison. */
2106 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2109 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2114 #else /* NV_PRESERVES_UV */
2115 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2116 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2117 /* The IV/UV slot will have been set from value returned by
2118 grok_number above. The NV slot has just been set using
2121 assert (SvIOKp(sv));
2123 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2124 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2125 /* Small enough to preserve all bits. */
2126 (void)SvIOKp_on(sv);
2128 SvIV_set(sv, I_V(SvNVX(sv)));
2129 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2131 /* Assumption: first non-preserved integer is < IV_MAX,
2132 this NV is in the preserved range, therefore: */
2133 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2135 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);
2139 0 0 already failed to read UV.
2140 0 1 already failed to read UV.
2141 1 0 you won't get here in this case. IV/UV
2142 slot set, public IOK, Atof() unneeded.
2143 1 1 already read UV.
2144 so there's no point in sv_2iuv_non_preserve() attempting
2145 to use atol, strtol, strtoul etc. */
2146 sv_2iuv_non_preserve (sv, numtype);
2149 #endif /* NV_PRESERVES_UV */
2150 /* It might be more code efficient to go through the entire logic above
2151 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2152 gets complex and potentially buggy, so more programmer efficient
2153 to do it this way, by turning off the public flags: */
2155 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2159 if (isGV_with_GP(sv))
2160 return glob_2number((GV *)sv);
2162 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2163 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2166 if (SvTYPE(sv) < SVt_IV)
2167 /* Typically the caller expects that sv_any is not NULL now. */
2168 sv_upgrade(sv, SVt_IV);
2169 /* Return 0 from the caller. */
2176 =for apidoc sv_2iv_flags
2178 Return the integer value of an SV, doing any necessary string
2179 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2180 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2186 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2191 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2192 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2193 cache IVs just in case. In practice it seems that they never
2194 actually anywhere accessible by user Perl code, let alone get used
2195 in anything other than a string context. */
2196 if (flags & SV_GMAGIC)
2201 return I_V(SvNVX(sv));
2203 if (SvPOKp(sv) && SvLEN(sv)) {
2206 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 == IS_NUMBER_IN_UV) {
2210 /* It's definitely an integer */
2211 if (numtype & IS_NUMBER_NEG) {
2212 if (value < (UV)IV_MIN)
2215 if (value < (UV)IV_MAX)
2220 if (ckWARN(WARN_NUMERIC))
2223 return I_V(Atof(SvPVX_const(sv)));
2228 assert(SvTYPE(sv) >= SVt_PVMG);
2229 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2230 } else if (SvTHINKFIRST(sv)) {
2234 SV * const tmpstr=AMG_CALLun(sv,numer);
2235 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2236 return SvIV(tmpstr);
2239 return PTR2IV(SvRV(sv));
2242 sv_force_normal_flags(sv, 0);
2244 if (SvREADONLY(sv) && !SvOK(sv)) {
2245 if (ckWARN(WARN_UNINITIALIZED))
2251 if (S_sv_2iuv_common(aTHX_ sv))
2254 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2255 PTR2UV(sv),SvIVX(sv)));
2256 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2260 =for apidoc sv_2uv_flags
2262 Return the unsigned integer value of an SV, doing any necessary string
2263 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2264 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2270 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2275 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2276 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2277 cache IVs just in case. */
2278 if (flags & SV_GMAGIC)
2283 return U_V(SvNVX(sv));
2284 if (SvPOKp(sv) && SvLEN(sv)) {
2287 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2289 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290 == IS_NUMBER_IN_UV) {
2291 /* It's definitely an integer */
2292 if (!(numtype & IS_NUMBER_NEG))
2296 if (ckWARN(WARN_NUMERIC))
2299 return U_V(Atof(SvPVX_const(sv)));
2304 assert(SvTYPE(sv) >= SVt_PVMG);
2305 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2306 } else if (SvTHINKFIRST(sv)) {
2310 SV *const tmpstr = AMG_CALLun(sv,numer);
2311 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2312 return SvUV(tmpstr);
2315 return PTR2UV(SvRV(sv));
2318 sv_force_normal_flags(sv, 0);
2320 if (SvREADONLY(sv) && !SvOK(sv)) {
2321 if (ckWARN(WARN_UNINITIALIZED))
2327 if (S_sv_2iuv_common(aTHX_ sv))
2331 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2332 PTR2UV(sv),SvUVX(sv)));
2333 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2339 Return the num value of an SV, doing any necessary string or integer
2340 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2347 Perl_sv_2nv(pTHX_ register SV *sv)
2352 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2353 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2354 cache IVs just in case. */
2358 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2359 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2360 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2362 return Atof(SvPVX_const(sv));
2366 return (NV)SvUVX(sv);
2368 return (NV)SvIVX(sv);
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit near the end of the
2376 } else if (SvTHINKFIRST(sv)) {
2380 SV *const tmpstr = AMG_CALLun(sv,numer);
2381 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2382 return SvNV(tmpstr);
2385 return PTR2NV(SvRV(sv));
2388 sv_force_normal_flags(sv, 0);
2390 if (SvREADONLY(sv) && !SvOK(sv)) {
2391 if (ckWARN(WARN_UNINITIALIZED))
2396 if (SvTYPE(sv) < SVt_NV) {
2397 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2398 sv_upgrade(sv, SVt_NV);
2399 #ifdef USE_LONG_DOUBLE
2401 STORE_NUMERIC_LOCAL_SET_STANDARD();
2402 PerlIO_printf(Perl_debug_log,
2403 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2404 PTR2UV(sv), SvNVX(sv));
2405 RESTORE_NUMERIC_LOCAL();
2409 STORE_NUMERIC_LOCAL_SET_STANDARD();
2410 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2411 PTR2UV(sv), SvNVX(sv));
2412 RESTORE_NUMERIC_LOCAL();
2416 else if (SvTYPE(sv) < SVt_PVNV)
2417 sv_upgrade(sv, SVt_PVNV);
2422 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2423 #ifdef NV_PRESERVES_UV
2429 /* Only set the public NV OK flag if this NV preserves the IV */
2430 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2432 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2433 : (SvIVX(sv) == I_V(SvNVX(sv))))
2439 else if (SvPOKp(sv) && SvLEN(sv)) {
2441 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2442 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2444 #ifdef NV_PRESERVES_UV
2445 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2446 == IS_NUMBER_IN_UV) {
2447 /* It's definitely an integer */
2448 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2450 SvNV_set(sv, Atof(SvPVX_const(sv)));
2456 SvNV_set(sv, Atof(SvPVX_const(sv)));
2457 /* Only set the public NV OK flag if this NV preserves the value in
2458 the PV at least as well as an IV/UV would.
2459 Not sure how to do this 100% reliably. */
2460 /* if that shift count is out of range then Configure's test is
2461 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2463 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2464 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2465 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2466 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2467 /* Can't use strtol etc to convert this string, so don't try.
2468 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2471 /* value has been set. It may not be precise. */
2472 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2473 /* 2s complement assumption for (UV)IV_MIN */
2474 SvNOK_on(sv); /* Integer is too negative. */
2479 if (numtype & IS_NUMBER_NEG) {
2480 SvIV_set(sv, -(IV)value);
2481 } else if (value <= (UV)IV_MAX) {
2482 SvIV_set(sv, (IV)value);
2484 SvUV_set(sv, value);
2488 if (numtype & IS_NUMBER_NOT_INT) {
2489 /* I believe that even if the original PV had decimals,
2490 they are lost beyond the limit of the FP precision.
2491 However, neither is canonical, so both only get p
2492 flags. NWC, 2000/11/25 */
2493 /* Both already have p flags, so do nothing */
2495 const NV nv = SvNVX(sv);
2496 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2497 if (SvIVX(sv) == I_V(nv)) {
2500 /* It had no "." so it must be integer. */
2504 /* between IV_MAX and NV(UV_MAX).
2505 Could be slightly > UV_MAX */
2507 if (numtype & IS_NUMBER_NOT_INT) {
2508 /* UV and NV both imprecise. */
2510 const UV nv_as_uv = U_V(nv);
2512 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2521 /* It might be more code efficient to go through the entire logic above
2522 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2523 gets complex and potentially buggy, so more programmer efficient
2524 to do it this way, by turning off the public flags: */
2526 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2527 #endif /* NV_PRESERVES_UV */
2530 if (isGV_with_GP(sv)) {
2531 glob_2number((GV *)sv);
2535 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2537 assert (SvTYPE(sv) >= SVt_NV);
2538 /* Typically the caller expects that sv_any is not NULL now. */
2539 /* XXX Ilya implies that this is a bug in callers that assume this
2540 and ideally should be fixed. */
2543 #if defined(USE_LONG_DOUBLE)
2545 STORE_NUMERIC_LOCAL_SET_STANDARD();
2546 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2547 PTR2UV(sv), SvNVX(sv));
2548 RESTORE_NUMERIC_LOCAL();
2552 STORE_NUMERIC_LOCAL_SET_STANDARD();
2553 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2554 PTR2UV(sv), SvNVX(sv));
2555 RESTORE_NUMERIC_LOCAL();
2564 Return an SV with the numeric value of the source SV, doing any necessary
2565 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2566 access this function.
2572 Perl_sv_2num(pTHX_ register SV *sv)
2577 SV * const tmpsv = AMG_CALLun(sv,numer);
2578 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2579 return sv_2num(tmpsv);
2581 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2584 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2585 * UV as a string towards the end of buf, and return pointers to start and
2588 * We assume that buf is at least TYPE_CHARS(UV) long.
2592 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2594 char *ptr = buf + TYPE_CHARS(UV);
2595 char * const ebuf = ptr;
2608 *--ptr = '0' + (char)(uv % 10);
2617 =for apidoc sv_2pv_flags
2619 Returns a pointer to the string value of an SV, and sets *lp to its length.
2620 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2622 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2623 usually end up here too.
2629 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2639 if (SvGMAGICAL(sv)) {
2640 if (flags & SV_GMAGIC)
2645 if (flags & SV_MUTABLE_RETURN)
2646 return SvPVX_mutable(sv);
2647 if (flags & SV_CONST_RETURN)
2648 return (char *)SvPVX_const(sv);
2651 if (SvIOKp(sv) || SvNOKp(sv)) {
2652 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2657 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2658 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2660 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2667 #ifdef FIXNEGATIVEZERO
2668 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2674 SvUPGRADE(sv, SVt_PV);
2677 s = SvGROW_mutable(sv, len + 1);
2680 return (char*)memcpy(s, tbuf, len + 1);
2686 assert(SvTYPE(sv) >= SVt_PVMG);
2687 /* This falls through to the report_uninit near the end of the
2689 } else if (SvTHINKFIRST(sv)) {
2693 SV *const tmpstr = AMG_CALLun(sv,string);
2694 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2696 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2700 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2701 if (flags & SV_CONST_RETURN) {
2702 pv = (char *) SvPVX_const(tmpstr);
2704 pv = (flags & SV_MUTABLE_RETURN)
2705 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2708 *lp = SvCUR(tmpstr);
2710 pv = sv_2pv_flags(tmpstr, lp, flags);
2723 const SV *const referent = (SV*)SvRV(sv);
2727 retval = buffer = savepvn("NULLREF", len);
2728 } else if (SvTYPE(referent) == SVt_REGEXP) {
2733 /* FIXME - get rid of this cast away of const, or work out
2734 how to do it better. */
2735 temp.mg_obj = (SV *)referent;
2736 assert(temp.mg_obj);
2737 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2742 PL_reginterp_cnt += haseval;
2745 const char *const typestr = sv_reftype(referent, 0);
2746 const STRLEN typelen = strlen(typestr);
2747 UV addr = PTR2UV(referent);
2748 const char *stashname = NULL;
2749 STRLEN stashnamelen = 0; /* hush, gcc */
2750 const char *buffer_end;
2752 if (SvOBJECT(referent)) {
2753 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2756 stashname = HEK_KEY(name);
2757 stashnamelen = HEK_LEN(name);
2759 if (HEK_UTF8(name)) {
2765 stashname = "__ANON__";
2768 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2769 + 2 * sizeof(UV) + 2 /* )\0 */;
2771 len = typelen + 3 /* (0x */
2772 + 2 * sizeof(UV) + 2 /* )\0 */;
2775 Newx(buffer, len, char);
2776 buffer_end = retval = buffer + len;
2778 /* Working backwards */
2782 *--retval = PL_hexdigit[addr & 15];
2783 } while (addr >>= 4);
2789 memcpy(retval, typestr, typelen);
2793 retval -= stashnamelen;
2794 memcpy(retval, stashname, stashnamelen);
2796 /* retval may not neccesarily have reached the start of the
2798 assert (retval >= buffer);
2800 len = buffer_end - retval - 1; /* -1 for that \0 */
2808 if (SvREADONLY(sv) && !SvOK(sv)) {
2809 if (ckWARN(WARN_UNINITIALIZED))
2816 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2817 /* I'm assuming that if both IV and NV are equally valid then
2818 converting the IV is going to be more efficient */
2819 const U32 isUIOK = SvIsUV(sv);
2820 char buf[TYPE_CHARS(UV)];
2824 if (SvTYPE(sv) < SVt_PVIV)
2825 sv_upgrade(sv, SVt_PVIV);
2826 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2828 /* inlined from sv_setpvn */
2829 s = SvGROW_mutable(sv, len + 1);
2830 Move(ptr, s, len, char);
2834 else if (SvNOKp(sv)) {
2835 const int olderrno = errno;
2836 if (SvTYPE(sv) < SVt_PVNV)
2837 sv_upgrade(sv, SVt_PVNV);
2838 /* The +20 is pure guesswork. Configure test needed. --jhi */
2839 s = SvGROW_mutable(sv, NV_DIG + 20);
2840 /* some Xenix systems wipe out errno here */
2842 if (SvNVX(sv) == 0.0)
2843 my_strlcpy(s, "0", SvLEN(sv));
2847 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2850 #ifdef FIXNEGATIVEZERO
2851 if (*s == '-' && s[1] == '0' && !s[2]) {
2863 if (isGV_with_GP(sv))
2864 return glob_2pv((GV *)sv, lp);
2866 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2870 if (SvTYPE(sv) < SVt_PV)
2871 /* Typically the caller expects that sv_any is not NULL now. */
2872 sv_upgrade(sv, SVt_PV);
2876 const STRLEN len = s - SvPVX_const(sv);
2882 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2883 PTR2UV(sv),SvPVX_const(sv)));
2884 if (flags & SV_CONST_RETURN)
2885 return (char *)SvPVX_const(sv);
2886 if (flags & SV_MUTABLE_RETURN)
2887 return SvPVX_mutable(sv);
2892 =for apidoc sv_copypv
2894 Copies a stringified representation of the source SV into the
2895 destination SV. Automatically performs any necessary mg_get and
2896 coercion of numeric values into strings. Guaranteed to preserve
2897 UTF8 flag even from overloaded objects. Similar in nature to
2898 sv_2pv[_flags] but operates directly on an SV instead of just the
2899 string. Mostly uses sv_2pv_flags to do its work, except when that
2900 would lose the UTF-8'ness of the PV.
2906 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2909 const char * const s = SvPV_const(ssv,len);
2910 sv_setpvn(dsv,s,len);
2918 =for apidoc sv_2pvbyte
2920 Return a pointer to the byte-encoded representation of the SV, and set *lp
2921 to its length. May cause the SV to be downgraded from UTF-8 as a
2924 Usually accessed via the C<SvPVbyte> macro.
2930 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2932 sv_utf8_downgrade(sv,0);
2933 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2937 =for apidoc sv_2pvutf8
2939 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2940 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2942 Usually accessed via the C<SvPVutf8> macro.
2948 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2950 sv_utf8_upgrade(sv);
2951 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2956 =for apidoc sv_2bool
2958 This function is only called on magical items, and is only used by
2959 sv_true() or its macro equivalent.
2965 Perl_sv_2bool(pTHX_ register SV *sv)
2974 SV * const tmpsv = AMG_CALLun(sv,bool_);
2975 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2976 return (bool)SvTRUE(tmpsv);
2978 return SvRV(sv) != 0;
2981 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2983 (*sv->sv_u.svu_pv > '0' ||
2984 Xpvtmp->xpv_cur > 1 ||
2985 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2992 return SvIVX(sv) != 0;
2995 return SvNVX(sv) != 0.0;
2997 if (isGV_with_GP(sv))
3007 =for apidoc sv_utf8_upgrade
3009 Converts the PV of an SV to its UTF-8-encoded form.
3010 Forces the SV to string form if it is not already.
3011 Always sets the SvUTF8 flag to avoid future validity checks even
3012 if all the bytes have hibit clear.
3014 This is not as a general purpose byte encoding to Unicode interface:
3015 use the Encode extension for that.
3017 =for apidoc sv_utf8_upgrade_flags
3019 Converts the PV of an SV to its UTF-8-encoded form.
3020 Forces the SV to string form if it is not already.
3021 Always sets the SvUTF8 flag to avoid future validity checks even
3022 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3023 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3024 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3026 This is not as a general purpose byte encoding to Unicode interface:
3027 use the Encode extension for that.
3033 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3036 if (sv == &PL_sv_undef)
3040 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3041 (void) sv_2pv_flags(sv,&len, flags);
3045 (void) SvPV_force(sv,len);
3054 sv_force_normal_flags(sv, 0);
3057 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3058 sv_recode_to_utf8(sv, PL_encoding);
3059 else { /* Assume Latin-1/EBCDIC */
3060 /* This function could be much more efficient if we
3061 * had a FLAG in SVs to signal if there are any hibit
3062 * chars in the PV. Given that there isn't such a flag
3063 * make the loop as fast as possible. */
3064 const U8 * const s = (U8 *) SvPVX_const(sv);
3065 const U8 * const e = (U8 *) SvEND(sv);
3070 /* Check for hi bit */
3071 if (!NATIVE_IS_INVARIANT(ch)) {
3072 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3073 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3075 SvPV_free(sv); /* No longer using what was there before. */
3076 SvPV_set(sv, (char*)recoded);
3077 SvCUR_set(sv, len - 1);
3078 SvLEN_set(sv, len); /* No longer know the real size. */
3082 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3089 =for apidoc sv_utf8_downgrade
3091 Attempts to convert the PV of an SV from characters to bytes.
3092 If the PV contains a character beyond byte, this conversion will fail;
3093 in this case, either returns false or, if C<fail_ok> is not
3096 This is not as a general purpose Unicode to byte encoding interface:
3097 use the Encode extension for that.
3103 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3106 if (SvPOKp(sv) && SvUTF8(sv)) {
3112 sv_force_normal_flags(sv, 0);
3114 s = (U8 *) SvPV(sv, len);
3115 if (!utf8_to_bytes(s, &len)) {
3120 Perl_croak(aTHX_ "Wide character in %s",
3123 Perl_croak(aTHX_ "Wide character");
3134 =for apidoc sv_utf8_encode
3136 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3137 flag off so that it looks like octets again.
3143 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3146 sv_force_normal_flags(sv, 0);
3148 if (SvREADONLY(sv)) {
3149 Perl_croak(aTHX_ PL_no_modify);
3151 (void) sv_utf8_upgrade(sv);
3156 =for apidoc sv_utf8_decode
3158 If the PV of the SV is an octet sequence in UTF-8
3159 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3160 so that it looks like a character. If the PV contains only single-byte
3161 characters, the C<SvUTF8> flag stays being off.
3162 Scans PV for validity and returns false if the PV is invalid UTF-8.
3168 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3174 /* The octets may have got themselves encoded - get them back as
3177 if (!sv_utf8_downgrade(sv, TRUE))
3180 /* it is actually just a matter of turning the utf8 flag on, but
3181 * we want to make sure everything inside is valid utf8 first.
3183 c = (const U8 *) SvPVX_const(sv);
3184 if (!is_utf8_string(c, SvCUR(sv)+1))
3186 e = (const U8 *) SvEND(sv);
3189 if (!UTF8_IS_INVARIANT(ch)) {
3199 =for apidoc sv_setsv
3201 Copies the contents of the source SV C<ssv> into the destination SV
3202 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3203 function if the source SV needs to be reused. Does not handle 'set' magic.
3204 Loosely speaking, it performs a copy-by-value, obliterating any previous
3205 content of the destination.
3207 You probably want to use one of the assortment of wrappers, such as
3208 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3209 C<SvSetMagicSV_nosteal>.
3211 =for apidoc sv_setsv_flags
3213 Copies the contents of the source SV C<ssv> into the destination SV
3214 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3215 function if the source SV needs to be reused. Does not handle 'set' magic.
3216 Loosely speaking, it performs a copy-by-value, obliterating any previous
3217 content of the destination.
3218 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3219 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3220 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3221 and C<sv_setsv_nomg> are implemented in terms of this function.
3223 You probably want to use one of the assortment of wrappers, such as
3224 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3225 C<SvSetMagicSV_nosteal>.
3227 This is the primary function for copying scalars, and most other
3228 copy-ish functions and macros use this underneath.
3234 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3236 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3238 if (dtype != SVt_PVGV) {
3239 const char * const name = GvNAME(sstr);
3240 const STRLEN len = GvNAMELEN(sstr);
3242 if (dtype >= SVt_PV) {
3248 SvUPGRADE(dstr, SVt_PVGV);
3249 (void)SvOK_off(dstr);
3250 /* FIXME - why are we doing this, then turning it off and on again
3252 isGV_with_GP_on(dstr);
3254 GvSTASH(dstr) = GvSTASH(sstr);
3256 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3257 gv_name_set((GV *)dstr, name, len, GV_ADD);
3258 SvFAKE_on(dstr); /* can coerce to non-glob */
3261 #ifdef GV_UNIQUE_CHECK
3262 if (GvUNIQUE((GV*)dstr)) {
3263 Perl_croak(aTHX_ PL_no_modify);
3267 if(GvGP((GV*)sstr)) {
3268 /* If source has method cache entry, clear it */
3270 SvREFCNT_dec(GvCV(sstr));
3274 /* If source has a real method, then a method is
3276 else if(GvCV((GV*)sstr)) {
3281 /* If dest already had a real method, that's a change as well */
3282 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3286 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3290 isGV_with_GP_off(dstr);
3291 (void)SvOK_off(dstr);
3292 isGV_with_GP_on(dstr);
3293 GvINTRO_off(dstr); /* one-shot flag */
3294 GvGP(dstr) = gp_ref(GvGP(sstr));
3295 if (SvTAINTED(sstr))
3297 if (GvIMPORTED(dstr) != GVf_IMPORTED
3298 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3300 GvIMPORTED_on(dstr);
3303 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3304 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3309 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3310 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3312 const int intro = GvINTRO(dstr);
3315 const U32 stype = SvTYPE(sref);
3318 #ifdef GV_UNIQUE_CHECK
3319 if (GvUNIQUE((GV*)dstr)) {
3320 Perl_croak(aTHX_ PL_no_modify);
3325 GvINTRO_off(dstr); /* one-shot flag */
3326 GvLINE(dstr) = CopLINE(PL_curcop);
3327 GvEGV(dstr) = (GV*)dstr;
3332 location = (SV **) &GvCV(dstr);
3333 import_flag = GVf_IMPORTED_CV;
3336 location = (SV **) &GvHV(dstr);
3337 import_flag = GVf_IMPORTED_HV;
3340 location = (SV **) &GvAV(dstr);
3341 import_flag = GVf_IMPORTED_AV;
3344 location = (SV **) &GvIOp(dstr);
3347 location = (SV **) &GvFORM(dstr);
3349 location = &GvSV(dstr);
3350 import_flag = GVf_IMPORTED_SV;
3353 if (stype == SVt_PVCV) {
3354 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3355 if (GvCVGEN(dstr)) {
3356 SvREFCNT_dec(GvCV(dstr));
3358 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3361 SAVEGENERICSV(*location);
3365 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3366 CV* const cv = (CV*)*location;
3368 if (!GvCVGEN((GV*)dstr) &&
3369 (CvROOT(cv) || CvXSUB(cv)))
3371 /* Redefining a sub - warning is mandatory if
3372 it was a const and its value changed. */
3373 if (CvCONST(cv) && CvCONST((CV*)sref)
3374 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3376 /* They are 2 constant subroutines generated from
3377 the same constant. This probably means that
3378 they are really the "same" proxy subroutine
3379 instantiated in 2 places. Most likely this is
3380 when a constant is exported twice. Don't warn.
3383 else if (ckWARN(WARN_REDEFINE)
3385 && (!CvCONST((CV*)sref)
3386 || sv_cmp(cv_const_sv(cv),
3387 cv_const_sv((CV*)sref))))) {
3388 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3391 ? "Constant subroutine %s::%s redefined"
3392 : "Subroutine %s::%s redefined"),
3393 HvNAME_get(GvSTASH((GV*)dstr)),
3394 GvENAME((GV*)dstr));
3398 cv_ckproto_len(cv, (GV*)dstr,
3399 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3400 SvPOK(sref) ? SvCUR(sref) : 0);
3402 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3403 GvASSUMECV_on(dstr);
3404 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3407 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3408 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3409 GvFLAGS(dstr) |= import_flag;
3414 if (SvTAINTED(sstr))
3420 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3423 register U32 sflags;
3425 register svtype stype;
3430 if (SvIS_FREED(dstr)) {
3431 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3432 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3434 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3436 sstr = &PL_sv_undef;
3437 if (SvIS_FREED(sstr)) {
3438 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3439 (void*)sstr, (void*)dstr);
3441 stype = SvTYPE(sstr);
3442 dtype = SvTYPE(dstr);
3444 (void)SvAMAGIC_off(dstr);
3447 /* need to nuke the magic */
3449 SvRMAGICAL_off(dstr);
3452 /* There's a lot of redundancy below but we're going for speed here */
3457 if (dtype != SVt_PVGV) {
3458 (void)SvOK_off(dstr);
3466 sv_upgrade(dstr, SVt_IV);
3470 sv_upgrade(dstr, SVt_PVIV);
3473 goto end_of_first_switch;
3475 (void)SvIOK_only(dstr);
3476 SvIV_set(dstr, SvIVX(sstr));
3479 /* SvTAINTED can only be true if the SV has taint magic, which in
3480 turn means that the SV type is PVMG (or greater). This is the
3481 case statement for SVt_IV, so this cannot be true (whatever gcov
3483 assert(!SvTAINTED(sstr));
3488 if (dtype < SVt_PV && dtype != SVt_IV)
3489 sv_upgrade(dstr, SVt_IV);
3497 sv_upgrade(dstr, SVt_NV);
3501 sv_upgrade(dstr, SVt_PVNV);
3504 goto end_of_first_switch;
3506 SvNV_set(dstr, SvNVX(sstr));
3507 (void)SvNOK_only(dstr);
3508 /* SvTAINTED can only be true if the SV has taint magic, which in
3509 turn means that the SV type is PVMG (or greater). This is the
3510 case statement for SVt_NV, so this cannot be true (whatever gcov
3512 assert(!SvTAINTED(sstr));
3518 #ifdef PERL_OLD_COPY_ON_WRITE
3519 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3520 if (dtype < SVt_PVIV)
3521 sv_upgrade(dstr, SVt_PVIV);
3529 sv_upgrade(dstr, SVt_PV);
3532 if (dtype < SVt_PVIV)
3533 sv_upgrade(dstr, SVt_PVIV);
3536 if (dtype < SVt_PVNV)
3537 sv_upgrade(dstr, SVt_PVNV);
3541 const char * const type = sv_reftype(sstr,0);
3543 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3545 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3549 /* case SVt_BIND: */
3552 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3553 glob_assign_glob(dstr, sstr, dtype);
3556 /* SvVALID means that this PVGV is playing at being an FBM. */
3560 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3562 if (SvTYPE(sstr) != stype) {
3563 stype = SvTYPE(sstr);
3564 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3565 glob_assign_glob(dstr, sstr, dtype);
3570 if (stype == SVt_PVLV)
3571 SvUPGRADE(dstr, SVt_PVNV);
3573 SvUPGRADE(dstr, (svtype)stype);
3575 end_of_first_switch:
3577 /* dstr may have been upgraded. */
3578 dtype = SvTYPE(dstr);
3579 sflags = SvFLAGS(sstr);
3581 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3582 /* Assigning to a subroutine sets the prototype. */
3585 const char *const ptr = SvPV_const(sstr, len);
3587 SvGROW(dstr, len + 1);
3588 Copy(ptr, SvPVX(dstr), len + 1, char);
3589 SvCUR_set(dstr, len);
3591 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3595 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3596 const char * const type = sv_reftype(dstr,0);
3598 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3600 Perl_croak(aTHX_ "Cannot copy to %s", type);
3601 } else if (sflags & SVf_ROK) {
3602 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3603 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3606 if (GvIMPORTED(dstr) != GVf_IMPORTED
3607 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3609 GvIMPORTED_on(dstr);
3614 glob_assign_glob(dstr, sstr, dtype);
3618 if (dtype >= SVt_PV) {
3619 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3620 glob_assign_ref(dstr, sstr);
3623 if (SvPVX_const(dstr)) {
3629 (void)SvOK_off(dstr);
3630 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3631 SvFLAGS(dstr) |= sflags & SVf_ROK;
3632 assert(!(sflags & SVp_NOK));
3633 assert(!(sflags & SVp_IOK));
3634 assert(!(sflags & SVf_NOK));
3635 assert(!(sflags & SVf_IOK));
3637 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3638 if (!(sflags & SVf_OK)) {
3639 if (ckWARN(WARN_MISC))
3640 Perl_warner(aTHX_ packWARN(WARN_MISC),
3641 "Undefined value assigned to typeglob");
3644 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3645 if (dstr != (SV*)gv) {
3648 GvGP(dstr) = gp_ref(GvGP(gv));
3652 else if (sflags & SVp_POK) {
3656 * Check to see if we can just swipe the string. If so, it's a
3657 * possible small lose on short strings, but a big win on long ones.
3658 * It might even be a win on short strings if SvPVX_const(dstr)
3659 * has to be allocated and SvPVX_const(sstr) has to be freed.
3660 * Likewise if we can set up COW rather than doing an actual copy, we
3661 * drop to the else clause, as the swipe code and the COW setup code
3662 * have much in common.
3665 /* Whichever path we take through the next code, we want this true,
3666 and doing it now facilitates the COW check. */
3667 (void)SvPOK_only(dstr);
3670 /* If we're already COW then this clause is not true, and if COW
3671 is allowed then we drop down to the else and make dest COW
3672 with us. If caller hasn't said that we're allowed to COW
3673 shared hash keys then we don't do the COW setup, even if the
3674 source scalar is a shared hash key scalar. */
3675 (((flags & SV_COW_SHARED_HASH_KEYS)
3676 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3677 : 1 /* If making a COW copy is forbidden then the behaviour we
3678 desire is as if the source SV isn't actually already
3679 COW, even if it is. So we act as if the source flags
3680 are not COW, rather than actually testing them. */
3682 #ifndef PERL_OLD_COPY_ON_WRITE
3683 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3684 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3685 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3686 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3687 but in turn, it's somewhat dead code, never expected to go
3688 live, but more kept as a placeholder on how to do it better
3689 in a newer implementation. */
3690 /* If we are COW and dstr is a suitable target then we drop down
3691 into the else and make dest a COW of us. */
3692 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3697 (sflags & SVs_TEMP) && /* slated for free anyway? */
3698 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3699 (!(flags & SV_NOSTEAL)) &&
3700 /* and we're allowed to steal temps */
3701 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3702 SvLEN(sstr) && /* and really is a string */
3703 /* and won't be needed again, potentially */
3704 !(PL_op && PL_op->op_type == OP_AASSIGN))
3705 #ifdef PERL_OLD_COPY_ON_WRITE
3706 && ((flags & SV_COW_SHARED_HASH_KEYS)
3707 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3708 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3709 && SvTYPE(sstr) >= SVt_PVIV))
3713 /* Failed the swipe test, and it's not a shared hash key either.
3714 Have to copy the string. */
3715 STRLEN len = SvCUR(sstr);
3716 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3717 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3718 SvCUR_set(dstr, len);
3719 *SvEND(dstr) = '\0';
3721 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3723 /* Either it's a shared hash key, or it's suitable for
3724 copy-on-write or we can swipe the string. */
3726 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3730 #ifdef PERL_OLD_COPY_ON_WRITE
3732 /* I believe I should acquire a global SV mutex if
3733 it's a COW sv (not a shared hash key) to stop
3734 it going un copy-on-write.
3735 If the source SV has gone un copy on write between up there
3736 and down here, then (assert() that) it is of the correct
3737 form to make it copy on write again */
3738 if ((sflags & (SVf_FAKE | SVf_READONLY))
3739 != (SVf_FAKE | SVf_READONLY)) {
3740 SvREADONLY_on(sstr);
3742 /* Make the source SV into a loop of 1.
3743 (about to become 2) */
3744 SV_COW_NEXT_SV_SET(sstr, sstr);
3748 /* Initial code is common. */
3749 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3754 /* making another shared SV. */
3755 STRLEN cur = SvCUR(sstr);
3756 STRLEN len = SvLEN(sstr);
3757 #ifdef PERL_OLD_COPY_ON_WRITE
3759 assert (SvTYPE(dstr) >= SVt_PVIV);
3760 /* SvIsCOW_normal */
3761 /* splice us in between source and next-after-source. */
3762 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3763 SV_COW_NEXT_SV_SET(sstr, dstr);
3764 SvPV_set(dstr, SvPVX_mutable(sstr));
3768 /* SvIsCOW_shared_hash */
3769 DEBUG_C(PerlIO_printf(Perl_debug_log,
3770 "Copy on write: Sharing hash\n"));
3772 assert (SvTYPE(dstr) >= SVt_PV);
3774 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3776 SvLEN_set(dstr, len);
3777 SvCUR_set(dstr, cur);
3778 SvREADONLY_on(dstr);
3780 /* Relesase a global SV mutex. */
3783 { /* Passes the swipe test. */
3784 SvPV_set(dstr, SvPVX_mutable(sstr));
3785 SvLEN_set(dstr, SvLEN(sstr));
3786 SvCUR_set(dstr, SvCUR(sstr));
3789 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3790 SvPV_set(sstr, NULL);
3796 if (sflags & SVp_NOK) {
3797 SvNV_set(dstr, SvNVX(sstr));
3799 if (sflags & SVp_IOK) {
3800 SvIV_set(dstr, SvIVX(sstr));
3801 /* Must do this otherwise some other overloaded use of 0x80000000
3802 gets confused. I guess SVpbm_VALID */
3803 if (sflags & SVf_IVisUV)
3806 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3808 const MAGIC * const smg = SvVSTRING_mg(sstr);
3810 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3811 smg->mg_ptr, smg->mg_len);
3812 SvRMAGICAL_on(dstr);
3816 else if (sflags & (SVp_IOK|SVp_NOK)) {
3817 (void)SvOK_off(dstr);
3818 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3819 if (sflags & SVp_IOK) {
3820 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3821 SvIV_set(dstr, SvIVX(sstr));
3823 if (sflags & SVp_NOK) {
3824 SvNV_set(dstr, SvNVX(sstr));
3828 if (isGV_with_GP(sstr)) {
3829 /* This stringification rule for globs is spread in 3 places.
3830 This feels bad. FIXME. */
3831 const U32 wasfake = sflags & SVf_FAKE;
3833 /* FAKE globs can get coerced, so need to turn this off
3834 temporarily if it is on. */
3836 gv_efullname3(dstr, (GV *)sstr, "*");
3837 SvFLAGS(sstr) |= wasfake;
3840 (void)SvOK_off(dstr);
3842 if (SvTAINTED(sstr))
3847 =for apidoc sv_setsv_mg
3849 Like C<sv_setsv>, but also handles 'set' magic.
3855 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3857 sv_setsv(dstr,sstr);
3861 #ifdef PERL_OLD_COPY_ON_WRITE
3863 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3865 STRLEN cur = SvCUR(sstr);
3866 STRLEN len = SvLEN(sstr);
3867 register char *new_pv;
3870 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3871 (void*)sstr, (void*)dstr);
3878 if (SvTHINKFIRST(dstr))
3879 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3880 else if (SvPVX_const(dstr))
3881 Safefree(SvPVX_const(dstr));
3885 SvUPGRADE(dstr, SVt_PVIV);
3887 assert (SvPOK(sstr));
3888 assert (SvPOKp(sstr));
3889 assert (!SvIOK(sstr));
3890 assert (!SvIOKp(sstr));
3891 assert (!SvNOK(sstr));
3892 assert (!SvNOKp(sstr));
3894 if (SvIsCOW(sstr)) {
3896 if (SvLEN(sstr) == 0) {
3897 /* source is a COW shared hash key. */
3898 DEBUG_C(PerlIO_printf(Perl_debug_log,
3899 "Fast copy on write: Sharing hash\n"));
3900 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3903 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3905 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3906 SvUPGRADE(sstr, SVt_PVIV);
3907 SvREADONLY_on(sstr);
3909 DEBUG_C(PerlIO_printf(Perl_debug_log,
3910 "Fast copy on write: Converting sstr to COW\n"));
3911 SV_COW_NEXT_SV_SET(dstr, sstr);
3913 SV_COW_NEXT_SV_SET(sstr, dstr);
3914 new_pv = SvPVX_mutable(sstr);
3917 SvPV_set(dstr, new_pv);
3918 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3921 SvLEN_set(dstr, len);
3922 SvCUR_set(dstr, cur);
3931 =for apidoc sv_setpvn
3933 Copies a string into an SV. The C<len> parameter indicates the number of
3934 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3935 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3941 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3944 register char *dptr;
3946 SV_CHECK_THINKFIRST_COW_DROP(sv);
3952 /* len is STRLEN which is unsigned, need to copy to signed */
3955 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3957 SvUPGRADE(sv, SVt_PV);
3959 dptr = SvGROW(sv, len + 1);
3960 Move(ptr,dptr,len,char);
3963 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3968 =for apidoc sv_setpvn_mg
3970 Like C<sv_setpvn>, but also handles 'set' magic.
3976 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3978 sv_setpvn(sv,ptr,len);
3983 =for apidoc sv_setpv
3985 Copies a string into an SV. The string must be null-terminated. Does not
3986 handle 'set' magic. See C<sv_setpv_mg>.
3992 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3995 register STRLEN len;
3997 SV_CHECK_THINKFIRST_COW_DROP(sv);
4003 SvUPGRADE(sv, SVt_PV);
4005 SvGROW(sv, len + 1);
4006 Move(ptr,SvPVX(sv),len+1,char);
4008 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4013 =for apidoc sv_setpv_mg
4015 Like C<sv_setpv>, but also handles 'set' magic.
4021 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4028 =for apidoc sv_usepvn_flags
4030 Tells an SV to use C<ptr> to find its string value. Normally the
4031 string is stored inside the SV but sv_usepvn allows the SV to use an
4032 outside string. The C<ptr> should point to memory that was allocated
4033 by C<malloc>. The string length, C<len>, must be supplied. By default
4034 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4035 so that pointer should not be freed or used by the programmer after
4036 giving it to sv_usepvn, and neither should any pointers from "behind"
4037 that pointer (e.g. ptr + 1) be used.
4039 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4040 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4041 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4042 C<len>, and already meets the requirements for storing in C<SvPVX>)
4048 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4052 SV_CHECK_THINKFIRST_COW_DROP(sv);
4053 SvUPGRADE(sv, SVt_PV);
4056 if (flags & SV_SMAGIC)
4060 if (SvPVX_const(sv))
4064 if (flags & SV_HAS_TRAILING_NUL)
4065 assert(ptr[len] == '\0');
4068 allocate = (flags & SV_HAS_TRAILING_NUL)
4069 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4070 if (flags & SV_HAS_TRAILING_NUL) {
4071 /* It's long enough - do nothing.
4072 Specfically Perl_newCONSTSUB is relying on this. */
4075 /* Force a move to shake out bugs in callers. */
4076 char *new_ptr = (char*)safemalloc(allocate);
4077 Copy(ptr, new_ptr, len, char);
4078 PoisonFree(ptr,len,char);
4082 ptr = (char*) saferealloc (ptr, allocate);
4087 SvLEN_set(sv, allocate);
4088 if (!(flags & SV_HAS_TRAILING_NUL)) {
4091 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4093 if (flags & SV_SMAGIC)
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098 /* Need to do this *after* making the SV normal, as we need the buffer
4099 pointer to remain valid until after we've copied it. If we let go too early,
4100 another thread could invalidate it by unsharing last of the same hash key
4101 (which it can do by means other than releasing copy-on-write Svs)
4102 or by changing the other copy-on-write SVs in the loop. */
4104 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4106 { /* this SV was SvIsCOW_normal(sv) */
4107 /* we need to find the SV pointing to us. */
4108 SV *current = SV_COW_NEXT_SV(after);
4110 if (current == sv) {
4111 /* The SV we point to points back to us (there were only two of us
4113 Hence other SV is no longer copy on write either. */
4115 SvREADONLY_off(after);
4117 /* We need to follow the pointers around the loop. */
4119 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4122 /* don't loop forever if the structure is bust, and we have
4123 a pointer into a closed loop. */
4124 assert (current != after);
4125 assert (SvPVX_const(current) == pvx);
4127 /* Make the SV before us point to the SV after us. */
4128 SV_COW_NEXT_SV_SET(current, after);
4134 =for apidoc sv_force_normal_flags
4136 Undo various types of fakery on an SV: if the PV is a shared string, make
4137 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4138 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4139 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4140 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4141 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4142 set to some other value.) In addition, the C<flags> parameter gets passed to
4143 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4144 with flags set to 0.
4150 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4153 #ifdef PERL_OLD_COPY_ON_WRITE
4154 if (SvREADONLY(sv)) {
4155 /* At this point I believe I should acquire a global SV mutex. */
4157 const char * const pvx = SvPVX_const(sv);
4158 const STRLEN len = SvLEN(sv);
4159 const STRLEN cur = SvCUR(sv);
4160 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4161 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4162 we'll fail an assertion. */
4163 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4166 PerlIO_printf(Perl_debug_log,
4167 "Copy on write: Force normal %ld\n",
4173 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4176 if (flags & SV_COW_DROP_PV) {
4177 /* OK, so we don't need to copy our buffer. */
4180 SvGROW(sv, cur + 1);
4181 Move(pvx,SvPVX(sv),cur,char);
4186 sv_release_COW(sv, pvx, next);
4188 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4194 else if (IN_PERL_RUNTIME)
4195 Perl_croak(aTHX_ PL_no_modify);
4196 /* At this point I believe that I can drop the global SV mutex. */
4199 if (SvREADONLY(sv)) {
4201 const char * const pvx = SvPVX_const(sv);
4202 const STRLEN len = SvCUR(sv);
4207 SvGROW(sv, len + 1);
4208 Move(pvx,SvPVX(sv),len,char);
4210 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4212 else if (IN_PERL_RUNTIME)
4213 Perl_croak(aTHX_ PL_no_modify);
4217 sv_unref_flags(sv, flags);
4218 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4225 Efficient removal of characters from the beginning of the string buffer.
4226 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4227 the string buffer. The C<ptr> becomes the first character of the adjusted
4228 string. Uses the "OOK hack".
4229 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4230 refer to the same chunk of data.
4236 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4242 const U8 *real_start;
4245 if (!ptr || !SvPOKp(sv))
4247 delta = ptr - SvPVX_const(sv);
4249 /* Nothing to do. */
4252 assert(ptr > SvPVX_const(sv));
4253 SV_CHECK_THINKFIRST(sv);
4256 if (!SvLEN(sv)) { /* make copy of shared string */
4257 const char *pvx = SvPVX_const(sv);
4258 const STRLEN len = SvCUR(sv);
4259 SvGROW(sv, len + 1);
4260 Move(pvx,SvPVX(sv),len,char);
4263 SvFLAGS(sv) |= SVf_OOK;
4266 SvOOK_offset(sv, old_delta);
4268 SvLEN_set(sv, SvLEN(sv) - delta);
4269 SvCUR_set(sv, SvCUR(sv) - delta);
4270 SvPV_set(sv, SvPVX(sv) + delta);
4272 p = (U8 *)SvPVX_const(sv);
4277 real_start = p - delta;
4281 if (delta < 0x100) {
4285 p -= sizeof(STRLEN);
4286 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4290 /* Fill the preceding buffer with sentinals to verify that no-one is
4292 while (p > real_start) {
4300 =for apidoc sv_catpvn
4302 Concatenates the string onto the end of the string which is in the SV. The
4303 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4304 status set, then the bytes appended should be valid UTF-8.
4305 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4307 =for apidoc sv_catpvn_flags
4309 Concatenates the string onto the end of the string which is in the SV. The
4310 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4311 status set, then the bytes appended should be valid UTF-8.
4312 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4313 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4314 in terms of this function.
4320 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4324 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4326 SvGROW(dsv, dlen + slen + 1);
4328 sstr = SvPVX_const(dsv);
4329 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4330 SvCUR_set(dsv, SvCUR(dsv) + slen);
4332 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4334 if (flags & SV_SMAGIC)
4339 =for apidoc sv_catsv
4341 Concatenates the string from SV C<ssv> onto the end of the string in
4342 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4343 not 'set' magic. See C<sv_catsv_mg>.
4345 =for apidoc sv_catsv_flags
4347 Concatenates the string from SV C<ssv> onto the end of the string in
4348 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4349 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4350 and C<sv_catsv_nomg> are implemented in terms of this function.
4355 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4360 const char *spv = SvPV_const(ssv, slen);
4362 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4363 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4364 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4365 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4366 dsv->sv_flags doesn't have that bit set.
4367 Andy Dougherty 12 Oct 2001
4369 const I32 sutf8 = DO_UTF8(ssv);
4372 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4374 dutf8 = DO_UTF8(dsv);
4376 if (dutf8 != sutf8) {
4378 /* Not modifying source SV, so taking a temporary copy. */
4379 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4381 sv_utf8_upgrade(csv);
4382 spv = SvPV_const(csv, slen);
4385 sv_utf8_upgrade_nomg(dsv);
4387 sv_catpvn_nomg(dsv, spv, slen);
4390 if (flags & SV_SMAGIC)
4395 =for apidoc sv_catpv
4397 Concatenates the string onto the end of the string which is in the SV.
4398 If the SV has the UTF-8 status set, then the bytes appended should be
4399 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4404 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4407 register STRLEN len;
4413 junk = SvPV_force(sv, tlen);
4415 SvGROW(sv, tlen + len + 1);
4417 ptr = SvPVX_const(sv);
4418 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4419 SvCUR_set(sv, SvCUR(sv) + len);
4420 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4425 =for apidoc sv_catpv_mg
4427 Like C<sv_catpv>, but also handles 'set' magic.
4433 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4442 Creates a new SV. A non-zero C<len> parameter indicates the number of
4443 bytes of preallocated string space the SV should have. An extra byte for a
4444 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4445 space is allocated.) The reference count for the new SV is set to 1.
4447 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4448 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4449 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4450 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4451 modules supporting older perls.
4457 Perl_newSV(pTHX_ STRLEN len)
4464 sv_upgrade(sv, SVt_PV);
4465 SvGROW(sv, len + 1);
4470 =for apidoc sv_magicext
4472 Adds magic to an SV, upgrading it if necessary. Applies the
4473 supplied vtable and returns a pointer to the magic added.
4475 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4476 In particular, you can add magic to SvREADONLY SVs, and add more than
4477 one instance of the same 'how'.
4479 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4480 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4481 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4482 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4484 (This is now used as a subroutine by C<sv_magic>.)
4489 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4490 const char* name, I32 namlen)
4495 SvUPGRADE(sv, SVt_PVMG);
4496 Newxz(mg, 1, MAGIC);
4497 mg->mg_moremagic = SvMAGIC(sv);
4498 SvMAGIC_set(sv, mg);
4500 /* Sometimes a magic contains a reference loop, where the sv and
4501 object refer to each other. To prevent a reference loop that
4502 would prevent such objects being freed, we look for such loops
4503 and if we find one we avoid incrementing the object refcount.
4505 Note we cannot do this to avoid self-tie loops as intervening RV must
4506 have its REFCNT incremented to keep it in existence.
4509 if (!obj || obj == sv ||
4510 how == PERL_MAGIC_arylen ||
4511 how == PERL_MAGIC_symtab ||
4512 (SvTYPE(obj) == SVt_PVGV &&
4513 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4514 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4515 GvFORM(obj) == (CV*)sv)))
4520 mg->mg_obj = SvREFCNT_inc_simple(obj);
4521 mg->mg_flags |= MGf_REFCOUNTED;
4524 /* Normal self-ties simply pass a null object, and instead of
4525 using mg_obj directly, use the SvTIED_obj macro to produce a
4526 new RV as needed. For glob "self-ties", we are tieing the PVIO
4527 with an RV obj pointing to the glob containing the PVIO. In
4528 this case, to avoid a reference loop, we need to weaken the
4532 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4533 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4539 mg->mg_len = namlen;
4542 mg->mg_ptr = savepvn(name, namlen);
4543 else if (namlen == HEf_SVKEY)
4544 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4546 mg->mg_ptr = (char *) name;
4548 mg->mg_virtual = (MGVTBL *) vtable;
4552 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4557 =for apidoc sv_magic
4559 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4560 then adds a new magic item of type C<how> to the head of the magic list.
4562 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4563 handling of the C<name> and C<namlen> arguments.
4565 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4566 to add more than one instance of the same 'how'.
4572 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4575 const MGVTBL *vtable;
4578 #ifdef PERL_OLD_COPY_ON_WRITE
4580 sv_force_normal_flags(sv, 0);
4582 if (SvREADONLY(sv)) {
4584 /* its okay to attach magic to shared strings; the subsequent
4585 * upgrade to PVMG will unshare the string */
4586 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4589 && how != PERL_MAGIC_regex_global
4590 && how != PERL_MAGIC_bm
4591 && how != PERL_MAGIC_fm
4592 && how != PERL_MAGIC_sv
4593 && how != PERL_MAGIC_backref
4596 Perl_croak(aTHX_ PL_no_modify);
4599 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4600 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4601 /* sv_magic() refuses to add a magic of the same 'how' as an
4604 if (how == PERL_MAGIC_taint) {
4606 /* Any scalar which already had taint magic on which someone
4607 (erroneously?) did SvIOK_on() or similar will now be
4608 incorrectly sporting public "OK" flags. */
4609 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4617 vtable = &PL_vtbl_sv;
4619 case PERL_MAGIC_overload:
4620 vtable = &PL_vtbl_amagic;
4622 case PERL_MAGIC_overload_elem:
4623 vtable = &PL_vtbl_amagicelem;
4625 case PERL_MAGIC_overload_table:
4626 vtable = &PL_vtbl_ovrld;
4629 vtable = &PL_vtbl_bm;
4631 case PERL_MAGIC_regdata:
4632 vtable = &PL_vtbl_regdata;
4634 case PERL_MAGIC_regdatum:
4635 vtable = &PL_vtbl_regdatum;
4637 case PERL_MAGIC_env:
4638 vtable = &PL_vtbl_env;
4641 vtable = &PL_vtbl_fm;
4643 case PERL_MAGIC_envelem:
4644 vtable = &PL_vtbl_envelem;
4646 case PERL_MAGIC_regex_global:
4647 vtable = &PL_vtbl_mglob;
4649 case PERL_MAGIC_isa:
4650 vtable = &PL_vtbl_isa;
4652 case PERL_MAGIC_isaelem:
4653 vtable = &PL_vtbl_isaelem;
4655 case PERL_MAGIC_nkeys:
4656 vtable = &PL_vtbl_nkeys;
4658 case PERL_MAGIC_dbfile:
4661 case PERL_MAGIC_dbline:
4662 vtable = &PL_vtbl_dbline;
4664 #ifdef USE_LOCALE_COLLATE
4665 case PERL_MAGIC_collxfrm:
4666 vtable = &PL_vtbl_collxfrm;
4668 #endif /* USE_LOCALE_COLLATE */
4669 case PERL_MAGIC_tied:
4670 vtable = &PL_vtbl_pack;
4672 case PERL_MAGIC_tiedelem:
4673 case PERL_MAGIC_tiedscalar:
4674 vtable = &PL_vtbl_packelem;
4677 vtable = &PL_vtbl_regexp;
4679 case PERL_MAGIC_hints:
4680 /* As this vtable is all NULL, we can reuse it. */
4681 case PERL_MAGIC_sig:
4682 vtable = &PL_vtbl_sig;
4684 case PERL_MAGIC_sigelem:
4685 vtable = &PL_vtbl_sigelem;
4687 case PERL_MAGIC_taint:
4688 vtable = &PL_vtbl_taint;
4690 case PERL_MAGIC_uvar:
4691 vtable = &PL_vtbl_uvar;
4693 case PERL_MAGIC_vec:
4694 vtable = &PL_vtbl_vec;
4696 case PERL_MAGIC_arylen_p:
4697 case PERL_MAGIC_rhash:
4698 case PERL_MAGIC_symtab:
4699 case PERL_MAGIC_vstring:
4702 case PERL_MAGIC_utf8:
4703 vtable = &PL_vtbl_utf8;
4705 case PERL_MAGIC_substr:
4706 vtable = &PL_vtbl_substr;
4708 case PERL_MAGIC_defelem:
4709 vtable = &PL_vtbl_defelem;
4711 case PERL_MAGIC_arylen:
4712 vtable = &PL_vtbl_arylen;
4714 case PERL_MAGIC_pos:
4715 vtable = &PL_vtbl_pos;
4717 case PERL_MAGIC_backref:
4718 vtable = &PL_vtbl_backref;
4720 case PERL_MAGIC_hintselem:
4721 vtable = &PL_vtbl_hintselem;
4723 case PERL_MAGIC_ext:
4724 /* Reserved for use by extensions not perl internals. */
4725 /* Useful for attaching extension internal data to perl vars. */
4726 /* Note that multiple extensions may clash if magical scalars */
4727 /* etc holding private data from one are passed to another. */
4731 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4734 /* Rest of work is done else where */
4735 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4738 case PERL_MAGIC_taint:
4741 case PERL_MAGIC_ext:
4742 case PERL_MAGIC_dbfile:
4749 =for apidoc sv_unmagic
4751 Removes all magic of type C<type> from an SV.
4757 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4761 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4763 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4764 for (mg = *mgp; mg; mg = *mgp) {
4765 if (mg->mg_type == type) {
4766 const MGVTBL* const vtbl = mg->mg_virtual;
4767 *mgp = mg->mg_moremagic;
4768 if (vtbl && vtbl->svt_free)
4769 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4770 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4772 Safefree(mg->mg_ptr);
4773 else if (mg->mg_len == HEf_SVKEY)
4774 SvREFCNT_dec((SV*)mg->mg_ptr);
4775 else if (mg->mg_type == PERL_MAGIC_utf8)
4776 Safefree(mg->mg_ptr);
4778 if (mg->mg_flags & MGf_REFCOUNTED)
4779 SvREFCNT_dec(mg->mg_obj);
4783 mgp = &mg->mg_moremagic;
4787 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4788 SvMAGIC_set(sv, NULL);
4795 =for apidoc sv_rvweaken
4797 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4798 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4799 push a back-reference to this RV onto the array of backreferences
4800 associated with that magic. If the RV is magical, set magic will be
4801 called after the RV is cleared.
4807 Perl_sv_rvweaken(pTHX_ SV *sv)
4810 if (!SvOK(sv)) /* let undefs pass */
4813 Perl_croak(aTHX_ "Can't weaken a nonreference");
4814 else if (SvWEAKREF(sv)) {
4815 if (ckWARN(WARN_MISC))
4816 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4820 Perl_sv_add_backref(aTHX_ tsv, sv);
4826 /* Give tsv backref magic if it hasn't already got it, then push a
4827 * back-reference to sv onto the array associated with the backref magic.
4831 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4836 if (SvTYPE(tsv) == SVt_PVHV) {
4837 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4841 /* There is no AV in the offical place - try a fixup. */
4842 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4845 /* Aha. They've got it stowed in magic. Bring it back. */
4846 av = (AV*)mg->mg_obj;
4847 /* Stop mg_free decreasing the refernce count. */
4849 /* Stop mg_free even calling the destructor, given that
4850 there's no AV to free up. */
4852 sv_unmagic(tsv, PERL_MAGIC_backref);
4856 SvREFCNT_inc_simple_void(av);
4861 const MAGIC *const mg
4862 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4864 av = (AV*)mg->mg_obj;
4868 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4869 /* av now has a refcnt of 2, which avoids it getting freed
4870 * before us during global cleanup. The extra ref is removed
4871 * by magic_killbackrefs() when tsv is being freed */
4874 if (AvFILLp(av) >= AvMAX(av)) {
4875 av_extend(av, AvFILLp(av)+1);
4877 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4880 /* delete a back-reference to ourselves from the backref magic associated
4881 * with the SV we point to.
4885 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4892 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4893 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4894 /* We mustn't attempt to "fix up" the hash here by moving the
4895 backreference array back to the hv_aux structure, as that is stored
4896 in the main HvARRAY(), and hfreentries assumes that no-one
4897 reallocates HvARRAY() while it is running. */
4900 const MAGIC *const mg
4901 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4903 av = (AV *)mg->mg_obj;
4906 if (PL_in_clean_all)
4908 Perl_croak(aTHX_ "panic: del_backref");
4915 /* We shouldn't be in here more than once, but for paranoia reasons lets
4917 for (i = AvFILLp(av); i >= 0; i--) {
4919 const SSize_t fill = AvFILLp(av);
4921 /* We weren't the last entry.
4922 An unordered list has this property that you can take the
4923 last element off the end to fill the hole, and it's still
4924 an unordered list :-)
4929 AvFILLp(av) = fill - 1;
4935 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4937 SV **svp = AvARRAY(av);
4939 PERL_UNUSED_ARG(sv);
4941 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4942 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4943 if (svp && !SvIS_FREED(av)) {
4944 SV *const *const last = svp + AvFILLp(av);
4946 while (svp <= last) {
4948 SV *const referrer = *svp;
4949 if (SvWEAKREF(referrer)) {
4950 /* XXX Should we check that it hasn't changed? */
4951 SvRV_set(referrer, 0);
4953 SvWEAKREF_off(referrer);
4954 SvSETMAGIC(referrer);
4955 } else if (SvTYPE(referrer) == SVt_PVGV ||
4956 SvTYPE(referrer) == SVt_PVLV) {
4957 /* You lookin' at me? */
4958 assert(GvSTASH(referrer));
4959 assert(GvSTASH(referrer) == (HV*)sv);
4960 GvSTASH(referrer) = 0;
4963 "panic: magic_killbackrefs (flags=%"UVxf")",
4964 (UV)SvFLAGS(referrer));
4972 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4977 =for apidoc sv_insert
4979 Inserts a string at the specified offset/length within the SV. Similar to
4980 the Perl substr() function.
4986 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4991 register char *midend;
4992 register char *bigend;
4998 Perl_croak(aTHX_ "Can't modify non-existent substring");
4999 SvPV_force(bigstr, curlen);
5000 (void)SvPOK_only_UTF8(bigstr);
5001 if (offset + len > curlen) {
5002 SvGROW(bigstr, offset+len+1);
5003 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5004 SvCUR_set(bigstr, offset+len);
5008 i = littlelen - len;
5009 if (i > 0) { /* string might grow */
5010 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5011 mid = big + offset + len;
5012 midend = bigend = big + SvCUR(bigstr);
5015 while (midend > mid) /* shove everything down */
5016 *--bigend = *--midend;
5017 Move(little,big+offset,littlelen,char);
5018 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5023 Move(little,SvPVX(bigstr)+offset,len,char);
5028 big = SvPVX(bigstr);
5031 bigend = big + SvCUR(bigstr);
5033 if (midend > bigend)
5034 Perl_croak(aTHX_ "panic: sv_insert");
5036 if (mid - big > bigend - midend) { /* faster to shorten from end */
5038 Move(little, mid, littlelen,char);
5041 i = bigend - midend;
5043 Move(midend, mid, i,char);
5047 SvCUR_set(bigstr, mid - big);
5049 else if ((i = mid - big)) { /* faster from front */
5050 midend -= littlelen;
5052 Move(big, midend - i, i, char);
5053 sv_chop(bigstr,midend-i);
5055 Move(little, mid, littlelen,char);
5057 else if (littlelen) {
5058 midend -= littlelen;
5059 sv_chop(bigstr,midend);
5060 Move(little,midend,littlelen,char);
5063 sv_chop(bigstr,midend);
5069 =for apidoc sv_replace
5071 Make the first argument a copy of the second, then delete the original.
5072 The target SV physically takes over ownership of the body of the source SV
5073 and inherits its flags; however, the target keeps any magic it owns,
5074 and any magic in the source is discarded.
5075 Note that this is a rather specialist SV copying operation; most of the
5076 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5082 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5085 const U32 refcnt = SvREFCNT(sv);
5086 SV_CHECK_THINKFIRST_COW_DROP(sv);
5087 if (SvREFCNT(nsv) != 1) {
5088 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5089 UVuf " != 1)", (UV) SvREFCNT(nsv));
5091 if (SvMAGICAL(sv)) {
5095 sv_upgrade(nsv, SVt_PVMG);
5096 SvMAGIC_set(nsv, SvMAGIC(sv));
5097 SvFLAGS(nsv) |= SvMAGICAL(sv);
5099 SvMAGIC_set(sv, NULL);
5103 assert(!SvREFCNT(sv));
5104 #ifdef DEBUG_LEAKING_SCALARS
5105 sv->sv_flags = nsv->sv_flags;
5106 sv->sv_any = nsv->sv_any;
5107 sv->sv_refcnt = nsv->sv_refcnt;
5108 sv->sv_u = nsv->sv_u;
5110 StructCopy(nsv,sv,SV);
5112 if(SvTYPE(sv) == SVt_IV) {
5114 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5118 #ifdef PERL_OLD_COPY_ON_WRITE
5119 if (SvIsCOW_normal(nsv)) {
5120 /* We need to follow the pointers around the loop to make the
5121 previous SV point to sv, rather than nsv. */
5124 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5127 assert(SvPVX_const(current) == SvPVX_const(nsv));
5129 /* Make the SV before us point to the SV after us. */
5131 PerlIO_printf(Perl_debug_log, "previous is\n");
5133 PerlIO_printf(Perl_debug_log,
5134 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5135 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5137 SV_COW_NEXT_SV_SET(current, sv);
5140 SvREFCNT(sv) = refcnt;
5141 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5147 =for apidoc sv_clear
5149 Clear an SV: call any destructors, free up any memory used by the body,
5150 and free the body itself. The SV's head is I<not> freed, although
5151 its type is set to all 1's so that it won't inadvertently be assumed
5152 to be live during global destruction etc.
5153 This function should only be called when REFCNT is zero. Most of the time
5154 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5161 Perl_sv_clear(pTHX_ register SV *sv)
5164 const U32 type = SvTYPE(sv);
5165 const struct body_details *const sv_type_details
5166 = bodies_by_type + type;
5170 assert(SvREFCNT(sv) == 0);
5171 assert(SvTYPE(sv) != SVTYPEMASK);
5173 if (type <= SVt_IV) {
5174 /* See the comment in sv.h about the collusion between this early
5175 return and the overloading of the NULL and IV slots in the size
5178 SV * const target = SvRV(sv);
5180 sv_del_backref(target, sv);
5182 SvREFCNT_dec(target);
5184 SvFLAGS(sv) &= SVf_BREAK;
5185 SvFLAGS(sv) |= SVTYPEMASK;
5190 if (PL_defstash && /* Still have a symbol table? */
5197 stash = SvSTASH(sv);
5198 destructor = StashHANDLER(stash,DESTROY);
5200 SV* const tmpref = newRV(sv);
5201 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5203 PUSHSTACKi(PERLSI_DESTROY);
5208 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5214 if(SvREFCNT(tmpref) < 2) {
5215 /* tmpref is not kept alive! */
5217 SvRV_set(tmpref, NULL);
5220 SvREFCNT_dec(tmpref);
5222 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5226 if (PL_in_clean_objs)
5227 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5229 /* DESTROY gave object new lease on life */
5235 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5236 SvOBJECT_off(sv); /* Curse the object. */
5237 if (type != SVt_PVIO)
5238 --PL_sv_objcount; /* XXX Might want something more general */
5241 if (type >= SVt_PVMG) {
5242 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5243 SvREFCNT_dec(SvOURSTASH(sv));
5244 } else if (SvMAGIC(sv))
5246 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5247 SvREFCNT_dec(SvSTASH(sv));
5250 /* case SVt_BIND: */
5253 IoIFP(sv) != PerlIO_stdin() &&
5254 IoIFP(sv) != PerlIO_stdout() &&
5255 IoIFP(sv) != PerlIO_stderr())
5257 io_close((IO*)sv, FALSE);
5259 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5260 PerlDir_close(IoDIRP(sv));
5261 IoDIRP(sv) = (DIR*)NULL;
5262 Safefree(IoTOP_NAME(sv));
5263 Safefree(IoFMT_NAME(sv));
5264 Safefree(IoBOTTOM_NAME(sv));
5267 /* FIXME for plugins */
5268 pregfree2((REGEXP*) sv);
5275 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5279 if (PL_comppad == (AV*)sv) {
5286 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5287 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5288 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5289 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5291 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5292 SvREFCNT_dec(LvTARG(sv));
5294 if (isGV_with_GP(sv)) {
5295 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5296 mro_method_changed_in(stash);
5299 unshare_hek(GvNAME_HEK(sv));
5300 /* If we're in a stash, we don't own a reference to it. However it does
5301 have a back reference to us, which needs to be cleared. */
5302 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5303 sv_del_backref((SV*)stash, sv);
5305 /* FIXME. There are probably more unreferenced pointers to SVs in the
5306 interpreter struct that we should check and tidy in a similar
5308 if ((GV*)sv == PL_last_in_gv)
5309 PL_last_in_gv = NULL;
5315 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5318 SvOOK_offset(sv, offset);
5319 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5320 /* Don't even bother with turning off the OOK flag. */
5323 SV * const target = SvRV(sv);
5325 sv_del_backref(target, sv);
5327 SvREFCNT_dec(target);
5329 #ifdef PERL_OLD_COPY_ON_WRITE
5330 else if (SvPVX_const(sv)) {
5332 /* I believe I need to grab the global SV mutex here and
5333 then recheck the COW status. */
5335 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5339 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5341 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5344 /* And drop it here. */
5346 } else if (SvLEN(sv)) {
5347 Safefree(SvPVX_const(sv));
5351 else if (SvPVX_const(sv) && SvLEN(sv))
5352 Safefree(SvPVX_mutable(sv));
5353 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5354 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5363 SvFLAGS(sv) &= SVf_BREAK;
5364 SvFLAGS(sv) |= SVTYPEMASK;
5366 if (sv_type_details->arena) {
5367 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5368 &PL_body_roots[type]);
5370 else if (sv_type_details->body_size) {
5371 my_safefree(SvANY(sv));
5376 =for apidoc sv_newref
5378 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5385 Perl_sv_newref(pTHX_ SV *sv)
5387 PERL_UNUSED_CONTEXT;
5396 Decrement an SV's reference count, and if it drops to zero, call
5397 C<sv_clear> to invoke destructors and free up any memory used by
5398 the body; finally, deallocate the SV's head itself.
5399 Normally called via a wrapper macro C<SvREFCNT_dec>.
5405 Perl_sv_free(pTHX_ SV *sv)
5410 if (SvREFCNT(sv) == 0) {
5411 if (SvFLAGS(sv) & SVf_BREAK)
5412 /* this SV's refcnt has been artificially decremented to
5413 * trigger cleanup */
5415 if (PL_in_clean_all) /* All is fair */
5417 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5418 /* make sure SvREFCNT(sv)==0 happens very seldom */
5419 SvREFCNT(sv) = (~(U32)0)/2;
5422 if (ckWARN_d(WARN_INTERNAL)) {
5423 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5424 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5425 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5426 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5427 Perl_dump_sv_child(aTHX_ sv);
5429 #ifdef DEBUG_LEAKING_SCALARS
5434 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5439 if (--(SvREFCNT(sv)) > 0)
5441 Perl_sv_free2(aTHX_ sv);
5445 Perl_sv_free2(pTHX_ SV *sv)
5450 if (ckWARN_d(WARN_DEBUGGING))
5451 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5452 "Attempt to free temp prematurely: SV 0x%"UVxf
5453 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5457 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5458 /* make sure SvREFCNT(sv)==0 happens very seldom */
5459 SvREFCNT(sv) = (~(U32)0)/2;
5470 Returns the length of the string in the SV. Handles magic and type
5471 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5477 Perl_sv_len(pTHX_ register SV *sv)
5485 len = mg_length(sv);
5487 (void)SvPV_const(sv, len);
5492 =for apidoc sv_len_utf8
5494 Returns the number of characters in the string in an SV, counting wide
5495 UTF-8 bytes as a single character. Handles magic and type coercion.
5501 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5502 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5503 * (Note that the mg_len is not the length of the mg_ptr field.
5504 * This allows the cache to store the character length of the string without
5505 * needing to malloc() extra storage to attach to the mg_ptr.)
5510 Perl_sv_len_utf8(pTHX_ register SV *sv)
5516 return mg_length(sv);
5520 const U8 *s = (U8*)SvPV_const(sv, len);
5524 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5526 if (mg && mg->mg_len != -1) {
5528 if (PL_utf8cache < 0) {
5529 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5531 /* Need to turn the assertions off otherwise we may
5532 recurse infinitely while printing error messages.
5534 SAVEI8(PL_utf8cache);
5536 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5537 " real %"UVuf" for %"SVf,
5538 (UV) ulen, (UV) real, SVfARG(sv));
5543 ulen = Perl_utf8_length(aTHX_ s, s + len);
5544 if (!SvREADONLY(sv)) {
5546 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5547 &PL_vtbl_utf8, 0, 0);
5555 return Perl_utf8_length(aTHX_ s, s + len);
5559 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5562 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5565 const U8 *s = start;
5567 while (s < send && uoffset--)
5570 /* This is the existing behaviour. Possibly it should be a croak, as
5571 it's actually a bounds error */
5577 /* Given the length of the string in both bytes and UTF-8 characters, decide
5578 whether to walk forwards or backwards to find the byte corresponding to
5579 the passed in UTF-8 offset. */
5581 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5582 STRLEN uoffset, STRLEN uend)
5584 STRLEN backw = uend - uoffset;
5585 if (uoffset < 2 * backw) {
5586 /* The assumption is that going forwards is twice the speed of going
5587 forward (that's where the 2 * backw comes from).
5588 (The real figure of course depends on the UTF-8 data.) */
5589 return sv_pos_u2b_forwards(start, send, uoffset);
5594 while (UTF8_IS_CONTINUATION(*send))
5597 return send - start;
5600 /* For the string representation of the given scalar, find the byte
5601 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5602 give another position in the string, *before* the sought offset, which
5603 (which is always true, as 0, 0 is a valid pair of positions), which should
5604 help reduce the amount of linear searching.
5605 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5606 will be used to reduce the amount of linear searching. The cache will be
5607 created if necessary, and the found value offered to it for update. */
5609 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5610 const U8 *const send, STRLEN uoffset,
5611 STRLEN uoffset0, STRLEN boffset0) {
5612 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5615 assert (uoffset >= uoffset0);
5617 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5618 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5619 if ((*mgp)->mg_ptr) {
5620 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5621 if (cache[0] == uoffset) {
5622 /* An exact match. */
5625 if (cache[2] == uoffset) {
5626 /* An exact match. */
5630 if (cache[0] < uoffset) {
5631 /* The cache already knows part of the way. */
5632 if (cache[0] > uoffset0) {
5633 /* The cache knows more than the passed in pair */
5634 uoffset0 = cache[0];
5635 boffset0 = cache[1];
5637 if ((*mgp)->mg_len != -1) {
5638 /* And we know the end too. */
5640 + sv_pos_u2b_midway(start + boffset0, send,
5642 (*mgp)->mg_len - uoffset0);
5645 + sv_pos_u2b_forwards(start + boffset0,
5646 send, uoffset - uoffset0);
5649 else if (cache[2] < uoffset) {
5650 /* We're between the two cache entries. */
5651 if (cache[2] > uoffset0) {
5652 /* and the cache knows more than the passed in pair */
5653 uoffset0 = cache[2];
5654 boffset0 = cache[3];
5658 + sv_pos_u2b_midway(start + boffset0,
5661 cache[0] - uoffset0);
5664 + sv_pos_u2b_midway(start + boffset0,
5667 cache[2] - uoffset0);
5671 else if ((*mgp)->mg_len != -1) {
5672 /* If we can take advantage of a passed in offset, do so. */
5673 /* In fact, offset0 is either 0, or less than offset, so don't
5674 need to worry about the other possibility. */
5676 + sv_pos_u2b_midway(start + boffset0, send,
5678 (*mgp)->mg_len - uoffset0);
5683 if (!found || PL_utf8cache < 0) {
5684 const STRLEN real_boffset
5685 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5686 send, uoffset - uoffset0);
5688 if (found && PL_utf8cache < 0) {
5689 if (real_boffset != boffset) {
5690 /* Need to turn the assertions off otherwise we may recurse
5691 infinitely while printing error messages. */
5692 SAVEI8(PL_utf8cache);
5694 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5695 " real %"UVuf" for %"SVf,
5696 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5699 boffset = real_boffset;
5702 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5708 =for apidoc sv_pos_u2b
5710 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5711 the start of the string, to a count of the equivalent number of bytes; if
5712 lenp is non-zero, it does the same to lenp, but this time starting from
5713 the offset, rather than from the start of the string. Handles magic and
5720 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5721 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5722 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5727 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5735 start = (U8*)SvPV_const(sv, len);
5737 STRLEN uoffset = (STRLEN) *offsetp;
5738 const U8 * const send = start + len;
5740 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5743 *offsetp = (I32) boffset;
5746 /* Convert the relative offset to absolute. */
5747 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5748 const STRLEN boffset2
5749 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5750 uoffset, boffset) - boffset;
5764 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5765 byte length pairing. The (byte) length of the total SV is passed in too,
5766 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5767 may not have updated SvCUR, so we can't rely on reading it directly.
5769 The proffered utf8/byte length pairing isn't used if the cache already has
5770 two pairs, and swapping either for the proffered pair would increase the
5771 RMS of the intervals between known byte offsets.
5773 The cache itself consists of 4 STRLEN values
5774 0: larger UTF-8 offset
5775 1: corresponding byte offset
5776 2: smaller UTF-8 offset
5777 3: corresponding byte offset
5779 Unused cache pairs have the value 0, 0.
5780 Keeping the cache "backwards" means that the invariant of
5781 cache[0] >= cache[2] is maintained even with empty slots, which means that
5782 the code that uses it doesn't need to worry if only 1 entry has actually
5783 been set to non-zero. It also makes the "position beyond the end of the
5784 cache" logic much simpler, as the first slot is always the one to start
5788 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5796 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5798 (*mgp)->mg_len = -1;
5802 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5803 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5804 (*mgp)->mg_ptr = (char *) cache;
5808 if (PL_utf8cache < 0) {
5809 const U8 *start = (const U8 *) SvPVX_const(sv);
5810 const STRLEN realutf8 = utf8_length(start, start + byte);
5812 if (realutf8 != utf8) {
5813 /* Need to turn the assertions off otherwise we may recurse
5814 infinitely while printing error messages. */
5815 SAVEI8(PL_utf8cache);
5817 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5818 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5822 /* Cache is held with the later position first, to simplify the code
5823 that deals with unbounded ends. */
5825 ASSERT_UTF8_CACHE(cache);
5826 if (cache[1] == 0) {
5827 /* Cache is totally empty */
5830 } else if (cache[3] == 0) {
5831 if (byte > cache[1]) {
5832 /* New one is larger, so goes first. */
5833 cache[2] = cache[0];
5834 cache[3] = cache[1];
5842 #define THREEWAY_SQUARE(a,b,c,d) \
5843 ((float)((d) - (c))) * ((float)((d) - (c))) \
5844 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5845 + ((float)((b) - (a))) * ((float)((b) - (a)))
5847 /* Cache has 2 slots in use, and we know three potential pairs.
5848 Keep the two that give the lowest RMS distance. Do the
5849 calcualation in bytes simply because we always know the byte
5850 length. squareroot has the same ordering as the positive value,
5851 so don't bother with the actual square root. */
5852 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5853 if (byte > cache[1]) {
5854 /* New position is after the existing pair of pairs. */
5855 const float keep_earlier
5856 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5857 const float keep_later
5858 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5860 if (keep_later < keep_earlier) {
5861 if (keep_later < existing) {
5862 cache[2] = cache[0];
5863 cache[3] = cache[1];
5869 if (keep_earlier < existing) {
5875 else if (byte > cache[3]) {
5876 /* New position is between the existing pair of pairs. */
5877 const float keep_earlier
5878 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5879 const float keep_later
5880 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5882 if (keep_later < keep_earlier) {
5883 if (keep_later < existing) {
5889 if (keep_earlier < existing) {
5896 /* New position is before the existing pair of pairs. */
5897 const float keep_earlier
5898 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5899 const float keep_later
5900 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5902 if (keep_later < keep_earlier) {
5903 if (keep_later < existing) {
5909 if (keep_earlier < existing) {
5910 cache[0] = cache[2];
5911 cache[1] = cache[3];
5918 ASSERT_UTF8_CACHE(cache);
5921 /* We already know all of the way, now we may be able to walk back. The same
5922 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5923 backward is half the speed of walking forward. */
5925 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5928 const STRLEN forw = target - s;
5929 STRLEN backw = end - target;
5931 if (forw < 2 * backw) {
5932 return utf8_length(s, target);
5935 while (end > target) {
5937 while (UTF8_IS_CONTINUATION(*end)) {
5946 =for apidoc sv_pos_b2u
5948 Converts the value pointed to by offsetp from a count of bytes from the
5949 start of the string, to a count of the equivalent number of UTF-8 chars.
5950 Handles magic and type coercion.
5956 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5957 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5962 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5965 const STRLEN byte = *offsetp;
5966 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5975 s = (const U8*)SvPV_const(sv, blen);
5978 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5982 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5983 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5985 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5986 if (cache[1] == byte) {
5987 /* An exact match. */
5988 *offsetp = cache[0];
5991 if (cache[3] == byte) {
5992 /* An exact match. */
5993 *offsetp = cache[2];
5997 if (cache[1] < byte) {
5998 /* We already know part of the way. */
5999 if (mg->mg_len != -1) {
6000 /* Actually, we know the end too. */
6002 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6003 s + blen, mg->mg_len - cache[0]);
6005 len = cache[0] + utf8_length(s + cache[1], send);
6008 else if (cache[3] < byte) {
6009 /* We're between the two cached pairs, so we do the calculation
6010 offset by the byte/utf-8 positions for the earlier pair,
6011 then add the utf-8 characters from the string start to
6013 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6014 s + cache[1], cache[0] - cache[2])
6018 else { /* cache[3] > byte */
6019 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6023 ASSERT_UTF8_CACHE(cache);
6025 } else if (mg->mg_len != -1) {
6026 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6030 if (!found || PL_utf8cache < 0) {
6031 const STRLEN real_len = utf8_length(s, send);
6033 if (found && PL_utf8cache < 0) {
6034 if (len != real_len) {
6035 /* Need to turn the assertions off otherwise we may recurse
6036 infinitely while printing error messages. */
6037 SAVEI8(PL_utf8cache);
6039 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6040 " real %"UVuf" for %"SVf,
6041 (UV) len, (UV) real_len, SVfARG(sv));
6048 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6054 Returns a boolean indicating whether the strings in the two SVs are
6055 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6056 coerce its args to strings if necessary.
6062 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6071 SV* svrecode = NULL;
6078 /* if pv1 and pv2 are the same, second SvPV_const call may
6079 * invalidate pv1, so we may need to make a copy */
6080 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6081 pv1 = SvPV_const(sv1, cur1);
6082 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6084 pv1 = SvPV_const(sv1, cur1);
6092 pv2 = SvPV_const(sv2, cur2);
6094 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6095 /* Differing utf8ness.
6096 * Do not UTF8size the comparands as a side-effect. */
6099 svrecode = newSVpvn(pv2, cur2);
6100 sv_recode_to_utf8(svrecode, PL_encoding);
6101 pv2 = SvPV_const(svrecode, cur2);
6104 svrecode = newSVpvn(pv1, cur1);
6105 sv_recode_to_utf8(svrecode, PL_encoding);
6106 pv1 = SvPV_const(svrecode, cur1);
6108 /* Now both are in UTF-8. */
6110 SvREFCNT_dec(svrecode);
6115 bool is_utf8 = TRUE;
6118 /* sv1 is the UTF-8 one,
6119 * if is equal it must be downgrade-able */
6120 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6126 /* sv2 is the UTF-8 one,
6127 * if is equal it must be downgrade-able */
6128 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6134 /* Downgrade not possible - cannot be eq */
6142 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6144 SvREFCNT_dec(svrecode);
6154 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6155 string in C<sv1> is less than, equal to, or greater than the string in
6156 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6157 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6163 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6167 const char *pv1, *pv2;
6170 SV *svrecode = NULL;
6177 pv1 = SvPV_const(sv1, cur1);
6184 pv2 = SvPV_const(sv2, cur2);
6186 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6187 /* Differing utf8ness.
6188 * Do not UTF8size the comparands as a side-effect. */
6191 svrecode = newSVpvn(pv2, cur2);
6192 sv_recode_to_utf8(svrecode, PL_encoding);
6193 pv2 = SvPV_const(svrecode, cur2);
6196 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6201 svrecode = newSVpvn(pv1, cur1);
6202 sv_recode_to_utf8(svrecode, PL_encoding);
6203 pv1 = SvPV_const(svrecode, cur1);
6206 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6212 cmp = cur2 ? -1 : 0;
6216 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6219 cmp = retval < 0 ? -1 : 1;
6220 } else if (cur1 == cur2) {
6223 cmp = cur1 < cur2 ? -1 : 1;
6227 SvREFCNT_dec(svrecode);
6235 =for apidoc sv_cmp_locale
6237 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6238 'use bytes' aware, handles get magic, and will coerce its args to strings
6239 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6245 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6248 #ifdef USE_LOCALE_COLLATE
6254 if (PL_collation_standard)
6258 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6260 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6262 if (!pv1 || !len1) {
6273 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6276 return retval < 0 ? -1 : 1;
6279 * When the result of collation is equality, that doesn't mean
6280 * that there are no differences -- some locales exclude some
6281 * characters from consideration. So to avoid false equalities,
6282 * we use the raw string as a tiebreaker.
6288 #endif /* USE_LOCALE_COLLATE */
6290 return sv_cmp(sv1, sv2);
6294 #ifdef USE_LOCALE_COLLATE
6297 =for apidoc sv_collxfrm
6299 Add Collate Transform magic to an SV if it doesn't already have it.
6301 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6302 scalar data of the variable, but transformed to such a format that a normal
6303 memory comparison can be used to compare the data according to the locale
6310 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6315 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6316 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6322 Safefree(mg->mg_ptr);
6323 s = SvPV_const(sv, len);
6324 if ((xf = mem_collxfrm(s, len, &xlen))) {
6325 if (SvREADONLY(sv)) {
6328 return xf + sizeof(PL_collation_ix);
6331 #ifdef PERL_OLD_COPY_ON_WRITE
6333 sv_force_normal_flags(sv, 0);
6335 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6349 if (mg && mg->mg_ptr) {
6351 return mg->mg_ptr + sizeof(PL_collation_ix);
6359 #endif /* USE_LOCALE_COLLATE */
6364 Get a line from the filehandle and store it into the SV, optionally
6365 appending to the currently-stored string.
6371 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6376 register STDCHAR rslast;
6377 register STDCHAR *bp;
6382 if (SvTHINKFIRST(sv))
6383 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6384 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6386 However, perlbench says it's slower, because the existing swipe code
6387 is faster than copy on write.
6388 Swings and roundabouts. */
6389 SvUPGRADE(sv, SVt_PV);
6394 if (PerlIO_isutf8(fp)) {
6396 sv_utf8_upgrade_nomg(sv);
6397 sv_pos_u2b(sv,&append,0);
6399 } else if (SvUTF8(sv)) {
6400 SV * const tsv = newSV(0);
6401 sv_gets(tsv, fp, 0);
6402 sv_utf8_upgrade_nomg(tsv);
6403 SvCUR_set(sv,append);
6406 goto return_string_or_null;
6411 if (PerlIO_isutf8(fp))
6414 if (IN_PERL_COMPILETIME) {
6415 /* we always read code in line mode */
6419 else if (RsSNARF(PL_rs)) {
6420 /* If it is a regular disk file use size from stat() as estimate
6421 of amount we are going to read -- may result in mallocing
6422 more memory than we really need if the layers below reduce
6423 the size we read (e.g. CRLF or a gzip layer).
6426 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6427 const Off_t offset = PerlIO_tell(fp);
6428 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6429 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6435 else if (RsRECORD(PL_rs)) {
6440 /* Grab the size of the record we're getting */
6441 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6442 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6445 /* VMS wants read instead of fread, because fread doesn't respect */
6446 /* RMS record boundaries. This is not necessarily a good thing to be */
6447 /* doing, but we've got no other real choice - except avoid stdio
6448 as implementation - perhaps write a :vms layer ?
6450 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6452 bytesread = PerlIO_read(fp, buffer, recsize);
6456 SvCUR_set(sv, bytesread += append);
6457 buffer[bytesread] = '\0';
6458 goto return_string_or_null;
6460 else if (RsPARA(PL_rs)) {
6466 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6467 if (PerlIO_isutf8(fp)) {
6468 rsptr = SvPVutf8(PL_rs, rslen);
6471 if (SvUTF8(PL_rs)) {
6472 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6473 Perl_croak(aTHX_ "Wide character in $/");
6476 rsptr = SvPV_const(PL_rs, rslen);
6480 rslast = rslen ? rsptr[rslen - 1] : '\0';
6482 if (rspara) { /* have to do this both before and after */
6483 do { /* to make sure file boundaries work right */
6486 i = PerlIO_getc(fp);
6490 PerlIO_ungetc(fp,i);
6496 /* See if we know enough about I/O mechanism to cheat it ! */
6498 /* This used to be #ifdef test - it is made run-time test for ease
6499 of abstracting out stdio interface. One call should be cheap
6500 enough here - and may even be a macro allowing compile
6504 if (PerlIO_fast_gets(fp)) {
6507 * We're going to steal some values from the stdio struct
6508 * and put EVERYTHING in the innermost loop into registers.
6510 register STDCHAR *ptr;
6514 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6515 /* An ungetc()d char is handled separately from the regular
6516 * buffer, so we getc() it back out and stuff it in the buffer.
6518 i = PerlIO_getc(fp);
6519 if (i == EOF) return 0;
6520 *(--((*fp)->_ptr)) = (unsigned char) i;
6524 /* Here is some breathtakingly efficient cheating */
6526 cnt = PerlIO_get_cnt(fp); /* get count into register */
6527 /* make sure we have the room */
6528 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6529 /* Not room for all of it
6530 if we are looking for a separator and room for some
6532 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6533 /* just process what we have room for */
6534 shortbuffered = cnt - SvLEN(sv) + append + 1;
6535 cnt -= shortbuffered;
6539 /* remember that cnt can be negative */
6540 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6545 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6546 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6547 DEBUG_P(PerlIO_printf(Perl_debug_log,
6548 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6549 DEBUG_P(PerlIO_printf(Perl_debug_log,
6550 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6551 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6552 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6557 while (cnt > 0) { /* this | eat */
6559 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6560 goto thats_all_folks; /* screams | sed :-) */
6564 Copy(ptr, bp, cnt, char); /* this | eat */
6565 bp += cnt; /* screams | dust */
6566 ptr += cnt; /* louder | sed :-) */
6571 if (shortbuffered) { /* oh well, must extend */
6572 cnt = shortbuffered;
6574 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6576 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6577 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6581 DEBUG_P(PerlIO_printf(Perl_debug_log,
6582 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6583 PTR2UV(ptr),(long)cnt));
6584 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6586 DEBUG_P(PerlIO_printf(Perl_debug_log,
6587 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6588 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6589 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6591 /* This used to call 'filbuf' in stdio form, but as that behaves like
6592 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6593 another abstraction. */
6594 i = PerlIO_getc(fp); /* get more characters */
6596 DEBUG_P(PerlIO_printf(Perl_debug_log,
6597 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6598 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6599 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6601 cnt = PerlIO_get_cnt(fp);
6602 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6603 DEBUG_P(PerlIO_printf(Perl_debug_log,
6604 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6606 if (i == EOF) /* all done for ever? */
6607 goto thats_really_all_folks;
6609 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6611 SvGROW(sv, bpx + cnt + 2);
6612 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6614 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6616 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6617 goto thats_all_folks;
6621 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6622 memNE((char*)bp - rslen, rsptr, rslen))
6623 goto screamer; /* go back to the fray */
6624 thats_really_all_folks:
6626 cnt += shortbuffered;
6627 DEBUG_P(PerlIO_printf(Perl_debug_log,
6628 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6629 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6630 DEBUG_P(PerlIO_printf(Perl_debug_log,
6631 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6632 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6633 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6635 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6636 DEBUG_P(PerlIO_printf(Perl_debug_log,
6637 "Screamer: done, len=%ld, string=|%.*s|\n",
6638 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6642 /*The big, slow, and stupid way. */
6643 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6644 STDCHAR *buf = NULL;
6645 Newx(buf, 8192, STDCHAR);
6653 register const STDCHAR * const bpe = buf + sizeof(buf);
6655 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6656 ; /* keep reading */
6660 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6661 /* Accomodate broken VAXC compiler, which applies U8 cast to
6662 * both args of ?: operator, causing EOF to change into 255
6665 i = (U8)buf[cnt - 1];
6671 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6673 sv_catpvn(sv, (char *) buf, cnt);
6675 sv_setpvn(sv, (char *) buf, cnt);
6677 if (i != EOF && /* joy */
6679 SvCUR(sv) < rslen ||
6680 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6684 * If we're reading from a TTY and we get a short read,
6685 * indicating that the user hit his EOF character, we need
6686 * to notice it now, because if we try to read from the TTY
6687 * again, the EOF condition will disappear.
6689 * The comparison of cnt to sizeof(buf) is an optimization
6690 * that prevents unnecessary calls to feof().
6694 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6698 #ifdef USE_HEAP_INSTEAD_OF_STACK
6703 if (rspara) { /* have to do this both before and after */
6704 while (i != EOF) { /* to make sure file boundaries work right */
6705 i = PerlIO_getc(fp);
6707 PerlIO_ungetc(fp,i);
6713 return_string_or_null:
6714 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6720 Auto-increment of the value in the SV, doing string to numeric conversion
6721 if necessary. Handles 'get' magic.
6727 Perl_sv_inc(pTHX_ register SV *sv)
6736 if (SvTHINKFIRST(sv)) {
6738 sv_force_normal_flags(sv, 0);
6739 if (SvREADONLY(sv)) {
6740 if (IN_PERL_RUNTIME)
6741 Perl_croak(aTHX_ PL_no_modify);
6745 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6747 i = PTR2IV(SvRV(sv));
6752 flags = SvFLAGS(sv);
6753 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6754 /* It's (privately or publicly) a float, but not tested as an
6755 integer, so test it to see. */
6757 flags = SvFLAGS(sv);
6759 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6760 /* It's publicly an integer, or privately an integer-not-float */
6761 #ifdef PERL_PRESERVE_IVUV
6765 if (SvUVX(sv) == UV_MAX)
6766 sv_setnv(sv, UV_MAX_P1);
6768 (void)SvIOK_only_UV(sv);
6769 SvUV_set(sv, SvUVX(sv) + 1);
6771 if (SvIVX(sv) == IV_MAX)
6772 sv_setuv(sv, (UV)IV_MAX + 1);
6774 (void)SvIOK_only(sv);
6775 SvIV_set(sv, SvIVX(sv) + 1);
6780 if (flags & SVp_NOK) {
6781 (void)SvNOK_only(sv);
6782 SvNV_set(sv, SvNVX(sv) + 1.0);
6786 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6787 if ((flags & SVTYPEMASK) < SVt_PVIV)
6788 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6789 (void)SvIOK_only(sv);
6794 while (isALPHA(*d)) d++;
6795 while (isDIGIT(*d)) d++;
6797 #ifdef PERL_PRESERVE_IVUV
6798 /* Got to punt this as an integer if needs be, but we don't issue
6799 warnings. Probably ought to make the sv_iv_please() that does
6800 the conversion if possible, and silently. */
6801 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6802 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6803 /* Need to try really hard to see if it's an integer.
6804 9.22337203685478e+18 is an integer.
6805 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6806 so $a="9.22337203685478e+18"; $a+0; $a++
6807 needs to be the same as $a="9.22337203685478e+18"; $a++
6814 /* sv_2iv *should* have made this an NV */
6815 if (flags & SVp_NOK) {
6816 (void)SvNOK_only(sv);
6817 SvNV_set(sv, SvNVX(sv) + 1.0);
6820 /* I don't think we can get here. Maybe I should assert this
6821 And if we do get here I suspect that sv_setnv will croak. NWC
6823 #if defined(USE_LONG_DOUBLE)
6824 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",
6825 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6827 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6828 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6831 #endif /* PERL_PRESERVE_IVUV */
6832 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6836 while (d >= SvPVX_const(sv)) {
6844 /* MKS: The original code here died if letters weren't consecutive.
6845 * at least it didn't have to worry about non-C locales. The
6846 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6847 * arranged in order (although not consecutively) and that only
6848 * [A-Za-z] are accepted by isALPHA in the C locale.
6850 if (*d != 'z' && *d != 'Z') {
6851 do { ++*d; } while (!isALPHA(*d));
6854 *(d--) -= 'z' - 'a';
6859 *(d--) -= 'z' - 'a' + 1;
6863 /* oh,oh, the number grew */
6864 SvGROW(sv, SvCUR(sv) + 2);
6865 SvCUR_set(sv, SvCUR(sv) + 1);
6866 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6877 Auto-decrement of the value in the SV, doing string to numeric conversion
6878 if necessary. Handles 'get' magic.
6884 Perl_sv_dec(pTHX_ register SV *sv)
6892 if (SvTHINKFIRST(sv)) {
6894 sv_force_normal_flags(sv, 0);
6895 if (SvREADONLY(sv)) {
6896 if (IN_PERL_RUNTIME)
6897 Perl_croak(aTHX_ PL_no_modify);
6901 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6903 i = PTR2IV(SvRV(sv));
6908 /* Unlike sv_inc we don't have to worry about string-never-numbers
6909 and keeping them magic. But we mustn't warn on punting */
6910 flags = SvFLAGS(sv);
6911 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6912 /* It's publicly an integer, or privately an integer-not-float */
6913 #ifdef PERL_PRESERVE_IVUV
6917 if (SvUVX(sv) == 0) {
6918 (void)SvIOK_only(sv);
6922 (void)SvIOK_only_UV(sv);
6923 SvUV_set(sv, SvUVX(sv) - 1);
6926 if (SvIVX(sv) == IV_MIN)
6927 sv_setnv(sv, (NV)IV_MIN - 1.0);
6929 (void)SvIOK_only(sv);
6930 SvIV_set(sv, SvIVX(sv) - 1);
6935 if (flags & SVp_NOK) {
6936 SvNV_set(sv, SvNVX(sv) - 1.0);
6937 (void)SvNOK_only(sv);
6940 if (!(flags & SVp_POK)) {
6941 if ((flags & SVTYPEMASK) < SVt_PVIV)
6942 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6944 (void)SvIOK_only(sv);
6947 #ifdef PERL_PRESERVE_IVUV
6949 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6950 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6951 /* Need to try really hard to see if it's an integer.
6952 9.22337203685478e+18 is an integer.
6953 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6954 so $a="9.22337203685478e+18"; $a+0; $a--
6955 needs to be the same as $a="9.22337203685478e+18"; $a--
6962 /* sv_2iv *should* have made this an NV */
6963 if (flags & SVp_NOK) {
6964 (void)SvNOK_only(sv);
6965 SvNV_set(sv, SvNVX(sv) - 1.0);
6968 /* I don't think we can get here. Maybe I should assert this
6969 And if we do get here I suspect that sv_setnv will croak. NWC
6971 #if defined(USE_LONG_DOUBLE)
6972 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",
6973 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6975 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6976 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6980 #endif /* PERL_PRESERVE_IVUV */
6981 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6985 =for apidoc sv_mortalcopy
6987 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6988 The new SV is marked as mortal. It will be destroyed "soon", either by an
6989 explicit call to FREETMPS, or by an implicit call at places such as
6990 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6995 /* Make a string that will exist for the duration of the expression
6996 * evaluation. Actually, it may have to last longer than that, but
6997 * hopefully we won't free it until it has been assigned to a
6998 * permanent location. */
7001 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7007 sv_setsv(sv,oldstr);
7009 PL_tmps_stack[++PL_tmps_ix] = sv;
7015 =for apidoc sv_newmortal
7017 Creates a new null SV which is mortal. The reference count of the SV is
7018 set to 1. It will be destroyed "soon", either by an explicit call to
7019 FREETMPS, or by an implicit call at places such as statement boundaries.
7020 See also C<sv_mortalcopy> and C<sv_2mortal>.
7026 Perl_sv_newmortal(pTHX)
7032 SvFLAGS(sv) = SVs_TEMP;
7034 PL_tmps_stack[++PL_tmps_ix] = sv;
7040 =for apidoc newSVpvn_flags
7042 Creates a new SV and copies a string into it. The reference count for the
7043 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7044 string. You are responsible for ensuring that the source string is at least
7045 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7046 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7047 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7048 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7049 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7051 #define newSVpvn_utf8(s, len, u) \
7052 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7058 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7063 /* All the flags we don't support must be zero.
7064 And we're new code so I'm going to assert this from the start. */
7065 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7067 sv_setpvn(sv,s,len);
7068 SvFLAGS(sv) |= (flags & SVf_UTF8);
7069 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7073 =for apidoc sv_2mortal
7075 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7076 by an explicit call to FREETMPS, or by an implicit call at places such as
7077 statement boundaries. SvTEMP() is turned on which means that the SV's
7078 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7079 and C<sv_mortalcopy>.
7085 Perl_sv_2mortal(pTHX_ register SV *sv)
7090 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7093 PL_tmps_stack[++PL_tmps_ix] = sv;
7101 Creates a new SV and copies a string into it. The reference count for the
7102 SV is set to 1. If C<len> is zero, Perl will compute the length using
7103 strlen(). For efficiency, consider using C<newSVpvn> instead.
7109 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7115 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7120 =for apidoc newSVpvn
7122 Creates a new SV and copies a string into it. The reference count for the
7123 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7124 string. You are responsible for ensuring that the source string is at least
7125 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7131 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7137 sv_setpvn(sv,s,len);
7142 =for apidoc newSVhek
7144 Creates a new SV from the hash key structure. It will generate scalars that
7145 point to the shared string table where possible. Returns a new (undefined)
7146 SV if the hek is NULL.
7152 Perl_newSVhek(pTHX_ const HEK *hek)
7162 if (HEK_LEN(hek) == HEf_SVKEY) {
7163 return newSVsv(*(SV**)HEK_KEY(hek));
7165 const int flags = HEK_FLAGS(hek);
7166 if (flags & HVhek_WASUTF8) {
7168 Andreas would like keys he put in as utf8 to come back as utf8
7170 STRLEN utf8_len = HEK_LEN(hek);
7171 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7172 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7175 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7177 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7178 /* We don't have a pointer to the hv, so we have to replicate the
7179 flag into every HEK. This hv is using custom a hasing
7180 algorithm. Hence we can't return a shared string scalar, as
7181 that would contain the (wrong) hash value, and might get passed
7182 into an hv routine with a regular hash.
7183 Similarly, a hash that isn't using shared hash keys has to have
7184 the flag in every key so that we know not to try to call
7185 share_hek_kek on it. */
7187 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7192 /* This will be overwhelminly the most common case. */
7194 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7195 more efficient than sharepvn(). */
7199 sv_upgrade(sv, SVt_PV);
7200 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7201 SvCUR_set(sv, HEK_LEN(hek));
7214 =for apidoc newSVpvn_share
7216 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7217 table. If the string does not already exist in the table, it is created
7218 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7219 value is used; otherwise the hash is computed. The string's hash can be later
7220 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7221 that as the string table is used for shared hash keys these strings will have
7222 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7228 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7232 bool is_utf8 = FALSE;
7233 const char *const orig_src = src;
7236 STRLEN tmplen = -len;
7238 /* See the note in hv.c:hv_fetch() --jhi */
7239 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7243 PERL_HASH(hash, src, len);
7245 sv_upgrade(sv, SVt_PV);
7246 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7254 if (src != orig_src)
7260 #if defined(PERL_IMPLICIT_CONTEXT)
7262 /* pTHX_ magic can't cope with varargs, so this is a no-context
7263 * version of the main function, (which may itself be aliased to us).
7264 * Don't access this version directly.
7268 Perl_newSVpvf_nocontext(const char* pat, ...)
7273 va_start(args, pat);
7274 sv = vnewSVpvf(pat, &args);
7281 =for apidoc newSVpvf
7283 Creates a new SV and initializes it with the string formatted like
7290 Perl_newSVpvf(pTHX_ const char* pat, ...)
7294 va_start(args, pat);
7295 sv = vnewSVpvf(pat, &args);
7300 /* backend for newSVpvf() and newSVpvf_nocontext() */
7303 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7308 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7315 Creates a new SV and copies a floating point value into it.
7316 The reference count for the SV is set to 1.
7322 Perl_newSVnv(pTHX_ NV n)
7335 Creates a new SV and copies an integer into it. The reference count for the
7342 Perl_newSViv(pTHX_ IV i)
7355 Creates a new SV and copies an unsigned integer into it.
7356 The reference count for the SV is set to 1.
7362 Perl_newSVuv(pTHX_ UV u)
7373 =for apidoc newSV_type
7375 Creates a new SV, of the type specified. The reference count for the new SV
7382 Perl_newSV_type(pTHX_ svtype type)
7387 sv_upgrade(sv, type);
7392 =for apidoc newRV_noinc
7394 Creates an RV wrapper for an SV. The reference count for the original
7395 SV is B<not> incremented.
7401 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7404 register SV *sv = newSV_type(SVt_IV);
7406 SvRV_set(sv, tmpRef);
7411 /* newRV_inc is the official function name to use now.
7412 * newRV_inc is in fact #defined to newRV in sv.h
7416 Perl_newRV(pTHX_ SV *sv)
7419 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7425 Creates a new SV which is an exact duplicate of the original SV.
7432 Perl_newSVsv(pTHX_ register SV *old)
7439 if (SvTYPE(old) == SVTYPEMASK) {
7440 if (ckWARN_d(WARN_INTERNAL))
7441 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7445 /* SV_GMAGIC is the default for sv_setv()
7446 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7447 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7448 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7453 =for apidoc sv_reset
7455 Underlying implementation for the C<reset> Perl function.
7456 Note that the perl-level function is vaguely deprecated.
7462 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7465 char todo[PERL_UCHAR_MAX+1];
7470 if (!*s) { /* reset ?? searches */
7471 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7473 const U32 count = mg->mg_len / sizeof(PMOP**);
7474 PMOP **pmp = (PMOP**) mg->mg_ptr;
7475 PMOP *const *const end = pmp + count;
7479 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7481 (*pmp)->op_pmflags &= ~PMf_USED;
7489 /* reset variables */
7491 if (!HvARRAY(stash))
7494 Zero(todo, 256, char);
7497 I32 i = (unsigned char)*s;
7501 max = (unsigned char)*s++;
7502 for ( ; i <= max; i++) {
7505 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7507 for (entry = HvARRAY(stash)[i];
7509 entry = HeNEXT(entry))
7514 if (!todo[(U8)*HeKEY(entry)])
7516 gv = (GV*)HeVAL(entry);
7519 if (SvTHINKFIRST(sv)) {
7520 if (!SvREADONLY(sv) && SvROK(sv))
7522 /* XXX Is this continue a bug? Why should THINKFIRST
7523 exempt us from resetting arrays and hashes? */
7527 if (SvTYPE(sv) >= SVt_PV) {
7529 if (SvPVX_const(sv) != NULL)
7537 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7539 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7542 # if defined(USE_ENVIRON_ARRAY)
7545 # endif /* USE_ENVIRON_ARRAY */
7556 Using various gambits, try to get an IO from an SV: the IO slot if its a
7557 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7558 named after the PV if we're a string.
7564 Perl_sv_2io(pTHX_ SV *sv)
7569 switch (SvTYPE(sv)) {
7577 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7581 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7583 return sv_2io(SvRV(sv));
7584 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7590 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7599 Using various gambits, try to get a CV from an SV; in addition, try if
7600 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7601 The flags in C<lref> are passed to sv_fetchsv.
7607 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7618 switch (SvTYPE(sv)) {
7637 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7638 tryAMAGICunDEREF(to_cv);
7641 if (SvTYPE(sv) == SVt_PVCV) {
7650 Perl_croak(aTHX_ "Not a subroutine reference");
7655 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7661 /* Some flags to gv_fetchsv mean don't really create the GV */
7662 if (SvTYPE(gv) != SVt_PVGV) {
7668 if (lref && !GvCVu(gv)) {
7672 gv_efullname3(tmpsv, gv, NULL);
7673 /* XXX this is probably not what they think they're getting.
7674 * It has the same effect as "sub name;", i.e. just a forward
7676 newSUB(start_subparse(FALSE, 0),
7677 newSVOP(OP_CONST, 0, tmpsv),
7681 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7691 Returns true if the SV has a true value by Perl's rules.
7692 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7693 instead use an in-line version.
7699 Perl_sv_true(pTHX_ register SV *sv)
7704 register const XPV* const tXpv = (XPV*)SvANY(sv);
7706 (tXpv->xpv_cur > 1 ||
7707 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7714 return SvIVX(sv) != 0;
7717 return SvNVX(sv) != 0.0;
7719 return sv_2bool(sv);
7725 =for apidoc sv_pvn_force
7727 Get a sensible string out of the SV somehow.
7728 A private implementation of the C<SvPV_force> macro for compilers which
7729 can't cope with complex macro expressions. Always use the macro instead.
7731 =for apidoc sv_pvn_force_flags
7733 Get a sensible string out of the SV somehow.
7734 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7735 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7736 implemented in terms of this function.
7737 You normally want to use the various wrapper macros instead: see
7738 C<SvPV_force> and C<SvPV_force_nomg>
7744 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7747 if (SvTHINKFIRST(sv) && !SvROK(sv))
7748 sv_force_normal_flags(sv, 0);
7758 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7759 const char * const ref = sv_reftype(sv,0);
7761 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7762 ref, OP_NAME(PL_op));
7764 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7766 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7767 || isGV_with_GP(sv))
7768 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7770 s = sv_2pv_flags(sv, &len, flags);
7774 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7777 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7778 SvGROW(sv, len + 1);
7779 Move(s,SvPVX(sv),len,char);
7781 SvPVX(sv)[len] = '\0';
7784 SvPOK_on(sv); /* validate pointer */
7786 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7787 PTR2UV(sv),SvPVX_const(sv)));
7790 return SvPVX_mutable(sv);
7794 =for apidoc sv_pvbyten_force
7796 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7802 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7804 sv_pvn_force(sv,lp);
7805 sv_utf8_downgrade(sv,0);
7811 =for apidoc sv_pvutf8n_force
7813 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7819 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7821 sv_pvn_force(sv,lp);
7822 sv_utf8_upgrade(sv);
7828 =for apidoc sv_reftype
7830 Returns a string describing what the SV is a reference to.
7836 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7838 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7839 inside return suggests a const propagation bug in g++. */
7840 if (ob && SvOBJECT(sv)) {
7841 char * const name = HvNAME_get(SvSTASH(sv));
7842 return name ? name : (char *) "__ANON__";
7845 switch (SvTYPE(sv)) {
7860 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7861 /* tied lvalues should appear to be
7862 * scalars for backwards compatitbility */
7863 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7864 ? "SCALAR" : "LVALUE");
7865 case SVt_PVAV: return "ARRAY";
7866 case SVt_PVHV: return "HASH";
7867 case SVt_PVCV: return "CODE";
7868 case SVt_PVGV: return "GLOB";
7869 case SVt_PVFM: return "FORMAT";
7870 case SVt_PVIO: return "IO";
7871 case SVt_BIND: return "BIND";
7872 case SVt_REGEXP: return "REGEXP";
7873 default: return "UNKNOWN";
7879 =for apidoc sv_isobject
7881 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7882 object. If the SV is not an RV, or if the object is not blessed, then this
7889 Perl_sv_isobject(pTHX_ SV *sv)
7905 Returns a boolean indicating whether the SV is blessed into the specified
7906 class. This does not check for subtypes; use C<sv_derived_from> to verify
7907 an inheritance relationship.
7913 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7924 hvname = HvNAME_get(SvSTASH(sv));
7928 return strEQ(hvname, name);
7934 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7935 it will be upgraded to one. If C<classname> is non-null then the new SV will
7936 be blessed in the specified package. The new SV is returned and its
7937 reference count is 1.
7943 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7950 SV_CHECK_THINKFIRST_COW_DROP(rv);
7951 (void)SvAMAGIC_off(rv);
7953 if (SvTYPE(rv) >= SVt_PVMG) {
7954 const U32 refcnt = SvREFCNT(rv);
7958 SvREFCNT(rv) = refcnt;
7960 sv_upgrade(rv, SVt_IV);
7961 } else if (SvROK(rv)) {
7962 SvREFCNT_dec(SvRV(rv));
7964 prepare_SV_for_RV(rv);
7972 HV* const stash = gv_stashpv(classname, GV_ADD);
7973 (void)sv_bless(rv, stash);
7979 =for apidoc sv_setref_pv
7981 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7982 argument will be upgraded to an RV. That RV will be modified to point to
7983 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7984 into the SV. The C<classname> argument indicates the package for the
7985 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7986 will have a reference count of 1, and the RV will be returned.
7988 Do not use with other Perl types such as HV, AV, SV, CV, because those
7989 objects will become corrupted by the pointer copy process.
7991 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7997 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8001 sv_setsv(rv, &PL_sv_undef);
8005 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8010 =for apidoc sv_setref_iv
8012 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8013 argument will be upgraded to an RV. That RV will be modified to point to
8014 the new SV. The C<classname> argument indicates the package for the
8015 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8016 will have a reference count of 1, and the RV will be returned.
8022 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8024 sv_setiv(newSVrv(rv,classname), iv);
8029 =for apidoc sv_setref_uv
8031 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8032 argument will be upgraded to an RV. That RV will be modified to point to
8033 the new SV. The C<classname> argument indicates the package for the
8034 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8035 will have a reference count of 1, and the RV will be returned.
8041 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8043 sv_setuv(newSVrv(rv,classname), uv);
8048 =for apidoc sv_setref_nv
8050 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8051 argument will be upgraded to an RV. That RV will be modified to point to
8052 the new SV. The C<classname> argument indicates the package for the
8053 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8054 will have a reference count of 1, and the RV will be returned.
8060 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8062 sv_setnv(newSVrv(rv,classname), nv);
8067 =for apidoc sv_setref_pvn
8069 Copies a string into a new SV, optionally blessing the SV. The length of the
8070 string must be specified with C<n>. The C<rv> argument will be upgraded to
8071 an RV. That RV will be modified to point to the new SV. The C<classname>
8072 argument indicates the package for the blessing. Set C<classname> to
8073 C<NULL> to avoid the blessing. The new SV will have a reference count
8074 of 1, and the RV will be returned.
8076 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8082 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8084 sv_setpvn(newSVrv(rv,classname), pv, n);
8089 =for apidoc sv_bless
8091 Blesses an SV into a specified package. The SV must be an RV. The package
8092 must be designated by its stash (see C<gv_stashpv()>). The reference count
8093 of the SV is unaffected.
8099 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8104 Perl_croak(aTHX_ "Can't bless non-reference value");
8106 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8107 if (SvIsCOW(tmpRef))
8108 sv_force_normal_flags(tmpRef, 0);
8109 if (SvREADONLY(tmpRef))
8110 Perl_croak(aTHX_ PL_no_modify);
8111 if (SvOBJECT(tmpRef)) {
8112 if (SvTYPE(tmpRef) != SVt_PVIO)
8114 SvREFCNT_dec(SvSTASH(tmpRef));
8117 SvOBJECT_on(tmpRef);
8118 if (SvTYPE(tmpRef) != SVt_PVIO)
8120 SvUPGRADE(tmpRef, SVt_PVMG);
8121 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8126 (void)SvAMAGIC_off(sv);
8128 if(SvSMAGICAL(tmpRef))
8129 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8137 /* Downgrades a PVGV to a PVMG.
8141 S_sv_unglob(pTHX_ SV *sv)
8146 SV * const temp = sv_newmortal();
8148 assert(SvTYPE(sv) == SVt_PVGV);
8150 gv_efullname3(temp, (GV *) sv, "*");
8153 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8154 mro_method_changed_in(stash);
8158 sv_del_backref((SV*)GvSTASH(sv), sv);
8162 if (GvNAME_HEK(sv)) {
8163 unshare_hek(GvNAME_HEK(sv));
8165 isGV_with_GP_off(sv);
8167 /* need to keep SvANY(sv) in the right arena */
8168 xpvmg = new_XPVMG();
8169 StructCopy(SvANY(sv), xpvmg, XPVMG);
8170 del_XPVGV(SvANY(sv));
8173 SvFLAGS(sv) &= ~SVTYPEMASK;
8174 SvFLAGS(sv) |= SVt_PVMG;
8176 /* Intentionally not calling any local SET magic, as this isn't so much a
8177 set operation as merely an internal storage change. */
8178 sv_setsv_flags(sv, temp, 0);
8182 =for apidoc sv_unref_flags
8184 Unsets the RV status of the SV, and decrements the reference count of
8185 whatever was being referenced by the RV. This can almost be thought of
8186 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8187 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8188 (otherwise the decrementing is conditional on the reference count being
8189 different from one or the reference being a readonly SV).
8196 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8198 SV* const target = SvRV(ref);
8200 if (SvWEAKREF(ref)) {
8201 sv_del_backref(target, ref);
8203 SvRV_set(ref, NULL);
8206 SvRV_set(ref, NULL);
8208 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8209 assigned to as BEGIN {$a = \"Foo"} will fail. */
8210 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8211 SvREFCNT_dec(target);
8212 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8213 sv_2mortal(target); /* Schedule for freeing later */
8217 =for apidoc sv_untaint
8219 Untaint an SV. Use C<SvTAINTED_off> instead.
8224 Perl_sv_untaint(pTHX_ SV *sv)
8226 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8227 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8234 =for apidoc sv_tainted
8236 Test an SV for taintedness. Use C<SvTAINTED> instead.
8241 Perl_sv_tainted(pTHX_ SV *sv)
8243 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8244 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8245 if (mg && (mg->mg_len & 1) )
8252 =for apidoc sv_setpviv
8254 Copies an integer into the given SV, also updating its string value.
8255 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8261 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8263 char buf[TYPE_CHARS(UV)];
8265 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8267 sv_setpvn(sv, ptr, ebuf - ptr);
8271 =for apidoc sv_setpviv_mg
8273 Like C<sv_setpviv>, but also handles 'set' magic.
8279 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8285 #if defined(PERL_IMPLICIT_CONTEXT)
8287 /* pTHX_ magic can't cope with varargs, so this is a no-context
8288 * version of the main function, (which may itself be aliased to us).
8289 * Don't access this version directly.
8293 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8297 va_start(args, pat);
8298 sv_vsetpvf(sv, pat, &args);
8302 /* pTHX_ magic can't cope with varargs, so this is a no-context
8303 * version of the main function, (which may itself be aliased to us).
8304 * Don't access this version directly.
8308 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8312 va_start(args, pat);
8313 sv_vsetpvf_mg(sv, pat, &args);
8319 =for apidoc sv_setpvf
8321 Works like C<sv_catpvf> but copies the text into the SV instead of
8322 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8328 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8331 va_start(args, pat);
8332 sv_vsetpvf(sv, pat, &args);
8337 =for apidoc sv_vsetpvf
8339 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8340 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8342 Usually used via its frontend C<sv_setpvf>.
8348 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8350 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8354 =for apidoc sv_setpvf_mg
8356 Like C<sv_setpvf>, but also handles 'set' magic.
8362 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8365 va_start(args, pat);
8366 sv_vsetpvf_mg(sv, pat, &args);
8371 =for apidoc sv_vsetpvf_mg
8373 Like C<sv_vsetpvf>, but also handles 'set' magic.
8375 Usually used via its frontend C<sv_setpvf_mg>.
8381 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8383 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8387 #if defined(PERL_IMPLICIT_CONTEXT)
8389 /* pTHX_ magic can't cope with varargs, so this is a no-context
8390 * version of the main function, (which may itself be aliased to us).
8391 * Don't access this version directly.
8395 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8399 va_start(args, pat);
8400 sv_vcatpvf(sv, pat, &args);
8404 /* pTHX_ magic can't cope with varargs, so this is a no-context
8405 * version of the main function, (which may itself be aliased to us).
8406 * Don't access this version directly.
8410 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8414 va_start(args, pat);
8415 sv_vcatpvf_mg(sv, pat, &args);
8421 =for apidoc sv_catpvf
8423 Processes its arguments like C<sprintf> and appends the formatted
8424 output to an SV. If the appended data contains "wide" characters
8425 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8426 and characters >255 formatted with %c), the original SV might get
8427 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8428 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8429 valid UTF-8; if the original SV was bytes, the pattern should be too.
8434 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8437 va_start(args, pat);
8438 sv_vcatpvf(sv, pat, &args);
8443 =for apidoc sv_vcatpvf
8445 Processes its arguments like C<vsprintf> and appends the formatted output
8446 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8448 Usually used via its frontend C<sv_catpvf>.
8454 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8456 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8460 =for apidoc sv_catpvf_mg
8462 Like C<sv_catpvf>, but also handles 'set' magic.
8468 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8471 va_start(args, pat);
8472 sv_vcatpvf_mg(sv, pat, &args);
8477 =for apidoc sv_vcatpvf_mg
8479 Like C<sv_vcatpvf>, but also handles 'set' magic.
8481 Usually used via its frontend C<sv_catpvf_mg>.
8487 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8489 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8494 =for apidoc sv_vsetpvfn
8496 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8499 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8505 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8507 sv_setpvn(sv, "", 0);
8508 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8512 S_expect_number(pTHX_ char** pattern)
8516 switch (**pattern) {
8517 case '1': case '2': case '3':
8518 case '4': case '5': case '6':
8519 case '7': case '8': case '9':
8520 var = *(*pattern)++ - '0';
8521 while (isDIGIT(**pattern)) {
8522 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8524 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8532 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8534 const int neg = nv < 0;
8543 if (uv & 1 && uv == nv)
8544 uv--; /* Round to even */
8546 const unsigned dig = uv % 10;
8559 =for apidoc sv_vcatpvfn
8561 Processes its arguments like C<vsprintf> and appends the formatted output
8562 to an SV. Uses an array of SVs if the C style variable argument list is
8563 missing (NULL). When running with taint checks enabled, indicates via
8564 C<maybe_tainted> if results are untrustworthy (often due to the use of
8567 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8573 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8574 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8575 vec_utf8 = DO_UTF8(vecsv);
8577 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8580 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8588 static const char nullstr[] = "(null)";
8590 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8591 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8593 /* Times 4: a decimal digit takes more than 3 binary digits.
8594 * NV_DIG: mantissa takes than many decimal digits.
8595 * Plus 32: Playing safe. */
8596 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8597 /* large enough for "%#.#f" --chip */
8598 /* what about long double NVs? --jhi */
8600 PERL_UNUSED_ARG(maybe_tainted);
8602 /* no matter what, this is a string now */
8603 (void)SvPV_force(sv, origlen);
8605 /* special-case "", "%s", and "%-p" (SVf - see below) */
8608 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8610 const char * const s = va_arg(*args, char*);
8611 sv_catpv(sv, s ? s : nullstr);
8613 else if (svix < svmax) {
8614 sv_catsv(sv, *svargs);
8618 if (args && patlen == 3 && pat[0] == '%' &&
8619 pat[1] == '-' && pat[2] == 'p') {
8620 argsv = (SV*)va_arg(*args, void*);
8621 sv_catsv(sv, argsv);
8625 #ifndef USE_LONG_DOUBLE
8626 /* special-case "%.<number>[gf]" */
8627 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8628 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8629 unsigned digits = 0;
8633 while (*pp >= '0' && *pp <= '9')
8634 digits = 10 * digits + (*pp++ - '0');
8635 if (pp - pat == (int)patlen - 1) {
8643 /* Add check for digits != 0 because it seems that some
8644 gconverts are buggy in this case, and we don't yet have
8645 a Configure test for this. */
8646 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8647 /* 0, point, slack */
8648 Gconvert(nv, (int)digits, 0, ebuf);
8650 if (*ebuf) /* May return an empty string for digits==0 */
8653 } else if (!digits) {
8656 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8657 sv_catpvn(sv, p, l);
8663 #endif /* !USE_LONG_DOUBLE */
8665 if (!args && svix < svmax && DO_UTF8(*svargs))
8668 patend = (char*)pat + patlen;
8669 for (p = (char*)pat; p < patend; p = q) {
8672 bool vectorize = FALSE;
8673 bool vectorarg = FALSE;
8674 bool vec_utf8 = FALSE;
8680 bool has_precis = FALSE;
8682 const I32 osvix = svix;
8683 bool is_utf8 = FALSE; /* is this item utf8? */
8684 #ifdef HAS_LDBL_SPRINTF_BUG
8685 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8686 with sfio - Allen <allens@cpan.org> */
8687 bool fix_ldbl_sprintf_bug = FALSE;
8691 U8 utf8buf[UTF8_MAXBYTES+1];
8692 STRLEN esignlen = 0;
8694 const char *eptr = NULL;
8697 const U8 *vecstr = NULL;
8704 /* we need a long double target in case HAS_LONG_DOUBLE but
8707 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8715 const char *dotstr = ".";
8716 STRLEN dotstrlen = 1;
8717 I32 efix = 0; /* explicit format parameter index */
8718 I32 ewix = 0; /* explicit width index */
8719 I32 epix = 0; /* explicit precision index */
8720 I32 evix = 0; /* explicit vector index */
8721 bool asterisk = FALSE;
8723 /* echo everything up to the next format specification */
8724 for (q = p; q < patend && *q != '%'; ++q) ;
8726 if (has_utf8 && !pat_utf8)
8727 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8729 sv_catpvn(sv, p, q - p);
8736 We allow format specification elements in this order:
8737 \d+\$ explicit format parameter index
8739 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8740 0 flag (as above): repeated to allow "v02"
8741 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8742 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8744 [%bcdefginopsuxDFOUX] format (mandatory)
8749 As of perl5.9.3, printf format checking is on by default.
8750 Internally, perl uses %p formats to provide an escape to
8751 some extended formatting. This block deals with those
8752 extensions: if it does not match, (char*)q is reset and
8753 the normal format processing code is used.
8755 Currently defined extensions are:
8756 %p include pointer address (standard)
8757 %-p (SVf) include an SV (previously %_)
8758 %-<num>p include an SV with precision <num>
8759 %<num>p reserved for future extensions
8761 Robin Barker 2005-07-14
8763 %1p (VDf) removed. RMB 2007-10-19
8770 n = expect_number(&q);
8777 argsv = (SV*)va_arg(*args, void*);
8778 eptr = SvPV_const(argsv, elen);
8784 if (ckWARN_d(WARN_INTERNAL))
8785 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8786 "internal %%<num>p might conflict with future printf extensions");
8792 if ( (width = expect_number(&q)) ) {
8807 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8836 if ( (ewix = expect_number(&q)) )
8845 if ((vectorarg = asterisk)) {
8858 width = expect_number(&q);
8864 vecsv = va_arg(*args, SV*);
8866 vecsv = (evix > 0 && evix <= svmax)
8867 ? svargs[evix-1] : &PL_sv_undef;
8869 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8871 dotstr = SvPV_const(vecsv, dotstrlen);
8872 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8873 bad with tied or overloaded values that return UTF8. */
8876 else if (has_utf8) {
8877 vecsv = sv_mortalcopy(vecsv);
8878 sv_utf8_upgrade(vecsv);
8879 dotstr = SvPV_const(vecsv, dotstrlen);
8886 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8887 vecsv = svargs[efix ? efix-1 : svix++];
8888 vecstr = (U8*)SvPV_const(vecsv,veclen);
8889 vec_utf8 = DO_UTF8(vecsv);
8891 /* if this is a version object, we need to convert
8892 * back into v-string notation and then let the
8893 * vectorize happen normally
8895 if (sv_derived_from(vecsv, "version")) {
8896 char *version = savesvpv(vecsv);
8897 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8898 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8899 "vector argument not supported with alpha versions");
8902 vecsv = sv_newmortal();
8903 scan_vstring(version, version + veclen, vecsv);
8904 vecstr = (U8*)SvPV_const(vecsv, veclen);
8905 vec_utf8 = DO_UTF8(vecsv);
8917 i = va_arg(*args, int);
8919 i = (ewix ? ewix <= svmax : svix < svmax) ?
8920 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8922 width = (i < 0) ? -i : i;
8932 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8934 /* XXX: todo, support specified precision parameter */
8938 i = va_arg(*args, int);
8940 i = (ewix ? ewix <= svmax : svix < svmax)
8941 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8943 has_precis = !(i < 0);
8948 precis = precis * 10 + (*q++ - '0');
8957 case 'I': /* Ix, I32x, and I64x */
8959 if (q[1] == '6' && q[2] == '4') {
8965 if (q[1] == '3' && q[2] == '2') {
8975 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8986 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8987 if (*(q + 1) == 'l') { /* lld, llf */
9013 if (!vectorize && !args) {
9015 const I32 i = efix-1;
9016 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9018 argsv = (svix >= 0 && svix < svmax)
9019 ? svargs[svix++] : &PL_sv_undef;
9030 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9032 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9034 eptr = (char*)utf8buf;
9035 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9049 eptr = va_arg(*args, char*);
9051 #ifdef MACOS_TRADITIONAL
9052 /* On MacOS, %#s format is used for Pascal strings */
9057 elen = strlen(eptr);
9059 eptr = (char *)nullstr;
9060 elen = sizeof nullstr - 1;
9064 eptr = SvPV_const(argsv, elen);
9065 if (DO_UTF8(argsv)) {
9066 I32 old_precis = precis;
9067 if (has_precis && precis < elen) {
9069 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9072 if (width) { /* fudge width (can't fudge elen) */
9073 if (has_precis && precis < elen)
9074 width += precis - old_precis;
9076 width += elen - sv_len_utf8(argsv);
9083 if (has_precis && elen > precis)
9090 if (alt || vectorize)
9092 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9113 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9122 esignbuf[esignlen++] = plus;
9126 case 'h': iv = (short)va_arg(*args, int); break;
9127 case 'l': iv = va_arg(*args, long); break;
9128 case 'V': iv = va_arg(*args, IV); break;
9129 default: iv = va_arg(*args, int); break;
9131 case 'q': iv = va_arg(*args, Quad_t); break;
9136 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9138 case 'h': iv = (short)tiv; break;
9139 case 'l': iv = (long)tiv; break;
9141 default: iv = tiv; break;
9143 case 'q': iv = (Quad_t)tiv; break;
9147 if ( !vectorize ) /* we already set uv above */
9152 esignbuf[esignlen++] = plus;
9156 esignbuf[esignlen++] = '-';
9200 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9211 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9212 case 'l': uv = va_arg(*args, unsigned long); break;
9213 case 'V': uv = va_arg(*args, UV); break;
9214 default: uv = va_arg(*args, unsigned); break;
9216 case 'q': uv = va_arg(*args, Uquad_t); break;
9221 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9223 case 'h': uv = (unsigned short)tuv; break;
9224 case 'l': uv = (unsigned long)tuv; break;
9226 default: uv = tuv; break;
9228 case 'q': uv = (Uquad_t)tuv; break;
9235 char *ptr = ebuf + sizeof ebuf;
9236 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9242 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9248 esignbuf[esignlen++] = '0';
9249 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9257 if (alt && *ptr != '0')
9266 esignbuf[esignlen++] = '0';
9267 esignbuf[esignlen++] = c;
9270 default: /* it had better be ten or less */
9274 } while (uv /= base);
9277 elen = (ebuf + sizeof ebuf) - ptr;
9281 zeros = precis - elen;
9282 else if (precis == 0 && elen == 1 && *eptr == '0'
9283 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9286 /* a precision nullifies the 0 flag. */
9293 /* FLOATING POINT */
9296 c = 'f'; /* maybe %F isn't supported here */
9304 /* This is evil, but floating point is even more evil */
9306 /* for SV-style calling, we can only get NV
9307 for C-style calling, we assume %f is double;
9308 for simplicity we allow any of %Lf, %llf, %qf for long double
9312 #if defined(USE_LONG_DOUBLE)
9316 /* [perl #20339] - we should accept and ignore %lf rather than die */
9320 #if defined(USE_LONG_DOUBLE)
9321 intsize = args ? 0 : 'q';
9325 #if defined(HAS_LONG_DOUBLE)
9334 /* now we need (long double) if intsize == 'q', else (double) */
9336 #if LONG_DOUBLESIZE > DOUBLESIZE
9338 va_arg(*args, long double) :
9339 va_arg(*args, double)
9341 va_arg(*args, double)
9346 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9347 else. frexp() has some unspecified behaviour for those three */
9348 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9350 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9351 will cast our (long double) to (double) */
9352 (void)Perl_frexp(nv, &i);
9353 if (i == PERL_INT_MIN)
9354 Perl_die(aTHX_ "panic: frexp");
9356 need = BIT_DIGITS(i);
9358 need += has_precis ? precis : 6; /* known default */
9363 #ifdef HAS_LDBL_SPRINTF_BUG
9364 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9365 with sfio - Allen <allens@cpan.org> */
9368 # define MY_DBL_MAX DBL_MAX
9369 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9370 # if DOUBLESIZE >= 8
9371 # define MY_DBL_MAX 1.7976931348623157E+308L
9373 # define MY_DBL_MAX 3.40282347E+38L
9377 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9378 # define MY_DBL_MAX_BUG 1L
9380 # define MY_DBL_MAX_BUG MY_DBL_MAX
9384 # define MY_DBL_MIN DBL_MIN
9385 # else /* XXX guessing! -Allen */
9386 # if DOUBLESIZE >= 8
9387 # define MY_DBL_MIN 2.2250738585072014E-308L
9389 # define MY_DBL_MIN 1.17549435E-38L
9393 if ((intsize == 'q') && (c == 'f') &&
9394 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9396 /* it's going to be short enough that
9397 * long double precision is not needed */
9399 if ((nv <= 0L) && (nv >= -0L))
9400 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9402 /* would use Perl_fp_class as a double-check but not
9403 * functional on IRIX - see perl.h comments */
9405 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9406 /* It's within the range that a double can represent */
9407 #if defined(DBL_MAX) && !defined(DBL_MIN)
9408 if ((nv >= ((long double)1/DBL_MAX)) ||
9409 (nv <= (-(long double)1/DBL_MAX)))
9411 fix_ldbl_sprintf_bug = TRUE;
9414 if (fix_ldbl_sprintf_bug == TRUE) {
9424 # undef MY_DBL_MAX_BUG
9427 #endif /* HAS_LDBL_SPRINTF_BUG */
9429 need += 20; /* fudge factor */
9430 if (PL_efloatsize < need) {
9431 Safefree(PL_efloatbuf);
9432 PL_efloatsize = need + 20; /* more fudge */
9433 Newx(PL_efloatbuf, PL_efloatsize, char);
9434 PL_efloatbuf[0] = '\0';
9437 if ( !(width || left || plus || alt) && fill != '0'
9438 && has_precis && intsize != 'q' ) { /* Shortcuts */
9439 /* See earlier comment about buggy Gconvert when digits,
9441 if ( c == 'g' && precis) {
9442 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9443 /* May return an empty string for digits==0 */
9444 if (*PL_efloatbuf) {
9445 elen = strlen(PL_efloatbuf);
9446 goto float_converted;
9448 } else if ( c == 'f' && !precis) {
9449 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9454 char *ptr = ebuf + sizeof ebuf;
9457 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9458 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9459 if (intsize == 'q') {
9460 /* Copy the one or more characters in a long double
9461 * format before the 'base' ([efgEFG]) character to
9462 * the format string. */
9463 static char const prifldbl[] = PERL_PRIfldbl;
9464 char const *p = prifldbl + sizeof(prifldbl) - 3;
9465 while (p >= prifldbl) { *--ptr = *p--; }
9470 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9475 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9487 /* No taint. Otherwise we are in the strange situation
9488 * where printf() taints but print($float) doesn't.
9490 #if defined(HAS_LONG_DOUBLE)
9491 elen = ((intsize == 'q')
9492 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9493 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9495 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9499 eptr = PL_efloatbuf;
9507 i = SvCUR(sv) - origlen;
9510 case 'h': *(va_arg(*args, short*)) = i; break;
9511 default: *(va_arg(*args, int*)) = i; break;
9512 case 'l': *(va_arg(*args, long*)) = i; break;
9513 case 'V': *(va_arg(*args, IV*)) = i; break;
9515 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9520 sv_setuv_mg(argsv, (UV)i);
9521 continue; /* not "break" */
9528 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9529 && ckWARN(WARN_PRINTF))
9531 SV * const msg = sv_newmortal();
9532 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9533 (PL_op->op_type == OP_PRTF) ? "" : "s");
9536 Perl_sv_catpvf(aTHX_ msg,
9537 "\"%%%c\"", c & 0xFF);
9539 Perl_sv_catpvf(aTHX_ msg,
9540 "\"%%\\%03"UVof"\"",
9543 sv_catpvs(msg, "end of string");
9544 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9547 /* output mangled stuff ... */
9553 /* ... right here, because formatting flags should not apply */
9554 SvGROW(sv, SvCUR(sv) + elen + 1);
9556 Copy(eptr, p, elen, char);
9559 SvCUR_set(sv, p - SvPVX_const(sv));
9561 continue; /* not "break" */
9564 if (is_utf8 != has_utf8) {
9567 sv_utf8_upgrade(sv);
9570 const STRLEN old_elen = elen;
9571 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9572 sv_utf8_upgrade(nsv);
9573 eptr = SvPVX_const(nsv);
9576 if (width) { /* fudge width (can't fudge elen) */
9577 width += elen - old_elen;
9583 have = esignlen + zeros + elen;
9585 Perl_croak_nocontext(PL_memory_wrap);
9587 need = (have > width ? have : width);
9590 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9591 Perl_croak_nocontext(PL_memory_wrap);
9592 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9594 if (esignlen && fill == '0') {
9596 for (i = 0; i < (int)esignlen; i++)
9600 memset(p, fill, gap);
9603 if (esignlen && fill != '0') {
9605 for (i = 0; i < (int)esignlen; i++)
9610 for (i = zeros; i; i--)
9614 Copy(eptr, p, elen, char);
9618 memset(p, ' ', gap);
9623 Copy(dotstr, p, dotstrlen, char);
9627 vectorize = FALSE; /* done iterating over vecstr */
9634 SvCUR_set(sv, p - SvPVX_const(sv));
9642 /* =========================================================================
9644 =head1 Cloning an interpreter
9646 All the macros and functions in this section are for the private use of
9647 the main function, perl_clone().
9649 The foo_dup() functions make an exact copy of an existing foo thingy.
9650 During the course of a cloning, a hash table is used to map old addresses
9651 to new addresses. The table is created and manipulated with the
9652 ptr_table_* functions.
9656 ============================================================================*/
9659 #if defined(USE_ITHREADS)
9661 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9662 #ifndef GpREFCNT_inc
9663 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9667 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9668 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9669 If this changes, please unmerge ss_dup. */
9670 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9671 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9672 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9673 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9674 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9675 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9676 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9677 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9678 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9679 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9680 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9681 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9682 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9683 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9685 /* clone a parser */
9688 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9695 /* look for it in the table first */
9696 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9700 /* create anew and remember what it is */
9701 Newxz(parser, 1, yy_parser);
9702 ptr_table_store(PL_ptr_table, proto, parser);
9704 parser->yyerrstatus = 0;
9705 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9707 /* XXX these not yet duped */
9708 parser->old_parser = NULL;
9709 parser->stack = NULL;
9711 parser->stack_size = 0;
9712 /* XXX parser->stack->state = 0; */
9714 /* XXX eventually, just Copy() most of the parser struct ? */
9716 parser->lex_brackets = proto->lex_brackets;
9717 parser->lex_casemods = proto->lex_casemods;
9718 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9719 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9720 parser->lex_casestack = savepvn(proto->lex_casestack,
9721 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9722 parser->lex_defer = proto->lex_defer;
9723 parser->lex_dojoin = proto->lex_dojoin;
9724 parser->lex_expect = proto->lex_expect;
9725 parser->lex_formbrack = proto->lex_formbrack;
9726 parser->lex_inpat = proto->lex_inpat;
9727 parser->lex_inwhat = proto->lex_inwhat;
9728 parser->lex_op = proto->lex_op;
9729 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9730 parser->lex_starts = proto->lex_starts;
9731 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9732 parser->multi_close = proto->multi_close;
9733 parser->multi_open = proto->multi_open;
9734 parser->multi_start = proto->multi_start;
9735 parser->multi_end = proto->multi_end;
9736 parser->pending_ident = proto->pending_ident;
9737 parser->preambled = proto->preambled;
9738 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9739 parser->linestr = sv_dup_inc(proto->linestr, param);
9740 parser->expect = proto->expect;
9741 parser->copline = proto->copline;
9742 parser->last_lop_op = proto->last_lop_op;
9743 parser->lex_state = proto->lex_state;
9744 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9745 /* rsfp_filters entries have fake IoDIRP() */
9746 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9747 parser->in_my = proto->in_my;
9748 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9749 parser->error_count = proto->error_count;
9752 parser->linestr = sv_dup_inc(proto->linestr, param);
9755 char * const ols = SvPVX(proto->linestr);
9756 char * const ls = SvPVX(parser->linestr);
9758 parser->bufptr = ls + (proto->bufptr >= ols ?
9759 proto->bufptr - ols : 0);
9760 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9761 proto->oldbufptr - ols : 0);
9762 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9763 proto->oldoldbufptr - ols : 0);
9764 parser->linestart = ls + (proto->linestart >= ols ?
9765 proto->linestart - ols : 0);
9766 parser->last_uni = ls + (proto->last_uni >= ols ?
9767 proto->last_uni - ols : 0);
9768 parser->last_lop = ls + (proto->last_lop >= ols ?
9769 proto->last_lop - ols : 0);
9771 parser->bufend = ls + SvCUR(parser->linestr);
9774 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9778 parser->endwhite = proto->endwhite;
9779 parser->faketokens = proto->faketokens;
9780 parser->lasttoke = proto->lasttoke;
9781 parser->nextwhite = proto->nextwhite;
9782 parser->realtokenstart = proto->realtokenstart;
9783 parser->skipwhite = proto->skipwhite;
9784 parser->thisclose = proto->thisclose;
9785 parser->thismad = proto->thismad;
9786 parser->thisopen = proto->thisopen;
9787 parser->thisstuff = proto->thisstuff;
9788 parser->thistoken = proto->thistoken;
9789 parser->thiswhite = proto->thiswhite;
9791 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9792 parser->curforce = proto->curforce;
9794 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9795 Copy(proto->nexttype, parser->nexttype, 5, I32);
9796 parser->nexttoke = proto->nexttoke;
9802 /* duplicate a file handle */
9805 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9809 PERL_UNUSED_ARG(type);
9812 return (PerlIO*)NULL;
9814 /* look for it in the table first */
9815 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9819 /* create anew and remember what it is */
9820 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9821 ptr_table_store(PL_ptr_table, fp, ret);
9825 /* duplicate a directory handle */
9828 Perl_dirp_dup(pTHX_ DIR *dp)
9830 PERL_UNUSED_CONTEXT;
9837 /* duplicate a typeglob */
9840 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9846 /* look for it in the table first */
9847 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9851 /* create anew and remember what it is */
9853 ptr_table_store(PL_ptr_table, gp, ret);
9856 ret->gp_refcnt = 0; /* must be before any other dups! */
9857 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9858 ret->gp_io = io_dup_inc(gp->gp_io, param);
9859 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9860 ret->gp_av = av_dup_inc(gp->gp_av, param);
9861 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9862 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9863 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9864 ret->gp_cvgen = gp->gp_cvgen;
9865 ret->gp_line = gp->gp_line;
9866 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9870 /* duplicate a chain of magic */
9873 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9875 MAGIC *mgprev = (MAGIC*)NULL;
9878 return (MAGIC*)NULL;
9879 /* look for it in the table first */
9880 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9884 for (; mg; mg = mg->mg_moremagic) {
9886 Newxz(nmg, 1, MAGIC);
9888 mgprev->mg_moremagic = nmg;
9891 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9892 nmg->mg_private = mg->mg_private;
9893 nmg->mg_type = mg->mg_type;
9894 nmg->mg_flags = mg->mg_flags;
9895 /* FIXME for plugins
9896 if (mg->mg_type == PERL_MAGIC_qr) {
9897 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9901 if(mg->mg_type == PERL_MAGIC_backref) {
9902 /* The backref AV has its reference count deliberately bumped by
9904 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9907 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9908 ? sv_dup_inc(mg->mg_obj, param)
9909 : sv_dup(mg->mg_obj, param);
9911 nmg->mg_len = mg->mg_len;
9912 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9913 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9914 if (mg->mg_len > 0) {
9915 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9916 if (mg->mg_type == PERL_MAGIC_overload_table &&
9917 AMT_AMAGIC((AMT*)mg->mg_ptr))
9919 const AMT * const amtp = (AMT*)mg->mg_ptr;
9920 AMT * const namtp = (AMT*)nmg->mg_ptr;
9922 for (i = 1; i < NofAMmeth; i++) {
9923 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9927 else if (mg->mg_len == HEf_SVKEY)
9928 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9930 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9931 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9938 #endif /* USE_ITHREADS */
9940 /* create a new pointer-mapping table */
9943 Perl_ptr_table_new(pTHX)
9946 PERL_UNUSED_CONTEXT;
9948 Newxz(tbl, 1, PTR_TBL_t);
9951 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9955 #define PTR_TABLE_HASH(ptr) \
9956 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9959 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9960 following define) and at call to new_body_inline made below in
9961 Perl_ptr_table_store()
9964 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9966 /* map an existing pointer using a table */
9968 STATIC PTR_TBL_ENT_t *
9969 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9970 PTR_TBL_ENT_t *tblent;
9971 const UV hash = PTR_TABLE_HASH(sv);
9973 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9974 for (; tblent; tblent = tblent->next) {
9975 if (tblent->oldval == sv)
9982 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9984 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9985 PERL_UNUSED_CONTEXT;
9986 return tblent ? tblent->newval : NULL;
9989 /* add a new entry to a pointer-mapping table */
9992 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9994 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9995 PERL_UNUSED_CONTEXT;
9998 tblent->newval = newsv;
10000 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10002 new_body_inline(tblent, PTE_SVSLOT);
10004 tblent->oldval = oldsv;
10005 tblent->newval = newsv;
10006 tblent->next = tbl->tbl_ary[entry];
10007 tbl->tbl_ary[entry] = tblent;
10009 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10010 ptr_table_split(tbl);
10014 /* double the hash bucket size of an existing ptr table */
10017 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10019 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10020 const UV oldsize = tbl->tbl_max + 1;
10021 UV newsize = oldsize * 2;
10023 PERL_UNUSED_CONTEXT;
10025 Renew(ary, newsize, PTR_TBL_ENT_t*);
10026 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10027 tbl->tbl_max = --newsize;
10028 tbl->tbl_ary = ary;
10029 for (i=0; i < oldsize; i++, ary++) {
10030 PTR_TBL_ENT_t **curentp, **entp, *ent;
10033 curentp = ary + oldsize;
10034 for (entp = ary, ent = *ary; ent; ent = *entp) {
10035 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10037 ent->next = *curentp;
10047 /* remove all the entries from a ptr table */
10050 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10052 if (tbl && tbl->tbl_items) {
10053 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10054 UV riter = tbl->tbl_max;
10057 PTR_TBL_ENT_t *entry = array[riter];
10060 PTR_TBL_ENT_t * const oentry = entry;
10061 entry = entry->next;
10066 tbl->tbl_items = 0;
10070 /* clear and free a ptr table */
10073 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10078 ptr_table_clear(tbl);
10079 Safefree(tbl->tbl_ary);
10083 #if defined(USE_ITHREADS)
10086 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10089 SvRV_set(dstr, SvWEAKREF(sstr)
10090 ? sv_dup(SvRV(sstr), param)
10091 : sv_dup_inc(SvRV(sstr), param));
10094 else if (SvPVX_const(sstr)) {
10095 /* Has something there */
10097 /* Normal PV - clone whole allocated space */
10098 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10099 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10100 /* Not that normal - actually sstr is copy on write.
10101 But we are a true, independant SV, so: */
10102 SvREADONLY_off(dstr);
10107 /* Special case - not normally malloced for some reason */
10108 if (isGV_with_GP(sstr)) {
10109 /* Don't need to do anything here. */
10111 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10112 /* A "shared" PV - clone it as "shared" PV */
10114 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10118 /* Some other special case - random pointer */
10119 SvPV_set(dstr, SvPVX(sstr));
10124 /* Copy the NULL */
10125 SvPV_set(dstr, NULL);
10129 /* duplicate an SV of any type (including AV, HV etc) */
10132 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10137 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10139 /* look for it in the table first */
10140 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10144 if(param->flags & CLONEf_JOIN_IN) {
10145 /** We are joining here so we don't want do clone
10146 something that is bad **/
10147 if (SvTYPE(sstr) == SVt_PVHV) {
10148 const HEK * const hvname = HvNAME_HEK(sstr);
10150 /** don't clone stashes if they already exist **/
10151 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10155 /* create anew and remember what it is */
10158 #ifdef DEBUG_LEAKING_SCALARS
10159 dstr->sv_debug_optype = sstr->sv_debug_optype;
10160 dstr->sv_debug_line = sstr->sv_debug_line;
10161 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10162 dstr->sv_debug_cloned = 1;
10163 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10166 ptr_table_store(PL_ptr_table, sstr, dstr);
10169 SvFLAGS(dstr) = SvFLAGS(sstr);
10170 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10171 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10174 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10175 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10176 (void*)PL_watch_pvx, SvPVX_const(sstr));
10179 /* don't clone objects whose class has asked us not to */
10180 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10185 switch (SvTYPE(sstr)) {
10187 SvANY(dstr) = NULL;
10190 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10192 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10194 SvIV_set(dstr, SvIVX(sstr));
10198 SvANY(dstr) = new_XNV();
10199 SvNV_set(dstr, SvNVX(sstr));
10201 /* case SVt_BIND: */
10204 /* These are all the types that need complex bodies allocating. */
10206 const svtype sv_type = SvTYPE(sstr);
10207 const struct body_details *const sv_type_details
10208 = bodies_by_type + sv_type;
10212 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10216 if (GvUNIQUE((GV*)sstr)) {
10217 NOOP; /* Do sharing here, and fall through */
10230 assert(sv_type_details->body_size);
10231 if (sv_type_details->arena) {
10232 new_body_inline(new_body, sv_type);
10234 = (void*)((char*)new_body - sv_type_details->offset);
10236 new_body = new_NOARENA(sv_type_details);
10240 SvANY(dstr) = new_body;
10243 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10244 ((char*)SvANY(dstr)) + sv_type_details->offset,
10245 sv_type_details->copy, char);
10247 Copy(((char*)SvANY(sstr)),
10248 ((char*)SvANY(dstr)),
10249 sv_type_details->body_size + sv_type_details->offset, char);
10252 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10253 && !isGV_with_GP(dstr))
10254 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10256 /* The Copy above means that all the source (unduplicated) pointers
10257 are now in the destination. We can check the flags and the
10258 pointers in either, but it's possible that there's less cache
10259 missing by always going for the destination.
10260 FIXME - instrument and check that assumption */
10261 if (sv_type >= SVt_PVMG) {
10262 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10263 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10264 } else if (SvMAGIC(dstr))
10265 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10267 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10270 /* The cast silences a GCC warning about unhandled types. */
10271 switch ((int)sv_type) {
10281 /* FIXME for plugins */
10282 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10285 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10286 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10287 LvTARG(dstr) = dstr;
10288 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10289 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10291 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10293 if(isGV_with_GP(sstr)) {
10294 if (GvNAME_HEK(dstr))
10295 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10296 /* Don't call sv_add_backref here as it's going to be
10297 created as part of the magic cloning of the symbol
10299 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10300 at the point of this comment. */
10301 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10302 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10303 (void)GpREFCNT_inc(GvGP(dstr));
10305 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10308 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10309 if (IoOFP(dstr) == IoIFP(sstr))
10310 IoOFP(dstr) = IoIFP(dstr);
10312 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10313 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10314 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10315 /* I have no idea why fake dirp (rsfps)
10316 should be treated differently but otherwise
10317 we end up with leaks -- sky*/
10318 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10319 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10320 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10322 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10323 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10324 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10325 if (IoDIRP(dstr)) {
10326 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10329 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10332 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10333 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10334 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10337 if (AvARRAY((AV*)sstr)) {
10338 SV **dst_ary, **src_ary;
10339 SSize_t items = AvFILLp((AV*)sstr) + 1;
10341 src_ary = AvARRAY((AV*)sstr);
10342 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10343 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10344 AvARRAY((AV*)dstr) = dst_ary;
10345 AvALLOC((AV*)dstr) = dst_ary;
10346 if (AvREAL((AV*)sstr)) {
10347 while (items-- > 0)
10348 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10351 while (items-- > 0)
10352 *dst_ary++ = sv_dup(*src_ary++, param);
10354 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10355 while (items-- > 0) {
10356 *dst_ary++ = &PL_sv_undef;
10360 AvARRAY((AV*)dstr) = NULL;
10361 AvALLOC((AV*)dstr) = (SV**)NULL;
10365 if (HvARRAY((HV*)sstr)) {
10367 const bool sharekeys = !!HvSHAREKEYS(sstr);
10368 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10369 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10371 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10372 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10374 HvARRAY(dstr) = (HE**)darray;
10375 while (i <= sxhv->xhv_max) {
10376 const HE * const source = HvARRAY(sstr)[i];
10377 HvARRAY(dstr)[i] = source
10378 ? he_dup(source, sharekeys, param) : 0;
10383 const struct xpvhv_aux * const saux = HvAUX(sstr);
10384 struct xpvhv_aux * const daux = HvAUX(dstr);
10385 /* This flag isn't copied. */
10386 /* SvOOK_on(hv) attacks the IV flags. */
10387 SvFLAGS(dstr) |= SVf_OOK;
10389 hvname = saux->xhv_name;
10390 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10392 daux->xhv_riter = saux->xhv_riter;
10393 daux->xhv_eiter = saux->xhv_eiter
10394 ? he_dup(saux->xhv_eiter,
10395 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10396 daux->xhv_backreferences =
10397 saux->xhv_backreferences
10398 ? (AV*) SvREFCNT_inc(
10399 sv_dup((SV*)saux->xhv_backreferences, param))
10402 daux->xhv_mro_meta = saux->xhv_mro_meta
10403 ? mro_meta_dup(saux->xhv_mro_meta, param)
10406 /* Record stashes for possible cloning in Perl_clone(). */
10408 av_push(param->stashes, dstr);
10412 HvARRAY((HV*)dstr) = NULL;
10415 if (!(param->flags & CLONEf_COPY_STACKS)) {
10419 /* NOTE: not refcounted */
10420 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10422 if (!CvISXSUB(dstr))
10423 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10425 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10426 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10427 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10428 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10430 /* don't dup if copying back - CvGV isn't refcounted, so the
10431 * duped GV may never be freed. A bit of a hack! DAPM */
10432 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10433 NULL : gv_dup(CvGV(dstr), param) ;
10434 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10436 CvWEAKOUTSIDE(sstr)
10437 ? cv_dup( CvOUTSIDE(dstr), param)
10438 : cv_dup_inc(CvOUTSIDE(dstr), param);
10439 if (!CvISXSUB(dstr))
10440 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10446 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10452 /* duplicate a context */
10455 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10457 PERL_CONTEXT *ncxs;
10460 return (PERL_CONTEXT*)NULL;
10462 /* look for it in the table first */
10463 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10467 /* create anew and remember what it is */
10468 Newxz(ncxs, max + 1, PERL_CONTEXT);
10469 ptr_table_store(PL_ptr_table, cxs, ncxs);
10472 PERL_CONTEXT * const cx = &cxs[ix];
10473 PERL_CONTEXT * const ncx = &ncxs[ix];
10474 ncx->cx_type = cx->cx_type;
10475 if (CxTYPE(cx) == CXt_SUBST) {
10476 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10479 ncx->blk_oldsp = cx->blk_oldsp;
10480 ncx->blk_oldcop = cx->blk_oldcop;
10481 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10482 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10483 ncx->blk_oldpm = cx->blk_oldpm;
10484 ncx->blk_gimme = cx->blk_gimme;
10485 switch (CxTYPE(cx)) {
10487 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10488 ? cv_dup_inc(cx->blk_sub.cv, param)
10489 : cv_dup(cx->blk_sub.cv,param));
10490 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10491 ? av_dup_inc(cx->blk_sub.argarray, param)
10493 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10494 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10495 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10496 ncx->blk_sub.lval = cx->blk_sub.lval;
10497 ncx->blk_sub.retop = cx->blk_sub.retop;
10498 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10499 cx->blk_sub.oldcomppad);
10502 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10503 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10504 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10505 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10506 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10507 ncx->blk_eval.retop = cx->blk_eval.retop;
10510 ncx->blk_loop.label = cx->blk_loop.label;
10511 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10512 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10513 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10514 ? cx->blk_loop.iterdata
10515 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10516 ncx->blk_loop.oldcomppad
10517 = (PAD*)ptr_table_fetch(PL_ptr_table,
10518 cx->blk_loop.oldcomppad);
10519 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10520 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10521 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10522 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10523 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10526 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10527 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10528 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10529 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10530 ncx->blk_sub.retop = cx->blk_sub.retop;
10542 /* duplicate a stack info structure */
10545 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10550 return (PERL_SI*)NULL;
10552 /* look for it in the table first */
10553 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10557 /* create anew and remember what it is */
10558 Newxz(nsi, 1, PERL_SI);
10559 ptr_table_store(PL_ptr_table, si, nsi);
10561 nsi->si_stack = av_dup_inc(si->si_stack, param);
10562 nsi->si_cxix = si->si_cxix;
10563 nsi->si_cxmax = si->si_cxmax;
10564 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10565 nsi->si_type = si->si_type;
10566 nsi->si_prev = si_dup(si->si_prev, param);
10567 nsi->si_next = si_dup(si->si_next, param);
10568 nsi->si_markoff = si->si_markoff;
10573 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10574 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10575 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10576 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10577 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10578 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10579 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10580 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10581 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10582 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10583 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10584 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10585 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10586 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10589 #define pv_dup_inc(p) SAVEPV(p)
10590 #define pv_dup(p) SAVEPV(p)
10591 #define svp_dup_inc(p,pp) any_dup(p,pp)
10593 /* map any object to the new equivent - either something in the
10594 * ptr table, or something in the interpreter structure
10598 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10603 return (void*)NULL;
10605 /* look for it in the table first */
10606 ret = ptr_table_fetch(PL_ptr_table, v);
10610 /* see if it is part of the interpreter structure */
10611 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10612 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10620 /* duplicate the save stack */
10623 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10626 ANY * const ss = proto_perl->Isavestack;
10627 const I32 max = proto_perl->Isavestack_max;
10628 I32 ix = proto_perl->Isavestack_ix;
10641 void (*dptr) (void*);
10642 void (*dxptr) (pTHX_ void*);
10644 Newxz(nss, max, ANY);
10647 const I32 type = POPINT(ss,ix);
10648 TOPINT(nss,ix) = type;
10650 case SAVEt_HELEM: /* hash element */
10651 sv = (SV*)POPPTR(ss,ix);
10652 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10654 case SAVEt_ITEM: /* normal string */
10655 case SAVEt_SV: /* scalar reference */
10656 sv = (SV*)POPPTR(ss,ix);
10657 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10660 case SAVEt_MORTALIZESV:
10661 sv = (SV*)POPPTR(ss,ix);
10662 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10664 case SAVEt_SHARED_PVREF: /* char* in shared space */
10665 c = (char*)POPPTR(ss,ix);
10666 TOPPTR(nss,ix) = savesharedpv(c);
10667 ptr = POPPTR(ss,ix);
10668 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10670 case SAVEt_GENERIC_SVREF: /* generic sv */
10671 case SAVEt_SVREF: /* scalar reference */
10672 sv = (SV*)POPPTR(ss,ix);
10673 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10674 ptr = POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10677 case SAVEt_HV: /* hash reference */
10678 case SAVEt_AV: /* array reference */
10679 sv = (SV*) POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10682 case SAVEt_COMPPAD:
10684 sv = (SV*) POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = sv_dup(sv, param);
10687 case SAVEt_INT: /* int reference */
10688 ptr = POPPTR(ss,ix);
10689 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10690 intval = (int)POPINT(ss,ix);
10691 TOPINT(nss,ix) = intval;
10693 case SAVEt_LONG: /* long reference */
10694 ptr = POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10697 case SAVEt_CLEARSV:
10698 longval = (long)POPLONG(ss,ix);
10699 TOPLONG(nss,ix) = longval;
10701 case SAVEt_I32: /* I32 reference */
10702 case SAVEt_I16: /* I16 reference */
10703 case SAVEt_I8: /* I8 reference */
10704 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10705 ptr = POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10708 TOPINT(nss,ix) = i;
10710 case SAVEt_IV: /* IV reference */
10711 ptr = POPPTR(ss,ix);
10712 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10714 TOPIV(nss,ix) = iv;
10716 case SAVEt_HPTR: /* HV* reference */
10717 case SAVEt_APTR: /* AV* reference */
10718 case SAVEt_SPTR: /* SV* reference */
10719 ptr = POPPTR(ss,ix);
10720 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10721 sv = (SV*)POPPTR(ss,ix);
10722 TOPPTR(nss,ix) = sv_dup(sv, param);
10724 case SAVEt_VPTR: /* random* reference */
10725 ptr = POPPTR(ss,ix);
10726 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10727 ptr = POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10730 case SAVEt_GENERIC_PVREF: /* generic char* */
10731 case SAVEt_PPTR: /* char* reference */
10732 ptr = POPPTR(ss,ix);
10733 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10734 c = (char*)POPPTR(ss,ix);
10735 TOPPTR(nss,ix) = pv_dup(c);
10737 case SAVEt_GP: /* scalar reference */
10738 gp = (GP*)POPPTR(ss,ix);
10739 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10740 (void)GpREFCNT_inc(gp);
10741 gv = (GV*)POPPTR(ss,ix);
10742 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10745 ptr = POPPTR(ss,ix);
10746 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10747 /* these are assumed to be refcounted properly */
10749 switch (((OP*)ptr)->op_type) {
10751 case OP_LEAVESUBLV:
10755 case OP_LEAVEWRITE:
10756 TOPPTR(nss,ix) = ptr;
10759 (void) OpREFCNT_inc(o);
10763 TOPPTR(nss,ix) = NULL;
10768 TOPPTR(nss,ix) = NULL;
10771 c = (char*)POPPTR(ss,ix);
10772 TOPPTR(nss,ix) = pv_dup_inc(c);
10775 hv = (HV*)POPPTR(ss,ix);
10776 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10777 c = (char*)POPPTR(ss,ix);
10778 TOPPTR(nss,ix) = pv_dup_inc(c);
10780 case SAVEt_STACK_POS: /* Position on Perl stack */
10782 TOPINT(nss,ix) = i;
10784 case SAVEt_DESTRUCTOR:
10785 ptr = POPPTR(ss,ix);
10786 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10787 dptr = POPDPTR(ss,ix);
10788 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10789 any_dup(FPTR2DPTR(void *, dptr),
10792 case SAVEt_DESTRUCTOR_X:
10793 ptr = POPPTR(ss,ix);
10794 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10795 dxptr = POPDXPTR(ss,ix);
10796 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10797 any_dup(FPTR2DPTR(void *, dxptr),
10800 case SAVEt_REGCONTEXT:
10803 TOPINT(nss,ix) = i;
10806 case SAVEt_AELEM: /* array element */
10807 sv = (SV*)POPPTR(ss,ix);
10808 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10810 TOPINT(nss,ix) = i;
10811 av = (AV*)POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = av_dup_inc(av, param);
10815 ptr = POPPTR(ss,ix);
10816 TOPPTR(nss,ix) = ptr;
10820 TOPINT(nss,ix) = i;
10821 ptr = POPPTR(ss,ix);
10824 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10825 HINTS_REFCNT_UNLOCK;
10827 TOPPTR(nss,ix) = ptr;
10828 if (i & HINT_LOCALIZE_HH) {
10829 hv = (HV*)POPPTR(ss,ix);
10830 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10834 longval = (long)POPLONG(ss,ix);
10835 TOPLONG(nss,ix) = longval;
10836 ptr = POPPTR(ss,ix);
10837 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10838 sv = (SV*)POPPTR(ss,ix);
10839 TOPPTR(nss,ix) = sv_dup(sv, param);
10842 ptr = POPPTR(ss,ix);
10843 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10844 longval = (long)POPBOOL(ss,ix);
10845 TOPBOOL(nss,ix) = (bool)longval;
10847 case SAVEt_SET_SVFLAGS:
10849 TOPINT(nss,ix) = i;
10851 TOPINT(nss,ix) = i;
10852 sv = (SV*)POPPTR(ss,ix);
10853 TOPPTR(nss,ix) = sv_dup(sv, param);
10855 case SAVEt_RE_STATE:
10857 const struct re_save_state *const old_state
10858 = (struct re_save_state *)
10859 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10860 struct re_save_state *const new_state
10861 = (struct re_save_state *)
10862 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10864 Copy(old_state, new_state, 1, struct re_save_state);
10865 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10867 new_state->re_state_bostr
10868 = pv_dup(old_state->re_state_bostr);
10869 new_state->re_state_reginput
10870 = pv_dup(old_state->re_state_reginput);
10871 new_state->re_state_regeol
10872 = pv_dup(old_state->re_state_regeol);
10873 new_state->re_state_regoffs
10874 = (regexp_paren_pair*)
10875 any_dup(old_state->re_state_regoffs, proto_perl);
10876 new_state->re_state_reglastparen
10877 = (U32*) any_dup(old_state->re_state_reglastparen,
10879 new_state->re_state_reglastcloseparen
10880 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10882 /* XXX This just has to be broken. The old save_re_context
10883 code did SAVEGENERICPV(PL_reg_start_tmp);
10884 PL_reg_start_tmp is char **.
10885 Look above to what the dup code does for
10886 SAVEt_GENERIC_PVREF
10887 It can never have worked.
10888 So this is merely a faithful copy of the exiting bug: */
10889 new_state->re_state_reg_start_tmp
10890 = (char **) pv_dup((char *)
10891 old_state->re_state_reg_start_tmp);
10892 /* I assume that it only ever "worked" because no-one called
10893 (pseudo)fork while the regexp engine had re-entered itself.
10895 #ifdef PERL_OLD_COPY_ON_WRITE
10896 new_state->re_state_nrs
10897 = sv_dup(old_state->re_state_nrs, param);
10899 new_state->re_state_reg_magic
10900 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10902 new_state->re_state_reg_oldcurpm
10903 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10905 new_state->re_state_reg_curpm
10906 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10908 new_state->re_state_reg_oldsaved
10909 = pv_dup(old_state->re_state_reg_oldsaved);
10910 new_state->re_state_reg_poscache
10911 = pv_dup(old_state->re_state_reg_poscache);
10912 new_state->re_state_reg_starttry
10913 = pv_dup(old_state->re_state_reg_starttry);
10916 case SAVEt_COMPILE_WARNINGS:
10917 ptr = POPPTR(ss,ix);
10918 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10921 ptr = POPPTR(ss,ix);
10922 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10926 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10934 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10935 * flag to the result. This is done for each stash before cloning starts,
10936 * so we know which stashes want their objects cloned */
10939 do_mark_cloneable_stash(pTHX_ SV *sv)
10941 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10943 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10944 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10945 if (cloner && GvCV(cloner)) {
10952 mXPUSHs(newSVhek(hvname));
10954 call_sv((SV*)GvCV(cloner), G_SCALAR);
10961 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10969 =for apidoc perl_clone
10971 Create and return a new interpreter by cloning the current one.
10973 perl_clone takes these flags as parameters:
10975 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10976 without it we only clone the data and zero the stacks,
10977 with it we copy the stacks and the new perl interpreter is
10978 ready to run at the exact same point as the previous one.
10979 The pseudo-fork code uses COPY_STACKS while the
10980 threads->create doesn't.
10982 CLONEf_KEEP_PTR_TABLE
10983 perl_clone keeps a ptr_table with the pointer of the old
10984 variable as a key and the new variable as a value,
10985 this allows it to check if something has been cloned and not
10986 clone it again but rather just use the value and increase the
10987 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10988 the ptr_table using the function
10989 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10990 reason to keep it around is if you want to dup some of your own
10991 variable who are outside the graph perl scans, example of this
10992 code is in threads.xs create
10995 This is a win32 thing, it is ignored on unix, it tells perls
10996 win32host code (which is c++) to clone itself, this is needed on
10997 win32 if you want to run two threads at the same time,
10998 if you just want to do some stuff in a separate perl interpreter
10999 and then throw it away and return to the original one,
11000 you don't need to do anything.
11005 /* XXX the above needs expanding by someone who actually understands it ! */
11006 EXTERN_C PerlInterpreter *
11007 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11010 perl_clone(PerlInterpreter *proto_perl, UV flags)
11013 #ifdef PERL_IMPLICIT_SYS
11015 /* perlhost.h so we need to call into it
11016 to clone the host, CPerlHost should have a c interface, sky */
11018 if (flags & CLONEf_CLONE_HOST) {
11019 return perl_clone_host(proto_perl,flags);
11021 return perl_clone_using(proto_perl, flags,
11023 proto_perl->IMemShared,
11024 proto_perl->IMemParse,
11026 proto_perl->IStdIO,
11030 proto_perl->IProc);
11034 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11035 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11036 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11037 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11038 struct IPerlDir* ipD, struct IPerlSock* ipS,
11039 struct IPerlProc* ipP)
11041 /* XXX many of the string copies here can be optimized if they're
11042 * constants; they need to be allocated as common memory and just
11043 * their pointers copied. */
11046 CLONE_PARAMS clone_params;
11047 CLONE_PARAMS* const param = &clone_params;
11049 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11050 /* for each stash, determine whether its objects should be cloned */
11051 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11052 PERL_SET_THX(my_perl);
11055 PoisonNew(my_perl, 1, PerlInterpreter);
11061 PL_savestack_ix = 0;
11062 PL_savestack_max = -1;
11063 PL_sig_pending = 0;
11065 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11066 # else /* !DEBUGGING */
11067 Zero(my_perl, 1, PerlInterpreter);
11068 # endif /* DEBUGGING */
11070 /* host pointers */
11072 PL_MemShared = ipMS;
11073 PL_MemParse = ipMP;
11080 #else /* !PERL_IMPLICIT_SYS */
11082 CLONE_PARAMS clone_params;
11083 CLONE_PARAMS* param = &clone_params;
11084 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11085 /* for each stash, determine whether its objects should be cloned */
11086 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11087 PERL_SET_THX(my_perl);
11090 PoisonNew(my_perl, 1, PerlInterpreter);
11096 PL_savestack_ix = 0;
11097 PL_savestack_max = -1;
11098 PL_sig_pending = 0;
11100 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11101 # else /* !DEBUGGING */
11102 Zero(my_perl, 1, PerlInterpreter);
11103 # endif /* DEBUGGING */
11104 #endif /* PERL_IMPLICIT_SYS */
11105 param->flags = flags;
11106 param->proto_perl = proto_perl;
11108 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11110 PL_body_arenas = NULL;
11111 Zero(&PL_body_roots, 1, PL_body_roots);
11113 PL_nice_chunk = NULL;
11114 PL_nice_chunk_size = 0;
11116 PL_sv_objcount = 0;
11118 PL_sv_arenaroot = NULL;
11120 PL_debug = proto_perl->Idebug;
11122 PL_hash_seed = proto_perl->Ihash_seed;
11123 PL_rehash_seed = proto_perl->Irehash_seed;
11125 #ifdef USE_REENTRANT_API
11126 /* XXX: things like -Dm will segfault here in perlio, but doing
11127 * PERL_SET_CONTEXT(proto_perl);
11128 * breaks too many other things
11130 Perl_reentrant_init(aTHX);
11133 /* create SV map for pointer relocation */
11134 PL_ptr_table = ptr_table_new();
11136 /* initialize these special pointers as early as possible */
11137 SvANY(&PL_sv_undef) = NULL;
11138 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11139 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11140 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11142 SvANY(&PL_sv_no) = new_XPVNV();
11143 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11144 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11145 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11146 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11147 SvCUR_set(&PL_sv_no, 0);
11148 SvLEN_set(&PL_sv_no, 1);
11149 SvIV_set(&PL_sv_no, 0);
11150 SvNV_set(&PL_sv_no, 0);
11151 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11153 SvANY(&PL_sv_yes) = new_XPVNV();
11154 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11155 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11156 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11157 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11158 SvCUR_set(&PL_sv_yes, 1);
11159 SvLEN_set(&PL_sv_yes, 2);
11160 SvIV_set(&PL_sv_yes, 1);
11161 SvNV_set(&PL_sv_yes, 1);
11162 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11164 /* create (a non-shared!) shared string table */
11165 PL_strtab = newHV();
11166 HvSHAREKEYS_off(PL_strtab);
11167 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11168 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11170 PL_compiling = proto_perl->Icompiling;
11172 /* These two PVs will be free'd special way so must set them same way op.c does */
11173 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11174 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11176 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11177 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11179 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11180 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11181 if (PL_compiling.cop_hints_hash) {
11183 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11184 HINTS_REFCNT_UNLOCK;
11186 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11187 #ifdef PERL_DEBUG_READONLY_OPS
11192 /* pseudo environmental stuff */
11193 PL_origargc = proto_perl->Iorigargc;
11194 PL_origargv = proto_perl->Iorigargv;
11196 param->stashes = newAV(); /* Setup array of objects to call clone on */
11198 /* Set tainting stuff before PerlIO_debug can possibly get called */
11199 PL_tainting = proto_perl->Itainting;
11200 PL_taint_warn = proto_perl->Itaint_warn;
11202 #ifdef PERLIO_LAYERS
11203 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11204 PerlIO_clone(aTHX_ proto_perl, param);
11207 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11208 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11209 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11210 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11211 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11212 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11215 PL_minus_c = proto_perl->Iminus_c;
11216 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11217 PL_localpatches = proto_perl->Ilocalpatches;
11218 PL_splitstr = proto_perl->Isplitstr;
11219 PL_preprocess = proto_perl->Ipreprocess;
11220 PL_minus_n = proto_perl->Iminus_n;
11221 PL_minus_p = proto_perl->Iminus_p;
11222 PL_minus_l = proto_perl->Iminus_l;
11223 PL_minus_a = proto_perl->Iminus_a;
11224 PL_minus_E = proto_perl->Iminus_E;
11225 PL_minus_F = proto_perl->Iminus_F;
11226 PL_doswitches = proto_perl->Idoswitches;
11227 PL_dowarn = proto_perl->Idowarn;
11228 PL_doextract = proto_perl->Idoextract;
11229 PL_sawampersand = proto_perl->Isawampersand;
11230 PL_unsafe = proto_perl->Iunsafe;
11231 PL_inplace = SAVEPV(proto_perl->Iinplace);
11232 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11233 PL_perldb = proto_perl->Iperldb;
11234 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11235 PL_exit_flags = proto_perl->Iexit_flags;
11237 /* magical thingies */
11238 /* XXX time(&PL_basetime) when asked for? */
11239 PL_basetime = proto_perl->Ibasetime;
11240 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11242 PL_maxsysfd = proto_perl->Imaxsysfd;
11243 PL_statusvalue = proto_perl->Istatusvalue;
11245 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11247 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11249 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11251 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11252 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11253 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11256 /* RE engine related */
11257 Zero(&PL_reg_state, 1, struct re_save_state);
11258 PL_reginterp_cnt = 0;
11259 PL_regmatch_slab = NULL;
11261 /* Clone the regex array */
11262 /* ORANGE FIXME for plugins, probably in the SV dup code.
11263 newSViv(PTR2IV(CALLREGDUPE(
11264 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11266 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11267 PL_regex_pad = AvARRAY(PL_regex_padav);
11269 /* shortcuts to various I/O objects */
11270 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11271 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11272 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11273 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11274 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11275 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11277 /* shortcuts to regexp stuff */
11278 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11280 /* shortcuts to misc objects */
11281 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11283 /* shortcuts to debugging objects */
11284 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11285 PL_DBline = gv_dup(proto_perl->IDBline, param);
11286 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11287 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11288 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11289 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11290 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11292 /* symbol tables */
11293 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11294 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11295 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11296 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11297 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11299 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11300 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11301 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11302 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11303 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11304 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11305 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11306 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11308 PL_sub_generation = proto_perl->Isub_generation;
11309 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11311 /* funky return mechanisms */
11312 PL_forkprocess = proto_perl->Iforkprocess;
11314 /* subprocess state */
11315 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11317 /* internal state */
11318 PL_maxo = proto_perl->Imaxo;
11319 if (proto_perl->Iop_mask)
11320 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11323 /* PL_asserting = proto_perl->Iasserting; */
11325 /* current interpreter roots */
11326 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11328 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11330 PL_main_start = proto_perl->Imain_start;
11331 PL_eval_root = proto_perl->Ieval_root;
11332 PL_eval_start = proto_perl->Ieval_start;
11334 /* runtime control stuff */
11335 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11337 PL_filemode = proto_perl->Ifilemode;
11338 PL_lastfd = proto_perl->Ilastfd;
11339 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11342 PL_gensym = proto_perl->Igensym;
11343 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11344 PL_laststatval = proto_perl->Ilaststatval;
11345 PL_laststype = proto_perl->Ilaststype;
11348 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11350 /* interpreter atexit processing */
11351 PL_exitlistlen = proto_perl->Iexitlistlen;
11352 if (PL_exitlistlen) {
11353 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11354 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11357 PL_exitlist = (PerlExitListEntry*)NULL;
11359 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11360 if (PL_my_cxt_size) {
11361 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11362 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11363 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11364 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11365 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11369 PL_my_cxt_list = (void**)NULL;
11370 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11371 PL_my_cxt_keys = (const char**)NULL;
11374 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11375 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11376 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11378 PL_profiledata = NULL;
11380 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11382 PAD_CLONE_VARS(proto_perl, param);
11384 #ifdef HAVE_INTERP_INTERN
11385 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11388 /* more statics moved here */
11389 PL_generation = proto_perl->Igeneration;
11390 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11392 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11393 PL_in_clean_all = proto_perl->Iin_clean_all;
11395 PL_uid = proto_perl->Iuid;
11396 PL_euid = proto_perl->Ieuid;
11397 PL_gid = proto_perl->Igid;
11398 PL_egid = proto_perl->Iegid;
11399 PL_nomemok = proto_perl->Inomemok;
11400 PL_an = proto_perl->Ian;
11401 PL_evalseq = proto_perl->Ievalseq;
11402 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11403 PL_origalen = proto_perl->Iorigalen;
11404 #ifdef PERL_USES_PL_PIDSTATUS
11405 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11407 PL_osname = SAVEPV(proto_perl->Iosname);
11408 PL_sighandlerp = proto_perl->Isighandlerp;
11410 PL_runops = proto_perl->Irunops;
11412 PL_parser = parser_dup(proto_perl->Iparser, param);
11414 PL_subline = proto_perl->Isubline;
11415 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11418 PL_cryptseen = proto_perl->Icryptseen;
11421 PL_hints = proto_perl->Ihints;
11423 PL_amagic_generation = proto_perl->Iamagic_generation;
11425 #ifdef USE_LOCALE_COLLATE
11426 PL_collation_ix = proto_perl->Icollation_ix;
11427 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11428 PL_collation_standard = proto_perl->Icollation_standard;
11429 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11430 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11431 #endif /* USE_LOCALE_COLLATE */
11433 #ifdef USE_LOCALE_NUMERIC
11434 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11435 PL_numeric_standard = proto_perl->Inumeric_standard;
11436 PL_numeric_local = proto_perl->Inumeric_local;
11437 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11438 #endif /* !USE_LOCALE_NUMERIC */
11440 /* utf8 character classes */
11441 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11442 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11443 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11444 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11445 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11446 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11447 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11448 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11449 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11450 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11451 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11452 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11453 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11454 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11455 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11456 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11457 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11458 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11459 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11460 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11462 /* Did the locale setup indicate UTF-8? */
11463 PL_utf8locale = proto_perl->Iutf8locale;
11464 /* Unicode features (see perlrun/-C) */
11465 PL_unicode = proto_perl->Iunicode;
11467 /* Pre-5.8 signals control */
11468 PL_signals = proto_perl->Isignals;
11470 /* times() ticks per second */
11471 PL_clocktick = proto_perl->Iclocktick;
11473 /* Recursion stopper for PerlIO_find_layer */
11474 PL_in_load_module = proto_perl->Iin_load_module;
11476 /* sort() routine */
11477 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11479 /* Not really needed/useful since the reenrant_retint is "volatile",
11480 * but do it for consistency's sake. */
11481 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11483 /* Hooks to shared SVs and locks. */
11484 PL_sharehook = proto_perl->Isharehook;
11485 PL_lockhook = proto_perl->Ilockhook;
11486 PL_unlockhook = proto_perl->Iunlockhook;
11487 PL_threadhook = proto_perl->Ithreadhook;
11488 PL_destroyhook = proto_perl->Idestroyhook;
11490 #ifdef THREADS_HAVE_PIDS
11491 PL_ppid = proto_perl->Ippid;
11495 PL_last_swash_hv = NULL; /* reinits on demand */
11496 PL_last_swash_klen = 0;
11497 PL_last_swash_key[0]= '\0';
11498 PL_last_swash_tmps = (U8*)NULL;
11499 PL_last_swash_slen = 0;
11501 PL_glob_index = proto_perl->Iglob_index;
11502 PL_srand_called = proto_perl->Isrand_called;
11503 PL_bitcount = NULL; /* reinits on demand */
11505 if (proto_perl->Ipsig_pend) {
11506 Newxz(PL_psig_pend, SIG_SIZE, int);
11509 PL_psig_pend = (int*)NULL;
11512 if (proto_perl->Ipsig_ptr) {
11513 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11514 Newxz(PL_psig_name, SIG_SIZE, SV*);
11515 for (i = 1; i < SIG_SIZE; i++) {
11516 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11517 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11521 PL_psig_ptr = (SV**)NULL;
11522 PL_psig_name = (SV**)NULL;
11525 /* intrpvar.h stuff */
11527 if (flags & CLONEf_COPY_STACKS) {
11528 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11529 PL_tmps_ix = proto_perl->Itmps_ix;
11530 PL_tmps_max = proto_perl->Itmps_max;
11531 PL_tmps_floor = proto_perl->Itmps_floor;
11532 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11534 while (i <= PL_tmps_ix) {
11535 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11539 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11540 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11541 Newxz(PL_markstack, i, I32);
11542 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11543 - proto_perl->Imarkstack);
11544 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11545 - proto_perl->Imarkstack);
11546 Copy(proto_perl->Imarkstack, PL_markstack,
11547 PL_markstack_ptr - PL_markstack + 1, I32);
11549 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11550 * NOTE: unlike the others! */
11551 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11552 PL_scopestack_max = proto_perl->Iscopestack_max;
11553 Newxz(PL_scopestack, PL_scopestack_max, I32);
11554 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11556 /* NOTE: si_dup() looks at PL_markstack */
11557 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11559 /* PL_curstack = PL_curstackinfo->si_stack; */
11560 PL_curstack = av_dup(proto_perl->Icurstack, param);
11561 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11563 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11564 PL_stack_base = AvARRAY(PL_curstack);
11565 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11566 - proto_perl->Istack_base);
11567 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11569 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11570 * NOTE: unlike the others! */
11571 PL_savestack_ix = proto_perl->Isavestack_ix;
11572 PL_savestack_max = proto_perl->Isavestack_max;
11573 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11574 PL_savestack = ss_dup(proto_perl, param);
11578 ENTER; /* perl_destruct() wants to LEAVE; */
11580 /* although we're not duplicating the tmps stack, we should still
11581 * add entries for any SVs on the tmps stack that got cloned by a
11582 * non-refcount means (eg a temp in @_); otherwise they will be
11585 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11586 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11587 proto_perl->Itmps_stack[i]);
11588 if (nsv && !SvREFCNT(nsv)) {
11590 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11595 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11596 PL_top_env = &PL_start_env;
11598 PL_op = proto_perl->Iop;
11601 PL_Xpv = (XPV*)NULL;
11602 my_perl->Ina = proto_perl->Ina;
11604 PL_statbuf = proto_perl->Istatbuf;
11605 PL_statcache = proto_perl->Istatcache;
11606 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11607 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11609 PL_timesbuf = proto_perl->Itimesbuf;
11612 PL_tainted = proto_perl->Itainted;
11613 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11614 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11615 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11616 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11617 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11618 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11619 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11620 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11621 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11623 PL_restartop = proto_perl->Irestartop;
11624 PL_in_eval = proto_perl->Iin_eval;
11625 PL_delaymagic = proto_perl->Idelaymagic;
11626 PL_dirty = proto_perl->Idirty;
11627 PL_localizing = proto_perl->Ilocalizing;
11629 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11630 PL_hv_fetch_ent_mh = NULL;
11631 PL_modcount = proto_perl->Imodcount;
11632 PL_lastgotoprobe = NULL;
11633 PL_dumpindent = proto_perl->Idumpindent;
11635 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11636 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11637 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11638 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11639 PL_efloatbuf = NULL; /* reinits on demand */
11640 PL_efloatsize = 0; /* reinits on demand */
11644 PL_screamfirst = NULL;
11645 PL_screamnext = NULL;
11646 PL_maxscream = -1; /* reinits on demand */
11647 PL_lastscream = NULL;
11650 PL_regdummy = proto_perl->Iregdummy;
11651 PL_colorset = 0; /* reinits PL_colors[] */
11652 /*PL_colors[6] = {0,0,0,0,0,0};*/
11656 /* Pluggable optimizer */
11657 PL_peepp = proto_perl->Ipeepp;
11659 PL_stashcache = newHV();
11661 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11662 proto_perl->Iwatchaddr);
11663 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11664 if (PL_debug && PL_watchaddr) {
11665 PerlIO_printf(Perl_debug_log,
11666 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11667 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11668 PTR2UV(PL_watchok));
11671 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11672 ptr_table_free(PL_ptr_table);
11673 PL_ptr_table = NULL;
11676 /* Call the ->CLONE method, if it exists, for each of the stashes
11677 identified by sv_dup() above.
11679 while(av_len(param->stashes) != -1) {
11680 HV* const stash = (HV*) av_shift(param->stashes);
11681 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11682 if (cloner && GvCV(cloner)) {
11687 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11689 call_sv((SV*)GvCV(cloner), G_DISCARD);
11695 SvREFCNT_dec(param->stashes);
11697 /* orphaned? eg threads->new inside BEGIN or use */
11698 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11699 SvREFCNT_inc_simple_void(PL_compcv);
11700 SAVEFREESV(PL_compcv);
11706 #endif /* USE_ITHREADS */
11709 =head1 Unicode Support
11711 =for apidoc sv_recode_to_utf8
11713 The encoding is assumed to be an Encode object, on entry the PV
11714 of the sv is assumed to be octets in that encoding, and the sv
11715 will be converted into Unicode (and UTF-8).
11717 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11718 is not a reference, nothing is done to the sv. If the encoding is not
11719 an C<Encode::XS> Encoding object, bad things will happen.
11720 (See F<lib/encoding.pm> and L<Encode>).
11722 The PV of the sv is returned.
11727 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11730 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11744 Passing sv_yes is wrong - it needs to be or'ed set of constants
11745 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11746 remove converted chars from source.
11748 Both will default the value - let them.
11750 XPUSHs(&PL_sv_yes);
11753 call_method("decode", G_SCALAR);
11757 s = SvPV_const(uni, len);
11758 if (s != SvPVX_const(sv)) {
11759 SvGROW(sv, len + 1);
11760 Move(s, SvPVX(sv), len + 1, char);
11761 SvCUR_set(sv, len);
11768 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11772 =for apidoc sv_cat_decode
11774 The encoding is assumed to be an Encode object, the PV of the ssv is
11775 assumed to be octets in that encoding and decoding the input starts
11776 from the position which (PV + *offset) pointed to. The dsv will be
11777 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11778 when the string tstr appears in decoding output or the input ends on
11779 the PV of the ssv. The value which the offset points will be modified
11780 to the last input position on the ssv.
11782 Returns TRUE if the terminator was found, else returns FALSE.
11787 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11788 SV *ssv, int *offset, char *tstr, int tlen)
11792 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11803 offsv = newSViv(*offset);
11805 mXPUSHp(tstr, tlen);
11807 call_method("cat_decode", G_SCALAR);
11809 ret = SvTRUE(TOPs);
11810 *offset = SvIV(offsv);
11816 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11821 /* ---------------------------------------------------------------------
11823 * support functions for report_uninit()
11826 /* the maxiumum size of array or hash where we will scan looking
11827 * for the undefined element that triggered the warning */
11829 #define FUV_MAX_SEARCH_SIZE 1000
11831 /* Look for an entry in the hash whose value has the same SV as val;
11832 * If so, return a mortal copy of the key. */
11835 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11838 register HE **array;
11841 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11842 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11845 array = HvARRAY(hv);
11847 for (i=HvMAX(hv); i>0; i--) {
11848 register HE *entry;
11849 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11850 if (HeVAL(entry) != val)
11852 if ( HeVAL(entry) == &PL_sv_undef ||
11853 HeVAL(entry) == &PL_sv_placeholder)
11857 if (HeKLEN(entry) == HEf_SVKEY)
11858 return sv_mortalcopy(HeKEY_sv(entry));
11859 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11865 /* Look for an entry in the array whose value has the same SV as val;
11866 * If so, return the index, otherwise return -1. */
11869 S_find_array_subscript(pTHX_ AV *av, SV* val)
11872 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11873 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11876 if (val != &PL_sv_undef) {
11877 SV ** const svp = AvARRAY(av);
11880 for (i=AvFILLp(av); i>=0; i--)
11887 /* S_varname(): return the name of a variable, optionally with a subscript.
11888 * If gv is non-zero, use the name of that global, along with gvtype (one
11889 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11890 * targ. Depending on the value of the subscript_type flag, return:
11893 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11894 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11895 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11896 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11899 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11900 SV* keyname, I32 aindex, int subscript_type)
11903 SV * const name = sv_newmortal();
11906 buffer[0] = gvtype;
11909 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11911 gv_fullname4(name, gv, buffer, 0);
11913 if ((unsigned int)SvPVX(name)[1] <= 26) {
11915 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11917 /* Swap the 1 unprintable control character for the 2 byte pretty
11918 version - ie substr($name, 1, 1) = $buffer; */
11919 sv_insert(name, 1, 1, buffer, 2);
11923 CV * const cv = find_runcv(NULL);
11927 if (!cv || !CvPADLIST(cv))
11929 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11930 sv = *av_fetch(av, targ, FALSE);
11931 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11934 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11935 SV * const sv = newSV(0);
11936 *SvPVX(name) = '$';
11937 Perl_sv_catpvf(aTHX_ name, "{%s}",
11938 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11941 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11942 *SvPVX(name) = '$';
11943 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11945 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11946 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11953 =for apidoc find_uninit_var
11955 Find the name of the undefined variable (if any) that caused the operator o
11956 to issue a "Use of uninitialized value" warning.
11957 If match is true, only return a name if it's value matches uninit_sv.
11958 So roughly speaking, if a unary operator (such as OP_COS) generates a
11959 warning, then following the direct child of the op may yield an
11960 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11961 other hand, with OP_ADD there are two branches to follow, so we only print
11962 the variable name if we get an exact match.
11964 The name is returned as a mortal SV.
11966 Assumes that PL_op is the op that originally triggered the error, and that
11967 PL_comppad/PL_curpad points to the currently executing pad.
11973 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11981 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11982 uninit_sv == &PL_sv_placeholder)))
11985 switch (obase->op_type) {
11992 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11993 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11996 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11998 if (pad) { /* @lex, %lex */
11999 sv = PAD_SVl(obase->op_targ);
12003 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12004 /* @global, %global */
12005 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12008 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12010 else /* @{expr}, %{expr} */
12011 return find_uninit_var(cUNOPx(obase)->op_first,
12015 /* attempt to find a match within the aggregate */
12017 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12019 subscript_type = FUV_SUBSCRIPT_HASH;
12022 index = find_array_subscript((AV*)sv, uninit_sv);
12024 subscript_type = FUV_SUBSCRIPT_ARRAY;
12027 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12030 return varname(gv, hash ? '%' : '@', obase->op_targ,
12031 keysv, index, subscript_type);
12035 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12037 return varname(NULL, '$', obase->op_targ,
12038 NULL, 0, FUV_SUBSCRIPT_NONE);
12041 gv = cGVOPx_gv(obase);
12042 if (!gv || (match && GvSV(gv) != uninit_sv))
12044 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12047 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12050 av = (AV*)PAD_SV(obase->op_targ);
12051 if (!av || SvRMAGICAL(av))
12053 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12054 if (!svp || *svp != uninit_sv)
12057 return varname(NULL, '$', obase->op_targ,
12058 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12061 gv = cGVOPx_gv(obase);
12067 if (!av || SvRMAGICAL(av))
12069 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12070 if (!svp || *svp != uninit_sv)
12073 return varname(gv, '$', 0,
12074 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12079 o = cUNOPx(obase)->op_first;
12080 if (!o || o->op_type != OP_NULL ||
12081 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12083 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12087 if (PL_op == obase)
12088 /* $a[uninit_expr] or $h{uninit_expr} */
12089 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12092 o = cBINOPx(obase)->op_first;
12093 kid = cBINOPx(obase)->op_last;
12095 /* get the av or hv, and optionally the gv */
12097 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12098 sv = PAD_SV(o->op_targ);
12100 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12101 && cUNOPo->op_first->op_type == OP_GV)
12103 gv = cGVOPx_gv(cUNOPo->op_first);
12106 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12111 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12112 /* index is constant */
12116 if (obase->op_type == OP_HELEM) {
12117 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12118 if (!he || HeVAL(he) != uninit_sv)
12122 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12123 if (!svp || *svp != uninit_sv)
12127 if (obase->op_type == OP_HELEM)
12128 return varname(gv, '%', o->op_targ,
12129 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12131 return varname(gv, '@', o->op_targ, NULL,
12132 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12135 /* index is an expression;
12136 * attempt to find a match within the aggregate */
12137 if (obase->op_type == OP_HELEM) {
12138 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12140 return varname(gv, '%', o->op_targ,
12141 keysv, 0, FUV_SUBSCRIPT_HASH);
12144 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12146 return varname(gv, '@', o->op_targ,
12147 NULL, index, FUV_SUBSCRIPT_ARRAY);
12152 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12154 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12159 /* only examine RHS */
12160 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12163 o = cUNOPx(obase)->op_first;
12164 if (o->op_type == OP_PUSHMARK)
12167 if (!o->op_sibling) {
12168 /* one-arg version of open is highly magical */
12170 if (o->op_type == OP_GV) { /* open FOO; */
12172 if (match && GvSV(gv) != uninit_sv)
12174 return varname(gv, '$', 0,
12175 NULL, 0, FUV_SUBSCRIPT_NONE);
12177 /* other possibilities not handled are:
12178 * open $x; or open my $x; should return '${*$x}'
12179 * open expr; should return '$'.expr ideally
12185 /* ops where $_ may be an implicit arg */
12189 if ( !(obase->op_flags & OPf_STACKED)) {
12190 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12191 ? PAD_SVl(obase->op_targ)
12194 sv = sv_newmortal();
12195 sv_setpvn(sv, "$_", 2);
12204 /* skip filehandle as it can't produce 'undef' warning */
12205 o = cUNOPx(obase)->op_first;
12206 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12207 o = o->op_sibling->op_sibling;
12213 match = 1; /* XS or custom code could trigger random warnings */
12218 /* XXX tmp hack: these two may call an XS sub, and currently
12219 XS subs don't have a SUB entry on the context stack, so CV and
12220 pad determination goes wrong, and BAD things happen. So, just
12221 don't try to determine the value under those circumstances.
12222 Need a better fix at dome point. DAPM 11/2007 */
12226 /* def-ness of rval pos() is independent of the def-ness of its arg */
12227 if ( !(obase->op_flags & OPf_MOD))
12232 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12233 return newSVpvs_flags("${$/}", SVs_TEMP);
12238 if (!(obase->op_flags & OPf_KIDS))
12240 o = cUNOPx(obase)->op_first;
12246 /* if all except one arg are constant, or have no side-effects,
12247 * or are optimized away, then it's unambiguous */
12249 for (kid=o; kid; kid = kid->op_sibling) {
12251 const OPCODE type = kid->op_type;
12252 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12253 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12254 || (type == OP_PUSHMARK)
12258 if (o2) { /* more than one found */
12265 return find_uninit_var(o2, uninit_sv, match);
12267 /* scan all args */
12269 sv = find_uninit_var(o, uninit_sv, 1);
12281 =for apidoc report_uninit
12283 Print appropriate "Use of uninitialized variable" warning
12289 Perl_report_uninit(pTHX_ SV* uninit_sv)
12293 SV* varname = NULL;
12295 varname = find_uninit_var(PL_op, uninit_sv,0);
12297 sv_insert(varname, 0, 0, " ", 1);
12299 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12300 varname ? SvPV_nolen_const(varname) : "",
12301 " in ", OP_DESC(PL_op));
12304 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12310 * c-indentation-style: bsd
12311 * c-basic-offset: 4
12312 * indent-tabs-mode: t
12315 * ex: set ts=8 sts=4 sw=4 noet: