3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
921 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
922 SVt_REGEXP, FALSE, NONV, HASARENA,
923 FIT_ARENA(0, sizeof(struct regexp_allocated))
927 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
934 { sizeof(xpvav_allocated),
935 copy_length(XPVAV, xmg_stash)
936 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
937 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
938 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
940 { sizeof(xpvhv_allocated),
941 copy_length(XPVHV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
943 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
944 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
947 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
948 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
949 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
951 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
952 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
953 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
955 /* XPVIO is 84 bytes, fits 48x */
956 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
957 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
960 #define new_body_type(sv_type) \
961 (void *)((char *)S_new_body(aTHX_ sv_type))
963 #define del_body_type(p, sv_type) \
964 del_body(p, &PL_body_roots[sv_type])
967 #define new_body_allocated(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type) \
969 - bodies_by_type[sv_type].offset)
971 #define del_body_allocated(p, sv_type) \
972 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
975 #define my_safemalloc(s) (void*)safemalloc(s)
976 #define my_safecalloc(s) (void*)safecalloc(s, 1)
977 #define my_safefree(p) safefree((char*)p)
981 #define new_XNV() my_safemalloc(sizeof(XPVNV))
982 #define del_XNV(p) my_safefree(p)
984 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
985 #define del_XPVNV(p) my_safefree(p)
987 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
988 #define del_XPVAV(p) my_safefree(p)
990 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
991 #define del_XPVHV(p) my_safefree(p)
993 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
994 #define del_XPVMG(p) my_safefree(p)
996 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
997 #define del_XPVGV(p) my_safefree(p)
1001 #define new_XNV() new_body_type(SVt_NV)
1002 #define del_XNV(p) del_body_type(p, SVt_NV)
1004 #define new_XPVNV() new_body_type(SVt_PVNV)
1005 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1007 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1008 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1010 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1011 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1013 #define new_XPVMG() new_body_type(SVt_PVMG)
1014 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1016 #define new_XPVGV() new_body_type(SVt_PVGV)
1017 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1021 /* no arena for you! */
1023 #define new_NOARENA(details) \
1024 my_safemalloc((details)->body_size + (details)->offset)
1025 #define new_NOARENAZ(details) \
1026 my_safecalloc((details)->body_size + (details)->offset)
1029 S_more_bodies (pTHX_ svtype sv_type)
1032 void ** const root = &PL_body_roots[sv_type];
1033 const struct body_details * const bdp = &bodies_by_type[sv_type];
1034 const size_t body_size = bdp->body_size;
1037 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1038 static bool done_sanity_check;
1040 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1041 * variables like done_sanity_check. */
1042 if (!done_sanity_check) {
1043 unsigned int i = SVt_LAST;
1045 done_sanity_check = TRUE;
1048 assert (bodies_by_type[i].type == i);
1052 assert(bdp->arena_size);
1054 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1056 end = start + bdp->arena_size - body_size;
1058 /* computed count doesnt reflect the 1st slot reservation */
1059 DEBUG_m(PerlIO_printf(Perl_debug_log,
1060 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1061 (void*)start, (void*)end,
1062 (int)bdp->arena_size, sv_type, (int)body_size,
1063 (int)bdp->arena_size / (int)body_size));
1065 *root = (void *)start;
1067 while (start < end) {
1068 char * const next = start + body_size;
1069 *(void**) start = (void *)next;
1072 *(void **)start = 0;
1077 /* grab a new thing from the free list, allocating more if necessary.
1078 The inline version is used for speed in hot routines, and the
1079 function using it serves the rest (unless PURIFY).
1081 #define new_body_inline(xpv, sv_type) \
1083 void ** const r3wt = &PL_body_roots[sv_type]; \
1084 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1085 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1086 *(r3wt) = *(void**)(xpv); \
1092 S_new_body(pTHX_ svtype sv_type)
1096 new_body_inline(xpv, sv_type);
1102 static const struct body_details fake_rv =
1103 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1106 =for apidoc sv_upgrade
1108 Upgrade an SV to a more complex form. Generally adds a new body type to the
1109 SV, then copies across as much information as possible from the old body.
1110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1116 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1121 const svtype old_type = SvTYPE(sv);
1122 const struct body_details *new_type_details;
1123 const struct body_details *old_type_details
1124 = bodies_by_type + old_type;
1125 SV *referant = NULL;
1127 if (new_type != SVt_PV && SvIsCOW(sv)) {
1128 sv_force_normal_flags(sv, 0);
1131 if (old_type == new_type)
1134 old_body = SvANY(sv);
1136 /* Copying structures onto other structures that have been neatly zeroed
1137 has a subtle gotcha. Consider XPVMG
1139 +------+------+------+------+------+-------+-------+
1140 | NV | CUR | LEN | IV | MAGIC | STASH |
1141 +------+------+------+------+------+-------+-------+
1142 0 4 8 12 16 20 24 28
1144 where NVs are aligned to 8 bytes, so that sizeof that structure is
1145 actually 32 bytes long, with 4 bytes of padding at the end:
1147 +------+------+------+------+------+-------+-------+------+
1148 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1149 +------+------+------+------+------+-------+-------+------+
1150 0 4 8 12 16 20 24 28 32
1152 so what happens if you allocate memory for this structure:
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1156 +------+------+------+------+------+-------+-------+------+------+...
1157 0 4 8 12 16 20 24 28 32 36
1159 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1160 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1161 started out as zero once, but it's quite possible that it isn't. So now,
1162 rather than a nicely zeroed GP, you have it pointing somewhere random.
1165 (In fact, GP ends up pointing at a previous GP structure, because the
1166 principle cause of the padding in XPVMG getting garbage is a copy of
1167 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1168 this happens to be moot because XPVGV has been re-ordered, with GP
1169 no longer after STASH)
1171 So we are careful and work out the size of used parts of all the
1179 referant = SvRV(sv);
1180 old_type_details = &fake_rv;
1181 if (new_type == SVt_NV)
1182 new_type = SVt_PVNV;
1184 if (new_type < SVt_PVIV) {
1185 new_type = (new_type == SVt_NV)
1186 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1196 assert(new_type > SVt_PV);
1197 assert(SVt_IV < SVt_PV);
1198 assert(SVt_NV < SVt_PV);
1205 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1206 there's no way that it can be safely upgraded, because perl.c
1207 expects to Safefree(SvANY(PL_mess_sv)) */
1208 assert(sv != PL_mess_sv);
1209 /* This flag bit is used to mean other things in other scalar types.
1210 Given that it only has meaning inside the pad, it shouldn't be set
1211 on anything that can get upgraded. */
1212 assert(!SvPAD_TYPED(sv));
1215 if (old_type_details->cant_upgrade)
1216 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1217 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1220 if (old_type > new_type)
1221 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1222 (int)old_type, (int)new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1245 assert(new_type_details->body_size);
1248 assert(new_type_details->arena);
1249 assert(new_type_details->arena_size);
1250 /* This points to the start of the allocated area. */
1251 new_body_inline(new_body, new_type);
1252 Zero(new_body, new_type_details->body_size, char);
1253 new_body = ((char *)new_body) - new_type_details->offset;
1255 /* We always allocated the full length item with PURIFY. To do this
1256 we fake things so that arena is false for all 16 types.. */
1257 new_body = new_NOARENAZ(new_type_details);
1259 SvANY(sv) = new_body;
1260 if (new_type == SVt_PVAV) {
1264 if (old_type_details->body_size) {
1267 /* It will have been zeroed when the new body was allocated.
1268 Lets not write to it, in case it confuses a write-back
1274 #ifndef NODEFAULT_SHAREKEYS
1275 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1277 HvMAX(sv) = 7; /* (start with 8 buckets) */
1278 if (old_type_details->body_size) {
1281 /* It will have been zeroed when the new body was allocated.
1282 Lets not write to it, in case it confuses a write-back
1287 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1288 The target created by newSVrv also is, and it can have magic.
1289 However, it never has SvPVX set.
1291 if (old_type == SVt_IV) {
1293 } else if (old_type >= SVt_PV) {
1294 assert(SvPVX_const(sv) == 0);
1297 if (old_type >= SVt_PVMG) {
1298 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1299 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1301 sv->sv_u.svu_array = NULL; /* or svu_hash */
1307 /* XXX Is this still needed? Was it ever needed? Surely as there is
1308 no route from NV to PVIV, NOK can never be true */
1309 assert(!SvNOKp(sv));
1321 assert(new_type_details->body_size);
1322 /* We always allocated the full length item with PURIFY. To do this
1323 we fake things so that arena is false for all 16 types.. */
1324 if(new_type_details->arena) {
1325 /* This points to the start of the allocated area. */
1326 new_body_inline(new_body, new_type);
1327 Zero(new_body, new_type_details->body_size, char);
1328 new_body = ((char *)new_body) - new_type_details->offset;
1330 new_body = new_NOARENAZ(new_type_details);
1332 SvANY(sv) = new_body;
1334 if (old_type_details->copy) {
1335 /* There is now the potential for an upgrade from something without
1336 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1337 int offset = old_type_details->offset;
1338 int length = old_type_details->copy;
1340 if (new_type_details->offset > old_type_details->offset) {
1341 const int difference
1342 = new_type_details->offset - old_type_details->offset;
1343 offset += difference;
1344 length -= difference;
1346 assert (length >= 0);
1348 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354 * correct 0.0 for us. Otherwise, if the old body didn't have an
1355 * NV slot, but the new one does, then we need to initialise the
1356 * freshly created NV slot with whatever the correct bit pattern is
1358 if (old_type_details->zero_nv && !new_type_details->zero_nv
1359 && !isGV_with_GP(sv))
1363 if (new_type == SVt_PVIO)
1364 IoPAGE_LEN(sv) = 60;
1365 if (old_type < SVt_PV) {
1366 /* referant will be NULL unless the old type was SVt_IV emulating
1368 sv->sv_u.svu_rv = referant;
1372 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1373 (unsigned long)new_type);
1376 if (old_type_details->arena) {
1377 /* If there was an old body, then we need to free it.
1378 Note that there is an assumption that all bodies of types that
1379 can be upgraded came from arenas. Only the more complex non-
1380 upgradable types are allowed to be directly malloc()ed. */
1382 my_safefree(old_body);
1384 del_body((void*)((char*)old_body + old_type_details->offset),
1385 &PL_body_roots[old_type]);
1391 =for apidoc sv_backoff
1393 Remove any string offset. You should normally use the C<SvOOK_off> macro
1400 Perl_sv_backoff(pTHX_ register SV *sv)
1403 const char * const s = SvPVX_const(sv);
1404 PERL_UNUSED_CONTEXT;
1406 assert(SvTYPE(sv) != SVt_PVHV);
1407 assert(SvTYPE(sv) != SVt_PVAV);
1409 SvOOK_offset(sv, delta);
1411 SvLEN_set(sv, SvLEN(sv) + delta);
1412 SvPV_set(sv, SvPVX(sv) - delta);
1413 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1414 SvFLAGS(sv) &= ~SVf_OOK;
1421 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1422 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1423 Use the C<SvGROW> wrapper instead.
1429 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1433 if (PL_madskills && newlen >= 0x100000) {
1434 PerlIO_printf(Perl_debug_log,
1435 "Allocation too large: %"UVxf"\n", (UV)newlen);
1437 #ifdef HAS_64K_LIMIT
1438 if (newlen >= 0x10000) {
1439 PerlIO_printf(Perl_debug_log,
1440 "Allocation too large: %"UVxf"\n", (UV)newlen);
1443 #endif /* HAS_64K_LIMIT */
1446 if (SvTYPE(sv) < SVt_PV) {
1447 sv_upgrade(sv, SVt_PV);
1448 s = SvPVX_mutable(sv);
1450 else if (SvOOK(sv)) { /* pv is offset? */
1452 s = SvPVX_mutable(sv);
1453 if (newlen > SvLEN(sv))
1454 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1455 #ifdef HAS_64K_LIMIT
1456 if (newlen >= 0x10000)
1461 s = SvPVX_mutable(sv);
1463 if (newlen > SvLEN(sv)) { /* need more room? */
1464 newlen = PERL_STRLEN_ROUNDUP(newlen);
1465 if (SvLEN(sv) && s) {
1467 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1473 s = (char*)saferealloc(s, newlen);
1476 s = (char*)safemalloc(newlen);
1477 if (SvPVX_const(sv) && SvCUR(sv)) {
1478 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1482 SvLEN_set(sv, newlen);
1488 =for apidoc sv_setiv
1490 Copies an integer into the given SV, upgrading first if necessary.
1491 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1497 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1500 SV_CHECK_THINKFIRST_COW_DROP(sv);
1501 switch (SvTYPE(sv)) {
1504 sv_upgrade(sv, SVt_IV);
1507 sv_upgrade(sv, SVt_PVIV);
1516 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1520 (void)SvIOK_only(sv); /* validate number */
1526 =for apidoc sv_setiv_mg
1528 Like C<sv_setiv>, but also handles 'set' magic.
1534 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1541 =for apidoc sv_setuv
1543 Copies an unsigned integer into the given SV, upgrading first if necessary.
1544 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1550 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1552 /* With these two if statements:
1553 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1556 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1558 If you wish to remove them, please benchmark to see what the effect is
1560 if (u <= (UV)IV_MAX) {
1561 sv_setiv(sv, (IV)u);
1570 =for apidoc sv_setuv_mg
1572 Like C<sv_setuv>, but also handles 'set' magic.
1578 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1585 =for apidoc sv_setnv
1587 Copies a double into the given SV, upgrading first if necessary.
1588 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1594 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1597 SV_CHECK_THINKFIRST_COW_DROP(sv);
1598 switch (SvTYPE(sv)) {
1601 sv_upgrade(sv, SVt_NV);
1605 sv_upgrade(sv, SVt_PVNV);
1614 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1619 (void)SvNOK_only(sv); /* validate number */
1624 =for apidoc sv_setnv_mg
1626 Like C<sv_setnv>, but also handles 'set' magic.
1632 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1638 /* Print an "isn't numeric" warning, using a cleaned-up,
1639 * printable version of the offending string
1643 S_not_a_number(pTHX_ SV *sv)
1651 dsv = newSVpvs_flags("", SVs_TEMP);
1652 pv = sv_uni_display(dsv, sv, 10, 0);
1655 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1656 /* each *s can expand to 4 chars + "...\0",
1657 i.e. need room for 8 chars */
1659 const char *s = SvPVX_const(sv);
1660 const char * const end = s + SvCUR(sv);
1661 for ( ; s < end && d < limit; s++ ) {
1663 if (ch & 128 && !isPRINT_LC(ch)) {
1672 else if (ch == '\r') {
1676 else if (ch == '\f') {
1680 else if (ch == '\\') {
1684 else if (ch == '\0') {
1688 else if (isPRINT_LC(ch))
1705 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706 "Argument \"%s\" isn't numeric in %s", pv,
1709 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1710 "Argument \"%s\" isn't numeric", pv);
1714 =for apidoc looks_like_number
1716 Test if the content of an SV looks like a number (or is a number).
1717 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1718 non-numeric warning), even if your atof() doesn't grok them.
1724 Perl_looks_like_number(pTHX_ SV *sv)
1726 register const char *sbegin;
1730 sbegin = SvPVX_const(sv);
1733 else if (SvPOKp(sv))
1734 sbegin = SvPV_const(sv, len);
1736 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1737 return grok_number(sbegin, len, NULL);
1741 S_glob_2number(pTHX_ GV * const gv)
1743 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1744 SV *const buffer = sv_newmortal();
1746 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1749 gv_efullname3(buffer, gv, "*");
1750 SvFLAGS(gv) |= wasfake;
1752 /* We know that all GVs stringify to something that is not-a-number,
1753 so no need to test that. */
1754 if (ckWARN(WARN_NUMERIC))
1755 not_a_number(buffer);
1756 /* We just want something true to return, so that S_sv_2iuv_common
1757 can tail call us and return true. */
1762 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1764 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1765 SV *const buffer = sv_newmortal();
1767 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1770 gv_efullname3(buffer, gv, "*");
1771 SvFLAGS(gv) |= wasfake;
1773 assert(SvPOK(buffer));
1775 *len = SvCUR(buffer);
1777 return SvPVX(buffer);
1780 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1781 until proven guilty, assume that things are not that bad... */
1786 As 64 bit platforms often have an NV that doesn't preserve all bits of
1787 an IV (an assumption perl has been based on to date) it becomes necessary
1788 to remove the assumption that the NV always carries enough precision to
1789 recreate the IV whenever needed, and that the NV is the canonical form.
1790 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1791 precision as a side effect of conversion (which would lead to insanity
1792 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1793 1) to distinguish between IV/UV/NV slots that have cached a valid
1794 conversion where precision was lost and IV/UV/NV slots that have a
1795 valid conversion which has lost no precision
1796 2) to ensure that if a numeric conversion to one form is requested that
1797 would lose precision, the precise conversion (or differently
1798 imprecise conversion) is also performed and cached, to prevent
1799 requests for different numeric formats on the same SV causing
1800 lossy conversion chains. (lossless conversion chains are perfectly
1805 SvIOKp is true if the IV slot contains a valid value
1806 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1807 SvNOKp is true if the NV slot contains a valid value
1808 SvNOK is true only if the NV value is accurate
1811 while converting from PV to NV, check to see if converting that NV to an
1812 IV(or UV) would lose accuracy over a direct conversion from PV to
1813 IV(or UV). If it would, cache both conversions, return NV, but mark
1814 SV as IOK NOKp (ie not NOK).
1816 While converting from PV to IV, check to see if converting that IV to an
1817 NV would lose accuracy over a direct conversion from PV to NV. If it
1818 would, cache both conversions, flag similarly.
1820 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1821 correctly because if IV & NV were set NV *always* overruled.
1822 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1823 changes - now IV and NV together means that the two are interchangeable:
1824 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1826 The benefit of this is that operations such as pp_add know that if
1827 SvIOK is true for both left and right operands, then integer addition
1828 can be used instead of floating point (for cases where the result won't
1829 overflow). Before, floating point was always used, which could lead to
1830 loss of precision compared with integer addition.
1832 * making IV and NV equal status should make maths accurate on 64 bit
1834 * may speed up maths somewhat if pp_add and friends start to use
1835 integers when possible instead of fp. (Hopefully the overhead in
1836 looking for SvIOK and checking for overflow will not outweigh the
1837 fp to integer speedup)
1838 * will slow down integer operations (callers of SvIV) on "inaccurate"
1839 values, as the change from SvIOK to SvIOKp will cause a call into
1840 sv_2iv each time rather than a macro access direct to the IV slot
1841 * should speed up number->string conversion on integers as IV is
1842 favoured when IV and NV are equally accurate
1844 ####################################################################
1845 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1846 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1847 On the other hand, SvUOK is true iff UV.
1848 ####################################################################
1850 Your mileage will vary depending your CPU's relative fp to integer
1854 #ifndef NV_PRESERVES_UV
1855 # define IS_NUMBER_UNDERFLOW_IV 1
1856 # define IS_NUMBER_UNDERFLOW_UV 2
1857 # define IS_NUMBER_IV_AND_UV 2
1858 # define IS_NUMBER_OVERFLOW_IV 4
1859 # define IS_NUMBER_OVERFLOW_UV 5
1861 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1863 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1865 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1868 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1869 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1870 if (SvNVX(sv) < (NV)IV_MIN) {
1871 (void)SvIOKp_on(sv);
1873 SvIV_set(sv, IV_MIN);
1874 return IS_NUMBER_UNDERFLOW_IV;
1876 if (SvNVX(sv) > (NV)UV_MAX) {
1877 (void)SvIOKp_on(sv);
1880 SvUV_set(sv, UV_MAX);
1881 return IS_NUMBER_OVERFLOW_UV;
1883 (void)SvIOKp_on(sv);
1885 /* Can't use strtol etc to convert this string. (See truth table in
1887 if (SvNVX(sv) <= (UV)IV_MAX) {
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1890 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1892 /* Integer is imprecise. NOK, IOKp */
1894 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1897 SvUV_set(sv, U_V(SvNVX(sv)));
1898 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1899 if (SvUVX(sv) == UV_MAX) {
1900 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1901 possibly be preserved by NV. Hence, it must be overflow.
1903 return IS_NUMBER_OVERFLOW_UV;
1905 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1907 /* Integer is imprecise. NOK, IOKp */
1909 return IS_NUMBER_OVERFLOW_IV;
1911 #endif /* !NV_PRESERVES_UV*/
1914 S_sv_2iuv_common(pTHX_ SV *sv) {
1917 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1918 * without also getting a cached IV/UV from it at the same time
1919 * (ie PV->NV conversion should detect loss of accuracy and cache
1920 * IV or UV at same time to avoid this. */
1921 /* IV-over-UV optimisation - choose to cache IV if possible */
1923 if (SvTYPE(sv) == SVt_NV)
1924 sv_upgrade(sv, SVt_PVNV);
1926 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1927 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1928 certainly cast into the IV range at IV_MAX, whereas the correct
1929 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1931 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1932 if (Perl_isnan(SvNVX(sv))) {
1938 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1939 SvIV_set(sv, I_V(SvNVX(sv)));
1940 if (SvNVX(sv) == (NV) SvIVX(sv)
1941 #ifndef NV_PRESERVES_UV
1942 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1943 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1944 /* Don't flag it as "accurately an integer" if the number
1945 came from a (by definition imprecise) NV operation, and
1946 we're outside the range of NV integer precision */
1950 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1952 /* scalar has trailing garbage, eg "42a" */
1954 DEBUG_c(PerlIO_printf(Perl_debug_log,
1955 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1961 /* IV not precise. No need to convert from PV, as NV
1962 conversion would already have cached IV if it detected
1963 that PV->IV would be better than PV->NV->IV
1964 flags already correct - don't set public IOK. */
1965 DEBUG_c(PerlIO_printf(Perl_debug_log,
1966 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1971 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1972 but the cast (NV)IV_MIN rounds to a the value less (more
1973 negative) than IV_MIN which happens to be equal to SvNVX ??
1974 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1975 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1976 (NV)UVX == NVX are both true, but the values differ. :-(
1977 Hopefully for 2s complement IV_MIN is something like
1978 0x8000000000000000 which will be exact. NWC */
1981 SvUV_set(sv, U_V(SvNVX(sv)));
1983 (SvNVX(sv) == (NV) SvUVX(sv))
1984 #ifndef NV_PRESERVES_UV
1985 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1986 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1987 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1988 /* Don't flag it as "accurately an integer" if the number
1989 came from a (by definition imprecise) NV operation, and
1990 we're outside the range of NV integer precision */
1996 DEBUG_c(PerlIO_printf(Perl_debug_log,
1997 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2003 else if (SvPOKp(sv) && SvLEN(sv)) {
2005 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2006 /* We want to avoid a possible problem when we cache an IV/ a UV which
2007 may be later translated to an NV, and the resulting NV is not
2008 the same as the direct translation of the initial string
2009 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2010 be careful to ensure that the value with the .456 is around if the
2011 NV value is requested in the future).
2013 This means that if we cache such an IV/a UV, we need to cache the
2014 NV as well. Moreover, we trade speed for space, and do not
2015 cache the NV if we are sure it's not needed.
2018 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2019 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2020 == IS_NUMBER_IN_UV) {
2021 /* It's definitely an integer, only upgrade to PVIV */
2022 if (SvTYPE(sv) < SVt_PVIV)
2023 sv_upgrade(sv, SVt_PVIV);
2025 } else if (SvTYPE(sv) < SVt_PVNV)
2026 sv_upgrade(sv, SVt_PVNV);
2028 /* If NVs preserve UVs then we only use the UV value if we know that
2029 we aren't going to call atof() below. If NVs don't preserve UVs
2030 then the value returned may have more precision than atof() will
2031 return, even though value isn't perfectly accurate. */
2032 if ((numtype & (IS_NUMBER_IN_UV
2033 #ifdef NV_PRESERVES_UV
2036 )) == IS_NUMBER_IN_UV) {
2037 /* This won't turn off the public IOK flag if it was set above */
2038 (void)SvIOKp_on(sv);
2040 if (!(numtype & IS_NUMBER_NEG)) {
2042 if (value <= (UV)IV_MAX) {
2043 SvIV_set(sv, (IV)value);
2045 /* it didn't overflow, and it was positive. */
2046 SvUV_set(sv, value);
2050 /* 2s complement assumption */
2051 if (value <= (UV)IV_MIN) {
2052 SvIV_set(sv, -(IV)value);
2054 /* Too negative for an IV. This is a double upgrade, but
2055 I'm assuming it will be rare. */
2056 if (SvTYPE(sv) < SVt_PVNV)
2057 sv_upgrade(sv, SVt_PVNV);
2061 SvNV_set(sv, -(NV)value);
2062 SvIV_set(sv, IV_MIN);
2066 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2067 will be in the previous block to set the IV slot, and the next
2068 block to set the NV slot. So no else here. */
2070 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071 != IS_NUMBER_IN_UV) {
2072 /* It wasn't an (integer that doesn't overflow the UV). */
2073 SvNV_set(sv, Atof(SvPVX_const(sv)));
2075 if (! numtype && ckWARN(WARN_NUMERIC))
2078 #if defined(USE_LONG_DOUBLE)
2079 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2080 PTR2UV(sv), SvNVX(sv)));
2082 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2083 PTR2UV(sv), SvNVX(sv)));
2086 #ifdef NV_PRESERVES_UV
2087 (void)SvIOKp_on(sv);
2089 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2094 NOOP; /* Integer is imprecise. NOK, IOKp */
2096 /* UV will not work better than IV */
2098 if (SvNVX(sv) > (NV)UV_MAX) {
2100 /* Integer is inaccurate. NOK, IOKp, is UV */
2101 SvUV_set(sv, UV_MAX);
2103 SvUV_set(sv, U_V(SvNVX(sv)));
2104 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2105 NV preservse UV so can do correct comparison. */
2106 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2109 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2114 #else /* NV_PRESERVES_UV */
2115 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2116 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2117 /* The IV/UV slot will have been set from value returned by
2118 grok_number above. The NV slot has just been set using
2121 assert (SvIOKp(sv));
2123 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2124 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2125 /* Small enough to preserve all bits. */
2126 (void)SvIOKp_on(sv);
2128 SvIV_set(sv, I_V(SvNVX(sv)));
2129 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2131 /* Assumption: first non-preserved integer is < IV_MAX,
2132 this NV is in the preserved range, therefore: */
2133 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2135 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2139 0 0 already failed to read UV.
2140 0 1 already failed to read UV.
2141 1 0 you won't get here in this case. IV/UV
2142 slot set, public IOK, Atof() unneeded.
2143 1 1 already read UV.
2144 so there's no point in sv_2iuv_non_preserve() attempting
2145 to use atol, strtol, strtoul etc. */
2146 sv_2iuv_non_preserve (sv, numtype);
2149 #endif /* NV_PRESERVES_UV */
2150 /* It might be more code efficient to go through the entire logic above
2151 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2152 gets complex and potentially buggy, so more programmer efficient
2153 to do it this way, by turning off the public flags: */
2155 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2159 if (isGV_with_GP(sv))
2160 return glob_2number((GV *)sv);
2162 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2163 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2166 if (SvTYPE(sv) < SVt_IV)
2167 /* Typically the caller expects that sv_any is not NULL now. */
2168 sv_upgrade(sv, SVt_IV);
2169 /* Return 0 from the caller. */
2176 =for apidoc sv_2iv_flags
2178 Return the integer value of an SV, doing any necessary string
2179 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2180 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2186 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2191 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2192 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2193 cache IVs just in case. In practice it seems that they never
2194 actually anywhere accessible by user Perl code, let alone get used
2195 in anything other than a string context. */
2196 if (flags & SV_GMAGIC)
2201 return I_V(SvNVX(sv));
2203 if (SvPOKp(sv) && SvLEN(sv)) {
2206 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 == IS_NUMBER_IN_UV) {
2210 /* It's definitely an integer */
2211 if (numtype & IS_NUMBER_NEG) {
2212 if (value < (UV)IV_MIN)
2215 if (value < (UV)IV_MAX)
2220 if (ckWARN(WARN_NUMERIC))
2223 return I_V(Atof(SvPVX_const(sv)));
2228 assert(SvTYPE(sv) >= SVt_PVMG);
2229 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2230 } else if (SvTHINKFIRST(sv)) {
2234 SV * const tmpstr=AMG_CALLun(sv,numer);
2235 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2236 return SvIV(tmpstr);
2239 return PTR2IV(SvRV(sv));
2242 sv_force_normal_flags(sv, 0);
2244 if (SvREADONLY(sv) && !SvOK(sv)) {
2245 if (ckWARN(WARN_UNINITIALIZED))
2251 if (S_sv_2iuv_common(aTHX_ sv))
2254 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2255 PTR2UV(sv),SvIVX(sv)));
2256 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2260 =for apidoc sv_2uv_flags
2262 Return the unsigned integer value of an SV, doing any necessary string
2263 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2264 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2270 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2275 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2276 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2277 cache IVs just in case. */
2278 if (flags & SV_GMAGIC)
2283 return U_V(SvNVX(sv));
2284 if (SvPOKp(sv) && SvLEN(sv)) {
2287 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2289 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290 == IS_NUMBER_IN_UV) {
2291 /* It's definitely an integer */
2292 if (!(numtype & IS_NUMBER_NEG))
2296 if (ckWARN(WARN_NUMERIC))
2299 return U_V(Atof(SvPVX_const(sv)));
2304 assert(SvTYPE(sv) >= SVt_PVMG);
2305 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2306 } else if (SvTHINKFIRST(sv)) {
2310 SV *const tmpstr = AMG_CALLun(sv,numer);
2311 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2312 return SvUV(tmpstr);
2315 return PTR2UV(SvRV(sv));
2318 sv_force_normal_flags(sv, 0);
2320 if (SvREADONLY(sv) && !SvOK(sv)) {
2321 if (ckWARN(WARN_UNINITIALIZED))
2327 if (S_sv_2iuv_common(aTHX_ sv))
2331 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2332 PTR2UV(sv),SvUVX(sv)));
2333 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2339 Return the num value of an SV, doing any necessary string or integer
2340 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2347 Perl_sv_2nv(pTHX_ register SV *sv)
2352 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2353 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2354 cache IVs just in case. */
2358 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2359 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2360 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2362 return Atof(SvPVX_const(sv));
2366 return (NV)SvUVX(sv);
2368 return (NV)SvIVX(sv);
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit near the end of the
2376 } else if (SvTHINKFIRST(sv)) {
2380 SV *const tmpstr = AMG_CALLun(sv,numer);
2381 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2382 return SvNV(tmpstr);
2385 return PTR2NV(SvRV(sv));
2388 sv_force_normal_flags(sv, 0);
2390 if (SvREADONLY(sv) && !SvOK(sv)) {
2391 if (ckWARN(WARN_UNINITIALIZED))
2396 if (SvTYPE(sv) < SVt_NV) {
2397 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2398 sv_upgrade(sv, SVt_NV);
2399 #ifdef USE_LONG_DOUBLE
2401 STORE_NUMERIC_LOCAL_SET_STANDARD();
2402 PerlIO_printf(Perl_debug_log,
2403 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2404 PTR2UV(sv), SvNVX(sv));
2405 RESTORE_NUMERIC_LOCAL();
2409 STORE_NUMERIC_LOCAL_SET_STANDARD();
2410 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2411 PTR2UV(sv), SvNVX(sv));
2412 RESTORE_NUMERIC_LOCAL();
2416 else if (SvTYPE(sv) < SVt_PVNV)
2417 sv_upgrade(sv, SVt_PVNV);
2422 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2423 #ifdef NV_PRESERVES_UV
2429 /* Only set the public NV OK flag if this NV preserves the IV */
2430 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2432 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2433 : (SvIVX(sv) == I_V(SvNVX(sv))))
2439 else if (SvPOKp(sv) && SvLEN(sv)) {
2441 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2442 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2444 #ifdef NV_PRESERVES_UV
2445 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2446 == IS_NUMBER_IN_UV) {
2447 /* It's definitely an integer */
2448 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2450 SvNV_set(sv, Atof(SvPVX_const(sv)));
2456 SvNV_set(sv, Atof(SvPVX_const(sv)));
2457 /* Only set the public NV OK flag if this NV preserves the value in
2458 the PV at least as well as an IV/UV would.
2459 Not sure how to do this 100% reliably. */
2460 /* if that shift count is out of range then Configure's test is
2461 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2463 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2464 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2465 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2466 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2467 /* Can't use strtol etc to convert this string, so don't try.
2468 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2471 /* value has been set. It may not be precise. */
2472 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2473 /* 2s complement assumption for (UV)IV_MIN */
2474 SvNOK_on(sv); /* Integer is too negative. */
2479 if (numtype & IS_NUMBER_NEG) {
2480 SvIV_set(sv, -(IV)value);
2481 } else if (value <= (UV)IV_MAX) {
2482 SvIV_set(sv, (IV)value);
2484 SvUV_set(sv, value);
2488 if (numtype & IS_NUMBER_NOT_INT) {
2489 /* I believe that even if the original PV had decimals,
2490 they are lost beyond the limit of the FP precision.
2491 However, neither is canonical, so both only get p
2492 flags. NWC, 2000/11/25 */
2493 /* Both already have p flags, so do nothing */
2495 const NV nv = SvNVX(sv);
2496 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2497 if (SvIVX(sv) == I_V(nv)) {
2500 /* It had no "." so it must be integer. */
2504 /* between IV_MAX and NV(UV_MAX).
2505 Could be slightly > UV_MAX */
2507 if (numtype & IS_NUMBER_NOT_INT) {
2508 /* UV and NV both imprecise. */
2510 const UV nv_as_uv = U_V(nv);
2512 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2521 /* It might be more code efficient to go through the entire logic above
2522 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2523 gets complex and potentially buggy, so more programmer efficient
2524 to do it this way, by turning off the public flags: */
2526 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2527 #endif /* NV_PRESERVES_UV */
2530 if (isGV_with_GP(sv)) {
2531 glob_2number((GV *)sv);
2535 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2537 assert (SvTYPE(sv) >= SVt_NV);
2538 /* Typically the caller expects that sv_any is not NULL now. */
2539 /* XXX Ilya implies that this is a bug in callers that assume this
2540 and ideally should be fixed. */
2543 #if defined(USE_LONG_DOUBLE)
2545 STORE_NUMERIC_LOCAL_SET_STANDARD();
2546 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2547 PTR2UV(sv), SvNVX(sv));
2548 RESTORE_NUMERIC_LOCAL();
2552 STORE_NUMERIC_LOCAL_SET_STANDARD();
2553 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2554 PTR2UV(sv), SvNVX(sv));
2555 RESTORE_NUMERIC_LOCAL();
2564 Return an SV with the numeric value of the source SV, doing any necessary
2565 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2566 access this function.
2572 Perl_sv_2num(pTHX_ register SV *sv)
2577 SV * const tmpsv = AMG_CALLun(sv,numer);
2578 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2579 return sv_2num(tmpsv);
2581 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2584 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2585 * UV as a string towards the end of buf, and return pointers to start and
2588 * We assume that buf is at least TYPE_CHARS(UV) long.
2592 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2594 char *ptr = buf + TYPE_CHARS(UV);
2595 char * const ebuf = ptr;
2608 *--ptr = '0' + (char)(uv % 10);
2617 =for apidoc sv_2pv_flags
2619 Returns a pointer to the string value of an SV, and sets *lp to its length.
2620 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2622 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2623 usually end up here too.
2629 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2639 if (SvGMAGICAL(sv)) {
2640 if (flags & SV_GMAGIC)
2645 if (flags & SV_MUTABLE_RETURN)
2646 return SvPVX_mutable(sv);
2647 if (flags & SV_CONST_RETURN)
2648 return (char *)SvPVX_const(sv);
2651 if (SvIOKp(sv) || SvNOKp(sv)) {
2652 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2657 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2658 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2660 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2667 #ifdef FIXNEGATIVEZERO
2668 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2674 SvUPGRADE(sv, SVt_PV);
2677 s = SvGROW_mutable(sv, len + 1);
2680 return (char*)memcpy(s, tbuf, len + 1);
2686 assert(SvTYPE(sv) >= SVt_PVMG);
2687 /* This falls through to the report_uninit near the end of the
2689 } else if (SvTHINKFIRST(sv)) {
2693 SV *const tmpstr = AMG_CALLun(sv,string);
2694 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2696 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2700 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2701 if (flags & SV_CONST_RETURN) {
2702 pv = (char *) SvPVX_const(tmpstr);
2704 pv = (flags & SV_MUTABLE_RETURN)
2705 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2708 *lp = SvCUR(tmpstr);
2710 pv = sv_2pv_flags(tmpstr, lp, flags);
2723 const SV *const referent = (SV*)SvRV(sv);
2727 retval = buffer = savepvn("NULLREF", len);
2728 } else if (SvTYPE(referent) == SVt_REGEXP) {
2729 const REGEXP * const re = (REGEXP *)referent;
2734 /* If the regex is UTF-8 we want the containing scalar to
2735 have an UTF-8 flag too */
2741 if ((seen_evals = RX_SEEN_EVALS(re)))
2742 PL_reginterp_cnt += seen_evals;
2745 *lp = RX_WRAPLEN(re);
2747 return RX_WRAPPED(re);
2749 const char *const typestr = sv_reftype(referent, 0);
2750 const STRLEN typelen = strlen(typestr);
2751 UV addr = PTR2UV(referent);
2752 const char *stashname = NULL;
2753 STRLEN stashnamelen = 0; /* hush, gcc */
2754 const char *buffer_end;
2756 if (SvOBJECT(referent)) {
2757 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2760 stashname = HEK_KEY(name);
2761 stashnamelen = HEK_LEN(name);
2763 if (HEK_UTF8(name)) {
2769 stashname = "__ANON__";
2772 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2773 + 2 * sizeof(UV) + 2 /* )\0 */;
2775 len = typelen + 3 /* (0x */
2776 + 2 * sizeof(UV) + 2 /* )\0 */;
2779 Newx(buffer, len, char);
2780 buffer_end = retval = buffer + len;
2782 /* Working backwards */
2786 *--retval = PL_hexdigit[addr & 15];
2787 } while (addr >>= 4);
2793 memcpy(retval, typestr, typelen);
2797 retval -= stashnamelen;
2798 memcpy(retval, stashname, stashnamelen);
2800 /* retval may not neccesarily have reached the start of the
2802 assert (retval >= buffer);
2804 len = buffer_end - retval - 1; /* -1 for that \0 */
2812 if (SvREADONLY(sv) && !SvOK(sv)) {
2815 if (flags & SV_UNDEF_RETURNS_NULL)
2817 if (ckWARN(WARN_UNINITIALIZED))
2822 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2823 /* I'm assuming that if both IV and NV are equally valid then
2824 converting the IV is going to be more efficient */
2825 const U32 isUIOK = SvIsUV(sv);
2826 char buf[TYPE_CHARS(UV)];
2830 if (SvTYPE(sv) < SVt_PVIV)
2831 sv_upgrade(sv, SVt_PVIV);
2832 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2834 /* inlined from sv_setpvn */
2835 s = SvGROW_mutable(sv, len + 1);
2836 Move(ptr, s, len, char);
2840 else if (SvNOKp(sv)) {
2841 const int olderrno = errno;
2842 if (SvTYPE(sv) < SVt_PVNV)
2843 sv_upgrade(sv, SVt_PVNV);
2844 /* The +20 is pure guesswork. Configure test needed. --jhi */
2845 s = SvGROW_mutable(sv, NV_DIG + 20);
2846 /* some Xenix systems wipe out errno here */
2848 if (SvNVX(sv) == 0.0)
2849 my_strlcpy(s, "0", SvLEN(sv));
2853 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2856 #ifdef FIXNEGATIVEZERO
2857 if (*s == '-' && s[1] == '0' && !s[2]) {
2869 if (isGV_with_GP(sv))
2870 return glob_2pv((GV *)sv, lp);
2874 if (flags & SV_UNDEF_RETURNS_NULL)
2876 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2878 if (SvTYPE(sv) < SVt_PV)
2879 /* Typically the caller expects that sv_any is not NULL now. */
2880 sv_upgrade(sv, SVt_PV);
2884 const STRLEN len = s - SvPVX_const(sv);
2890 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2891 PTR2UV(sv),SvPVX_const(sv)));
2892 if (flags & SV_CONST_RETURN)
2893 return (char *)SvPVX_const(sv);
2894 if (flags & SV_MUTABLE_RETURN)
2895 return SvPVX_mutable(sv);
2900 =for apidoc sv_copypv
2902 Copies a stringified representation of the source SV into the
2903 destination SV. Automatically performs any necessary mg_get and
2904 coercion of numeric values into strings. Guaranteed to preserve
2905 UTF8 flag even from overloaded objects. Similar in nature to
2906 sv_2pv[_flags] but operates directly on an SV instead of just the
2907 string. Mostly uses sv_2pv_flags to do its work, except when that
2908 would lose the UTF-8'ness of the PV.
2914 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2917 const char * const s = SvPV_const(ssv,len);
2918 sv_setpvn(dsv,s,len);
2926 =for apidoc sv_2pvbyte
2928 Return a pointer to the byte-encoded representation of the SV, and set *lp
2929 to its length. May cause the SV to be downgraded from UTF-8 as a
2932 Usually accessed via the C<SvPVbyte> macro.
2938 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2940 sv_utf8_downgrade(sv,0);
2941 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2945 =for apidoc sv_2pvutf8
2947 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2948 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2950 Usually accessed via the C<SvPVutf8> macro.
2956 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2958 sv_utf8_upgrade(sv);
2959 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2964 =for apidoc sv_2bool
2966 This function is only called on magical items, and is only used by
2967 sv_true() or its macro equivalent.
2973 Perl_sv_2bool(pTHX_ register SV *sv)
2982 SV * const tmpsv = AMG_CALLun(sv,bool_);
2983 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2984 return (bool)SvTRUE(tmpsv);
2986 return SvRV(sv) != 0;
2989 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2991 (*sv->sv_u.svu_pv > '0' ||
2992 Xpvtmp->xpv_cur > 1 ||
2993 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3000 return SvIVX(sv) != 0;
3003 return SvNVX(sv) != 0.0;
3005 if (isGV_with_GP(sv))
3015 =for apidoc sv_utf8_upgrade
3017 Converts the PV of an SV to its UTF-8-encoded form.
3018 Forces the SV to string form if it is not already.
3019 Always sets the SvUTF8 flag to avoid future validity checks even
3020 if all the bytes have hibit clear.
3022 This is not as a general purpose byte encoding to Unicode interface:
3023 use the Encode extension for that.
3025 =for apidoc sv_utf8_upgrade_flags
3027 Converts the PV of an SV to its UTF-8-encoded form.
3028 Forces the SV to string form if it is not already.
3029 Always sets the SvUTF8 flag to avoid future validity checks even
3030 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3031 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3032 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3034 This is not as a general purpose byte encoding to Unicode interface:
3035 use the Encode extension for that.
3041 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3044 if (sv == &PL_sv_undef)
3048 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3049 (void) sv_2pv_flags(sv,&len, flags);
3053 (void) SvPV_force(sv,len);
3062 sv_force_normal_flags(sv, 0);
3065 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3066 sv_recode_to_utf8(sv, PL_encoding);
3067 else { /* Assume Latin-1/EBCDIC */
3068 /* This function could be much more efficient if we
3069 * had a FLAG in SVs to signal if there are any hibit
3070 * chars in the PV. Given that there isn't such a flag
3071 * make the loop as fast as possible. */
3072 const U8 * const s = (U8 *) SvPVX_const(sv);
3073 const U8 * const e = (U8 *) SvEND(sv);
3078 /* Check for hi bit */
3079 if (!NATIVE_IS_INVARIANT(ch)) {
3080 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3081 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3083 SvPV_free(sv); /* No longer using what was there before. */
3084 SvPV_set(sv, (char*)recoded);
3085 SvCUR_set(sv, len - 1);
3086 SvLEN_set(sv, len); /* No longer know the real size. */
3090 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3097 =for apidoc sv_utf8_downgrade
3099 Attempts to convert the PV of an SV from characters to bytes.
3100 If the PV contains a character beyond byte, this conversion will fail;
3101 in this case, either returns false or, if C<fail_ok> is not
3104 This is not as a general purpose Unicode to byte encoding interface:
3105 use the Encode extension for that.
3111 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3114 if (SvPOKp(sv) && SvUTF8(sv)) {
3120 sv_force_normal_flags(sv, 0);
3122 s = (U8 *) SvPV(sv, len);
3123 if (!utf8_to_bytes(s, &len)) {
3128 Perl_croak(aTHX_ "Wide character in %s",
3131 Perl_croak(aTHX_ "Wide character");
3142 =for apidoc sv_utf8_encode
3144 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3145 flag off so that it looks like octets again.
3151 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3154 sv_force_normal_flags(sv, 0);
3156 if (SvREADONLY(sv)) {
3157 Perl_croak(aTHX_ PL_no_modify);
3159 (void) sv_utf8_upgrade(sv);
3164 =for apidoc sv_utf8_decode
3166 If the PV of the SV is an octet sequence in UTF-8
3167 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3168 so that it looks like a character. If the PV contains only single-byte
3169 characters, the C<SvUTF8> flag stays being off.
3170 Scans PV for validity and returns false if the PV is invalid UTF-8.
3176 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3182 /* The octets may have got themselves encoded - get them back as
3185 if (!sv_utf8_downgrade(sv, TRUE))
3188 /* it is actually just a matter of turning the utf8 flag on, but
3189 * we want to make sure everything inside is valid utf8 first.
3191 c = (const U8 *) SvPVX_const(sv);
3192 if (!is_utf8_string(c, SvCUR(sv)+1))
3194 e = (const U8 *) SvEND(sv);
3197 if (!UTF8_IS_INVARIANT(ch)) {
3207 =for apidoc sv_setsv
3209 Copies the contents of the source SV C<ssv> into the destination SV
3210 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3211 function if the source SV needs to be reused. Does not handle 'set' magic.
3212 Loosely speaking, it performs a copy-by-value, obliterating any previous
3213 content of the destination.
3215 You probably want to use one of the assortment of wrappers, such as
3216 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3217 C<SvSetMagicSV_nosteal>.
3219 =for apidoc sv_setsv_flags
3221 Copies the contents of the source SV C<ssv> into the destination SV
3222 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3223 function if the source SV needs to be reused. Does not handle 'set' magic.
3224 Loosely speaking, it performs a copy-by-value, obliterating any previous
3225 content of the destination.
3226 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3227 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3228 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3229 and C<sv_setsv_nomg> are implemented in terms of this function.
3231 You probably want to use one of the assortment of wrappers, such as
3232 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3233 C<SvSetMagicSV_nosteal>.
3235 This is the primary function for copying scalars, and most other
3236 copy-ish functions and macros use this underneath.
3242 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3244 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3246 if (dtype != SVt_PVGV) {
3247 const char * const name = GvNAME(sstr);
3248 const STRLEN len = GvNAMELEN(sstr);
3250 if (dtype >= SVt_PV) {
3256 SvUPGRADE(dstr, SVt_PVGV);
3257 (void)SvOK_off(dstr);
3258 /* FIXME - why are we doing this, then turning it off and on again
3260 isGV_with_GP_on(dstr);
3262 GvSTASH(dstr) = GvSTASH(sstr);
3264 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3265 gv_name_set((GV *)dstr, name, len, GV_ADD);
3266 SvFAKE_on(dstr); /* can coerce to non-glob */
3269 #ifdef GV_UNIQUE_CHECK
3270 if (GvUNIQUE((GV*)dstr)) {
3271 Perl_croak(aTHX_ PL_no_modify);
3275 if(GvGP((GV*)sstr)) {
3276 /* If source has method cache entry, clear it */
3278 SvREFCNT_dec(GvCV(sstr));
3282 /* If source has a real method, then a method is
3284 else if(GvCV((GV*)sstr)) {
3289 /* If dest already had a real method, that's a change as well */
3290 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3294 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3298 isGV_with_GP_off(dstr);
3299 (void)SvOK_off(dstr);
3300 isGV_with_GP_on(dstr);
3301 GvINTRO_off(dstr); /* one-shot flag */
3302 GvGP(dstr) = gp_ref(GvGP(sstr));
3303 if (SvTAINTED(sstr))
3305 if (GvIMPORTED(dstr) != GVf_IMPORTED
3306 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3308 GvIMPORTED_on(dstr);
3311 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3312 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3317 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3318 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3320 const int intro = GvINTRO(dstr);
3323 const U32 stype = SvTYPE(sref);
3326 #ifdef GV_UNIQUE_CHECK
3327 if (GvUNIQUE((GV*)dstr)) {
3328 Perl_croak(aTHX_ PL_no_modify);
3333 GvINTRO_off(dstr); /* one-shot flag */
3334 GvLINE(dstr) = CopLINE(PL_curcop);
3335 GvEGV(dstr) = (GV*)dstr;
3340 location = (SV **) &GvCV(dstr);
3341 import_flag = GVf_IMPORTED_CV;
3344 location = (SV **) &GvHV(dstr);
3345 import_flag = GVf_IMPORTED_HV;
3348 location = (SV **) &GvAV(dstr);
3349 import_flag = GVf_IMPORTED_AV;
3352 location = (SV **) &GvIOp(dstr);
3355 location = (SV **) &GvFORM(dstr);
3357 location = &GvSV(dstr);
3358 import_flag = GVf_IMPORTED_SV;
3361 if (stype == SVt_PVCV) {
3362 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3363 if (GvCVGEN(dstr)) {
3364 SvREFCNT_dec(GvCV(dstr));
3366 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3369 SAVEGENERICSV(*location);
3373 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3374 CV* const cv = (CV*)*location;
3376 if (!GvCVGEN((GV*)dstr) &&
3377 (CvROOT(cv) || CvXSUB(cv)))
3379 /* Redefining a sub - warning is mandatory if
3380 it was a const and its value changed. */
3381 if (CvCONST(cv) && CvCONST((CV*)sref)
3382 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3384 /* They are 2 constant subroutines generated from
3385 the same constant. This probably means that
3386 they are really the "same" proxy subroutine
3387 instantiated in 2 places. Most likely this is
3388 when a constant is exported twice. Don't warn.
3391 else if (ckWARN(WARN_REDEFINE)
3393 && (!CvCONST((CV*)sref)
3394 || sv_cmp(cv_const_sv(cv),
3395 cv_const_sv((CV*)sref))))) {
3396 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3399 ? "Constant subroutine %s::%s redefined"
3400 : "Subroutine %s::%s redefined"),
3401 HvNAME_get(GvSTASH((GV*)dstr)),
3402 GvENAME((GV*)dstr));
3406 cv_ckproto_len(cv, (GV*)dstr,
3407 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3408 SvPOK(sref) ? SvCUR(sref) : 0);
3410 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3411 GvASSUMECV_on(dstr);
3412 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3415 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3416 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3417 GvFLAGS(dstr) |= import_flag;
3422 if (SvTAINTED(sstr))
3428 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3431 register U32 sflags;
3433 register svtype stype;
3438 if (SvIS_FREED(dstr)) {
3439 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3440 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3442 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3444 sstr = &PL_sv_undef;
3445 if (SvIS_FREED(sstr)) {
3446 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3447 (void*)sstr, (void*)dstr);
3449 stype = SvTYPE(sstr);
3450 dtype = SvTYPE(dstr);
3452 (void)SvAMAGIC_off(dstr);
3455 /* need to nuke the magic */
3457 SvRMAGICAL_off(dstr);
3460 /* There's a lot of redundancy below but we're going for speed here */
3465 if (dtype != SVt_PVGV) {
3466 (void)SvOK_off(dstr);
3474 sv_upgrade(dstr, SVt_IV);
3478 sv_upgrade(dstr, SVt_PVIV);
3481 goto end_of_first_switch;
3483 (void)SvIOK_only(dstr);
3484 SvIV_set(dstr, SvIVX(sstr));
3487 /* SvTAINTED can only be true if the SV has taint magic, which in
3488 turn means that the SV type is PVMG (or greater). This is the
3489 case statement for SVt_IV, so this cannot be true (whatever gcov
3491 assert(!SvTAINTED(sstr));
3496 if (dtype < SVt_PV && dtype != SVt_IV)
3497 sv_upgrade(dstr, SVt_IV);
3505 sv_upgrade(dstr, SVt_NV);
3509 sv_upgrade(dstr, SVt_PVNV);
3512 goto end_of_first_switch;
3514 SvNV_set(dstr, SvNVX(sstr));
3515 (void)SvNOK_only(dstr);
3516 /* SvTAINTED can only be true if the SV has taint magic, which in
3517 turn means that the SV type is PVMG (or greater). This is the
3518 case statement for SVt_NV, so this cannot be true (whatever gcov
3520 assert(!SvTAINTED(sstr));
3526 #ifdef PERL_OLD_COPY_ON_WRITE
3527 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3528 if (dtype < SVt_PVIV)
3529 sv_upgrade(dstr, SVt_PVIV);
3537 sv_upgrade(dstr, SVt_PV);
3540 if (dtype < SVt_PVIV)
3541 sv_upgrade(dstr, SVt_PVIV);
3544 if (dtype < SVt_PVNV)
3545 sv_upgrade(dstr, SVt_PVNV);
3549 const char * const type = sv_reftype(sstr,0);
3551 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3553 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3557 /* case SVt_BIND: */
3560 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3561 glob_assign_glob(dstr, sstr, dtype);
3564 /* SvVALID means that this PVGV is playing at being an FBM. */
3568 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3570 if (SvTYPE(sstr) != stype) {
3571 stype = SvTYPE(sstr);
3572 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3573 glob_assign_glob(dstr, sstr, dtype);
3578 if (stype == SVt_PVLV)
3579 SvUPGRADE(dstr, SVt_PVNV);
3581 SvUPGRADE(dstr, (svtype)stype);
3583 end_of_first_switch:
3585 /* dstr may have been upgraded. */
3586 dtype = SvTYPE(dstr);
3587 sflags = SvFLAGS(sstr);
3589 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3590 /* Assigning to a subroutine sets the prototype. */
3593 const char *const ptr = SvPV_const(sstr, len);
3595 SvGROW(dstr, len + 1);
3596 Copy(ptr, SvPVX(dstr), len + 1, char);
3597 SvCUR_set(dstr, len);
3599 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3603 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3604 const char * const type = sv_reftype(dstr,0);
3606 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3608 Perl_croak(aTHX_ "Cannot copy to %s", type);
3609 } else if (sflags & SVf_ROK) {
3610 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3611 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3614 if (GvIMPORTED(dstr) != GVf_IMPORTED
3615 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3617 GvIMPORTED_on(dstr);
3622 glob_assign_glob(dstr, sstr, dtype);
3626 if (dtype >= SVt_PV) {
3627 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3628 glob_assign_ref(dstr, sstr);
3631 if (SvPVX_const(dstr)) {
3637 (void)SvOK_off(dstr);
3638 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3639 SvFLAGS(dstr) |= sflags & SVf_ROK;
3640 assert(!(sflags & SVp_NOK));
3641 assert(!(sflags & SVp_IOK));
3642 assert(!(sflags & SVf_NOK));
3643 assert(!(sflags & SVf_IOK));
3645 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3646 if (!(sflags & SVf_OK)) {
3647 if (ckWARN(WARN_MISC))
3648 Perl_warner(aTHX_ packWARN(WARN_MISC),
3649 "Undefined value assigned to typeglob");
3652 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3653 if (dstr != (SV*)gv) {
3656 GvGP(dstr) = gp_ref(GvGP(gv));
3660 else if (sflags & SVp_POK) {
3664 * Check to see if we can just swipe the string. If so, it's a
3665 * possible small lose on short strings, but a big win on long ones.
3666 * It might even be a win on short strings if SvPVX_const(dstr)
3667 * has to be allocated and SvPVX_const(sstr) has to be freed.
3668 * Likewise if we can set up COW rather than doing an actual copy, we
3669 * drop to the else clause, as the swipe code and the COW setup code
3670 * have much in common.
3673 /* Whichever path we take through the next code, we want this true,
3674 and doing it now facilitates the COW check. */
3675 (void)SvPOK_only(dstr);
3678 /* If we're already COW then this clause is not true, and if COW
3679 is allowed then we drop down to the else and make dest COW
3680 with us. If caller hasn't said that we're allowed to COW
3681 shared hash keys then we don't do the COW setup, even if the
3682 source scalar is a shared hash key scalar. */
3683 (((flags & SV_COW_SHARED_HASH_KEYS)
3684 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3685 : 1 /* If making a COW copy is forbidden then the behaviour we
3686 desire is as if the source SV isn't actually already
3687 COW, even if it is. So we act as if the source flags
3688 are not COW, rather than actually testing them. */
3690 #ifndef PERL_OLD_COPY_ON_WRITE
3691 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3692 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3693 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3694 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3695 but in turn, it's somewhat dead code, never expected to go
3696 live, but more kept as a placeholder on how to do it better
3697 in a newer implementation. */
3698 /* If we are COW and dstr is a suitable target then we drop down
3699 into the else and make dest a COW of us. */
3700 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3705 (sflags & SVs_TEMP) && /* slated for free anyway? */
3706 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3707 (!(flags & SV_NOSTEAL)) &&
3708 /* and we're allowed to steal temps */
3709 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3710 SvLEN(sstr) && /* and really is a string */
3711 /* and won't be needed again, potentially */
3712 !(PL_op && PL_op->op_type == OP_AASSIGN))
3713 #ifdef PERL_OLD_COPY_ON_WRITE
3714 && ((flags & SV_COW_SHARED_HASH_KEYS)
3715 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3716 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3717 && SvTYPE(sstr) >= SVt_PVIV))
3721 /* Failed the swipe test, and it's not a shared hash key either.
3722 Have to copy the string. */
3723 STRLEN len = SvCUR(sstr);
3724 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3725 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3726 SvCUR_set(dstr, len);
3727 *SvEND(dstr) = '\0';
3729 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3731 /* Either it's a shared hash key, or it's suitable for
3732 copy-on-write or we can swipe the string. */
3734 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3738 #ifdef PERL_OLD_COPY_ON_WRITE
3740 /* I believe I should acquire a global SV mutex if
3741 it's a COW sv (not a shared hash key) to stop
3742 it going un copy-on-write.
3743 If the source SV has gone un copy on write between up there
3744 and down here, then (assert() that) it is of the correct
3745 form to make it copy on write again */
3746 if ((sflags & (SVf_FAKE | SVf_READONLY))
3747 != (SVf_FAKE | SVf_READONLY)) {
3748 SvREADONLY_on(sstr);
3750 /* Make the source SV into a loop of 1.
3751 (about to become 2) */
3752 SV_COW_NEXT_SV_SET(sstr, sstr);
3756 /* Initial code is common. */
3757 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3762 /* making another shared SV. */
3763 STRLEN cur = SvCUR(sstr);
3764 STRLEN len = SvLEN(sstr);
3765 #ifdef PERL_OLD_COPY_ON_WRITE
3767 assert (SvTYPE(dstr) >= SVt_PVIV);
3768 /* SvIsCOW_normal */
3769 /* splice us in between source and next-after-source. */
3770 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3771 SV_COW_NEXT_SV_SET(sstr, dstr);
3772 SvPV_set(dstr, SvPVX_mutable(sstr));
3776 /* SvIsCOW_shared_hash */
3777 DEBUG_C(PerlIO_printf(Perl_debug_log,
3778 "Copy on write: Sharing hash\n"));
3780 assert (SvTYPE(dstr) >= SVt_PV);
3782 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3784 SvLEN_set(dstr, len);
3785 SvCUR_set(dstr, cur);
3786 SvREADONLY_on(dstr);
3788 /* Relesase a global SV mutex. */
3791 { /* Passes the swipe test. */
3792 SvPV_set(dstr, SvPVX_mutable(sstr));
3793 SvLEN_set(dstr, SvLEN(sstr));
3794 SvCUR_set(dstr, SvCUR(sstr));
3797 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3798 SvPV_set(sstr, NULL);
3804 if (sflags & SVp_NOK) {
3805 SvNV_set(dstr, SvNVX(sstr));
3807 if (sflags & SVp_IOK) {
3808 SvIV_set(dstr, SvIVX(sstr));
3809 /* Must do this otherwise some other overloaded use of 0x80000000
3810 gets confused. I guess SVpbm_VALID */
3811 if (sflags & SVf_IVisUV)
3814 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3816 const MAGIC * const smg = SvVSTRING_mg(sstr);
3818 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3819 smg->mg_ptr, smg->mg_len);
3820 SvRMAGICAL_on(dstr);
3824 else if (sflags & (SVp_IOK|SVp_NOK)) {
3825 (void)SvOK_off(dstr);
3826 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3827 if (sflags & SVp_IOK) {
3828 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3829 SvIV_set(dstr, SvIVX(sstr));
3831 if (sflags & SVp_NOK) {
3832 SvNV_set(dstr, SvNVX(sstr));
3836 if (isGV_with_GP(sstr)) {
3837 /* This stringification rule for globs is spread in 3 places.
3838 This feels bad. FIXME. */
3839 const U32 wasfake = sflags & SVf_FAKE;
3841 /* FAKE globs can get coerced, so need to turn this off
3842 temporarily if it is on. */
3844 gv_efullname3(dstr, (GV *)sstr, "*");
3845 SvFLAGS(sstr) |= wasfake;
3848 (void)SvOK_off(dstr);
3850 if (SvTAINTED(sstr))
3855 =for apidoc sv_setsv_mg
3857 Like C<sv_setsv>, but also handles 'set' magic.
3863 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3865 sv_setsv(dstr,sstr);
3869 #ifdef PERL_OLD_COPY_ON_WRITE
3871 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3873 STRLEN cur = SvCUR(sstr);
3874 STRLEN len = SvLEN(sstr);
3875 register char *new_pv;
3878 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3879 (void*)sstr, (void*)dstr);
3886 if (SvTHINKFIRST(dstr))
3887 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3888 else if (SvPVX_const(dstr))
3889 Safefree(SvPVX_const(dstr));
3893 SvUPGRADE(dstr, SVt_PVIV);
3895 assert (SvPOK(sstr));
3896 assert (SvPOKp(sstr));
3897 assert (!SvIOK(sstr));
3898 assert (!SvIOKp(sstr));
3899 assert (!SvNOK(sstr));
3900 assert (!SvNOKp(sstr));
3902 if (SvIsCOW(sstr)) {
3904 if (SvLEN(sstr) == 0) {
3905 /* source is a COW shared hash key. */
3906 DEBUG_C(PerlIO_printf(Perl_debug_log,
3907 "Fast copy on write: Sharing hash\n"));
3908 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3911 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3913 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3914 SvUPGRADE(sstr, SVt_PVIV);
3915 SvREADONLY_on(sstr);
3917 DEBUG_C(PerlIO_printf(Perl_debug_log,
3918 "Fast copy on write: Converting sstr to COW\n"));
3919 SV_COW_NEXT_SV_SET(dstr, sstr);
3921 SV_COW_NEXT_SV_SET(sstr, dstr);
3922 new_pv = SvPVX_mutable(sstr);
3925 SvPV_set(dstr, new_pv);
3926 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3929 SvLEN_set(dstr, len);
3930 SvCUR_set(dstr, cur);
3939 =for apidoc sv_setpvn
3941 Copies a string into an SV. The C<len> parameter indicates the number of
3942 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3943 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3949 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3952 register char *dptr;
3954 SV_CHECK_THINKFIRST_COW_DROP(sv);
3960 /* len is STRLEN which is unsigned, need to copy to signed */
3963 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3965 SvUPGRADE(sv, SVt_PV);
3967 dptr = SvGROW(sv, len + 1);
3968 Move(ptr,dptr,len,char);
3971 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3976 =for apidoc sv_setpvn_mg
3978 Like C<sv_setpvn>, but also handles 'set' magic.
3984 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3986 sv_setpvn(sv,ptr,len);
3991 =for apidoc sv_setpv
3993 Copies a string into an SV. The string must be null-terminated. Does not
3994 handle 'set' magic. See C<sv_setpv_mg>.
4000 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4003 register STRLEN len;
4005 SV_CHECK_THINKFIRST_COW_DROP(sv);
4011 SvUPGRADE(sv, SVt_PV);
4013 SvGROW(sv, len + 1);
4014 Move(ptr,SvPVX(sv),len+1,char);
4016 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4021 =for apidoc sv_setpv_mg
4023 Like C<sv_setpv>, but also handles 'set' magic.
4029 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4036 =for apidoc sv_usepvn_flags
4038 Tells an SV to use C<ptr> to find its string value. Normally the
4039 string is stored inside the SV but sv_usepvn allows the SV to use an
4040 outside string. The C<ptr> should point to memory that was allocated
4041 by C<malloc>. The string length, C<len>, must be supplied. By default
4042 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4043 so that pointer should not be freed or used by the programmer after
4044 giving it to sv_usepvn, and neither should any pointers from "behind"
4045 that pointer (e.g. ptr + 1) be used.
4047 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4048 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4049 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4050 C<len>, and already meets the requirements for storing in C<SvPVX>)
4056 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4060 SV_CHECK_THINKFIRST_COW_DROP(sv);
4061 SvUPGRADE(sv, SVt_PV);
4064 if (flags & SV_SMAGIC)
4068 if (SvPVX_const(sv))
4072 if (flags & SV_HAS_TRAILING_NUL)
4073 assert(ptr[len] == '\0');
4076 allocate = (flags & SV_HAS_TRAILING_NUL)
4077 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4078 if (flags & SV_HAS_TRAILING_NUL) {
4079 /* It's long enough - do nothing.
4080 Specfically Perl_newCONSTSUB is relying on this. */
4083 /* Force a move to shake out bugs in callers. */
4084 char *new_ptr = (char*)safemalloc(allocate);
4085 Copy(ptr, new_ptr, len, char);
4086 PoisonFree(ptr,len,char);
4090 ptr = (char*) saferealloc (ptr, allocate);
4095 SvLEN_set(sv, allocate);
4096 if (!(flags & SV_HAS_TRAILING_NUL)) {
4099 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4101 if (flags & SV_SMAGIC)
4105 #ifdef PERL_OLD_COPY_ON_WRITE
4106 /* Need to do this *after* making the SV normal, as we need the buffer
4107 pointer to remain valid until after we've copied it. If we let go too early,
4108 another thread could invalidate it by unsharing last of the same hash key
4109 (which it can do by means other than releasing copy-on-write Svs)
4110 or by changing the other copy-on-write SVs in the loop. */
4112 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4114 { /* this SV was SvIsCOW_normal(sv) */
4115 /* we need to find the SV pointing to us. */
4116 SV *current = SV_COW_NEXT_SV(after);
4118 if (current == sv) {
4119 /* The SV we point to points back to us (there were only two of us
4121 Hence other SV is no longer copy on write either. */
4123 SvREADONLY_off(after);
4125 /* We need to follow the pointers around the loop. */
4127 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4130 /* don't loop forever if the structure is bust, and we have
4131 a pointer into a closed loop. */
4132 assert (current != after);
4133 assert (SvPVX_const(current) == pvx);
4135 /* Make the SV before us point to the SV after us. */
4136 SV_COW_NEXT_SV_SET(current, after);
4142 =for apidoc sv_force_normal_flags
4144 Undo various types of fakery on an SV: if the PV is a shared string, make
4145 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4146 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4147 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4148 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4149 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4150 set to some other value.) In addition, the C<flags> parameter gets passed to
4151 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4152 with flags set to 0.
4158 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4161 #ifdef PERL_OLD_COPY_ON_WRITE
4162 if (SvREADONLY(sv)) {
4163 /* At this point I believe I should acquire a global SV mutex. */
4165 const char * const pvx = SvPVX_const(sv);
4166 const STRLEN len = SvLEN(sv);
4167 const STRLEN cur = SvCUR(sv);
4168 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4169 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4170 we'll fail an assertion. */
4171 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4174 PerlIO_printf(Perl_debug_log,
4175 "Copy on write: Force normal %ld\n",
4181 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4184 if (flags & SV_COW_DROP_PV) {
4185 /* OK, so we don't need to copy our buffer. */
4188 SvGROW(sv, cur + 1);
4189 Move(pvx,SvPVX(sv),cur,char);
4194 sv_release_COW(sv, pvx, next);
4196 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4202 else if (IN_PERL_RUNTIME)
4203 Perl_croak(aTHX_ PL_no_modify);
4204 /* At this point I believe that I can drop the global SV mutex. */
4207 if (SvREADONLY(sv)) {
4209 const char * const pvx = SvPVX_const(sv);
4210 const STRLEN len = SvCUR(sv);
4215 SvGROW(sv, len + 1);
4216 Move(pvx,SvPVX(sv),len,char);
4218 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4220 else if (IN_PERL_RUNTIME)
4221 Perl_croak(aTHX_ PL_no_modify);
4225 sv_unref_flags(sv, flags);
4226 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4233 Efficient removal of characters from the beginning of the string buffer.
4234 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4235 the string buffer. The C<ptr> becomes the first character of the adjusted
4236 string. Uses the "OOK hack".
4237 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4238 refer to the same chunk of data.
4244 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4250 const U8 *real_start;
4253 if (!ptr || !SvPOKp(sv))
4255 delta = ptr - SvPVX_const(sv);
4257 /* Nothing to do. */
4260 assert(ptr > SvPVX_const(sv));
4261 SV_CHECK_THINKFIRST(sv);
4264 if (!SvLEN(sv)) { /* make copy of shared string */
4265 const char *pvx = SvPVX_const(sv);
4266 const STRLEN len = SvCUR(sv);
4267 SvGROW(sv, len + 1);
4268 Move(pvx,SvPVX(sv),len,char);
4271 SvFLAGS(sv) |= SVf_OOK;
4274 SvOOK_offset(sv, old_delta);
4276 SvLEN_set(sv, SvLEN(sv) - delta);
4277 SvCUR_set(sv, SvCUR(sv) - delta);
4278 SvPV_set(sv, SvPVX(sv) + delta);
4280 p = (U8 *)SvPVX_const(sv);
4285 real_start = p - delta;
4289 if (delta < 0x100) {
4293 p -= sizeof(STRLEN);
4294 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4298 /* Fill the preceding buffer with sentinals to verify that no-one is
4300 while (p > real_start) {
4308 =for apidoc sv_catpvn
4310 Concatenates the string onto the end of the string which is in the SV. The
4311 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4312 status set, then the bytes appended should be valid UTF-8.
4313 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4315 =for apidoc sv_catpvn_flags
4317 Concatenates the string onto the end of the string which is in the SV. The
4318 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4319 status set, then the bytes appended should be valid UTF-8.
4320 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4321 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4322 in terms of this function.
4328 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4332 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4334 SvGROW(dsv, dlen + slen + 1);
4336 sstr = SvPVX_const(dsv);
4337 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4338 SvCUR_set(dsv, SvCUR(dsv) + slen);
4340 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4342 if (flags & SV_SMAGIC)
4347 =for apidoc sv_catsv
4349 Concatenates the string from SV C<ssv> onto the end of the string in
4350 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4351 not 'set' magic. See C<sv_catsv_mg>.
4353 =for apidoc sv_catsv_flags
4355 Concatenates the string from SV C<ssv> onto the end of the string in
4356 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4357 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4358 and C<sv_catsv_nomg> are implemented in terms of this function.
4363 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4368 const char *spv = SvPV_const(ssv, slen);
4370 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4371 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4372 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4373 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4374 dsv->sv_flags doesn't have that bit set.
4375 Andy Dougherty 12 Oct 2001
4377 const I32 sutf8 = DO_UTF8(ssv);
4380 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4382 dutf8 = DO_UTF8(dsv);
4384 if (dutf8 != sutf8) {
4386 /* Not modifying source SV, so taking a temporary copy. */
4387 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4389 sv_utf8_upgrade(csv);
4390 spv = SvPV_const(csv, slen);
4393 sv_utf8_upgrade_nomg(dsv);
4395 sv_catpvn_nomg(dsv, spv, slen);
4398 if (flags & SV_SMAGIC)
4403 =for apidoc sv_catpv
4405 Concatenates the string onto the end of the string which is in the SV.
4406 If the SV has the UTF-8 status set, then the bytes appended should be
4407 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4412 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4415 register STRLEN len;
4421 junk = SvPV_force(sv, tlen);
4423 SvGROW(sv, tlen + len + 1);
4425 ptr = SvPVX_const(sv);
4426 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4427 SvCUR_set(sv, SvCUR(sv) + len);
4428 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4433 =for apidoc sv_catpv_mg
4435 Like C<sv_catpv>, but also handles 'set' magic.
4441 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4450 Creates a new SV. A non-zero C<len> parameter indicates the number of
4451 bytes of preallocated string space the SV should have. An extra byte for a
4452 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4453 space is allocated.) The reference count for the new SV is set to 1.
4455 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4456 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4457 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4458 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4459 modules supporting older perls.
4465 Perl_newSV(pTHX_ STRLEN len)
4472 sv_upgrade(sv, SVt_PV);
4473 SvGROW(sv, len + 1);
4478 =for apidoc sv_magicext
4480 Adds magic to an SV, upgrading it if necessary. Applies the
4481 supplied vtable and returns a pointer to the magic added.
4483 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4484 In particular, you can add magic to SvREADONLY SVs, and add more than
4485 one instance of the same 'how'.
4487 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4488 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4489 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4490 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4492 (This is now used as a subroutine by C<sv_magic>.)
4497 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4498 const char* name, I32 namlen)
4503 SvUPGRADE(sv, SVt_PVMG);
4504 Newxz(mg, 1, MAGIC);
4505 mg->mg_moremagic = SvMAGIC(sv);
4506 SvMAGIC_set(sv, mg);
4508 /* Sometimes a magic contains a reference loop, where the sv and
4509 object refer to each other. To prevent a reference loop that
4510 would prevent such objects being freed, we look for such loops
4511 and if we find one we avoid incrementing the object refcount.
4513 Note we cannot do this to avoid self-tie loops as intervening RV must
4514 have its REFCNT incremented to keep it in existence.
4517 if (!obj || obj == sv ||
4518 how == PERL_MAGIC_arylen ||
4519 how == PERL_MAGIC_symtab ||
4520 (SvTYPE(obj) == SVt_PVGV &&
4521 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4522 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4523 GvFORM(obj) == (CV*)sv)))
4528 mg->mg_obj = SvREFCNT_inc_simple(obj);
4529 mg->mg_flags |= MGf_REFCOUNTED;
4532 /* Normal self-ties simply pass a null object, and instead of
4533 using mg_obj directly, use the SvTIED_obj macro to produce a
4534 new RV as needed. For glob "self-ties", we are tieing the PVIO
4535 with an RV obj pointing to the glob containing the PVIO. In
4536 this case, to avoid a reference loop, we need to weaken the
4540 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4541 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4547 mg->mg_len = namlen;
4550 mg->mg_ptr = savepvn(name, namlen);
4551 else if (namlen == HEf_SVKEY)
4552 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4554 mg->mg_ptr = (char *) name;
4556 mg->mg_virtual = (MGVTBL *) vtable;
4560 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4565 =for apidoc sv_magic
4567 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4568 then adds a new magic item of type C<how> to the head of the magic list.
4570 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4571 handling of the C<name> and C<namlen> arguments.
4573 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4574 to add more than one instance of the same 'how'.
4580 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4583 const MGVTBL *vtable;
4586 #ifdef PERL_OLD_COPY_ON_WRITE
4588 sv_force_normal_flags(sv, 0);
4590 if (SvREADONLY(sv)) {
4592 /* its okay to attach magic to shared strings; the subsequent
4593 * upgrade to PVMG will unshare the string */
4594 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4597 && how != PERL_MAGIC_regex_global
4598 && how != PERL_MAGIC_bm
4599 && how != PERL_MAGIC_fm
4600 && how != PERL_MAGIC_sv
4601 && how != PERL_MAGIC_backref
4604 Perl_croak(aTHX_ PL_no_modify);
4607 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4608 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4609 /* sv_magic() refuses to add a magic of the same 'how' as an
4612 if (how == PERL_MAGIC_taint) {
4614 /* Any scalar which already had taint magic on which someone
4615 (erroneously?) did SvIOK_on() or similar will now be
4616 incorrectly sporting public "OK" flags. */
4617 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4625 vtable = &PL_vtbl_sv;
4627 case PERL_MAGIC_overload:
4628 vtable = &PL_vtbl_amagic;
4630 case PERL_MAGIC_overload_elem:
4631 vtable = &PL_vtbl_amagicelem;
4633 case PERL_MAGIC_overload_table:
4634 vtable = &PL_vtbl_ovrld;
4637 vtable = &PL_vtbl_bm;
4639 case PERL_MAGIC_regdata:
4640 vtable = &PL_vtbl_regdata;
4642 case PERL_MAGIC_regdatum:
4643 vtable = &PL_vtbl_regdatum;
4645 case PERL_MAGIC_env:
4646 vtable = &PL_vtbl_env;
4649 vtable = &PL_vtbl_fm;
4651 case PERL_MAGIC_envelem:
4652 vtable = &PL_vtbl_envelem;
4654 case PERL_MAGIC_regex_global:
4655 vtable = &PL_vtbl_mglob;
4657 case PERL_MAGIC_isa:
4658 vtable = &PL_vtbl_isa;
4660 case PERL_MAGIC_isaelem:
4661 vtable = &PL_vtbl_isaelem;
4663 case PERL_MAGIC_nkeys:
4664 vtable = &PL_vtbl_nkeys;
4666 case PERL_MAGIC_dbfile:
4669 case PERL_MAGIC_dbline:
4670 vtable = &PL_vtbl_dbline;
4672 #ifdef USE_LOCALE_COLLATE
4673 case PERL_MAGIC_collxfrm:
4674 vtable = &PL_vtbl_collxfrm;
4676 #endif /* USE_LOCALE_COLLATE */
4677 case PERL_MAGIC_tied:
4678 vtable = &PL_vtbl_pack;
4680 case PERL_MAGIC_tiedelem:
4681 case PERL_MAGIC_tiedscalar:
4682 vtable = &PL_vtbl_packelem;
4685 vtable = &PL_vtbl_regexp;
4687 case PERL_MAGIC_hints:
4688 /* As this vtable is all NULL, we can reuse it. */
4689 case PERL_MAGIC_sig:
4690 vtable = &PL_vtbl_sig;
4692 case PERL_MAGIC_sigelem:
4693 vtable = &PL_vtbl_sigelem;
4695 case PERL_MAGIC_taint:
4696 vtable = &PL_vtbl_taint;
4698 case PERL_MAGIC_uvar:
4699 vtable = &PL_vtbl_uvar;
4701 case PERL_MAGIC_vec:
4702 vtable = &PL_vtbl_vec;
4704 case PERL_MAGIC_arylen_p:
4705 case PERL_MAGIC_rhash:
4706 case PERL_MAGIC_symtab:
4707 case PERL_MAGIC_vstring:
4710 case PERL_MAGIC_utf8:
4711 vtable = &PL_vtbl_utf8;
4713 case PERL_MAGIC_substr:
4714 vtable = &PL_vtbl_substr;
4716 case PERL_MAGIC_defelem:
4717 vtable = &PL_vtbl_defelem;
4719 case PERL_MAGIC_arylen:
4720 vtable = &PL_vtbl_arylen;
4722 case PERL_MAGIC_pos:
4723 vtable = &PL_vtbl_pos;
4725 case PERL_MAGIC_backref:
4726 vtable = &PL_vtbl_backref;
4728 case PERL_MAGIC_hintselem:
4729 vtable = &PL_vtbl_hintselem;
4731 case PERL_MAGIC_ext:
4732 /* Reserved for use by extensions not perl internals. */
4733 /* Useful for attaching extension internal data to perl vars. */
4734 /* Note that multiple extensions may clash if magical scalars */
4735 /* etc holding private data from one are passed to another. */
4739 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4742 /* Rest of work is done else where */
4743 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4746 case PERL_MAGIC_taint:
4749 case PERL_MAGIC_ext:
4750 case PERL_MAGIC_dbfile:
4757 =for apidoc sv_unmagic
4759 Removes all magic of type C<type> from an SV.
4765 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4769 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4771 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4772 for (mg = *mgp; mg; mg = *mgp) {
4773 if (mg->mg_type == type) {
4774 const MGVTBL* const vtbl = mg->mg_virtual;
4775 *mgp = mg->mg_moremagic;
4776 if (vtbl && vtbl->svt_free)
4777 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4778 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4780 Safefree(mg->mg_ptr);
4781 else if (mg->mg_len == HEf_SVKEY)
4782 SvREFCNT_dec((SV*)mg->mg_ptr);
4783 else if (mg->mg_type == PERL_MAGIC_utf8)
4784 Safefree(mg->mg_ptr);
4786 if (mg->mg_flags & MGf_REFCOUNTED)
4787 SvREFCNT_dec(mg->mg_obj);
4791 mgp = &mg->mg_moremagic;
4795 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4796 SvMAGIC_set(sv, NULL);
4803 =for apidoc sv_rvweaken
4805 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4806 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4807 push a back-reference to this RV onto the array of backreferences
4808 associated with that magic. If the RV is magical, set magic will be
4809 called after the RV is cleared.
4815 Perl_sv_rvweaken(pTHX_ SV *sv)
4818 if (!SvOK(sv)) /* let undefs pass */
4821 Perl_croak(aTHX_ "Can't weaken a nonreference");
4822 else if (SvWEAKREF(sv)) {
4823 if (ckWARN(WARN_MISC))
4824 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4828 Perl_sv_add_backref(aTHX_ tsv, sv);
4834 /* Give tsv backref magic if it hasn't already got it, then push a
4835 * back-reference to sv onto the array associated with the backref magic.
4839 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4844 if (SvTYPE(tsv) == SVt_PVHV) {
4845 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4849 /* There is no AV in the offical place - try a fixup. */
4850 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4853 /* Aha. They've got it stowed in magic. Bring it back. */
4854 av = (AV*)mg->mg_obj;
4855 /* Stop mg_free decreasing the refernce count. */
4857 /* Stop mg_free even calling the destructor, given that
4858 there's no AV to free up. */
4860 sv_unmagic(tsv, PERL_MAGIC_backref);
4864 SvREFCNT_inc_simple_void(av);
4869 const MAGIC *const mg
4870 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4872 av = (AV*)mg->mg_obj;
4876 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4877 /* av now has a refcnt of 2, which avoids it getting freed
4878 * before us during global cleanup. The extra ref is removed
4879 * by magic_killbackrefs() when tsv is being freed */
4882 if (AvFILLp(av) >= AvMAX(av)) {
4883 av_extend(av, AvFILLp(av)+1);
4885 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4888 /* delete a back-reference to ourselves from the backref magic associated
4889 * with the SV we point to.
4893 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4900 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4901 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4902 /* We mustn't attempt to "fix up" the hash here by moving the
4903 backreference array back to the hv_aux structure, as that is stored
4904 in the main HvARRAY(), and hfreentries assumes that no-one
4905 reallocates HvARRAY() while it is running. */
4908 const MAGIC *const mg
4909 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4911 av = (AV *)mg->mg_obj;
4914 if (PL_in_clean_all)
4916 Perl_croak(aTHX_ "panic: del_backref");
4923 /* We shouldn't be in here more than once, but for paranoia reasons lets
4925 for (i = AvFILLp(av); i >= 0; i--) {
4927 const SSize_t fill = AvFILLp(av);
4929 /* We weren't the last entry.
4930 An unordered list has this property that you can take the
4931 last element off the end to fill the hole, and it's still
4932 an unordered list :-)
4937 AvFILLp(av) = fill - 1;
4943 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4945 SV **svp = AvARRAY(av);
4947 PERL_UNUSED_ARG(sv);
4949 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4950 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4951 if (svp && !SvIS_FREED(av)) {
4952 SV *const *const last = svp + AvFILLp(av);
4954 while (svp <= last) {
4956 SV *const referrer = *svp;
4957 if (SvWEAKREF(referrer)) {
4958 /* XXX Should we check that it hasn't changed? */
4959 SvRV_set(referrer, 0);
4961 SvWEAKREF_off(referrer);
4962 SvSETMAGIC(referrer);
4963 } else if (SvTYPE(referrer) == SVt_PVGV ||
4964 SvTYPE(referrer) == SVt_PVLV) {
4965 /* You lookin' at me? */
4966 assert(GvSTASH(referrer));
4967 assert(GvSTASH(referrer) == (HV*)sv);
4968 GvSTASH(referrer) = 0;
4971 "panic: magic_killbackrefs (flags=%"UVxf")",
4972 (UV)SvFLAGS(referrer));
4980 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4985 =for apidoc sv_insert
4987 Inserts a string at the specified offset/length within the SV. Similar to
4988 the Perl substr() function.
4994 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4999 register char *midend;
5000 register char *bigend;
5006 Perl_croak(aTHX_ "Can't modify non-existent substring");
5007 SvPV_force(bigstr, curlen);
5008 (void)SvPOK_only_UTF8(bigstr);
5009 if (offset + len > curlen) {
5010 SvGROW(bigstr, offset+len+1);
5011 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5012 SvCUR_set(bigstr, offset+len);
5016 i = littlelen - len;
5017 if (i > 0) { /* string might grow */
5018 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5019 mid = big + offset + len;
5020 midend = bigend = big + SvCUR(bigstr);
5023 while (midend > mid) /* shove everything down */
5024 *--bigend = *--midend;
5025 Move(little,big+offset,littlelen,char);
5026 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5031 Move(little,SvPVX(bigstr)+offset,len,char);
5036 big = SvPVX(bigstr);
5039 bigend = big + SvCUR(bigstr);
5041 if (midend > bigend)
5042 Perl_croak(aTHX_ "panic: sv_insert");
5044 if (mid - big > bigend - midend) { /* faster to shorten from end */
5046 Move(little, mid, littlelen,char);
5049 i = bigend - midend;
5051 Move(midend, mid, i,char);
5055 SvCUR_set(bigstr, mid - big);
5057 else if ((i = mid - big)) { /* faster from front */
5058 midend -= littlelen;
5060 Move(big, midend - i, i, char);
5061 sv_chop(bigstr,midend-i);
5063 Move(little, mid, littlelen,char);
5065 else if (littlelen) {
5066 midend -= littlelen;
5067 sv_chop(bigstr,midend);
5068 Move(little,midend,littlelen,char);
5071 sv_chop(bigstr,midend);
5077 =for apidoc sv_replace
5079 Make the first argument a copy of the second, then delete the original.
5080 The target SV physically takes over ownership of the body of the source SV
5081 and inherits its flags; however, the target keeps any magic it owns,
5082 and any magic in the source is discarded.
5083 Note that this is a rather specialist SV copying operation; most of the
5084 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5090 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5093 const U32 refcnt = SvREFCNT(sv);
5094 SV_CHECK_THINKFIRST_COW_DROP(sv);
5095 if (SvREFCNT(nsv) != 1) {
5096 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5097 UVuf " != 1)", (UV) SvREFCNT(nsv));
5099 if (SvMAGICAL(sv)) {
5103 sv_upgrade(nsv, SVt_PVMG);
5104 SvMAGIC_set(nsv, SvMAGIC(sv));
5105 SvFLAGS(nsv) |= SvMAGICAL(sv);
5107 SvMAGIC_set(sv, NULL);
5111 assert(!SvREFCNT(sv));
5112 #ifdef DEBUG_LEAKING_SCALARS
5113 sv->sv_flags = nsv->sv_flags;
5114 sv->sv_any = nsv->sv_any;
5115 sv->sv_refcnt = nsv->sv_refcnt;
5116 sv->sv_u = nsv->sv_u;
5118 StructCopy(nsv,sv,SV);
5120 if(SvTYPE(sv) == SVt_IV) {
5122 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5126 #ifdef PERL_OLD_COPY_ON_WRITE
5127 if (SvIsCOW_normal(nsv)) {
5128 /* We need to follow the pointers around the loop to make the
5129 previous SV point to sv, rather than nsv. */
5132 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5135 assert(SvPVX_const(current) == SvPVX_const(nsv));
5137 /* Make the SV before us point to the SV after us. */
5139 PerlIO_printf(Perl_debug_log, "previous is\n");
5141 PerlIO_printf(Perl_debug_log,
5142 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5143 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5145 SV_COW_NEXT_SV_SET(current, sv);
5148 SvREFCNT(sv) = refcnt;
5149 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5155 =for apidoc sv_clear
5157 Clear an SV: call any destructors, free up any memory used by the body,
5158 and free the body itself. The SV's head is I<not> freed, although
5159 its type is set to all 1's so that it won't inadvertently be assumed
5160 to be live during global destruction etc.
5161 This function should only be called when REFCNT is zero. Most of the time
5162 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5169 Perl_sv_clear(pTHX_ register SV *sv)
5172 const U32 type = SvTYPE(sv);
5173 const struct body_details *const sv_type_details
5174 = bodies_by_type + type;
5178 assert(SvREFCNT(sv) == 0);
5179 assert(SvTYPE(sv) != SVTYPEMASK);
5181 if (type <= SVt_IV) {
5182 /* See the comment in sv.h about the collusion between this early
5183 return and the overloading of the NULL and IV slots in the size
5186 SV * const target = SvRV(sv);
5188 sv_del_backref(target, sv);
5190 SvREFCNT_dec(target);
5192 SvFLAGS(sv) &= SVf_BREAK;
5193 SvFLAGS(sv) |= SVTYPEMASK;
5198 if (PL_defstash && /* Still have a symbol table? */
5205 stash = SvSTASH(sv);
5206 destructor = StashHANDLER(stash,DESTROY);
5208 SV* const tmpref = newRV(sv);
5209 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5211 PUSHSTACKi(PERLSI_DESTROY);
5216 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5222 if(SvREFCNT(tmpref) < 2) {
5223 /* tmpref is not kept alive! */
5225 SvRV_set(tmpref, NULL);
5228 SvREFCNT_dec(tmpref);
5230 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5234 if (PL_in_clean_objs)
5235 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5237 /* DESTROY gave object new lease on life */
5243 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5244 SvOBJECT_off(sv); /* Curse the object. */
5245 if (type != SVt_PVIO)
5246 --PL_sv_objcount; /* XXX Might want something more general */
5249 if (type >= SVt_PVMG) {
5250 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5251 SvREFCNT_dec(SvOURSTASH(sv));
5252 } else if (SvMAGIC(sv))
5254 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5255 SvREFCNT_dec(SvSTASH(sv));
5258 /* case SVt_BIND: */
5261 IoIFP(sv) != PerlIO_stdin() &&
5262 IoIFP(sv) != PerlIO_stdout() &&
5263 IoIFP(sv) != PerlIO_stderr())
5265 io_close((IO*)sv, FALSE);
5267 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5268 PerlDir_close(IoDIRP(sv));
5269 IoDIRP(sv) = (DIR*)NULL;
5270 Safefree(IoTOP_NAME(sv));
5271 Safefree(IoFMT_NAME(sv));
5272 Safefree(IoBOTTOM_NAME(sv));
5275 /* FIXME for plugins */
5276 pregfree2((REGEXP*) sv);
5283 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5287 if (PL_comppad == (AV*)sv) {
5294 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5295 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5296 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5297 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5299 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5300 SvREFCNT_dec(LvTARG(sv));
5302 if (isGV_with_GP(sv)) {
5303 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5304 mro_method_changed_in(stash);
5307 unshare_hek(GvNAME_HEK(sv));
5308 /* If we're in a stash, we don't own a reference to it. However it does
5309 have a back reference to us, which needs to be cleared. */
5310 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5311 sv_del_backref((SV*)stash, sv);
5313 /* FIXME. There are probably more unreferenced pointers to SVs in the
5314 interpreter struct that we should check and tidy in a similar
5316 if ((GV*)sv == PL_last_in_gv)
5317 PL_last_in_gv = NULL;
5323 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5326 SvOOK_offset(sv, offset);
5327 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5328 /* Don't even bother with turning off the OOK flag. */
5331 SV * const target = SvRV(sv);
5333 sv_del_backref(target, sv);
5335 SvREFCNT_dec(target);
5337 #ifdef PERL_OLD_COPY_ON_WRITE
5338 else if (SvPVX_const(sv)) {
5340 /* I believe I need to grab the global SV mutex here and
5341 then recheck the COW status. */
5343 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5347 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5349 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5352 /* And drop it here. */
5354 } else if (SvLEN(sv)) {
5355 Safefree(SvPVX_const(sv));
5359 else if (SvPVX_const(sv) && SvLEN(sv))
5360 Safefree(SvPVX_mutable(sv));
5361 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5362 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5371 SvFLAGS(sv) &= SVf_BREAK;
5372 SvFLAGS(sv) |= SVTYPEMASK;
5374 if (sv_type_details->arena) {
5375 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5376 &PL_body_roots[type]);
5378 else if (sv_type_details->body_size) {
5379 my_safefree(SvANY(sv));
5384 =for apidoc sv_newref
5386 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5393 Perl_sv_newref(pTHX_ SV *sv)
5395 PERL_UNUSED_CONTEXT;
5404 Decrement an SV's reference count, and if it drops to zero, call
5405 C<sv_clear> to invoke destructors and free up any memory used by
5406 the body; finally, deallocate the SV's head itself.
5407 Normally called via a wrapper macro C<SvREFCNT_dec>.
5413 Perl_sv_free(pTHX_ SV *sv)
5418 if (SvREFCNT(sv) == 0) {
5419 if (SvFLAGS(sv) & SVf_BREAK)
5420 /* this SV's refcnt has been artificially decremented to
5421 * trigger cleanup */
5423 if (PL_in_clean_all) /* All is fair */
5425 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5426 /* make sure SvREFCNT(sv)==0 happens very seldom */
5427 SvREFCNT(sv) = (~(U32)0)/2;
5430 if (ckWARN_d(WARN_INTERNAL)) {
5431 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5432 Perl_dump_sv_child(aTHX_ sv);
5434 #ifdef DEBUG_LEAKING_SCALARS
5437 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5438 if (PL_warnhook == PERL_WARNHOOK_FATAL
5439 || ckDEAD(packWARN(WARN_INTERNAL))) {
5440 /* Don't let Perl_warner cause us to escape our fate: */
5444 /* This may not return: */
5445 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5446 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5447 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5450 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5455 if (--(SvREFCNT(sv)) > 0)
5457 Perl_sv_free2(aTHX_ sv);
5461 Perl_sv_free2(pTHX_ SV *sv)
5466 if (ckWARN_d(WARN_DEBUGGING))
5467 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5468 "Attempt to free temp prematurely: SV 0x%"UVxf
5469 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5473 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5474 /* make sure SvREFCNT(sv)==0 happens very seldom */
5475 SvREFCNT(sv) = (~(U32)0)/2;
5486 Returns the length of the string in the SV. Handles magic and type
5487 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5493 Perl_sv_len(pTHX_ register SV *sv)
5501 len = mg_length(sv);
5503 (void)SvPV_const(sv, len);
5508 =for apidoc sv_len_utf8
5510 Returns the number of characters in the string in an SV, counting wide
5511 UTF-8 bytes as a single character. Handles magic and type coercion.
5517 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5518 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5519 * (Note that the mg_len is not the length of the mg_ptr field.
5520 * This allows the cache to store the character length of the string without
5521 * needing to malloc() extra storage to attach to the mg_ptr.)
5526 Perl_sv_len_utf8(pTHX_ register SV *sv)
5532 return mg_length(sv);
5536 const U8 *s = (U8*)SvPV_const(sv, len);
5540 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5542 if (mg && mg->mg_len != -1) {
5544 if (PL_utf8cache < 0) {
5545 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5547 /* Need to turn the assertions off otherwise we may
5548 recurse infinitely while printing error messages.
5550 SAVEI8(PL_utf8cache);
5552 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5553 " real %"UVuf" for %"SVf,
5554 (UV) ulen, (UV) real, SVfARG(sv));
5559 ulen = Perl_utf8_length(aTHX_ s, s + len);
5560 if (!SvREADONLY(sv)) {
5562 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5563 &PL_vtbl_utf8, 0, 0);
5571 return Perl_utf8_length(aTHX_ s, s + len);
5575 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5578 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5581 const U8 *s = start;
5583 while (s < send && uoffset--)
5586 /* This is the existing behaviour. Possibly it should be a croak, as
5587 it's actually a bounds error */
5593 /* Given the length of the string in both bytes and UTF-8 characters, decide
5594 whether to walk forwards or backwards to find the byte corresponding to
5595 the passed in UTF-8 offset. */
5597 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5598 STRLEN uoffset, STRLEN uend)
5600 STRLEN backw = uend - uoffset;
5601 if (uoffset < 2 * backw) {
5602 /* The assumption is that going forwards is twice the speed of going
5603 forward (that's where the 2 * backw comes from).
5604 (The real figure of course depends on the UTF-8 data.) */
5605 return sv_pos_u2b_forwards(start, send, uoffset);
5610 while (UTF8_IS_CONTINUATION(*send))
5613 return send - start;
5616 /* For the string representation of the given scalar, find the byte
5617 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5618 give another position in the string, *before* the sought offset, which
5619 (which is always true, as 0, 0 is a valid pair of positions), which should
5620 help reduce the amount of linear searching.
5621 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5622 will be used to reduce the amount of linear searching. The cache will be
5623 created if necessary, and the found value offered to it for update. */
5625 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5626 const U8 *const send, STRLEN uoffset,
5627 STRLEN uoffset0, STRLEN boffset0) {
5628 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5631 assert (uoffset >= uoffset0);
5633 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5634 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5635 if ((*mgp)->mg_ptr) {
5636 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5637 if (cache[0] == uoffset) {
5638 /* An exact match. */
5641 if (cache[2] == uoffset) {
5642 /* An exact match. */
5646 if (cache[0] < uoffset) {
5647 /* The cache already knows part of the way. */
5648 if (cache[0] > uoffset0) {
5649 /* The cache knows more than the passed in pair */
5650 uoffset0 = cache[0];
5651 boffset0 = cache[1];
5653 if ((*mgp)->mg_len != -1) {
5654 /* And we know the end too. */
5656 + sv_pos_u2b_midway(start + boffset0, send,
5658 (*mgp)->mg_len - uoffset0);
5661 + sv_pos_u2b_forwards(start + boffset0,
5662 send, uoffset - uoffset0);
5665 else if (cache[2] < uoffset) {
5666 /* We're between the two cache entries. */
5667 if (cache[2] > uoffset0) {
5668 /* and the cache knows more than the passed in pair */
5669 uoffset0 = cache[2];
5670 boffset0 = cache[3];
5674 + sv_pos_u2b_midway(start + boffset0,
5677 cache[0] - uoffset0);
5680 + sv_pos_u2b_midway(start + boffset0,
5683 cache[2] - uoffset0);
5687 else if ((*mgp)->mg_len != -1) {
5688 /* If we can take advantage of a passed in offset, do so. */
5689 /* In fact, offset0 is either 0, or less than offset, so don't
5690 need to worry about the other possibility. */
5692 + sv_pos_u2b_midway(start + boffset0, send,
5694 (*mgp)->mg_len - uoffset0);
5699 if (!found || PL_utf8cache < 0) {
5700 const STRLEN real_boffset
5701 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5702 send, uoffset - uoffset0);
5704 if (found && PL_utf8cache < 0) {
5705 if (real_boffset != boffset) {
5706 /* Need to turn the assertions off otherwise we may recurse
5707 infinitely while printing error messages. */
5708 SAVEI8(PL_utf8cache);
5710 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5711 " real %"UVuf" for %"SVf,
5712 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5715 boffset = real_boffset;
5718 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5724 =for apidoc sv_pos_u2b
5726 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5727 the start of the string, to a count of the equivalent number of bytes; if
5728 lenp is non-zero, it does the same to lenp, but this time starting from
5729 the offset, rather than from the start of the string. Handles magic and
5736 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5737 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5738 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5743 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5751 start = (U8*)SvPV_const(sv, len);
5753 STRLEN uoffset = (STRLEN) *offsetp;
5754 const U8 * const send = start + len;
5756 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5759 *offsetp = (I32) boffset;
5762 /* Convert the relative offset to absolute. */
5763 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5764 const STRLEN boffset2
5765 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5766 uoffset, boffset) - boffset;
5780 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5781 byte length pairing. The (byte) length of the total SV is passed in too,
5782 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5783 may not have updated SvCUR, so we can't rely on reading it directly.
5785 The proffered utf8/byte length pairing isn't used if the cache already has
5786 two pairs, and swapping either for the proffered pair would increase the
5787 RMS of the intervals between known byte offsets.
5789 The cache itself consists of 4 STRLEN values
5790 0: larger UTF-8 offset
5791 1: corresponding byte offset
5792 2: smaller UTF-8 offset
5793 3: corresponding byte offset
5795 Unused cache pairs have the value 0, 0.
5796 Keeping the cache "backwards" means that the invariant of
5797 cache[0] >= cache[2] is maintained even with empty slots, which means that
5798 the code that uses it doesn't need to worry if only 1 entry has actually
5799 been set to non-zero. It also makes the "position beyond the end of the
5800 cache" logic much simpler, as the first slot is always the one to start
5804 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5812 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5814 (*mgp)->mg_len = -1;
5818 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5819 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5820 (*mgp)->mg_ptr = (char *) cache;
5824 if (PL_utf8cache < 0) {
5825 const U8 *start = (const U8 *) SvPVX_const(sv);
5826 const STRLEN realutf8 = utf8_length(start, start + byte);
5828 if (realutf8 != utf8) {
5829 /* Need to turn the assertions off otherwise we may recurse
5830 infinitely while printing error messages. */
5831 SAVEI8(PL_utf8cache);
5833 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5834 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5838 /* Cache is held with the later position first, to simplify the code
5839 that deals with unbounded ends. */
5841 ASSERT_UTF8_CACHE(cache);
5842 if (cache[1] == 0) {
5843 /* Cache is totally empty */
5846 } else if (cache[3] == 0) {
5847 if (byte > cache[1]) {
5848 /* New one is larger, so goes first. */
5849 cache[2] = cache[0];
5850 cache[3] = cache[1];
5858 #define THREEWAY_SQUARE(a,b,c,d) \
5859 ((float)((d) - (c))) * ((float)((d) - (c))) \
5860 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5861 + ((float)((b) - (a))) * ((float)((b) - (a)))
5863 /* Cache has 2 slots in use, and we know three potential pairs.
5864 Keep the two that give the lowest RMS distance. Do the
5865 calcualation in bytes simply because we always know the byte
5866 length. squareroot has the same ordering as the positive value,
5867 so don't bother with the actual square root. */
5868 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5869 if (byte > cache[1]) {
5870 /* New position is after the existing pair of pairs. */
5871 const float keep_earlier
5872 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5873 const float keep_later
5874 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5876 if (keep_later < keep_earlier) {
5877 if (keep_later < existing) {
5878 cache[2] = cache[0];
5879 cache[3] = cache[1];
5885 if (keep_earlier < existing) {
5891 else if (byte > cache[3]) {
5892 /* New position is between the existing pair of pairs. */
5893 const float keep_earlier
5894 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5895 const float keep_later
5896 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5898 if (keep_later < keep_earlier) {
5899 if (keep_later < existing) {
5905 if (keep_earlier < existing) {
5912 /* New position is before the existing pair of pairs. */
5913 const float keep_earlier
5914 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5915 const float keep_later
5916 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5918 if (keep_later < keep_earlier) {
5919 if (keep_later < existing) {
5925 if (keep_earlier < existing) {
5926 cache[0] = cache[2];
5927 cache[1] = cache[3];
5934 ASSERT_UTF8_CACHE(cache);
5937 /* We already know all of the way, now we may be able to walk back. The same
5938 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5939 backward is half the speed of walking forward. */
5941 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5944 const STRLEN forw = target - s;
5945 STRLEN backw = end - target;
5947 if (forw < 2 * backw) {
5948 return utf8_length(s, target);
5951 while (end > target) {
5953 while (UTF8_IS_CONTINUATION(*end)) {
5962 =for apidoc sv_pos_b2u
5964 Converts the value pointed to by offsetp from a count of bytes from the
5965 start of the string, to a count of the equivalent number of UTF-8 chars.
5966 Handles magic and type coercion.
5972 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5973 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5978 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5981 const STRLEN byte = *offsetp;
5982 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5991 s = (const U8*)SvPV_const(sv, blen);
5994 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5998 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5999 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6001 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6002 if (cache[1] == byte) {
6003 /* An exact match. */
6004 *offsetp = cache[0];
6007 if (cache[3] == byte) {
6008 /* An exact match. */
6009 *offsetp = cache[2];
6013 if (cache[1] < byte) {
6014 /* We already know part of the way. */
6015 if (mg->mg_len != -1) {
6016 /* Actually, we know the end too. */
6018 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6019 s + blen, mg->mg_len - cache[0]);
6021 len = cache[0] + utf8_length(s + cache[1], send);
6024 else if (cache[3] < byte) {
6025 /* We're between the two cached pairs, so we do the calculation
6026 offset by the byte/utf-8 positions for the earlier pair,
6027 then add the utf-8 characters from the string start to
6029 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6030 s + cache[1], cache[0] - cache[2])
6034 else { /* cache[3] > byte */
6035 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6039 ASSERT_UTF8_CACHE(cache);
6041 } else if (mg->mg_len != -1) {
6042 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6046 if (!found || PL_utf8cache < 0) {
6047 const STRLEN real_len = utf8_length(s, send);
6049 if (found && PL_utf8cache < 0) {
6050 if (len != real_len) {
6051 /* Need to turn the assertions off otherwise we may recurse
6052 infinitely while printing error messages. */
6053 SAVEI8(PL_utf8cache);
6055 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6056 " real %"UVuf" for %"SVf,
6057 (UV) len, (UV) real_len, SVfARG(sv));
6064 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6070 Returns a boolean indicating whether the strings in the two SVs are
6071 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6072 coerce its args to strings if necessary.
6078 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6087 SV* svrecode = NULL;
6094 /* if pv1 and pv2 are the same, second SvPV_const call may
6095 * invalidate pv1, so we may need to make a copy */
6096 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6097 pv1 = SvPV_const(sv1, cur1);
6098 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6100 pv1 = SvPV_const(sv1, cur1);
6108 pv2 = SvPV_const(sv2, cur2);
6110 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6111 /* Differing utf8ness.
6112 * Do not UTF8size the comparands as a side-effect. */
6115 svrecode = newSVpvn(pv2, cur2);
6116 sv_recode_to_utf8(svrecode, PL_encoding);
6117 pv2 = SvPV_const(svrecode, cur2);
6120 svrecode = newSVpvn(pv1, cur1);
6121 sv_recode_to_utf8(svrecode, PL_encoding);
6122 pv1 = SvPV_const(svrecode, cur1);
6124 /* Now both are in UTF-8. */
6126 SvREFCNT_dec(svrecode);
6131 bool is_utf8 = TRUE;
6134 /* sv1 is the UTF-8 one,
6135 * if is equal it must be downgrade-able */
6136 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6142 /* sv2 is the UTF-8 one,
6143 * if is equal it must be downgrade-able */
6144 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6150 /* Downgrade not possible - cannot be eq */
6158 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6160 SvREFCNT_dec(svrecode);
6170 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6171 string in C<sv1> is less than, equal to, or greater than the string in
6172 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6173 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6179 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6183 const char *pv1, *pv2;
6186 SV *svrecode = NULL;
6193 pv1 = SvPV_const(sv1, cur1);
6200 pv2 = SvPV_const(sv2, cur2);
6202 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6203 /* Differing utf8ness.
6204 * Do not UTF8size the comparands as a side-effect. */
6207 svrecode = newSVpvn(pv2, cur2);
6208 sv_recode_to_utf8(svrecode, PL_encoding);
6209 pv2 = SvPV_const(svrecode, cur2);
6212 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6217 svrecode = newSVpvn(pv1, cur1);
6218 sv_recode_to_utf8(svrecode, PL_encoding);
6219 pv1 = SvPV_const(svrecode, cur1);
6222 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6228 cmp = cur2 ? -1 : 0;
6232 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6235 cmp = retval < 0 ? -1 : 1;
6236 } else if (cur1 == cur2) {
6239 cmp = cur1 < cur2 ? -1 : 1;
6243 SvREFCNT_dec(svrecode);
6251 =for apidoc sv_cmp_locale
6253 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6254 'use bytes' aware, handles get magic, and will coerce its args to strings
6255 if necessary. See also C<sv_cmp>.
6261 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6264 #ifdef USE_LOCALE_COLLATE
6270 if (PL_collation_standard)
6274 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6276 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6278 if (!pv1 || !len1) {
6289 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6292 return retval < 0 ? -1 : 1;
6295 * When the result of collation is equality, that doesn't mean
6296 * that there are no differences -- some locales exclude some
6297 * characters from consideration. So to avoid false equalities,
6298 * we use the raw string as a tiebreaker.
6304 #endif /* USE_LOCALE_COLLATE */
6306 return sv_cmp(sv1, sv2);
6310 #ifdef USE_LOCALE_COLLATE
6313 =for apidoc sv_collxfrm
6315 Add Collate Transform magic to an SV if it doesn't already have it.
6317 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6318 scalar data of the variable, but transformed to such a format that a normal
6319 memory comparison can be used to compare the data according to the locale
6326 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6331 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6332 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6338 Safefree(mg->mg_ptr);
6339 s = SvPV_const(sv, len);
6340 if ((xf = mem_collxfrm(s, len, &xlen))) {
6341 if (SvREADONLY(sv)) {
6344 return xf + sizeof(PL_collation_ix);
6347 #ifdef PERL_OLD_COPY_ON_WRITE
6349 sv_force_normal_flags(sv, 0);
6351 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6365 if (mg && mg->mg_ptr) {
6367 return mg->mg_ptr + sizeof(PL_collation_ix);
6375 #endif /* USE_LOCALE_COLLATE */
6380 Get a line from the filehandle and store it into the SV, optionally
6381 appending to the currently-stored string.
6387 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6392 register STDCHAR rslast;
6393 register STDCHAR *bp;
6398 if (SvTHINKFIRST(sv))
6399 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6400 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6402 However, perlbench says it's slower, because the existing swipe code
6403 is faster than copy on write.
6404 Swings and roundabouts. */
6405 SvUPGRADE(sv, SVt_PV);
6410 if (PerlIO_isutf8(fp)) {
6412 sv_utf8_upgrade_nomg(sv);
6413 sv_pos_u2b(sv,&append,0);
6415 } else if (SvUTF8(sv)) {
6416 SV * const tsv = newSV(0);
6417 sv_gets(tsv, fp, 0);
6418 sv_utf8_upgrade_nomg(tsv);
6419 SvCUR_set(sv,append);
6422 goto return_string_or_null;
6427 if (PerlIO_isutf8(fp))
6430 if (IN_PERL_COMPILETIME) {
6431 /* we always read code in line mode */
6435 else if (RsSNARF(PL_rs)) {
6436 /* If it is a regular disk file use size from stat() as estimate
6437 of amount we are going to read -- may result in mallocing
6438 more memory than we really need if the layers below reduce
6439 the size we read (e.g. CRLF or a gzip layer).
6442 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6443 const Off_t offset = PerlIO_tell(fp);
6444 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6445 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6451 else if (RsRECORD(PL_rs)) {
6456 /* Grab the size of the record we're getting */
6457 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6458 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6461 /* VMS wants read instead of fread, because fread doesn't respect */
6462 /* RMS record boundaries. This is not necessarily a good thing to be */
6463 /* doing, but we've got no other real choice - except avoid stdio
6464 as implementation - perhaps write a :vms layer ?
6466 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6468 bytesread = PerlIO_read(fp, buffer, recsize);
6472 SvCUR_set(sv, bytesread += append);
6473 buffer[bytesread] = '\0';
6474 goto return_string_or_null;
6476 else if (RsPARA(PL_rs)) {
6482 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6483 if (PerlIO_isutf8(fp)) {
6484 rsptr = SvPVutf8(PL_rs, rslen);
6487 if (SvUTF8(PL_rs)) {
6488 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6489 Perl_croak(aTHX_ "Wide character in $/");
6492 rsptr = SvPV_const(PL_rs, rslen);
6496 rslast = rslen ? rsptr[rslen - 1] : '\0';
6498 if (rspara) { /* have to do this both before and after */
6499 do { /* to make sure file boundaries work right */
6502 i = PerlIO_getc(fp);
6506 PerlIO_ungetc(fp,i);
6512 /* See if we know enough about I/O mechanism to cheat it ! */
6514 /* This used to be #ifdef test - it is made run-time test for ease
6515 of abstracting out stdio interface. One call should be cheap
6516 enough here - and may even be a macro allowing compile
6520 if (PerlIO_fast_gets(fp)) {
6523 * We're going to steal some values from the stdio struct
6524 * and put EVERYTHING in the innermost loop into registers.
6526 register STDCHAR *ptr;
6530 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6531 /* An ungetc()d char is handled separately from the regular
6532 * buffer, so we getc() it back out and stuff it in the buffer.
6534 i = PerlIO_getc(fp);
6535 if (i == EOF) return 0;
6536 *(--((*fp)->_ptr)) = (unsigned char) i;
6540 /* Here is some breathtakingly efficient cheating */
6542 cnt = PerlIO_get_cnt(fp); /* get count into register */
6543 /* make sure we have the room */
6544 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6545 /* Not room for all of it
6546 if we are looking for a separator and room for some
6548 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6549 /* just process what we have room for */
6550 shortbuffered = cnt - SvLEN(sv) + append + 1;
6551 cnt -= shortbuffered;
6555 /* remember that cnt can be negative */
6556 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6561 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6562 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6563 DEBUG_P(PerlIO_printf(Perl_debug_log,
6564 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6565 DEBUG_P(PerlIO_printf(Perl_debug_log,
6566 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6567 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6568 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6573 while (cnt > 0) { /* this | eat */
6575 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6576 goto thats_all_folks; /* screams | sed :-) */
6580 Copy(ptr, bp, cnt, char); /* this | eat */
6581 bp += cnt; /* screams | dust */
6582 ptr += cnt; /* louder | sed :-) */
6587 if (shortbuffered) { /* oh well, must extend */
6588 cnt = shortbuffered;
6590 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6592 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6593 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6597 DEBUG_P(PerlIO_printf(Perl_debug_log,
6598 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6599 PTR2UV(ptr),(long)cnt));
6600 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6602 DEBUG_P(PerlIO_printf(Perl_debug_log,
6603 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6604 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6605 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6607 /* This used to call 'filbuf' in stdio form, but as that behaves like
6608 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6609 another abstraction. */
6610 i = PerlIO_getc(fp); /* get more characters */
6612 DEBUG_P(PerlIO_printf(Perl_debug_log,
6613 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6614 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6615 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6617 cnt = PerlIO_get_cnt(fp);
6618 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6619 DEBUG_P(PerlIO_printf(Perl_debug_log,
6620 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6622 if (i == EOF) /* all done for ever? */
6623 goto thats_really_all_folks;
6625 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6627 SvGROW(sv, bpx + cnt + 2);
6628 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6630 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6632 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6633 goto thats_all_folks;
6637 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6638 memNE((char*)bp - rslen, rsptr, rslen))
6639 goto screamer; /* go back to the fray */
6640 thats_really_all_folks:
6642 cnt += shortbuffered;
6643 DEBUG_P(PerlIO_printf(Perl_debug_log,
6644 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6645 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6646 DEBUG_P(PerlIO_printf(Perl_debug_log,
6647 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6648 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6649 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6651 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6652 DEBUG_P(PerlIO_printf(Perl_debug_log,
6653 "Screamer: done, len=%ld, string=|%.*s|\n",
6654 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6658 /*The big, slow, and stupid way. */
6659 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6660 STDCHAR *buf = NULL;
6661 Newx(buf, 8192, STDCHAR);
6669 register const STDCHAR * const bpe = buf + sizeof(buf);
6671 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6672 ; /* keep reading */
6676 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6677 /* Accomodate broken VAXC compiler, which applies U8 cast to
6678 * both args of ?: operator, causing EOF to change into 255
6681 i = (U8)buf[cnt - 1];
6687 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6689 sv_catpvn(sv, (char *) buf, cnt);
6691 sv_setpvn(sv, (char *) buf, cnt);
6693 if (i != EOF && /* joy */
6695 SvCUR(sv) < rslen ||
6696 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6700 * If we're reading from a TTY and we get a short read,
6701 * indicating that the user hit his EOF character, we need
6702 * to notice it now, because if we try to read from the TTY
6703 * again, the EOF condition will disappear.
6705 * The comparison of cnt to sizeof(buf) is an optimization
6706 * that prevents unnecessary calls to feof().
6710 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6714 #ifdef USE_HEAP_INSTEAD_OF_STACK
6719 if (rspara) { /* have to do this both before and after */
6720 while (i != EOF) { /* to make sure file boundaries work right */
6721 i = PerlIO_getc(fp);
6723 PerlIO_ungetc(fp,i);
6729 return_string_or_null:
6730 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6736 Auto-increment of the value in the SV, doing string to numeric conversion
6737 if necessary. Handles 'get' magic.
6743 Perl_sv_inc(pTHX_ register SV *sv)
6752 if (SvTHINKFIRST(sv)) {
6754 sv_force_normal_flags(sv, 0);
6755 if (SvREADONLY(sv)) {
6756 if (IN_PERL_RUNTIME)
6757 Perl_croak(aTHX_ PL_no_modify);
6761 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6763 i = PTR2IV(SvRV(sv));
6768 flags = SvFLAGS(sv);
6769 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6770 /* It's (privately or publicly) a float, but not tested as an
6771 integer, so test it to see. */
6773 flags = SvFLAGS(sv);
6775 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6776 /* It's publicly an integer, or privately an integer-not-float */
6777 #ifdef PERL_PRESERVE_IVUV
6781 if (SvUVX(sv) == UV_MAX)
6782 sv_setnv(sv, UV_MAX_P1);
6784 (void)SvIOK_only_UV(sv);
6785 SvUV_set(sv, SvUVX(sv) + 1);
6787 if (SvIVX(sv) == IV_MAX)
6788 sv_setuv(sv, (UV)IV_MAX + 1);
6790 (void)SvIOK_only(sv);
6791 SvIV_set(sv, SvIVX(sv) + 1);
6796 if (flags & SVp_NOK) {
6797 (void)SvNOK_only(sv);
6798 SvNV_set(sv, SvNVX(sv) + 1.0);
6802 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6803 if ((flags & SVTYPEMASK) < SVt_PVIV)
6804 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6805 (void)SvIOK_only(sv);
6810 while (isALPHA(*d)) d++;
6811 while (isDIGIT(*d)) d++;
6813 #ifdef PERL_PRESERVE_IVUV
6814 /* Got to punt this as an integer if needs be, but we don't issue
6815 warnings. Probably ought to make the sv_iv_please() that does
6816 the conversion if possible, and silently. */
6817 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6818 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6819 /* Need to try really hard to see if it's an integer.
6820 9.22337203685478e+18 is an integer.
6821 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6822 so $a="9.22337203685478e+18"; $a+0; $a++
6823 needs to be the same as $a="9.22337203685478e+18"; $a++
6830 /* sv_2iv *should* have made this an NV */
6831 if (flags & SVp_NOK) {
6832 (void)SvNOK_only(sv);
6833 SvNV_set(sv, SvNVX(sv) + 1.0);
6836 /* I don't think we can get here. Maybe I should assert this
6837 And if we do get here I suspect that sv_setnv will croak. NWC
6839 #if defined(USE_LONG_DOUBLE)
6840 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",
6841 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6843 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6844 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6847 #endif /* PERL_PRESERVE_IVUV */
6848 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6852 while (d >= SvPVX_const(sv)) {
6860 /* MKS: The original code here died if letters weren't consecutive.
6861 * at least it didn't have to worry about non-C locales. The
6862 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6863 * arranged in order (although not consecutively) and that only
6864 * [A-Za-z] are accepted by isALPHA in the C locale.
6866 if (*d != 'z' && *d != 'Z') {
6867 do { ++*d; } while (!isALPHA(*d));
6870 *(d--) -= 'z' - 'a';
6875 *(d--) -= 'z' - 'a' + 1;
6879 /* oh,oh, the number grew */
6880 SvGROW(sv, SvCUR(sv) + 2);
6881 SvCUR_set(sv, SvCUR(sv) + 1);
6882 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6893 Auto-decrement of the value in the SV, doing string to numeric conversion
6894 if necessary. Handles 'get' magic.
6900 Perl_sv_dec(pTHX_ register SV *sv)
6908 if (SvTHINKFIRST(sv)) {
6910 sv_force_normal_flags(sv, 0);
6911 if (SvREADONLY(sv)) {
6912 if (IN_PERL_RUNTIME)
6913 Perl_croak(aTHX_ PL_no_modify);
6917 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6919 i = PTR2IV(SvRV(sv));
6924 /* Unlike sv_inc we don't have to worry about string-never-numbers
6925 and keeping them magic. But we mustn't warn on punting */
6926 flags = SvFLAGS(sv);
6927 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6928 /* It's publicly an integer, or privately an integer-not-float */
6929 #ifdef PERL_PRESERVE_IVUV
6933 if (SvUVX(sv) == 0) {
6934 (void)SvIOK_only(sv);
6938 (void)SvIOK_only_UV(sv);
6939 SvUV_set(sv, SvUVX(sv) - 1);
6942 if (SvIVX(sv) == IV_MIN)
6943 sv_setnv(sv, (NV)IV_MIN - 1.0);
6945 (void)SvIOK_only(sv);
6946 SvIV_set(sv, SvIVX(sv) - 1);
6951 if (flags & SVp_NOK) {
6952 SvNV_set(sv, SvNVX(sv) - 1.0);
6953 (void)SvNOK_only(sv);
6956 if (!(flags & SVp_POK)) {
6957 if ((flags & SVTYPEMASK) < SVt_PVIV)
6958 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6960 (void)SvIOK_only(sv);
6963 #ifdef PERL_PRESERVE_IVUV
6965 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6966 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6967 /* Need to try really hard to see if it's an integer.
6968 9.22337203685478e+18 is an integer.
6969 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6970 so $a="9.22337203685478e+18"; $a+0; $a--
6971 needs to be the same as $a="9.22337203685478e+18"; $a--
6978 /* sv_2iv *should* have made this an NV */
6979 if (flags & SVp_NOK) {
6980 (void)SvNOK_only(sv);
6981 SvNV_set(sv, SvNVX(sv) - 1.0);
6984 /* I don't think we can get here. Maybe I should assert this
6985 And if we do get here I suspect that sv_setnv will croak. NWC
6987 #if defined(USE_LONG_DOUBLE)
6988 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",
6989 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6991 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6992 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6996 #endif /* PERL_PRESERVE_IVUV */
6997 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7001 =for apidoc sv_mortalcopy
7003 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7004 The new SV is marked as mortal. It will be destroyed "soon", either by an
7005 explicit call to FREETMPS, or by an implicit call at places such as
7006 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7011 /* Make a string that will exist for the duration of the expression
7012 * evaluation. Actually, it may have to last longer than that, but
7013 * hopefully we won't free it until it has been assigned to a
7014 * permanent location. */
7017 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7023 sv_setsv(sv,oldstr);
7025 PL_tmps_stack[++PL_tmps_ix] = sv;
7031 =for apidoc sv_newmortal
7033 Creates a new null SV which is mortal. The reference count of the SV is
7034 set to 1. It will be destroyed "soon", either by an explicit call to
7035 FREETMPS, or by an implicit call at places such as statement boundaries.
7036 See also C<sv_mortalcopy> and C<sv_2mortal>.
7042 Perl_sv_newmortal(pTHX)
7048 SvFLAGS(sv) = SVs_TEMP;
7050 PL_tmps_stack[++PL_tmps_ix] = sv;
7056 =for apidoc newSVpvn_flags
7058 Creates a new SV and copies a string into it. The reference count for the
7059 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7060 string. You are responsible for ensuring that the source string is at least
7061 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7062 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7063 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7064 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7065 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7067 #define newSVpvn_utf8(s, len, u) \
7068 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7074 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7079 /* All the flags we don't support must be zero.
7080 And we're new code so I'm going to assert this from the start. */
7081 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7083 sv_setpvn(sv,s,len);
7084 SvFLAGS(sv) |= (flags & SVf_UTF8);
7085 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7089 =for apidoc sv_2mortal
7091 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7092 by an explicit call to FREETMPS, or by an implicit call at places such as
7093 statement boundaries. SvTEMP() is turned on which means that the SV's
7094 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7095 and C<sv_mortalcopy>.
7101 Perl_sv_2mortal(pTHX_ register SV *sv)
7106 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7109 PL_tmps_stack[++PL_tmps_ix] = sv;
7117 Creates a new SV and copies a string into it. The reference count for the
7118 SV is set to 1. If C<len> is zero, Perl will compute the length using
7119 strlen(). For efficiency, consider using C<newSVpvn> instead.
7125 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7131 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7136 =for apidoc newSVpvn
7138 Creates a new SV and copies a string into it. The reference count for the
7139 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7140 string. You are responsible for ensuring that the source string is at least
7141 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7147 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7153 sv_setpvn(sv,s,len);
7158 =for apidoc newSVhek
7160 Creates a new SV from the hash key structure. It will generate scalars that
7161 point to the shared string table where possible. Returns a new (undefined)
7162 SV if the hek is NULL.
7168 Perl_newSVhek(pTHX_ const HEK *hek)
7178 if (HEK_LEN(hek) == HEf_SVKEY) {
7179 return newSVsv(*(SV**)HEK_KEY(hek));
7181 const int flags = HEK_FLAGS(hek);
7182 if (flags & HVhek_WASUTF8) {
7184 Andreas would like keys he put in as utf8 to come back as utf8
7186 STRLEN utf8_len = HEK_LEN(hek);
7187 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7188 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7191 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7193 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7194 /* We don't have a pointer to the hv, so we have to replicate the
7195 flag into every HEK. This hv is using custom a hasing
7196 algorithm. Hence we can't return a shared string scalar, as
7197 that would contain the (wrong) hash value, and might get passed
7198 into an hv routine with a regular hash.
7199 Similarly, a hash that isn't using shared hash keys has to have
7200 the flag in every key so that we know not to try to call
7201 share_hek_kek on it. */
7203 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7208 /* This will be overwhelminly the most common case. */
7210 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7211 more efficient than sharepvn(). */
7215 sv_upgrade(sv, SVt_PV);
7216 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7217 SvCUR_set(sv, HEK_LEN(hek));
7230 =for apidoc newSVpvn_share
7232 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7233 table. If the string does not already exist in the table, it is created
7234 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7235 value is used; otherwise the hash is computed. The string's hash can be later
7236 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7237 that as the string table is used for shared hash keys these strings will have
7238 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7244 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7248 bool is_utf8 = FALSE;
7249 const char *const orig_src = src;
7252 STRLEN tmplen = -len;
7254 /* See the note in hv.c:hv_fetch() --jhi */
7255 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7259 PERL_HASH(hash, src, len);
7261 sv_upgrade(sv, SVt_PV);
7262 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7270 if (src != orig_src)
7276 #if defined(PERL_IMPLICIT_CONTEXT)
7278 /* pTHX_ magic can't cope with varargs, so this is a no-context
7279 * version of the main function, (which may itself be aliased to us).
7280 * Don't access this version directly.
7284 Perl_newSVpvf_nocontext(const char* pat, ...)
7289 va_start(args, pat);
7290 sv = vnewSVpvf(pat, &args);
7297 =for apidoc newSVpvf
7299 Creates a new SV and initializes it with the string formatted like
7306 Perl_newSVpvf(pTHX_ const char* pat, ...)
7310 va_start(args, pat);
7311 sv = vnewSVpvf(pat, &args);
7316 /* backend for newSVpvf() and newSVpvf_nocontext() */
7319 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7324 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7331 Creates a new SV and copies a floating point value into it.
7332 The reference count for the SV is set to 1.
7338 Perl_newSVnv(pTHX_ NV n)
7351 Creates a new SV and copies an integer into it. The reference count for the
7358 Perl_newSViv(pTHX_ IV i)
7371 Creates a new SV and copies an unsigned integer into it.
7372 The reference count for the SV is set to 1.
7378 Perl_newSVuv(pTHX_ UV u)
7389 =for apidoc newSV_type
7391 Creates a new SV, of the type specified. The reference count for the new SV
7398 Perl_newSV_type(pTHX_ svtype type)
7403 sv_upgrade(sv, type);
7408 =for apidoc newRV_noinc
7410 Creates an RV wrapper for an SV. The reference count for the original
7411 SV is B<not> incremented.
7417 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7420 register SV *sv = newSV_type(SVt_IV);
7422 SvRV_set(sv, tmpRef);
7427 /* newRV_inc is the official function name to use now.
7428 * newRV_inc is in fact #defined to newRV in sv.h
7432 Perl_newRV(pTHX_ SV *sv)
7435 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7441 Creates a new SV which is an exact duplicate of the original SV.
7448 Perl_newSVsv(pTHX_ register SV *old)
7455 if (SvTYPE(old) == SVTYPEMASK) {
7456 if (ckWARN_d(WARN_INTERNAL))
7457 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7461 /* SV_GMAGIC is the default for sv_setv()
7462 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7463 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7464 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7469 =for apidoc sv_reset
7471 Underlying implementation for the C<reset> Perl function.
7472 Note that the perl-level function is vaguely deprecated.
7478 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7481 char todo[PERL_UCHAR_MAX+1];
7486 if (!*s) { /* reset ?? searches */
7487 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7489 const U32 count = mg->mg_len / sizeof(PMOP**);
7490 PMOP **pmp = (PMOP**) mg->mg_ptr;
7491 PMOP *const *const end = pmp + count;
7495 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7497 (*pmp)->op_pmflags &= ~PMf_USED;
7505 /* reset variables */
7507 if (!HvARRAY(stash))
7510 Zero(todo, 256, char);
7513 I32 i = (unsigned char)*s;
7517 max = (unsigned char)*s++;
7518 for ( ; i <= max; i++) {
7521 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7523 for (entry = HvARRAY(stash)[i];
7525 entry = HeNEXT(entry))
7530 if (!todo[(U8)*HeKEY(entry)])
7532 gv = (GV*)HeVAL(entry);
7535 if (SvTHINKFIRST(sv)) {
7536 if (!SvREADONLY(sv) && SvROK(sv))
7538 /* XXX Is this continue a bug? Why should THINKFIRST
7539 exempt us from resetting arrays and hashes? */
7543 if (SvTYPE(sv) >= SVt_PV) {
7545 if (SvPVX_const(sv) != NULL)
7553 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7555 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7558 # if defined(USE_ENVIRON_ARRAY)
7561 # endif /* USE_ENVIRON_ARRAY */
7572 Using various gambits, try to get an IO from an SV: the IO slot if its a
7573 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7574 named after the PV if we're a string.
7580 Perl_sv_2io(pTHX_ SV *sv)
7585 switch (SvTYPE(sv)) {
7593 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7597 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7599 return sv_2io(SvRV(sv));
7600 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7606 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7615 Using various gambits, try to get a CV from an SV; in addition, try if
7616 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7617 The flags in C<lref> are passed to sv_fetchsv.
7623 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7634 switch (SvTYPE(sv)) {
7653 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7654 tryAMAGICunDEREF(to_cv);
7657 if (SvTYPE(sv) == SVt_PVCV) {
7666 Perl_croak(aTHX_ "Not a subroutine reference");
7671 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7677 /* Some flags to gv_fetchsv mean don't really create the GV */
7678 if (SvTYPE(gv) != SVt_PVGV) {
7684 if (lref && !GvCVu(gv)) {
7688 gv_efullname3(tmpsv, gv, NULL);
7689 /* XXX this is probably not what they think they're getting.
7690 * It has the same effect as "sub name;", i.e. just a forward
7692 newSUB(start_subparse(FALSE, 0),
7693 newSVOP(OP_CONST, 0, tmpsv),
7697 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7707 Returns true if the SV has a true value by Perl's rules.
7708 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7709 instead use an in-line version.
7715 Perl_sv_true(pTHX_ register SV *sv)
7720 register const XPV* const tXpv = (XPV*)SvANY(sv);
7722 (tXpv->xpv_cur > 1 ||
7723 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7730 return SvIVX(sv) != 0;
7733 return SvNVX(sv) != 0.0;
7735 return sv_2bool(sv);
7741 =for apidoc sv_pvn_force
7743 Get a sensible string out of the SV somehow.
7744 A private implementation of the C<SvPV_force> macro for compilers which
7745 can't cope with complex macro expressions. Always use the macro instead.
7747 =for apidoc sv_pvn_force_flags
7749 Get a sensible string out of the SV somehow.
7750 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7751 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7752 implemented in terms of this function.
7753 You normally want to use the various wrapper macros instead: see
7754 C<SvPV_force> and C<SvPV_force_nomg>
7760 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7763 if (SvTHINKFIRST(sv) && !SvROK(sv))
7764 sv_force_normal_flags(sv, 0);
7774 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7775 const char * const ref = sv_reftype(sv,0);
7777 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7778 ref, OP_NAME(PL_op));
7780 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7782 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7783 || isGV_with_GP(sv))
7784 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7786 s = sv_2pv_flags(sv, &len, flags);
7790 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7793 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7794 SvGROW(sv, len + 1);
7795 Move(s,SvPVX(sv),len,char);
7797 SvPVX(sv)[len] = '\0';
7800 SvPOK_on(sv); /* validate pointer */
7802 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7803 PTR2UV(sv),SvPVX_const(sv)));
7806 return SvPVX_mutable(sv);
7810 =for apidoc sv_pvbyten_force
7812 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7818 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7820 sv_pvn_force(sv,lp);
7821 sv_utf8_downgrade(sv,0);
7827 =for apidoc sv_pvutf8n_force
7829 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7835 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7837 sv_pvn_force(sv,lp);
7838 sv_utf8_upgrade(sv);
7844 =for apidoc sv_reftype
7846 Returns a string describing what the SV is a reference to.
7852 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7854 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7855 inside return suggests a const propagation bug in g++. */
7856 if (ob && SvOBJECT(sv)) {
7857 char * const name = HvNAME_get(SvSTASH(sv));
7858 return name ? name : (char *) "__ANON__";
7861 switch (SvTYPE(sv)) {
7876 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7877 /* tied lvalues should appear to be
7878 * scalars for backwards compatitbility */
7879 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7880 ? "SCALAR" : "LVALUE");
7881 case SVt_PVAV: return "ARRAY";
7882 case SVt_PVHV: return "HASH";
7883 case SVt_PVCV: return "CODE";
7884 case SVt_PVGV: return "GLOB";
7885 case SVt_PVFM: return "FORMAT";
7886 case SVt_PVIO: return "IO";
7887 case SVt_BIND: return "BIND";
7888 case SVt_REGEXP: return "REGEXP";
7889 default: return "UNKNOWN";
7895 =for apidoc sv_isobject
7897 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7898 object. If the SV is not an RV, or if the object is not blessed, then this
7905 Perl_sv_isobject(pTHX_ SV *sv)
7921 Returns a boolean indicating whether the SV is blessed into the specified
7922 class. This does not check for subtypes; use C<sv_derived_from> to verify
7923 an inheritance relationship.
7929 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7940 hvname = HvNAME_get(SvSTASH(sv));
7944 return strEQ(hvname, name);
7950 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7951 it will be upgraded to one. If C<classname> is non-null then the new SV will
7952 be blessed in the specified package. The new SV is returned and its
7953 reference count is 1.
7959 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7966 SV_CHECK_THINKFIRST_COW_DROP(rv);
7967 (void)SvAMAGIC_off(rv);
7969 if (SvTYPE(rv) >= SVt_PVMG) {
7970 const U32 refcnt = SvREFCNT(rv);
7974 SvREFCNT(rv) = refcnt;
7976 sv_upgrade(rv, SVt_IV);
7977 } else if (SvROK(rv)) {
7978 SvREFCNT_dec(SvRV(rv));
7980 prepare_SV_for_RV(rv);
7988 HV* const stash = gv_stashpv(classname, GV_ADD);
7989 (void)sv_bless(rv, stash);
7995 =for apidoc sv_setref_pv
7997 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7998 argument will be upgraded to an RV. That RV will be modified to point to
7999 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8000 into the SV. The C<classname> argument indicates the package for the
8001 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8002 will have a reference count of 1, and the RV will be returned.
8004 Do not use with other Perl types such as HV, AV, SV, CV, because those
8005 objects will become corrupted by the pointer copy process.
8007 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8013 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8017 sv_setsv(rv, &PL_sv_undef);
8021 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8026 =for apidoc sv_setref_iv
8028 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8029 argument will be upgraded to an RV. That RV will be modified to point to
8030 the new SV. The C<classname> argument indicates the package for the
8031 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8032 will have a reference count of 1, and the RV will be returned.
8038 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8040 sv_setiv(newSVrv(rv,classname), iv);
8045 =for apidoc sv_setref_uv
8047 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8048 argument will be upgraded to an RV. That RV will be modified to point to
8049 the new SV. The C<classname> argument indicates the package for the
8050 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8051 will have a reference count of 1, and the RV will be returned.
8057 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8059 sv_setuv(newSVrv(rv,classname), uv);
8064 =for apidoc sv_setref_nv
8066 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8067 argument will be upgraded to an RV. That RV will be modified to point to
8068 the new SV. The C<classname> argument indicates the package for the
8069 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8070 will have a reference count of 1, and the RV will be returned.
8076 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8078 sv_setnv(newSVrv(rv,classname), nv);
8083 =for apidoc sv_setref_pvn
8085 Copies a string into a new SV, optionally blessing the SV. The length of the
8086 string must be specified with C<n>. The C<rv> argument will be upgraded to
8087 an RV. That RV will be modified to point to the new SV. The C<classname>
8088 argument indicates the package for the blessing. Set C<classname> to
8089 C<NULL> to avoid the blessing. The new SV will have a reference count
8090 of 1, and the RV will be returned.
8092 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8098 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8100 sv_setpvn(newSVrv(rv,classname), pv, n);
8105 =for apidoc sv_bless
8107 Blesses an SV into a specified package. The SV must be an RV. The package
8108 must be designated by its stash (see C<gv_stashpv()>). The reference count
8109 of the SV is unaffected.
8115 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8120 Perl_croak(aTHX_ "Can't bless non-reference value");
8122 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8123 if (SvIsCOW(tmpRef))
8124 sv_force_normal_flags(tmpRef, 0);
8125 if (SvREADONLY(tmpRef))
8126 Perl_croak(aTHX_ PL_no_modify);
8127 if (SvOBJECT(tmpRef)) {
8128 if (SvTYPE(tmpRef) != SVt_PVIO)
8130 SvREFCNT_dec(SvSTASH(tmpRef));
8133 SvOBJECT_on(tmpRef);
8134 if (SvTYPE(tmpRef) != SVt_PVIO)
8136 SvUPGRADE(tmpRef, SVt_PVMG);
8137 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8142 (void)SvAMAGIC_off(sv);
8144 if(SvSMAGICAL(tmpRef))
8145 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8153 /* Downgrades a PVGV to a PVMG.
8157 S_sv_unglob(pTHX_ SV *sv)
8162 SV * const temp = sv_newmortal();
8164 assert(SvTYPE(sv) == SVt_PVGV);
8166 gv_efullname3(temp, (GV *) sv, "*");
8169 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8170 mro_method_changed_in(stash);
8174 sv_del_backref((SV*)GvSTASH(sv), sv);
8178 if (GvNAME_HEK(sv)) {
8179 unshare_hek(GvNAME_HEK(sv));
8181 isGV_with_GP_off(sv);
8183 /* need to keep SvANY(sv) in the right arena */
8184 xpvmg = new_XPVMG();
8185 StructCopy(SvANY(sv), xpvmg, XPVMG);
8186 del_XPVGV(SvANY(sv));
8189 SvFLAGS(sv) &= ~SVTYPEMASK;
8190 SvFLAGS(sv) |= SVt_PVMG;
8192 /* Intentionally not calling any local SET magic, as this isn't so much a
8193 set operation as merely an internal storage change. */
8194 sv_setsv_flags(sv, temp, 0);
8198 =for apidoc sv_unref_flags
8200 Unsets the RV status of the SV, and decrements the reference count of
8201 whatever was being referenced by the RV. This can almost be thought of
8202 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8203 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8204 (otherwise the decrementing is conditional on the reference count being
8205 different from one or the reference being a readonly SV).
8212 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8214 SV* const target = SvRV(ref);
8216 if (SvWEAKREF(ref)) {
8217 sv_del_backref(target, ref);
8219 SvRV_set(ref, NULL);
8222 SvRV_set(ref, NULL);
8224 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8225 assigned to as BEGIN {$a = \"Foo"} will fail. */
8226 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8227 SvREFCNT_dec(target);
8228 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8229 sv_2mortal(target); /* Schedule for freeing later */
8233 =for apidoc sv_untaint
8235 Untaint an SV. Use C<SvTAINTED_off> instead.
8240 Perl_sv_untaint(pTHX_ SV *sv)
8242 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8243 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8250 =for apidoc sv_tainted
8252 Test an SV for taintedness. Use C<SvTAINTED> instead.
8257 Perl_sv_tainted(pTHX_ SV *sv)
8259 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8260 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8261 if (mg && (mg->mg_len & 1) )
8268 =for apidoc sv_setpviv
8270 Copies an integer into the given SV, also updating its string value.
8271 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8277 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8279 char buf[TYPE_CHARS(UV)];
8281 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8283 sv_setpvn(sv, ptr, ebuf - ptr);
8287 =for apidoc sv_setpviv_mg
8289 Like C<sv_setpviv>, but also handles 'set' magic.
8295 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8301 #if defined(PERL_IMPLICIT_CONTEXT)
8303 /* pTHX_ magic can't cope with varargs, so this is a no-context
8304 * version of the main function, (which may itself be aliased to us).
8305 * Don't access this version directly.
8309 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8313 va_start(args, pat);
8314 sv_vsetpvf(sv, pat, &args);
8318 /* pTHX_ magic can't cope with varargs, so this is a no-context
8319 * version of the main function, (which may itself be aliased to us).
8320 * Don't access this version directly.
8324 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8328 va_start(args, pat);
8329 sv_vsetpvf_mg(sv, pat, &args);
8335 =for apidoc sv_setpvf
8337 Works like C<sv_catpvf> but copies the text into the SV instead of
8338 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8344 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8347 va_start(args, pat);
8348 sv_vsetpvf(sv, pat, &args);
8353 =for apidoc sv_vsetpvf
8355 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8356 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8358 Usually used via its frontend C<sv_setpvf>.
8364 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8366 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8370 =for apidoc sv_setpvf_mg
8372 Like C<sv_setpvf>, but also handles 'set' magic.
8378 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8381 va_start(args, pat);
8382 sv_vsetpvf_mg(sv, pat, &args);
8387 =for apidoc sv_vsetpvf_mg
8389 Like C<sv_vsetpvf>, but also handles 'set' magic.
8391 Usually used via its frontend C<sv_setpvf_mg>.
8397 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8399 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8403 #if defined(PERL_IMPLICIT_CONTEXT)
8405 /* pTHX_ magic can't cope with varargs, so this is a no-context
8406 * version of the main function, (which may itself be aliased to us).
8407 * Don't access this version directly.
8411 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8415 va_start(args, pat);
8416 sv_vcatpvf(sv, pat, &args);
8420 /* pTHX_ magic can't cope with varargs, so this is a no-context
8421 * version of the main function, (which may itself be aliased to us).
8422 * Don't access this version directly.
8426 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8430 va_start(args, pat);
8431 sv_vcatpvf_mg(sv, pat, &args);
8437 =for apidoc sv_catpvf
8439 Processes its arguments like C<sprintf> and appends the formatted
8440 output to an SV. If the appended data contains "wide" characters
8441 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8442 and characters >255 formatted with %c), the original SV might get
8443 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8444 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8445 valid UTF-8; if the original SV was bytes, the pattern should be too.
8450 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8453 va_start(args, pat);
8454 sv_vcatpvf(sv, pat, &args);
8459 =for apidoc sv_vcatpvf
8461 Processes its arguments like C<vsprintf> and appends the formatted output
8462 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8464 Usually used via its frontend C<sv_catpvf>.
8470 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8472 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8476 =for apidoc sv_catpvf_mg
8478 Like C<sv_catpvf>, but also handles 'set' magic.
8484 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8487 va_start(args, pat);
8488 sv_vcatpvf_mg(sv, pat, &args);
8493 =for apidoc sv_vcatpvf_mg
8495 Like C<sv_vcatpvf>, but also handles 'set' magic.
8497 Usually used via its frontend C<sv_catpvf_mg>.
8503 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8505 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8510 =for apidoc sv_vsetpvfn
8512 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8515 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8521 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8523 sv_setpvn(sv, "", 0);
8524 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8528 S_expect_number(pTHX_ char** pattern)
8532 switch (**pattern) {
8533 case '1': case '2': case '3':
8534 case '4': case '5': case '6':
8535 case '7': case '8': case '9':
8536 var = *(*pattern)++ - '0';
8537 while (isDIGIT(**pattern)) {
8538 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8540 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8548 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8550 const int neg = nv < 0;
8559 if (uv & 1 && uv == nv)
8560 uv--; /* Round to even */
8562 const unsigned dig = uv % 10;
8575 =for apidoc sv_vcatpvfn
8577 Processes its arguments like C<vsprintf> and appends the formatted output
8578 to an SV. Uses an array of SVs if the C style variable argument list is
8579 missing (NULL). When running with taint checks enabled, indicates via
8580 C<maybe_tainted> if results are untrustworthy (often due to the use of
8583 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8589 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8590 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8591 vec_utf8 = DO_UTF8(vecsv);
8593 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8596 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8604 static const char nullstr[] = "(null)";
8606 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8607 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8609 /* Times 4: a decimal digit takes more than 3 binary digits.
8610 * NV_DIG: mantissa takes than many decimal digits.
8611 * Plus 32: Playing safe. */
8612 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8613 /* large enough for "%#.#f" --chip */
8614 /* what about long double NVs? --jhi */
8616 PERL_UNUSED_ARG(maybe_tainted);
8618 /* no matter what, this is a string now */
8619 (void)SvPV_force(sv, origlen);
8621 /* special-case "", "%s", and "%-p" (SVf - see below) */
8624 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8626 const char * const s = va_arg(*args, char*);
8627 sv_catpv(sv, s ? s : nullstr);
8629 else if (svix < svmax) {
8630 sv_catsv(sv, *svargs);
8634 if (args && patlen == 3 && pat[0] == '%' &&
8635 pat[1] == '-' && pat[2] == 'p') {
8636 argsv = (SV*)va_arg(*args, void*);
8637 sv_catsv(sv, argsv);
8641 #ifndef USE_LONG_DOUBLE
8642 /* special-case "%.<number>[gf]" */
8643 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8644 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8645 unsigned digits = 0;
8649 while (*pp >= '0' && *pp <= '9')
8650 digits = 10 * digits + (*pp++ - '0');
8651 if (pp - pat == (int)patlen - 1) {
8659 /* Add check for digits != 0 because it seems that some
8660 gconverts are buggy in this case, and we don't yet have
8661 a Configure test for this. */
8662 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8663 /* 0, point, slack */
8664 Gconvert(nv, (int)digits, 0, ebuf);
8666 if (*ebuf) /* May return an empty string for digits==0 */
8669 } else if (!digits) {
8672 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8673 sv_catpvn(sv, p, l);
8679 #endif /* !USE_LONG_DOUBLE */
8681 if (!args && svix < svmax && DO_UTF8(*svargs))
8684 patend = (char*)pat + patlen;
8685 for (p = (char*)pat; p < patend; p = q) {
8688 bool vectorize = FALSE;
8689 bool vectorarg = FALSE;
8690 bool vec_utf8 = FALSE;
8696 bool has_precis = FALSE;
8698 const I32 osvix = svix;
8699 bool is_utf8 = FALSE; /* is this item utf8? */
8700 #ifdef HAS_LDBL_SPRINTF_BUG
8701 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8702 with sfio - Allen <allens@cpan.org> */
8703 bool fix_ldbl_sprintf_bug = FALSE;
8707 U8 utf8buf[UTF8_MAXBYTES+1];
8708 STRLEN esignlen = 0;
8710 const char *eptr = NULL;
8713 const U8 *vecstr = NULL;
8720 /* we need a long double target in case HAS_LONG_DOUBLE but
8723 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8731 const char *dotstr = ".";
8732 STRLEN dotstrlen = 1;
8733 I32 efix = 0; /* explicit format parameter index */
8734 I32 ewix = 0; /* explicit width index */
8735 I32 epix = 0; /* explicit precision index */
8736 I32 evix = 0; /* explicit vector index */
8737 bool asterisk = FALSE;
8739 /* echo everything up to the next format specification */
8740 for (q = p; q < patend && *q != '%'; ++q) ;
8742 if (has_utf8 && !pat_utf8)
8743 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8745 sv_catpvn(sv, p, q - p);
8752 We allow format specification elements in this order:
8753 \d+\$ explicit format parameter index
8755 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8756 0 flag (as above): repeated to allow "v02"
8757 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8758 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8760 [%bcdefginopsuxDFOUX] format (mandatory)
8765 As of perl5.9.3, printf format checking is on by default.
8766 Internally, perl uses %p formats to provide an escape to
8767 some extended formatting. This block deals with those
8768 extensions: if it does not match, (char*)q is reset and
8769 the normal format processing code is used.
8771 Currently defined extensions are:
8772 %p include pointer address (standard)
8773 %-p (SVf) include an SV (previously %_)
8774 %-<num>p include an SV with precision <num>
8775 %<num>p reserved for future extensions
8777 Robin Barker 2005-07-14
8779 %1p (VDf) removed. RMB 2007-10-19
8786 n = expect_number(&q);
8793 argsv = (SV*)va_arg(*args, void*);
8794 eptr = SvPV_const(argsv, elen);
8800 if (ckWARN_d(WARN_INTERNAL))
8801 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8802 "internal %%<num>p might conflict with future printf extensions");
8808 if ( (width = expect_number(&q)) ) {
8823 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8852 if ( (ewix = expect_number(&q)) )
8861 if ((vectorarg = asterisk)) {
8874 width = expect_number(&q);
8880 vecsv = va_arg(*args, SV*);
8882 vecsv = (evix > 0 && evix <= svmax)
8883 ? svargs[evix-1] : &PL_sv_undef;
8885 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8887 dotstr = SvPV_const(vecsv, dotstrlen);
8888 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8889 bad with tied or overloaded values that return UTF8. */
8892 else if (has_utf8) {
8893 vecsv = sv_mortalcopy(vecsv);
8894 sv_utf8_upgrade(vecsv);
8895 dotstr = SvPV_const(vecsv, dotstrlen);
8902 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8903 vecsv = svargs[efix ? efix-1 : svix++];
8904 vecstr = (U8*)SvPV_const(vecsv,veclen);
8905 vec_utf8 = DO_UTF8(vecsv);
8907 /* if this is a version object, we need to convert
8908 * back into v-string notation and then let the
8909 * vectorize happen normally
8911 if (sv_derived_from(vecsv, "version")) {
8912 char *version = savesvpv(vecsv);
8913 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8914 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8915 "vector argument not supported with alpha versions");
8918 vecsv = sv_newmortal();
8919 scan_vstring(version, version + veclen, vecsv);
8920 vecstr = (U8*)SvPV_const(vecsv, veclen);
8921 vec_utf8 = DO_UTF8(vecsv);
8933 i = va_arg(*args, int);
8935 i = (ewix ? ewix <= svmax : svix < svmax) ?
8936 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8938 width = (i < 0) ? -i : i;
8948 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8950 /* XXX: todo, support specified precision parameter */
8954 i = va_arg(*args, int);
8956 i = (ewix ? ewix <= svmax : svix < svmax)
8957 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8959 has_precis = !(i < 0);
8964 precis = precis * 10 + (*q++ - '0');
8973 case 'I': /* Ix, I32x, and I64x */
8975 if (q[1] == '6' && q[2] == '4') {
8981 if (q[1] == '3' && q[2] == '2') {
8991 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9002 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9003 if (*(q + 1) == 'l') { /* lld, llf */
9029 if (!vectorize && !args) {
9031 const I32 i = efix-1;
9032 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9034 argsv = (svix >= 0 && svix < svmax)
9035 ? svargs[svix++] : &PL_sv_undef;
9046 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9048 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9050 eptr = (char*)utf8buf;
9051 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9065 eptr = va_arg(*args, char*);
9067 #ifdef MACOS_TRADITIONAL
9068 /* On MacOS, %#s format is used for Pascal strings */
9073 elen = strlen(eptr);
9075 eptr = (char *)nullstr;
9076 elen = sizeof nullstr - 1;
9080 eptr = SvPV_const(argsv, elen);
9081 if (DO_UTF8(argsv)) {
9082 I32 old_precis = precis;
9083 if (has_precis && precis < elen) {
9085 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9088 if (width) { /* fudge width (can't fudge elen) */
9089 if (has_precis && precis < elen)
9090 width += precis - old_precis;
9092 width += elen - sv_len_utf8(argsv);
9099 if (has_precis && elen > precis)
9106 if (alt || vectorize)
9108 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9129 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9138 esignbuf[esignlen++] = plus;
9142 case 'h': iv = (short)va_arg(*args, int); break;
9143 case 'l': iv = va_arg(*args, long); break;
9144 case 'V': iv = va_arg(*args, IV); break;
9145 default: iv = va_arg(*args, int); break;
9147 case 'q': iv = va_arg(*args, Quad_t); break;
9152 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9154 case 'h': iv = (short)tiv; break;
9155 case 'l': iv = (long)tiv; break;
9157 default: iv = tiv; break;
9159 case 'q': iv = (Quad_t)tiv; break;
9163 if ( !vectorize ) /* we already set uv above */
9168 esignbuf[esignlen++] = plus;
9172 esignbuf[esignlen++] = '-';
9216 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9227 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9228 case 'l': uv = va_arg(*args, unsigned long); break;
9229 case 'V': uv = va_arg(*args, UV); break;
9230 default: uv = va_arg(*args, unsigned); break;
9232 case 'q': uv = va_arg(*args, Uquad_t); break;
9237 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9239 case 'h': uv = (unsigned short)tuv; break;
9240 case 'l': uv = (unsigned long)tuv; break;
9242 default: uv = tuv; break;
9244 case 'q': uv = (Uquad_t)tuv; break;
9251 char *ptr = ebuf + sizeof ebuf;
9252 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9258 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9264 esignbuf[esignlen++] = '0';
9265 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9273 if (alt && *ptr != '0')
9282 esignbuf[esignlen++] = '0';
9283 esignbuf[esignlen++] = c;
9286 default: /* it had better be ten or less */
9290 } while (uv /= base);
9293 elen = (ebuf + sizeof ebuf) - ptr;
9297 zeros = precis - elen;
9298 else if (precis == 0 && elen == 1 && *eptr == '0'
9299 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9302 /* a precision nullifies the 0 flag. */
9309 /* FLOATING POINT */
9312 c = 'f'; /* maybe %F isn't supported here */
9320 /* This is evil, but floating point is even more evil */
9322 /* for SV-style calling, we can only get NV
9323 for C-style calling, we assume %f is double;
9324 for simplicity we allow any of %Lf, %llf, %qf for long double
9328 #if defined(USE_LONG_DOUBLE)
9332 /* [perl #20339] - we should accept and ignore %lf rather than die */
9336 #if defined(USE_LONG_DOUBLE)
9337 intsize = args ? 0 : 'q';
9341 #if defined(HAS_LONG_DOUBLE)
9350 /* now we need (long double) if intsize == 'q', else (double) */
9352 #if LONG_DOUBLESIZE > DOUBLESIZE
9354 va_arg(*args, long double) :
9355 va_arg(*args, double)
9357 va_arg(*args, double)
9362 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9363 else. frexp() has some unspecified behaviour for those three */
9364 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9366 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9367 will cast our (long double) to (double) */
9368 (void)Perl_frexp(nv, &i);
9369 if (i == PERL_INT_MIN)
9370 Perl_die(aTHX_ "panic: frexp");
9372 need = BIT_DIGITS(i);
9374 need += has_precis ? precis : 6; /* known default */
9379 #ifdef HAS_LDBL_SPRINTF_BUG
9380 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9381 with sfio - Allen <allens@cpan.org> */
9384 # define MY_DBL_MAX DBL_MAX
9385 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9386 # if DOUBLESIZE >= 8
9387 # define MY_DBL_MAX 1.7976931348623157E+308L
9389 # define MY_DBL_MAX 3.40282347E+38L
9393 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9394 # define MY_DBL_MAX_BUG 1L
9396 # define MY_DBL_MAX_BUG MY_DBL_MAX
9400 # define MY_DBL_MIN DBL_MIN
9401 # else /* XXX guessing! -Allen */
9402 # if DOUBLESIZE >= 8
9403 # define MY_DBL_MIN 2.2250738585072014E-308L
9405 # define MY_DBL_MIN 1.17549435E-38L
9409 if ((intsize == 'q') && (c == 'f') &&
9410 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9412 /* it's going to be short enough that
9413 * long double precision is not needed */
9415 if ((nv <= 0L) && (nv >= -0L))
9416 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9418 /* would use Perl_fp_class as a double-check but not
9419 * functional on IRIX - see perl.h comments */
9421 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9422 /* It's within the range that a double can represent */
9423 #if defined(DBL_MAX) && !defined(DBL_MIN)
9424 if ((nv >= ((long double)1/DBL_MAX)) ||
9425 (nv <= (-(long double)1/DBL_MAX)))
9427 fix_ldbl_sprintf_bug = TRUE;
9430 if (fix_ldbl_sprintf_bug == TRUE) {
9440 # undef MY_DBL_MAX_BUG
9443 #endif /* HAS_LDBL_SPRINTF_BUG */
9445 need += 20; /* fudge factor */
9446 if (PL_efloatsize < need) {
9447 Safefree(PL_efloatbuf);
9448 PL_efloatsize = need + 20; /* more fudge */
9449 Newx(PL_efloatbuf, PL_efloatsize, char);
9450 PL_efloatbuf[0] = '\0';
9453 if ( !(width || left || plus || alt) && fill != '0'
9454 && has_precis && intsize != 'q' ) { /* Shortcuts */
9455 /* See earlier comment about buggy Gconvert when digits,
9457 if ( c == 'g' && precis) {
9458 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9459 /* May return an empty string for digits==0 */
9460 if (*PL_efloatbuf) {
9461 elen = strlen(PL_efloatbuf);
9462 goto float_converted;
9464 } else if ( c == 'f' && !precis) {
9465 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9470 char *ptr = ebuf + sizeof ebuf;
9473 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9474 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9475 if (intsize == 'q') {
9476 /* Copy the one or more characters in a long double
9477 * format before the 'base' ([efgEFG]) character to
9478 * the format string. */
9479 static char const prifldbl[] = PERL_PRIfldbl;
9480 char const *p = prifldbl + sizeof(prifldbl) - 3;
9481 while (p >= prifldbl) { *--ptr = *p--; }
9486 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9491 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9503 /* No taint. Otherwise we are in the strange situation
9504 * where printf() taints but print($float) doesn't.
9506 #if defined(HAS_LONG_DOUBLE)
9507 elen = ((intsize == 'q')
9508 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9509 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9511 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9515 eptr = PL_efloatbuf;
9523 i = SvCUR(sv) - origlen;
9526 case 'h': *(va_arg(*args, short*)) = i; break;
9527 default: *(va_arg(*args, int*)) = i; break;
9528 case 'l': *(va_arg(*args, long*)) = i; break;
9529 case 'V': *(va_arg(*args, IV*)) = i; break;
9531 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9536 sv_setuv_mg(argsv, (UV)i);
9537 continue; /* not "break" */
9544 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9545 && ckWARN(WARN_PRINTF))
9547 SV * const msg = sv_newmortal();
9548 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9549 (PL_op->op_type == OP_PRTF) ? "" : "s");
9552 Perl_sv_catpvf(aTHX_ msg,
9553 "\"%%%c\"", c & 0xFF);
9555 Perl_sv_catpvf(aTHX_ msg,
9556 "\"%%\\%03"UVof"\"",
9559 sv_catpvs(msg, "end of string");
9560 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9563 /* output mangled stuff ... */
9569 /* ... right here, because formatting flags should not apply */
9570 SvGROW(sv, SvCUR(sv) + elen + 1);
9572 Copy(eptr, p, elen, char);
9575 SvCUR_set(sv, p - SvPVX_const(sv));
9577 continue; /* not "break" */
9580 if (is_utf8 != has_utf8) {
9583 sv_utf8_upgrade(sv);
9586 const STRLEN old_elen = elen;
9587 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9588 sv_utf8_upgrade(nsv);
9589 eptr = SvPVX_const(nsv);
9592 if (width) { /* fudge width (can't fudge elen) */
9593 width += elen - old_elen;
9599 have = esignlen + zeros + elen;
9601 Perl_croak_nocontext(PL_memory_wrap);
9603 need = (have > width ? have : width);
9606 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9607 Perl_croak_nocontext(PL_memory_wrap);
9608 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9610 if (esignlen && fill == '0') {
9612 for (i = 0; i < (int)esignlen; i++)
9616 memset(p, fill, gap);
9619 if (esignlen && fill != '0') {
9621 for (i = 0; i < (int)esignlen; i++)
9626 for (i = zeros; i; i--)
9630 Copy(eptr, p, elen, char);
9634 memset(p, ' ', gap);
9639 Copy(dotstr, p, dotstrlen, char);
9643 vectorize = FALSE; /* done iterating over vecstr */
9650 SvCUR_set(sv, p - SvPVX_const(sv));
9658 /* =========================================================================
9660 =head1 Cloning an interpreter
9662 All the macros and functions in this section are for the private use of
9663 the main function, perl_clone().
9665 The foo_dup() functions make an exact copy of an existing foo thingy.
9666 During the course of a cloning, a hash table is used to map old addresses
9667 to new addresses. The table is created and manipulated with the
9668 ptr_table_* functions.
9672 ============================================================================*/
9675 #if defined(USE_ITHREADS)
9677 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9678 #ifndef GpREFCNT_inc
9679 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9683 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9684 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9685 If this changes, please unmerge ss_dup. */
9686 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9687 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9688 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9689 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9690 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9691 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9692 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9693 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9694 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9695 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9696 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9697 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9698 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9699 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9701 /* clone a parser */
9704 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9711 /* look for it in the table first */
9712 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9716 /* create anew and remember what it is */
9717 Newxz(parser, 1, yy_parser);
9718 ptr_table_store(PL_ptr_table, proto, parser);
9720 parser->yyerrstatus = 0;
9721 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9723 /* XXX these not yet duped */
9724 parser->old_parser = NULL;
9725 parser->stack = NULL;
9727 parser->stack_size = 0;
9728 /* XXX parser->stack->state = 0; */
9730 /* XXX eventually, just Copy() most of the parser struct ? */
9732 parser->lex_brackets = proto->lex_brackets;
9733 parser->lex_casemods = proto->lex_casemods;
9734 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9735 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9736 parser->lex_casestack = savepvn(proto->lex_casestack,
9737 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9738 parser->lex_defer = proto->lex_defer;
9739 parser->lex_dojoin = proto->lex_dojoin;
9740 parser->lex_expect = proto->lex_expect;
9741 parser->lex_formbrack = proto->lex_formbrack;
9742 parser->lex_inpat = proto->lex_inpat;
9743 parser->lex_inwhat = proto->lex_inwhat;
9744 parser->lex_op = proto->lex_op;
9745 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9746 parser->lex_starts = proto->lex_starts;
9747 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9748 parser->multi_close = proto->multi_close;
9749 parser->multi_open = proto->multi_open;
9750 parser->multi_start = proto->multi_start;
9751 parser->multi_end = proto->multi_end;
9752 parser->pending_ident = proto->pending_ident;
9753 parser->preambled = proto->preambled;
9754 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9755 parser->linestr = sv_dup_inc(proto->linestr, param);
9756 parser->expect = proto->expect;
9757 parser->copline = proto->copline;
9758 parser->last_lop_op = proto->last_lop_op;
9759 parser->lex_state = proto->lex_state;
9760 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9761 /* rsfp_filters entries have fake IoDIRP() */
9762 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9763 parser->in_my = proto->in_my;
9764 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9765 parser->error_count = proto->error_count;
9768 parser->linestr = sv_dup_inc(proto->linestr, param);
9771 char * const ols = SvPVX(proto->linestr);
9772 char * const ls = SvPVX(parser->linestr);
9774 parser->bufptr = ls + (proto->bufptr >= ols ?
9775 proto->bufptr - ols : 0);
9776 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9777 proto->oldbufptr - ols : 0);
9778 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9779 proto->oldoldbufptr - ols : 0);
9780 parser->linestart = ls + (proto->linestart >= ols ?
9781 proto->linestart - ols : 0);
9782 parser->last_uni = ls + (proto->last_uni >= ols ?
9783 proto->last_uni - ols : 0);
9784 parser->last_lop = ls + (proto->last_lop >= ols ?
9785 proto->last_lop - ols : 0);
9787 parser->bufend = ls + SvCUR(parser->linestr);
9790 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9794 parser->endwhite = proto->endwhite;
9795 parser->faketokens = proto->faketokens;
9796 parser->lasttoke = proto->lasttoke;
9797 parser->nextwhite = proto->nextwhite;
9798 parser->realtokenstart = proto->realtokenstart;
9799 parser->skipwhite = proto->skipwhite;
9800 parser->thisclose = proto->thisclose;
9801 parser->thismad = proto->thismad;
9802 parser->thisopen = proto->thisopen;
9803 parser->thisstuff = proto->thisstuff;
9804 parser->thistoken = proto->thistoken;
9805 parser->thiswhite = proto->thiswhite;
9807 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9808 parser->curforce = proto->curforce;
9810 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9811 Copy(proto->nexttype, parser->nexttype, 5, I32);
9812 parser->nexttoke = proto->nexttoke;
9818 /* duplicate a file handle */
9821 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9825 PERL_UNUSED_ARG(type);
9828 return (PerlIO*)NULL;
9830 /* look for it in the table first */
9831 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9835 /* create anew and remember what it is */
9836 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9837 ptr_table_store(PL_ptr_table, fp, ret);
9841 /* duplicate a directory handle */
9844 Perl_dirp_dup(pTHX_ DIR *dp)
9846 PERL_UNUSED_CONTEXT;
9853 /* duplicate a typeglob */
9856 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9862 /* look for it in the table first */
9863 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9867 /* create anew and remember what it is */
9869 ptr_table_store(PL_ptr_table, gp, ret);
9872 ret->gp_refcnt = 0; /* must be before any other dups! */
9873 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9874 ret->gp_io = io_dup_inc(gp->gp_io, param);
9875 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9876 ret->gp_av = av_dup_inc(gp->gp_av, param);
9877 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9878 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9879 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9880 ret->gp_cvgen = gp->gp_cvgen;
9881 ret->gp_line = gp->gp_line;
9882 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9886 /* duplicate a chain of magic */
9889 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9891 MAGIC *mgprev = (MAGIC*)NULL;
9894 return (MAGIC*)NULL;
9895 /* look for it in the table first */
9896 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9900 for (; mg; mg = mg->mg_moremagic) {
9902 Newxz(nmg, 1, MAGIC);
9904 mgprev->mg_moremagic = nmg;
9907 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9908 nmg->mg_private = mg->mg_private;
9909 nmg->mg_type = mg->mg_type;
9910 nmg->mg_flags = mg->mg_flags;
9911 /* FIXME for plugins
9912 if (mg->mg_type == PERL_MAGIC_qr) {
9913 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9917 if(mg->mg_type == PERL_MAGIC_backref) {
9918 /* The backref AV has its reference count deliberately bumped by
9920 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9923 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9924 ? sv_dup_inc(mg->mg_obj, param)
9925 : sv_dup(mg->mg_obj, param);
9927 nmg->mg_len = mg->mg_len;
9928 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9929 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9930 if (mg->mg_len > 0) {
9931 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9932 if (mg->mg_type == PERL_MAGIC_overload_table &&
9933 AMT_AMAGIC((AMT*)mg->mg_ptr))
9935 const AMT * const amtp = (AMT*)mg->mg_ptr;
9936 AMT * const namtp = (AMT*)nmg->mg_ptr;
9938 for (i = 1; i < NofAMmeth; i++) {
9939 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9943 else if (mg->mg_len == HEf_SVKEY)
9944 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9946 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9947 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9954 #endif /* USE_ITHREADS */
9956 /* create a new pointer-mapping table */
9959 Perl_ptr_table_new(pTHX)
9962 PERL_UNUSED_CONTEXT;
9964 Newxz(tbl, 1, PTR_TBL_t);
9967 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9971 #define PTR_TABLE_HASH(ptr) \
9972 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9975 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9976 following define) and at call to new_body_inline made below in
9977 Perl_ptr_table_store()
9980 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9982 /* map an existing pointer using a table */
9984 STATIC PTR_TBL_ENT_t *
9985 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9986 PTR_TBL_ENT_t *tblent;
9987 const UV hash = PTR_TABLE_HASH(sv);
9989 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9990 for (; tblent; tblent = tblent->next) {
9991 if (tblent->oldval == sv)
9998 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10000 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10001 PERL_UNUSED_CONTEXT;
10002 return tblent ? tblent->newval : NULL;
10005 /* add a new entry to a pointer-mapping table */
10008 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10010 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10011 PERL_UNUSED_CONTEXT;
10014 tblent->newval = newsv;
10016 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10018 new_body_inline(tblent, PTE_SVSLOT);
10020 tblent->oldval = oldsv;
10021 tblent->newval = newsv;
10022 tblent->next = tbl->tbl_ary[entry];
10023 tbl->tbl_ary[entry] = tblent;
10025 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10026 ptr_table_split(tbl);
10030 /* double the hash bucket size of an existing ptr table */
10033 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10035 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10036 const UV oldsize = tbl->tbl_max + 1;
10037 UV newsize = oldsize * 2;
10039 PERL_UNUSED_CONTEXT;
10041 Renew(ary, newsize, PTR_TBL_ENT_t*);
10042 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10043 tbl->tbl_max = --newsize;
10044 tbl->tbl_ary = ary;
10045 for (i=0; i < oldsize; i++, ary++) {
10046 PTR_TBL_ENT_t **curentp, **entp, *ent;
10049 curentp = ary + oldsize;
10050 for (entp = ary, ent = *ary; ent; ent = *entp) {
10051 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10053 ent->next = *curentp;
10063 /* remove all the entries from a ptr table */
10066 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10068 if (tbl && tbl->tbl_items) {
10069 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10070 UV riter = tbl->tbl_max;
10073 PTR_TBL_ENT_t *entry = array[riter];
10076 PTR_TBL_ENT_t * const oentry = entry;
10077 entry = entry->next;
10082 tbl->tbl_items = 0;
10086 /* clear and free a ptr table */
10089 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10094 ptr_table_clear(tbl);
10095 Safefree(tbl->tbl_ary);
10099 #if defined(USE_ITHREADS)
10102 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10105 SvRV_set(dstr, SvWEAKREF(sstr)
10106 ? sv_dup(SvRV(sstr), param)
10107 : sv_dup_inc(SvRV(sstr), param));
10110 else if (SvPVX_const(sstr)) {
10111 /* Has something there */
10113 /* Normal PV - clone whole allocated space */
10114 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10115 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10116 /* Not that normal - actually sstr is copy on write.
10117 But we are a true, independant SV, so: */
10118 SvREADONLY_off(dstr);
10123 /* Special case - not normally malloced for some reason */
10124 if (isGV_with_GP(sstr)) {
10125 /* Don't need to do anything here. */
10127 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10128 /* A "shared" PV - clone it as "shared" PV */
10130 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10134 /* Some other special case - random pointer */
10135 SvPV_set(dstr, SvPVX(sstr));
10140 /* Copy the NULL */
10141 SvPV_set(dstr, NULL);
10145 /* duplicate an SV of any type (including AV, HV etc) */
10148 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10155 if (SvTYPE(sstr) == SVTYPEMASK) {
10156 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10161 /* look for it in the table first */
10162 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10166 if(param->flags & CLONEf_JOIN_IN) {
10167 /** We are joining here so we don't want do clone
10168 something that is bad **/
10169 if (SvTYPE(sstr) == SVt_PVHV) {
10170 const HEK * const hvname = HvNAME_HEK(sstr);
10172 /** don't clone stashes if they already exist **/
10173 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10177 /* create anew and remember what it is */
10180 #ifdef DEBUG_LEAKING_SCALARS
10181 dstr->sv_debug_optype = sstr->sv_debug_optype;
10182 dstr->sv_debug_line = sstr->sv_debug_line;
10183 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10184 dstr->sv_debug_cloned = 1;
10185 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10188 ptr_table_store(PL_ptr_table, sstr, dstr);
10191 SvFLAGS(dstr) = SvFLAGS(sstr);
10192 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10193 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10196 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10197 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10198 (void*)PL_watch_pvx, SvPVX_const(sstr));
10201 /* don't clone objects whose class has asked us not to */
10202 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10207 switch (SvTYPE(sstr)) {
10209 SvANY(dstr) = NULL;
10212 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10214 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10216 SvIV_set(dstr, SvIVX(sstr));
10220 SvANY(dstr) = new_XNV();
10221 SvNV_set(dstr, SvNVX(sstr));
10223 /* case SVt_BIND: */
10226 /* These are all the types that need complex bodies allocating. */
10228 const svtype sv_type = SvTYPE(sstr);
10229 const struct body_details *const sv_type_details
10230 = bodies_by_type + sv_type;
10234 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10238 if (GvUNIQUE((GV*)sstr)) {
10239 NOOP; /* Do sharing here, and fall through */
10252 assert(sv_type_details->body_size);
10253 if (sv_type_details->arena) {
10254 new_body_inline(new_body, sv_type);
10256 = (void*)((char*)new_body - sv_type_details->offset);
10258 new_body = new_NOARENA(sv_type_details);
10262 SvANY(dstr) = new_body;
10265 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10266 ((char*)SvANY(dstr)) + sv_type_details->offset,
10267 sv_type_details->copy, char);
10269 Copy(((char*)SvANY(sstr)),
10270 ((char*)SvANY(dstr)),
10271 sv_type_details->body_size + sv_type_details->offset, char);
10274 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10275 && !isGV_with_GP(dstr))
10276 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10278 /* The Copy above means that all the source (unduplicated) pointers
10279 are now in the destination. We can check the flags and the
10280 pointers in either, but it's possible that there's less cache
10281 missing by always going for the destination.
10282 FIXME - instrument and check that assumption */
10283 if (sv_type >= SVt_PVMG) {
10284 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10285 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10286 } else if (SvMAGIC(dstr))
10287 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10289 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10292 /* The cast silences a GCC warning about unhandled types. */
10293 switch ((int)sv_type) {
10303 /* FIXME for plugins */
10304 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10307 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10308 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10309 LvTARG(dstr) = dstr;
10310 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10311 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10313 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10315 if(isGV_with_GP(sstr)) {
10316 if (GvNAME_HEK(dstr))
10317 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10318 /* Don't call sv_add_backref here as it's going to be
10319 created as part of the magic cloning of the symbol
10321 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10322 at the point of this comment. */
10323 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10324 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10325 (void)GpREFCNT_inc(GvGP(dstr));
10327 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10330 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10331 if (IoOFP(dstr) == IoIFP(sstr))
10332 IoOFP(dstr) = IoIFP(dstr);
10334 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10335 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10336 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10337 /* I have no idea why fake dirp (rsfps)
10338 should be treated differently but otherwise
10339 we end up with leaks -- sky*/
10340 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10341 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10342 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10344 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10345 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10346 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10347 if (IoDIRP(dstr)) {
10348 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10351 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10354 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10355 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10356 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10359 if (AvARRAY((AV*)sstr)) {
10360 SV **dst_ary, **src_ary;
10361 SSize_t items = AvFILLp((AV*)sstr) + 1;
10363 src_ary = AvARRAY((AV*)sstr);
10364 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10365 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10366 AvARRAY((AV*)dstr) = dst_ary;
10367 AvALLOC((AV*)dstr) = dst_ary;
10368 if (AvREAL((AV*)sstr)) {
10369 while (items-- > 0)
10370 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10373 while (items-- > 0)
10374 *dst_ary++ = sv_dup(*src_ary++, param);
10376 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10377 while (items-- > 0) {
10378 *dst_ary++ = &PL_sv_undef;
10382 AvARRAY((AV*)dstr) = NULL;
10383 AvALLOC((AV*)dstr) = (SV**)NULL;
10387 if (HvARRAY((HV*)sstr)) {
10389 const bool sharekeys = !!HvSHAREKEYS(sstr);
10390 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10391 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10393 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10394 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10396 HvARRAY(dstr) = (HE**)darray;
10397 while (i <= sxhv->xhv_max) {
10398 const HE * const source = HvARRAY(sstr)[i];
10399 HvARRAY(dstr)[i] = source
10400 ? he_dup(source, sharekeys, param) : 0;
10405 const struct xpvhv_aux * const saux = HvAUX(sstr);
10406 struct xpvhv_aux * const daux = HvAUX(dstr);
10407 /* This flag isn't copied. */
10408 /* SvOOK_on(hv) attacks the IV flags. */
10409 SvFLAGS(dstr) |= SVf_OOK;
10411 hvname = saux->xhv_name;
10412 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10414 daux->xhv_riter = saux->xhv_riter;
10415 daux->xhv_eiter = saux->xhv_eiter
10416 ? he_dup(saux->xhv_eiter,
10417 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10418 daux->xhv_backreferences =
10419 saux->xhv_backreferences
10420 ? (AV*) SvREFCNT_inc(
10421 sv_dup((SV*)saux->xhv_backreferences, param))
10424 daux->xhv_mro_meta = saux->xhv_mro_meta
10425 ? mro_meta_dup(saux->xhv_mro_meta, param)
10428 /* Record stashes for possible cloning in Perl_clone(). */
10430 av_push(param->stashes, dstr);
10434 HvARRAY((HV*)dstr) = NULL;
10437 if (!(param->flags & CLONEf_COPY_STACKS)) {
10441 /* NOTE: not refcounted */
10442 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10444 if (!CvISXSUB(dstr))
10445 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10447 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10448 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10449 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10450 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10452 /* don't dup if copying back - CvGV isn't refcounted, so the
10453 * duped GV may never be freed. A bit of a hack! DAPM */
10454 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10455 NULL : gv_dup(CvGV(dstr), param) ;
10456 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10458 CvWEAKOUTSIDE(sstr)
10459 ? cv_dup( CvOUTSIDE(dstr), param)
10460 : cv_dup_inc(CvOUTSIDE(dstr), param);
10461 if (!CvISXSUB(dstr))
10462 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10468 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10474 /* duplicate a context */
10477 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10479 PERL_CONTEXT *ncxs;
10482 return (PERL_CONTEXT*)NULL;
10484 /* look for it in the table first */
10485 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10489 /* create anew and remember what it is */
10490 Newxz(ncxs, max + 1, PERL_CONTEXT);
10491 ptr_table_store(PL_ptr_table, cxs, ncxs);
10494 PERL_CONTEXT * const cx = &cxs[ix];
10495 PERL_CONTEXT * const ncx = &ncxs[ix];
10496 ncx->cx_type = cx->cx_type;
10497 if (CxTYPE(cx) == CXt_SUBST) {
10498 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10501 ncx->blk_oldsp = cx->blk_oldsp;
10502 ncx->blk_oldcop = cx->blk_oldcop;
10503 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10504 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10505 ncx->blk_oldpm = cx->blk_oldpm;
10506 ncx->blk_gimme = cx->blk_gimme;
10507 switch (CxTYPE(cx)) {
10509 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10510 ? cv_dup_inc(cx->blk_sub.cv, param)
10511 : cv_dup(cx->blk_sub.cv,param));
10512 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10513 ? av_dup_inc(cx->blk_sub.argarray, param)
10515 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10516 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10517 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10518 ncx->blk_sub.lval = cx->blk_sub.lval;
10519 ncx->blk_sub.retop = cx->blk_sub.retop;
10520 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10521 cx->blk_sub.oldcomppad);
10524 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10525 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10526 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10527 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10528 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10529 ncx->blk_eval.retop = cx->blk_eval.retop;
10532 ncx->blk_loop.label = cx->blk_loop.label;
10533 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10534 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10535 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10536 ? cx->blk_loop.iterdata
10537 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10538 ncx->blk_loop.oldcomppad
10539 = (PAD*)ptr_table_fetch(PL_ptr_table,
10540 cx->blk_loop.oldcomppad);
10541 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10542 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10543 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10544 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10545 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10548 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10549 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10550 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10551 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10552 ncx->blk_sub.retop = cx->blk_sub.retop;
10564 /* duplicate a stack info structure */
10567 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10572 return (PERL_SI*)NULL;
10574 /* look for it in the table first */
10575 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10579 /* create anew and remember what it is */
10580 Newxz(nsi, 1, PERL_SI);
10581 ptr_table_store(PL_ptr_table, si, nsi);
10583 nsi->si_stack = av_dup_inc(si->si_stack, param);
10584 nsi->si_cxix = si->si_cxix;
10585 nsi->si_cxmax = si->si_cxmax;
10586 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10587 nsi->si_type = si->si_type;
10588 nsi->si_prev = si_dup(si->si_prev, param);
10589 nsi->si_next = si_dup(si->si_next, param);
10590 nsi->si_markoff = si->si_markoff;
10595 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10596 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10597 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10598 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10599 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10600 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10601 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10602 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10603 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10604 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10605 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10606 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10607 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10608 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10611 #define pv_dup_inc(p) SAVEPV(p)
10612 #define pv_dup(p) SAVEPV(p)
10613 #define svp_dup_inc(p,pp) any_dup(p,pp)
10615 /* map any object to the new equivent - either something in the
10616 * ptr table, or something in the interpreter structure
10620 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10625 return (void*)NULL;
10627 /* look for it in the table first */
10628 ret = ptr_table_fetch(PL_ptr_table, v);
10632 /* see if it is part of the interpreter structure */
10633 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10634 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10642 /* duplicate the save stack */
10645 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10648 ANY * const ss = proto_perl->Isavestack;
10649 const I32 max = proto_perl->Isavestack_max;
10650 I32 ix = proto_perl->Isavestack_ix;
10663 void (*dptr) (void*);
10664 void (*dxptr) (pTHX_ void*);
10666 Newxz(nss, max, ANY);
10669 const I32 type = POPINT(ss,ix);
10670 TOPINT(nss,ix) = type;
10672 case SAVEt_HELEM: /* hash element */
10673 sv = (SV*)POPPTR(ss,ix);
10674 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10676 case SAVEt_ITEM: /* normal string */
10677 case SAVEt_SV: /* scalar reference */
10678 sv = (SV*)POPPTR(ss,ix);
10679 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10682 case SAVEt_MORTALIZESV:
10683 sv = (SV*)POPPTR(ss,ix);
10684 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10686 case SAVEt_SHARED_PVREF: /* char* in shared space */
10687 c = (char*)POPPTR(ss,ix);
10688 TOPPTR(nss,ix) = savesharedpv(c);
10689 ptr = POPPTR(ss,ix);
10690 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10692 case SAVEt_GENERIC_SVREF: /* generic sv */
10693 case SAVEt_SVREF: /* scalar reference */
10694 sv = (SV*)POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10696 ptr = POPPTR(ss,ix);
10697 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10699 case SAVEt_HV: /* hash reference */
10700 case SAVEt_AV: /* array reference */
10701 sv = (SV*) POPPTR(ss,ix);
10702 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10704 case SAVEt_COMPPAD:
10706 sv = (SV*) POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = sv_dup(sv, param);
10709 case SAVEt_INT: /* int reference */
10710 ptr = POPPTR(ss,ix);
10711 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10712 intval = (int)POPINT(ss,ix);
10713 TOPINT(nss,ix) = intval;
10715 case SAVEt_LONG: /* long reference */
10716 ptr = POPPTR(ss,ix);
10717 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10719 case SAVEt_CLEARSV:
10720 longval = (long)POPLONG(ss,ix);
10721 TOPLONG(nss,ix) = longval;
10723 case SAVEt_I32: /* I32 reference */
10724 case SAVEt_I16: /* I16 reference */
10725 case SAVEt_I8: /* I8 reference */
10726 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10727 ptr = POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10730 TOPINT(nss,ix) = i;
10732 case SAVEt_IV: /* IV reference */
10733 ptr = POPPTR(ss,ix);
10734 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10736 TOPIV(nss,ix) = iv;
10738 case SAVEt_HPTR: /* HV* reference */
10739 case SAVEt_APTR: /* AV* reference */
10740 case SAVEt_SPTR: /* SV* reference */
10741 ptr = POPPTR(ss,ix);
10742 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10743 sv = (SV*)POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = sv_dup(sv, param);
10746 case SAVEt_VPTR: /* random* reference */
10747 ptr = POPPTR(ss,ix);
10748 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10749 ptr = POPPTR(ss,ix);
10750 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10752 case SAVEt_GENERIC_PVREF: /* generic char* */
10753 case SAVEt_PPTR: /* char* reference */
10754 ptr = POPPTR(ss,ix);
10755 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10756 c = (char*)POPPTR(ss,ix);
10757 TOPPTR(nss,ix) = pv_dup(c);
10759 case SAVEt_GP: /* scalar reference */
10760 gp = (GP*)POPPTR(ss,ix);
10761 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10762 (void)GpREFCNT_inc(gp);
10763 gv = (GV*)POPPTR(ss,ix);
10764 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10767 ptr = POPPTR(ss,ix);
10768 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10769 /* these are assumed to be refcounted properly */
10771 switch (((OP*)ptr)->op_type) {
10773 case OP_LEAVESUBLV:
10777 case OP_LEAVEWRITE:
10778 TOPPTR(nss,ix) = ptr;
10781 (void) OpREFCNT_inc(o);
10785 TOPPTR(nss,ix) = NULL;
10790 TOPPTR(nss,ix) = NULL;
10793 c = (char*)POPPTR(ss,ix);
10794 TOPPTR(nss,ix) = pv_dup_inc(c);
10797 hv = (HV*)POPPTR(ss,ix);
10798 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10799 c = (char*)POPPTR(ss,ix);
10800 TOPPTR(nss,ix) = pv_dup_inc(c);
10802 case SAVEt_STACK_POS: /* Position on Perl stack */
10804 TOPINT(nss,ix) = i;
10806 case SAVEt_DESTRUCTOR:
10807 ptr = POPPTR(ss,ix);
10808 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10809 dptr = POPDPTR(ss,ix);
10810 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10811 any_dup(FPTR2DPTR(void *, dptr),
10814 case SAVEt_DESTRUCTOR_X:
10815 ptr = POPPTR(ss,ix);
10816 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10817 dxptr = POPDXPTR(ss,ix);
10818 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10819 any_dup(FPTR2DPTR(void *, dxptr),
10822 case SAVEt_REGCONTEXT:
10825 TOPINT(nss,ix) = i;
10828 case SAVEt_AELEM: /* array element */
10829 sv = (SV*)POPPTR(ss,ix);
10830 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10832 TOPINT(nss,ix) = i;
10833 av = (AV*)POPPTR(ss,ix);
10834 TOPPTR(nss,ix) = av_dup_inc(av, param);
10837 ptr = POPPTR(ss,ix);
10838 TOPPTR(nss,ix) = ptr;
10842 TOPINT(nss,ix) = i;
10843 ptr = POPPTR(ss,ix);
10846 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10847 HINTS_REFCNT_UNLOCK;
10849 TOPPTR(nss,ix) = ptr;
10850 if (i & HINT_LOCALIZE_HH) {
10851 hv = (HV*)POPPTR(ss,ix);
10852 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10856 longval = (long)POPLONG(ss,ix);
10857 TOPLONG(nss,ix) = longval;
10858 ptr = POPPTR(ss,ix);
10859 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10860 sv = (SV*)POPPTR(ss,ix);
10861 TOPPTR(nss,ix) = sv_dup(sv, param);
10864 ptr = POPPTR(ss,ix);
10865 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10866 longval = (long)POPBOOL(ss,ix);
10867 TOPBOOL(nss,ix) = (bool)longval;
10869 case SAVEt_SET_SVFLAGS:
10871 TOPINT(nss,ix) = i;
10873 TOPINT(nss,ix) = i;
10874 sv = (SV*)POPPTR(ss,ix);
10875 TOPPTR(nss,ix) = sv_dup(sv, param);
10877 case SAVEt_RE_STATE:
10879 const struct re_save_state *const old_state
10880 = (struct re_save_state *)
10881 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10882 struct re_save_state *const new_state
10883 = (struct re_save_state *)
10884 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10886 Copy(old_state, new_state, 1, struct re_save_state);
10887 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10889 new_state->re_state_bostr
10890 = pv_dup(old_state->re_state_bostr);
10891 new_state->re_state_reginput
10892 = pv_dup(old_state->re_state_reginput);
10893 new_state->re_state_regeol
10894 = pv_dup(old_state->re_state_regeol);
10895 new_state->re_state_regoffs
10896 = (regexp_paren_pair*)
10897 any_dup(old_state->re_state_regoffs, proto_perl);
10898 new_state->re_state_reglastparen
10899 = (U32*) any_dup(old_state->re_state_reglastparen,
10901 new_state->re_state_reglastcloseparen
10902 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10904 /* XXX This just has to be broken. The old save_re_context
10905 code did SAVEGENERICPV(PL_reg_start_tmp);
10906 PL_reg_start_tmp is char **.
10907 Look above to what the dup code does for
10908 SAVEt_GENERIC_PVREF
10909 It can never have worked.
10910 So this is merely a faithful copy of the exiting bug: */
10911 new_state->re_state_reg_start_tmp
10912 = (char **) pv_dup((char *)
10913 old_state->re_state_reg_start_tmp);
10914 /* I assume that it only ever "worked" because no-one called
10915 (pseudo)fork while the regexp engine had re-entered itself.
10917 #ifdef PERL_OLD_COPY_ON_WRITE
10918 new_state->re_state_nrs
10919 = sv_dup(old_state->re_state_nrs, param);
10921 new_state->re_state_reg_magic
10922 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10924 new_state->re_state_reg_oldcurpm
10925 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10927 new_state->re_state_reg_curpm
10928 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10930 new_state->re_state_reg_oldsaved
10931 = pv_dup(old_state->re_state_reg_oldsaved);
10932 new_state->re_state_reg_poscache
10933 = pv_dup(old_state->re_state_reg_poscache);
10934 new_state->re_state_reg_starttry
10935 = pv_dup(old_state->re_state_reg_starttry);
10938 case SAVEt_COMPILE_WARNINGS:
10939 ptr = POPPTR(ss,ix);
10940 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10943 ptr = POPPTR(ss,ix);
10944 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10948 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10956 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10957 * flag to the result. This is done for each stash before cloning starts,
10958 * so we know which stashes want their objects cloned */
10961 do_mark_cloneable_stash(pTHX_ SV *sv)
10963 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10965 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10966 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10967 if (cloner && GvCV(cloner)) {
10974 mXPUSHs(newSVhek(hvname));
10976 call_sv((SV*)GvCV(cloner), G_SCALAR);
10983 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10991 =for apidoc perl_clone
10993 Create and return a new interpreter by cloning the current one.
10995 perl_clone takes these flags as parameters:
10997 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10998 without it we only clone the data and zero the stacks,
10999 with it we copy the stacks and the new perl interpreter is
11000 ready to run at the exact same point as the previous one.
11001 The pseudo-fork code uses COPY_STACKS while the
11002 threads->create doesn't.
11004 CLONEf_KEEP_PTR_TABLE
11005 perl_clone keeps a ptr_table with the pointer of the old
11006 variable as a key and the new variable as a value,
11007 this allows it to check if something has been cloned and not
11008 clone it again but rather just use the value and increase the
11009 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11010 the ptr_table using the function
11011 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11012 reason to keep it around is if you want to dup some of your own
11013 variable who are outside the graph perl scans, example of this
11014 code is in threads.xs create
11017 This is a win32 thing, it is ignored on unix, it tells perls
11018 win32host code (which is c++) to clone itself, this is needed on
11019 win32 if you want to run two threads at the same time,
11020 if you just want to do some stuff in a separate perl interpreter
11021 and then throw it away and return to the original one,
11022 you don't need to do anything.
11027 /* XXX the above needs expanding by someone who actually understands it ! */
11028 EXTERN_C PerlInterpreter *
11029 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11032 perl_clone(PerlInterpreter *proto_perl, UV flags)
11035 #ifdef PERL_IMPLICIT_SYS
11037 /* perlhost.h so we need to call into it
11038 to clone the host, CPerlHost should have a c interface, sky */
11040 if (flags & CLONEf_CLONE_HOST) {
11041 return perl_clone_host(proto_perl,flags);
11043 return perl_clone_using(proto_perl, flags,
11045 proto_perl->IMemShared,
11046 proto_perl->IMemParse,
11048 proto_perl->IStdIO,
11052 proto_perl->IProc);
11056 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11057 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11058 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11059 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11060 struct IPerlDir* ipD, struct IPerlSock* ipS,
11061 struct IPerlProc* ipP)
11063 /* XXX many of the string copies here can be optimized if they're
11064 * constants; they need to be allocated as common memory and just
11065 * their pointers copied. */
11068 CLONE_PARAMS clone_params;
11069 CLONE_PARAMS* const param = &clone_params;
11071 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11072 /* for each stash, determine whether its objects should be cloned */
11073 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11074 PERL_SET_THX(my_perl);
11077 PoisonNew(my_perl, 1, PerlInterpreter);
11083 PL_savestack_ix = 0;
11084 PL_savestack_max = -1;
11085 PL_sig_pending = 0;
11087 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11088 # else /* !DEBUGGING */
11089 Zero(my_perl, 1, PerlInterpreter);
11090 # endif /* DEBUGGING */
11092 /* host pointers */
11094 PL_MemShared = ipMS;
11095 PL_MemParse = ipMP;
11102 #else /* !PERL_IMPLICIT_SYS */
11104 CLONE_PARAMS clone_params;
11105 CLONE_PARAMS* param = &clone_params;
11106 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11107 /* for each stash, determine whether its objects should be cloned */
11108 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11109 PERL_SET_THX(my_perl);
11112 PoisonNew(my_perl, 1, PerlInterpreter);
11118 PL_savestack_ix = 0;
11119 PL_savestack_max = -1;
11120 PL_sig_pending = 0;
11122 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11123 # else /* !DEBUGGING */
11124 Zero(my_perl, 1, PerlInterpreter);
11125 # endif /* DEBUGGING */
11126 #endif /* PERL_IMPLICIT_SYS */
11127 param->flags = flags;
11128 param->proto_perl = proto_perl;
11130 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11132 PL_body_arenas = NULL;
11133 Zero(&PL_body_roots, 1, PL_body_roots);
11135 PL_nice_chunk = NULL;
11136 PL_nice_chunk_size = 0;
11138 PL_sv_objcount = 0;
11140 PL_sv_arenaroot = NULL;
11142 PL_debug = proto_perl->Idebug;
11144 PL_hash_seed = proto_perl->Ihash_seed;
11145 PL_rehash_seed = proto_perl->Irehash_seed;
11147 #ifdef USE_REENTRANT_API
11148 /* XXX: things like -Dm will segfault here in perlio, but doing
11149 * PERL_SET_CONTEXT(proto_perl);
11150 * breaks too many other things
11152 Perl_reentrant_init(aTHX);
11155 /* create SV map for pointer relocation */
11156 PL_ptr_table = ptr_table_new();
11158 /* initialize these special pointers as early as possible */
11159 SvANY(&PL_sv_undef) = NULL;
11160 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11161 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11162 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11164 SvANY(&PL_sv_no) = new_XPVNV();
11165 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11166 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11167 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11168 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11169 SvCUR_set(&PL_sv_no, 0);
11170 SvLEN_set(&PL_sv_no, 1);
11171 SvIV_set(&PL_sv_no, 0);
11172 SvNV_set(&PL_sv_no, 0);
11173 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11175 SvANY(&PL_sv_yes) = new_XPVNV();
11176 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11177 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11178 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11179 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11180 SvCUR_set(&PL_sv_yes, 1);
11181 SvLEN_set(&PL_sv_yes, 2);
11182 SvIV_set(&PL_sv_yes, 1);
11183 SvNV_set(&PL_sv_yes, 1);
11184 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11186 /* create (a non-shared!) shared string table */
11187 PL_strtab = newHV();
11188 HvSHAREKEYS_off(PL_strtab);
11189 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11190 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11192 PL_compiling = proto_perl->Icompiling;
11194 /* These two PVs will be free'd special way so must set them same way op.c does */
11195 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11196 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11198 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11199 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11201 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11202 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11203 if (PL_compiling.cop_hints_hash) {
11205 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11206 HINTS_REFCNT_UNLOCK;
11208 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11209 #ifdef PERL_DEBUG_READONLY_OPS
11214 /* pseudo environmental stuff */
11215 PL_origargc = proto_perl->Iorigargc;
11216 PL_origargv = proto_perl->Iorigargv;
11218 param->stashes = newAV(); /* Setup array of objects to call clone on */
11220 /* Set tainting stuff before PerlIO_debug can possibly get called */
11221 PL_tainting = proto_perl->Itainting;
11222 PL_taint_warn = proto_perl->Itaint_warn;
11224 #ifdef PERLIO_LAYERS
11225 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11226 PerlIO_clone(aTHX_ proto_perl, param);
11229 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11230 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11231 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11232 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11233 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11234 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11237 PL_minus_c = proto_perl->Iminus_c;
11238 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11239 PL_localpatches = proto_perl->Ilocalpatches;
11240 PL_splitstr = proto_perl->Isplitstr;
11241 PL_minus_n = proto_perl->Iminus_n;
11242 PL_minus_p = proto_perl->Iminus_p;
11243 PL_minus_l = proto_perl->Iminus_l;
11244 PL_minus_a = proto_perl->Iminus_a;
11245 PL_minus_E = proto_perl->Iminus_E;
11246 PL_minus_F = proto_perl->Iminus_F;
11247 PL_doswitches = proto_perl->Idoswitches;
11248 PL_dowarn = proto_perl->Idowarn;
11249 PL_doextract = proto_perl->Idoextract;
11250 PL_sawampersand = proto_perl->Isawampersand;
11251 PL_unsafe = proto_perl->Iunsafe;
11252 PL_inplace = SAVEPV(proto_perl->Iinplace);
11253 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11254 PL_perldb = proto_perl->Iperldb;
11255 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11256 PL_exit_flags = proto_perl->Iexit_flags;
11258 /* magical thingies */
11259 /* XXX time(&PL_basetime) when asked for? */
11260 PL_basetime = proto_perl->Ibasetime;
11261 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11263 PL_maxsysfd = proto_perl->Imaxsysfd;
11264 PL_statusvalue = proto_perl->Istatusvalue;
11266 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11268 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11270 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11272 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11273 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11274 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11277 /* RE engine related */
11278 Zero(&PL_reg_state, 1, struct re_save_state);
11279 PL_reginterp_cnt = 0;
11280 PL_regmatch_slab = NULL;
11282 /* Clone the regex array */
11283 /* ORANGE FIXME for plugins, probably in the SV dup code.
11284 newSViv(PTR2IV(CALLREGDUPE(
11285 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11287 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11288 PL_regex_pad = AvARRAY(PL_regex_padav);
11290 /* shortcuts to various I/O objects */
11291 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11292 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11293 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11294 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11295 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11296 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11298 /* shortcuts to regexp stuff */
11299 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11301 /* shortcuts to misc objects */
11302 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11304 /* shortcuts to debugging objects */
11305 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11306 PL_DBline = gv_dup(proto_perl->IDBline, param);
11307 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11308 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11309 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11310 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11311 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11313 /* symbol tables */
11314 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11315 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11316 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11317 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11318 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11320 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11321 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11322 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11323 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11324 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11325 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11326 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11327 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11329 PL_sub_generation = proto_perl->Isub_generation;
11330 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11332 /* funky return mechanisms */
11333 PL_forkprocess = proto_perl->Iforkprocess;
11335 /* subprocess state */
11336 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11338 /* internal state */
11339 PL_maxo = proto_perl->Imaxo;
11340 if (proto_perl->Iop_mask)
11341 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11344 /* PL_asserting = proto_perl->Iasserting; */
11346 /* current interpreter roots */
11347 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11349 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11351 PL_main_start = proto_perl->Imain_start;
11352 PL_eval_root = proto_perl->Ieval_root;
11353 PL_eval_start = proto_perl->Ieval_start;
11355 /* runtime control stuff */
11356 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11358 PL_filemode = proto_perl->Ifilemode;
11359 PL_lastfd = proto_perl->Ilastfd;
11360 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11363 PL_gensym = proto_perl->Igensym;
11364 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11365 PL_laststatval = proto_perl->Ilaststatval;
11366 PL_laststype = proto_perl->Ilaststype;
11369 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11371 /* interpreter atexit processing */
11372 PL_exitlistlen = proto_perl->Iexitlistlen;
11373 if (PL_exitlistlen) {
11374 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11375 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11378 PL_exitlist = (PerlExitListEntry*)NULL;
11380 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11381 if (PL_my_cxt_size) {
11382 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11383 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11384 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11385 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11386 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11390 PL_my_cxt_list = (void**)NULL;
11391 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11392 PL_my_cxt_keys = (const char**)NULL;
11395 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11396 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11397 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11399 PL_profiledata = NULL;
11401 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11403 PAD_CLONE_VARS(proto_perl, param);
11405 #ifdef HAVE_INTERP_INTERN
11406 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11409 /* more statics moved here */
11410 PL_generation = proto_perl->Igeneration;
11411 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11413 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11414 PL_in_clean_all = proto_perl->Iin_clean_all;
11416 PL_uid = proto_perl->Iuid;
11417 PL_euid = proto_perl->Ieuid;
11418 PL_gid = proto_perl->Igid;
11419 PL_egid = proto_perl->Iegid;
11420 PL_nomemok = proto_perl->Inomemok;
11421 PL_an = proto_perl->Ian;
11422 PL_evalseq = proto_perl->Ievalseq;
11423 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11424 PL_origalen = proto_perl->Iorigalen;
11425 #ifdef PERL_USES_PL_PIDSTATUS
11426 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11428 PL_osname = SAVEPV(proto_perl->Iosname);
11429 PL_sighandlerp = proto_perl->Isighandlerp;
11431 PL_runops = proto_perl->Irunops;
11433 PL_parser = parser_dup(proto_perl->Iparser, param);
11435 PL_subline = proto_perl->Isubline;
11436 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11439 PL_cryptseen = proto_perl->Icryptseen;
11442 PL_hints = proto_perl->Ihints;
11444 PL_amagic_generation = proto_perl->Iamagic_generation;
11446 #ifdef USE_LOCALE_COLLATE
11447 PL_collation_ix = proto_perl->Icollation_ix;
11448 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11449 PL_collation_standard = proto_perl->Icollation_standard;
11450 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11451 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11452 #endif /* USE_LOCALE_COLLATE */
11454 #ifdef USE_LOCALE_NUMERIC
11455 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11456 PL_numeric_standard = proto_perl->Inumeric_standard;
11457 PL_numeric_local = proto_perl->Inumeric_local;
11458 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11459 #endif /* !USE_LOCALE_NUMERIC */
11461 /* utf8 character classes */
11462 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11463 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11464 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11465 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11466 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11467 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11468 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11469 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11470 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11471 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11472 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11473 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11474 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11475 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11476 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11477 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11478 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11479 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11480 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11481 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11483 /* Did the locale setup indicate UTF-8? */
11484 PL_utf8locale = proto_perl->Iutf8locale;
11485 /* Unicode features (see perlrun/-C) */
11486 PL_unicode = proto_perl->Iunicode;
11488 /* Pre-5.8 signals control */
11489 PL_signals = proto_perl->Isignals;
11491 /* times() ticks per second */
11492 PL_clocktick = proto_perl->Iclocktick;
11494 /* Recursion stopper for PerlIO_find_layer */
11495 PL_in_load_module = proto_perl->Iin_load_module;
11497 /* sort() routine */
11498 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11500 /* Not really needed/useful since the reenrant_retint is "volatile",
11501 * but do it for consistency's sake. */
11502 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11504 /* Hooks to shared SVs and locks. */
11505 PL_sharehook = proto_perl->Isharehook;
11506 PL_lockhook = proto_perl->Ilockhook;
11507 PL_unlockhook = proto_perl->Iunlockhook;
11508 PL_threadhook = proto_perl->Ithreadhook;
11509 PL_destroyhook = proto_perl->Idestroyhook;
11511 #ifdef THREADS_HAVE_PIDS
11512 PL_ppid = proto_perl->Ippid;
11516 PL_last_swash_hv = NULL; /* reinits on demand */
11517 PL_last_swash_klen = 0;
11518 PL_last_swash_key[0]= '\0';
11519 PL_last_swash_tmps = (U8*)NULL;
11520 PL_last_swash_slen = 0;
11522 PL_glob_index = proto_perl->Iglob_index;
11523 PL_srand_called = proto_perl->Isrand_called;
11524 PL_bitcount = NULL; /* reinits on demand */
11526 if (proto_perl->Ipsig_pend) {
11527 Newxz(PL_psig_pend, SIG_SIZE, int);
11530 PL_psig_pend = (int*)NULL;
11533 if (proto_perl->Ipsig_ptr) {
11534 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11535 Newxz(PL_psig_name, SIG_SIZE, SV*);
11536 for (i = 1; i < SIG_SIZE; i++) {
11537 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11538 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11542 PL_psig_ptr = (SV**)NULL;
11543 PL_psig_name = (SV**)NULL;
11546 /* intrpvar.h stuff */
11548 if (flags & CLONEf_COPY_STACKS) {
11549 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11550 PL_tmps_ix = proto_perl->Itmps_ix;
11551 PL_tmps_max = proto_perl->Itmps_max;
11552 PL_tmps_floor = proto_perl->Itmps_floor;
11553 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11555 while (i <= PL_tmps_ix) {
11556 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11560 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11561 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11562 Newxz(PL_markstack, i, I32);
11563 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11564 - proto_perl->Imarkstack);
11565 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11566 - proto_perl->Imarkstack);
11567 Copy(proto_perl->Imarkstack, PL_markstack,
11568 PL_markstack_ptr - PL_markstack + 1, I32);
11570 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11571 * NOTE: unlike the others! */
11572 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11573 PL_scopestack_max = proto_perl->Iscopestack_max;
11574 Newxz(PL_scopestack, PL_scopestack_max, I32);
11575 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11577 /* NOTE: si_dup() looks at PL_markstack */
11578 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11580 /* PL_curstack = PL_curstackinfo->si_stack; */
11581 PL_curstack = av_dup(proto_perl->Icurstack, param);
11582 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11584 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11585 PL_stack_base = AvARRAY(PL_curstack);
11586 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11587 - proto_perl->Istack_base);
11588 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11590 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11591 * NOTE: unlike the others! */
11592 PL_savestack_ix = proto_perl->Isavestack_ix;
11593 PL_savestack_max = proto_perl->Isavestack_max;
11594 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11595 PL_savestack = ss_dup(proto_perl, param);
11599 ENTER; /* perl_destruct() wants to LEAVE; */
11601 /* although we're not duplicating the tmps stack, we should still
11602 * add entries for any SVs on the tmps stack that got cloned by a
11603 * non-refcount means (eg a temp in @_); otherwise they will be
11606 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11607 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11608 proto_perl->Itmps_stack[i]);
11609 if (nsv && !SvREFCNT(nsv)) {
11611 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11616 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11617 PL_top_env = &PL_start_env;
11619 PL_op = proto_perl->Iop;
11622 PL_Xpv = (XPV*)NULL;
11623 my_perl->Ina = proto_perl->Ina;
11625 PL_statbuf = proto_perl->Istatbuf;
11626 PL_statcache = proto_perl->Istatcache;
11627 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11628 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11630 PL_timesbuf = proto_perl->Itimesbuf;
11633 PL_tainted = proto_perl->Itainted;
11634 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11635 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11636 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11637 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11638 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11639 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11640 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11641 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11642 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11644 PL_restartop = proto_perl->Irestartop;
11645 PL_in_eval = proto_perl->Iin_eval;
11646 PL_delaymagic = proto_perl->Idelaymagic;
11647 PL_dirty = proto_perl->Idirty;
11648 PL_localizing = proto_perl->Ilocalizing;
11650 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11651 PL_hv_fetch_ent_mh = NULL;
11652 PL_modcount = proto_perl->Imodcount;
11653 PL_lastgotoprobe = NULL;
11654 PL_dumpindent = proto_perl->Idumpindent;
11656 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11657 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11658 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11659 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11660 PL_efloatbuf = NULL; /* reinits on demand */
11661 PL_efloatsize = 0; /* reinits on demand */
11665 PL_screamfirst = NULL;
11666 PL_screamnext = NULL;
11667 PL_maxscream = -1; /* reinits on demand */
11668 PL_lastscream = NULL;
11671 PL_regdummy = proto_perl->Iregdummy;
11672 PL_colorset = 0; /* reinits PL_colors[] */
11673 /*PL_colors[6] = {0,0,0,0,0,0};*/
11677 /* Pluggable optimizer */
11678 PL_peepp = proto_perl->Ipeepp;
11680 PL_stashcache = newHV();
11682 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11683 proto_perl->Iwatchaddr);
11684 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11685 if (PL_debug && PL_watchaddr) {
11686 PerlIO_printf(Perl_debug_log,
11687 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11688 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11689 PTR2UV(PL_watchok));
11692 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11693 ptr_table_free(PL_ptr_table);
11694 PL_ptr_table = NULL;
11697 /* Call the ->CLONE method, if it exists, for each of the stashes
11698 identified by sv_dup() above.
11700 while(av_len(param->stashes) != -1) {
11701 HV* const stash = (HV*) av_shift(param->stashes);
11702 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11703 if (cloner && GvCV(cloner)) {
11708 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11710 call_sv((SV*)GvCV(cloner), G_DISCARD);
11716 SvREFCNT_dec(param->stashes);
11718 /* orphaned? eg threads->new inside BEGIN or use */
11719 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11720 SvREFCNT_inc_simple_void(PL_compcv);
11721 SAVEFREESV(PL_compcv);
11727 #endif /* USE_ITHREADS */
11730 =head1 Unicode Support
11732 =for apidoc sv_recode_to_utf8
11734 The encoding is assumed to be an Encode object, on entry the PV
11735 of the sv is assumed to be octets in that encoding, and the sv
11736 will be converted into Unicode (and UTF-8).
11738 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11739 is not a reference, nothing is done to the sv. If the encoding is not
11740 an C<Encode::XS> Encoding object, bad things will happen.
11741 (See F<lib/encoding.pm> and L<Encode>).
11743 The PV of the sv is returned.
11748 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11751 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11765 Passing sv_yes is wrong - it needs to be or'ed set of constants
11766 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11767 remove converted chars from source.
11769 Both will default the value - let them.
11771 XPUSHs(&PL_sv_yes);
11774 call_method("decode", G_SCALAR);
11778 s = SvPV_const(uni, len);
11779 if (s != SvPVX_const(sv)) {
11780 SvGROW(sv, len + 1);
11781 Move(s, SvPVX(sv), len + 1, char);
11782 SvCUR_set(sv, len);
11789 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11793 =for apidoc sv_cat_decode
11795 The encoding is assumed to be an Encode object, the PV of the ssv is
11796 assumed to be octets in that encoding and decoding the input starts
11797 from the position which (PV + *offset) pointed to. The dsv will be
11798 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11799 when the string tstr appears in decoding output or the input ends on
11800 the PV of the ssv. The value which the offset points will be modified
11801 to the last input position on the ssv.
11803 Returns TRUE if the terminator was found, else returns FALSE.
11808 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11809 SV *ssv, int *offset, char *tstr, int tlen)
11813 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11824 offsv = newSViv(*offset);
11826 mXPUSHp(tstr, tlen);
11828 call_method("cat_decode", G_SCALAR);
11830 ret = SvTRUE(TOPs);
11831 *offset = SvIV(offsv);
11837 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11842 /* ---------------------------------------------------------------------
11844 * support functions for report_uninit()
11847 /* the maxiumum size of array or hash where we will scan looking
11848 * for the undefined element that triggered the warning */
11850 #define FUV_MAX_SEARCH_SIZE 1000
11852 /* Look for an entry in the hash whose value has the same SV as val;
11853 * If so, return a mortal copy of the key. */
11856 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11859 register HE **array;
11862 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11863 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11866 array = HvARRAY(hv);
11868 for (i=HvMAX(hv); i>0; i--) {
11869 register HE *entry;
11870 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11871 if (HeVAL(entry) != val)
11873 if ( HeVAL(entry) == &PL_sv_undef ||
11874 HeVAL(entry) == &PL_sv_placeholder)
11878 if (HeKLEN(entry) == HEf_SVKEY)
11879 return sv_mortalcopy(HeKEY_sv(entry));
11880 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11886 /* Look for an entry in the array whose value has the same SV as val;
11887 * If so, return the index, otherwise return -1. */
11890 S_find_array_subscript(pTHX_ AV *av, SV* val)
11893 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11894 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11897 if (val != &PL_sv_undef) {
11898 SV ** const svp = AvARRAY(av);
11901 for (i=AvFILLp(av); i>=0; i--)
11908 /* S_varname(): return the name of a variable, optionally with a subscript.
11909 * If gv is non-zero, use the name of that global, along with gvtype (one
11910 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11911 * targ. Depending on the value of the subscript_type flag, return:
11914 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11915 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11916 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11917 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11920 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11921 SV* keyname, I32 aindex, int subscript_type)
11924 SV * const name = sv_newmortal();
11927 buffer[0] = gvtype;
11930 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11932 gv_fullname4(name, gv, buffer, 0);
11934 if ((unsigned int)SvPVX(name)[1] <= 26) {
11936 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11938 /* Swap the 1 unprintable control character for the 2 byte pretty
11939 version - ie substr($name, 1, 1) = $buffer; */
11940 sv_insert(name, 1, 1, buffer, 2);
11944 CV * const cv = find_runcv(NULL);
11948 if (!cv || !CvPADLIST(cv))
11950 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11951 sv = *av_fetch(av, targ, FALSE);
11952 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11955 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11956 SV * const sv = newSV(0);
11957 *SvPVX(name) = '$';
11958 Perl_sv_catpvf(aTHX_ name, "{%s}",
11959 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11962 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11963 *SvPVX(name) = '$';
11964 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11966 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11967 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11974 =for apidoc find_uninit_var
11976 Find the name of the undefined variable (if any) that caused the operator o
11977 to issue a "Use of uninitialized value" warning.
11978 If match is true, only return a name if it's value matches uninit_sv.
11979 So roughly speaking, if a unary operator (such as OP_COS) generates a
11980 warning, then following the direct child of the op may yield an
11981 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11982 other hand, with OP_ADD there are two branches to follow, so we only print
11983 the variable name if we get an exact match.
11985 The name is returned as a mortal SV.
11987 Assumes that PL_op is the op that originally triggered the error, and that
11988 PL_comppad/PL_curpad points to the currently executing pad.
11994 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12002 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12003 uninit_sv == &PL_sv_placeholder)))
12006 switch (obase->op_type) {
12013 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12014 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12017 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12019 if (pad) { /* @lex, %lex */
12020 sv = PAD_SVl(obase->op_targ);
12024 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12025 /* @global, %global */
12026 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12029 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12031 else /* @{expr}, %{expr} */
12032 return find_uninit_var(cUNOPx(obase)->op_first,
12036 /* attempt to find a match within the aggregate */
12038 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12040 subscript_type = FUV_SUBSCRIPT_HASH;
12043 index = find_array_subscript((AV*)sv, uninit_sv);
12045 subscript_type = FUV_SUBSCRIPT_ARRAY;
12048 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12051 return varname(gv, hash ? '%' : '@', obase->op_targ,
12052 keysv, index, subscript_type);
12056 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12058 return varname(NULL, '$', obase->op_targ,
12059 NULL, 0, FUV_SUBSCRIPT_NONE);
12062 gv = cGVOPx_gv(obase);
12063 if (!gv || (match && GvSV(gv) != uninit_sv))
12065 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12068 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12071 av = (AV*)PAD_SV(obase->op_targ);
12072 if (!av || SvRMAGICAL(av))
12074 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12075 if (!svp || *svp != uninit_sv)
12078 return varname(NULL, '$', obase->op_targ,
12079 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12082 gv = cGVOPx_gv(obase);
12088 if (!av || SvRMAGICAL(av))
12090 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12091 if (!svp || *svp != uninit_sv)
12094 return varname(gv, '$', 0,
12095 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12100 o = cUNOPx(obase)->op_first;
12101 if (!o || o->op_type != OP_NULL ||
12102 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12104 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12108 if (PL_op == obase)
12109 /* $a[uninit_expr] or $h{uninit_expr} */
12110 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12113 o = cBINOPx(obase)->op_first;
12114 kid = cBINOPx(obase)->op_last;
12116 /* get the av or hv, and optionally the gv */
12118 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12119 sv = PAD_SV(o->op_targ);
12121 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12122 && cUNOPo->op_first->op_type == OP_GV)
12124 gv = cGVOPx_gv(cUNOPo->op_first);
12127 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12132 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12133 /* index is constant */
12137 if (obase->op_type == OP_HELEM) {
12138 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12139 if (!he || HeVAL(he) != uninit_sv)
12143 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12144 if (!svp || *svp != uninit_sv)
12148 if (obase->op_type == OP_HELEM)
12149 return varname(gv, '%', o->op_targ,
12150 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12152 return varname(gv, '@', o->op_targ, NULL,
12153 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12156 /* index is an expression;
12157 * attempt to find a match within the aggregate */
12158 if (obase->op_type == OP_HELEM) {
12159 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12161 return varname(gv, '%', o->op_targ,
12162 keysv, 0, FUV_SUBSCRIPT_HASH);
12165 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12167 return varname(gv, '@', o->op_targ,
12168 NULL, index, FUV_SUBSCRIPT_ARRAY);
12173 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12175 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12180 /* only examine RHS */
12181 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12184 o = cUNOPx(obase)->op_first;
12185 if (o->op_type == OP_PUSHMARK)
12188 if (!o->op_sibling) {
12189 /* one-arg version of open is highly magical */
12191 if (o->op_type == OP_GV) { /* open FOO; */
12193 if (match && GvSV(gv) != uninit_sv)
12195 return varname(gv, '$', 0,
12196 NULL, 0, FUV_SUBSCRIPT_NONE);
12198 /* other possibilities not handled are:
12199 * open $x; or open my $x; should return '${*$x}'
12200 * open expr; should return '$'.expr ideally
12206 /* ops where $_ may be an implicit arg */
12210 if ( !(obase->op_flags & OPf_STACKED)) {
12211 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12212 ? PAD_SVl(obase->op_targ)
12215 sv = sv_newmortal();
12216 sv_setpvn(sv, "$_", 2);
12225 /* skip filehandle as it can't produce 'undef' warning */
12226 o = cUNOPx(obase)->op_first;
12227 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12228 o = o->op_sibling->op_sibling;
12234 match = 1; /* XS or custom code could trigger random warnings */
12239 /* XXX tmp hack: these two may call an XS sub, and currently
12240 XS subs don't have a SUB entry on the context stack, so CV and
12241 pad determination goes wrong, and BAD things happen. So, just
12242 don't try to determine the value under those circumstances.
12243 Need a better fix at dome point. DAPM 11/2007 */
12247 /* def-ness of rval pos() is independent of the def-ness of its arg */
12248 if ( !(obase->op_flags & OPf_MOD))
12253 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12254 return newSVpvs_flags("${$/}", SVs_TEMP);
12259 if (!(obase->op_flags & OPf_KIDS))
12261 o = cUNOPx(obase)->op_first;
12267 /* if all except one arg are constant, or have no side-effects,
12268 * or are optimized away, then it's unambiguous */
12270 for (kid=o; kid; kid = kid->op_sibling) {
12272 const OPCODE type = kid->op_type;
12273 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12274 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12275 || (type == OP_PUSHMARK)
12279 if (o2) { /* more than one found */
12286 return find_uninit_var(o2, uninit_sv, match);
12288 /* scan all args */
12290 sv = find_uninit_var(o, uninit_sv, 1);
12302 =for apidoc report_uninit
12304 Print appropriate "Use of uninitialized variable" warning
12310 Perl_report_uninit(pTHX_ SV* uninit_sv)
12314 SV* varname = NULL;
12316 varname = find_uninit_var(PL_op, uninit_sv,0);
12318 sv_insert(varname, 0, 0, " ", 1);
12320 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12321 varname ? SvPV_nolen_const(varname) : "",
12322 " in ", OP_DESC(PL_op));
12325 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12331 * c-indentation-style: bsd
12332 * c-basic-offset: 4
12333 * indent-tabs-mode: t
12336 * ex: set ts=8 sts=4 sw=4 noet: