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 */
1949 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1950 DEBUG_c(PerlIO_printf(Perl_debug_log,
1951 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1957 /* IV not precise. No need to convert from PV, as NV
1958 conversion would already have cached IV if it detected
1959 that PV->IV would be better than PV->NV->IV
1960 flags already correct - don't set public IOK. */
1961 DEBUG_c(PerlIO_printf(Perl_debug_log,
1962 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1967 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1968 but the cast (NV)IV_MIN rounds to a the value less (more
1969 negative) than IV_MIN which happens to be equal to SvNVX ??
1970 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1971 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1972 (NV)UVX == NVX are both true, but the values differ. :-(
1973 Hopefully for 2s complement IV_MIN is something like
1974 0x8000000000000000 which will be exact. NWC */
1977 SvUV_set(sv, U_V(SvNVX(sv)));
1979 (SvNVX(sv) == (NV) SvUVX(sv))
1980 #ifndef NV_PRESERVES_UV
1981 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1982 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1983 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1984 /* Don't flag it as "accurately an integer" if the number
1985 came from a (by definition imprecise) NV operation, and
1986 we're outside the range of NV integer precision */
1991 DEBUG_c(PerlIO_printf(Perl_debug_log,
1992 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
1998 else if (SvPOKp(sv) && SvLEN(sv)) {
2000 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2001 /* We want to avoid a possible problem when we cache an IV/ a UV which
2002 may be later translated to an NV, and the resulting NV is not
2003 the same as the direct translation of the initial string
2004 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2005 be careful to ensure that the value with the .456 is around if the
2006 NV value is requested in the future).
2008 This means that if we cache such an IV/a UV, we need to cache the
2009 NV as well. Moreover, we trade speed for space, and do not
2010 cache the NV if we are sure it's not needed.
2013 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2014 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2015 == IS_NUMBER_IN_UV) {
2016 /* It's definitely an integer, only upgrade to PVIV */
2017 if (SvTYPE(sv) < SVt_PVIV)
2018 sv_upgrade(sv, SVt_PVIV);
2020 } else if (SvTYPE(sv) < SVt_PVNV)
2021 sv_upgrade(sv, SVt_PVNV);
2023 /* If NVs preserve UVs then we only use the UV value if we know that
2024 we aren't going to call atof() below. If NVs don't preserve UVs
2025 then the value returned may have more precision than atof() will
2026 return, even though value isn't perfectly accurate. */
2027 if ((numtype & (IS_NUMBER_IN_UV
2028 #ifdef NV_PRESERVES_UV
2031 )) == IS_NUMBER_IN_UV) {
2032 /* This won't turn off the public IOK flag if it was set above */
2033 (void)SvIOKp_on(sv);
2035 if (!(numtype & IS_NUMBER_NEG)) {
2037 if (value <= (UV)IV_MAX) {
2038 SvIV_set(sv, (IV)value);
2040 /* it didn't overflow, and it was positive. */
2041 SvUV_set(sv, value);
2045 /* 2s complement assumption */
2046 if (value <= (UV)IV_MIN) {
2047 SvIV_set(sv, -(IV)value);
2049 /* Too negative for an IV. This is a double upgrade, but
2050 I'm assuming it will be rare. */
2051 if (SvTYPE(sv) < SVt_PVNV)
2052 sv_upgrade(sv, SVt_PVNV);
2056 SvNV_set(sv, -(NV)value);
2057 SvIV_set(sv, IV_MIN);
2061 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2062 will be in the previous block to set the IV slot, and the next
2063 block to set the NV slot. So no else here. */
2065 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2066 != IS_NUMBER_IN_UV) {
2067 /* It wasn't an (integer that doesn't overflow the UV). */
2068 SvNV_set(sv, Atof(SvPVX_const(sv)));
2070 if (! numtype && ckWARN(WARN_NUMERIC))
2073 #if defined(USE_LONG_DOUBLE)
2074 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2075 PTR2UV(sv), SvNVX(sv)));
2077 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2078 PTR2UV(sv), SvNVX(sv)));
2081 #ifdef NV_PRESERVES_UV
2082 (void)SvIOKp_on(sv);
2084 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2085 SvIV_set(sv, I_V(SvNVX(sv)));
2086 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2089 NOOP; /* Integer is imprecise. NOK, IOKp */
2091 /* UV will not work better than IV */
2093 if (SvNVX(sv) > (NV)UV_MAX) {
2095 /* Integer is inaccurate. NOK, IOKp, is UV */
2096 SvUV_set(sv, UV_MAX);
2098 SvUV_set(sv, U_V(SvNVX(sv)));
2099 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2100 NV preservse UV so can do correct comparison. */
2101 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2104 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2109 #else /* NV_PRESERVES_UV */
2110 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2111 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2112 /* The IV/UV slot will have been set from value returned by
2113 grok_number above. The NV slot has just been set using
2116 assert (SvIOKp(sv));
2118 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2119 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2120 /* Small enough to preserve all bits. */
2121 (void)SvIOKp_on(sv);
2123 SvIV_set(sv, I_V(SvNVX(sv)));
2124 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2126 /* Assumption: first non-preserved integer is < IV_MAX,
2127 this NV is in the preserved range, therefore: */
2128 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2130 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);
2134 0 0 already failed to read UV.
2135 0 1 already failed to read UV.
2136 1 0 you won't get here in this case. IV/UV
2137 slot set, public IOK, Atof() unneeded.
2138 1 1 already read UV.
2139 so there's no point in sv_2iuv_non_preserve() attempting
2140 to use atol, strtol, strtoul etc. */
2141 sv_2iuv_non_preserve (sv, numtype);
2144 #endif /* NV_PRESERVES_UV */
2148 if (isGV_with_GP(sv))
2149 return glob_2number((GV *)sv);
2151 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2152 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2155 if (SvTYPE(sv) < SVt_IV)
2156 /* Typically the caller expects that sv_any is not NULL now. */
2157 sv_upgrade(sv, SVt_IV);
2158 /* Return 0 from the caller. */
2165 =for apidoc sv_2iv_flags
2167 Return the integer value of an SV, doing any necessary string
2168 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2169 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2175 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2180 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2181 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2182 cache IVs just in case. In practice it seems that they never
2183 actually anywhere accessible by user Perl code, let alone get used
2184 in anything other than a string context. */
2185 if (flags & SV_GMAGIC)
2190 return I_V(SvNVX(sv));
2192 if (SvPOKp(sv) && SvLEN(sv)) {
2195 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2197 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2198 == IS_NUMBER_IN_UV) {
2199 /* It's definitely an integer */
2200 if (numtype & IS_NUMBER_NEG) {
2201 if (value < (UV)IV_MIN)
2204 if (value < (UV)IV_MAX)
2209 if (ckWARN(WARN_NUMERIC))
2212 return I_V(Atof(SvPVX_const(sv)));
2217 assert(SvTYPE(sv) >= SVt_PVMG);
2218 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2219 } else if (SvTHINKFIRST(sv)) {
2223 SV * const tmpstr=AMG_CALLun(sv,numer);
2224 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2225 return SvIV(tmpstr);
2228 return PTR2IV(SvRV(sv));
2231 sv_force_normal_flags(sv, 0);
2233 if (SvREADONLY(sv) && !SvOK(sv)) {
2234 if (ckWARN(WARN_UNINITIALIZED))
2240 if (S_sv_2iuv_common(aTHX_ sv))
2243 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2244 PTR2UV(sv),SvIVX(sv)));
2245 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2249 =for apidoc sv_2uv_flags
2251 Return the unsigned integer value of an SV, doing any necessary string
2252 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2253 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2259 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2264 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2265 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2266 cache IVs just in case. */
2267 if (flags & SV_GMAGIC)
2272 return U_V(SvNVX(sv));
2273 if (SvPOKp(sv) && SvLEN(sv)) {
2276 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2278 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2279 == IS_NUMBER_IN_UV) {
2280 /* It's definitely an integer */
2281 if (!(numtype & IS_NUMBER_NEG))
2285 if (ckWARN(WARN_NUMERIC))
2288 return U_V(Atof(SvPVX_const(sv)));
2293 assert(SvTYPE(sv) >= SVt_PVMG);
2294 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2295 } else if (SvTHINKFIRST(sv)) {
2299 SV *const tmpstr = AMG_CALLun(sv,numer);
2300 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2301 return SvUV(tmpstr);
2304 return PTR2UV(SvRV(sv));
2307 sv_force_normal_flags(sv, 0);
2309 if (SvREADONLY(sv) && !SvOK(sv)) {
2310 if (ckWARN(WARN_UNINITIALIZED))
2316 if (S_sv_2iuv_common(aTHX_ sv))
2320 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2321 PTR2UV(sv),SvUVX(sv)));
2322 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2328 Return the num value of an SV, doing any necessary string or integer
2329 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2336 Perl_sv_2nv(pTHX_ register SV *sv)
2341 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2342 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2343 cache IVs just in case. */
2347 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2348 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2349 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2351 return Atof(SvPVX_const(sv));
2355 return (NV)SvUVX(sv);
2357 return (NV)SvIVX(sv);
2362 assert(SvTYPE(sv) >= SVt_PVMG);
2363 /* This falls through to the report_uninit near the end of the
2365 } else if (SvTHINKFIRST(sv)) {
2369 SV *const tmpstr = AMG_CALLun(sv,numer);
2370 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2371 return SvNV(tmpstr);
2374 return PTR2NV(SvRV(sv));
2377 sv_force_normal_flags(sv, 0);
2379 if (SvREADONLY(sv) && !SvOK(sv)) {
2380 if (ckWARN(WARN_UNINITIALIZED))
2385 if (SvTYPE(sv) < SVt_NV) {
2386 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2387 sv_upgrade(sv, SVt_NV);
2388 #ifdef USE_LONG_DOUBLE
2390 STORE_NUMERIC_LOCAL_SET_STANDARD();
2391 PerlIO_printf(Perl_debug_log,
2392 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2393 PTR2UV(sv), SvNVX(sv));
2394 RESTORE_NUMERIC_LOCAL();
2398 STORE_NUMERIC_LOCAL_SET_STANDARD();
2399 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2400 PTR2UV(sv), SvNVX(sv));
2401 RESTORE_NUMERIC_LOCAL();
2405 else if (SvTYPE(sv) < SVt_PVNV)
2406 sv_upgrade(sv, SVt_PVNV);
2411 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2412 #ifdef NV_PRESERVES_UV
2415 /* Only set the public NV OK flag if this NV preserves the IV */
2416 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2417 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2418 : (SvIVX(sv) == I_V(SvNVX(sv))))
2424 else if (SvPOKp(sv) && SvLEN(sv)) {
2426 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2427 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2429 #ifdef NV_PRESERVES_UV
2430 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2431 == IS_NUMBER_IN_UV) {
2432 /* It's definitely an integer */
2433 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2435 SvNV_set(sv, Atof(SvPVX_const(sv)));
2438 SvNV_set(sv, Atof(SvPVX_const(sv)));
2439 /* Only set the public NV OK flag if this NV preserves the value in
2440 the PV at least as well as an IV/UV would.
2441 Not sure how to do this 100% reliably. */
2442 /* if that shift count is out of range then Configure's test is
2443 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2445 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2446 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2447 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2448 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2449 /* Can't use strtol etc to convert this string, so don't try.
2450 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2453 /* value has been set. It may not be precise. */
2454 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2455 /* 2s complement assumption for (UV)IV_MIN */
2456 SvNOK_on(sv); /* Integer is too negative. */
2461 if (numtype & IS_NUMBER_NEG) {
2462 SvIV_set(sv, -(IV)value);
2463 } else if (value <= (UV)IV_MAX) {
2464 SvIV_set(sv, (IV)value);
2466 SvUV_set(sv, value);
2470 if (numtype & IS_NUMBER_NOT_INT) {
2471 /* I believe that even if the original PV had decimals,
2472 they are lost beyond the limit of the FP precision.
2473 However, neither is canonical, so both only get p
2474 flags. NWC, 2000/11/25 */
2475 /* Both already have p flags, so do nothing */
2477 const NV nv = SvNVX(sv);
2478 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2479 if (SvIVX(sv) == I_V(nv)) {
2482 /* It had no "." so it must be integer. */
2486 /* between IV_MAX and NV(UV_MAX).
2487 Could be slightly > UV_MAX */
2489 if (numtype & IS_NUMBER_NOT_INT) {
2490 /* UV and NV both imprecise. */
2492 const UV nv_as_uv = U_V(nv);
2494 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2503 #endif /* NV_PRESERVES_UV */
2506 if (isGV_with_GP(sv)) {
2507 glob_2number((GV *)sv);
2511 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2513 assert (SvTYPE(sv) >= SVt_NV);
2514 /* Typically the caller expects that sv_any is not NULL now. */
2515 /* XXX Ilya implies that this is a bug in callers that assume this
2516 and ideally should be fixed. */
2519 #if defined(USE_LONG_DOUBLE)
2521 STORE_NUMERIC_LOCAL_SET_STANDARD();
2522 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2523 PTR2UV(sv), SvNVX(sv));
2524 RESTORE_NUMERIC_LOCAL();
2528 STORE_NUMERIC_LOCAL_SET_STANDARD();
2529 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2530 PTR2UV(sv), SvNVX(sv));
2531 RESTORE_NUMERIC_LOCAL();
2540 Return an SV with the numeric value of the source SV, doing any necessary
2541 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2542 access this function.
2548 Perl_sv_2num(pTHX_ register SV *sv)
2553 SV * const tmpsv = AMG_CALLun(sv,numer);
2554 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2555 return sv_2num(tmpsv);
2557 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2560 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2561 * UV as a string towards the end of buf, and return pointers to start and
2564 * We assume that buf is at least TYPE_CHARS(UV) long.
2568 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2570 char *ptr = buf + TYPE_CHARS(UV);
2571 char * const ebuf = ptr;
2584 *--ptr = '0' + (char)(uv % 10);
2593 =for apidoc sv_2pv_flags
2595 Returns a pointer to the string value of an SV, and sets *lp to its length.
2596 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2598 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2599 usually end up here too.
2605 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2615 if (SvGMAGICAL(sv)) {
2616 if (flags & SV_GMAGIC)
2621 if (flags & SV_MUTABLE_RETURN)
2622 return SvPVX_mutable(sv);
2623 if (flags & SV_CONST_RETURN)
2624 return (char *)SvPVX_const(sv);
2627 if (SvIOKp(sv) || SvNOKp(sv)) {
2628 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2633 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2634 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2636 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2643 #ifdef FIXNEGATIVEZERO
2644 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2650 SvUPGRADE(sv, SVt_PV);
2653 s = SvGROW_mutable(sv, len + 1);
2656 return (char*)memcpy(s, tbuf, len + 1);
2662 assert(SvTYPE(sv) >= SVt_PVMG);
2663 /* This falls through to the report_uninit near the end of the
2665 } else if (SvTHINKFIRST(sv)) {
2669 SV *const tmpstr = AMG_CALLun(sv,string);
2670 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2672 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2676 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2677 if (flags & SV_CONST_RETURN) {
2678 pv = (char *) SvPVX_const(tmpstr);
2680 pv = (flags & SV_MUTABLE_RETURN)
2681 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2684 *lp = SvCUR(tmpstr);
2686 pv = sv_2pv_flags(tmpstr, lp, flags);
2699 const SV *const referent = (SV*)SvRV(sv);
2703 retval = buffer = savepvn("NULLREF", len);
2704 } else if (SvTYPE(referent) == SVt_REGEXP) {
2709 /* FIXME - get rid of this cast away of const, or work out
2710 how to do it better. */
2711 temp.mg_obj = (SV *)referent;
2712 assert(temp.mg_obj);
2713 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2718 PL_reginterp_cnt += haseval;
2721 const char *const typestr = sv_reftype(referent, 0);
2722 const STRLEN typelen = strlen(typestr);
2723 UV addr = PTR2UV(referent);
2724 const char *stashname = NULL;
2725 STRLEN stashnamelen = 0; /* hush, gcc */
2726 const char *buffer_end;
2728 if (SvOBJECT(referent)) {
2729 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2732 stashname = HEK_KEY(name);
2733 stashnamelen = HEK_LEN(name);
2735 if (HEK_UTF8(name)) {
2741 stashname = "__ANON__";
2744 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2745 + 2 * sizeof(UV) + 2 /* )\0 */;
2747 len = typelen + 3 /* (0x */
2748 + 2 * sizeof(UV) + 2 /* )\0 */;
2751 Newx(buffer, len, char);
2752 buffer_end = retval = buffer + len;
2754 /* Working backwards */
2758 *--retval = PL_hexdigit[addr & 15];
2759 } while (addr >>= 4);
2765 memcpy(retval, typestr, typelen);
2769 retval -= stashnamelen;
2770 memcpy(retval, stashname, stashnamelen);
2772 /* retval may not neccesarily have reached the start of the
2774 assert (retval >= buffer);
2776 len = buffer_end - retval - 1; /* -1 for that \0 */
2784 if (SvREADONLY(sv) && !SvOK(sv)) {
2785 if (ckWARN(WARN_UNINITIALIZED))
2792 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2793 /* I'm assuming that if both IV and NV are equally valid then
2794 converting the IV is going to be more efficient */
2795 const U32 isUIOK = SvIsUV(sv);
2796 char buf[TYPE_CHARS(UV)];
2800 if (SvTYPE(sv) < SVt_PVIV)
2801 sv_upgrade(sv, SVt_PVIV);
2802 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2804 /* inlined from sv_setpvn */
2805 s = SvGROW_mutable(sv, len + 1);
2806 Move(ptr, s, len, char);
2810 else if (SvNOKp(sv)) {
2811 const int olderrno = errno;
2812 if (SvTYPE(sv) < SVt_PVNV)
2813 sv_upgrade(sv, SVt_PVNV);
2814 /* The +20 is pure guesswork. Configure test needed. --jhi */
2815 s = SvGROW_mutable(sv, NV_DIG + 20);
2816 /* some Xenix systems wipe out errno here */
2818 if (SvNVX(sv) == 0.0)
2819 my_strlcpy(s, "0", SvLEN(sv));
2823 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2826 #ifdef FIXNEGATIVEZERO
2827 if (*s == '-' && s[1] == '0' && !s[2]) {
2839 if (isGV_with_GP(sv))
2840 return glob_2pv((GV *)sv, lp);
2842 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2846 if (SvTYPE(sv) < SVt_PV)
2847 /* Typically the caller expects that sv_any is not NULL now. */
2848 sv_upgrade(sv, SVt_PV);
2852 const STRLEN len = s - SvPVX_const(sv);
2858 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2859 PTR2UV(sv),SvPVX_const(sv)));
2860 if (flags & SV_CONST_RETURN)
2861 return (char *)SvPVX_const(sv);
2862 if (flags & SV_MUTABLE_RETURN)
2863 return SvPVX_mutable(sv);
2868 =for apidoc sv_copypv
2870 Copies a stringified representation of the source SV into the
2871 destination SV. Automatically performs any necessary mg_get and
2872 coercion of numeric values into strings. Guaranteed to preserve
2873 UTF8 flag even from overloaded objects. Similar in nature to
2874 sv_2pv[_flags] but operates directly on an SV instead of just the
2875 string. Mostly uses sv_2pv_flags to do its work, except when that
2876 would lose the UTF-8'ness of the PV.
2882 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2885 const char * const s = SvPV_const(ssv,len);
2886 sv_setpvn(dsv,s,len);
2894 =for apidoc sv_2pvbyte
2896 Return a pointer to the byte-encoded representation of the SV, and set *lp
2897 to its length. May cause the SV to be downgraded from UTF-8 as a
2900 Usually accessed via the C<SvPVbyte> macro.
2906 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2908 sv_utf8_downgrade(sv,0);
2909 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2913 =for apidoc sv_2pvutf8
2915 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2916 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2918 Usually accessed via the C<SvPVutf8> macro.
2924 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2926 sv_utf8_upgrade(sv);
2927 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2932 =for apidoc sv_2bool
2934 This function is only called on magical items, and is only used by
2935 sv_true() or its macro equivalent.
2941 Perl_sv_2bool(pTHX_ register SV *sv)
2950 SV * const tmpsv = AMG_CALLun(sv,bool_);
2951 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2952 return (bool)SvTRUE(tmpsv);
2954 return SvRV(sv) != 0;
2957 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2959 (*sv->sv_u.svu_pv > '0' ||
2960 Xpvtmp->xpv_cur > 1 ||
2961 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2968 return SvIVX(sv) != 0;
2971 return SvNVX(sv) != 0.0;
2973 if (isGV_with_GP(sv))
2983 =for apidoc sv_utf8_upgrade
2985 Converts the PV of an SV to its UTF-8-encoded form.
2986 Forces the SV to string form if it is not already.
2987 Always sets the SvUTF8 flag to avoid future validity checks even
2988 if all the bytes have hibit clear.
2990 This is not as a general purpose byte encoding to Unicode interface:
2991 use the Encode extension for that.
2993 =for apidoc sv_utf8_upgrade_flags
2995 Converts the PV of an SV to its UTF-8-encoded form.
2996 Forces the SV to string form if it is not already.
2997 Always sets the SvUTF8 flag to avoid future validity checks even
2998 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
2999 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3000 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3002 This is not as a general purpose byte encoding to Unicode interface:
3003 use the Encode extension for that.
3009 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3012 if (sv == &PL_sv_undef)
3016 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3017 (void) sv_2pv_flags(sv,&len, flags);
3021 (void) SvPV_force(sv,len);
3030 sv_force_normal_flags(sv, 0);
3033 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3034 sv_recode_to_utf8(sv, PL_encoding);
3035 else { /* Assume Latin-1/EBCDIC */
3036 /* This function could be much more efficient if we
3037 * had a FLAG in SVs to signal if there are any hibit
3038 * chars in the PV. Given that there isn't such a flag
3039 * make the loop as fast as possible. */
3040 const U8 * const s = (U8 *) SvPVX_const(sv);
3041 const U8 * const e = (U8 *) SvEND(sv);
3046 /* Check for hi bit */
3047 if (!NATIVE_IS_INVARIANT(ch)) {
3048 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3049 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3051 SvPV_free(sv); /* No longer using what was there before. */
3052 SvPV_set(sv, (char*)recoded);
3053 SvCUR_set(sv, len - 1);
3054 SvLEN_set(sv, len); /* No longer know the real size. */
3058 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3065 =for apidoc sv_utf8_downgrade
3067 Attempts to convert the PV of an SV from characters to bytes.
3068 If the PV contains a character beyond byte, this conversion will fail;
3069 in this case, either returns false or, if C<fail_ok> is not
3072 This is not as a general purpose Unicode to byte encoding interface:
3073 use the Encode extension for that.
3079 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3082 if (SvPOKp(sv) && SvUTF8(sv)) {
3088 sv_force_normal_flags(sv, 0);
3090 s = (U8 *) SvPV(sv, len);
3091 if (!utf8_to_bytes(s, &len)) {
3096 Perl_croak(aTHX_ "Wide character in %s",
3099 Perl_croak(aTHX_ "Wide character");
3110 =for apidoc sv_utf8_encode
3112 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3113 flag off so that it looks like octets again.
3119 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3122 sv_force_normal_flags(sv, 0);
3124 if (SvREADONLY(sv)) {
3125 Perl_croak(aTHX_ PL_no_modify);
3127 (void) sv_utf8_upgrade(sv);
3132 =for apidoc sv_utf8_decode
3134 If the PV of the SV is an octet sequence in UTF-8
3135 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3136 so that it looks like a character. If the PV contains only single-byte
3137 characters, the C<SvUTF8> flag stays being off.
3138 Scans PV for validity and returns false if the PV is invalid UTF-8.
3144 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3150 /* The octets may have got themselves encoded - get them back as
3153 if (!sv_utf8_downgrade(sv, TRUE))
3156 /* it is actually just a matter of turning the utf8 flag on, but
3157 * we want to make sure everything inside is valid utf8 first.
3159 c = (const U8 *) SvPVX_const(sv);
3160 if (!is_utf8_string(c, SvCUR(sv)+1))
3162 e = (const U8 *) SvEND(sv);
3165 if (!UTF8_IS_INVARIANT(ch)) {
3175 =for apidoc sv_setsv
3177 Copies the contents of the source SV C<ssv> into the destination SV
3178 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3179 function if the source SV needs to be reused. Does not handle 'set' magic.
3180 Loosely speaking, it performs a copy-by-value, obliterating any previous
3181 content of the destination.
3183 You probably want to use one of the assortment of wrappers, such as
3184 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3185 C<SvSetMagicSV_nosteal>.
3187 =for apidoc sv_setsv_flags
3189 Copies the contents of the source SV C<ssv> into the destination SV
3190 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3191 function if the source SV needs to be reused. Does not handle 'set' magic.
3192 Loosely speaking, it performs a copy-by-value, obliterating any previous
3193 content of the destination.
3194 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3195 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3196 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3197 and C<sv_setsv_nomg> are implemented in terms of this function.
3199 You probably want to use one of the assortment of wrappers, such as
3200 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3201 C<SvSetMagicSV_nosteal>.
3203 This is the primary function for copying scalars, and most other
3204 copy-ish functions and macros use this underneath.
3210 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3212 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3214 if (dtype != SVt_PVGV) {
3215 const char * const name = GvNAME(sstr);
3216 const STRLEN len = GvNAMELEN(sstr);
3218 if (dtype >= SVt_PV) {
3224 SvUPGRADE(dstr, SVt_PVGV);
3225 (void)SvOK_off(dstr);
3226 /* FIXME - why are we doing this, then turning it off and on again
3228 isGV_with_GP_on(dstr);
3230 GvSTASH(dstr) = GvSTASH(sstr);
3232 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3233 gv_name_set((GV *)dstr, name, len, GV_ADD);
3234 SvFAKE_on(dstr); /* can coerce to non-glob */
3237 #ifdef GV_UNIQUE_CHECK
3238 if (GvUNIQUE((GV*)dstr)) {
3239 Perl_croak(aTHX_ PL_no_modify);
3243 if(GvGP((GV*)sstr)) {
3244 /* If source has method cache entry, clear it */
3246 SvREFCNT_dec(GvCV(sstr));
3250 /* If source has a real method, then a method is
3252 else if(GvCV((GV*)sstr)) {
3257 /* If dest already had a real method, that's a change as well */
3258 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3262 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3266 isGV_with_GP_off(dstr);
3267 (void)SvOK_off(dstr);
3268 isGV_with_GP_on(dstr);
3269 GvINTRO_off(dstr); /* one-shot flag */
3270 GvGP(dstr) = gp_ref(GvGP(sstr));
3271 if (SvTAINTED(sstr))
3273 if (GvIMPORTED(dstr) != GVf_IMPORTED
3274 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3276 GvIMPORTED_on(dstr);
3279 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3280 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3285 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3286 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3288 const int intro = GvINTRO(dstr);
3291 const U32 stype = SvTYPE(sref);
3294 #ifdef GV_UNIQUE_CHECK
3295 if (GvUNIQUE((GV*)dstr)) {
3296 Perl_croak(aTHX_ PL_no_modify);
3301 GvINTRO_off(dstr); /* one-shot flag */
3302 GvLINE(dstr) = CopLINE(PL_curcop);
3303 GvEGV(dstr) = (GV*)dstr;
3308 location = (SV **) &GvCV(dstr);
3309 import_flag = GVf_IMPORTED_CV;
3312 location = (SV **) &GvHV(dstr);
3313 import_flag = GVf_IMPORTED_HV;
3316 location = (SV **) &GvAV(dstr);
3317 import_flag = GVf_IMPORTED_AV;
3320 location = (SV **) &GvIOp(dstr);
3323 location = (SV **) &GvFORM(dstr);
3325 location = &GvSV(dstr);
3326 import_flag = GVf_IMPORTED_SV;
3329 if (stype == SVt_PVCV) {
3330 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3331 if (GvCVGEN(dstr)) {
3332 SvREFCNT_dec(GvCV(dstr));
3334 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3337 SAVEGENERICSV(*location);
3341 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3342 CV* const cv = (CV*)*location;
3344 if (!GvCVGEN((GV*)dstr) &&
3345 (CvROOT(cv) || CvXSUB(cv)))
3347 /* Redefining a sub - warning is mandatory if
3348 it was a const and its value changed. */
3349 if (CvCONST(cv) && CvCONST((CV*)sref)
3350 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3352 /* They are 2 constant subroutines generated from
3353 the same constant. This probably means that
3354 they are really the "same" proxy subroutine
3355 instantiated in 2 places. Most likely this is
3356 when a constant is exported twice. Don't warn.
3359 else if (ckWARN(WARN_REDEFINE)
3361 && (!CvCONST((CV*)sref)
3362 || sv_cmp(cv_const_sv(cv),
3363 cv_const_sv((CV*)sref))))) {
3364 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3367 ? "Constant subroutine %s::%s redefined"
3368 : "Subroutine %s::%s redefined"),
3369 HvNAME_get(GvSTASH((GV*)dstr)),
3370 GvENAME((GV*)dstr));
3374 cv_ckproto_len(cv, (GV*)dstr,
3375 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3376 SvPOK(sref) ? SvCUR(sref) : 0);
3378 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3379 GvASSUMECV_on(dstr);
3380 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3383 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3384 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3385 GvFLAGS(dstr) |= import_flag;
3390 if (SvTAINTED(sstr))
3396 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3399 register U32 sflags;
3401 register svtype stype;
3406 if (SvIS_FREED(dstr)) {
3407 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3408 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3410 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3412 sstr = &PL_sv_undef;
3413 if (SvIS_FREED(sstr)) {
3414 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3415 (void*)sstr, (void*)dstr);
3417 stype = SvTYPE(sstr);
3418 dtype = SvTYPE(dstr);
3420 (void)SvAMAGIC_off(dstr);
3423 /* need to nuke the magic */
3425 SvRMAGICAL_off(dstr);
3428 /* There's a lot of redundancy below but we're going for speed here */
3433 if (dtype != SVt_PVGV) {
3434 (void)SvOK_off(dstr);
3442 sv_upgrade(dstr, SVt_IV);
3446 sv_upgrade(dstr, SVt_PVIV);
3449 goto end_of_first_switch;
3451 (void)SvIOK_only(dstr);
3452 SvIV_set(dstr, SvIVX(sstr));
3455 /* SvTAINTED can only be true if the SV has taint magic, which in
3456 turn means that the SV type is PVMG (or greater). This is the
3457 case statement for SVt_IV, so this cannot be true (whatever gcov
3459 assert(!SvTAINTED(sstr));
3464 if (dtype < SVt_PV && dtype != SVt_IV)
3465 sv_upgrade(dstr, SVt_IV);
3473 sv_upgrade(dstr, SVt_NV);
3477 sv_upgrade(dstr, SVt_PVNV);
3480 goto end_of_first_switch;
3482 SvNV_set(dstr, SvNVX(sstr));
3483 (void)SvNOK_only(dstr);
3484 /* SvTAINTED can only be true if the SV has taint magic, which in
3485 turn means that the SV type is PVMG (or greater). This is the
3486 case statement for SVt_NV, so this cannot be true (whatever gcov
3488 assert(!SvTAINTED(sstr));
3494 #ifdef PERL_OLD_COPY_ON_WRITE
3495 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3496 if (dtype < SVt_PVIV)
3497 sv_upgrade(dstr, SVt_PVIV);
3505 sv_upgrade(dstr, SVt_PV);
3508 if (dtype < SVt_PVIV)
3509 sv_upgrade(dstr, SVt_PVIV);
3512 if (dtype < SVt_PVNV)
3513 sv_upgrade(dstr, SVt_PVNV);
3517 const char * const type = sv_reftype(sstr,0);
3519 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3521 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3525 /* case SVt_BIND: */
3528 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3529 glob_assign_glob(dstr, sstr, dtype);
3532 /* SvVALID means that this PVGV is playing at being an FBM. */
3536 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3538 if (SvTYPE(sstr) != stype) {
3539 stype = SvTYPE(sstr);
3540 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3541 glob_assign_glob(dstr, sstr, dtype);
3546 if (stype == SVt_PVLV)
3547 SvUPGRADE(dstr, SVt_PVNV);
3549 SvUPGRADE(dstr, (svtype)stype);
3551 end_of_first_switch:
3553 /* dstr may have been upgraded. */
3554 dtype = SvTYPE(dstr);
3555 sflags = SvFLAGS(sstr);
3557 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3558 /* Assigning to a subroutine sets the prototype. */
3561 const char *const ptr = SvPV_const(sstr, len);
3563 SvGROW(dstr, len + 1);
3564 Copy(ptr, SvPVX(dstr), len + 1, char);
3565 SvCUR_set(dstr, len);
3567 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3571 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3572 const char * const type = sv_reftype(dstr,0);
3574 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3576 Perl_croak(aTHX_ "Cannot copy to %s", type);
3577 } else if (sflags & SVf_ROK) {
3578 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3579 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3582 if (GvIMPORTED(dstr) != GVf_IMPORTED
3583 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3585 GvIMPORTED_on(dstr);
3590 glob_assign_glob(dstr, sstr, dtype);
3594 if (dtype >= SVt_PV) {
3595 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3596 glob_assign_ref(dstr, sstr);
3599 if (SvPVX_const(dstr)) {
3605 (void)SvOK_off(dstr);
3606 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3607 SvFLAGS(dstr) |= sflags & SVf_ROK;
3608 assert(!(sflags & SVp_NOK));
3609 assert(!(sflags & SVp_IOK));
3610 assert(!(sflags & SVf_NOK));
3611 assert(!(sflags & SVf_IOK));
3613 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3614 if (!(sflags & SVf_OK)) {
3615 if (ckWARN(WARN_MISC))
3616 Perl_warner(aTHX_ packWARN(WARN_MISC),
3617 "Undefined value assigned to typeglob");
3620 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3621 if (dstr != (SV*)gv) {
3624 GvGP(dstr) = gp_ref(GvGP(gv));
3628 else if (sflags & SVp_POK) {
3632 * Check to see if we can just swipe the string. If so, it's a
3633 * possible small lose on short strings, but a big win on long ones.
3634 * It might even be a win on short strings if SvPVX_const(dstr)
3635 * has to be allocated and SvPVX_const(sstr) has to be freed.
3636 * Likewise if we can set up COW rather than doing an actual copy, we
3637 * drop to the else clause, as the swipe code and the COW setup code
3638 * have much in common.
3641 /* Whichever path we take through the next code, we want this true,
3642 and doing it now facilitates the COW check. */
3643 (void)SvPOK_only(dstr);
3646 /* If we're already COW then this clause is not true, and if COW
3647 is allowed then we drop down to the else and make dest COW
3648 with us. If caller hasn't said that we're allowed to COW
3649 shared hash keys then we don't do the COW setup, even if the
3650 source scalar is a shared hash key scalar. */
3651 (((flags & SV_COW_SHARED_HASH_KEYS)
3652 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3653 : 1 /* If making a COW copy is forbidden then the behaviour we
3654 desire is as if the source SV isn't actually already
3655 COW, even if it is. So we act as if the source flags
3656 are not COW, rather than actually testing them. */
3658 #ifndef PERL_OLD_COPY_ON_WRITE
3659 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3660 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3661 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3662 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3663 but in turn, it's somewhat dead code, never expected to go
3664 live, but more kept as a placeholder on how to do it better
3665 in a newer implementation. */
3666 /* If we are COW and dstr is a suitable target then we drop down
3667 into the else and make dest a COW of us. */
3668 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3673 (sflags & SVs_TEMP) && /* slated for free anyway? */
3674 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3675 (!(flags & SV_NOSTEAL)) &&
3676 /* and we're allowed to steal temps */
3677 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3678 SvLEN(sstr) && /* and really is a string */
3679 /* and won't be needed again, potentially */
3680 !(PL_op && PL_op->op_type == OP_AASSIGN))
3681 #ifdef PERL_OLD_COPY_ON_WRITE
3682 && ((flags & SV_COW_SHARED_HASH_KEYS)
3683 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3684 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3685 && SvTYPE(sstr) >= SVt_PVIV))
3689 /* Failed the swipe test, and it's not a shared hash key either.
3690 Have to copy the string. */
3691 STRLEN len = SvCUR(sstr);
3692 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3693 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3694 SvCUR_set(dstr, len);
3695 *SvEND(dstr) = '\0';
3697 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3699 /* Either it's a shared hash key, or it's suitable for
3700 copy-on-write or we can swipe the string. */
3702 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3706 #ifdef PERL_OLD_COPY_ON_WRITE
3708 /* I believe I should acquire a global SV mutex if
3709 it's a COW sv (not a shared hash key) to stop
3710 it going un copy-on-write.
3711 If the source SV has gone un copy on write between up there
3712 and down here, then (assert() that) it is of the correct
3713 form to make it copy on write again */
3714 if ((sflags & (SVf_FAKE | SVf_READONLY))
3715 != (SVf_FAKE | SVf_READONLY)) {
3716 SvREADONLY_on(sstr);
3718 /* Make the source SV into a loop of 1.
3719 (about to become 2) */
3720 SV_COW_NEXT_SV_SET(sstr, sstr);
3724 /* Initial code is common. */
3725 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3730 /* making another shared SV. */
3731 STRLEN cur = SvCUR(sstr);
3732 STRLEN len = SvLEN(sstr);
3733 #ifdef PERL_OLD_COPY_ON_WRITE
3735 assert (SvTYPE(dstr) >= SVt_PVIV);
3736 /* SvIsCOW_normal */
3737 /* splice us in between source and next-after-source. */
3738 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3739 SV_COW_NEXT_SV_SET(sstr, dstr);
3740 SvPV_set(dstr, SvPVX_mutable(sstr));
3744 /* SvIsCOW_shared_hash */
3745 DEBUG_C(PerlIO_printf(Perl_debug_log,
3746 "Copy on write: Sharing hash\n"));
3748 assert (SvTYPE(dstr) >= SVt_PV);
3750 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3752 SvLEN_set(dstr, len);
3753 SvCUR_set(dstr, cur);
3754 SvREADONLY_on(dstr);
3756 /* Relesase a global SV mutex. */
3759 { /* Passes the swipe test. */
3760 SvPV_set(dstr, SvPVX_mutable(sstr));
3761 SvLEN_set(dstr, SvLEN(sstr));
3762 SvCUR_set(dstr, SvCUR(sstr));
3765 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3766 SvPV_set(sstr, NULL);
3772 if (sflags & SVp_NOK) {
3773 SvNV_set(dstr, SvNVX(sstr));
3775 if (sflags & SVp_IOK) {
3776 SvIV_set(dstr, SvIVX(sstr));
3777 /* Must do this otherwise some other overloaded use of 0x80000000
3778 gets confused. I guess SVpbm_VALID */
3779 if (sflags & SVf_IVisUV)
3782 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3784 const MAGIC * const smg = SvVSTRING_mg(sstr);
3786 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3787 smg->mg_ptr, smg->mg_len);
3788 SvRMAGICAL_on(dstr);
3792 else if (sflags & (SVp_IOK|SVp_NOK)) {
3793 (void)SvOK_off(dstr);
3794 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3795 if (sflags & SVp_IOK) {
3796 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3797 SvIV_set(dstr, SvIVX(sstr));
3799 if (sflags & SVp_NOK) {
3800 SvNV_set(dstr, SvNVX(sstr));
3804 if (isGV_with_GP(sstr)) {
3805 /* This stringification rule for globs is spread in 3 places.
3806 This feels bad. FIXME. */
3807 const U32 wasfake = sflags & SVf_FAKE;
3809 /* FAKE globs can get coerced, so need to turn this off
3810 temporarily if it is on. */
3812 gv_efullname3(dstr, (GV *)sstr, "*");
3813 SvFLAGS(sstr) |= wasfake;
3816 (void)SvOK_off(dstr);
3818 if (SvTAINTED(sstr))
3823 =for apidoc sv_setsv_mg
3825 Like C<sv_setsv>, but also handles 'set' magic.
3831 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3833 sv_setsv(dstr,sstr);
3837 #ifdef PERL_OLD_COPY_ON_WRITE
3839 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3841 STRLEN cur = SvCUR(sstr);
3842 STRLEN len = SvLEN(sstr);
3843 register char *new_pv;
3846 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3847 (void*)sstr, (void*)dstr);
3854 if (SvTHINKFIRST(dstr))
3855 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3856 else if (SvPVX_const(dstr))
3857 Safefree(SvPVX_const(dstr));
3861 SvUPGRADE(dstr, SVt_PVIV);
3863 assert (SvPOK(sstr));
3864 assert (SvPOKp(sstr));
3865 assert (!SvIOK(sstr));
3866 assert (!SvIOKp(sstr));
3867 assert (!SvNOK(sstr));
3868 assert (!SvNOKp(sstr));
3870 if (SvIsCOW(sstr)) {
3872 if (SvLEN(sstr) == 0) {
3873 /* source is a COW shared hash key. */
3874 DEBUG_C(PerlIO_printf(Perl_debug_log,
3875 "Fast copy on write: Sharing hash\n"));
3876 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3879 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3881 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3882 SvUPGRADE(sstr, SVt_PVIV);
3883 SvREADONLY_on(sstr);
3885 DEBUG_C(PerlIO_printf(Perl_debug_log,
3886 "Fast copy on write: Converting sstr to COW\n"));
3887 SV_COW_NEXT_SV_SET(dstr, sstr);
3889 SV_COW_NEXT_SV_SET(sstr, dstr);
3890 new_pv = SvPVX_mutable(sstr);
3893 SvPV_set(dstr, new_pv);
3894 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3897 SvLEN_set(dstr, len);
3898 SvCUR_set(dstr, cur);
3907 =for apidoc sv_setpvn
3909 Copies a string into an SV. The C<len> parameter indicates the number of
3910 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3911 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3917 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3920 register char *dptr;
3922 SV_CHECK_THINKFIRST_COW_DROP(sv);
3928 /* len is STRLEN which is unsigned, need to copy to signed */
3931 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3933 SvUPGRADE(sv, SVt_PV);
3935 dptr = SvGROW(sv, len + 1);
3936 Move(ptr,dptr,len,char);
3939 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3944 =for apidoc sv_setpvn_mg
3946 Like C<sv_setpvn>, but also handles 'set' magic.
3952 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3954 sv_setpvn(sv,ptr,len);
3959 =for apidoc sv_setpv
3961 Copies a string into an SV. The string must be null-terminated. Does not
3962 handle 'set' magic. See C<sv_setpv_mg>.
3968 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3971 register STRLEN len;
3973 SV_CHECK_THINKFIRST_COW_DROP(sv);
3979 SvUPGRADE(sv, SVt_PV);
3981 SvGROW(sv, len + 1);
3982 Move(ptr,SvPVX(sv),len+1,char);
3984 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3989 =for apidoc sv_setpv_mg
3991 Like C<sv_setpv>, but also handles 'set' magic.
3997 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4004 =for apidoc sv_usepvn_flags
4006 Tells an SV to use C<ptr> to find its string value. Normally the
4007 string is stored inside the SV but sv_usepvn allows the SV to use an
4008 outside string. The C<ptr> should point to memory that was allocated
4009 by C<malloc>. The string length, C<len>, must be supplied. By default
4010 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4011 so that pointer should not be freed or used by the programmer after
4012 giving it to sv_usepvn, and neither should any pointers from "behind"
4013 that pointer (e.g. ptr + 1) be used.
4015 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4016 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4017 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4018 C<len>, and already meets the requirements for storing in C<SvPVX>)
4024 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4028 SV_CHECK_THINKFIRST_COW_DROP(sv);
4029 SvUPGRADE(sv, SVt_PV);
4032 if (flags & SV_SMAGIC)
4036 if (SvPVX_const(sv))
4040 if (flags & SV_HAS_TRAILING_NUL)
4041 assert(ptr[len] == '\0');
4044 allocate = (flags & SV_HAS_TRAILING_NUL)
4045 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4046 if (flags & SV_HAS_TRAILING_NUL) {
4047 /* It's long enough - do nothing.
4048 Specfically Perl_newCONSTSUB is relying on this. */
4051 /* Force a move to shake out bugs in callers. */
4052 char *new_ptr = (char*)safemalloc(allocate);
4053 Copy(ptr, new_ptr, len, char);
4054 PoisonFree(ptr,len,char);
4058 ptr = (char*) saferealloc (ptr, allocate);
4063 SvLEN_set(sv, allocate);
4064 if (!(flags & SV_HAS_TRAILING_NUL)) {
4067 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4069 if (flags & SV_SMAGIC)
4073 #ifdef PERL_OLD_COPY_ON_WRITE
4074 /* Need to do this *after* making the SV normal, as we need the buffer
4075 pointer to remain valid until after we've copied it. If we let go too early,
4076 another thread could invalidate it by unsharing last of the same hash key
4077 (which it can do by means other than releasing copy-on-write Svs)
4078 or by changing the other copy-on-write SVs in the loop. */
4080 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4082 { /* this SV was SvIsCOW_normal(sv) */
4083 /* we need to find the SV pointing to us. */
4084 SV *current = SV_COW_NEXT_SV(after);
4086 if (current == sv) {
4087 /* The SV we point to points back to us (there were only two of us
4089 Hence other SV is no longer copy on write either. */
4091 SvREADONLY_off(after);
4093 /* We need to follow the pointers around the loop. */
4095 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4098 /* don't loop forever if the structure is bust, and we have
4099 a pointer into a closed loop. */
4100 assert (current != after);
4101 assert (SvPVX_const(current) == pvx);
4103 /* Make the SV before us point to the SV after us. */
4104 SV_COW_NEXT_SV_SET(current, after);
4110 =for apidoc sv_force_normal_flags
4112 Undo various types of fakery on an SV: if the PV is a shared string, make
4113 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4114 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4115 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4116 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4117 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4118 set to some other value.) In addition, the C<flags> parameter gets passed to
4119 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4120 with flags set to 0.
4126 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4129 #ifdef PERL_OLD_COPY_ON_WRITE
4130 if (SvREADONLY(sv)) {
4131 /* At this point I believe I should acquire a global SV mutex. */
4133 const char * const pvx = SvPVX_const(sv);
4134 const STRLEN len = SvLEN(sv);
4135 const STRLEN cur = SvCUR(sv);
4136 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4137 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4138 we'll fail an assertion. */
4139 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4142 PerlIO_printf(Perl_debug_log,
4143 "Copy on write: Force normal %ld\n",
4149 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4152 if (flags & SV_COW_DROP_PV) {
4153 /* OK, so we don't need to copy our buffer. */
4156 SvGROW(sv, cur + 1);
4157 Move(pvx,SvPVX(sv),cur,char);
4162 sv_release_COW(sv, pvx, next);
4164 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4170 else if (IN_PERL_RUNTIME)
4171 Perl_croak(aTHX_ PL_no_modify);
4172 /* At this point I believe that I can drop the global SV mutex. */
4175 if (SvREADONLY(sv)) {
4177 const char * const pvx = SvPVX_const(sv);
4178 const STRLEN len = SvCUR(sv);
4183 SvGROW(sv, len + 1);
4184 Move(pvx,SvPVX(sv),len,char);
4186 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4188 else if (IN_PERL_RUNTIME)
4189 Perl_croak(aTHX_ PL_no_modify);
4193 sv_unref_flags(sv, flags);
4194 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4201 Efficient removal of characters from the beginning of the string buffer.
4202 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4203 the string buffer. The C<ptr> becomes the first character of the adjusted
4204 string. Uses the "OOK hack".
4205 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4206 refer to the same chunk of data.
4212 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4218 const U8 *real_start;
4221 if (!ptr || !SvPOKp(sv))
4223 delta = ptr - SvPVX_const(sv);
4225 /* Nothing to do. */
4228 assert(ptr > SvPVX_const(sv));
4229 SV_CHECK_THINKFIRST(sv);
4232 if (!SvLEN(sv)) { /* make copy of shared string */
4233 const char *pvx = SvPVX_const(sv);
4234 const STRLEN len = SvCUR(sv);
4235 SvGROW(sv, len + 1);
4236 Move(pvx,SvPVX(sv),len,char);
4239 SvFLAGS(sv) |= SVf_OOK;
4242 SvOOK_offset(sv, old_delta);
4244 SvLEN_set(sv, SvLEN(sv) - delta);
4245 SvCUR_set(sv, SvCUR(sv) - delta);
4246 SvPV_set(sv, SvPVX(sv) + delta);
4248 p = (U8 *)SvPVX_const(sv);
4253 real_start = p - delta;
4257 if (delta < 0x100) {
4261 p -= sizeof(STRLEN);
4262 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4266 /* Fill the preceding buffer with sentinals to verify that no-one is
4268 while (p > real_start) {
4276 =for apidoc sv_catpvn
4278 Concatenates the string onto the end of the string which is in the SV. The
4279 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4280 status set, then the bytes appended should be valid UTF-8.
4281 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4283 =for apidoc sv_catpvn_flags
4285 Concatenates the string onto the end of the string which is in the SV. The
4286 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4287 status set, then the bytes appended should be valid UTF-8.
4288 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4289 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4290 in terms of this function.
4296 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4300 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4302 SvGROW(dsv, dlen + slen + 1);
4304 sstr = SvPVX_const(dsv);
4305 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4306 SvCUR_set(dsv, SvCUR(dsv) + slen);
4308 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4310 if (flags & SV_SMAGIC)
4315 =for apidoc sv_catsv
4317 Concatenates the string from SV C<ssv> onto the end of the string in
4318 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4319 not 'set' magic. See C<sv_catsv_mg>.
4321 =for apidoc sv_catsv_flags
4323 Concatenates the string from SV C<ssv> onto the end of the string in
4324 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4325 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4326 and C<sv_catsv_nomg> are implemented in terms of this function.
4331 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4336 const char *spv = SvPV_const(ssv, slen);
4338 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4339 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4340 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4341 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4342 dsv->sv_flags doesn't have that bit set.
4343 Andy Dougherty 12 Oct 2001
4345 const I32 sutf8 = DO_UTF8(ssv);
4348 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4350 dutf8 = DO_UTF8(dsv);
4352 if (dutf8 != sutf8) {
4354 /* Not modifying source SV, so taking a temporary copy. */
4355 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4357 sv_utf8_upgrade(csv);
4358 spv = SvPV_const(csv, slen);
4361 sv_utf8_upgrade_nomg(dsv);
4363 sv_catpvn_nomg(dsv, spv, slen);
4366 if (flags & SV_SMAGIC)
4371 =for apidoc sv_catpv
4373 Concatenates the string onto the end of the string which is in the SV.
4374 If the SV has the UTF-8 status set, then the bytes appended should be
4375 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4380 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4383 register STRLEN len;
4389 junk = SvPV_force(sv, tlen);
4391 SvGROW(sv, tlen + len + 1);
4393 ptr = SvPVX_const(sv);
4394 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4395 SvCUR_set(sv, SvCUR(sv) + len);
4396 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4401 =for apidoc sv_catpv_mg
4403 Like C<sv_catpv>, but also handles 'set' magic.
4409 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4418 Creates a new SV. A non-zero C<len> parameter indicates the number of
4419 bytes of preallocated string space the SV should have. An extra byte for a
4420 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4421 space is allocated.) The reference count for the new SV is set to 1.
4423 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4424 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4425 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4426 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4427 modules supporting older perls.
4433 Perl_newSV(pTHX_ STRLEN len)
4440 sv_upgrade(sv, SVt_PV);
4441 SvGROW(sv, len + 1);
4446 =for apidoc sv_magicext
4448 Adds magic to an SV, upgrading it if necessary. Applies the
4449 supplied vtable and returns a pointer to the magic added.
4451 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4452 In particular, you can add magic to SvREADONLY SVs, and add more than
4453 one instance of the same 'how'.
4455 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4456 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4457 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4458 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4460 (This is now used as a subroutine by C<sv_magic>.)
4465 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4466 const char* name, I32 namlen)
4471 SvUPGRADE(sv, SVt_PVMG);
4472 Newxz(mg, 1, MAGIC);
4473 mg->mg_moremagic = SvMAGIC(sv);
4474 SvMAGIC_set(sv, mg);
4476 /* Sometimes a magic contains a reference loop, where the sv and
4477 object refer to each other. To prevent a reference loop that
4478 would prevent such objects being freed, we look for such loops
4479 and if we find one we avoid incrementing the object refcount.
4481 Note we cannot do this to avoid self-tie loops as intervening RV must
4482 have its REFCNT incremented to keep it in existence.
4485 if (!obj || obj == sv ||
4486 how == PERL_MAGIC_arylen ||
4487 how == PERL_MAGIC_symtab ||
4488 (SvTYPE(obj) == SVt_PVGV &&
4489 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4490 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4491 GvFORM(obj) == (CV*)sv)))
4496 mg->mg_obj = SvREFCNT_inc_simple(obj);
4497 mg->mg_flags |= MGf_REFCOUNTED;
4500 /* Normal self-ties simply pass a null object, and instead of
4501 using mg_obj directly, use the SvTIED_obj macro to produce a
4502 new RV as needed. For glob "self-ties", we are tieing the PVIO
4503 with an RV obj pointing to the glob containing the PVIO. In
4504 this case, to avoid a reference loop, we need to weaken the
4508 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4509 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4515 mg->mg_len = namlen;
4518 mg->mg_ptr = savepvn(name, namlen);
4519 else if (namlen == HEf_SVKEY)
4520 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4522 mg->mg_ptr = (char *) name;
4524 mg->mg_virtual = (MGVTBL *) vtable;
4528 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4533 =for apidoc sv_magic
4535 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4536 then adds a new magic item of type C<how> to the head of the magic list.
4538 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4539 handling of the C<name> and C<namlen> arguments.
4541 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4542 to add more than one instance of the same 'how'.
4548 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4551 const MGVTBL *vtable;
4554 #ifdef PERL_OLD_COPY_ON_WRITE
4556 sv_force_normal_flags(sv, 0);
4558 if (SvREADONLY(sv)) {
4560 /* its okay to attach magic to shared strings; the subsequent
4561 * upgrade to PVMG will unshare the string */
4562 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4565 && how != PERL_MAGIC_regex_global
4566 && how != PERL_MAGIC_bm
4567 && how != PERL_MAGIC_fm
4568 && how != PERL_MAGIC_sv
4569 && how != PERL_MAGIC_backref
4572 Perl_croak(aTHX_ PL_no_modify);
4575 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4576 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4577 /* sv_magic() refuses to add a magic of the same 'how' as an
4580 if (how == PERL_MAGIC_taint) {
4582 /* Any scalar which already had taint magic on which someone
4583 (erroneously?) did SvIOK_on() or similar will now be
4584 incorrectly sporting public "OK" flags. */
4585 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4593 vtable = &PL_vtbl_sv;
4595 case PERL_MAGIC_overload:
4596 vtable = &PL_vtbl_amagic;
4598 case PERL_MAGIC_overload_elem:
4599 vtable = &PL_vtbl_amagicelem;
4601 case PERL_MAGIC_overload_table:
4602 vtable = &PL_vtbl_ovrld;
4605 vtable = &PL_vtbl_bm;
4607 case PERL_MAGIC_regdata:
4608 vtable = &PL_vtbl_regdata;
4610 case PERL_MAGIC_regdatum:
4611 vtable = &PL_vtbl_regdatum;
4613 case PERL_MAGIC_env:
4614 vtable = &PL_vtbl_env;
4617 vtable = &PL_vtbl_fm;
4619 case PERL_MAGIC_envelem:
4620 vtable = &PL_vtbl_envelem;
4622 case PERL_MAGIC_regex_global:
4623 vtable = &PL_vtbl_mglob;
4625 case PERL_MAGIC_isa:
4626 vtable = &PL_vtbl_isa;
4628 case PERL_MAGIC_isaelem:
4629 vtable = &PL_vtbl_isaelem;
4631 case PERL_MAGIC_nkeys:
4632 vtable = &PL_vtbl_nkeys;
4634 case PERL_MAGIC_dbfile:
4637 case PERL_MAGIC_dbline:
4638 vtable = &PL_vtbl_dbline;
4640 #ifdef USE_LOCALE_COLLATE
4641 case PERL_MAGIC_collxfrm:
4642 vtable = &PL_vtbl_collxfrm;
4644 #endif /* USE_LOCALE_COLLATE */
4645 case PERL_MAGIC_tied:
4646 vtable = &PL_vtbl_pack;
4648 case PERL_MAGIC_tiedelem:
4649 case PERL_MAGIC_tiedscalar:
4650 vtable = &PL_vtbl_packelem;
4653 vtable = &PL_vtbl_regexp;
4655 case PERL_MAGIC_hints:
4656 /* As this vtable is all NULL, we can reuse it. */
4657 case PERL_MAGIC_sig:
4658 vtable = &PL_vtbl_sig;
4660 case PERL_MAGIC_sigelem:
4661 vtable = &PL_vtbl_sigelem;
4663 case PERL_MAGIC_taint:
4664 vtable = &PL_vtbl_taint;
4666 case PERL_MAGIC_uvar:
4667 vtable = &PL_vtbl_uvar;
4669 case PERL_MAGIC_vec:
4670 vtable = &PL_vtbl_vec;
4672 case PERL_MAGIC_arylen_p:
4673 case PERL_MAGIC_rhash:
4674 case PERL_MAGIC_symtab:
4675 case PERL_MAGIC_vstring:
4678 case PERL_MAGIC_utf8:
4679 vtable = &PL_vtbl_utf8;
4681 case PERL_MAGIC_substr:
4682 vtable = &PL_vtbl_substr;
4684 case PERL_MAGIC_defelem:
4685 vtable = &PL_vtbl_defelem;
4687 case PERL_MAGIC_arylen:
4688 vtable = &PL_vtbl_arylen;
4690 case PERL_MAGIC_pos:
4691 vtable = &PL_vtbl_pos;
4693 case PERL_MAGIC_backref:
4694 vtable = &PL_vtbl_backref;
4696 case PERL_MAGIC_hintselem:
4697 vtable = &PL_vtbl_hintselem;
4699 case PERL_MAGIC_ext:
4700 /* Reserved for use by extensions not perl internals. */
4701 /* Useful for attaching extension internal data to perl vars. */
4702 /* Note that multiple extensions may clash if magical scalars */
4703 /* etc holding private data from one are passed to another. */
4707 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4710 /* Rest of work is done else where */
4711 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4714 case PERL_MAGIC_taint:
4717 case PERL_MAGIC_ext:
4718 case PERL_MAGIC_dbfile:
4725 =for apidoc sv_unmagic
4727 Removes all magic of type C<type> from an SV.
4733 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4737 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4739 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4740 for (mg = *mgp; mg; mg = *mgp) {
4741 if (mg->mg_type == type) {
4742 const MGVTBL* const vtbl = mg->mg_virtual;
4743 *mgp = mg->mg_moremagic;
4744 if (vtbl && vtbl->svt_free)
4745 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4746 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4748 Safefree(mg->mg_ptr);
4749 else if (mg->mg_len == HEf_SVKEY)
4750 SvREFCNT_dec((SV*)mg->mg_ptr);
4751 else if (mg->mg_type == PERL_MAGIC_utf8)
4752 Safefree(mg->mg_ptr);
4754 if (mg->mg_flags & MGf_REFCOUNTED)
4755 SvREFCNT_dec(mg->mg_obj);
4759 mgp = &mg->mg_moremagic;
4763 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4764 SvMAGIC_set(sv, NULL);
4771 =for apidoc sv_rvweaken
4773 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4774 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4775 push a back-reference to this RV onto the array of backreferences
4776 associated with that magic. If the RV is magical, set magic will be
4777 called after the RV is cleared.
4783 Perl_sv_rvweaken(pTHX_ SV *sv)
4786 if (!SvOK(sv)) /* let undefs pass */
4789 Perl_croak(aTHX_ "Can't weaken a nonreference");
4790 else if (SvWEAKREF(sv)) {
4791 if (ckWARN(WARN_MISC))
4792 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4796 Perl_sv_add_backref(aTHX_ tsv, sv);
4802 /* Give tsv backref magic if it hasn't already got it, then push a
4803 * back-reference to sv onto the array associated with the backref magic.
4807 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4812 if (SvTYPE(tsv) == SVt_PVHV) {
4813 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4817 /* There is no AV in the offical place - try a fixup. */
4818 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4821 /* Aha. They've got it stowed in magic. Bring it back. */
4822 av = (AV*)mg->mg_obj;
4823 /* Stop mg_free decreasing the refernce count. */
4825 /* Stop mg_free even calling the destructor, given that
4826 there's no AV to free up. */
4828 sv_unmagic(tsv, PERL_MAGIC_backref);
4832 SvREFCNT_inc_simple_void(av);
4837 const MAGIC *const mg
4838 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4840 av = (AV*)mg->mg_obj;
4844 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4845 /* av now has a refcnt of 2, which avoids it getting freed
4846 * before us during global cleanup. The extra ref is removed
4847 * by magic_killbackrefs() when tsv is being freed */
4850 if (AvFILLp(av) >= AvMAX(av)) {
4851 av_extend(av, AvFILLp(av)+1);
4853 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4856 /* delete a back-reference to ourselves from the backref magic associated
4857 * with the SV we point to.
4861 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4868 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4869 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4870 /* We mustn't attempt to "fix up" the hash here by moving the
4871 backreference array back to the hv_aux structure, as that is stored
4872 in the main HvARRAY(), and hfreentries assumes that no-one
4873 reallocates HvARRAY() while it is running. */
4876 const MAGIC *const mg
4877 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4879 av = (AV *)mg->mg_obj;
4882 if (PL_in_clean_all)
4884 Perl_croak(aTHX_ "panic: del_backref");
4891 /* We shouldn't be in here more than once, but for paranoia reasons lets
4893 for (i = AvFILLp(av); i >= 0; i--) {
4895 const SSize_t fill = AvFILLp(av);
4897 /* We weren't the last entry.
4898 An unordered list has this property that you can take the
4899 last element off the end to fill the hole, and it's still
4900 an unordered list :-)
4905 AvFILLp(av) = fill - 1;
4911 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4913 SV **svp = AvARRAY(av);
4915 PERL_UNUSED_ARG(sv);
4917 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4918 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4919 if (svp && !SvIS_FREED(av)) {
4920 SV *const *const last = svp + AvFILLp(av);
4922 while (svp <= last) {
4924 SV *const referrer = *svp;
4925 if (SvWEAKREF(referrer)) {
4926 /* XXX Should we check that it hasn't changed? */
4927 SvRV_set(referrer, 0);
4929 SvWEAKREF_off(referrer);
4930 SvSETMAGIC(referrer);
4931 } else if (SvTYPE(referrer) == SVt_PVGV ||
4932 SvTYPE(referrer) == SVt_PVLV) {
4933 /* You lookin' at me? */
4934 assert(GvSTASH(referrer));
4935 assert(GvSTASH(referrer) == (HV*)sv);
4936 GvSTASH(referrer) = 0;
4939 "panic: magic_killbackrefs (flags=%"UVxf")",
4940 (UV)SvFLAGS(referrer));
4948 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4953 =for apidoc sv_insert
4955 Inserts a string at the specified offset/length within the SV. Similar to
4956 the Perl substr() function.
4962 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4967 register char *midend;
4968 register char *bigend;
4974 Perl_croak(aTHX_ "Can't modify non-existent substring");
4975 SvPV_force(bigstr, curlen);
4976 (void)SvPOK_only_UTF8(bigstr);
4977 if (offset + len > curlen) {
4978 SvGROW(bigstr, offset+len+1);
4979 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
4980 SvCUR_set(bigstr, offset+len);
4984 i = littlelen - len;
4985 if (i > 0) { /* string might grow */
4986 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
4987 mid = big + offset + len;
4988 midend = bigend = big + SvCUR(bigstr);
4991 while (midend > mid) /* shove everything down */
4992 *--bigend = *--midend;
4993 Move(little,big+offset,littlelen,char);
4994 SvCUR_set(bigstr, SvCUR(bigstr) + i);
4999 Move(little,SvPVX(bigstr)+offset,len,char);
5004 big = SvPVX(bigstr);
5007 bigend = big + SvCUR(bigstr);
5009 if (midend > bigend)
5010 Perl_croak(aTHX_ "panic: sv_insert");
5012 if (mid - big > bigend - midend) { /* faster to shorten from end */
5014 Move(little, mid, littlelen,char);
5017 i = bigend - midend;
5019 Move(midend, mid, i,char);
5023 SvCUR_set(bigstr, mid - big);
5025 else if ((i = mid - big)) { /* faster from front */
5026 midend -= littlelen;
5028 Move(big, midend - i, i, char);
5029 sv_chop(bigstr,midend-i);
5031 Move(little, mid, littlelen,char);
5033 else if (littlelen) {
5034 midend -= littlelen;
5035 sv_chop(bigstr,midend);
5036 Move(little,midend,littlelen,char);
5039 sv_chop(bigstr,midend);
5045 =for apidoc sv_replace
5047 Make the first argument a copy of the second, then delete the original.
5048 The target SV physically takes over ownership of the body of the source SV
5049 and inherits its flags; however, the target keeps any magic it owns,
5050 and any magic in the source is discarded.
5051 Note that this is a rather specialist SV copying operation; most of the
5052 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5058 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5061 const U32 refcnt = SvREFCNT(sv);
5062 SV_CHECK_THINKFIRST_COW_DROP(sv);
5063 if (SvREFCNT(nsv) != 1) {
5064 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5065 UVuf " != 1)", (UV) SvREFCNT(nsv));
5067 if (SvMAGICAL(sv)) {
5071 sv_upgrade(nsv, SVt_PVMG);
5072 SvMAGIC_set(nsv, SvMAGIC(sv));
5073 SvFLAGS(nsv) |= SvMAGICAL(sv);
5075 SvMAGIC_set(sv, NULL);
5079 assert(!SvREFCNT(sv));
5080 #ifdef DEBUG_LEAKING_SCALARS
5081 sv->sv_flags = nsv->sv_flags;
5082 sv->sv_any = nsv->sv_any;
5083 sv->sv_refcnt = nsv->sv_refcnt;
5084 sv->sv_u = nsv->sv_u;
5086 StructCopy(nsv,sv,SV);
5088 if(SvTYPE(sv) == SVt_IV) {
5090 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5094 #ifdef PERL_OLD_COPY_ON_WRITE
5095 if (SvIsCOW_normal(nsv)) {
5096 /* We need to follow the pointers around the loop to make the
5097 previous SV point to sv, rather than nsv. */
5100 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5103 assert(SvPVX_const(current) == SvPVX_const(nsv));
5105 /* Make the SV before us point to the SV after us. */
5107 PerlIO_printf(Perl_debug_log, "previous is\n");
5109 PerlIO_printf(Perl_debug_log,
5110 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5111 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5113 SV_COW_NEXT_SV_SET(current, sv);
5116 SvREFCNT(sv) = refcnt;
5117 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5123 =for apidoc sv_clear
5125 Clear an SV: call any destructors, free up any memory used by the body,
5126 and free the body itself. The SV's head is I<not> freed, although
5127 its type is set to all 1's so that it won't inadvertently be assumed
5128 to be live during global destruction etc.
5129 This function should only be called when REFCNT is zero. Most of the time
5130 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5137 Perl_sv_clear(pTHX_ register SV *sv)
5140 const U32 type = SvTYPE(sv);
5141 const struct body_details *const sv_type_details
5142 = bodies_by_type + type;
5146 assert(SvREFCNT(sv) == 0);
5147 assert(SvTYPE(sv) != SVTYPEMASK);
5149 if (type <= SVt_IV) {
5150 /* See the comment in sv.h about the collusion between this early
5151 return and the overloading of the NULL and IV slots in the size
5154 SV * const target = SvRV(sv);
5156 sv_del_backref(target, sv);
5158 SvREFCNT_dec(target);
5160 SvFLAGS(sv) &= SVf_BREAK;
5161 SvFLAGS(sv) |= SVTYPEMASK;
5166 if (PL_defstash && /* Still have a symbol table? */
5173 stash = SvSTASH(sv);
5174 destructor = StashHANDLER(stash,DESTROY);
5176 SV* const tmpref = newRV(sv);
5177 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5179 PUSHSTACKi(PERLSI_DESTROY);
5184 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5190 if(SvREFCNT(tmpref) < 2) {
5191 /* tmpref is not kept alive! */
5193 SvRV_set(tmpref, NULL);
5196 SvREFCNT_dec(tmpref);
5198 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5202 if (PL_in_clean_objs)
5203 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5205 /* DESTROY gave object new lease on life */
5211 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5212 SvOBJECT_off(sv); /* Curse the object. */
5213 if (type != SVt_PVIO)
5214 --PL_sv_objcount; /* XXX Might want something more general */
5217 if (type >= SVt_PVMG) {
5218 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5219 SvREFCNT_dec(SvOURSTASH(sv));
5220 } else if (SvMAGIC(sv))
5222 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5223 SvREFCNT_dec(SvSTASH(sv));
5226 /* case SVt_BIND: */
5229 IoIFP(sv) != PerlIO_stdin() &&
5230 IoIFP(sv) != PerlIO_stdout() &&
5231 IoIFP(sv) != PerlIO_stderr())
5233 io_close((IO*)sv, FALSE);
5235 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5236 PerlDir_close(IoDIRP(sv));
5237 IoDIRP(sv) = (DIR*)NULL;
5238 Safefree(IoTOP_NAME(sv));
5239 Safefree(IoFMT_NAME(sv));
5240 Safefree(IoBOTTOM_NAME(sv));
5243 /* FIXME for plugins */
5244 pregfree2((REGEXP*) sv);
5251 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5255 if (PL_comppad == (AV*)sv) {
5262 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5263 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5264 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5265 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5267 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5268 SvREFCNT_dec(LvTARG(sv));
5270 if (isGV_with_GP(sv)) {
5271 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5272 mro_method_changed_in(stash);
5275 unshare_hek(GvNAME_HEK(sv));
5276 /* If we're in a stash, we don't own a reference to it. However it does
5277 have a back reference to us, which needs to be cleared. */
5278 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5279 sv_del_backref((SV*)stash, sv);
5281 /* FIXME. There are probably more unreferenced pointers to SVs in the
5282 interpreter struct that we should check and tidy in a similar
5284 if ((GV*)sv == PL_last_in_gv)
5285 PL_last_in_gv = NULL;
5291 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5294 SvOOK_offset(sv, offset);
5295 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5296 /* Don't even bother with turning off the OOK flag. */
5299 SV * const target = SvRV(sv);
5301 sv_del_backref(target, sv);
5303 SvREFCNT_dec(target);
5305 #ifdef PERL_OLD_COPY_ON_WRITE
5306 else if (SvPVX_const(sv)) {
5308 /* I believe I need to grab the global SV mutex here and
5309 then recheck the COW status. */
5311 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5315 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5317 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5320 /* And drop it here. */
5322 } else if (SvLEN(sv)) {
5323 Safefree(SvPVX_const(sv));
5327 else if (SvPVX_const(sv) && SvLEN(sv))
5328 Safefree(SvPVX_mutable(sv));
5329 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5330 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5339 SvFLAGS(sv) &= SVf_BREAK;
5340 SvFLAGS(sv) |= SVTYPEMASK;
5342 if (sv_type_details->arena) {
5343 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5344 &PL_body_roots[type]);
5346 else if (sv_type_details->body_size) {
5347 my_safefree(SvANY(sv));
5352 =for apidoc sv_newref
5354 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5361 Perl_sv_newref(pTHX_ SV *sv)
5363 PERL_UNUSED_CONTEXT;
5372 Decrement an SV's reference count, and if it drops to zero, call
5373 C<sv_clear> to invoke destructors and free up any memory used by
5374 the body; finally, deallocate the SV's head itself.
5375 Normally called via a wrapper macro C<SvREFCNT_dec>.
5381 Perl_sv_free(pTHX_ SV *sv)
5386 if (SvREFCNT(sv) == 0) {
5387 if (SvFLAGS(sv) & SVf_BREAK)
5388 /* this SV's refcnt has been artificially decremented to
5389 * trigger cleanup */
5391 if (PL_in_clean_all) /* All is fair */
5393 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5394 /* make sure SvREFCNT(sv)==0 happens very seldom */
5395 SvREFCNT(sv) = (~(U32)0)/2;
5398 if (ckWARN_d(WARN_INTERNAL)) {
5399 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5400 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5401 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5402 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5403 Perl_dump_sv_child(aTHX_ sv);
5405 #ifdef DEBUG_LEAKING_SCALARS
5412 if (--(SvREFCNT(sv)) > 0)
5414 Perl_sv_free2(aTHX_ sv);
5418 Perl_sv_free2(pTHX_ SV *sv)
5423 if (ckWARN_d(WARN_DEBUGGING))
5424 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5425 "Attempt to free temp prematurely: SV 0x%"UVxf
5426 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5430 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5431 /* make sure SvREFCNT(sv)==0 happens very seldom */
5432 SvREFCNT(sv) = (~(U32)0)/2;
5443 Returns the length of the string in the SV. Handles magic and type
5444 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5450 Perl_sv_len(pTHX_ register SV *sv)
5458 len = mg_length(sv);
5460 (void)SvPV_const(sv, len);
5465 =for apidoc sv_len_utf8
5467 Returns the number of characters in the string in an SV, counting wide
5468 UTF-8 bytes as a single character. Handles magic and type coercion.
5474 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5475 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5476 * (Note that the mg_len is not the length of the mg_ptr field.
5477 * This allows the cache to store the character length of the string without
5478 * needing to malloc() extra storage to attach to the mg_ptr.)
5483 Perl_sv_len_utf8(pTHX_ register SV *sv)
5489 return mg_length(sv);
5493 const U8 *s = (U8*)SvPV_const(sv, len);
5497 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5499 if (mg && mg->mg_len != -1) {
5501 if (PL_utf8cache < 0) {
5502 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5504 /* Need to turn the assertions off otherwise we may
5505 recurse infinitely while printing error messages.
5507 SAVEI8(PL_utf8cache);
5509 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5510 " real %"UVuf" for %"SVf,
5511 (UV) ulen, (UV) real, SVfARG(sv));
5516 ulen = Perl_utf8_length(aTHX_ s, s + len);
5517 if (!SvREADONLY(sv)) {
5519 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5520 &PL_vtbl_utf8, 0, 0);
5528 return Perl_utf8_length(aTHX_ s, s + len);
5532 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5535 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5538 const U8 *s = start;
5540 while (s < send && uoffset--)
5543 /* This is the existing behaviour. Possibly it should be a croak, as
5544 it's actually a bounds error */
5550 /* Given the length of the string in both bytes and UTF-8 characters, decide
5551 whether to walk forwards or backwards to find the byte corresponding to
5552 the passed in UTF-8 offset. */
5554 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5555 STRLEN uoffset, STRLEN uend)
5557 STRLEN backw = uend - uoffset;
5558 if (uoffset < 2 * backw) {
5559 /* The assumption is that going forwards is twice the speed of going
5560 forward (that's where the 2 * backw comes from).
5561 (The real figure of course depends on the UTF-8 data.) */
5562 return sv_pos_u2b_forwards(start, send, uoffset);
5567 while (UTF8_IS_CONTINUATION(*send))
5570 return send - start;
5573 /* For the string representation of the given scalar, find the byte
5574 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5575 give another position in the string, *before* the sought offset, which
5576 (which is always true, as 0, 0 is a valid pair of positions), which should
5577 help reduce the amount of linear searching.
5578 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5579 will be used to reduce the amount of linear searching. The cache will be
5580 created if necessary, and the found value offered to it for update. */
5582 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5583 const U8 *const send, STRLEN uoffset,
5584 STRLEN uoffset0, STRLEN boffset0) {
5585 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5588 assert (uoffset >= uoffset0);
5590 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5591 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5592 if ((*mgp)->mg_ptr) {
5593 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5594 if (cache[0] == uoffset) {
5595 /* An exact match. */
5598 if (cache[2] == uoffset) {
5599 /* An exact match. */
5603 if (cache[0] < uoffset) {
5604 /* The cache already knows part of the way. */
5605 if (cache[0] > uoffset0) {
5606 /* The cache knows more than the passed in pair */
5607 uoffset0 = cache[0];
5608 boffset0 = cache[1];
5610 if ((*mgp)->mg_len != -1) {
5611 /* And we know the end too. */
5613 + sv_pos_u2b_midway(start + boffset0, send,
5615 (*mgp)->mg_len - uoffset0);
5618 + sv_pos_u2b_forwards(start + boffset0,
5619 send, uoffset - uoffset0);
5622 else if (cache[2] < uoffset) {
5623 /* We're between the two cache entries. */
5624 if (cache[2] > uoffset0) {
5625 /* and the cache knows more than the passed in pair */
5626 uoffset0 = cache[2];
5627 boffset0 = cache[3];
5631 + sv_pos_u2b_midway(start + boffset0,
5634 cache[0] - uoffset0);
5637 + sv_pos_u2b_midway(start + boffset0,
5640 cache[2] - uoffset0);
5644 else if ((*mgp)->mg_len != -1) {
5645 /* If we can take advantage of a passed in offset, do so. */
5646 /* In fact, offset0 is either 0, or less than offset, so don't
5647 need to worry about the other possibility. */
5649 + sv_pos_u2b_midway(start + boffset0, send,
5651 (*mgp)->mg_len - uoffset0);
5656 if (!found || PL_utf8cache < 0) {
5657 const STRLEN real_boffset
5658 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5659 send, uoffset - uoffset0);
5661 if (found && PL_utf8cache < 0) {
5662 if (real_boffset != boffset) {
5663 /* Need to turn the assertions off otherwise we may recurse
5664 infinitely while printing error messages. */
5665 SAVEI8(PL_utf8cache);
5667 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5668 " real %"UVuf" for %"SVf,
5669 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5672 boffset = real_boffset;
5675 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5681 =for apidoc sv_pos_u2b
5683 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5684 the start of the string, to a count of the equivalent number of bytes; if
5685 lenp is non-zero, it does the same to lenp, but this time starting from
5686 the offset, rather than from the start of the string. Handles magic and
5693 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5694 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5695 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5700 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5708 start = (U8*)SvPV_const(sv, len);
5710 STRLEN uoffset = (STRLEN) *offsetp;
5711 const U8 * const send = start + len;
5713 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5716 *offsetp = (I32) boffset;
5719 /* Convert the relative offset to absolute. */
5720 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5721 const STRLEN boffset2
5722 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5723 uoffset, boffset) - boffset;
5737 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5738 byte length pairing. The (byte) length of the total SV is passed in too,
5739 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5740 may not have updated SvCUR, so we can't rely on reading it directly.
5742 The proffered utf8/byte length pairing isn't used if the cache already has
5743 two pairs, and swapping either for the proffered pair would increase the
5744 RMS of the intervals between known byte offsets.
5746 The cache itself consists of 4 STRLEN values
5747 0: larger UTF-8 offset
5748 1: corresponding byte offset
5749 2: smaller UTF-8 offset
5750 3: corresponding byte offset
5752 Unused cache pairs have the value 0, 0.
5753 Keeping the cache "backwards" means that the invariant of
5754 cache[0] >= cache[2] is maintained even with empty slots, which means that
5755 the code that uses it doesn't need to worry if only 1 entry has actually
5756 been set to non-zero. It also makes the "position beyond the end of the
5757 cache" logic much simpler, as the first slot is always the one to start
5761 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5769 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5771 (*mgp)->mg_len = -1;
5775 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5776 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5777 (*mgp)->mg_ptr = (char *) cache;
5781 if (PL_utf8cache < 0) {
5782 const U8 *start = (const U8 *) SvPVX_const(sv);
5783 const STRLEN realutf8 = utf8_length(start, start + byte);
5785 if (realutf8 != utf8) {
5786 /* Need to turn the assertions off otherwise we may recurse
5787 infinitely while printing error messages. */
5788 SAVEI8(PL_utf8cache);
5790 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5791 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5795 /* Cache is held with the later position first, to simplify the code
5796 that deals with unbounded ends. */
5798 ASSERT_UTF8_CACHE(cache);
5799 if (cache[1] == 0) {
5800 /* Cache is totally empty */
5803 } else if (cache[3] == 0) {
5804 if (byte > cache[1]) {
5805 /* New one is larger, so goes first. */
5806 cache[2] = cache[0];
5807 cache[3] = cache[1];
5815 #define THREEWAY_SQUARE(a,b,c,d) \
5816 ((float)((d) - (c))) * ((float)((d) - (c))) \
5817 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5818 + ((float)((b) - (a))) * ((float)((b) - (a)))
5820 /* Cache has 2 slots in use, and we know three potential pairs.
5821 Keep the two that give the lowest RMS distance. Do the
5822 calcualation in bytes simply because we always know the byte
5823 length. squareroot has the same ordering as the positive value,
5824 so don't bother with the actual square root. */
5825 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5826 if (byte > cache[1]) {
5827 /* New position is after the existing pair of pairs. */
5828 const float keep_earlier
5829 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5830 const float keep_later
5831 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5833 if (keep_later < keep_earlier) {
5834 if (keep_later < existing) {
5835 cache[2] = cache[0];
5836 cache[3] = cache[1];
5842 if (keep_earlier < existing) {
5848 else if (byte > cache[3]) {
5849 /* New position is between the existing pair of pairs. */
5850 const float keep_earlier
5851 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5852 const float keep_later
5853 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5855 if (keep_later < keep_earlier) {
5856 if (keep_later < existing) {
5862 if (keep_earlier < existing) {
5869 /* New position is before the existing pair of pairs. */
5870 const float keep_earlier
5871 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5872 const float keep_later
5873 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5875 if (keep_later < keep_earlier) {
5876 if (keep_later < existing) {
5882 if (keep_earlier < existing) {
5883 cache[0] = cache[2];
5884 cache[1] = cache[3];
5891 ASSERT_UTF8_CACHE(cache);
5894 /* We already know all of the way, now we may be able to walk back. The same
5895 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5896 backward is half the speed of walking forward. */
5898 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5901 const STRLEN forw = target - s;
5902 STRLEN backw = end - target;
5904 if (forw < 2 * backw) {
5905 return utf8_length(s, target);
5908 while (end > target) {
5910 while (UTF8_IS_CONTINUATION(*end)) {
5919 =for apidoc sv_pos_b2u
5921 Converts the value pointed to by offsetp from a count of bytes from the
5922 start of the string, to a count of the equivalent number of UTF-8 chars.
5923 Handles magic and type coercion.
5929 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5930 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5935 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5938 const STRLEN byte = *offsetp;
5939 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5948 s = (const U8*)SvPV_const(sv, blen);
5951 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5955 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5956 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5958 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5959 if (cache[1] == byte) {
5960 /* An exact match. */
5961 *offsetp = cache[0];
5964 if (cache[3] == byte) {
5965 /* An exact match. */
5966 *offsetp = cache[2];
5970 if (cache[1] < byte) {
5971 /* We already know part of the way. */
5972 if (mg->mg_len != -1) {
5973 /* Actually, we know the end too. */
5975 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
5976 s + blen, mg->mg_len - cache[0]);
5978 len = cache[0] + utf8_length(s + cache[1], send);
5981 else if (cache[3] < byte) {
5982 /* We're between the two cached pairs, so we do the calculation
5983 offset by the byte/utf-8 positions for the earlier pair,
5984 then add the utf-8 characters from the string start to
5986 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
5987 s + cache[1], cache[0] - cache[2])
5991 else { /* cache[3] > byte */
5992 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
5996 ASSERT_UTF8_CACHE(cache);
5998 } else if (mg->mg_len != -1) {
5999 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6003 if (!found || PL_utf8cache < 0) {
6004 const STRLEN real_len = utf8_length(s, send);
6006 if (found && PL_utf8cache < 0) {
6007 if (len != real_len) {
6008 /* Need to turn the assertions off otherwise we may recurse
6009 infinitely while printing error messages. */
6010 SAVEI8(PL_utf8cache);
6012 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6013 " real %"UVuf" for %"SVf,
6014 (UV) len, (UV) real_len, SVfARG(sv));
6021 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6027 Returns a boolean indicating whether the strings in the two SVs are
6028 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6029 coerce its args to strings if necessary.
6035 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6044 SV* svrecode = NULL;
6051 /* if pv1 and pv2 are the same, second SvPV_const call may
6052 * invalidate pv1, so we may need to make a copy */
6053 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6054 pv1 = SvPV_const(sv1, cur1);
6055 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6057 pv1 = SvPV_const(sv1, cur1);
6065 pv2 = SvPV_const(sv2, cur2);
6067 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6068 /* Differing utf8ness.
6069 * Do not UTF8size the comparands as a side-effect. */
6072 svrecode = newSVpvn(pv2, cur2);
6073 sv_recode_to_utf8(svrecode, PL_encoding);
6074 pv2 = SvPV_const(svrecode, cur2);
6077 svrecode = newSVpvn(pv1, cur1);
6078 sv_recode_to_utf8(svrecode, PL_encoding);
6079 pv1 = SvPV_const(svrecode, cur1);
6081 /* Now both are in UTF-8. */
6083 SvREFCNT_dec(svrecode);
6088 bool is_utf8 = TRUE;
6091 /* sv1 is the UTF-8 one,
6092 * if is equal it must be downgrade-able */
6093 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6099 /* sv2 is the UTF-8 one,
6100 * if is equal it must be downgrade-able */
6101 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6107 /* Downgrade not possible - cannot be eq */
6115 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6117 SvREFCNT_dec(svrecode);
6127 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6128 string in C<sv1> is less than, equal to, or greater than the string in
6129 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6130 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6136 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6140 const char *pv1, *pv2;
6143 SV *svrecode = NULL;
6150 pv1 = SvPV_const(sv1, cur1);
6157 pv2 = SvPV_const(sv2, cur2);
6159 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6160 /* Differing utf8ness.
6161 * Do not UTF8size the comparands as a side-effect. */
6164 svrecode = newSVpvn(pv2, cur2);
6165 sv_recode_to_utf8(svrecode, PL_encoding);
6166 pv2 = SvPV_const(svrecode, cur2);
6169 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6174 svrecode = newSVpvn(pv1, cur1);
6175 sv_recode_to_utf8(svrecode, PL_encoding);
6176 pv1 = SvPV_const(svrecode, cur1);
6179 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6185 cmp = cur2 ? -1 : 0;
6189 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6192 cmp = retval < 0 ? -1 : 1;
6193 } else if (cur1 == cur2) {
6196 cmp = cur1 < cur2 ? -1 : 1;
6200 SvREFCNT_dec(svrecode);
6208 =for apidoc sv_cmp_locale
6210 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6211 'use bytes' aware, handles get magic, and will coerce its args to strings
6212 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6218 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6221 #ifdef USE_LOCALE_COLLATE
6227 if (PL_collation_standard)
6231 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6233 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6235 if (!pv1 || !len1) {
6246 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6249 return retval < 0 ? -1 : 1;
6252 * When the result of collation is equality, that doesn't mean
6253 * that there are no differences -- some locales exclude some
6254 * characters from consideration. So to avoid false equalities,
6255 * we use the raw string as a tiebreaker.
6261 #endif /* USE_LOCALE_COLLATE */
6263 return sv_cmp(sv1, sv2);
6267 #ifdef USE_LOCALE_COLLATE
6270 =for apidoc sv_collxfrm
6272 Add Collate Transform magic to an SV if it doesn't already have it.
6274 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6275 scalar data of the variable, but transformed to such a format that a normal
6276 memory comparison can be used to compare the data according to the locale
6283 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6288 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6289 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6295 Safefree(mg->mg_ptr);
6296 s = SvPV_const(sv, len);
6297 if ((xf = mem_collxfrm(s, len, &xlen))) {
6298 if (SvREADONLY(sv)) {
6301 return xf + sizeof(PL_collation_ix);
6304 #ifdef PERL_OLD_COPY_ON_WRITE
6306 sv_force_normal_flags(sv, 0);
6308 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6322 if (mg && mg->mg_ptr) {
6324 return mg->mg_ptr + sizeof(PL_collation_ix);
6332 #endif /* USE_LOCALE_COLLATE */
6337 Get a line from the filehandle and store it into the SV, optionally
6338 appending to the currently-stored string.
6344 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6349 register STDCHAR rslast;
6350 register STDCHAR *bp;
6355 if (SvTHINKFIRST(sv))
6356 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6357 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6359 However, perlbench says it's slower, because the existing swipe code
6360 is faster than copy on write.
6361 Swings and roundabouts. */
6362 SvUPGRADE(sv, SVt_PV);
6367 if (PerlIO_isutf8(fp)) {
6369 sv_utf8_upgrade_nomg(sv);
6370 sv_pos_u2b(sv,&append,0);
6372 } else if (SvUTF8(sv)) {
6373 SV * const tsv = newSV(0);
6374 sv_gets(tsv, fp, 0);
6375 sv_utf8_upgrade_nomg(tsv);
6376 SvCUR_set(sv,append);
6379 goto return_string_or_null;
6384 if (PerlIO_isutf8(fp))
6387 if (IN_PERL_COMPILETIME) {
6388 /* we always read code in line mode */
6392 else if (RsSNARF(PL_rs)) {
6393 /* If it is a regular disk file use size from stat() as estimate
6394 of amount we are going to read -- may result in mallocing
6395 more memory than we really need if the layers below reduce
6396 the size we read (e.g. CRLF or a gzip layer).
6399 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6400 const Off_t offset = PerlIO_tell(fp);
6401 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6402 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6408 else if (RsRECORD(PL_rs)) {
6413 /* Grab the size of the record we're getting */
6414 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6415 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6418 /* VMS wants read instead of fread, because fread doesn't respect */
6419 /* RMS record boundaries. This is not necessarily a good thing to be */
6420 /* doing, but we've got no other real choice - except avoid stdio
6421 as implementation - perhaps write a :vms layer ?
6423 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6425 bytesread = PerlIO_read(fp, buffer, recsize);
6429 SvCUR_set(sv, bytesread += append);
6430 buffer[bytesread] = '\0';
6431 goto return_string_or_null;
6433 else if (RsPARA(PL_rs)) {
6439 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6440 if (PerlIO_isutf8(fp)) {
6441 rsptr = SvPVutf8(PL_rs, rslen);
6444 if (SvUTF8(PL_rs)) {
6445 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6446 Perl_croak(aTHX_ "Wide character in $/");
6449 rsptr = SvPV_const(PL_rs, rslen);
6453 rslast = rslen ? rsptr[rslen - 1] : '\0';
6455 if (rspara) { /* have to do this both before and after */
6456 do { /* to make sure file boundaries work right */
6459 i = PerlIO_getc(fp);
6463 PerlIO_ungetc(fp,i);
6469 /* See if we know enough about I/O mechanism to cheat it ! */
6471 /* This used to be #ifdef test - it is made run-time test for ease
6472 of abstracting out stdio interface. One call should be cheap
6473 enough here - and may even be a macro allowing compile
6477 if (PerlIO_fast_gets(fp)) {
6480 * We're going to steal some values from the stdio struct
6481 * and put EVERYTHING in the innermost loop into registers.
6483 register STDCHAR *ptr;
6487 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6488 /* An ungetc()d char is handled separately from the regular
6489 * buffer, so we getc() it back out and stuff it in the buffer.
6491 i = PerlIO_getc(fp);
6492 if (i == EOF) return 0;
6493 *(--((*fp)->_ptr)) = (unsigned char) i;
6497 /* Here is some breathtakingly efficient cheating */
6499 cnt = PerlIO_get_cnt(fp); /* get count into register */
6500 /* make sure we have the room */
6501 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6502 /* Not room for all of it
6503 if we are looking for a separator and room for some
6505 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6506 /* just process what we have room for */
6507 shortbuffered = cnt - SvLEN(sv) + append + 1;
6508 cnt -= shortbuffered;
6512 /* remember that cnt can be negative */
6513 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6518 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6519 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6520 DEBUG_P(PerlIO_printf(Perl_debug_log,
6521 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6522 DEBUG_P(PerlIO_printf(Perl_debug_log,
6523 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6524 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6525 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6530 while (cnt > 0) { /* this | eat */
6532 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6533 goto thats_all_folks; /* screams | sed :-) */
6537 Copy(ptr, bp, cnt, char); /* this | eat */
6538 bp += cnt; /* screams | dust */
6539 ptr += cnt; /* louder | sed :-) */
6544 if (shortbuffered) { /* oh well, must extend */
6545 cnt = shortbuffered;
6547 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6549 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6550 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6554 DEBUG_P(PerlIO_printf(Perl_debug_log,
6555 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6556 PTR2UV(ptr),(long)cnt));
6557 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6559 DEBUG_P(PerlIO_printf(Perl_debug_log,
6560 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6561 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6562 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6564 /* This used to call 'filbuf' in stdio form, but as that behaves like
6565 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6566 another abstraction. */
6567 i = PerlIO_getc(fp); /* get more characters */
6569 DEBUG_P(PerlIO_printf(Perl_debug_log,
6570 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6571 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6572 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6574 cnt = PerlIO_get_cnt(fp);
6575 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6576 DEBUG_P(PerlIO_printf(Perl_debug_log,
6577 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6579 if (i == EOF) /* all done for ever? */
6580 goto thats_really_all_folks;
6582 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6584 SvGROW(sv, bpx + cnt + 2);
6585 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6587 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6589 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6590 goto thats_all_folks;
6594 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6595 memNE((char*)bp - rslen, rsptr, rslen))
6596 goto screamer; /* go back to the fray */
6597 thats_really_all_folks:
6599 cnt += shortbuffered;
6600 DEBUG_P(PerlIO_printf(Perl_debug_log,
6601 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6602 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6603 DEBUG_P(PerlIO_printf(Perl_debug_log,
6604 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6605 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6606 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6608 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6609 DEBUG_P(PerlIO_printf(Perl_debug_log,
6610 "Screamer: done, len=%ld, string=|%.*s|\n",
6611 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6615 /*The big, slow, and stupid way. */
6616 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6617 STDCHAR *buf = NULL;
6618 Newx(buf, 8192, STDCHAR);
6626 register const STDCHAR * const bpe = buf + sizeof(buf);
6628 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6629 ; /* keep reading */
6633 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6634 /* Accomodate broken VAXC compiler, which applies U8 cast to
6635 * both args of ?: operator, causing EOF to change into 255
6638 i = (U8)buf[cnt - 1];
6644 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6646 sv_catpvn(sv, (char *) buf, cnt);
6648 sv_setpvn(sv, (char *) buf, cnt);
6650 if (i != EOF && /* joy */
6652 SvCUR(sv) < rslen ||
6653 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6657 * If we're reading from a TTY and we get a short read,
6658 * indicating that the user hit his EOF character, we need
6659 * to notice it now, because if we try to read from the TTY
6660 * again, the EOF condition will disappear.
6662 * The comparison of cnt to sizeof(buf) is an optimization
6663 * that prevents unnecessary calls to feof().
6667 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6671 #ifdef USE_HEAP_INSTEAD_OF_STACK
6676 if (rspara) { /* have to do this both before and after */
6677 while (i != EOF) { /* to make sure file boundaries work right */
6678 i = PerlIO_getc(fp);
6680 PerlIO_ungetc(fp,i);
6686 return_string_or_null:
6687 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6693 Auto-increment of the value in the SV, doing string to numeric conversion
6694 if necessary. Handles 'get' magic.
6700 Perl_sv_inc(pTHX_ register SV *sv)
6709 if (SvTHINKFIRST(sv)) {
6711 sv_force_normal_flags(sv, 0);
6712 if (SvREADONLY(sv)) {
6713 if (IN_PERL_RUNTIME)
6714 Perl_croak(aTHX_ PL_no_modify);
6718 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6720 i = PTR2IV(SvRV(sv));
6725 flags = SvFLAGS(sv);
6726 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6727 /* It's (privately or publicly) a float, but not tested as an
6728 integer, so test it to see. */
6730 flags = SvFLAGS(sv);
6732 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6733 /* It's publicly an integer, or privately an integer-not-float */
6734 #ifdef PERL_PRESERVE_IVUV
6738 if (SvUVX(sv) == UV_MAX)
6739 sv_setnv(sv, UV_MAX_P1);
6741 (void)SvIOK_only_UV(sv);
6742 SvUV_set(sv, SvUVX(sv) + 1);
6744 if (SvIVX(sv) == IV_MAX)
6745 sv_setuv(sv, (UV)IV_MAX + 1);
6747 (void)SvIOK_only(sv);
6748 SvIV_set(sv, SvIVX(sv) + 1);
6753 if (flags & SVp_NOK) {
6754 (void)SvNOK_only(sv);
6755 SvNV_set(sv, SvNVX(sv) + 1.0);
6759 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6760 if ((flags & SVTYPEMASK) < SVt_PVIV)
6761 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6762 (void)SvIOK_only(sv);
6767 while (isALPHA(*d)) d++;
6768 while (isDIGIT(*d)) d++;
6770 #ifdef PERL_PRESERVE_IVUV
6771 /* Got to punt this as an integer if needs be, but we don't issue
6772 warnings. Probably ought to make the sv_iv_please() that does
6773 the conversion if possible, and silently. */
6774 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6775 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6776 /* Need to try really hard to see if it's an integer.
6777 9.22337203685478e+18 is an integer.
6778 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6779 so $a="9.22337203685478e+18"; $a+0; $a++
6780 needs to be the same as $a="9.22337203685478e+18"; $a++
6787 /* sv_2iv *should* have made this an NV */
6788 if (flags & SVp_NOK) {
6789 (void)SvNOK_only(sv);
6790 SvNV_set(sv, SvNVX(sv) + 1.0);
6793 /* I don't think we can get here. Maybe I should assert this
6794 And if we do get here I suspect that sv_setnv will croak. NWC
6796 #if defined(USE_LONG_DOUBLE)
6797 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",
6798 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6800 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6801 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6804 #endif /* PERL_PRESERVE_IVUV */
6805 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6809 while (d >= SvPVX_const(sv)) {
6817 /* MKS: The original code here died if letters weren't consecutive.
6818 * at least it didn't have to worry about non-C locales. The
6819 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6820 * arranged in order (although not consecutively) and that only
6821 * [A-Za-z] are accepted by isALPHA in the C locale.
6823 if (*d != 'z' && *d != 'Z') {
6824 do { ++*d; } while (!isALPHA(*d));
6827 *(d--) -= 'z' - 'a';
6832 *(d--) -= 'z' - 'a' + 1;
6836 /* oh,oh, the number grew */
6837 SvGROW(sv, SvCUR(sv) + 2);
6838 SvCUR_set(sv, SvCUR(sv) + 1);
6839 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6850 Auto-decrement of the value in the SV, doing string to numeric conversion
6851 if necessary. Handles 'get' magic.
6857 Perl_sv_dec(pTHX_ register SV *sv)
6865 if (SvTHINKFIRST(sv)) {
6867 sv_force_normal_flags(sv, 0);
6868 if (SvREADONLY(sv)) {
6869 if (IN_PERL_RUNTIME)
6870 Perl_croak(aTHX_ PL_no_modify);
6874 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6876 i = PTR2IV(SvRV(sv));
6881 /* Unlike sv_inc we don't have to worry about string-never-numbers
6882 and keeping them magic. But we mustn't warn on punting */
6883 flags = SvFLAGS(sv);
6884 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6885 /* It's publicly an integer, or privately an integer-not-float */
6886 #ifdef PERL_PRESERVE_IVUV
6890 if (SvUVX(sv) == 0) {
6891 (void)SvIOK_only(sv);
6895 (void)SvIOK_only_UV(sv);
6896 SvUV_set(sv, SvUVX(sv) - 1);
6899 if (SvIVX(sv) == IV_MIN)
6900 sv_setnv(sv, (NV)IV_MIN - 1.0);
6902 (void)SvIOK_only(sv);
6903 SvIV_set(sv, SvIVX(sv) - 1);
6908 if (flags & SVp_NOK) {
6909 SvNV_set(sv, SvNVX(sv) - 1.0);
6910 (void)SvNOK_only(sv);
6913 if (!(flags & SVp_POK)) {
6914 if ((flags & SVTYPEMASK) < SVt_PVIV)
6915 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6917 (void)SvIOK_only(sv);
6920 #ifdef PERL_PRESERVE_IVUV
6922 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6923 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6924 /* Need to try really hard to see if it's an integer.
6925 9.22337203685478e+18 is an integer.
6926 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6927 so $a="9.22337203685478e+18"; $a+0; $a--
6928 needs to be the same as $a="9.22337203685478e+18"; $a--
6935 /* sv_2iv *should* have made this an NV */
6936 if (flags & SVp_NOK) {
6937 (void)SvNOK_only(sv);
6938 SvNV_set(sv, SvNVX(sv) - 1.0);
6941 /* I don't think we can get here. Maybe I should assert this
6942 And if we do get here I suspect that sv_setnv will croak. NWC
6944 #if defined(USE_LONG_DOUBLE)
6945 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",
6946 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6948 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6949 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6953 #endif /* PERL_PRESERVE_IVUV */
6954 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6958 =for apidoc sv_mortalcopy
6960 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6961 The new SV is marked as mortal. It will be destroyed "soon", either by an
6962 explicit call to FREETMPS, or by an implicit call at places such as
6963 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6968 /* Make a string that will exist for the duration of the expression
6969 * evaluation. Actually, it may have to last longer than that, but
6970 * hopefully we won't free it until it has been assigned to a
6971 * permanent location. */
6974 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
6980 sv_setsv(sv,oldstr);
6982 PL_tmps_stack[++PL_tmps_ix] = sv;
6988 =for apidoc sv_newmortal
6990 Creates a new null SV which is mortal. The reference count of the SV is
6991 set to 1. It will be destroyed "soon", either by an explicit call to
6992 FREETMPS, or by an implicit call at places such as statement boundaries.
6993 See also C<sv_mortalcopy> and C<sv_2mortal>.
6999 Perl_sv_newmortal(pTHX)
7005 SvFLAGS(sv) = SVs_TEMP;
7007 PL_tmps_stack[++PL_tmps_ix] = sv;
7013 =for apidoc newSVpvn_flags
7015 Creates a new SV and copies a string into it. The reference count for the
7016 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7017 string. You are responsible for ensuring that the source string is at least
7018 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7019 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7020 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7021 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7022 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7024 #define newSVpvn_utf8(s, len, u) \
7025 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7031 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7036 /* All the flags we don't support must be zero.
7037 And we're new code so I'm going to assert this from the start. */
7038 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7040 sv_setpvn(sv,s,len);
7041 SvFLAGS(sv) |= (flags & SVf_UTF8);
7042 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7046 =for apidoc sv_2mortal
7048 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7049 by an explicit call to FREETMPS, or by an implicit call at places such as
7050 statement boundaries. SvTEMP() is turned on which means that the SV's
7051 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7052 and C<sv_mortalcopy>.
7058 Perl_sv_2mortal(pTHX_ register SV *sv)
7063 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7066 PL_tmps_stack[++PL_tmps_ix] = sv;
7074 Creates a new SV and copies a string into it. The reference count for the
7075 SV is set to 1. If C<len> is zero, Perl will compute the length using
7076 strlen(). For efficiency, consider using C<newSVpvn> instead.
7082 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7088 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7093 =for apidoc newSVpvn
7095 Creates a new SV and copies a string into it. The reference count for the
7096 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7097 string. You are responsible for ensuring that the source string is at least
7098 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7104 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7110 sv_setpvn(sv,s,len);
7115 =for apidoc newSVhek
7117 Creates a new SV from the hash key structure. It will generate scalars that
7118 point to the shared string table where possible. Returns a new (undefined)
7119 SV if the hek is NULL.
7125 Perl_newSVhek(pTHX_ const HEK *hek)
7135 if (HEK_LEN(hek) == HEf_SVKEY) {
7136 return newSVsv(*(SV**)HEK_KEY(hek));
7138 const int flags = HEK_FLAGS(hek);
7139 if (flags & HVhek_WASUTF8) {
7141 Andreas would like keys he put in as utf8 to come back as utf8
7143 STRLEN utf8_len = HEK_LEN(hek);
7144 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7145 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7148 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7150 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7151 /* We don't have a pointer to the hv, so we have to replicate the
7152 flag into every HEK. This hv is using custom a hasing
7153 algorithm. Hence we can't return a shared string scalar, as
7154 that would contain the (wrong) hash value, and might get passed
7155 into an hv routine with a regular hash.
7156 Similarly, a hash that isn't using shared hash keys has to have
7157 the flag in every key so that we know not to try to call
7158 share_hek_kek on it. */
7160 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7165 /* This will be overwhelminly the most common case. */
7167 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7168 more efficient than sharepvn(). */
7172 sv_upgrade(sv, SVt_PV);
7173 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7174 SvCUR_set(sv, HEK_LEN(hek));
7187 =for apidoc newSVpvn_share
7189 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7190 table. If the string does not already exist in the table, it is created
7191 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7192 value is used; otherwise the hash is computed. The string's hash can be later
7193 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7194 that as the string table is used for shared hash keys these strings will have
7195 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7201 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7205 bool is_utf8 = FALSE;
7206 const char *const orig_src = src;
7209 STRLEN tmplen = -len;
7211 /* See the note in hv.c:hv_fetch() --jhi */
7212 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7216 PERL_HASH(hash, src, len);
7218 sv_upgrade(sv, SVt_PV);
7219 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7227 if (src != orig_src)
7233 #if defined(PERL_IMPLICIT_CONTEXT)
7235 /* pTHX_ magic can't cope with varargs, so this is a no-context
7236 * version of the main function, (which may itself be aliased to us).
7237 * Don't access this version directly.
7241 Perl_newSVpvf_nocontext(const char* pat, ...)
7246 va_start(args, pat);
7247 sv = vnewSVpvf(pat, &args);
7254 =for apidoc newSVpvf
7256 Creates a new SV and initializes it with the string formatted like
7263 Perl_newSVpvf(pTHX_ const char* pat, ...)
7267 va_start(args, pat);
7268 sv = vnewSVpvf(pat, &args);
7273 /* backend for newSVpvf() and newSVpvf_nocontext() */
7276 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7281 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7288 Creates a new SV and copies a floating point value into it.
7289 The reference count for the SV is set to 1.
7295 Perl_newSVnv(pTHX_ NV n)
7308 Creates a new SV and copies an integer into it. The reference count for the
7315 Perl_newSViv(pTHX_ IV i)
7328 Creates a new SV and copies an unsigned integer into it.
7329 The reference count for the SV is set to 1.
7335 Perl_newSVuv(pTHX_ UV u)
7346 =for apidoc newSV_type
7348 Creates a new SV, of the type specified. The reference count for the new SV
7355 Perl_newSV_type(pTHX_ svtype type)
7360 sv_upgrade(sv, type);
7365 =for apidoc newRV_noinc
7367 Creates an RV wrapper for an SV. The reference count for the original
7368 SV is B<not> incremented.
7374 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7377 register SV *sv = newSV_type(SVt_IV);
7379 SvRV_set(sv, tmpRef);
7384 /* newRV_inc is the official function name to use now.
7385 * newRV_inc is in fact #defined to newRV in sv.h
7389 Perl_newRV(pTHX_ SV *sv)
7392 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7398 Creates a new SV which is an exact duplicate of the original SV.
7405 Perl_newSVsv(pTHX_ register SV *old)
7412 if (SvTYPE(old) == SVTYPEMASK) {
7413 if (ckWARN_d(WARN_INTERNAL))
7414 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7418 /* SV_GMAGIC is the default for sv_setv()
7419 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7420 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7421 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7426 =for apidoc sv_reset
7428 Underlying implementation for the C<reset> Perl function.
7429 Note that the perl-level function is vaguely deprecated.
7435 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7438 char todo[PERL_UCHAR_MAX+1];
7443 if (!*s) { /* reset ?? searches */
7444 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7446 const U32 count = mg->mg_len / sizeof(PMOP**);
7447 PMOP **pmp = (PMOP**) mg->mg_ptr;
7448 PMOP *const *const end = pmp + count;
7452 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7454 (*pmp)->op_pmflags &= ~PMf_USED;
7462 /* reset variables */
7464 if (!HvARRAY(stash))
7467 Zero(todo, 256, char);
7470 I32 i = (unsigned char)*s;
7474 max = (unsigned char)*s++;
7475 for ( ; i <= max; i++) {
7478 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7480 for (entry = HvARRAY(stash)[i];
7482 entry = HeNEXT(entry))
7487 if (!todo[(U8)*HeKEY(entry)])
7489 gv = (GV*)HeVAL(entry);
7492 if (SvTHINKFIRST(sv)) {
7493 if (!SvREADONLY(sv) && SvROK(sv))
7495 /* XXX Is this continue a bug? Why should THINKFIRST
7496 exempt us from resetting arrays and hashes? */
7500 if (SvTYPE(sv) >= SVt_PV) {
7502 if (SvPVX_const(sv) != NULL)
7510 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7512 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7515 # if defined(USE_ENVIRON_ARRAY)
7518 # endif /* USE_ENVIRON_ARRAY */
7529 Using various gambits, try to get an IO from an SV: the IO slot if its a
7530 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7531 named after the PV if we're a string.
7537 Perl_sv_2io(pTHX_ SV *sv)
7542 switch (SvTYPE(sv)) {
7550 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7554 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7556 return sv_2io(SvRV(sv));
7557 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7563 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7572 Using various gambits, try to get a CV from an SV; in addition, try if
7573 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7574 The flags in C<lref> are passed to sv_fetchsv.
7580 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7591 switch (SvTYPE(sv)) {
7610 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7611 tryAMAGICunDEREF(to_cv);
7614 if (SvTYPE(sv) == SVt_PVCV) {
7623 Perl_croak(aTHX_ "Not a subroutine reference");
7628 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7634 /* Some flags to gv_fetchsv mean don't really create the GV */
7635 if (SvTYPE(gv) != SVt_PVGV) {
7641 if (lref && !GvCVu(gv)) {
7645 gv_efullname3(tmpsv, gv, NULL);
7646 /* XXX this is probably not what they think they're getting.
7647 * It has the same effect as "sub name;", i.e. just a forward
7649 newSUB(start_subparse(FALSE, 0),
7650 newSVOP(OP_CONST, 0, tmpsv),
7654 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7664 Returns true if the SV has a true value by Perl's rules.
7665 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7666 instead use an in-line version.
7672 Perl_sv_true(pTHX_ register SV *sv)
7677 register const XPV* const tXpv = (XPV*)SvANY(sv);
7679 (tXpv->xpv_cur > 1 ||
7680 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7687 return SvIVX(sv) != 0;
7690 return SvNVX(sv) != 0.0;
7692 return sv_2bool(sv);
7698 =for apidoc sv_pvn_force
7700 Get a sensible string out of the SV somehow.
7701 A private implementation of the C<SvPV_force> macro for compilers which
7702 can't cope with complex macro expressions. Always use the macro instead.
7704 =for apidoc sv_pvn_force_flags
7706 Get a sensible string out of the SV somehow.
7707 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7708 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7709 implemented in terms of this function.
7710 You normally want to use the various wrapper macros instead: see
7711 C<SvPV_force> and C<SvPV_force_nomg>
7717 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7720 if (SvTHINKFIRST(sv) && !SvROK(sv))
7721 sv_force_normal_flags(sv, 0);
7731 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7732 const char * const ref = sv_reftype(sv,0);
7734 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7735 ref, OP_NAME(PL_op));
7737 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7739 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7740 || isGV_with_GP(sv))
7741 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7743 s = sv_2pv_flags(sv, &len, flags);
7747 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7750 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7751 SvGROW(sv, len + 1);
7752 Move(s,SvPVX(sv),len,char);
7754 SvPVX(sv)[len] = '\0';
7757 SvPOK_on(sv); /* validate pointer */
7759 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7760 PTR2UV(sv),SvPVX_const(sv)));
7763 return SvPVX_mutable(sv);
7767 =for apidoc sv_pvbyten_force
7769 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7775 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7777 sv_pvn_force(sv,lp);
7778 sv_utf8_downgrade(sv,0);
7784 =for apidoc sv_pvutf8n_force
7786 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7792 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7794 sv_pvn_force(sv,lp);
7795 sv_utf8_upgrade(sv);
7801 =for apidoc sv_reftype
7803 Returns a string describing what the SV is a reference to.
7809 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7811 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7812 inside return suggests a const propagation bug in g++. */
7813 if (ob && SvOBJECT(sv)) {
7814 char * const name = HvNAME_get(SvSTASH(sv));
7815 return name ? name : (char *) "__ANON__";
7818 switch (SvTYPE(sv)) {
7833 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7834 /* tied lvalues should appear to be
7835 * scalars for backwards compatitbility */
7836 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7837 ? "SCALAR" : "LVALUE");
7838 case SVt_PVAV: return "ARRAY";
7839 case SVt_PVHV: return "HASH";
7840 case SVt_PVCV: return "CODE";
7841 case SVt_PVGV: return "GLOB";
7842 case SVt_PVFM: return "FORMAT";
7843 case SVt_PVIO: return "IO";
7844 case SVt_BIND: return "BIND";
7845 case SVt_REGEXP: return "REGEXP"; /* FIXME? to "REGEXP" */
7846 default: return "UNKNOWN";
7852 =for apidoc sv_isobject
7854 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7855 object. If the SV is not an RV, or if the object is not blessed, then this
7862 Perl_sv_isobject(pTHX_ SV *sv)
7878 Returns a boolean indicating whether the SV is blessed into the specified
7879 class. This does not check for subtypes; use C<sv_derived_from> to verify
7880 an inheritance relationship.
7886 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7897 hvname = HvNAME_get(SvSTASH(sv));
7901 return strEQ(hvname, name);
7907 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7908 it will be upgraded to one. If C<classname> is non-null then the new SV will
7909 be blessed in the specified package. The new SV is returned and its
7910 reference count is 1.
7916 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7923 SV_CHECK_THINKFIRST_COW_DROP(rv);
7924 (void)SvAMAGIC_off(rv);
7926 if (SvTYPE(rv) >= SVt_PVMG) {
7927 const U32 refcnt = SvREFCNT(rv);
7931 SvREFCNT(rv) = refcnt;
7933 sv_upgrade(rv, SVt_IV);
7934 } else if (SvROK(rv)) {
7935 SvREFCNT_dec(SvRV(rv));
7937 prepare_SV_for_RV(rv);
7945 HV* const stash = gv_stashpv(classname, GV_ADD);
7946 (void)sv_bless(rv, stash);
7952 =for apidoc sv_setref_pv
7954 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7955 argument will be upgraded to an RV. That RV will be modified to point to
7956 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7957 into the SV. The C<classname> argument indicates the package for the
7958 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7959 will have a reference count of 1, and the RV will be returned.
7961 Do not use with other Perl types such as HV, AV, SV, CV, because those
7962 objects will become corrupted by the pointer copy process.
7964 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7970 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7974 sv_setsv(rv, &PL_sv_undef);
7978 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
7983 =for apidoc sv_setref_iv
7985 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7986 argument will be upgraded to an RV. That RV will be modified to point to
7987 the new SV. The C<classname> argument indicates the package for the
7988 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7989 will have a reference count of 1, and the RV will be returned.
7995 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
7997 sv_setiv(newSVrv(rv,classname), iv);
8002 =for apidoc sv_setref_uv
8004 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8005 argument will be upgraded to an RV. That RV will be modified to point to
8006 the new SV. The C<classname> argument indicates the package for the
8007 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8008 will have a reference count of 1, and the RV will be returned.
8014 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8016 sv_setuv(newSVrv(rv,classname), uv);
8021 =for apidoc sv_setref_nv
8023 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8024 argument will be upgraded to an RV. That RV will be modified to point to
8025 the new SV. The C<classname> argument indicates the package for the
8026 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8027 will have a reference count of 1, and the RV will be returned.
8033 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8035 sv_setnv(newSVrv(rv,classname), nv);
8040 =for apidoc sv_setref_pvn
8042 Copies a string into a new SV, optionally blessing the SV. The length of the
8043 string must be specified with C<n>. The C<rv> argument will be upgraded to
8044 an RV. That RV will be modified to point to the new SV. The C<classname>
8045 argument indicates the package for the blessing. Set C<classname> to
8046 C<NULL> to avoid the blessing. The new SV will have a reference count
8047 of 1, and the RV will be returned.
8049 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8055 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8057 sv_setpvn(newSVrv(rv,classname), pv, n);
8062 =for apidoc sv_bless
8064 Blesses an SV into a specified package. The SV must be an RV. The package
8065 must be designated by its stash (see C<gv_stashpv()>). The reference count
8066 of the SV is unaffected.
8072 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8077 Perl_croak(aTHX_ "Can't bless non-reference value");
8079 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8080 if (SvIsCOW(tmpRef))
8081 sv_force_normal_flags(tmpRef, 0);
8082 if (SvREADONLY(tmpRef))
8083 Perl_croak(aTHX_ PL_no_modify);
8084 if (SvOBJECT(tmpRef)) {
8085 if (SvTYPE(tmpRef) != SVt_PVIO)
8087 SvREFCNT_dec(SvSTASH(tmpRef));
8090 SvOBJECT_on(tmpRef);
8091 if (SvTYPE(tmpRef) != SVt_PVIO)
8093 SvUPGRADE(tmpRef, SVt_PVMG);
8094 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8099 (void)SvAMAGIC_off(sv);
8101 if(SvSMAGICAL(tmpRef))
8102 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8110 /* Downgrades a PVGV to a PVMG.
8114 S_sv_unglob(pTHX_ SV *sv)
8119 SV * const temp = sv_newmortal();
8121 assert(SvTYPE(sv) == SVt_PVGV);
8123 gv_efullname3(temp, (GV *) sv, "*");
8126 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8127 mro_method_changed_in(stash);
8131 sv_del_backref((SV*)GvSTASH(sv), sv);
8135 if (GvNAME_HEK(sv)) {
8136 unshare_hek(GvNAME_HEK(sv));
8138 isGV_with_GP_off(sv);
8140 /* need to keep SvANY(sv) in the right arena */
8141 xpvmg = new_XPVMG();
8142 StructCopy(SvANY(sv), xpvmg, XPVMG);
8143 del_XPVGV(SvANY(sv));
8146 SvFLAGS(sv) &= ~SVTYPEMASK;
8147 SvFLAGS(sv) |= SVt_PVMG;
8149 /* Intentionally not calling any local SET magic, as this isn't so much a
8150 set operation as merely an internal storage change. */
8151 sv_setsv_flags(sv, temp, 0);
8155 =for apidoc sv_unref_flags
8157 Unsets the RV status of the SV, and decrements the reference count of
8158 whatever was being referenced by the RV. This can almost be thought of
8159 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8160 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8161 (otherwise the decrementing is conditional on the reference count being
8162 different from one or the reference being a readonly SV).
8169 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8171 SV* const target = SvRV(ref);
8173 if (SvWEAKREF(ref)) {
8174 sv_del_backref(target, ref);
8176 SvRV_set(ref, NULL);
8179 SvRV_set(ref, NULL);
8181 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8182 assigned to as BEGIN {$a = \"Foo"} will fail. */
8183 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8184 SvREFCNT_dec(target);
8185 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8186 sv_2mortal(target); /* Schedule for freeing later */
8190 =for apidoc sv_untaint
8192 Untaint an SV. Use C<SvTAINTED_off> instead.
8197 Perl_sv_untaint(pTHX_ SV *sv)
8199 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8200 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8207 =for apidoc sv_tainted
8209 Test an SV for taintedness. Use C<SvTAINTED> instead.
8214 Perl_sv_tainted(pTHX_ SV *sv)
8216 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8217 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8218 if (mg && (mg->mg_len & 1) )
8225 =for apidoc sv_setpviv
8227 Copies an integer into the given SV, also updating its string value.
8228 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8234 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8236 char buf[TYPE_CHARS(UV)];
8238 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8240 sv_setpvn(sv, ptr, ebuf - ptr);
8244 =for apidoc sv_setpviv_mg
8246 Like C<sv_setpviv>, but also handles 'set' magic.
8252 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8258 #if defined(PERL_IMPLICIT_CONTEXT)
8260 /* pTHX_ magic can't cope with varargs, so this is a no-context
8261 * version of the main function, (which may itself be aliased to us).
8262 * Don't access this version directly.
8266 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8270 va_start(args, pat);
8271 sv_vsetpvf(sv, pat, &args);
8275 /* pTHX_ magic can't cope with varargs, so this is a no-context
8276 * version of the main function, (which may itself be aliased to us).
8277 * Don't access this version directly.
8281 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8285 va_start(args, pat);
8286 sv_vsetpvf_mg(sv, pat, &args);
8292 =for apidoc sv_setpvf
8294 Works like C<sv_catpvf> but copies the text into the SV instead of
8295 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8301 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8304 va_start(args, pat);
8305 sv_vsetpvf(sv, pat, &args);
8310 =for apidoc sv_vsetpvf
8312 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8313 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8315 Usually used via its frontend C<sv_setpvf>.
8321 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8323 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8327 =for apidoc sv_setpvf_mg
8329 Like C<sv_setpvf>, but also handles 'set' magic.
8335 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8338 va_start(args, pat);
8339 sv_vsetpvf_mg(sv, pat, &args);
8344 =for apidoc sv_vsetpvf_mg
8346 Like C<sv_vsetpvf>, but also handles 'set' magic.
8348 Usually used via its frontend C<sv_setpvf_mg>.
8354 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8356 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8360 #if defined(PERL_IMPLICIT_CONTEXT)
8362 /* pTHX_ magic can't cope with varargs, so this is a no-context
8363 * version of the main function, (which may itself be aliased to us).
8364 * Don't access this version directly.
8368 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8372 va_start(args, pat);
8373 sv_vcatpvf(sv, pat, &args);
8377 /* pTHX_ magic can't cope with varargs, so this is a no-context
8378 * version of the main function, (which may itself be aliased to us).
8379 * Don't access this version directly.
8383 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8387 va_start(args, pat);
8388 sv_vcatpvf_mg(sv, pat, &args);
8394 =for apidoc sv_catpvf
8396 Processes its arguments like C<sprintf> and appends the formatted
8397 output to an SV. If the appended data contains "wide" characters
8398 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8399 and characters >255 formatted with %c), the original SV might get
8400 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8401 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8402 valid UTF-8; if the original SV was bytes, the pattern should be too.
8407 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8410 va_start(args, pat);
8411 sv_vcatpvf(sv, pat, &args);
8416 =for apidoc sv_vcatpvf
8418 Processes its arguments like C<vsprintf> and appends the formatted output
8419 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8421 Usually used via its frontend C<sv_catpvf>.
8427 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8429 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8433 =for apidoc sv_catpvf_mg
8435 Like C<sv_catpvf>, but also handles 'set' magic.
8441 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8444 va_start(args, pat);
8445 sv_vcatpvf_mg(sv, pat, &args);
8450 =for apidoc sv_vcatpvf_mg
8452 Like C<sv_vcatpvf>, but also handles 'set' magic.
8454 Usually used via its frontend C<sv_catpvf_mg>.
8460 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8462 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8467 =for apidoc sv_vsetpvfn
8469 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8472 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8478 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8480 sv_setpvn(sv, "", 0);
8481 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8485 S_expect_number(pTHX_ char** pattern)
8489 switch (**pattern) {
8490 case '1': case '2': case '3':
8491 case '4': case '5': case '6':
8492 case '7': case '8': case '9':
8493 var = *(*pattern)++ - '0';
8494 while (isDIGIT(**pattern)) {
8495 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8497 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8505 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8507 const int neg = nv < 0;
8516 if (uv & 1 && uv == nv)
8517 uv--; /* Round to even */
8519 const unsigned dig = uv % 10;
8532 =for apidoc sv_vcatpvfn
8534 Processes its arguments like C<vsprintf> and appends the formatted output
8535 to an SV. Uses an array of SVs if the C style variable argument list is
8536 missing (NULL). When running with taint checks enabled, indicates via
8537 C<maybe_tainted> if results are untrustworthy (often due to the use of
8540 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8546 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8547 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8548 vec_utf8 = DO_UTF8(vecsv);
8550 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8553 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8561 static const char nullstr[] = "(null)";
8563 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8564 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8566 /* Times 4: a decimal digit takes more than 3 binary digits.
8567 * NV_DIG: mantissa takes than many decimal digits.
8568 * Plus 32: Playing safe. */
8569 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8570 /* large enough for "%#.#f" --chip */
8571 /* what about long double NVs? --jhi */
8573 PERL_UNUSED_ARG(maybe_tainted);
8575 /* no matter what, this is a string now */
8576 (void)SvPV_force(sv, origlen);
8578 /* special-case "", "%s", and "%-p" (SVf - see below) */
8581 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8583 const char * const s = va_arg(*args, char*);
8584 sv_catpv(sv, s ? s : nullstr);
8586 else if (svix < svmax) {
8587 sv_catsv(sv, *svargs);
8591 if (args && patlen == 3 && pat[0] == '%' &&
8592 pat[1] == '-' && pat[2] == 'p') {
8593 argsv = (SV*)va_arg(*args, void*);
8594 sv_catsv(sv, argsv);
8598 #ifndef USE_LONG_DOUBLE
8599 /* special-case "%.<number>[gf]" */
8600 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8601 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8602 unsigned digits = 0;
8606 while (*pp >= '0' && *pp <= '9')
8607 digits = 10 * digits + (*pp++ - '0');
8608 if (pp - pat == (int)patlen - 1) {
8616 /* Add check for digits != 0 because it seems that some
8617 gconverts are buggy in this case, and we don't yet have
8618 a Configure test for this. */
8619 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8620 /* 0, point, slack */
8621 Gconvert(nv, (int)digits, 0, ebuf);
8623 if (*ebuf) /* May return an empty string for digits==0 */
8626 } else if (!digits) {
8629 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8630 sv_catpvn(sv, p, l);
8636 #endif /* !USE_LONG_DOUBLE */
8638 if (!args && svix < svmax && DO_UTF8(*svargs))
8641 patend = (char*)pat + patlen;
8642 for (p = (char*)pat; p < patend; p = q) {
8645 bool vectorize = FALSE;
8646 bool vectorarg = FALSE;
8647 bool vec_utf8 = FALSE;
8653 bool has_precis = FALSE;
8655 const I32 osvix = svix;
8656 bool is_utf8 = FALSE; /* is this item utf8? */
8657 #ifdef HAS_LDBL_SPRINTF_BUG
8658 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8659 with sfio - Allen <allens@cpan.org> */
8660 bool fix_ldbl_sprintf_bug = FALSE;
8664 U8 utf8buf[UTF8_MAXBYTES+1];
8665 STRLEN esignlen = 0;
8667 const char *eptr = NULL;
8670 const U8 *vecstr = NULL;
8677 /* we need a long double target in case HAS_LONG_DOUBLE but
8680 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8688 const char *dotstr = ".";
8689 STRLEN dotstrlen = 1;
8690 I32 efix = 0; /* explicit format parameter index */
8691 I32 ewix = 0; /* explicit width index */
8692 I32 epix = 0; /* explicit precision index */
8693 I32 evix = 0; /* explicit vector index */
8694 bool asterisk = FALSE;
8696 /* echo everything up to the next format specification */
8697 for (q = p; q < patend && *q != '%'; ++q) ;
8699 if (has_utf8 && !pat_utf8)
8700 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8702 sv_catpvn(sv, p, q - p);
8709 We allow format specification elements in this order:
8710 \d+\$ explicit format parameter index
8712 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8713 0 flag (as above): repeated to allow "v02"
8714 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8715 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8717 [%bcdefginopsuxDFOUX] format (mandatory)
8722 As of perl5.9.3, printf format checking is on by default.
8723 Internally, perl uses %p formats to provide an escape to
8724 some extended formatting. This block deals with those
8725 extensions: if it does not match, (char*)q is reset and
8726 the normal format processing code is used.
8728 Currently defined extensions are:
8729 %p include pointer address (standard)
8730 %-p (SVf) include an SV (previously %_)
8731 %-<num>p include an SV with precision <num>
8732 %<num>p reserved for future extensions
8734 Robin Barker 2005-07-14
8736 %1p (VDf) removed. RMB 2007-10-19
8743 n = expect_number(&q);
8750 argsv = (SV*)va_arg(*args, void*);
8751 eptr = SvPV_const(argsv, elen);
8757 if (ckWARN_d(WARN_INTERNAL))
8758 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8759 "internal %%<num>p might conflict with future printf extensions");
8765 if ( (width = expect_number(&q)) ) {
8780 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8809 if ( (ewix = expect_number(&q)) )
8818 if ((vectorarg = asterisk)) {
8831 width = expect_number(&q);
8837 vecsv = va_arg(*args, SV*);
8839 vecsv = (evix > 0 && evix <= svmax)
8840 ? svargs[evix-1] : &PL_sv_undef;
8842 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8844 dotstr = SvPV_const(vecsv, dotstrlen);
8845 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8846 bad with tied or overloaded values that return UTF8. */
8849 else if (has_utf8) {
8850 vecsv = sv_mortalcopy(vecsv);
8851 sv_utf8_upgrade(vecsv);
8852 dotstr = SvPV_const(vecsv, dotstrlen);
8859 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8860 vecsv = svargs[efix ? efix-1 : svix++];
8861 vecstr = (U8*)SvPV_const(vecsv,veclen);
8862 vec_utf8 = DO_UTF8(vecsv);
8864 /* if this is a version object, we need to convert
8865 * back into v-string notation and then let the
8866 * vectorize happen normally
8868 if (sv_derived_from(vecsv, "version")) {
8869 char *version = savesvpv(vecsv);
8870 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8871 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8872 "vector argument not supported with alpha versions");
8875 vecsv = sv_newmortal();
8876 scan_vstring(version, version + veclen, vecsv);
8877 vecstr = (U8*)SvPV_const(vecsv, veclen);
8878 vec_utf8 = DO_UTF8(vecsv);
8890 i = va_arg(*args, int);
8892 i = (ewix ? ewix <= svmax : svix < svmax) ?
8893 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8895 width = (i < 0) ? -i : i;
8905 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8907 /* XXX: todo, support specified precision parameter */
8911 i = va_arg(*args, int);
8913 i = (ewix ? ewix <= svmax : svix < svmax)
8914 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8916 has_precis = !(i < 0);
8921 precis = precis * 10 + (*q++ - '0');
8930 case 'I': /* Ix, I32x, and I64x */
8932 if (q[1] == '6' && q[2] == '4') {
8938 if (q[1] == '3' && q[2] == '2') {
8948 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8959 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8960 if (*(q + 1) == 'l') { /* lld, llf */
8986 if (!vectorize && !args) {
8988 const I32 i = efix-1;
8989 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
8991 argsv = (svix >= 0 && svix < svmax)
8992 ? svargs[svix++] : &PL_sv_undef;
9003 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9005 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9007 eptr = (char*)utf8buf;
9008 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9022 eptr = va_arg(*args, char*);
9024 #ifdef MACOS_TRADITIONAL
9025 /* On MacOS, %#s format is used for Pascal strings */
9030 elen = strlen(eptr);
9032 eptr = (char *)nullstr;
9033 elen = sizeof nullstr - 1;
9037 eptr = SvPV_const(argsv, elen);
9038 if (DO_UTF8(argsv)) {
9039 I32 old_precis = precis;
9040 if (has_precis && precis < elen) {
9042 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9045 if (width) { /* fudge width (can't fudge elen) */
9046 if (has_precis && precis < elen)
9047 width += precis - old_precis;
9049 width += elen - sv_len_utf8(argsv);
9056 if (has_precis && elen > precis)
9063 if (alt || vectorize)
9065 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9086 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9095 esignbuf[esignlen++] = plus;
9099 case 'h': iv = (short)va_arg(*args, int); break;
9100 case 'l': iv = va_arg(*args, long); break;
9101 case 'V': iv = va_arg(*args, IV); break;
9102 default: iv = va_arg(*args, int); break;
9104 case 'q': iv = va_arg(*args, Quad_t); break;
9109 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9111 case 'h': iv = (short)tiv; break;
9112 case 'l': iv = (long)tiv; break;
9114 default: iv = tiv; break;
9116 case 'q': iv = (Quad_t)tiv; break;
9120 if ( !vectorize ) /* we already set uv above */
9125 esignbuf[esignlen++] = plus;
9129 esignbuf[esignlen++] = '-';
9173 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9184 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9185 case 'l': uv = va_arg(*args, unsigned long); break;
9186 case 'V': uv = va_arg(*args, UV); break;
9187 default: uv = va_arg(*args, unsigned); break;
9189 case 'q': uv = va_arg(*args, Uquad_t); break;
9194 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9196 case 'h': uv = (unsigned short)tuv; break;
9197 case 'l': uv = (unsigned long)tuv; break;
9199 default: uv = tuv; break;
9201 case 'q': uv = (Uquad_t)tuv; break;
9208 char *ptr = ebuf + sizeof ebuf;
9209 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9215 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9221 esignbuf[esignlen++] = '0';
9222 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9230 if (alt && *ptr != '0')
9239 esignbuf[esignlen++] = '0';
9240 esignbuf[esignlen++] = c;
9243 default: /* it had better be ten or less */
9247 } while (uv /= base);
9250 elen = (ebuf + sizeof ebuf) - ptr;
9254 zeros = precis - elen;
9255 else if (precis == 0 && elen == 1 && *eptr == '0'
9256 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9259 /* a precision nullifies the 0 flag. */
9266 /* FLOATING POINT */
9269 c = 'f'; /* maybe %F isn't supported here */
9277 /* This is evil, but floating point is even more evil */
9279 /* for SV-style calling, we can only get NV
9280 for C-style calling, we assume %f is double;
9281 for simplicity we allow any of %Lf, %llf, %qf for long double
9285 #if defined(USE_LONG_DOUBLE)
9289 /* [perl #20339] - we should accept and ignore %lf rather than die */
9293 #if defined(USE_LONG_DOUBLE)
9294 intsize = args ? 0 : 'q';
9298 #if defined(HAS_LONG_DOUBLE)
9307 /* now we need (long double) if intsize == 'q', else (double) */
9309 #if LONG_DOUBLESIZE > DOUBLESIZE
9311 va_arg(*args, long double) :
9312 va_arg(*args, double)
9314 va_arg(*args, double)
9319 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9320 else. frexp() has some unspecified behaviour for those three */
9321 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9323 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9324 will cast our (long double) to (double) */
9325 (void)Perl_frexp(nv, &i);
9326 if (i == PERL_INT_MIN)
9327 Perl_die(aTHX_ "panic: frexp");
9329 need = BIT_DIGITS(i);
9331 need += has_precis ? precis : 6; /* known default */
9336 #ifdef HAS_LDBL_SPRINTF_BUG
9337 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9338 with sfio - Allen <allens@cpan.org> */
9341 # define MY_DBL_MAX DBL_MAX
9342 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9343 # if DOUBLESIZE >= 8
9344 # define MY_DBL_MAX 1.7976931348623157E+308L
9346 # define MY_DBL_MAX 3.40282347E+38L
9350 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9351 # define MY_DBL_MAX_BUG 1L
9353 # define MY_DBL_MAX_BUG MY_DBL_MAX
9357 # define MY_DBL_MIN DBL_MIN
9358 # else /* XXX guessing! -Allen */
9359 # if DOUBLESIZE >= 8
9360 # define MY_DBL_MIN 2.2250738585072014E-308L
9362 # define MY_DBL_MIN 1.17549435E-38L
9366 if ((intsize == 'q') && (c == 'f') &&
9367 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9369 /* it's going to be short enough that
9370 * long double precision is not needed */
9372 if ((nv <= 0L) && (nv >= -0L))
9373 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9375 /* would use Perl_fp_class as a double-check but not
9376 * functional on IRIX - see perl.h comments */
9378 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9379 /* It's within the range that a double can represent */
9380 #if defined(DBL_MAX) && !defined(DBL_MIN)
9381 if ((nv >= ((long double)1/DBL_MAX)) ||
9382 (nv <= (-(long double)1/DBL_MAX)))
9384 fix_ldbl_sprintf_bug = TRUE;
9387 if (fix_ldbl_sprintf_bug == TRUE) {
9397 # undef MY_DBL_MAX_BUG
9400 #endif /* HAS_LDBL_SPRINTF_BUG */
9402 need += 20; /* fudge factor */
9403 if (PL_efloatsize < need) {
9404 Safefree(PL_efloatbuf);
9405 PL_efloatsize = need + 20; /* more fudge */
9406 Newx(PL_efloatbuf, PL_efloatsize, char);
9407 PL_efloatbuf[0] = '\0';
9410 if ( !(width || left || plus || alt) && fill != '0'
9411 && has_precis && intsize != 'q' ) { /* Shortcuts */
9412 /* See earlier comment about buggy Gconvert when digits,
9414 if ( c == 'g' && precis) {
9415 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9416 /* May return an empty string for digits==0 */
9417 if (*PL_efloatbuf) {
9418 elen = strlen(PL_efloatbuf);
9419 goto float_converted;
9421 } else if ( c == 'f' && !precis) {
9422 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9427 char *ptr = ebuf + sizeof ebuf;
9430 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9431 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9432 if (intsize == 'q') {
9433 /* Copy the one or more characters in a long double
9434 * format before the 'base' ([efgEFG]) character to
9435 * the format string. */
9436 static char const prifldbl[] = PERL_PRIfldbl;
9437 char const *p = prifldbl + sizeof(prifldbl) - 3;
9438 while (p >= prifldbl) { *--ptr = *p--; }
9443 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9448 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9460 /* No taint. Otherwise we are in the strange situation
9461 * where printf() taints but print($float) doesn't.
9463 #if defined(HAS_LONG_DOUBLE)
9464 elen = ((intsize == 'q')
9465 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9466 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9468 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9472 eptr = PL_efloatbuf;
9480 i = SvCUR(sv) - origlen;
9483 case 'h': *(va_arg(*args, short*)) = i; break;
9484 default: *(va_arg(*args, int*)) = i; break;
9485 case 'l': *(va_arg(*args, long*)) = i; break;
9486 case 'V': *(va_arg(*args, IV*)) = i; break;
9488 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9493 sv_setuv_mg(argsv, (UV)i);
9494 continue; /* not "break" */
9501 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9502 && ckWARN(WARN_PRINTF))
9504 SV * const msg = sv_newmortal();
9505 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9506 (PL_op->op_type == OP_PRTF) ? "" : "s");
9509 Perl_sv_catpvf(aTHX_ msg,
9510 "\"%%%c\"", c & 0xFF);
9512 Perl_sv_catpvf(aTHX_ msg,
9513 "\"%%\\%03"UVof"\"",
9516 sv_catpvs(msg, "end of string");
9517 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9520 /* output mangled stuff ... */
9526 /* ... right here, because formatting flags should not apply */
9527 SvGROW(sv, SvCUR(sv) + elen + 1);
9529 Copy(eptr, p, elen, char);
9532 SvCUR_set(sv, p - SvPVX_const(sv));
9534 continue; /* not "break" */
9537 if (is_utf8 != has_utf8) {
9540 sv_utf8_upgrade(sv);
9543 const STRLEN old_elen = elen;
9544 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9545 sv_utf8_upgrade(nsv);
9546 eptr = SvPVX_const(nsv);
9549 if (width) { /* fudge width (can't fudge elen) */
9550 width += elen - old_elen;
9556 have = esignlen + zeros + elen;
9558 Perl_croak_nocontext(PL_memory_wrap);
9560 need = (have > width ? have : width);
9563 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9564 Perl_croak_nocontext(PL_memory_wrap);
9565 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9567 if (esignlen && fill == '0') {
9569 for (i = 0; i < (int)esignlen; i++)
9573 memset(p, fill, gap);
9576 if (esignlen && fill != '0') {
9578 for (i = 0; i < (int)esignlen; i++)
9583 for (i = zeros; i; i--)
9587 Copy(eptr, p, elen, char);
9591 memset(p, ' ', gap);
9596 Copy(dotstr, p, dotstrlen, char);
9600 vectorize = FALSE; /* done iterating over vecstr */
9607 SvCUR_set(sv, p - SvPVX_const(sv));
9615 /* =========================================================================
9617 =head1 Cloning an interpreter
9619 All the macros and functions in this section are for the private use of
9620 the main function, perl_clone().
9622 The foo_dup() functions make an exact copy of an existing foo thingy.
9623 During the course of a cloning, a hash table is used to map old addresses
9624 to new addresses. The table is created and manipulated with the
9625 ptr_table_* functions.
9629 ============================================================================*/
9632 #if defined(USE_ITHREADS)
9634 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9635 #ifndef GpREFCNT_inc
9636 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9640 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9641 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9642 If this changes, please unmerge ss_dup. */
9643 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9644 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9645 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9646 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9647 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9648 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9649 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9650 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9651 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9652 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9653 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9654 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9655 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9656 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9658 /* clone a parser */
9661 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9668 /* look for it in the table first */
9669 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9673 /* create anew and remember what it is */
9674 Newxz(parser, 1, yy_parser);
9675 ptr_table_store(PL_ptr_table, proto, parser);
9677 parser->yyerrstatus = 0;
9678 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9680 /* XXX these not yet duped */
9681 parser->old_parser = NULL;
9682 parser->stack = NULL;
9684 parser->stack_size = 0;
9685 /* XXX parser->stack->state = 0; */
9687 /* XXX eventually, just Copy() most of the parser struct ? */
9689 parser->lex_brackets = proto->lex_brackets;
9690 parser->lex_casemods = proto->lex_casemods;
9691 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9692 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9693 parser->lex_casestack = savepvn(proto->lex_casestack,
9694 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9695 parser->lex_defer = proto->lex_defer;
9696 parser->lex_dojoin = proto->lex_dojoin;
9697 parser->lex_expect = proto->lex_expect;
9698 parser->lex_formbrack = proto->lex_formbrack;
9699 parser->lex_inpat = proto->lex_inpat;
9700 parser->lex_inwhat = proto->lex_inwhat;
9701 parser->lex_op = proto->lex_op;
9702 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9703 parser->lex_starts = proto->lex_starts;
9704 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9705 parser->multi_close = proto->multi_close;
9706 parser->multi_open = proto->multi_open;
9707 parser->multi_start = proto->multi_start;
9708 parser->multi_end = proto->multi_end;
9709 parser->pending_ident = proto->pending_ident;
9710 parser->preambled = proto->preambled;
9711 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9712 parser->linestr = sv_dup_inc(proto->linestr, param);
9713 parser->expect = proto->expect;
9714 parser->copline = proto->copline;
9715 parser->last_lop_op = proto->last_lop_op;
9716 parser->lex_state = proto->lex_state;
9717 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9718 /* rsfp_filters entries have fake IoDIRP() */
9719 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9720 parser->in_my = proto->in_my;
9721 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9722 parser->error_count = proto->error_count;
9725 parser->linestr = sv_dup_inc(proto->linestr, param);
9728 char * const ols = SvPVX(proto->linestr);
9729 char * const ls = SvPVX(parser->linestr);
9731 parser->bufptr = ls + (proto->bufptr >= ols ?
9732 proto->bufptr - ols : 0);
9733 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9734 proto->oldbufptr - ols : 0);
9735 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9736 proto->oldoldbufptr - ols : 0);
9737 parser->linestart = ls + (proto->linestart >= ols ?
9738 proto->linestart - ols : 0);
9739 parser->last_uni = ls + (proto->last_uni >= ols ?
9740 proto->last_uni - ols : 0);
9741 parser->last_lop = ls + (proto->last_lop >= ols ?
9742 proto->last_lop - ols : 0);
9744 parser->bufend = ls + SvCUR(parser->linestr);
9747 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9751 parser->endwhite = proto->endwhite;
9752 parser->faketokens = proto->faketokens;
9753 parser->lasttoke = proto->lasttoke;
9754 parser->nextwhite = proto->nextwhite;
9755 parser->realtokenstart = proto->realtokenstart;
9756 parser->skipwhite = proto->skipwhite;
9757 parser->thisclose = proto->thisclose;
9758 parser->thismad = proto->thismad;
9759 parser->thisopen = proto->thisopen;
9760 parser->thisstuff = proto->thisstuff;
9761 parser->thistoken = proto->thistoken;
9762 parser->thiswhite = proto->thiswhite;
9764 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9765 parser->curforce = proto->curforce;
9767 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9768 Copy(proto->nexttype, parser->nexttype, 5, I32);
9769 parser->nexttoke = proto->nexttoke;
9775 /* duplicate a file handle */
9778 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9782 PERL_UNUSED_ARG(type);
9785 return (PerlIO*)NULL;
9787 /* look for it in the table first */
9788 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9792 /* create anew and remember what it is */
9793 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9794 ptr_table_store(PL_ptr_table, fp, ret);
9798 /* duplicate a directory handle */
9801 Perl_dirp_dup(pTHX_ DIR *dp)
9803 PERL_UNUSED_CONTEXT;
9810 /* duplicate a typeglob */
9813 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9819 /* look for it in the table first */
9820 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9824 /* create anew and remember what it is */
9826 ptr_table_store(PL_ptr_table, gp, ret);
9829 ret->gp_refcnt = 0; /* must be before any other dups! */
9830 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9831 ret->gp_io = io_dup_inc(gp->gp_io, param);
9832 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9833 ret->gp_av = av_dup_inc(gp->gp_av, param);
9834 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9835 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9836 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9837 ret->gp_cvgen = gp->gp_cvgen;
9838 ret->gp_line = gp->gp_line;
9839 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9843 /* duplicate a chain of magic */
9846 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9848 MAGIC *mgprev = (MAGIC*)NULL;
9851 return (MAGIC*)NULL;
9852 /* look for it in the table first */
9853 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9857 for (; mg; mg = mg->mg_moremagic) {
9859 Newxz(nmg, 1, MAGIC);
9861 mgprev->mg_moremagic = nmg;
9864 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9865 nmg->mg_private = mg->mg_private;
9866 nmg->mg_type = mg->mg_type;
9867 nmg->mg_flags = mg->mg_flags;
9868 /* FIXME for plugins
9869 if (mg->mg_type == PERL_MAGIC_qr) {
9870 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9874 if(mg->mg_type == PERL_MAGIC_backref) {
9875 /* The backref AV has its reference count deliberately bumped by
9877 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9880 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9881 ? sv_dup_inc(mg->mg_obj, param)
9882 : sv_dup(mg->mg_obj, param);
9884 nmg->mg_len = mg->mg_len;
9885 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9886 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9887 if (mg->mg_len > 0) {
9888 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9889 if (mg->mg_type == PERL_MAGIC_overload_table &&
9890 AMT_AMAGIC((AMT*)mg->mg_ptr))
9892 const AMT * const amtp = (AMT*)mg->mg_ptr;
9893 AMT * const namtp = (AMT*)nmg->mg_ptr;
9895 for (i = 1; i < NofAMmeth; i++) {
9896 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9900 else if (mg->mg_len == HEf_SVKEY)
9901 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9903 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9904 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9911 #endif /* USE_ITHREADS */
9913 /* create a new pointer-mapping table */
9916 Perl_ptr_table_new(pTHX)
9919 PERL_UNUSED_CONTEXT;
9921 Newxz(tbl, 1, PTR_TBL_t);
9924 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9928 #define PTR_TABLE_HASH(ptr) \
9929 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9932 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9933 following define) and at call to new_body_inline made below in
9934 Perl_ptr_table_store()
9937 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9939 /* map an existing pointer using a table */
9941 STATIC PTR_TBL_ENT_t *
9942 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9943 PTR_TBL_ENT_t *tblent;
9944 const UV hash = PTR_TABLE_HASH(sv);
9946 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9947 for (; tblent; tblent = tblent->next) {
9948 if (tblent->oldval == sv)
9955 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9957 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9958 PERL_UNUSED_CONTEXT;
9959 return tblent ? tblent->newval : NULL;
9962 /* add a new entry to a pointer-mapping table */
9965 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9967 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9968 PERL_UNUSED_CONTEXT;
9971 tblent->newval = newsv;
9973 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9975 new_body_inline(tblent, PTE_SVSLOT);
9977 tblent->oldval = oldsv;
9978 tblent->newval = newsv;
9979 tblent->next = tbl->tbl_ary[entry];
9980 tbl->tbl_ary[entry] = tblent;
9982 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
9983 ptr_table_split(tbl);
9987 /* double the hash bucket size of an existing ptr table */
9990 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9992 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9993 const UV oldsize = tbl->tbl_max + 1;
9994 UV newsize = oldsize * 2;
9996 PERL_UNUSED_CONTEXT;
9998 Renew(ary, newsize, PTR_TBL_ENT_t*);
9999 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10000 tbl->tbl_max = --newsize;
10001 tbl->tbl_ary = ary;
10002 for (i=0; i < oldsize; i++, ary++) {
10003 PTR_TBL_ENT_t **curentp, **entp, *ent;
10006 curentp = ary + oldsize;
10007 for (entp = ary, ent = *ary; ent; ent = *entp) {
10008 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10010 ent->next = *curentp;
10020 /* remove all the entries from a ptr table */
10023 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10025 if (tbl && tbl->tbl_items) {
10026 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10027 UV riter = tbl->tbl_max;
10030 PTR_TBL_ENT_t *entry = array[riter];
10033 PTR_TBL_ENT_t * const oentry = entry;
10034 entry = entry->next;
10039 tbl->tbl_items = 0;
10043 /* clear and free a ptr table */
10046 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10051 ptr_table_clear(tbl);
10052 Safefree(tbl->tbl_ary);
10056 #if defined(USE_ITHREADS)
10059 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10062 SvRV_set(dstr, SvWEAKREF(sstr)
10063 ? sv_dup(SvRV(sstr), param)
10064 : sv_dup_inc(SvRV(sstr), param));
10067 else if (SvPVX_const(sstr)) {
10068 /* Has something there */
10070 /* Normal PV - clone whole allocated space */
10071 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10072 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10073 /* Not that normal - actually sstr is copy on write.
10074 But we are a true, independant SV, so: */
10075 SvREADONLY_off(dstr);
10080 /* Special case - not normally malloced for some reason */
10081 if (isGV_with_GP(sstr)) {
10082 /* Don't need to do anything here. */
10084 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10085 /* A "shared" PV - clone it as "shared" PV */
10087 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10091 /* Some other special case - random pointer */
10092 SvPV_set(dstr, SvPVX(sstr));
10097 /* Copy the NULL */
10098 SvPV_set(dstr, NULL);
10102 /* duplicate an SV of any type (including AV, HV etc) */
10105 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10110 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10112 /* look for it in the table first */
10113 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10117 if(param->flags & CLONEf_JOIN_IN) {
10118 /** We are joining here so we don't want do clone
10119 something that is bad **/
10120 if (SvTYPE(sstr) == SVt_PVHV) {
10121 const HEK * const hvname = HvNAME_HEK(sstr);
10123 /** don't clone stashes if they already exist **/
10124 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10128 /* create anew and remember what it is */
10131 #ifdef DEBUG_LEAKING_SCALARS
10132 dstr->sv_debug_optype = sstr->sv_debug_optype;
10133 dstr->sv_debug_line = sstr->sv_debug_line;
10134 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10135 dstr->sv_debug_cloned = 1;
10136 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10139 ptr_table_store(PL_ptr_table, sstr, dstr);
10142 SvFLAGS(dstr) = SvFLAGS(sstr);
10143 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10144 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10147 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10148 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10149 (void*)PL_watch_pvx, SvPVX_const(sstr));
10152 /* don't clone objects whose class has asked us not to */
10153 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10158 switch (SvTYPE(sstr)) {
10160 SvANY(dstr) = NULL;
10163 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10165 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10167 SvIV_set(dstr, SvIVX(sstr));
10171 SvANY(dstr) = new_XNV();
10172 SvNV_set(dstr, SvNVX(sstr));
10174 /* case SVt_BIND: */
10177 /* These are all the types that need complex bodies allocating. */
10179 const svtype sv_type = SvTYPE(sstr);
10180 const struct body_details *const sv_type_details
10181 = bodies_by_type + sv_type;
10185 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10189 if (GvUNIQUE((GV*)sstr)) {
10190 NOOP; /* Do sharing here, and fall through */
10203 assert(sv_type_details->body_size);
10204 if (sv_type_details->arena) {
10205 new_body_inline(new_body, sv_type);
10207 = (void*)((char*)new_body - sv_type_details->offset);
10209 new_body = new_NOARENA(sv_type_details);
10213 SvANY(dstr) = new_body;
10216 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10217 ((char*)SvANY(dstr)) + sv_type_details->offset,
10218 sv_type_details->copy, char);
10220 Copy(((char*)SvANY(sstr)),
10221 ((char*)SvANY(dstr)),
10222 sv_type_details->body_size + sv_type_details->offset, char);
10225 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10226 && !isGV_with_GP(dstr))
10227 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10229 /* The Copy above means that all the source (unduplicated) pointers
10230 are now in the destination. We can check the flags and the
10231 pointers in either, but it's possible that there's less cache
10232 missing by always going for the destination.
10233 FIXME - instrument and check that assumption */
10234 if (sv_type >= SVt_PVMG) {
10235 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10236 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10237 } else if (SvMAGIC(dstr))
10238 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10240 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10243 /* The cast silences a GCC warning about unhandled types. */
10244 switch ((int)sv_type) {
10254 /* FIXME for plugins */
10255 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10258 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10259 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10260 LvTARG(dstr) = dstr;
10261 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10262 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10264 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10266 if(isGV_with_GP(sstr)) {
10267 if (GvNAME_HEK(dstr))
10268 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10269 /* Don't call sv_add_backref here as it's going to be
10270 created as part of the magic cloning of the symbol
10272 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10273 at the point of this comment. */
10274 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10275 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10276 (void)GpREFCNT_inc(GvGP(dstr));
10278 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10281 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10282 if (IoOFP(dstr) == IoIFP(sstr))
10283 IoOFP(dstr) = IoIFP(dstr);
10285 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10286 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10287 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10288 /* I have no idea why fake dirp (rsfps)
10289 should be treated differently but otherwise
10290 we end up with leaks -- sky*/
10291 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10292 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10293 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10295 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10296 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10297 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10298 if (IoDIRP(dstr)) {
10299 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10302 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10305 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10306 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10307 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10310 if (AvARRAY((AV*)sstr)) {
10311 SV **dst_ary, **src_ary;
10312 SSize_t items = AvFILLp((AV*)sstr) + 1;
10314 src_ary = AvARRAY((AV*)sstr);
10315 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10316 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10317 AvARRAY((AV*)dstr) = dst_ary;
10318 AvALLOC((AV*)dstr) = dst_ary;
10319 if (AvREAL((AV*)sstr)) {
10320 while (items-- > 0)
10321 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10324 while (items-- > 0)
10325 *dst_ary++ = sv_dup(*src_ary++, param);
10327 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10328 while (items-- > 0) {
10329 *dst_ary++ = &PL_sv_undef;
10333 AvARRAY((AV*)dstr) = NULL;
10334 AvALLOC((AV*)dstr) = (SV**)NULL;
10338 if (HvARRAY((HV*)sstr)) {
10340 const bool sharekeys = !!HvSHAREKEYS(sstr);
10341 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10342 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10344 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10345 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10347 HvARRAY(dstr) = (HE**)darray;
10348 while (i <= sxhv->xhv_max) {
10349 const HE * const source = HvARRAY(sstr)[i];
10350 HvARRAY(dstr)[i] = source
10351 ? he_dup(source, sharekeys, param) : 0;
10356 const struct xpvhv_aux * const saux = HvAUX(sstr);
10357 struct xpvhv_aux * const daux = HvAUX(dstr);
10358 /* This flag isn't copied. */
10359 /* SvOOK_on(hv) attacks the IV flags. */
10360 SvFLAGS(dstr) |= SVf_OOK;
10362 hvname = saux->xhv_name;
10363 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10365 daux->xhv_riter = saux->xhv_riter;
10366 daux->xhv_eiter = saux->xhv_eiter
10367 ? he_dup(saux->xhv_eiter,
10368 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10369 daux->xhv_backreferences =
10370 saux->xhv_backreferences
10371 ? (AV*) SvREFCNT_inc(
10372 sv_dup((SV*)saux->xhv_backreferences, param))
10375 daux->xhv_mro_meta = saux->xhv_mro_meta
10376 ? mro_meta_dup(saux->xhv_mro_meta, param)
10379 /* Record stashes for possible cloning in Perl_clone(). */
10381 av_push(param->stashes, dstr);
10385 HvARRAY((HV*)dstr) = NULL;
10388 if (!(param->flags & CLONEf_COPY_STACKS)) {
10392 /* NOTE: not refcounted */
10393 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10395 if (!CvISXSUB(dstr))
10396 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10398 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10399 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10400 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10401 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10403 /* don't dup if copying back - CvGV isn't refcounted, so the
10404 * duped GV may never be freed. A bit of a hack! DAPM */
10405 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10406 NULL : gv_dup(CvGV(dstr), param) ;
10407 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10409 CvWEAKOUTSIDE(sstr)
10410 ? cv_dup( CvOUTSIDE(dstr), param)
10411 : cv_dup_inc(CvOUTSIDE(dstr), param);
10412 if (!CvISXSUB(dstr))
10413 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10419 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10425 /* duplicate a context */
10428 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10430 PERL_CONTEXT *ncxs;
10433 return (PERL_CONTEXT*)NULL;
10435 /* look for it in the table first */
10436 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10440 /* create anew and remember what it is */
10441 Newxz(ncxs, max + 1, PERL_CONTEXT);
10442 ptr_table_store(PL_ptr_table, cxs, ncxs);
10445 PERL_CONTEXT * const cx = &cxs[ix];
10446 PERL_CONTEXT * const ncx = &ncxs[ix];
10447 ncx->cx_type = cx->cx_type;
10448 if (CxTYPE(cx) == CXt_SUBST) {
10449 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10452 ncx->blk_oldsp = cx->blk_oldsp;
10453 ncx->blk_oldcop = cx->blk_oldcop;
10454 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10455 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10456 ncx->blk_oldpm = cx->blk_oldpm;
10457 ncx->blk_gimme = cx->blk_gimme;
10458 switch (CxTYPE(cx)) {
10460 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10461 ? cv_dup_inc(cx->blk_sub.cv, param)
10462 : cv_dup(cx->blk_sub.cv,param));
10463 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10464 ? av_dup_inc(cx->blk_sub.argarray, param)
10466 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10467 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10468 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10469 ncx->blk_sub.lval = cx->blk_sub.lval;
10470 ncx->blk_sub.retop = cx->blk_sub.retop;
10471 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10472 cx->blk_sub.oldcomppad);
10475 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10476 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10477 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10478 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10479 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10480 ncx->blk_eval.retop = cx->blk_eval.retop;
10483 ncx->blk_loop.label = cx->blk_loop.label;
10484 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10485 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10486 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10487 ? cx->blk_loop.iterdata
10488 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10489 ncx->blk_loop.oldcomppad
10490 = (PAD*)ptr_table_fetch(PL_ptr_table,
10491 cx->blk_loop.oldcomppad);
10492 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10493 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10494 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10495 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10496 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10499 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10500 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10501 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10502 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10503 ncx->blk_sub.retop = cx->blk_sub.retop;
10515 /* duplicate a stack info structure */
10518 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10523 return (PERL_SI*)NULL;
10525 /* look for it in the table first */
10526 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10530 /* create anew and remember what it is */
10531 Newxz(nsi, 1, PERL_SI);
10532 ptr_table_store(PL_ptr_table, si, nsi);
10534 nsi->si_stack = av_dup_inc(si->si_stack, param);
10535 nsi->si_cxix = si->si_cxix;
10536 nsi->si_cxmax = si->si_cxmax;
10537 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10538 nsi->si_type = si->si_type;
10539 nsi->si_prev = si_dup(si->si_prev, param);
10540 nsi->si_next = si_dup(si->si_next, param);
10541 nsi->si_markoff = si->si_markoff;
10546 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10547 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10548 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10549 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10550 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10551 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10552 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10553 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10554 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10555 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10556 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10557 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10558 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10559 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10562 #define pv_dup_inc(p) SAVEPV(p)
10563 #define pv_dup(p) SAVEPV(p)
10564 #define svp_dup_inc(p,pp) any_dup(p,pp)
10566 /* map any object to the new equivent - either something in the
10567 * ptr table, or something in the interpreter structure
10571 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10576 return (void*)NULL;
10578 /* look for it in the table first */
10579 ret = ptr_table_fetch(PL_ptr_table, v);
10583 /* see if it is part of the interpreter structure */
10584 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10585 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10593 /* duplicate the save stack */
10596 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10599 ANY * const ss = proto_perl->Isavestack;
10600 const I32 max = proto_perl->Isavestack_max;
10601 I32 ix = proto_perl->Isavestack_ix;
10614 void (*dptr) (void*);
10615 void (*dxptr) (pTHX_ void*);
10617 Newxz(nss, max, ANY);
10620 const I32 type = POPINT(ss,ix);
10621 TOPINT(nss,ix) = type;
10623 case SAVEt_HELEM: /* hash element */
10624 sv = (SV*)POPPTR(ss,ix);
10625 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10627 case SAVEt_ITEM: /* normal string */
10628 case SAVEt_SV: /* scalar reference */
10629 sv = (SV*)POPPTR(ss,ix);
10630 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10633 case SAVEt_MORTALIZESV:
10634 sv = (SV*)POPPTR(ss,ix);
10635 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10637 case SAVEt_SHARED_PVREF: /* char* in shared space */
10638 c = (char*)POPPTR(ss,ix);
10639 TOPPTR(nss,ix) = savesharedpv(c);
10640 ptr = POPPTR(ss,ix);
10641 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10643 case SAVEt_GENERIC_SVREF: /* generic sv */
10644 case SAVEt_SVREF: /* scalar reference */
10645 sv = (SV*)POPPTR(ss,ix);
10646 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10647 ptr = POPPTR(ss,ix);
10648 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10650 case SAVEt_HV: /* hash reference */
10651 case SAVEt_AV: /* array reference */
10652 sv = (SV*) POPPTR(ss,ix);
10653 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10655 case SAVEt_COMPPAD:
10657 sv = (SV*) POPPTR(ss,ix);
10658 TOPPTR(nss,ix) = sv_dup(sv, param);
10660 case SAVEt_INT: /* int reference */
10661 ptr = POPPTR(ss,ix);
10662 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10663 intval = (int)POPINT(ss,ix);
10664 TOPINT(nss,ix) = intval;
10666 case SAVEt_LONG: /* long reference */
10667 ptr = POPPTR(ss,ix);
10668 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10670 case SAVEt_CLEARSV:
10671 longval = (long)POPLONG(ss,ix);
10672 TOPLONG(nss,ix) = longval;
10674 case SAVEt_I32: /* I32 reference */
10675 case SAVEt_I16: /* I16 reference */
10676 case SAVEt_I8: /* I8 reference */
10677 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10678 ptr = POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10681 TOPINT(nss,ix) = i;
10683 case SAVEt_IV: /* IV reference */
10684 ptr = POPPTR(ss,ix);
10685 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10687 TOPIV(nss,ix) = iv;
10689 case SAVEt_HPTR: /* HV* reference */
10690 case SAVEt_APTR: /* AV* reference */
10691 case SAVEt_SPTR: /* SV* reference */
10692 ptr = POPPTR(ss,ix);
10693 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10694 sv = (SV*)POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = sv_dup(sv, param);
10697 case SAVEt_VPTR: /* random* reference */
10698 ptr = POPPTR(ss,ix);
10699 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10700 ptr = POPPTR(ss,ix);
10701 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10703 case SAVEt_GENERIC_PVREF: /* generic char* */
10704 case SAVEt_PPTR: /* char* reference */
10705 ptr = POPPTR(ss,ix);
10706 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10707 c = (char*)POPPTR(ss,ix);
10708 TOPPTR(nss,ix) = pv_dup(c);
10710 case SAVEt_GP: /* scalar reference */
10711 gp = (GP*)POPPTR(ss,ix);
10712 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10713 (void)GpREFCNT_inc(gp);
10714 gv = (GV*)POPPTR(ss,ix);
10715 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10718 ptr = POPPTR(ss,ix);
10719 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10720 /* these are assumed to be refcounted properly */
10722 switch (((OP*)ptr)->op_type) {
10724 case OP_LEAVESUBLV:
10728 case OP_LEAVEWRITE:
10729 TOPPTR(nss,ix) = ptr;
10732 (void) OpREFCNT_inc(o);
10736 TOPPTR(nss,ix) = NULL;
10741 TOPPTR(nss,ix) = NULL;
10744 c = (char*)POPPTR(ss,ix);
10745 TOPPTR(nss,ix) = pv_dup_inc(c);
10748 hv = (HV*)POPPTR(ss,ix);
10749 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10750 c = (char*)POPPTR(ss,ix);
10751 TOPPTR(nss,ix) = pv_dup_inc(c);
10753 case SAVEt_STACK_POS: /* Position on Perl stack */
10755 TOPINT(nss,ix) = i;
10757 case SAVEt_DESTRUCTOR:
10758 ptr = POPPTR(ss,ix);
10759 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10760 dptr = POPDPTR(ss,ix);
10761 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10762 any_dup(FPTR2DPTR(void *, dptr),
10765 case SAVEt_DESTRUCTOR_X:
10766 ptr = POPPTR(ss,ix);
10767 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10768 dxptr = POPDXPTR(ss,ix);
10769 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10770 any_dup(FPTR2DPTR(void *, dxptr),
10773 case SAVEt_REGCONTEXT:
10776 TOPINT(nss,ix) = i;
10779 case SAVEt_AELEM: /* array element */
10780 sv = (SV*)POPPTR(ss,ix);
10781 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10783 TOPINT(nss,ix) = i;
10784 av = (AV*)POPPTR(ss,ix);
10785 TOPPTR(nss,ix) = av_dup_inc(av, param);
10788 ptr = POPPTR(ss,ix);
10789 TOPPTR(nss,ix) = ptr;
10793 TOPINT(nss,ix) = i;
10794 ptr = POPPTR(ss,ix);
10797 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10798 HINTS_REFCNT_UNLOCK;
10800 TOPPTR(nss,ix) = ptr;
10801 if (i & HINT_LOCALIZE_HH) {
10802 hv = (HV*)POPPTR(ss,ix);
10803 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10807 longval = (long)POPLONG(ss,ix);
10808 TOPLONG(nss,ix) = longval;
10809 ptr = POPPTR(ss,ix);
10810 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10811 sv = (SV*)POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = sv_dup(sv, param);
10815 ptr = POPPTR(ss,ix);
10816 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10817 longval = (long)POPBOOL(ss,ix);
10818 TOPBOOL(nss,ix) = (bool)longval;
10820 case SAVEt_SET_SVFLAGS:
10822 TOPINT(nss,ix) = i;
10824 TOPINT(nss,ix) = i;
10825 sv = (SV*)POPPTR(ss,ix);
10826 TOPPTR(nss,ix) = sv_dup(sv, param);
10828 case SAVEt_RE_STATE:
10830 const struct re_save_state *const old_state
10831 = (struct re_save_state *)
10832 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10833 struct re_save_state *const new_state
10834 = (struct re_save_state *)
10835 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10837 Copy(old_state, new_state, 1, struct re_save_state);
10838 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10840 new_state->re_state_bostr
10841 = pv_dup(old_state->re_state_bostr);
10842 new_state->re_state_reginput
10843 = pv_dup(old_state->re_state_reginput);
10844 new_state->re_state_regeol
10845 = pv_dup(old_state->re_state_regeol);
10846 new_state->re_state_regoffs
10847 = (regexp_paren_pair*)
10848 any_dup(old_state->re_state_regoffs, proto_perl);
10849 new_state->re_state_reglastparen
10850 = (U32*) any_dup(old_state->re_state_reglastparen,
10852 new_state->re_state_reglastcloseparen
10853 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10855 /* XXX This just has to be broken. The old save_re_context
10856 code did SAVEGENERICPV(PL_reg_start_tmp);
10857 PL_reg_start_tmp is char **.
10858 Look above to what the dup code does for
10859 SAVEt_GENERIC_PVREF
10860 It can never have worked.
10861 So this is merely a faithful copy of the exiting bug: */
10862 new_state->re_state_reg_start_tmp
10863 = (char **) pv_dup((char *)
10864 old_state->re_state_reg_start_tmp);
10865 /* I assume that it only ever "worked" because no-one called
10866 (pseudo)fork while the regexp engine had re-entered itself.
10868 #ifdef PERL_OLD_COPY_ON_WRITE
10869 new_state->re_state_nrs
10870 = sv_dup(old_state->re_state_nrs, param);
10872 new_state->re_state_reg_magic
10873 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10875 new_state->re_state_reg_oldcurpm
10876 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10878 new_state->re_state_reg_curpm
10879 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10881 new_state->re_state_reg_oldsaved
10882 = pv_dup(old_state->re_state_reg_oldsaved);
10883 new_state->re_state_reg_poscache
10884 = pv_dup(old_state->re_state_reg_poscache);
10885 new_state->re_state_reg_starttry
10886 = pv_dup(old_state->re_state_reg_starttry);
10889 case SAVEt_COMPILE_WARNINGS:
10890 ptr = POPPTR(ss,ix);
10891 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10894 ptr = POPPTR(ss,ix);
10895 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10899 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10907 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10908 * flag to the result. This is done for each stash before cloning starts,
10909 * so we know which stashes want their objects cloned */
10912 do_mark_cloneable_stash(pTHX_ SV *sv)
10914 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10916 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10917 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10918 if (cloner && GvCV(cloner)) {
10925 mXPUSHs(newSVhek(hvname));
10927 call_sv((SV*)GvCV(cloner), G_SCALAR);
10934 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10942 =for apidoc perl_clone
10944 Create and return a new interpreter by cloning the current one.
10946 perl_clone takes these flags as parameters:
10948 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10949 without it we only clone the data and zero the stacks,
10950 with it we copy the stacks and the new perl interpreter is
10951 ready to run at the exact same point as the previous one.
10952 The pseudo-fork code uses COPY_STACKS while the
10953 threads->create doesn't.
10955 CLONEf_KEEP_PTR_TABLE
10956 perl_clone keeps a ptr_table with the pointer of the old
10957 variable as a key and the new variable as a value,
10958 this allows it to check if something has been cloned and not
10959 clone it again but rather just use the value and increase the
10960 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10961 the ptr_table using the function
10962 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10963 reason to keep it around is if you want to dup some of your own
10964 variable who are outside the graph perl scans, example of this
10965 code is in threads.xs create
10968 This is a win32 thing, it is ignored on unix, it tells perls
10969 win32host code (which is c++) to clone itself, this is needed on
10970 win32 if you want to run two threads at the same time,
10971 if you just want to do some stuff in a separate perl interpreter
10972 and then throw it away and return to the original one,
10973 you don't need to do anything.
10978 /* XXX the above needs expanding by someone who actually understands it ! */
10979 EXTERN_C PerlInterpreter *
10980 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
10983 perl_clone(PerlInterpreter *proto_perl, UV flags)
10986 #ifdef PERL_IMPLICIT_SYS
10988 /* perlhost.h so we need to call into it
10989 to clone the host, CPerlHost should have a c interface, sky */
10991 if (flags & CLONEf_CLONE_HOST) {
10992 return perl_clone_host(proto_perl,flags);
10994 return perl_clone_using(proto_perl, flags,
10996 proto_perl->IMemShared,
10997 proto_perl->IMemParse,
10999 proto_perl->IStdIO,
11003 proto_perl->IProc);
11007 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11008 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11009 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11010 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11011 struct IPerlDir* ipD, struct IPerlSock* ipS,
11012 struct IPerlProc* ipP)
11014 /* XXX many of the string copies here can be optimized if they're
11015 * constants; they need to be allocated as common memory and just
11016 * their pointers copied. */
11019 CLONE_PARAMS clone_params;
11020 CLONE_PARAMS* const param = &clone_params;
11022 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11023 /* for each stash, determine whether its objects should be cloned */
11024 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11025 PERL_SET_THX(my_perl);
11028 PoisonNew(my_perl, 1, PerlInterpreter);
11034 PL_savestack_ix = 0;
11035 PL_savestack_max = -1;
11036 PL_sig_pending = 0;
11038 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11039 # else /* !DEBUGGING */
11040 Zero(my_perl, 1, PerlInterpreter);
11041 # endif /* DEBUGGING */
11043 /* host pointers */
11045 PL_MemShared = ipMS;
11046 PL_MemParse = ipMP;
11053 #else /* !PERL_IMPLICIT_SYS */
11055 CLONE_PARAMS clone_params;
11056 CLONE_PARAMS* param = &clone_params;
11057 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11058 /* for each stash, determine whether its objects should be cloned */
11059 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11060 PERL_SET_THX(my_perl);
11063 PoisonNew(my_perl, 1, PerlInterpreter);
11069 PL_savestack_ix = 0;
11070 PL_savestack_max = -1;
11071 PL_sig_pending = 0;
11073 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11074 # else /* !DEBUGGING */
11075 Zero(my_perl, 1, PerlInterpreter);
11076 # endif /* DEBUGGING */
11077 #endif /* PERL_IMPLICIT_SYS */
11078 param->flags = flags;
11079 param->proto_perl = proto_perl;
11081 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11083 PL_body_arenas = NULL;
11084 Zero(&PL_body_roots, 1, PL_body_roots);
11086 PL_nice_chunk = NULL;
11087 PL_nice_chunk_size = 0;
11089 PL_sv_objcount = 0;
11091 PL_sv_arenaroot = NULL;
11093 PL_debug = proto_perl->Idebug;
11095 PL_hash_seed = proto_perl->Ihash_seed;
11096 PL_rehash_seed = proto_perl->Irehash_seed;
11098 #ifdef USE_REENTRANT_API
11099 /* XXX: things like -Dm will segfault here in perlio, but doing
11100 * PERL_SET_CONTEXT(proto_perl);
11101 * breaks too many other things
11103 Perl_reentrant_init(aTHX);
11106 /* create SV map for pointer relocation */
11107 PL_ptr_table = ptr_table_new();
11109 /* initialize these special pointers as early as possible */
11110 SvANY(&PL_sv_undef) = NULL;
11111 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11112 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11113 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11115 SvANY(&PL_sv_no) = new_XPVNV();
11116 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11117 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11118 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11119 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11120 SvCUR_set(&PL_sv_no, 0);
11121 SvLEN_set(&PL_sv_no, 1);
11122 SvIV_set(&PL_sv_no, 0);
11123 SvNV_set(&PL_sv_no, 0);
11124 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11126 SvANY(&PL_sv_yes) = new_XPVNV();
11127 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11128 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11129 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11130 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11131 SvCUR_set(&PL_sv_yes, 1);
11132 SvLEN_set(&PL_sv_yes, 2);
11133 SvIV_set(&PL_sv_yes, 1);
11134 SvNV_set(&PL_sv_yes, 1);
11135 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11137 /* create (a non-shared!) shared string table */
11138 PL_strtab = newHV();
11139 HvSHAREKEYS_off(PL_strtab);
11140 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11141 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11143 PL_compiling = proto_perl->Icompiling;
11145 /* These two PVs will be free'd special way so must set them same way op.c does */
11146 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11147 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11149 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11150 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11152 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11153 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11154 if (PL_compiling.cop_hints_hash) {
11156 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11157 HINTS_REFCNT_UNLOCK;
11159 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11160 #ifdef PERL_DEBUG_READONLY_OPS
11165 /* pseudo environmental stuff */
11166 PL_origargc = proto_perl->Iorigargc;
11167 PL_origargv = proto_perl->Iorigargv;
11169 param->stashes = newAV(); /* Setup array of objects to call clone on */
11171 /* Set tainting stuff before PerlIO_debug can possibly get called */
11172 PL_tainting = proto_perl->Itainting;
11173 PL_taint_warn = proto_perl->Itaint_warn;
11175 #ifdef PERLIO_LAYERS
11176 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11177 PerlIO_clone(aTHX_ proto_perl, param);
11180 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11181 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11182 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11183 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11184 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11185 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11188 PL_minus_c = proto_perl->Iminus_c;
11189 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11190 PL_localpatches = proto_perl->Ilocalpatches;
11191 PL_splitstr = proto_perl->Isplitstr;
11192 PL_preprocess = proto_perl->Ipreprocess;
11193 PL_minus_n = proto_perl->Iminus_n;
11194 PL_minus_p = proto_perl->Iminus_p;
11195 PL_minus_l = proto_perl->Iminus_l;
11196 PL_minus_a = proto_perl->Iminus_a;
11197 PL_minus_E = proto_perl->Iminus_E;
11198 PL_minus_F = proto_perl->Iminus_F;
11199 PL_doswitches = proto_perl->Idoswitches;
11200 PL_dowarn = proto_perl->Idowarn;
11201 PL_doextract = proto_perl->Idoextract;
11202 PL_sawampersand = proto_perl->Isawampersand;
11203 PL_unsafe = proto_perl->Iunsafe;
11204 PL_inplace = SAVEPV(proto_perl->Iinplace);
11205 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11206 PL_perldb = proto_perl->Iperldb;
11207 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11208 PL_exit_flags = proto_perl->Iexit_flags;
11210 /* magical thingies */
11211 /* XXX time(&PL_basetime) when asked for? */
11212 PL_basetime = proto_perl->Ibasetime;
11213 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11215 PL_maxsysfd = proto_perl->Imaxsysfd;
11216 PL_statusvalue = proto_perl->Istatusvalue;
11218 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11220 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11222 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11224 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11225 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11226 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11229 /* RE engine related */
11230 Zero(&PL_reg_state, 1, struct re_save_state);
11231 PL_reginterp_cnt = 0;
11232 PL_regmatch_slab = NULL;
11234 /* Clone the regex array */
11235 PL_regex_padav = newAV();
11237 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11238 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11240 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11241 for(i = 1; i <= len; i++) {
11242 const SV * const regex = regexen[i];
11243 /* FIXME for plugins
11244 newSViv(PTR2IV(CALLREGDUPE(
11245 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11247 /* And while we're at it, can we FIXME on the whole hiding
11248 pointer inside an IV hack? */
11251 ? sv_dup_inc((SV*) regex, param)
11253 newSViv(PTR2IV(sv_dup_inc(INT2PTR(SV *, SvIVX(regex)), param))))
11255 if (SvFLAGS(regex) & SVf_BREAK)
11256 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11257 av_push(PL_regex_padav, sv);
11260 PL_regex_pad = AvARRAY(PL_regex_padav);
11262 /* shortcuts to various I/O objects */
11263 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11264 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11265 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11266 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11267 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11268 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11270 /* shortcuts to regexp stuff */
11271 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11273 /* shortcuts to misc objects */
11274 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11276 /* shortcuts to debugging objects */
11277 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11278 PL_DBline = gv_dup(proto_perl->IDBline, param);
11279 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11280 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11281 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11282 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11283 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11285 /* symbol tables */
11286 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11287 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11288 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11289 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11290 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11292 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11293 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11294 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11295 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11296 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11297 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11298 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11299 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11301 PL_sub_generation = proto_perl->Isub_generation;
11302 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11304 /* funky return mechanisms */
11305 PL_forkprocess = proto_perl->Iforkprocess;
11307 /* subprocess state */
11308 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11310 /* internal state */
11311 PL_maxo = proto_perl->Imaxo;
11312 if (proto_perl->Iop_mask)
11313 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11316 /* PL_asserting = proto_perl->Iasserting; */
11318 /* current interpreter roots */
11319 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11321 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11323 PL_main_start = proto_perl->Imain_start;
11324 PL_eval_root = proto_perl->Ieval_root;
11325 PL_eval_start = proto_perl->Ieval_start;
11327 /* runtime control stuff */
11328 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11330 PL_filemode = proto_perl->Ifilemode;
11331 PL_lastfd = proto_perl->Ilastfd;
11332 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11335 PL_gensym = proto_perl->Igensym;
11336 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11337 PL_laststatval = proto_perl->Ilaststatval;
11338 PL_laststype = proto_perl->Ilaststype;
11341 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11343 /* interpreter atexit processing */
11344 PL_exitlistlen = proto_perl->Iexitlistlen;
11345 if (PL_exitlistlen) {
11346 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11347 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11350 PL_exitlist = (PerlExitListEntry*)NULL;
11352 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11353 if (PL_my_cxt_size) {
11354 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11355 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11356 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11357 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11358 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11362 PL_my_cxt_list = (void**)NULL;
11363 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11364 PL_my_cxt_keys = (const char**)NULL;
11367 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11368 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11369 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11371 PL_profiledata = NULL;
11373 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11375 PAD_CLONE_VARS(proto_perl, param);
11377 #ifdef HAVE_INTERP_INTERN
11378 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11381 /* more statics moved here */
11382 PL_generation = proto_perl->Igeneration;
11383 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11385 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11386 PL_in_clean_all = proto_perl->Iin_clean_all;
11388 PL_uid = proto_perl->Iuid;
11389 PL_euid = proto_perl->Ieuid;
11390 PL_gid = proto_perl->Igid;
11391 PL_egid = proto_perl->Iegid;
11392 PL_nomemok = proto_perl->Inomemok;
11393 PL_an = proto_perl->Ian;
11394 PL_evalseq = proto_perl->Ievalseq;
11395 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11396 PL_origalen = proto_perl->Iorigalen;
11397 #ifdef PERL_USES_PL_PIDSTATUS
11398 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11400 PL_osname = SAVEPV(proto_perl->Iosname);
11401 PL_sighandlerp = proto_perl->Isighandlerp;
11403 PL_runops = proto_perl->Irunops;
11405 PL_parser = parser_dup(proto_perl->Iparser, param);
11407 PL_subline = proto_perl->Isubline;
11408 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11411 PL_cryptseen = proto_perl->Icryptseen;
11414 PL_hints = proto_perl->Ihints;
11416 PL_amagic_generation = proto_perl->Iamagic_generation;
11418 #ifdef USE_LOCALE_COLLATE
11419 PL_collation_ix = proto_perl->Icollation_ix;
11420 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11421 PL_collation_standard = proto_perl->Icollation_standard;
11422 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11423 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11424 #endif /* USE_LOCALE_COLLATE */
11426 #ifdef USE_LOCALE_NUMERIC
11427 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11428 PL_numeric_standard = proto_perl->Inumeric_standard;
11429 PL_numeric_local = proto_perl->Inumeric_local;
11430 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11431 #endif /* !USE_LOCALE_NUMERIC */
11433 /* utf8 character classes */
11434 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11435 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11436 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11437 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11438 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11439 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11440 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11441 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11442 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11443 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11444 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11445 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11446 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11447 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11448 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11449 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11450 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11451 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11452 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11453 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11455 /* Did the locale setup indicate UTF-8? */
11456 PL_utf8locale = proto_perl->Iutf8locale;
11457 /* Unicode features (see perlrun/-C) */
11458 PL_unicode = proto_perl->Iunicode;
11460 /* Pre-5.8 signals control */
11461 PL_signals = proto_perl->Isignals;
11463 /* times() ticks per second */
11464 PL_clocktick = proto_perl->Iclocktick;
11466 /* Recursion stopper for PerlIO_find_layer */
11467 PL_in_load_module = proto_perl->Iin_load_module;
11469 /* sort() routine */
11470 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11472 /* Not really needed/useful since the reenrant_retint is "volatile",
11473 * but do it for consistency's sake. */
11474 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11476 /* Hooks to shared SVs and locks. */
11477 PL_sharehook = proto_perl->Isharehook;
11478 PL_lockhook = proto_perl->Ilockhook;
11479 PL_unlockhook = proto_perl->Iunlockhook;
11480 PL_threadhook = proto_perl->Ithreadhook;
11481 PL_destroyhook = proto_perl->Idestroyhook;
11483 #ifdef THREADS_HAVE_PIDS
11484 PL_ppid = proto_perl->Ippid;
11488 PL_last_swash_hv = NULL; /* reinits on demand */
11489 PL_last_swash_klen = 0;
11490 PL_last_swash_key[0]= '\0';
11491 PL_last_swash_tmps = (U8*)NULL;
11492 PL_last_swash_slen = 0;
11494 PL_glob_index = proto_perl->Iglob_index;
11495 PL_srand_called = proto_perl->Isrand_called;
11496 PL_bitcount = NULL; /* reinits on demand */
11498 if (proto_perl->Ipsig_pend) {
11499 Newxz(PL_psig_pend, SIG_SIZE, int);
11502 PL_psig_pend = (int*)NULL;
11505 if (proto_perl->Ipsig_ptr) {
11506 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11507 Newxz(PL_psig_name, SIG_SIZE, SV*);
11508 for (i = 1; i < SIG_SIZE; i++) {
11509 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11510 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11514 PL_psig_ptr = (SV**)NULL;
11515 PL_psig_name = (SV**)NULL;
11518 /* intrpvar.h stuff */
11520 if (flags & CLONEf_COPY_STACKS) {
11521 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11522 PL_tmps_ix = proto_perl->Itmps_ix;
11523 PL_tmps_max = proto_perl->Itmps_max;
11524 PL_tmps_floor = proto_perl->Itmps_floor;
11525 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11527 while (i <= PL_tmps_ix) {
11528 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11532 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11533 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11534 Newxz(PL_markstack, i, I32);
11535 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11536 - proto_perl->Imarkstack);
11537 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11538 - proto_perl->Imarkstack);
11539 Copy(proto_perl->Imarkstack, PL_markstack,
11540 PL_markstack_ptr - PL_markstack + 1, I32);
11542 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11543 * NOTE: unlike the others! */
11544 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11545 PL_scopestack_max = proto_perl->Iscopestack_max;
11546 Newxz(PL_scopestack, PL_scopestack_max, I32);
11547 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11549 /* NOTE: si_dup() looks at PL_markstack */
11550 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11552 /* PL_curstack = PL_curstackinfo->si_stack; */
11553 PL_curstack = av_dup(proto_perl->Icurstack, param);
11554 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11556 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11557 PL_stack_base = AvARRAY(PL_curstack);
11558 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11559 - proto_perl->Istack_base);
11560 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11562 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11563 * NOTE: unlike the others! */
11564 PL_savestack_ix = proto_perl->Isavestack_ix;
11565 PL_savestack_max = proto_perl->Isavestack_max;
11566 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11567 PL_savestack = ss_dup(proto_perl, param);
11571 ENTER; /* perl_destruct() wants to LEAVE; */
11573 /* although we're not duplicating the tmps stack, we should still
11574 * add entries for any SVs on the tmps stack that got cloned by a
11575 * non-refcount means (eg a temp in @_); otherwise they will be
11578 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11579 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11580 proto_perl->Itmps_stack[i]);
11581 if (nsv && !SvREFCNT(nsv)) {
11583 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11588 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11589 PL_top_env = &PL_start_env;
11591 PL_op = proto_perl->Iop;
11594 PL_Xpv = (XPV*)NULL;
11595 my_perl->Ina = proto_perl->Ina;
11597 PL_statbuf = proto_perl->Istatbuf;
11598 PL_statcache = proto_perl->Istatcache;
11599 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11600 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11602 PL_timesbuf = proto_perl->Itimesbuf;
11605 PL_tainted = proto_perl->Itainted;
11606 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11607 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11608 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11609 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11610 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11611 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11612 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11613 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11614 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11616 PL_restartop = proto_perl->Irestartop;
11617 PL_in_eval = proto_perl->Iin_eval;
11618 PL_delaymagic = proto_perl->Idelaymagic;
11619 PL_dirty = proto_perl->Idirty;
11620 PL_localizing = proto_perl->Ilocalizing;
11622 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11623 PL_hv_fetch_ent_mh = NULL;
11624 PL_modcount = proto_perl->Imodcount;
11625 PL_lastgotoprobe = NULL;
11626 PL_dumpindent = proto_perl->Idumpindent;
11628 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11629 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11630 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11631 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11632 PL_efloatbuf = NULL; /* reinits on demand */
11633 PL_efloatsize = 0; /* reinits on demand */
11637 PL_screamfirst = NULL;
11638 PL_screamnext = NULL;
11639 PL_maxscream = -1; /* reinits on demand */
11640 PL_lastscream = NULL;
11643 PL_regdummy = proto_perl->Iregdummy;
11644 PL_colorset = 0; /* reinits PL_colors[] */
11645 /*PL_colors[6] = {0,0,0,0,0,0};*/
11649 /* Pluggable optimizer */
11650 PL_peepp = proto_perl->Ipeepp;
11652 PL_stashcache = newHV();
11654 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11655 proto_perl->Iwatchaddr);
11656 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11657 if (PL_debug && PL_watchaddr) {
11658 PerlIO_printf(Perl_debug_log,
11659 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11660 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11661 PTR2UV(PL_watchok));
11664 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11665 ptr_table_free(PL_ptr_table);
11666 PL_ptr_table = NULL;
11669 /* Call the ->CLONE method, if it exists, for each of the stashes
11670 identified by sv_dup() above.
11672 while(av_len(param->stashes) != -1) {
11673 HV* const stash = (HV*) av_shift(param->stashes);
11674 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11675 if (cloner && GvCV(cloner)) {
11680 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11682 call_sv((SV*)GvCV(cloner), G_DISCARD);
11688 SvREFCNT_dec(param->stashes);
11690 /* orphaned? eg threads->new inside BEGIN or use */
11691 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11692 SvREFCNT_inc_simple_void(PL_compcv);
11693 SAVEFREESV(PL_compcv);
11699 #endif /* USE_ITHREADS */
11702 =head1 Unicode Support
11704 =for apidoc sv_recode_to_utf8
11706 The encoding is assumed to be an Encode object, on entry the PV
11707 of the sv is assumed to be octets in that encoding, and the sv
11708 will be converted into Unicode (and UTF-8).
11710 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11711 is not a reference, nothing is done to the sv. If the encoding is not
11712 an C<Encode::XS> Encoding object, bad things will happen.
11713 (See F<lib/encoding.pm> and L<Encode>).
11715 The PV of the sv is returned.
11720 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11723 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11737 Passing sv_yes is wrong - it needs to be or'ed set of constants
11738 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11739 remove converted chars from source.
11741 Both will default the value - let them.
11743 XPUSHs(&PL_sv_yes);
11746 call_method("decode", G_SCALAR);
11750 s = SvPV_const(uni, len);
11751 if (s != SvPVX_const(sv)) {
11752 SvGROW(sv, len + 1);
11753 Move(s, SvPVX(sv), len + 1, char);
11754 SvCUR_set(sv, len);
11761 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11765 =for apidoc sv_cat_decode
11767 The encoding is assumed to be an Encode object, the PV of the ssv is
11768 assumed to be octets in that encoding and decoding the input starts
11769 from the position which (PV + *offset) pointed to. The dsv will be
11770 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11771 when the string tstr appears in decoding output or the input ends on
11772 the PV of the ssv. The value which the offset points will be modified
11773 to the last input position on the ssv.
11775 Returns TRUE if the terminator was found, else returns FALSE.
11780 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11781 SV *ssv, int *offset, char *tstr, int tlen)
11785 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11796 offsv = newSViv(*offset);
11798 mXPUSHp(tstr, tlen);
11800 call_method("cat_decode", G_SCALAR);
11802 ret = SvTRUE(TOPs);
11803 *offset = SvIV(offsv);
11809 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11814 /* ---------------------------------------------------------------------
11816 * support functions for report_uninit()
11819 /* the maxiumum size of array or hash where we will scan looking
11820 * for the undefined element that triggered the warning */
11822 #define FUV_MAX_SEARCH_SIZE 1000
11824 /* Look for an entry in the hash whose value has the same SV as val;
11825 * If so, return a mortal copy of the key. */
11828 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11831 register HE **array;
11834 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11835 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11838 array = HvARRAY(hv);
11840 for (i=HvMAX(hv); i>0; i--) {
11841 register HE *entry;
11842 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11843 if (HeVAL(entry) != val)
11845 if ( HeVAL(entry) == &PL_sv_undef ||
11846 HeVAL(entry) == &PL_sv_placeholder)
11850 if (HeKLEN(entry) == HEf_SVKEY)
11851 return sv_mortalcopy(HeKEY_sv(entry));
11852 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11858 /* Look for an entry in the array whose value has the same SV as val;
11859 * If so, return the index, otherwise return -1. */
11862 S_find_array_subscript(pTHX_ AV *av, SV* val)
11865 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11866 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11869 if (val != &PL_sv_undef) {
11870 SV ** const svp = AvARRAY(av);
11873 for (i=AvFILLp(av); i>=0; i--)
11880 /* S_varname(): return the name of a variable, optionally with a subscript.
11881 * If gv is non-zero, use the name of that global, along with gvtype (one
11882 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11883 * targ. Depending on the value of the subscript_type flag, return:
11886 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11887 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11888 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11889 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11892 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11893 SV* keyname, I32 aindex, int subscript_type)
11896 SV * const name = sv_newmortal();
11899 buffer[0] = gvtype;
11902 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11904 gv_fullname4(name, gv, buffer, 0);
11906 if ((unsigned int)SvPVX(name)[1] <= 26) {
11908 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11910 /* Swap the 1 unprintable control character for the 2 byte pretty
11911 version - ie substr($name, 1, 1) = $buffer; */
11912 sv_insert(name, 1, 1, buffer, 2);
11916 CV * const cv = find_runcv(NULL);
11920 if (!cv || !CvPADLIST(cv))
11922 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11923 sv = *av_fetch(av, targ, FALSE);
11924 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11927 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11928 SV * const sv = newSV(0);
11929 *SvPVX(name) = '$';
11930 Perl_sv_catpvf(aTHX_ name, "{%s}",
11931 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11934 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11935 *SvPVX(name) = '$';
11936 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11938 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11939 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11946 =for apidoc find_uninit_var
11948 Find the name of the undefined variable (if any) that caused the operator o
11949 to issue a "Use of uninitialized value" warning.
11950 If match is true, only return a name if it's value matches uninit_sv.
11951 So roughly speaking, if a unary operator (such as OP_COS) generates a
11952 warning, then following the direct child of the op may yield an
11953 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11954 other hand, with OP_ADD there are two branches to follow, so we only print
11955 the variable name if we get an exact match.
11957 The name is returned as a mortal SV.
11959 Assumes that PL_op is the op that originally triggered the error, and that
11960 PL_comppad/PL_curpad points to the currently executing pad.
11966 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11974 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11975 uninit_sv == &PL_sv_placeholder)))
11978 switch (obase->op_type) {
11985 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
11986 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
11989 int subscript_type = FUV_SUBSCRIPT_WITHIN;
11991 if (pad) { /* @lex, %lex */
11992 sv = PAD_SVl(obase->op_targ);
11996 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
11997 /* @global, %global */
11998 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12001 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12003 else /* @{expr}, %{expr} */
12004 return find_uninit_var(cUNOPx(obase)->op_first,
12008 /* attempt to find a match within the aggregate */
12010 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12012 subscript_type = FUV_SUBSCRIPT_HASH;
12015 index = find_array_subscript((AV*)sv, uninit_sv);
12017 subscript_type = FUV_SUBSCRIPT_ARRAY;
12020 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12023 return varname(gv, hash ? '%' : '@', obase->op_targ,
12024 keysv, index, subscript_type);
12028 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12030 return varname(NULL, '$', obase->op_targ,
12031 NULL, 0, FUV_SUBSCRIPT_NONE);
12034 gv = cGVOPx_gv(obase);
12035 if (!gv || (match && GvSV(gv) != uninit_sv))
12037 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12040 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12043 av = (AV*)PAD_SV(obase->op_targ);
12044 if (!av || SvRMAGICAL(av))
12046 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12047 if (!svp || *svp != uninit_sv)
12050 return varname(NULL, '$', obase->op_targ,
12051 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12054 gv = cGVOPx_gv(obase);
12060 if (!av || SvRMAGICAL(av))
12062 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12063 if (!svp || *svp != uninit_sv)
12066 return varname(gv, '$', 0,
12067 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12072 o = cUNOPx(obase)->op_first;
12073 if (!o || o->op_type != OP_NULL ||
12074 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12076 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12080 if (PL_op == obase)
12081 /* $a[uninit_expr] or $h{uninit_expr} */
12082 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12085 o = cBINOPx(obase)->op_first;
12086 kid = cBINOPx(obase)->op_last;
12088 /* get the av or hv, and optionally the gv */
12090 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12091 sv = PAD_SV(o->op_targ);
12093 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12094 && cUNOPo->op_first->op_type == OP_GV)
12096 gv = cGVOPx_gv(cUNOPo->op_first);
12099 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12104 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12105 /* index is constant */
12109 if (obase->op_type == OP_HELEM) {
12110 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12111 if (!he || HeVAL(he) != uninit_sv)
12115 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12116 if (!svp || *svp != uninit_sv)
12120 if (obase->op_type == OP_HELEM)
12121 return varname(gv, '%', o->op_targ,
12122 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12124 return varname(gv, '@', o->op_targ, NULL,
12125 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12128 /* index is an expression;
12129 * attempt to find a match within the aggregate */
12130 if (obase->op_type == OP_HELEM) {
12131 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12133 return varname(gv, '%', o->op_targ,
12134 keysv, 0, FUV_SUBSCRIPT_HASH);
12137 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12139 return varname(gv, '@', o->op_targ,
12140 NULL, index, FUV_SUBSCRIPT_ARRAY);
12145 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12147 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12152 /* only examine RHS */
12153 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12156 o = cUNOPx(obase)->op_first;
12157 if (o->op_type == OP_PUSHMARK)
12160 if (!o->op_sibling) {
12161 /* one-arg version of open is highly magical */
12163 if (o->op_type == OP_GV) { /* open FOO; */
12165 if (match && GvSV(gv) != uninit_sv)
12167 return varname(gv, '$', 0,
12168 NULL, 0, FUV_SUBSCRIPT_NONE);
12170 /* other possibilities not handled are:
12171 * open $x; or open my $x; should return '${*$x}'
12172 * open expr; should return '$'.expr ideally
12178 /* ops where $_ may be an implicit arg */
12182 if ( !(obase->op_flags & OPf_STACKED)) {
12183 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12184 ? PAD_SVl(obase->op_targ)
12187 sv = sv_newmortal();
12188 sv_setpvn(sv, "$_", 2);
12197 /* skip filehandle as it can't produce 'undef' warning */
12198 o = cUNOPx(obase)->op_first;
12199 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12200 o = o->op_sibling->op_sibling;
12206 match = 1; /* XS or custom code could trigger random warnings */
12211 /* XXX tmp hack: these two may call an XS sub, and currently
12212 XS subs don't have a SUB entry on the context stack, so CV and
12213 pad determination goes wrong, and BAD things happen. So, just
12214 don't try to determine the value under those circumstances.
12215 Need a better fix at dome point. DAPM 11/2007 */
12219 /* def-ness of rval pos() is independent of the def-ness of its arg */
12220 if ( !(obase->op_flags & OPf_MOD))
12225 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12226 return newSVpvs_flags("${$/}", SVs_TEMP);
12231 if (!(obase->op_flags & OPf_KIDS))
12233 o = cUNOPx(obase)->op_first;
12239 /* if all except one arg are constant, or have no side-effects,
12240 * or are optimized away, then it's unambiguous */
12242 for (kid=o; kid; kid = kid->op_sibling) {
12244 const OPCODE type = kid->op_type;
12245 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12246 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12247 || (type == OP_PUSHMARK)
12251 if (o2) { /* more than one found */
12258 return find_uninit_var(o2, uninit_sv, match);
12260 /* scan all args */
12262 sv = find_uninit_var(o, uninit_sv, 1);
12274 =for apidoc report_uninit
12276 Print appropriate "Use of uninitialized variable" warning
12282 Perl_report_uninit(pTHX_ SV* uninit_sv)
12286 SV* varname = NULL;
12288 varname = find_uninit_var(PL_op, uninit_sv,0);
12290 sv_insert(varname, 0, 0, " ", 1);
12292 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12293 varname ? SvPV_nolen_const(varname) : "",
12294 " in ", OP_DESC(PL_op));
12297 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12303 * c-indentation-style: bsd
12304 * c-basic-offset: 4
12305 * indent-tabs-mode: t
12308 * ex: set ts=8 sts=4 sw=4 noet: