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)) {
2813 if (ckWARN(WARN_UNINITIALIZED))
2820 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2821 /* I'm assuming that if both IV and NV are equally valid then
2822 converting the IV is going to be more efficient */
2823 const U32 isUIOK = SvIsUV(sv);
2824 char buf[TYPE_CHARS(UV)];
2828 if (SvTYPE(sv) < SVt_PVIV)
2829 sv_upgrade(sv, SVt_PVIV);
2830 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2832 /* inlined from sv_setpvn */
2833 s = SvGROW_mutable(sv, len + 1);
2834 Move(ptr, s, len, char);
2838 else if (SvNOKp(sv)) {
2839 const int olderrno = errno;
2840 if (SvTYPE(sv) < SVt_PVNV)
2841 sv_upgrade(sv, SVt_PVNV);
2842 /* The +20 is pure guesswork. Configure test needed. --jhi */
2843 s = SvGROW_mutable(sv, NV_DIG + 20);
2844 /* some Xenix systems wipe out errno here */
2846 if (SvNVX(sv) == 0.0)
2847 my_strlcpy(s, "0", SvLEN(sv));
2851 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2854 #ifdef FIXNEGATIVEZERO
2855 if (*s == '-' && s[1] == '0' && !s[2]) {
2867 if (isGV_with_GP(sv))
2868 return glob_2pv((GV *)sv, lp);
2870 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2874 if (SvTYPE(sv) < SVt_PV)
2875 /* Typically the caller expects that sv_any is not NULL now. */
2876 sv_upgrade(sv, SVt_PV);
2880 const STRLEN len = s - SvPVX_const(sv);
2886 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2887 PTR2UV(sv),SvPVX_const(sv)));
2888 if (flags & SV_CONST_RETURN)
2889 return (char *)SvPVX_const(sv);
2890 if (flags & SV_MUTABLE_RETURN)
2891 return SvPVX_mutable(sv);
2896 =for apidoc sv_copypv
2898 Copies a stringified representation of the source SV into the
2899 destination SV. Automatically performs any necessary mg_get and
2900 coercion of numeric values into strings. Guaranteed to preserve
2901 UTF8 flag even from overloaded objects. Similar in nature to
2902 sv_2pv[_flags] but operates directly on an SV instead of just the
2903 string. Mostly uses sv_2pv_flags to do its work, except when that
2904 would lose the UTF-8'ness of the PV.
2910 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2913 const char * const s = SvPV_const(ssv,len);
2914 sv_setpvn(dsv,s,len);
2922 =for apidoc sv_2pvbyte
2924 Return a pointer to the byte-encoded representation of the SV, and set *lp
2925 to its length. May cause the SV to be downgraded from UTF-8 as a
2928 Usually accessed via the C<SvPVbyte> macro.
2934 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2936 sv_utf8_downgrade(sv,0);
2937 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2941 =for apidoc sv_2pvutf8
2943 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2944 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2946 Usually accessed via the C<SvPVutf8> macro.
2952 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2954 sv_utf8_upgrade(sv);
2955 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2960 =for apidoc sv_2bool
2962 This function is only called on magical items, and is only used by
2963 sv_true() or its macro equivalent.
2969 Perl_sv_2bool(pTHX_ register SV *sv)
2978 SV * const tmpsv = AMG_CALLun(sv,bool_);
2979 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2980 return (bool)SvTRUE(tmpsv);
2982 return SvRV(sv) != 0;
2985 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2987 (*sv->sv_u.svu_pv > '0' ||
2988 Xpvtmp->xpv_cur > 1 ||
2989 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2996 return SvIVX(sv) != 0;
2999 return SvNVX(sv) != 0.0;
3001 if (isGV_with_GP(sv))
3011 =for apidoc sv_utf8_upgrade
3013 Converts the PV of an SV to its UTF-8-encoded form.
3014 Forces the SV to string form if it is not already.
3015 Always sets the SvUTF8 flag to avoid future validity checks even
3016 if all the bytes have hibit clear.
3018 This is not as a general purpose byte encoding to Unicode interface:
3019 use the Encode extension for that.
3021 =for apidoc sv_utf8_upgrade_flags
3023 Converts the PV of an SV to its UTF-8-encoded form.
3024 Forces the SV to string form if it is not already.
3025 Always sets the SvUTF8 flag to avoid future validity checks even
3026 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3027 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3028 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3030 This is not as a general purpose byte encoding to Unicode interface:
3031 use the Encode extension for that.
3037 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3040 if (sv == &PL_sv_undef)
3044 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3045 (void) sv_2pv_flags(sv,&len, flags);
3049 (void) SvPV_force(sv,len);
3058 sv_force_normal_flags(sv, 0);
3061 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3062 sv_recode_to_utf8(sv, PL_encoding);
3063 else { /* Assume Latin-1/EBCDIC */
3064 /* This function could be much more efficient if we
3065 * had a FLAG in SVs to signal if there are any hibit
3066 * chars in the PV. Given that there isn't such a flag
3067 * make the loop as fast as possible. */
3068 const U8 * const s = (U8 *) SvPVX_const(sv);
3069 const U8 * const e = (U8 *) SvEND(sv);
3074 /* Check for hi bit */
3075 if (!NATIVE_IS_INVARIANT(ch)) {
3076 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3077 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3079 SvPV_free(sv); /* No longer using what was there before. */
3080 SvPV_set(sv, (char*)recoded);
3081 SvCUR_set(sv, len - 1);
3082 SvLEN_set(sv, len); /* No longer know the real size. */
3086 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3093 =for apidoc sv_utf8_downgrade
3095 Attempts to convert the PV of an SV from characters to bytes.
3096 If the PV contains a character beyond byte, this conversion will fail;
3097 in this case, either returns false or, if C<fail_ok> is not
3100 This is not as a general purpose Unicode to byte encoding interface:
3101 use the Encode extension for that.
3107 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3110 if (SvPOKp(sv) && SvUTF8(sv)) {
3116 sv_force_normal_flags(sv, 0);
3118 s = (U8 *) SvPV(sv, len);
3119 if (!utf8_to_bytes(s, &len)) {
3124 Perl_croak(aTHX_ "Wide character in %s",
3127 Perl_croak(aTHX_ "Wide character");
3138 =for apidoc sv_utf8_encode
3140 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3141 flag off so that it looks like octets again.
3147 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3150 sv_force_normal_flags(sv, 0);
3152 if (SvREADONLY(sv)) {
3153 Perl_croak(aTHX_ PL_no_modify);
3155 (void) sv_utf8_upgrade(sv);
3160 =for apidoc sv_utf8_decode
3162 If the PV of the SV is an octet sequence in UTF-8
3163 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3164 so that it looks like a character. If the PV contains only single-byte
3165 characters, the C<SvUTF8> flag stays being off.
3166 Scans PV for validity and returns false if the PV is invalid UTF-8.
3172 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3178 /* The octets may have got themselves encoded - get them back as
3181 if (!sv_utf8_downgrade(sv, TRUE))
3184 /* it is actually just a matter of turning the utf8 flag on, but
3185 * we want to make sure everything inside is valid utf8 first.
3187 c = (const U8 *) SvPVX_const(sv);
3188 if (!is_utf8_string(c, SvCUR(sv)+1))
3190 e = (const U8 *) SvEND(sv);
3193 if (!UTF8_IS_INVARIANT(ch)) {
3203 =for apidoc sv_setsv
3205 Copies the contents of the source SV C<ssv> into the destination SV
3206 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3207 function if the source SV needs to be reused. Does not handle 'set' magic.
3208 Loosely speaking, it performs a copy-by-value, obliterating any previous
3209 content of the destination.
3211 You probably want to use one of the assortment of wrappers, such as
3212 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3213 C<SvSetMagicSV_nosteal>.
3215 =for apidoc sv_setsv_flags
3217 Copies the contents of the source SV C<ssv> into the destination SV
3218 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3219 function if the source SV needs to be reused. Does not handle 'set' magic.
3220 Loosely speaking, it performs a copy-by-value, obliterating any previous
3221 content of the destination.
3222 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3223 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3224 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3225 and C<sv_setsv_nomg> are implemented in terms of this function.
3227 You probably want to use one of the assortment of wrappers, such as
3228 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3229 C<SvSetMagicSV_nosteal>.
3231 This is the primary function for copying scalars, and most other
3232 copy-ish functions and macros use this underneath.
3238 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3240 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3242 if (dtype != SVt_PVGV) {
3243 const char * const name = GvNAME(sstr);
3244 const STRLEN len = GvNAMELEN(sstr);
3246 if (dtype >= SVt_PV) {
3252 SvUPGRADE(dstr, SVt_PVGV);
3253 (void)SvOK_off(dstr);
3254 /* FIXME - why are we doing this, then turning it off and on again
3256 isGV_with_GP_on(dstr);
3258 GvSTASH(dstr) = GvSTASH(sstr);
3260 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3261 gv_name_set((GV *)dstr, name, len, GV_ADD);
3262 SvFAKE_on(dstr); /* can coerce to non-glob */
3265 #ifdef GV_UNIQUE_CHECK
3266 if (GvUNIQUE((GV*)dstr)) {
3267 Perl_croak(aTHX_ PL_no_modify);
3271 if(GvGP((GV*)sstr)) {
3272 /* If source has method cache entry, clear it */
3274 SvREFCNT_dec(GvCV(sstr));
3278 /* If source has a real method, then a method is
3280 else if(GvCV((GV*)sstr)) {
3285 /* If dest already had a real method, that's a change as well */
3286 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3290 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3294 isGV_with_GP_off(dstr);
3295 (void)SvOK_off(dstr);
3296 isGV_with_GP_on(dstr);
3297 GvINTRO_off(dstr); /* one-shot flag */
3298 GvGP(dstr) = gp_ref(GvGP(sstr));
3299 if (SvTAINTED(sstr))
3301 if (GvIMPORTED(dstr) != GVf_IMPORTED
3302 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3304 GvIMPORTED_on(dstr);
3307 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3308 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3313 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3314 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3316 const int intro = GvINTRO(dstr);
3319 const U32 stype = SvTYPE(sref);
3322 #ifdef GV_UNIQUE_CHECK
3323 if (GvUNIQUE((GV*)dstr)) {
3324 Perl_croak(aTHX_ PL_no_modify);
3329 GvINTRO_off(dstr); /* one-shot flag */
3330 GvLINE(dstr) = CopLINE(PL_curcop);
3331 GvEGV(dstr) = (GV*)dstr;
3336 location = (SV **) &GvCV(dstr);
3337 import_flag = GVf_IMPORTED_CV;
3340 location = (SV **) &GvHV(dstr);
3341 import_flag = GVf_IMPORTED_HV;
3344 location = (SV **) &GvAV(dstr);
3345 import_flag = GVf_IMPORTED_AV;
3348 location = (SV **) &GvIOp(dstr);
3351 location = (SV **) &GvFORM(dstr);
3353 location = &GvSV(dstr);
3354 import_flag = GVf_IMPORTED_SV;
3357 if (stype == SVt_PVCV) {
3358 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3359 if (GvCVGEN(dstr)) {
3360 SvREFCNT_dec(GvCV(dstr));
3362 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3365 SAVEGENERICSV(*location);
3369 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3370 CV* const cv = (CV*)*location;
3372 if (!GvCVGEN((GV*)dstr) &&
3373 (CvROOT(cv) || CvXSUB(cv)))
3375 /* Redefining a sub - warning is mandatory if
3376 it was a const and its value changed. */
3377 if (CvCONST(cv) && CvCONST((CV*)sref)
3378 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3380 /* They are 2 constant subroutines generated from
3381 the same constant. This probably means that
3382 they are really the "same" proxy subroutine
3383 instantiated in 2 places. Most likely this is
3384 when a constant is exported twice. Don't warn.
3387 else if (ckWARN(WARN_REDEFINE)
3389 && (!CvCONST((CV*)sref)
3390 || sv_cmp(cv_const_sv(cv),
3391 cv_const_sv((CV*)sref))))) {
3392 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3395 ? "Constant subroutine %s::%s redefined"
3396 : "Subroutine %s::%s redefined"),
3397 HvNAME_get(GvSTASH((GV*)dstr)),
3398 GvENAME((GV*)dstr));
3402 cv_ckproto_len(cv, (GV*)dstr,
3403 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3404 SvPOK(sref) ? SvCUR(sref) : 0);
3406 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3407 GvASSUMECV_on(dstr);
3408 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3411 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3412 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3413 GvFLAGS(dstr) |= import_flag;
3418 if (SvTAINTED(sstr))
3424 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3427 register U32 sflags;
3429 register svtype stype;
3434 if (SvIS_FREED(dstr)) {
3435 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3436 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3438 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3440 sstr = &PL_sv_undef;
3441 if (SvIS_FREED(sstr)) {
3442 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3443 (void*)sstr, (void*)dstr);
3445 stype = SvTYPE(sstr);
3446 dtype = SvTYPE(dstr);
3448 (void)SvAMAGIC_off(dstr);
3451 /* need to nuke the magic */
3453 SvRMAGICAL_off(dstr);
3456 /* There's a lot of redundancy below but we're going for speed here */
3461 if (dtype != SVt_PVGV) {
3462 (void)SvOK_off(dstr);
3470 sv_upgrade(dstr, SVt_IV);
3474 sv_upgrade(dstr, SVt_PVIV);
3477 goto end_of_first_switch;
3479 (void)SvIOK_only(dstr);
3480 SvIV_set(dstr, SvIVX(sstr));
3483 /* SvTAINTED can only be true if the SV has taint magic, which in
3484 turn means that the SV type is PVMG (or greater). This is the
3485 case statement for SVt_IV, so this cannot be true (whatever gcov
3487 assert(!SvTAINTED(sstr));
3492 if (dtype < SVt_PV && dtype != SVt_IV)
3493 sv_upgrade(dstr, SVt_IV);
3501 sv_upgrade(dstr, SVt_NV);
3505 sv_upgrade(dstr, SVt_PVNV);
3508 goto end_of_first_switch;
3510 SvNV_set(dstr, SvNVX(sstr));
3511 (void)SvNOK_only(dstr);
3512 /* SvTAINTED can only be true if the SV has taint magic, which in
3513 turn means that the SV type is PVMG (or greater). This is the
3514 case statement for SVt_NV, so this cannot be true (whatever gcov
3516 assert(!SvTAINTED(sstr));
3522 #ifdef PERL_OLD_COPY_ON_WRITE
3523 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3524 if (dtype < SVt_PVIV)
3525 sv_upgrade(dstr, SVt_PVIV);
3533 sv_upgrade(dstr, SVt_PV);
3536 if (dtype < SVt_PVIV)
3537 sv_upgrade(dstr, SVt_PVIV);
3540 if (dtype < SVt_PVNV)
3541 sv_upgrade(dstr, SVt_PVNV);
3545 const char * const type = sv_reftype(sstr,0);
3547 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3549 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3553 /* case SVt_BIND: */
3556 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3557 glob_assign_glob(dstr, sstr, dtype);
3560 /* SvVALID means that this PVGV is playing at being an FBM. */
3564 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3566 if (SvTYPE(sstr) != stype) {
3567 stype = SvTYPE(sstr);
3568 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3569 glob_assign_glob(dstr, sstr, dtype);
3574 if (stype == SVt_PVLV)
3575 SvUPGRADE(dstr, SVt_PVNV);
3577 SvUPGRADE(dstr, (svtype)stype);
3579 end_of_first_switch:
3581 /* dstr may have been upgraded. */
3582 dtype = SvTYPE(dstr);
3583 sflags = SvFLAGS(sstr);
3585 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3586 /* Assigning to a subroutine sets the prototype. */
3589 const char *const ptr = SvPV_const(sstr, len);
3591 SvGROW(dstr, len + 1);
3592 Copy(ptr, SvPVX(dstr), len + 1, char);
3593 SvCUR_set(dstr, len);
3595 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3599 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3600 const char * const type = sv_reftype(dstr,0);
3602 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3604 Perl_croak(aTHX_ "Cannot copy to %s", type);
3605 } else if (sflags & SVf_ROK) {
3606 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3607 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3610 if (GvIMPORTED(dstr) != GVf_IMPORTED
3611 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3613 GvIMPORTED_on(dstr);
3618 glob_assign_glob(dstr, sstr, dtype);
3622 if (dtype >= SVt_PV) {
3623 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3624 glob_assign_ref(dstr, sstr);
3627 if (SvPVX_const(dstr)) {
3633 (void)SvOK_off(dstr);
3634 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3635 SvFLAGS(dstr) |= sflags & SVf_ROK;
3636 assert(!(sflags & SVp_NOK));
3637 assert(!(sflags & SVp_IOK));
3638 assert(!(sflags & SVf_NOK));
3639 assert(!(sflags & SVf_IOK));
3641 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3642 if (!(sflags & SVf_OK)) {
3643 if (ckWARN(WARN_MISC))
3644 Perl_warner(aTHX_ packWARN(WARN_MISC),
3645 "Undefined value assigned to typeglob");
3648 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3649 if (dstr != (SV*)gv) {
3652 GvGP(dstr) = gp_ref(GvGP(gv));
3656 else if (sflags & SVp_POK) {
3660 * Check to see if we can just swipe the string. If so, it's a
3661 * possible small lose on short strings, but a big win on long ones.
3662 * It might even be a win on short strings if SvPVX_const(dstr)
3663 * has to be allocated and SvPVX_const(sstr) has to be freed.
3664 * Likewise if we can set up COW rather than doing an actual copy, we
3665 * drop to the else clause, as the swipe code and the COW setup code
3666 * have much in common.
3669 /* Whichever path we take through the next code, we want this true,
3670 and doing it now facilitates the COW check. */
3671 (void)SvPOK_only(dstr);
3674 /* If we're already COW then this clause is not true, and if COW
3675 is allowed then we drop down to the else and make dest COW
3676 with us. If caller hasn't said that we're allowed to COW
3677 shared hash keys then we don't do the COW setup, even if the
3678 source scalar is a shared hash key scalar. */
3679 (((flags & SV_COW_SHARED_HASH_KEYS)
3680 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3681 : 1 /* If making a COW copy is forbidden then the behaviour we
3682 desire is as if the source SV isn't actually already
3683 COW, even if it is. So we act as if the source flags
3684 are not COW, rather than actually testing them. */
3686 #ifndef PERL_OLD_COPY_ON_WRITE
3687 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3688 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3689 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3690 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3691 but in turn, it's somewhat dead code, never expected to go
3692 live, but more kept as a placeholder on how to do it better
3693 in a newer implementation. */
3694 /* If we are COW and dstr is a suitable target then we drop down
3695 into the else and make dest a COW of us. */
3696 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3701 (sflags & SVs_TEMP) && /* slated for free anyway? */
3702 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3703 (!(flags & SV_NOSTEAL)) &&
3704 /* and we're allowed to steal temps */
3705 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3706 SvLEN(sstr) && /* and really is a string */
3707 /* and won't be needed again, potentially */
3708 !(PL_op && PL_op->op_type == OP_AASSIGN))
3709 #ifdef PERL_OLD_COPY_ON_WRITE
3710 && ((flags & SV_COW_SHARED_HASH_KEYS)
3711 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3712 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3713 && SvTYPE(sstr) >= SVt_PVIV))
3717 /* Failed the swipe test, and it's not a shared hash key either.
3718 Have to copy the string. */
3719 STRLEN len = SvCUR(sstr);
3720 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3721 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3722 SvCUR_set(dstr, len);
3723 *SvEND(dstr) = '\0';
3725 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3727 /* Either it's a shared hash key, or it's suitable for
3728 copy-on-write or we can swipe the string. */
3730 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3734 #ifdef PERL_OLD_COPY_ON_WRITE
3736 /* I believe I should acquire a global SV mutex if
3737 it's a COW sv (not a shared hash key) to stop
3738 it going un copy-on-write.
3739 If the source SV has gone un copy on write between up there
3740 and down here, then (assert() that) it is of the correct
3741 form to make it copy on write again */
3742 if ((sflags & (SVf_FAKE | SVf_READONLY))
3743 != (SVf_FAKE | SVf_READONLY)) {
3744 SvREADONLY_on(sstr);
3746 /* Make the source SV into a loop of 1.
3747 (about to become 2) */
3748 SV_COW_NEXT_SV_SET(sstr, sstr);
3752 /* Initial code is common. */
3753 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3758 /* making another shared SV. */
3759 STRLEN cur = SvCUR(sstr);
3760 STRLEN len = SvLEN(sstr);
3761 #ifdef PERL_OLD_COPY_ON_WRITE
3763 assert (SvTYPE(dstr) >= SVt_PVIV);
3764 /* SvIsCOW_normal */
3765 /* splice us in between source and next-after-source. */
3766 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3767 SV_COW_NEXT_SV_SET(sstr, dstr);
3768 SvPV_set(dstr, SvPVX_mutable(sstr));
3772 /* SvIsCOW_shared_hash */
3773 DEBUG_C(PerlIO_printf(Perl_debug_log,
3774 "Copy on write: Sharing hash\n"));
3776 assert (SvTYPE(dstr) >= SVt_PV);
3778 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3780 SvLEN_set(dstr, len);
3781 SvCUR_set(dstr, cur);
3782 SvREADONLY_on(dstr);
3784 /* Relesase a global SV mutex. */
3787 { /* Passes the swipe test. */
3788 SvPV_set(dstr, SvPVX_mutable(sstr));
3789 SvLEN_set(dstr, SvLEN(sstr));
3790 SvCUR_set(dstr, SvCUR(sstr));
3793 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3794 SvPV_set(sstr, NULL);
3800 if (sflags & SVp_NOK) {
3801 SvNV_set(dstr, SvNVX(sstr));
3803 if (sflags & SVp_IOK) {
3804 SvIV_set(dstr, SvIVX(sstr));
3805 /* Must do this otherwise some other overloaded use of 0x80000000
3806 gets confused. I guess SVpbm_VALID */
3807 if (sflags & SVf_IVisUV)
3810 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3812 const MAGIC * const smg = SvVSTRING_mg(sstr);
3814 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3815 smg->mg_ptr, smg->mg_len);
3816 SvRMAGICAL_on(dstr);
3820 else if (sflags & (SVp_IOK|SVp_NOK)) {
3821 (void)SvOK_off(dstr);
3822 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3823 if (sflags & SVp_IOK) {
3824 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3825 SvIV_set(dstr, SvIVX(sstr));
3827 if (sflags & SVp_NOK) {
3828 SvNV_set(dstr, SvNVX(sstr));
3832 if (isGV_with_GP(sstr)) {
3833 /* This stringification rule for globs is spread in 3 places.
3834 This feels bad. FIXME. */
3835 const U32 wasfake = sflags & SVf_FAKE;
3837 /* FAKE globs can get coerced, so need to turn this off
3838 temporarily if it is on. */
3840 gv_efullname3(dstr, (GV *)sstr, "*");
3841 SvFLAGS(sstr) |= wasfake;
3844 (void)SvOK_off(dstr);
3846 if (SvTAINTED(sstr))
3851 =for apidoc sv_setsv_mg
3853 Like C<sv_setsv>, but also handles 'set' magic.
3859 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3861 sv_setsv(dstr,sstr);
3865 #ifdef PERL_OLD_COPY_ON_WRITE
3867 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3869 STRLEN cur = SvCUR(sstr);
3870 STRLEN len = SvLEN(sstr);
3871 register char *new_pv;
3874 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3875 (void*)sstr, (void*)dstr);
3882 if (SvTHINKFIRST(dstr))
3883 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3884 else if (SvPVX_const(dstr))
3885 Safefree(SvPVX_const(dstr));
3889 SvUPGRADE(dstr, SVt_PVIV);
3891 assert (SvPOK(sstr));
3892 assert (SvPOKp(sstr));
3893 assert (!SvIOK(sstr));
3894 assert (!SvIOKp(sstr));
3895 assert (!SvNOK(sstr));
3896 assert (!SvNOKp(sstr));
3898 if (SvIsCOW(sstr)) {
3900 if (SvLEN(sstr) == 0) {
3901 /* source is a COW shared hash key. */
3902 DEBUG_C(PerlIO_printf(Perl_debug_log,
3903 "Fast copy on write: Sharing hash\n"));
3904 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3907 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3909 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3910 SvUPGRADE(sstr, SVt_PVIV);
3911 SvREADONLY_on(sstr);
3913 DEBUG_C(PerlIO_printf(Perl_debug_log,
3914 "Fast copy on write: Converting sstr to COW\n"));
3915 SV_COW_NEXT_SV_SET(dstr, sstr);
3917 SV_COW_NEXT_SV_SET(sstr, dstr);
3918 new_pv = SvPVX_mutable(sstr);
3921 SvPV_set(dstr, new_pv);
3922 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3925 SvLEN_set(dstr, len);
3926 SvCUR_set(dstr, cur);
3935 =for apidoc sv_setpvn
3937 Copies a string into an SV. The C<len> parameter indicates the number of
3938 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3939 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3945 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3948 register char *dptr;
3950 SV_CHECK_THINKFIRST_COW_DROP(sv);
3956 /* len is STRLEN which is unsigned, need to copy to signed */
3959 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3961 SvUPGRADE(sv, SVt_PV);
3963 dptr = SvGROW(sv, len + 1);
3964 Move(ptr,dptr,len,char);
3967 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3972 =for apidoc sv_setpvn_mg
3974 Like C<sv_setpvn>, but also handles 'set' magic.
3980 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3982 sv_setpvn(sv,ptr,len);
3987 =for apidoc sv_setpv
3989 Copies a string into an SV. The string must be null-terminated. Does not
3990 handle 'set' magic. See C<sv_setpv_mg>.
3996 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3999 register STRLEN len;
4001 SV_CHECK_THINKFIRST_COW_DROP(sv);
4007 SvUPGRADE(sv, SVt_PV);
4009 SvGROW(sv, len + 1);
4010 Move(ptr,SvPVX(sv),len+1,char);
4012 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4017 =for apidoc sv_setpv_mg
4019 Like C<sv_setpv>, but also handles 'set' magic.
4025 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4032 =for apidoc sv_usepvn_flags
4034 Tells an SV to use C<ptr> to find its string value. Normally the
4035 string is stored inside the SV but sv_usepvn allows the SV to use an
4036 outside string. The C<ptr> should point to memory that was allocated
4037 by C<malloc>. The string length, C<len>, must be supplied. By default
4038 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4039 so that pointer should not be freed or used by the programmer after
4040 giving it to sv_usepvn, and neither should any pointers from "behind"
4041 that pointer (e.g. ptr + 1) be used.
4043 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4044 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4045 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4046 C<len>, and already meets the requirements for storing in C<SvPVX>)
4052 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4056 SV_CHECK_THINKFIRST_COW_DROP(sv);
4057 SvUPGRADE(sv, SVt_PV);
4060 if (flags & SV_SMAGIC)
4064 if (SvPVX_const(sv))
4068 if (flags & SV_HAS_TRAILING_NUL)
4069 assert(ptr[len] == '\0');
4072 allocate = (flags & SV_HAS_TRAILING_NUL)
4073 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4074 if (flags & SV_HAS_TRAILING_NUL) {
4075 /* It's long enough - do nothing.
4076 Specfically Perl_newCONSTSUB is relying on this. */
4079 /* Force a move to shake out bugs in callers. */
4080 char *new_ptr = (char*)safemalloc(allocate);
4081 Copy(ptr, new_ptr, len, char);
4082 PoisonFree(ptr,len,char);
4086 ptr = (char*) saferealloc (ptr, allocate);
4091 SvLEN_set(sv, allocate);
4092 if (!(flags & SV_HAS_TRAILING_NUL)) {
4095 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4097 if (flags & SV_SMAGIC)
4101 #ifdef PERL_OLD_COPY_ON_WRITE
4102 /* Need to do this *after* making the SV normal, as we need the buffer
4103 pointer to remain valid until after we've copied it. If we let go too early,
4104 another thread could invalidate it by unsharing last of the same hash key
4105 (which it can do by means other than releasing copy-on-write Svs)
4106 or by changing the other copy-on-write SVs in the loop. */
4108 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4110 { /* this SV was SvIsCOW_normal(sv) */
4111 /* we need to find the SV pointing to us. */
4112 SV *current = SV_COW_NEXT_SV(after);
4114 if (current == sv) {
4115 /* The SV we point to points back to us (there were only two of us
4117 Hence other SV is no longer copy on write either. */
4119 SvREADONLY_off(after);
4121 /* We need to follow the pointers around the loop. */
4123 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4126 /* don't loop forever if the structure is bust, and we have
4127 a pointer into a closed loop. */
4128 assert (current != after);
4129 assert (SvPVX_const(current) == pvx);
4131 /* Make the SV before us point to the SV after us. */
4132 SV_COW_NEXT_SV_SET(current, after);
4138 =for apidoc sv_force_normal_flags
4140 Undo various types of fakery on an SV: if the PV is a shared string, make
4141 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4142 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4143 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4144 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4145 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4146 set to some other value.) In addition, the C<flags> parameter gets passed to
4147 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4148 with flags set to 0.
4154 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4157 #ifdef PERL_OLD_COPY_ON_WRITE
4158 if (SvREADONLY(sv)) {
4159 /* At this point I believe I should acquire a global SV mutex. */
4161 const char * const pvx = SvPVX_const(sv);
4162 const STRLEN len = SvLEN(sv);
4163 const STRLEN cur = SvCUR(sv);
4164 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4165 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4166 we'll fail an assertion. */
4167 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4170 PerlIO_printf(Perl_debug_log,
4171 "Copy on write: Force normal %ld\n",
4177 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4180 if (flags & SV_COW_DROP_PV) {
4181 /* OK, so we don't need to copy our buffer. */
4184 SvGROW(sv, cur + 1);
4185 Move(pvx,SvPVX(sv),cur,char);
4190 sv_release_COW(sv, pvx, next);
4192 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4198 else if (IN_PERL_RUNTIME)
4199 Perl_croak(aTHX_ PL_no_modify);
4200 /* At this point I believe that I can drop the global SV mutex. */
4203 if (SvREADONLY(sv)) {
4205 const char * const pvx = SvPVX_const(sv);
4206 const STRLEN len = SvCUR(sv);
4211 SvGROW(sv, len + 1);
4212 Move(pvx,SvPVX(sv),len,char);
4214 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4216 else if (IN_PERL_RUNTIME)
4217 Perl_croak(aTHX_ PL_no_modify);
4221 sv_unref_flags(sv, flags);
4222 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4229 Efficient removal of characters from the beginning of the string buffer.
4230 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4231 the string buffer. The C<ptr> becomes the first character of the adjusted
4232 string. Uses the "OOK hack".
4233 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4234 refer to the same chunk of data.
4240 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4246 const U8 *real_start;
4249 if (!ptr || !SvPOKp(sv))
4251 delta = ptr - SvPVX_const(sv);
4253 /* Nothing to do. */
4256 assert(ptr > SvPVX_const(sv));
4257 SV_CHECK_THINKFIRST(sv);
4260 if (!SvLEN(sv)) { /* make copy of shared string */
4261 const char *pvx = SvPVX_const(sv);
4262 const STRLEN len = SvCUR(sv);
4263 SvGROW(sv, len + 1);
4264 Move(pvx,SvPVX(sv),len,char);
4267 SvFLAGS(sv) |= SVf_OOK;
4270 SvOOK_offset(sv, old_delta);
4272 SvLEN_set(sv, SvLEN(sv) - delta);
4273 SvCUR_set(sv, SvCUR(sv) - delta);
4274 SvPV_set(sv, SvPVX(sv) + delta);
4276 p = (U8 *)SvPVX_const(sv);
4281 real_start = p - delta;
4285 if (delta < 0x100) {
4289 p -= sizeof(STRLEN);
4290 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4294 /* Fill the preceding buffer with sentinals to verify that no-one is
4296 while (p > real_start) {
4304 =for apidoc sv_catpvn
4306 Concatenates the string onto the end of the string which is in the SV. The
4307 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4308 status set, then the bytes appended should be valid UTF-8.
4309 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4311 =for apidoc sv_catpvn_flags
4313 Concatenates the string onto the end of the string which is in the SV. The
4314 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4315 status set, then the bytes appended should be valid UTF-8.
4316 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4317 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4318 in terms of this function.
4324 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4328 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4330 SvGROW(dsv, dlen + slen + 1);
4332 sstr = SvPVX_const(dsv);
4333 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4334 SvCUR_set(dsv, SvCUR(dsv) + slen);
4336 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4338 if (flags & SV_SMAGIC)
4343 =for apidoc sv_catsv
4345 Concatenates the string from SV C<ssv> onto the end of the string in
4346 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4347 not 'set' magic. See C<sv_catsv_mg>.
4349 =for apidoc sv_catsv_flags
4351 Concatenates the string from SV C<ssv> onto the end of the string in
4352 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4353 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4354 and C<sv_catsv_nomg> are implemented in terms of this function.
4359 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4364 const char *spv = SvPV_const(ssv, slen);
4366 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4367 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4368 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4369 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4370 dsv->sv_flags doesn't have that bit set.
4371 Andy Dougherty 12 Oct 2001
4373 const I32 sutf8 = DO_UTF8(ssv);
4376 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4378 dutf8 = DO_UTF8(dsv);
4380 if (dutf8 != sutf8) {
4382 /* Not modifying source SV, so taking a temporary copy. */
4383 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4385 sv_utf8_upgrade(csv);
4386 spv = SvPV_const(csv, slen);
4389 sv_utf8_upgrade_nomg(dsv);
4391 sv_catpvn_nomg(dsv, spv, slen);
4394 if (flags & SV_SMAGIC)
4399 =for apidoc sv_catpv
4401 Concatenates the string onto the end of the string which is in the SV.
4402 If the SV has the UTF-8 status set, then the bytes appended should be
4403 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4408 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4411 register STRLEN len;
4417 junk = SvPV_force(sv, tlen);
4419 SvGROW(sv, tlen + len + 1);
4421 ptr = SvPVX_const(sv);
4422 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4423 SvCUR_set(sv, SvCUR(sv) + len);
4424 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4429 =for apidoc sv_catpv_mg
4431 Like C<sv_catpv>, but also handles 'set' magic.
4437 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4446 Creates a new SV. A non-zero C<len> parameter indicates the number of
4447 bytes of preallocated string space the SV should have. An extra byte for a
4448 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4449 space is allocated.) The reference count for the new SV is set to 1.
4451 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4452 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4453 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4454 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4455 modules supporting older perls.
4461 Perl_newSV(pTHX_ STRLEN len)
4468 sv_upgrade(sv, SVt_PV);
4469 SvGROW(sv, len + 1);
4474 =for apidoc sv_magicext
4476 Adds magic to an SV, upgrading it if necessary. Applies the
4477 supplied vtable and returns a pointer to the magic added.
4479 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4480 In particular, you can add magic to SvREADONLY SVs, and add more than
4481 one instance of the same 'how'.
4483 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4484 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4485 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4486 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4488 (This is now used as a subroutine by C<sv_magic>.)
4493 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4494 const char* name, I32 namlen)
4499 SvUPGRADE(sv, SVt_PVMG);
4500 Newxz(mg, 1, MAGIC);
4501 mg->mg_moremagic = SvMAGIC(sv);
4502 SvMAGIC_set(sv, mg);
4504 /* Sometimes a magic contains a reference loop, where the sv and
4505 object refer to each other. To prevent a reference loop that
4506 would prevent such objects being freed, we look for such loops
4507 and if we find one we avoid incrementing the object refcount.
4509 Note we cannot do this to avoid self-tie loops as intervening RV must
4510 have its REFCNT incremented to keep it in existence.
4513 if (!obj || obj == sv ||
4514 how == PERL_MAGIC_arylen ||
4515 how == PERL_MAGIC_symtab ||
4516 (SvTYPE(obj) == SVt_PVGV &&
4517 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4518 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4519 GvFORM(obj) == (CV*)sv)))
4524 mg->mg_obj = SvREFCNT_inc_simple(obj);
4525 mg->mg_flags |= MGf_REFCOUNTED;
4528 /* Normal self-ties simply pass a null object, and instead of
4529 using mg_obj directly, use the SvTIED_obj macro to produce a
4530 new RV as needed. For glob "self-ties", we are tieing the PVIO
4531 with an RV obj pointing to the glob containing the PVIO. In
4532 this case, to avoid a reference loop, we need to weaken the
4536 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4537 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4543 mg->mg_len = namlen;
4546 mg->mg_ptr = savepvn(name, namlen);
4547 else if (namlen == HEf_SVKEY)
4548 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4550 mg->mg_ptr = (char *) name;
4552 mg->mg_virtual = (MGVTBL *) vtable;
4556 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4561 =for apidoc sv_magic
4563 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4564 then adds a new magic item of type C<how> to the head of the magic list.
4566 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4567 handling of the C<name> and C<namlen> arguments.
4569 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4570 to add more than one instance of the same 'how'.
4576 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4579 const MGVTBL *vtable;
4582 #ifdef PERL_OLD_COPY_ON_WRITE
4584 sv_force_normal_flags(sv, 0);
4586 if (SvREADONLY(sv)) {
4588 /* its okay to attach magic to shared strings; the subsequent
4589 * upgrade to PVMG will unshare the string */
4590 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4593 && how != PERL_MAGIC_regex_global
4594 && how != PERL_MAGIC_bm
4595 && how != PERL_MAGIC_fm
4596 && how != PERL_MAGIC_sv
4597 && how != PERL_MAGIC_backref
4600 Perl_croak(aTHX_ PL_no_modify);
4603 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4604 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4605 /* sv_magic() refuses to add a magic of the same 'how' as an
4608 if (how == PERL_MAGIC_taint) {
4610 /* Any scalar which already had taint magic on which someone
4611 (erroneously?) did SvIOK_on() or similar will now be
4612 incorrectly sporting public "OK" flags. */
4613 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4621 vtable = &PL_vtbl_sv;
4623 case PERL_MAGIC_overload:
4624 vtable = &PL_vtbl_amagic;
4626 case PERL_MAGIC_overload_elem:
4627 vtable = &PL_vtbl_amagicelem;
4629 case PERL_MAGIC_overload_table:
4630 vtable = &PL_vtbl_ovrld;
4633 vtable = &PL_vtbl_bm;
4635 case PERL_MAGIC_regdata:
4636 vtable = &PL_vtbl_regdata;
4638 case PERL_MAGIC_regdatum:
4639 vtable = &PL_vtbl_regdatum;
4641 case PERL_MAGIC_env:
4642 vtable = &PL_vtbl_env;
4645 vtable = &PL_vtbl_fm;
4647 case PERL_MAGIC_envelem:
4648 vtable = &PL_vtbl_envelem;
4650 case PERL_MAGIC_regex_global:
4651 vtable = &PL_vtbl_mglob;
4653 case PERL_MAGIC_isa:
4654 vtable = &PL_vtbl_isa;
4656 case PERL_MAGIC_isaelem:
4657 vtable = &PL_vtbl_isaelem;
4659 case PERL_MAGIC_nkeys:
4660 vtable = &PL_vtbl_nkeys;
4662 case PERL_MAGIC_dbfile:
4665 case PERL_MAGIC_dbline:
4666 vtable = &PL_vtbl_dbline;
4668 #ifdef USE_LOCALE_COLLATE
4669 case PERL_MAGIC_collxfrm:
4670 vtable = &PL_vtbl_collxfrm;
4672 #endif /* USE_LOCALE_COLLATE */
4673 case PERL_MAGIC_tied:
4674 vtable = &PL_vtbl_pack;
4676 case PERL_MAGIC_tiedelem:
4677 case PERL_MAGIC_tiedscalar:
4678 vtable = &PL_vtbl_packelem;
4681 vtable = &PL_vtbl_regexp;
4683 case PERL_MAGIC_hints:
4684 /* As this vtable is all NULL, we can reuse it. */
4685 case PERL_MAGIC_sig:
4686 vtable = &PL_vtbl_sig;
4688 case PERL_MAGIC_sigelem:
4689 vtable = &PL_vtbl_sigelem;
4691 case PERL_MAGIC_taint:
4692 vtable = &PL_vtbl_taint;
4694 case PERL_MAGIC_uvar:
4695 vtable = &PL_vtbl_uvar;
4697 case PERL_MAGIC_vec:
4698 vtable = &PL_vtbl_vec;
4700 case PERL_MAGIC_arylen_p:
4701 case PERL_MAGIC_rhash:
4702 case PERL_MAGIC_symtab:
4703 case PERL_MAGIC_vstring:
4706 case PERL_MAGIC_utf8:
4707 vtable = &PL_vtbl_utf8;
4709 case PERL_MAGIC_substr:
4710 vtable = &PL_vtbl_substr;
4712 case PERL_MAGIC_defelem:
4713 vtable = &PL_vtbl_defelem;
4715 case PERL_MAGIC_arylen:
4716 vtable = &PL_vtbl_arylen;
4718 case PERL_MAGIC_pos:
4719 vtable = &PL_vtbl_pos;
4721 case PERL_MAGIC_backref:
4722 vtable = &PL_vtbl_backref;
4724 case PERL_MAGIC_hintselem:
4725 vtable = &PL_vtbl_hintselem;
4727 case PERL_MAGIC_ext:
4728 /* Reserved for use by extensions not perl internals. */
4729 /* Useful for attaching extension internal data to perl vars. */
4730 /* Note that multiple extensions may clash if magical scalars */
4731 /* etc holding private data from one are passed to another. */
4735 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4738 /* Rest of work is done else where */
4739 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4742 case PERL_MAGIC_taint:
4745 case PERL_MAGIC_ext:
4746 case PERL_MAGIC_dbfile:
4753 =for apidoc sv_unmagic
4755 Removes all magic of type C<type> from an SV.
4761 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4765 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4767 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4768 for (mg = *mgp; mg; mg = *mgp) {
4769 if (mg->mg_type == type) {
4770 const MGVTBL* const vtbl = mg->mg_virtual;
4771 *mgp = mg->mg_moremagic;
4772 if (vtbl && vtbl->svt_free)
4773 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4774 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4776 Safefree(mg->mg_ptr);
4777 else if (mg->mg_len == HEf_SVKEY)
4778 SvREFCNT_dec((SV*)mg->mg_ptr);
4779 else if (mg->mg_type == PERL_MAGIC_utf8)
4780 Safefree(mg->mg_ptr);
4782 if (mg->mg_flags & MGf_REFCOUNTED)
4783 SvREFCNT_dec(mg->mg_obj);
4787 mgp = &mg->mg_moremagic;
4791 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4792 SvMAGIC_set(sv, NULL);
4799 =for apidoc sv_rvweaken
4801 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4802 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4803 push a back-reference to this RV onto the array of backreferences
4804 associated with that magic. If the RV is magical, set magic will be
4805 called after the RV is cleared.
4811 Perl_sv_rvweaken(pTHX_ SV *sv)
4814 if (!SvOK(sv)) /* let undefs pass */
4817 Perl_croak(aTHX_ "Can't weaken a nonreference");
4818 else if (SvWEAKREF(sv)) {
4819 if (ckWARN(WARN_MISC))
4820 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4824 Perl_sv_add_backref(aTHX_ tsv, sv);
4830 /* Give tsv backref magic if it hasn't already got it, then push a
4831 * back-reference to sv onto the array associated with the backref magic.
4835 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4840 if (SvTYPE(tsv) == SVt_PVHV) {
4841 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4845 /* There is no AV in the offical place - try a fixup. */
4846 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4849 /* Aha. They've got it stowed in magic. Bring it back. */
4850 av = (AV*)mg->mg_obj;
4851 /* Stop mg_free decreasing the refernce count. */
4853 /* Stop mg_free even calling the destructor, given that
4854 there's no AV to free up. */
4856 sv_unmagic(tsv, PERL_MAGIC_backref);
4860 SvREFCNT_inc_simple_void(av);
4865 const MAGIC *const mg
4866 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4868 av = (AV*)mg->mg_obj;
4872 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4873 /* av now has a refcnt of 2, which avoids it getting freed
4874 * before us during global cleanup. The extra ref is removed
4875 * by magic_killbackrefs() when tsv is being freed */
4878 if (AvFILLp(av) >= AvMAX(av)) {
4879 av_extend(av, AvFILLp(av)+1);
4881 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4884 /* delete a back-reference to ourselves from the backref magic associated
4885 * with the SV we point to.
4889 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4896 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4897 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4898 /* We mustn't attempt to "fix up" the hash here by moving the
4899 backreference array back to the hv_aux structure, as that is stored
4900 in the main HvARRAY(), and hfreentries assumes that no-one
4901 reallocates HvARRAY() while it is running. */
4904 const MAGIC *const mg
4905 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4907 av = (AV *)mg->mg_obj;
4910 if (PL_in_clean_all)
4912 Perl_croak(aTHX_ "panic: del_backref");
4919 /* We shouldn't be in here more than once, but for paranoia reasons lets
4921 for (i = AvFILLp(av); i >= 0; i--) {
4923 const SSize_t fill = AvFILLp(av);
4925 /* We weren't the last entry.
4926 An unordered list has this property that you can take the
4927 last element off the end to fill the hole, and it's still
4928 an unordered list :-)
4933 AvFILLp(av) = fill - 1;
4939 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4941 SV **svp = AvARRAY(av);
4943 PERL_UNUSED_ARG(sv);
4945 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4946 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4947 if (svp && !SvIS_FREED(av)) {
4948 SV *const *const last = svp + AvFILLp(av);
4950 while (svp <= last) {
4952 SV *const referrer = *svp;
4953 if (SvWEAKREF(referrer)) {
4954 /* XXX Should we check that it hasn't changed? */
4955 SvRV_set(referrer, 0);
4957 SvWEAKREF_off(referrer);
4958 SvSETMAGIC(referrer);
4959 } else if (SvTYPE(referrer) == SVt_PVGV ||
4960 SvTYPE(referrer) == SVt_PVLV) {
4961 /* You lookin' at me? */
4962 assert(GvSTASH(referrer));
4963 assert(GvSTASH(referrer) == (HV*)sv);
4964 GvSTASH(referrer) = 0;
4967 "panic: magic_killbackrefs (flags=%"UVxf")",
4968 (UV)SvFLAGS(referrer));
4976 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4981 =for apidoc sv_insert
4983 Inserts a string at the specified offset/length within the SV. Similar to
4984 the Perl substr() function.
4990 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4995 register char *midend;
4996 register char *bigend;
5002 Perl_croak(aTHX_ "Can't modify non-existent substring");
5003 SvPV_force(bigstr, curlen);
5004 (void)SvPOK_only_UTF8(bigstr);
5005 if (offset + len > curlen) {
5006 SvGROW(bigstr, offset+len+1);
5007 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5008 SvCUR_set(bigstr, offset+len);
5012 i = littlelen - len;
5013 if (i > 0) { /* string might grow */
5014 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5015 mid = big + offset + len;
5016 midend = bigend = big + SvCUR(bigstr);
5019 while (midend > mid) /* shove everything down */
5020 *--bigend = *--midend;
5021 Move(little,big+offset,littlelen,char);
5022 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5027 Move(little,SvPVX(bigstr)+offset,len,char);
5032 big = SvPVX(bigstr);
5035 bigend = big + SvCUR(bigstr);
5037 if (midend > bigend)
5038 Perl_croak(aTHX_ "panic: sv_insert");
5040 if (mid - big > bigend - midend) { /* faster to shorten from end */
5042 Move(little, mid, littlelen,char);
5045 i = bigend - midend;
5047 Move(midend, mid, i,char);
5051 SvCUR_set(bigstr, mid - big);
5053 else if ((i = mid - big)) { /* faster from front */
5054 midend -= littlelen;
5056 Move(big, midend - i, i, char);
5057 sv_chop(bigstr,midend-i);
5059 Move(little, mid, littlelen,char);
5061 else if (littlelen) {
5062 midend -= littlelen;
5063 sv_chop(bigstr,midend);
5064 Move(little,midend,littlelen,char);
5067 sv_chop(bigstr,midend);
5073 =for apidoc sv_replace
5075 Make the first argument a copy of the second, then delete the original.
5076 The target SV physically takes over ownership of the body of the source SV
5077 and inherits its flags; however, the target keeps any magic it owns,
5078 and any magic in the source is discarded.
5079 Note that this is a rather specialist SV copying operation; most of the
5080 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5086 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5089 const U32 refcnt = SvREFCNT(sv);
5090 SV_CHECK_THINKFIRST_COW_DROP(sv);
5091 if (SvREFCNT(nsv) != 1) {
5092 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5093 UVuf " != 1)", (UV) SvREFCNT(nsv));
5095 if (SvMAGICAL(sv)) {
5099 sv_upgrade(nsv, SVt_PVMG);
5100 SvMAGIC_set(nsv, SvMAGIC(sv));
5101 SvFLAGS(nsv) |= SvMAGICAL(sv);
5103 SvMAGIC_set(sv, NULL);
5107 assert(!SvREFCNT(sv));
5108 #ifdef DEBUG_LEAKING_SCALARS
5109 sv->sv_flags = nsv->sv_flags;
5110 sv->sv_any = nsv->sv_any;
5111 sv->sv_refcnt = nsv->sv_refcnt;
5112 sv->sv_u = nsv->sv_u;
5114 StructCopy(nsv,sv,SV);
5116 if(SvTYPE(sv) == SVt_IV) {
5118 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5122 #ifdef PERL_OLD_COPY_ON_WRITE
5123 if (SvIsCOW_normal(nsv)) {
5124 /* We need to follow the pointers around the loop to make the
5125 previous SV point to sv, rather than nsv. */
5128 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5131 assert(SvPVX_const(current) == SvPVX_const(nsv));
5133 /* Make the SV before us point to the SV after us. */
5135 PerlIO_printf(Perl_debug_log, "previous is\n");
5137 PerlIO_printf(Perl_debug_log,
5138 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5139 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5141 SV_COW_NEXT_SV_SET(current, sv);
5144 SvREFCNT(sv) = refcnt;
5145 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5151 =for apidoc sv_clear
5153 Clear an SV: call any destructors, free up any memory used by the body,
5154 and free the body itself. The SV's head is I<not> freed, although
5155 its type is set to all 1's so that it won't inadvertently be assumed
5156 to be live during global destruction etc.
5157 This function should only be called when REFCNT is zero. Most of the time
5158 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5165 Perl_sv_clear(pTHX_ register SV *sv)
5168 const U32 type = SvTYPE(sv);
5169 const struct body_details *const sv_type_details
5170 = bodies_by_type + type;
5174 assert(SvREFCNT(sv) == 0);
5175 assert(SvTYPE(sv) != SVTYPEMASK);
5177 if (type <= SVt_IV) {
5178 /* See the comment in sv.h about the collusion between this early
5179 return and the overloading of the NULL and IV slots in the size
5182 SV * const target = SvRV(sv);
5184 sv_del_backref(target, sv);
5186 SvREFCNT_dec(target);
5188 SvFLAGS(sv) &= SVf_BREAK;
5189 SvFLAGS(sv) |= SVTYPEMASK;
5194 if (PL_defstash && /* Still have a symbol table? */
5201 stash = SvSTASH(sv);
5202 destructor = StashHANDLER(stash,DESTROY);
5204 SV* const tmpref = newRV(sv);
5205 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5207 PUSHSTACKi(PERLSI_DESTROY);
5212 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5218 if(SvREFCNT(tmpref) < 2) {
5219 /* tmpref is not kept alive! */
5221 SvRV_set(tmpref, NULL);
5224 SvREFCNT_dec(tmpref);
5226 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5230 if (PL_in_clean_objs)
5231 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5233 /* DESTROY gave object new lease on life */
5239 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5240 SvOBJECT_off(sv); /* Curse the object. */
5241 if (type != SVt_PVIO)
5242 --PL_sv_objcount; /* XXX Might want something more general */
5245 if (type >= SVt_PVMG) {
5246 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5247 SvREFCNT_dec(SvOURSTASH(sv));
5248 } else if (SvMAGIC(sv))
5250 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5251 SvREFCNT_dec(SvSTASH(sv));
5254 /* case SVt_BIND: */
5257 IoIFP(sv) != PerlIO_stdin() &&
5258 IoIFP(sv) != PerlIO_stdout() &&
5259 IoIFP(sv) != PerlIO_stderr())
5261 io_close((IO*)sv, FALSE);
5263 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5264 PerlDir_close(IoDIRP(sv));
5265 IoDIRP(sv) = (DIR*)NULL;
5266 Safefree(IoTOP_NAME(sv));
5267 Safefree(IoFMT_NAME(sv));
5268 Safefree(IoBOTTOM_NAME(sv));
5271 /* FIXME for plugins */
5272 pregfree2((REGEXP*) sv);
5279 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5283 if (PL_comppad == (AV*)sv) {
5290 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5291 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5292 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5293 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5295 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5296 SvREFCNT_dec(LvTARG(sv));
5298 if (isGV_with_GP(sv)) {
5299 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5300 mro_method_changed_in(stash);
5303 unshare_hek(GvNAME_HEK(sv));
5304 /* If we're in a stash, we don't own a reference to it. However it does
5305 have a back reference to us, which needs to be cleared. */
5306 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5307 sv_del_backref((SV*)stash, sv);
5309 /* FIXME. There are probably more unreferenced pointers to SVs in the
5310 interpreter struct that we should check and tidy in a similar
5312 if ((GV*)sv == PL_last_in_gv)
5313 PL_last_in_gv = NULL;
5319 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5322 SvOOK_offset(sv, offset);
5323 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5324 /* Don't even bother with turning off the OOK flag. */
5327 SV * const target = SvRV(sv);
5329 sv_del_backref(target, sv);
5331 SvREFCNT_dec(target);
5333 #ifdef PERL_OLD_COPY_ON_WRITE
5334 else if (SvPVX_const(sv)) {
5336 /* I believe I need to grab the global SV mutex here and
5337 then recheck the COW status. */
5339 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5343 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5345 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5348 /* And drop it here. */
5350 } else if (SvLEN(sv)) {
5351 Safefree(SvPVX_const(sv));
5355 else if (SvPVX_const(sv) && SvLEN(sv))
5356 Safefree(SvPVX_mutable(sv));
5357 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5358 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5367 SvFLAGS(sv) &= SVf_BREAK;
5368 SvFLAGS(sv) |= SVTYPEMASK;
5370 if (sv_type_details->arena) {
5371 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5372 &PL_body_roots[type]);
5374 else if (sv_type_details->body_size) {
5375 my_safefree(SvANY(sv));
5380 =for apidoc sv_newref
5382 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5389 Perl_sv_newref(pTHX_ SV *sv)
5391 PERL_UNUSED_CONTEXT;
5400 Decrement an SV's reference count, and if it drops to zero, call
5401 C<sv_clear> to invoke destructors and free up any memory used by
5402 the body; finally, deallocate the SV's head itself.
5403 Normally called via a wrapper macro C<SvREFCNT_dec>.
5409 Perl_sv_free(pTHX_ SV *sv)
5414 if (SvREFCNT(sv) == 0) {
5415 if (SvFLAGS(sv) & SVf_BREAK)
5416 /* this SV's refcnt has been artificially decremented to
5417 * trigger cleanup */
5419 if (PL_in_clean_all) /* All is fair */
5421 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5422 /* make sure SvREFCNT(sv)==0 happens very seldom */
5423 SvREFCNT(sv) = (~(U32)0)/2;
5426 if (ckWARN_d(WARN_INTERNAL)) {
5427 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5428 Perl_dump_sv_child(aTHX_ sv);
5430 #ifdef DEBUG_LEAKING_SCALARS
5433 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5434 if (PL_warnhook == PERL_WARNHOOK_FATAL
5435 || ckDEAD(packWARN(WARN_INTERNAL))) {
5436 /* Don't let Perl_warner cause us to escape our fate: */
5440 /* This may not return: */
5441 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5442 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5443 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5446 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5451 if (--(SvREFCNT(sv)) > 0)
5453 Perl_sv_free2(aTHX_ sv);
5457 Perl_sv_free2(pTHX_ SV *sv)
5462 if (ckWARN_d(WARN_DEBUGGING))
5463 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5464 "Attempt to free temp prematurely: SV 0x%"UVxf
5465 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5469 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5470 /* make sure SvREFCNT(sv)==0 happens very seldom */
5471 SvREFCNT(sv) = (~(U32)0)/2;
5482 Returns the length of the string in the SV. Handles magic and type
5483 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5489 Perl_sv_len(pTHX_ register SV *sv)
5497 len = mg_length(sv);
5499 (void)SvPV_const(sv, len);
5504 =for apidoc sv_len_utf8
5506 Returns the number of characters in the string in an SV, counting wide
5507 UTF-8 bytes as a single character. Handles magic and type coercion.
5513 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5514 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5515 * (Note that the mg_len is not the length of the mg_ptr field.
5516 * This allows the cache to store the character length of the string without
5517 * needing to malloc() extra storage to attach to the mg_ptr.)
5522 Perl_sv_len_utf8(pTHX_ register SV *sv)
5528 return mg_length(sv);
5532 const U8 *s = (U8*)SvPV_const(sv, len);
5536 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5538 if (mg && mg->mg_len != -1) {
5540 if (PL_utf8cache < 0) {
5541 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5543 /* Need to turn the assertions off otherwise we may
5544 recurse infinitely while printing error messages.
5546 SAVEI8(PL_utf8cache);
5548 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5549 " real %"UVuf" for %"SVf,
5550 (UV) ulen, (UV) real, SVfARG(sv));
5555 ulen = Perl_utf8_length(aTHX_ s, s + len);
5556 if (!SvREADONLY(sv)) {
5558 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5559 &PL_vtbl_utf8, 0, 0);
5567 return Perl_utf8_length(aTHX_ s, s + len);
5571 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5574 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5577 const U8 *s = start;
5579 while (s < send && uoffset--)
5582 /* This is the existing behaviour. Possibly it should be a croak, as
5583 it's actually a bounds error */
5589 /* Given the length of the string in both bytes and UTF-8 characters, decide
5590 whether to walk forwards or backwards to find the byte corresponding to
5591 the passed in UTF-8 offset. */
5593 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5594 STRLEN uoffset, STRLEN uend)
5596 STRLEN backw = uend - uoffset;
5597 if (uoffset < 2 * backw) {
5598 /* The assumption is that going forwards is twice the speed of going
5599 forward (that's where the 2 * backw comes from).
5600 (The real figure of course depends on the UTF-8 data.) */
5601 return sv_pos_u2b_forwards(start, send, uoffset);
5606 while (UTF8_IS_CONTINUATION(*send))
5609 return send - start;
5612 /* For the string representation of the given scalar, find the byte
5613 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5614 give another position in the string, *before* the sought offset, which
5615 (which is always true, as 0, 0 is a valid pair of positions), which should
5616 help reduce the amount of linear searching.
5617 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5618 will be used to reduce the amount of linear searching. The cache will be
5619 created if necessary, and the found value offered to it for update. */
5621 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5622 const U8 *const send, STRLEN uoffset,
5623 STRLEN uoffset0, STRLEN boffset0) {
5624 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5627 assert (uoffset >= uoffset0);
5629 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5630 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5631 if ((*mgp)->mg_ptr) {
5632 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5633 if (cache[0] == uoffset) {
5634 /* An exact match. */
5637 if (cache[2] == uoffset) {
5638 /* An exact match. */
5642 if (cache[0] < uoffset) {
5643 /* The cache already knows part of the way. */
5644 if (cache[0] > uoffset0) {
5645 /* The cache knows more than the passed in pair */
5646 uoffset0 = cache[0];
5647 boffset0 = cache[1];
5649 if ((*mgp)->mg_len != -1) {
5650 /* And we know the end too. */
5652 + sv_pos_u2b_midway(start + boffset0, send,
5654 (*mgp)->mg_len - uoffset0);
5657 + sv_pos_u2b_forwards(start + boffset0,
5658 send, uoffset - uoffset0);
5661 else if (cache[2] < uoffset) {
5662 /* We're between the two cache entries. */
5663 if (cache[2] > uoffset0) {
5664 /* and the cache knows more than the passed in pair */
5665 uoffset0 = cache[2];
5666 boffset0 = cache[3];
5670 + sv_pos_u2b_midway(start + boffset0,
5673 cache[0] - uoffset0);
5676 + sv_pos_u2b_midway(start + boffset0,
5679 cache[2] - uoffset0);
5683 else if ((*mgp)->mg_len != -1) {
5684 /* If we can take advantage of a passed in offset, do so. */
5685 /* In fact, offset0 is either 0, or less than offset, so don't
5686 need to worry about the other possibility. */
5688 + sv_pos_u2b_midway(start + boffset0, send,
5690 (*mgp)->mg_len - uoffset0);
5695 if (!found || PL_utf8cache < 0) {
5696 const STRLEN real_boffset
5697 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5698 send, uoffset - uoffset0);
5700 if (found && PL_utf8cache < 0) {
5701 if (real_boffset != boffset) {
5702 /* Need to turn the assertions off otherwise we may recurse
5703 infinitely while printing error messages. */
5704 SAVEI8(PL_utf8cache);
5706 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5707 " real %"UVuf" for %"SVf,
5708 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5711 boffset = real_boffset;
5714 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5720 =for apidoc sv_pos_u2b
5722 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5723 the start of the string, to a count of the equivalent number of bytes; if
5724 lenp is non-zero, it does the same to lenp, but this time starting from
5725 the offset, rather than from the start of the string. Handles magic and
5732 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5733 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5734 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5739 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5747 start = (U8*)SvPV_const(sv, len);
5749 STRLEN uoffset = (STRLEN) *offsetp;
5750 const U8 * const send = start + len;
5752 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5755 *offsetp = (I32) boffset;
5758 /* Convert the relative offset to absolute. */
5759 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5760 const STRLEN boffset2
5761 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5762 uoffset, boffset) - boffset;
5776 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5777 byte length pairing. The (byte) length of the total SV is passed in too,
5778 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5779 may not have updated SvCUR, so we can't rely on reading it directly.
5781 The proffered utf8/byte length pairing isn't used if the cache already has
5782 two pairs, and swapping either for the proffered pair would increase the
5783 RMS of the intervals between known byte offsets.
5785 The cache itself consists of 4 STRLEN values
5786 0: larger UTF-8 offset
5787 1: corresponding byte offset
5788 2: smaller UTF-8 offset
5789 3: corresponding byte offset
5791 Unused cache pairs have the value 0, 0.
5792 Keeping the cache "backwards" means that the invariant of
5793 cache[0] >= cache[2] is maintained even with empty slots, which means that
5794 the code that uses it doesn't need to worry if only 1 entry has actually
5795 been set to non-zero. It also makes the "position beyond the end of the
5796 cache" logic much simpler, as the first slot is always the one to start
5800 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5808 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5810 (*mgp)->mg_len = -1;
5814 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5815 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5816 (*mgp)->mg_ptr = (char *) cache;
5820 if (PL_utf8cache < 0) {
5821 const U8 *start = (const U8 *) SvPVX_const(sv);
5822 const STRLEN realutf8 = utf8_length(start, start + byte);
5824 if (realutf8 != utf8) {
5825 /* Need to turn the assertions off otherwise we may recurse
5826 infinitely while printing error messages. */
5827 SAVEI8(PL_utf8cache);
5829 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5830 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5834 /* Cache is held with the later position first, to simplify the code
5835 that deals with unbounded ends. */
5837 ASSERT_UTF8_CACHE(cache);
5838 if (cache[1] == 0) {
5839 /* Cache is totally empty */
5842 } else if (cache[3] == 0) {
5843 if (byte > cache[1]) {
5844 /* New one is larger, so goes first. */
5845 cache[2] = cache[0];
5846 cache[3] = cache[1];
5854 #define THREEWAY_SQUARE(a,b,c,d) \
5855 ((float)((d) - (c))) * ((float)((d) - (c))) \
5856 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5857 + ((float)((b) - (a))) * ((float)((b) - (a)))
5859 /* Cache has 2 slots in use, and we know three potential pairs.
5860 Keep the two that give the lowest RMS distance. Do the
5861 calcualation in bytes simply because we always know the byte
5862 length. squareroot has the same ordering as the positive value,
5863 so don't bother with the actual square root. */
5864 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5865 if (byte > cache[1]) {
5866 /* New position is after the existing pair of pairs. */
5867 const float keep_earlier
5868 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5869 const float keep_later
5870 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5872 if (keep_later < keep_earlier) {
5873 if (keep_later < existing) {
5874 cache[2] = cache[0];
5875 cache[3] = cache[1];
5881 if (keep_earlier < existing) {
5887 else if (byte > cache[3]) {
5888 /* New position is between the existing pair of pairs. */
5889 const float keep_earlier
5890 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5891 const float keep_later
5892 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5894 if (keep_later < keep_earlier) {
5895 if (keep_later < existing) {
5901 if (keep_earlier < existing) {
5908 /* New position is before the existing pair of pairs. */
5909 const float keep_earlier
5910 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5911 const float keep_later
5912 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5914 if (keep_later < keep_earlier) {
5915 if (keep_later < existing) {
5921 if (keep_earlier < existing) {
5922 cache[0] = cache[2];
5923 cache[1] = cache[3];
5930 ASSERT_UTF8_CACHE(cache);
5933 /* We already know all of the way, now we may be able to walk back. The same
5934 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5935 backward is half the speed of walking forward. */
5937 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5940 const STRLEN forw = target - s;
5941 STRLEN backw = end - target;
5943 if (forw < 2 * backw) {
5944 return utf8_length(s, target);
5947 while (end > target) {
5949 while (UTF8_IS_CONTINUATION(*end)) {
5958 =for apidoc sv_pos_b2u
5960 Converts the value pointed to by offsetp from a count of bytes from the
5961 start of the string, to a count of the equivalent number of UTF-8 chars.
5962 Handles magic and type coercion.
5968 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5969 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5974 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5977 const STRLEN byte = *offsetp;
5978 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5987 s = (const U8*)SvPV_const(sv, blen);
5990 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5994 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5995 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5997 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5998 if (cache[1] == byte) {
5999 /* An exact match. */
6000 *offsetp = cache[0];
6003 if (cache[3] == byte) {
6004 /* An exact match. */
6005 *offsetp = cache[2];
6009 if (cache[1] < byte) {
6010 /* We already know part of the way. */
6011 if (mg->mg_len != -1) {
6012 /* Actually, we know the end too. */
6014 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6015 s + blen, mg->mg_len - cache[0]);
6017 len = cache[0] + utf8_length(s + cache[1], send);
6020 else if (cache[3] < byte) {
6021 /* We're between the two cached pairs, so we do the calculation
6022 offset by the byte/utf-8 positions for the earlier pair,
6023 then add the utf-8 characters from the string start to
6025 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6026 s + cache[1], cache[0] - cache[2])
6030 else { /* cache[3] > byte */
6031 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6035 ASSERT_UTF8_CACHE(cache);
6037 } else if (mg->mg_len != -1) {
6038 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6042 if (!found || PL_utf8cache < 0) {
6043 const STRLEN real_len = utf8_length(s, send);
6045 if (found && PL_utf8cache < 0) {
6046 if (len != real_len) {
6047 /* Need to turn the assertions off otherwise we may recurse
6048 infinitely while printing error messages. */
6049 SAVEI8(PL_utf8cache);
6051 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6052 " real %"UVuf" for %"SVf,
6053 (UV) len, (UV) real_len, SVfARG(sv));
6060 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6066 Returns a boolean indicating whether the strings in the two SVs are
6067 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6068 coerce its args to strings if necessary.
6074 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6083 SV* svrecode = NULL;
6090 /* if pv1 and pv2 are the same, second SvPV_const call may
6091 * invalidate pv1, so we may need to make a copy */
6092 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6093 pv1 = SvPV_const(sv1, cur1);
6094 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6096 pv1 = SvPV_const(sv1, cur1);
6104 pv2 = SvPV_const(sv2, cur2);
6106 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6107 /* Differing utf8ness.
6108 * Do not UTF8size the comparands as a side-effect. */
6111 svrecode = newSVpvn(pv2, cur2);
6112 sv_recode_to_utf8(svrecode, PL_encoding);
6113 pv2 = SvPV_const(svrecode, cur2);
6116 svrecode = newSVpvn(pv1, cur1);
6117 sv_recode_to_utf8(svrecode, PL_encoding);
6118 pv1 = SvPV_const(svrecode, cur1);
6120 /* Now both are in UTF-8. */
6122 SvREFCNT_dec(svrecode);
6127 bool is_utf8 = TRUE;
6130 /* sv1 is the UTF-8 one,
6131 * if is equal it must be downgrade-able */
6132 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6138 /* sv2 is the UTF-8 one,
6139 * if is equal it must be downgrade-able */
6140 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6146 /* Downgrade not possible - cannot be eq */
6154 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6156 SvREFCNT_dec(svrecode);
6166 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6167 string in C<sv1> is less than, equal to, or greater than the string in
6168 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6169 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6175 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6179 const char *pv1, *pv2;
6182 SV *svrecode = NULL;
6189 pv1 = SvPV_const(sv1, cur1);
6196 pv2 = SvPV_const(sv2, cur2);
6198 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6199 /* Differing utf8ness.
6200 * Do not UTF8size the comparands as a side-effect. */
6203 svrecode = newSVpvn(pv2, cur2);
6204 sv_recode_to_utf8(svrecode, PL_encoding);
6205 pv2 = SvPV_const(svrecode, cur2);
6208 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6213 svrecode = newSVpvn(pv1, cur1);
6214 sv_recode_to_utf8(svrecode, PL_encoding);
6215 pv1 = SvPV_const(svrecode, cur1);
6218 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6224 cmp = cur2 ? -1 : 0;
6228 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6231 cmp = retval < 0 ? -1 : 1;
6232 } else if (cur1 == cur2) {
6235 cmp = cur1 < cur2 ? -1 : 1;
6239 SvREFCNT_dec(svrecode);
6247 =for apidoc sv_cmp_locale
6249 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6250 'use bytes' aware, handles get magic, and will coerce its args to strings
6251 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6257 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6260 #ifdef USE_LOCALE_COLLATE
6266 if (PL_collation_standard)
6270 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6272 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6274 if (!pv1 || !len1) {
6285 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6288 return retval < 0 ? -1 : 1;
6291 * When the result of collation is equality, that doesn't mean
6292 * that there are no differences -- some locales exclude some
6293 * characters from consideration. So to avoid false equalities,
6294 * we use the raw string as a tiebreaker.
6300 #endif /* USE_LOCALE_COLLATE */
6302 return sv_cmp(sv1, sv2);
6306 #ifdef USE_LOCALE_COLLATE
6309 =for apidoc sv_collxfrm
6311 Add Collate Transform magic to an SV if it doesn't already have it.
6313 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6314 scalar data of the variable, but transformed to such a format that a normal
6315 memory comparison can be used to compare the data according to the locale
6322 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6327 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6328 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6334 Safefree(mg->mg_ptr);
6335 s = SvPV_const(sv, len);
6336 if ((xf = mem_collxfrm(s, len, &xlen))) {
6337 if (SvREADONLY(sv)) {
6340 return xf + sizeof(PL_collation_ix);
6343 #ifdef PERL_OLD_COPY_ON_WRITE
6345 sv_force_normal_flags(sv, 0);
6347 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6361 if (mg && mg->mg_ptr) {
6363 return mg->mg_ptr + sizeof(PL_collation_ix);
6371 #endif /* USE_LOCALE_COLLATE */
6376 Get a line from the filehandle and store it into the SV, optionally
6377 appending to the currently-stored string.
6383 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6388 register STDCHAR rslast;
6389 register STDCHAR *bp;
6394 if (SvTHINKFIRST(sv))
6395 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6396 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6398 However, perlbench says it's slower, because the existing swipe code
6399 is faster than copy on write.
6400 Swings and roundabouts. */
6401 SvUPGRADE(sv, SVt_PV);
6406 if (PerlIO_isutf8(fp)) {
6408 sv_utf8_upgrade_nomg(sv);
6409 sv_pos_u2b(sv,&append,0);
6411 } else if (SvUTF8(sv)) {
6412 SV * const tsv = newSV(0);
6413 sv_gets(tsv, fp, 0);
6414 sv_utf8_upgrade_nomg(tsv);
6415 SvCUR_set(sv,append);
6418 goto return_string_or_null;
6423 if (PerlIO_isutf8(fp))
6426 if (IN_PERL_COMPILETIME) {
6427 /* we always read code in line mode */
6431 else if (RsSNARF(PL_rs)) {
6432 /* If it is a regular disk file use size from stat() as estimate
6433 of amount we are going to read -- may result in mallocing
6434 more memory than we really need if the layers below reduce
6435 the size we read (e.g. CRLF or a gzip layer).
6438 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6439 const Off_t offset = PerlIO_tell(fp);
6440 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6441 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6447 else if (RsRECORD(PL_rs)) {
6452 /* Grab the size of the record we're getting */
6453 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6454 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6457 /* VMS wants read instead of fread, because fread doesn't respect */
6458 /* RMS record boundaries. This is not necessarily a good thing to be */
6459 /* doing, but we've got no other real choice - except avoid stdio
6460 as implementation - perhaps write a :vms layer ?
6462 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6464 bytesread = PerlIO_read(fp, buffer, recsize);
6468 SvCUR_set(sv, bytesread += append);
6469 buffer[bytesread] = '\0';
6470 goto return_string_or_null;
6472 else if (RsPARA(PL_rs)) {
6478 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6479 if (PerlIO_isutf8(fp)) {
6480 rsptr = SvPVutf8(PL_rs, rslen);
6483 if (SvUTF8(PL_rs)) {
6484 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6485 Perl_croak(aTHX_ "Wide character in $/");
6488 rsptr = SvPV_const(PL_rs, rslen);
6492 rslast = rslen ? rsptr[rslen - 1] : '\0';
6494 if (rspara) { /* have to do this both before and after */
6495 do { /* to make sure file boundaries work right */
6498 i = PerlIO_getc(fp);
6502 PerlIO_ungetc(fp,i);
6508 /* See if we know enough about I/O mechanism to cheat it ! */
6510 /* This used to be #ifdef test - it is made run-time test for ease
6511 of abstracting out stdio interface. One call should be cheap
6512 enough here - and may even be a macro allowing compile
6516 if (PerlIO_fast_gets(fp)) {
6519 * We're going to steal some values from the stdio struct
6520 * and put EVERYTHING in the innermost loop into registers.
6522 register STDCHAR *ptr;
6526 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6527 /* An ungetc()d char is handled separately from the regular
6528 * buffer, so we getc() it back out and stuff it in the buffer.
6530 i = PerlIO_getc(fp);
6531 if (i == EOF) return 0;
6532 *(--((*fp)->_ptr)) = (unsigned char) i;
6536 /* Here is some breathtakingly efficient cheating */
6538 cnt = PerlIO_get_cnt(fp); /* get count into register */
6539 /* make sure we have the room */
6540 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6541 /* Not room for all of it
6542 if we are looking for a separator and room for some
6544 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6545 /* just process what we have room for */
6546 shortbuffered = cnt - SvLEN(sv) + append + 1;
6547 cnt -= shortbuffered;
6551 /* remember that cnt can be negative */
6552 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6557 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6558 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6559 DEBUG_P(PerlIO_printf(Perl_debug_log,
6560 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6561 DEBUG_P(PerlIO_printf(Perl_debug_log,
6562 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6563 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6564 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6569 while (cnt > 0) { /* this | eat */
6571 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6572 goto thats_all_folks; /* screams | sed :-) */
6576 Copy(ptr, bp, cnt, char); /* this | eat */
6577 bp += cnt; /* screams | dust */
6578 ptr += cnt; /* louder | sed :-) */
6583 if (shortbuffered) { /* oh well, must extend */
6584 cnt = shortbuffered;
6586 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6588 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6589 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6593 DEBUG_P(PerlIO_printf(Perl_debug_log,
6594 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6595 PTR2UV(ptr),(long)cnt));
6596 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6598 DEBUG_P(PerlIO_printf(Perl_debug_log,
6599 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6600 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6601 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6603 /* This used to call 'filbuf' in stdio form, but as that behaves like
6604 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6605 another abstraction. */
6606 i = PerlIO_getc(fp); /* get more characters */
6608 DEBUG_P(PerlIO_printf(Perl_debug_log,
6609 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6610 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6611 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6613 cnt = PerlIO_get_cnt(fp);
6614 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6615 DEBUG_P(PerlIO_printf(Perl_debug_log,
6616 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6618 if (i == EOF) /* all done for ever? */
6619 goto thats_really_all_folks;
6621 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6623 SvGROW(sv, bpx + cnt + 2);
6624 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6626 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6628 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6629 goto thats_all_folks;
6633 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6634 memNE((char*)bp - rslen, rsptr, rslen))
6635 goto screamer; /* go back to the fray */
6636 thats_really_all_folks:
6638 cnt += shortbuffered;
6639 DEBUG_P(PerlIO_printf(Perl_debug_log,
6640 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6641 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6642 DEBUG_P(PerlIO_printf(Perl_debug_log,
6643 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6644 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6645 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6647 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6648 DEBUG_P(PerlIO_printf(Perl_debug_log,
6649 "Screamer: done, len=%ld, string=|%.*s|\n",
6650 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6654 /*The big, slow, and stupid way. */
6655 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6656 STDCHAR *buf = NULL;
6657 Newx(buf, 8192, STDCHAR);
6665 register const STDCHAR * const bpe = buf + sizeof(buf);
6667 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6668 ; /* keep reading */
6672 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6673 /* Accomodate broken VAXC compiler, which applies U8 cast to
6674 * both args of ?: operator, causing EOF to change into 255
6677 i = (U8)buf[cnt - 1];
6683 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6685 sv_catpvn(sv, (char *) buf, cnt);
6687 sv_setpvn(sv, (char *) buf, cnt);
6689 if (i != EOF && /* joy */
6691 SvCUR(sv) < rslen ||
6692 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6696 * If we're reading from a TTY and we get a short read,
6697 * indicating that the user hit his EOF character, we need
6698 * to notice it now, because if we try to read from the TTY
6699 * again, the EOF condition will disappear.
6701 * The comparison of cnt to sizeof(buf) is an optimization
6702 * that prevents unnecessary calls to feof().
6706 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6710 #ifdef USE_HEAP_INSTEAD_OF_STACK
6715 if (rspara) { /* have to do this both before and after */
6716 while (i != EOF) { /* to make sure file boundaries work right */
6717 i = PerlIO_getc(fp);
6719 PerlIO_ungetc(fp,i);
6725 return_string_or_null:
6726 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6732 Auto-increment of the value in the SV, doing string to numeric conversion
6733 if necessary. Handles 'get' magic.
6739 Perl_sv_inc(pTHX_ register SV *sv)
6748 if (SvTHINKFIRST(sv)) {
6750 sv_force_normal_flags(sv, 0);
6751 if (SvREADONLY(sv)) {
6752 if (IN_PERL_RUNTIME)
6753 Perl_croak(aTHX_ PL_no_modify);
6757 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6759 i = PTR2IV(SvRV(sv));
6764 flags = SvFLAGS(sv);
6765 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6766 /* It's (privately or publicly) a float, but not tested as an
6767 integer, so test it to see. */
6769 flags = SvFLAGS(sv);
6771 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6772 /* It's publicly an integer, or privately an integer-not-float */
6773 #ifdef PERL_PRESERVE_IVUV
6777 if (SvUVX(sv) == UV_MAX)
6778 sv_setnv(sv, UV_MAX_P1);
6780 (void)SvIOK_only_UV(sv);
6781 SvUV_set(sv, SvUVX(sv) + 1);
6783 if (SvIVX(sv) == IV_MAX)
6784 sv_setuv(sv, (UV)IV_MAX + 1);
6786 (void)SvIOK_only(sv);
6787 SvIV_set(sv, SvIVX(sv) + 1);
6792 if (flags & SVp_NOK) {
6793 (void)SvNOK_only(sv);
6794 SvNV_set(sv, SvNVX(sv) + 1.0);
6798 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6799 if ((flags & SVTYPEMASK) < SVt_PVIV)
6800 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6801 (void)SvIOK_only(sv);
6806 while (isALPHA(*d)) d++;
6807 while (isDIGIT(*d)) d++;
6809 #ifdef PERL_PRESERVE_IVUV
6810 /* Got to punt this as an integer if needs be, but we don't issue
6811 warnings. Probably ought to make the sv_iv_please() that does
6812 the conversion if possible, and silently. */
6813 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6814 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6815 /* Need to try really hard to see if it's an integer.
6816 9.22337203685478e+18 is an integer.
6817 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6818 so $a="9.22337203685478e+18"; $a+0; $a++
6819 needs to be the same as $a="9.22337203685478e+18"; $a++
6826 /* sv_2iv *should* have made this an NV */
6827 if (flags & SVp_NOK) {
6828 (void)SvNOK_only(sv);
6829 SvNV_set(sv, SvNVX(sv) + 1.0);
6832 /* I don't think we can get here. Maybe I should assert this
6833 And if we do get here I suspect that sv_setnv will croak. NWC
6835 #if defined(USE_LONG_DOUBLE)
6836 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6837 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6839 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6840 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6843 #endif /* PERL_PRESERVE_IVUV */
6844 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6848 while (d >= SvPVX_const(sv)) {
6856 /* MKS: The original code here died if letters weren't consecutive.
6857 * at least it didn't have to worry about non-C locales. The
6858 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6859 * arranged in order (although not consecutively) and that only
6860 * [A-Za-z] are accepted by isALPHA in the C locale.
6862 if (*d != 'z' && *d != 'Z') {
6863 do { ++*d; } while (!isALPHA(*d));
6866 *(d--) -= 'z' - 'a';
6871 *(d--) -= 'z' - 'a' + 1;
6875 /* oh,oh, the number grew */
6876 SvGROW(sv, SvCUR(sv) + 2);
6877 SvCUR_set(sv, SvCUR(sv) + 1);
6878 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6889 Auto-decrement of the value in the SV, doing string to numeric conversion
6890 if necessary. Handles 'get' magic.
6896 Perl_sv_dec(pTHX_ register SV *sv)
6904 if (SvTHINKFIRST(sv)) {
6906 sv_force_normal_flags(sv, 0);
6907 if (SvREADONLY(sv)) {
6908 if (IN_PERL_RUNTIME)
6909 Perl_croak(aTHX_ PL_no_modify);
6913 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6915 i = PTR2IV(SvRV(sv));
6920 /* Unlike sv_inc we don't have to worry about string-never-numbers
6921 and keeping them magic. But we mustn't warn on punting */
6922 flags = SvFLAGS(sv);
6923 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6924 /* It's publicly an integer, or privately an integer-not-float */
6925 #ifdef PERL_PRESERVE_IVUV
6929 if (SvUVX(sv) == 0) {
6930 (void)SvIOK_only(sv);
6934 (void)SvIOK_only_UV(sv);
6935 SvUV_set(sv, SvUVX(sv) - 1);
6938 if (SvIVX(sv) == IV_MIN)
6939 sv_setnv(sv, (NV)IV_MIN - 1.0);
6941 (void)SvIOK_only(sv);
6942 SvIV_set(sv, SvIVX(sv) - 1);
6947 if (flags & SVp_NOK) {
6948 SvNV_set(sv, SvNVX(sv) - 1.0);
6949 (void)SvNOK_only(sv);
6952 if (!(flags & SVp_POK)) {
6953 if ((flags & SVTYPEMASK) < SVt_PVIV)
6954 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6956 (void)SvIOK_only(sv);
6959 #ifdef PERL_PRESERVE_IVUV
6961 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6962 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6963 /* Need to try really hard to see if it's an integer.
6964 9.22337203685478e+18 is an integer.
6965 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6966 so $a="9.22337203685478e+18"; $a+0; $a--
6967 needs to be the same as $a="9.22337203685478e+18"; $a--
6974 /* sv_2iv *should* have made this an NV */
6975 if (flags & SVp_NOK) {
6976 (void)SvNOK_only(sv);
6977 SvNV_set(sv, SvNVX(sv) - 1.0);
6980 /* I don't think we can get here. Maybe I should assert this
6981 And if we do get here I suspect that sv_setnv will croak. NWC
6983 #if defined(USE_LONG_DOUBLE)
6984 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
6985 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6987 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6988 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6992 #endif /* PERL_PRESERVE_IVUV */
6993 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6997 =for apidoc sv_mortalcopy
6999 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7000 The new SV is marked as mortal. It will be destroyed "soon", either by an
7001 explicit call to FREETMPS, or by an implicit call at places such as
7002 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7007 /* Make a string that will exist for the duration of the expression
7008 * evaluation. Actually, it may have to last longer than that, but
7009 * hopefully we won't free it until it has been assigned to a
7010 * permanent location. */
7013 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7019 sv_setsv(sv,oldstr);
7021 PL_tmps_stack[++PL_tmps_ix] = sv;
7027 =for apidoc sv_newmortal
7029 Creates a new null SV which is mortal. The reference count of the SV is
7030 set to 1. It will be destroyed "soon", either by an explicit call to
7031 FREETMPS, or by an implicit call at places such as statement boundaries.
7032 See also C<sv_mortalcopy> and C<sv_2mortal>.
7038 Perl_sv_newmortal(pTHX)
7044 SvFLAGS(sv) = SVs_TEMP;
7046 PL_tmps_stack[++PL_tmps_ix] = sv;
7052 =for apidoc newSVpvn_flags
7054 Creates a new SV and copies a string into it. The reference count for the
7055 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7056 string. You are responsible for ensuring that the source string is at least
7057 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7058 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7059 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7060 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7061 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7063 #define newSVpvn_utf8(s, len, u) \
7064 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7070 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7075 /* All the flags we don't support must be zero.
7076 And we're new code so I'm going to assert this from the start. */
7077 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7079 sv_setpvn(sv,s,len);
7080 SvFLAGS(sv) |= (flags & SVf_UTF8);
7081 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7085 =for apidoc sv_2mortal
7087 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7088 by an explicit call to FREETMPS, or by an implicit call at places such as
7089 statement boundaries. SvTEMP() is turned on which means that the SV's
7090 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7091 and C<sv_mortalcopy>.
7097 Perl_sv_2mortal(pTHX_ register SV *sv)
7102 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7105 PL_tmps_stack[++PL_tmps_ix] = sv;
7113 Creates a new SV and copies a string into it. The reference count for the
7114 SV is set to 1. If C<len> is zero, Perl will compute the length using
7115 strlen(). For efficiency, consider using C<newSVpvn> instead.
7121 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7127 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7132 =for apidoc newSVpvn
7134 Creates a new SV and copies a string into it. The reference count for the
7135 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7136 string. You are responsible for ensuring that the source string is at least
7137 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7143 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7149 sv_setpvn(sv,s,len);
7154 =for apidoc newSVhek
7156 Creates a new SV from the hash key structure. It will generate scalars that
7157 point to the shared string table where possible. Returns a new (undefined)
7158 SV if the hek is NULL.
7164 Perl_newSVhek(pTHX_ const HEK *hek)
7174 if (HEK_LEN(hek) == HEf_SVKEY) {
7175 return newSVsv(*(SV**)HEK_KEY(hek));
7177 const int flags = HEK_FLAGS(hek);
7178 if (flags & HVhek_WASUTF8) {
7180 Andreas would like keys he put in as utf8 to come back as utf8
7182 STRLEN utf8_len = HEK_LEN(hek);
7183 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7184 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7187 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7189 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7190 /* We don't have a pointer to the hv, so we have to replicate the
7191 flag into every HEK. This hv is using custom a hasing
7192 algorithm. Hence we can't return a shared string scalar, as
7193 that would contain the (wrong) hash value, and might get passed
7194 into an hv routine with a regular hash.
7195 Similarly, a hash that isn't using shared hash keys has to have
7196 the flag in every key so that we know not to try to call
7197 share_hek_kek on it. */
7199 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7204 /* This will be overwhelminly the most common case. */
7206 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7207 more efficient than sharepvn(). */
7211 sv_upgrade(sv, SVt_PV);
7212 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7213 SvCUR_set(sv, HEK_LEN(hek));
7226 =for apidoc newSVpvn_share
7228 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7229 table. If the string does not already exist in the table, it is created
7230 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7231 value is used; otherwise the hash is computed. The string's hash can be later
7232 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7233 that as the string table is used for shared hash keys these strings will have
7234 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7240 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7244 bool is_utf8 = FALSE;
7245 const char *const orig_src = src;
7248 STRLEN tmplen = -len;
7250 /* See the note in hv.c:hv_fetch() --jhi */
7251 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7255 PERL_HASH(hash, src, len);
7257 sv_upgrade(sv, SVt_PV);
7258 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7266 if (src != orig_src)
7272 #if defined(PERL_IMPLICIT_CONTEXT)
7274 /* pTHX_ magic can't cope with varargs, so this is a no-context
7275 * version of the main function, (which may itself be aliased to us).
7276 * Don't access this version directly.
7280 Perl_newSVpvf_nocontext(const char* pat, ...)
7285 va_start(args, pat);
7286 sv = vnewSVpvf(pat, &args);
7293 =for apidoc newSVpvf
7295 Creates a new SV and initializes it with the string formatted like
7302 Perl_newSVpvf(pTHX_ const char* pat, ...)
7306 va_start(args, pat);
7307 sv = vnewSVpvf(pat, &args);
7312 /* backend for newSVpvf() and newSVpvf_nocontext() */
7315 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7320 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7327 Creates a new SV and copies a floating point value into it.
7328 The reference count for the SV is set to 1.
7334 Perl_newSVnv(pTHX_ NV n)
7347 Creates a new SV and copies an integer into it. The reference count for the
7354 Perl_newSViv(pTHX_ IV i)
7367 Creates a new SV and copies an unsigned integer into it.
7368 The reference count for the SV is set to 1.
7374 Perl_newSVuv(pTHX_ UV u)
7385 =for apidoc newSV_type
7387 Creates a new SV, of the type specified. The reference count for the new SV
7394 Perl_newSV_type(pTHX_ svtype type)
7399 sv_upgrade(sv, type);
7404 =for apidoc newRV_noinc
7406 Creates an RV wrapper for an SV. The reference count for the original
7407 SV is B<not> incremented.
7413 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7416 register SV *sv = newSV_type(SVt_IV);
7418 SvRV_set(sv, tmpRef);
7423 /* newRV_inc is the official function name to use now.
7424 * newRV_inc is in fact #defined to newRV in sv.h
7428 Perl_newRV(pTHX_ SV *sv)
7431 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7437 Creates a new SV which is an exact duplicate of the original SV.
7444 Perl_newSVsv(pTHX_ register SV *old)
7451 if (SvTYPE(old) == SVTYPEMASK) {
7452 if (ckWARN_d(WARN_INTERNAL))
7453 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7457 /* SV_GMAGIC is the default for sv_setv()
7458 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7459 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7460 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7465 =for apidoc sv_reset
7467 Underlying implementation for the C<reset> Perl function.
7468 Note that the perl-level function is vaguely deprecated.
7474 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7477 char todo[PERL_UCHAR_MAX+1];
7482 if (!*s) { /* reset ?? searches */
7483 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7485 const U32 count = mg->mg_len / sizeof(PMOP**);
7486 PMOP **pmp = (PMOP**) mg->mg_ptr;
7487 PMOP *const *const end = pmp + count;
7491 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7493 (*pmp)->op_pmflags &= ~PMf_USED;
7501 /* reset variables */
7503 if (!HvARRAY(stash))
7506 Zero(todo, 256, char);
7509 I32 i = (unsigned char)*s;
7513 max = (unsigned char)*s++;
7514 for ( ; i <= max; i++) {
7517 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7519 for (entry = HvARRAY(stash)[i];
7521 entry = HeNEXT(entry))
7526 if (!todo[(U8)*HeKEY(entry)])
7528 gv = (GV*)HeVAL(entry);
7531 if (SvTHINKFIRST(sv)) {
7532 if (!SvREADONLY(sv) && SvROK(sv))
7534 /* XXX Is this continue a bug? Why should THINKFIRST
7535 exempt us from resetting arrays and hashes? */
7539 if (SvTYPE(sv) >= SVt_PV) {
7541 if (SvPVX_const(sv) != NULL)
7549 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7551 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7554 # if defined(USE_ENVIRON_ARRAY)
7557 # endif /* USE_ENVIRON_ARRAY */
7568 Using various gambits, try to get an IO from an SV: the IO slot if its a
7569 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7570 named after the PV if we're a string.
7576 Perl_sv_2io(pTHX_ SV *sv)
7581 switch (SvTYPE(sv)) {
7589 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7593 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7595 return sv_2io(SvRV(sv));
7596 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7602 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7611 Using various gambits, try to get a CV from an SV; in addition, try if
7612 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7613 The flags in C<lref> are passed to sv_fetchsv.
7619 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7630 switch (SvTYPE(sv)) {
7649 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7650 tryAMAGICunDEREF(to_cv);
7653 if (SvTYPE(sv) == SVt_PVCV) {
7662 Perl_croak(aTHX_ "Not a subroutine reference");
7667 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7673 /* Some flags to gv_fetchsv mean don't really create the GV */
7674 if (SvTYPE(gv) != SVt_PVGV) {
7680 if (lref && !GvCVu(gv)) {
7684 gv_efullname3(tmpsv, gv, NULL);
7685 /* XXX this is probably not what they think they're getting.
7686 * It has the same effect as "sub name;", i.e. just a forward
7688 newSUB(start_subparse(FALSE, 0),
7689 newSVOP(OP_CONST, 0, tmpsv),
7693 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7703 Returns true if the SV has a true value by Perl's rules.
7704 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7705 instead use an in-line version.
7711 Perl_sv_true(pTHX_ register SV *sv)
7716 register const XPV* const tXpv = (XPV*)SvANY(sv);
7718 (tXpv->xpv_cur > 1 ||
7719 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7726 return SvIVX(sv) != 0;
7729 return SvNVX(sv) != 0.0;
7731 return sv_2bool(sv);
7737 =for apidoc sv_pvn_force
7739 Get a sensible string out of the SV somehow.
7740 A private implementation of the C<SvPV_force> macro for compilers which
7741 can't cope with complex macro expressions. Always use the macro instead.
7743 =for apidoc sv_pvn_force_flags
7745 Get a sensible string out of the SV somehow.
7746 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7747 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7748 implemented in terms of this function.
7749 You normally want to use the various wrapper macros instead: see
7750 C<SvPV_force> and C<SvPV_force_nomg>
7756 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7759 if (SvTHINKFIRST(sv) && !SvROK(sv))
7760 sv_force_normal_flags(sv, 0);
7770 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7771 const char * const ref = sv_reftype(sv,0);
7773 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7774 ref, OP_NAME(PL_op));
7776 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7778 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7779 || isGV_with_GP(sv))
7780 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7782 s = sv_2pv_flags(sv, &len, flags);
7786 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7789 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7790 SvGROW(sv, len + 1);
7791 Move(s,SvPVX(sv),len,char);
7793 SvPVX(sv)[len] = '\0';
7796 SvPOK_on(sv); /* validate pointer */
7798 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7799 PTR2UV(sv),SvPVX_const(sv)));
7802 return SvPVX_mutable(sv);
7806 =for apidoc sv_pvbyten_force
7808 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7814 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7816 sv_pvn_force(sv,lp);
7817 sv_utf8_downgrade(sv,0);
7823 =for apidoc sv_pvutf8n_force
7825 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7831 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7833 sv_pvn_force(sv,lp);
7834 sv_utf8_upgrade(sv);
7840 =for apidoc sv_reftype
7842 Returns a string describing what the SV is a reference to.
7848 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7850 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7851 inside return suggests a const propagation bug in g++. */
7852 if (ob && SvOBJECT(sv)) {
7853 char * const name = HvNAME_get(SvSTASH(sv));
7854 return name ? name : (char *) "__ANON__";
7857 switch (SvTYPE(sv)) {
7872 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7873 /* tied lvalues should appear to be
7874 * scalars for backwards compatitbility */
7875 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7876 ? "SCALAR" : "LVALUE");
7877 case SVt_PVAV: return "ARRAY";
7878 case SVt_PVHV: return "HASH";
7879 case SVt_PVCV: return "CODE";
7880 case SVt_PVGV: return "GLOB";
7881 case SVt_PVFM: return "FORMAT";
7882 case SVt_PVIO: return "IO";
7883 case SVt_BIND: return "BIND";
7884 case SVt_REGEXP: return "REGEXP";
7885 default: return "UNKNOWN";
7891 =for apidoc sv_isobject
7893 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7894 object. If the SV is not an RV, or if the object is not blessed, then this
7901 Perl_sv_isobject(pTHX_ SV *sv)
7917 Returns a boolean indicating whether the SV is blessed into the specified
7918 class. This does not check for subtypes; use C<sv_derived_from> to verify
7919 an inheritance relationship.
7925 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7936 hvname = HvNAME_get(SvSTASH(sv));
7940 return strEQ(hvname, name);
7946 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7947 it will be upgraded to one. If C<classname> is non-null then the new SV will
7948 be blessed in the specified package. The new SV is returned and its
7949 reference count is 1.
7955 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7962 SV_CHECK_THINKFIRST_COW_DROP(rv);
7963 (void)SvAMAGIC_off(rv);
7965 if (SvTYPE(rv) >= SVt_PVMG) {
7966 const U32 refcnt = SvREFCNT(rv);
7970 SvREFCNT(rv) = refcnt;
7972 sv_upgrade(rv, SVt_IV);
7973 } else if (SvROK(rv)) {
7974 SvREFCNT_dec(SvRV(rv));
7976 prepare_SV_for_RV(rv);
7984 HV* const stash = gv_stashpv(classname, GV_ADD);
7985 (void)sv_bless(rv, stash);
7991 =for apidoc sv_setref_pv
7993 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7994 argument will be upgraded to an RV. That RV will be modified to point to
7995 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7996 into the SV. The C<classname> argument indicates the package for the
7997 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7998 will have a reference count of 1, and the RV will be returned.
8000 Do not use with other Perl types such as HV, AV, SV, CV, because those
8001 objects will become corrupted by the pointer copy process.
8003 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8009 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8013 sv_setsv(rv, &PL_sv_undef);
8017 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8022 =for apidoc sv_setref_iv
8024 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8025 argument will be upgraded to an RV. That RV will be modified to point to
8026 the new SV. The C<classname> argument indicates the package for the
8027 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8028 will have a reference count of 1, and the RV will be returned.
8034 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8036 sv_setiv(newSVrv(rv,classname), iv);
8041 =for apidoc sv_setref_uv
8043 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8044 argument will be upgraded to an RV. That RV will be modified to point to
8045 the new SV. The C<classname> argument indicates the package for the
8046 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8047 will have a reference count of 1, and the RV will be returned.
8053 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8055 sv_setuv(newSVrv(rv,classname), uv);
8060 =for apidoc sv_setref_nv
8062 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8063 argument will be upgraded to an RV. That RV will be modified to point to
8064 the new SV. The C<classname> argument indicates the package for the
8065 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8066 will have a reference count of 1, and the RV will be returned.
8072 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8074 sv_setnv(newSVrv(rv,classname), nv);
8079 =for apidoc sv_setref_pvn
8081 Copies a string into a new SV, optionally blessing the SV. The length of the
8082 string must be specified with C<n>. The C<rv> argument will be upgraded to
8083 an RV. That RV will be modified to point to the new SV. The C<classname>
8084 argument indicates the package for the blessing. Set C<classname> to
8085 C<NULL> to avoid the blessing. The new SV will have a reference count
8086 of 1, and the RV will be returned.
8088 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8094 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8096 sv_setpvn(newSVrv(rv,classname), pv, n);
8101 =for apidoc sv_bless
8103 Blesses an SV into a specified package. The SV must be an RV. The package
8104 must be designated by its stash (see C<gv_stashpv()>). The reference count
8105 of the SV is unaffected.
8111 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8116 Perl_croak(aTHX_ "Can't bless non-reference value");
8118 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8119 if (SvIsCOW(tmpRef))
8120 sv_force_normal_flags(tmpRef, 0);
8121 if (SvREADONLY(tmpRef))
8122 Perl_croak(aTHX_ PL_no_modify);
8123 if (SvOBJECT(tmpRef)) {
8124 if (SvTYPE(tmpRef) != SVt_PVIO)
8126 SvREFCNT_dec(SvSTASH(tmpRef));
8129 SvOBJECT_on(tmpRef);
8130 if (SvTYPE(tmpRef) != SVt_PVIO)
8132 SvUPGRADE(tmpRef, SVt_PVMG);
8133 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8138 (void)SvAMAGIC_off(sv);
8140 if(SvSMAGICAL(tmpRef))
8141 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8149 /* Downgrades a PVGV to a PVMG.
8153 S_sv_unglob(pTHX_ SV *sv)
8158 SV * const temp = sv_newmortal();
8160 assert(SvTYPE(sv) == SVt_PVGV);
8162 gv_efullname3(temp, (GV *) sv, "*");
8165 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8166 mro_method_changed_in(stash);
8170 sv_del_backref((SV*)GvSTASH(sv), sv);
8174 if (GvNAME_HEK(sv)) {
8175 unshare_hek(GvNAME_HEK(sv));
8177 isGV_with_GP_off(sv);
8179 /* need to keep SvANY(sv) in the right arena */
8180 xpvmg = new_XPVMG();
8181 StructCopy(SvANY(sv), xpvmg, XPVMG);
8182 del_XPVGV(SvANY(sv));
8185 SvFLAGS(sv) &= ~SVTYPEMASK;
8186 SvFLAGS(sv) |= SVt_PVMG;
8188 /* Intentionally not calling any local SET magic, as this isn't so much a
8189 set operation as merely an internal storage change. */
8190 sv_setsv_flags(sv, temp, 0);
8194 =for apidoc sv_unref_flags
8196 Unsets the RV status of the SV, and decrements the reference count of
8197 whatever was being referenced by the RV. This can almost be thought of
8198 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8199 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8200 (otherwise the decrementing is conditional on the reference count being
8201 different from one or the reference being a readonly SV).
8208 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8210 SV* const target = SvRV(ref);
8212 if (SvWEAKREF(ref)) {
8213 sv_del_backref(target, ref);
8215 SvRV_set(ref, NULL);
8218 SvRV_set(ref, NULL);
8220 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8221 assigned to as BEGIN {$a = \"Foo"} will fail. */
8222 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8223 SvREFCNT_dec(target);
8224 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8225 sv_2mortal(target); /* Schedule for freeing later */
8229 =for apidoc sv_untaint
8231 Untaint an SV. Use C<SvTAINTED_off> instead.
8236 Perl_sv_untaint(pTHX_ SV *sv)
8238 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8239 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8246 =for apidoc sv_tainted
8248 Test an SV for taintedness. Use C<SvTAINTED> instead.
8253 Perl_sv_tainted(pTHX_ SV *sv)
8255 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8256 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8257 if (mg && (mg->mg_len & 1) )
8264 =for apidoc sv_setpviv
8266 Copies an integer into the given SV, also updating its string value.
8267 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8273 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8275 char buf[TYPE_CHARS(UV)];
8277 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8279 sv_setpvn(sv, ptr, ebuf - ptr);
8283 =for apidoc sv_setpviv_mg
8285 Like C<sv_setpviv>, but also handles 'set' magic.
8291 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8297 #if defined(PERL_IMPLICIT_CONTEXT)
8299 /* pTHX_ magic can't cope with varargs, so this is a no-context
8300 * version of the main function, (which may itself be aliased to us).
8301 * Don't access this version directly.
8305 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8309 va_start(args, pat);
8310 sv_vsetpvf(sv, pat, &args);
8314 /* pTHX_ magic can't cope with varargs, so this is a no-context
8315 * version of the main function, (which may itself be aliased to us).
8316 * Don't access this version directly.
8320 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8324 va_start(args, pat);
8325 sv_vsetpvf_mg(sv, pat, &args);
8331 =for apidoc sv_setpvf
8333 Works like C<sv_catpvf> but copies the text into the SV instead of
8334 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8340 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8343 va_start(args, pat);
8344 sv_vsetpvf(sv, pat, &args);
8349 =for apidoc sv_vsetpvf
8351 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8352 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8354 Usually used via its frontend C<sv_setpvf>.
8360 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8362 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8366 =for apidoc sv_setpvf_mg
8368 Like C<sv_setpvf>, but also handles 'set' magic.
8374 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8377 va_start(args, pat);
8378 sv_vsetpvf_mg(sv, pat, &args);
8383 =for apidoc sv_vsetpvf_mg
8385 Like C<sv_vsetpvf>, but also handles 'set' magic.
8387 Usually used via its frontend C<sv_setpvf_mg>.
8393 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8395 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8399 #if defined(PERL_IMPLICIT_CONTEXT)
8401 /* pTHX_ magic can't cope with varargs, so this is a no-context
8402 * version of the main function, (which may itself be aliased to us).
8403 * Don't access this version directly.
8407 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8411 va_start(args, pat);
8412 sv_vcatpvf(sv, pat, &args);
8416 /* pTHX_ magic can't cope with varargs, so this is a no-context
8417 * version of the main function, (which may itself be aliased to us).
8418 * Don't access this version directly.
8422 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8426 va_start(args, pat);
8427 sv_vcatpvf_mg(sv, pat, &args);
8433 =for apidoc sv_catpvf
8435 Processes its arguments like C<sprintf> and appends the formatted
8436 output to an SV. If the appended data contains "wide" characters
8437 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8438 and characters >255 formatted with %c), the original SV might get
8439 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8440 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8441 valid UTF-8; if the original SV was bytes, the pattern should be too.
8446 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8449 va_start(args, pat);
8450 sv_vcatpvf(sv, pat, &args);
8455 =for apidoc sv_vcatpvf
8457 Processes its arguments like C<vsprintf> and appends the formatted output
8458 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8460 Usually used via its frontend C<sv_catpvf>.
8466 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8468 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8472 =for apidoc sv_catpvf_mg
8474 Like C<sv_catpvf>, but also handles 'set' magic.
8480 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8483 va_start(args, pat);
8484 sv_vcatpvf_mg(sv, pat, &args);
8489 =for apidoc sv_vcatpvf_mg
8491 Like C<sv_vcatpvf>, but also handles 'set' magic.
8493 Usually used via its frontend C<sv_catpvf_mg>.
8499 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8501 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8506 =for apidoc sv_vsetpvfn
8508 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8511 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8517 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8519 sv_setpvn(sv, "", 0);
8520 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8524 S_expect_number(pTHX_ char** pattern)
8528 switch (**pattern) {
8529 case '1': case '2': case '3':
8530 case '4': case '5': case '6':
8531 case '7': case '8': case '9':
8532 var = *(*pattern)++ - '0';
8533 while (isDIGIT(**pattern)) {
8534 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8536 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8544 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8546 const int neg = nv < 0;
8555 if (uv & 1 && uv == nv)
8556 uv--; /* Round to even */
8558 const unsigned dig = uv % 10;
8571 =for apidoc sv_vcatpvfn
8573 Processes its arguments like C<vsprintf> and appends the formatted output
8574 to an SV. Uses an array of SVs if the C style variable argument list is
8575 missing (NULL). When running with taint checks enabled, indicates via
8576 C<maybe_tainted> if results are untrustworthy (often due to the use of
8579 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8585 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8586 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8587 vec_utf8 = DO_UTF8(vecsv);
8589 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8592 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8600 static const char nullstr[] = "(null)";
8602 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8603 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8605 /* Times 4: a decimal digit takes more than 3 binary digits.
8606 * NV_DIG: mantissa takes than many decimal digits.
8607 * Plus 32: Playing safe. */
8608 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8609 /* large enough for "%#.#f" --chip */
8610 /* what about long double NVs? --jhi */
8612 PERL_UNUSED_ARG(maybe_tainted);
8614 /* no matter what, this is a string now */
8615 (void)SvPV_force(sv, origlen);
8617 /* special-case "", "%s", and "%-p" (SVf - see below) */
8620 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8622 const char * const s = va_arg(*args, char*);
8623 sv_catpv(sv, s ? s : nullstr);
8625 else if (svix < svmax) {
8626 sv_catsv(sv, *svargs);
8630 if (args && patlen == 3 && pat[0] == '%' &&
8631 pat[1] == '-' && pat[2] == 'p') {
8632 argsv = (SV*)va_arg(*args, void*);
8633 sv_catsv(sv, argsv);
8637 #ifndef USE_LONG_DOUBLE
8638 /* special-case "%.<number>[gf]" */
8639 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8640 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8641 unsigned digits = 0;
8645 while (*pp >= '0' && *pp <= '9')
8646 digits = 10 * digits + (*pp++ - '0');
8647 if (pp - pat == (int)patlen - 1) {
8655 /* Add check for digits != 0 because it seems that some
8656 gconverts are buggy in this case, and we don't yet have
8657 a Configure test for this. */
8658 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8659 /* 0, point, slack */
8660 Gconvert(nv, (int)digits, 0, ebuf);
8662 if (*ebuf) /* May return an empty string for digits==0 */
8665 } else if (!digits) {
8668 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8669 sv_catpvn(sv, p, l);
8675 #endif /* !USE_LONG_DOUBLE */
8677 if (!args && svix < svmax && DO_UTF8(*svargs))
8680 patend = (char*)pat + patlen;
8681 for (p = (char*)pat; p < patend; p = q) {
8684 bool vectorize = FALSE;
8685 bool vectorarg = FALSE;
8686 bool vec_utf8 = FALSE;
8692 bool has_precis = FALSE;
8694 const I32 osvix = svix;
8695 bool is_utf8 = FALSE; /* is this item utf8? */
8696 #ifdef HAS_LDBL_SPRINTF_BUG
8697 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8698 with sfio - Allen <allens@cpan.org> */
8699 bool fix_ldbl_sprintf_bug = FALSE;
8703 U8 utf8buf[UTF8_MAXBYTES+1];
8704 STRLEN esignlen = 0;
8706 const char *eptr = NULL;
8709 const U8 *vecstr = NULL;
8716 /* we need a long double target in case HAS_LONG_DOUBLE but
8719 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8727 const char *dotstr = ".";
8728 STRLEN dotstrlen = 1;
8729 I32 efix = 0; /* explicit format parameter index */
8730 I32 ewix = 0; /* explicit width index */
8731 I32 epix = 0; /* explicit precision index */
8732 I32 evix = 0; /* explicit vector index */
8733 bool asterisk = FALSE;
8735 /* echo everything up to the next format specification */
8736 for (q = p; q < patend && *q != '%'; ++q) ;
8738 if (has_utf8 && !pat_utf8)
8739 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8741 sv_catpvn(sv, p, q - p);
8748 We allow format specification elements in this order:
8749 \d+\$ explicit format parameter index
8751 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8752 0 flag (as above): repeated to allow "v02"
8753 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8754 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8756 [%bcdefginopsuxDFOUX] format (mandatory)
8761 As of perl5.9.3, printf format checking is on by default.
8762 Internally, perl uses %p formats to provide an escape to
8763 some extended formatting. This block deals with those
8764 extensions: if it does not match, (char*)q is reset and
8765 the normal format processing code is used.
8767 Currently defined extensions are:
8768 %p include pointer address (standard)
8769 %-p (SVf) include an SV (previously %_)
8770 %-<num>p include an SV with precision <num>
8771 %<num>p reserved for future extensions
8773 Robin Barker 2005-07-14
8775 %1p (VDf) removed. RMB 2007-10-19
8782 n = expect_number(&q);
8789 argsv = (SV*)va_arg(*args, void*);
8790 eptr = SvPV_const(argsv, elen);
8796 if (ckWARN_d(WARN_INTERNAL))
8797 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8798 "internal %%<num>p might conflict with future printf extensions");
8804 if ( (width = expect_number(&q)) ) {
8819 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8848 if ( (ewix = expect_number(&q)) )
8857 if ((vectorarg = asterisk)) {
8870 width = expect_number(&q);
8876 vecsv = va_arg(*args, SV*);
8878 vecsv = (evix > 0 && evix <= svmax)
8879 ? svargs[evix-1] : &PL_sv_undef;
8881 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8883 dotstr = SvPV_const(vecsv, dotstrlen);
8884 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8885 bad with tied or overloaded values that return UTF8. */
8888 else if (has_utf8) {
8889 vecsv = sv_mortalcopy(vecsv);
8890 sv_utf8_upgrade(vecsv);
8891 dotstr = SvPV_const(vecsv, dotstrlen);
8898 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8899 vecsv = svargs[efix ? efix-1 : svix++];
8900 vecstr = (U8*)SvPV_const(vecsv,veclen);
8901 vec_utf8 = DO_UTF8(vecsv);
8903 /* if this is a version object, we need to convert
8904 * back into v-string notation and then let the
8905 * vectorize happen normally
8907 if (sv_derived_from(vecsv, "version")) {
8908 char *version = savesvpv(vecsv);
8909 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8910 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8911 "vector argument not supported with alpha versions");
8914 vecsv = sv_newmortal();
8915 scan_vstring(version, version + veclen, vecsv);
8916 vecstr = (U8*)SvPV_const(vecsv, veclen);
8917 vec_utf8 = DO_UTF8(vecsv);
8929 i = va_arg(*args, int);
8931 i = (ewix ? ewix <= svmax : svix < svmax) ?
8932 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8934 width = (i < 0) ? -i : i;
8944 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8946 /* XXX: todo, support specified precision parameter */
8950 i = va_arg(*args, int);
8952 i = (ewix ? ewix <= svmax : svix < svmax)
8953 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8955 has_precis = !(i < 0);
8960 precis = precis * 10 + (*q++ - '0');
8969 case 'I': /* Ix, I32x, and I64x */
8971 if (q[1] == '6' && q[2] == '4') {
8977 if (q[1] == '3' && q[2] == '2') {
8987 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8998 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8999 if (*(q + 1) == 'l') { /* lld, llf */
9025 if (!vectorize && !args) {
9027 const I32 i = efix-1;
9028 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9030 argsv = (svix >= 0 && svix < svmax)
9031 ? svargs[svix++] : &PL_sv_undef;
9042 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9044 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9046 eptr = (char*)utf8buf;
9047 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9061 eptr = va_arg(*args, char*);
9063 #ifdef MACOS_TRADITIONAL
9064 /* On MacOS, %#s format is used for Pascal strings */
9069 elen = strlen(eptr);
9071 eptr = (char *)nullstr;
9072 elen = sizeof nullstr - 1;
9076 eptr = SvPV_const(argsv, elen);
9077 if (DO_UTF8(argsv)) {
9078 I32 old_precis = precis;
9079 if (has_precis && precis < elen) {
9081 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9084 if (width) { /* fudge width (can't fudge elen) */
9085 if (has_precis && precis < elen)
9086 width += precis - old_precis;
9088 width += elen - sv_len_utf8(argsv);
9095 if (has_precis && elen > precis)
9102 if (alt || vectorize)
9104 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9125 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9134 esignbuf[esignlen++] = plus;
9138 case 'h': iv = (short)va_arg(*args, int); break;
9139 case 'l': iv = va_arg(*args, long); break;
9140 case 'V': iv = va_arg(*args, IV); break;
9141 default: iv = va_arg(*args, int); break;
9143 case 'q': iv = va_arg(*args, Quad_t); break;
9148 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9150 case 'h': iv = (short)tiv; break;
9151 case 'l': iv = (long)tiv; break;
9153 default: iv = tiv; break;
9155 case 'q': iv = (Quad_t)tiv; break;
9159 if ( !vectorize ) /* we already set uv above */
9164 esignbuf[esignlen++] = plus;
9168 esignbuf[esignlen++] = '-';
9212 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9223 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9224 case 'l': uv = va_arg(*args, unsigned long); break;
9225 case 'V': uv = va_arg(*args, UV); break;
9226 default: uv = va_arg(*args, unsigned); break;
9228 case 'q': uv = va_arg(*args, Uquad_t); break;
9233 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9235 case 'h': uv = (unsigned short)tuv; break;
9236 case 'l': uv = (unsigned long)tuv; break;
9238 default: uv = tuv; break;
9240 case 'q': uv = (Uquad_t)tuv; break;
9247 char *ptr = ebuf + sizeof ebuf;
9248 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9254 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9260 esignbuf[esignlen++] = '0';
9261 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9269 if (alt && *ptr != '0')
9278 esignbuf[esignlen++] = '0';
9279 esignbuf[esignlen++] = c;
9282 default: /* it had better be ten or less */
9286 } while (uv /= base);
9289 elen = (ebuf + sizeof ebuf) - ptr;
9293 zeros = precis - elen;
9294 else if (precis == 0 && elen == 1 && *eptr == '0'
9295 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9298 /* a precision nullifies the 0 flag. */
9305 /* FLOATING POINT */
9308 c = 'f'; /* maybe %F isn't supported here */
9316 /* This is evil, but floating point is even more evil */
9318 /* for SV-style calling, we can only get NV
9319 for C-style calling, we assume %f is double;
9320 for simplicity we allow any of %Lf, %llf, %qf for long double
9324 #if defined(USE_LONG_DOUBLE)
9328 /* [perl #20339] - we should accept and ignore %lf rather than die */
9332 #if defined(USE_LONG_DOUBLE)
9333 intsize = args ? 0 : 'q';
9337 #if defined(HAS_LONG_DOUBLE)
9346 /* now we need (long double) if intsize == 'q', else (double) */
9348 #if LONG_DOUBLESIZE > DOUBLESIZE
9350 va_arg(*args, long double) :
9351 va_arg(*args, double)
9353 va_arg(*args, double)
9358 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9359 else. frexp() has some unspecified behaviour for those three */
9360 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9362 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9363 will cast our (long double) to (double) */
9364 (void)Perl_frexp(nv, &i);
9365 if (i == PERL_INT_MIN)
9366 Perl_die(aTHX_ "panic: frexp");
9368 need = BIT_DIGITS(i);
9370 need += has_precis ? precis : 6; /* known default */
9375 #ifdef HAS_LDBL_SPRINTF_BUG
9376 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9377 with sfio - Allen <allens@cpan.org> */
9380 # define MY_DBL_MAX DBL_MAX
9381 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9382 # if DOUBLESIZE >= 8
9383 # define MY_DBL_MAX 1.7976931348623157E+308L
9385 # define MY_DBL_MAX 3.40282347E+38L
9389 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9390 # define MY_DBL_MAX_BUG 1L
9392 # define MY_DBL_MAX_BUG MY_DBL_MAX
9396 # define MY_DBL_MIN DBL_MIN
9397 # else /* XXX guessing! -Allen */
9398 # if DOUBLESIZE >= 8
9399 # define MY_DBL_MIN 2.2250738585072014E-308L
9401 # define MY_DBL_MIN 1.17549435E-38L
9405 if ((intsize == 'q') && (c == 'f') &&
9406 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9408 /* it's going to be short enough that
9409 * long double precision is not needed */
9411 if ((nv <= 0L) && (nv >= -0L))
9412 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9414 /* would use Perl_fp_class as a double-check but not
9415 * functional on IRIX - see perl.h comments */
9417 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9418 /* It's within the range that a double can represent */
9419 #if defined(DBL_MAX) && !defined(DBL_MIN)
9420 if ((nv >= ((long double)1/DBL_MAX)) ||
9421 (nv <= (-(long double)1/DBL_MAX)))
9423 fix_ldbl_sprintf_bug = TRUE;
9426 if (fix_ldbl_sprintf_bug == TRUE) {
9436 # undef MY_DBL_MAX_BUG
9439 #endif /* HAS_LDBL_SPRINTF_BUG */
9441 need += 20; /* fudge factor */
9442 if (PL_efloatsize < need) {
9443 Safefree(PL_efloatbuf);
9444 PL_efloatsize = need + 20; /* more fudge */
9445 Newx(PL_efloatbuf, PL_efloatsize, char);
9446 PL_efloatbuf[0] = '\0';
9449 if ( !(width || left || plus || alt) && fill != '0'
9450 && has_precis && intsize != 'q' ) { /* Shortcuts */
9451 /* See earlier comment about buggy Gconvert when digits,
9453 if ( c == 'g' && precis) {
9454 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9455 /* May return an empty string for digits==0 */
9456 if (*PL_efloatbuf) {
9457 elen = strlen(PL_efloatbuf);
9458 goto float_converted;
9460 } else if ( c == 'f' && !precis) {
9461 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9466 char *ptr = ebuf + sizeof ebuf;
9469 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9470 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9471 if (intsize == 'q') {
9472 /* Copy the one or more characters in a long double
9473 * format before the 'base' ([efgEFG]) character to
9474 * the format string. */
9475 static char const prifldbl[] = PERL_PRIfldbl;
9476 char const *p = prifldbl + sizeof(prifldbl) - 3;
9477 while (p >= prifldbl) { *--ptr = *p--; }
9482 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9487 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9499 /* No taint. Otherwise we are in the strange situation
9500 * where printf() taints but print($float) doesn't.
9502 #if defined(HAS_LONG_DOUBLE)
9503 elen = ((intsize == 'q')
9504 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9505 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9507 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9511 eptr = PL_efloatbuf;
9519 i = SvCUR(sv) - origlen;
9522 case 'h': *(va_arg(*args, short*)) = i; break;
9523 default: *(va_arg(*args, int*)) = i; break;
9524 case 'l': *(va_arg(*args, long*)) = i; break;
9525 case 'V': *(va_arg(*args, IV*)) = i; break;
9527 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9532 sv_setuv_mg(argsv, (UV)i);
9533 continue; /* not "break" */
9540 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9541 && ckWARN(WARN_PRINTF))
9543 SV * const msg = sv_newmortal();
9544 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9545 (PL_op->op_type == OP_PRTF) ? "" : "s");
9548 Perl_sv_catpvf(aTHX_ msg,
9549 "\"%%%c\"", c & 0xFF);
9551 Perl_sv_catpvf(aTHX_ msg,
9552 "\"%%\\%03"UVof"\"",
9555 sv_catpvs(msg, "end of string");
9556 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9559 /* output mangled stuff ... */
9565 /* ... right here, because formatting flags should not apply */
9566 SvGROW(sv, SvCUR(sv) + elen + 1);
9568 Copy(eptr, p, elen, char);
9571 SvCUR_set(sv, p - SvPVX_const(sv));
9573 continue; /* not "break" */
9576 if (is_utf8 != has_utf8) {
9579 sv_utf8_upgrade(sv);
9582 const STRLEN old_elen = elen;
9583 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9584 sv_utf8_upgrade(nsv);
9585 eptr = SvPVX_const(nsv);
9588 if (width) { /* fudge width (can't fudge elen) */
9589 width += elen - old_elen;
9595 have = esignlen + zeros + elen;
9597 Perl_croak_nocontext(PL_memory_wrap);
9599 need = (have > width ? have : width);
9602 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9603 Perl_croak_nocontext(PL_memory_wrap);
9604 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9606 if (esignlen && fill == '0') {
9608 for (i = 0; i < (int)esignlen; i++)
9612 memset(p, fill, gap);
9615 if (esignlen && fill != '0') {
9617 for (i = 0; i < (int)esignlen; i++)
9622 for (i = zeros; i; i--)
9626 Copy(eptr, p, elen, char);
9630 memset(p, ' ', gap);
9635 Copy(dotstr, p, dotstrlen, char);
9639 vectorize = FALSE; /* done iterating over vecstr */
9646 SvCUR_set(sv, p - SvPVX_const(sv));
9654 /* =========================================================================
9656 =head1 Cloning an interpreter
9658 All the macros and functions in this section are for the private use of
9659 the main function, perl_clone().
9661 The foo_dup() functions make an exact copy of an existing foo thingy.
9662 During the course of a cloning, a hash table is used to map old addresses
9663 to new addresses. The table is created and manipulated with the
9664 ptr_table_* functions.
9668 ============================================================================*/
9671 #if defined(USE_ITHREADS)
9673 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9674 #ifndef GpREFCNT_inc
9675 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9679 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9680 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9681 If this changes, please unmerge ss_dup. */
9682 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9683 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9684 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9685 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9686 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9687 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9688 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9689 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9690 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9691 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9692 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9693 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9694 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9695 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9697 /* clone a parser */
9700 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9707 /* look for it in the table first */
9708 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9712 /* create anew and remember what it is */
9713 Newxz(parser, 1, yy_parser);
9714 ptr_table_store(PL_ptr_table, proto, parser);
9716 parser->yyerrstatus = 0;
9717 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9719 /* XXX these not yet duped */
9720 parser->old_parser = NULL;
9721 parser->stack = NULL;
9723 parser->stack_size = 0;
9724 /* XXX parser->stack->state = 0; */
9726 /* XXX eventually, just Copy() most of the parser struct ? */
9728 parser->lex_brackets = proto->lex_brackets;
9729 parser->lex_casemods = proto->lex_casemods;
9730 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9731 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9732 parser->lex_casestack = savepvn(proto->lex_casestack,
9733 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9734 parser->lex_defer = proto->lex_defer;
9735 parser->lex_dojoin = proto->lex_dojoin;
9736 parser->lex_expect = proto->lex_expect;
9737 parser->lex_formbrack = proto->lex_formbrack;
9738 parser->lex_inpat = proto->lex_inpat;
9739 parser->lex_inwhat = proto->lex_inwhat;
9740 parser->lex_op = proto->lex_op;
9741 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9742 parser->lex_starts = proto->lex_starts;
9743 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9744 parser->multi_close = proto->multi_close;
9745 parser->multi_open = proto->multi_open;
9746 parser->multi_start = proto->multi_start;
9747 parser->multi_end = proto->multi_end;
9748 parser->pending_ident = proto->pending_ident;
9749 parser->preambled = proto->preambled;
9750 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9751 parser->linestr = sv_dup_inc(proto->linestr, param);
9752 parser->expect = proto->expect;
9753 parser->copline = proto->copline;
9754 parser->last_lop_op = proto->last_lop_op;
9755 parser->lex_state = proto->lex_state;
9756 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9757 /* rsfp_filters entries have fake IoDIRP() */
9758 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9759 parser->in_my = proto->in_my;
9760 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9761 parser->error_count = proto->error_count;
9764 parser->linestr = sv_dup_inc(proto->linestr, param);
9767 char * const ols = SvPVX(proto->linestr);
9768 char * const ls = SvPVX(parser->linestr);
9770 parser->bufptr = ls + (proto->bufptr >= ols ?
9771 proto->bufptr - ols : 0);
9772 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9773 proto->oldbufptr - ols : 0);
9774 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9775 proto->oldoldbufptr - ols : 0);
9776 parser->linestart = ls + (proto->linestart >= ols ?
9777 proto->linestart - ols : 0);
9778 parser->last_uni = ls + (proto->last_uni >= ols ?
9779 proto->last_uni - ols : 0);
9780 parser->last_lop = ls + (proto->last_lop >= ols ?
9781 proto->last_lop - ols : 0);
9783 parser->bufend = ls + SvCUR(parser->linestr);
9786 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9790 parser->endwhite = proto->endwhite;
9791 parser->faketokens = proto->faketokens;
9792 parser->lasttoke = proto->lasttoke;
9793 parser->nextwhite = proto->nextwhite;
9794 parser->realtokenstart = proto->realtokenstart;
9795 parser->skipwhite = proto->skipwhite;
9796 parser->thisclose = proto->thisclose;
9797 parser->thismad = proto->thismad;
9798 parser->thisopen = proto->thisopen;
9799 parser->thisstuff = proto->thisstuff;
9800 parser->thistoken = proto->thistoken;
9801 parser->thiswhite = proto->thiswhite;
9803 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9804 parser->curforce = proto->curforce;
9806 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9807 Copy(proto->nexttype, parser->nexttype, 5, I32);
9808 parser->nexttoke = proto->nexttoke;
9814 /* duplicate a file handle */
9817 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9821 PERL_UNUSED_ARG(type);
9824 return (PerlIO*)NULL;
9826 /* look for it in the table first */
9827 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9831 /* create anew and remember what it is */
9832 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9833 ptr_table_store(PL_ptr_table, fp, ret);
9837 /* duplicate a directory handle */
9840 Perl_dirp_dup(pTHX_ DIR *dp)
9842 PERL_UNUSED_CONTEXT;
9849 /* duplicate a typeglob */
9852 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9858 /* look for it in the table first */
9859 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9863 /* create anew and remember what it is */
9865 ptr_table_store(PL_ptr_table, gp, ret);
9868 ret->gp_refcnt = 0; /* must be before any other dups! */
9869 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9870 ret->gp_io = io_dup_inc(gp->gp_io, param);
9871 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9872 ret->gp_av = av_dup_inc(gp->gp_av, param);
9873 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9874 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9875 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9876 ret->gp_cvgen = gp->gp_cvgen;
9877 ret->gp_line = gp->gp_line;
9878 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9882 /* duplicate a chain of magic */
9885 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9887 MAGIC *mgprev = (MAGIC*)NULL;
9890 return (MAGIC*)NULL;
9891 /* look for it in the table first */
9892 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9896 for (; mg; mg = mg->mg_moremagic) {
9898 Newxz(nmg, 1, MAGIC);
9900 mgprev->mg_moremagic = nmg;
9903 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9904 nmg->mg_private = mg->mg_private;
9905 nmg->mg_type = mg->mg_type;
9906 nmg->mg_flags = mg->mg_flags;
9907 /* FIXME for plugins
9908 if (mg->mg_type == PERL_MAGIC_qr) {
9909 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9913 if(mg->mg_type == PERL_MAGIC_backref) {
9914 /* The backref AV has its reference count deliberately bumped by
9916 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9919 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9920 ? sv_dup_inc(mg->mg_obj, param)
9921 : sv_dup(mg->mg_obj, param);
9923 nmg->mg_len = mg->mg_len;
9924 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9925 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9926 if (mg->mg_len > 0) {
9927 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9928 if (mg->mg_type == PERL_MAGIC_overload_table &&
9929 AMT_AMAGIC((AMT*)mg->mg_ptr))
9931 const AMT * const amtp = (AMT*)mg->mg_ptr;
9932 AMT * const namtp = (AMT*)nmg->mg_ptr;
9934 for (i = 1; i < NofAMmeth; i++) {
9935 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9939 else if (mg->mg_len == HEf_SVKEY)
9940 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9942 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9943 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9950 #endif /* USE_ITHREADS */
9952 /* create a new pointer-mapping table */
9955 Perl_ptr_table_new(pTHX)
9958 PERL_UNUSED_CONTEXT;
9960 Newxz(tbl, 1, PTR_TBL_t);
9963 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9967 #define PTR_TABLE_HASH(ptr) \
9968 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9971 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9972 following define) and at call to new_body_inline made below in
9973 Perl_ptr_table_store()
9976 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9978 /* map an existing pointer using a table */
9980 STATIC PTR_TBL_ENT_t *
9981 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9982 PTR_TBL_ENT_t *tblent;
9983 const UV hash = PTR_TABLE_HASH(sv);
9985 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9986 for (; tblent; tblent = tblent->next) {
9987 if (tblent->oldval == sv)
9994 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9996 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9997 PERL_UNUSED_CONTEXT;
9998 return tblent ? tblent->newval : NULL;
10001 /* add a new entry to a pointer-mapping table */
10004 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10006 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10007 PERL_UNUSED_CONTEXT;
10010 tblent->newval = newsv;
10012 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10014 new_body_inline(tblent, PTE_SVSLOT);
10016 tblent->oldval = oldsv;
10017 tblent->newval = newsv;
10018 tblent->next = tbl->tbl_ary[entry];
10019 tbl->tbl_ary[entry] = tblent;
10021 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10022 ptr_table_split(tbl);
10026 /* double the hash bucket size of an existing ptr table */
10029 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10031 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10032 const UV oldsize = tbl->tbl_max + 1;
10033 UV newsize = oldsize * 2;
10035 PERL_UNUSED_CONTEXT;
10037 Renew(ary, newsize, PTR_TBL_ENT_t*);
10038 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10039 tbl->tbl_max = --newsize;
10040 tbl->tbl_ary = ary;
10041 for (i=0; i < oldsize; i++, ary++) {
10042 PTR_TBL_ENT_t **curentp, **entp, *ent;
10045 curentp = ary + oldsize;
10046 for (entp = ary, ent = *ary; ent; ent = *entp) {
10047 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10049 ent->next = *curentp;
10059 /* remove all the entries from a ptr table */
10062 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10064 if (tbl && tbl->tbl_items) {
10065 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10066 UV riter = tbl->tbl_max;
10069 PTR_TBL_ENT_t *entry = array[riter];
10072 PTR_TBL_ENT_t * const oentry = entry;
10073 entry = entry->next;
10078 tbl->tbl_items = 0;
10082 /* clear and free a ptr table */
10085 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10090 ptr_table_clear(tbl);
10091 Safefree(tbl->tbl_ary);
10095 #if defined(USE_ITHREADS)
10098 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10101 SvRV_set(dstr, SvWEAKREF(sstr)
10102 ? sv_dup(SvRV(sstr), param)
10103 : sv_dup_inc(SvRV(sstr), param));
10106 else if (SvPVX_const(sstr)) {
10107 /* Has something there */
10109 /* Normal PV - clone whole allocated space */
10110 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10111 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10112 /* Not that normal - actually sstr is copy on write.
10113 But we are a true, independant SV, so: */
10114 SvREADONLY_off(dstr);
10119 /* Special case - not normally malloced for some reason */
10120 if (isGV_with_GP(sstr)) {
10121 /* Don't need to do anything here. */
10123 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10124 /* A "shared" PV - clone it as "shared" PV */
10126 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10130 /* Some other special case - random pointer */
10131 SvPV_set(dstr, SvPVX(sstr));
10136 /* Copy the NULL */
10137 SvPV_set(dstr, NULL);
10141 /* duplicate an SV of any type (including AV, HV etc) */
10144 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10151 if (SvTYPE(sstr) == SVTYPEMASK) {
10152 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10157 /* look for it in the table first */
10158 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10162 if(param->flags & CLONEf_JOIN_IN) {
10163 /** We are joining here so we don't want do clone
10164 something that is bad **/
10165 if (SvTYPE(sstr) == SVt_PVHV) {
10166 const HEK * const hvname = HvNAME_HEK(sstr);
10168 /** don't clone stashes if they already exist **/
10169 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10173 /* create anew and remember what it is */
10176 #ifdef DEBUG_LEAKING_SCALARS
10177 dstr->sv_debug_optype = sstr->sv_debug_optype;
10178 dstr->sv_debug_line = sstr->sv_debug_line;
10179 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10180 dstr->sv_debug_cloned = 1;
10181 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10184 ptr_table_store(PL_ptr_table, sstr, dstr);
10187 SvFLAGS(dstr) = SvFLAGS(sstr);
10188 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10189 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10192 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10193 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10194 (void*)PL_watch_pvx, SvPVX_const(sstr));
10197 /* don't clone objects whose class has asked us not to */
10198 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10203 switch (SvTYPE(sstr)) {
10205 SvANY(dstr) = NULL;
10208 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10210 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10212 SvIV_set(dstr, SvIVX(sstr));
10216 SvANY(dstr) = new_XNV();
10217 SvNV_set(dstr, SvNVX(sstr));
10219 /* case SVt_BIND: */
10222 /* These are all the types that need complex bodies allocating. */
10224 const svtype sv_type = SvTYPE(sstr);
10225 const struct body_details *const sv_type_details
10226 = bodies_by_type + sv_type;
10230 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10234 if (GvUNIQUE((GV*)sstr)) {
10235 NOOP; /* Do sharing here, and fall through */
10248 assert(sv_type_details->body_size);
10249 if (sv_type_details->arena) {
10250 new_body_inline(new_body, sv_type);
10252 = (void*)((char*)new_body - sv_type_details->offset);
10254 new_body = new_NOARENA(sv_type_details);
10258 SvANY(dstr) = new_body;
10261 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10262 ((char*)SvANY(dstr)) + sv_type_details->offset,
10263 sv_type_details->copy, char);
10265 Copy(((char*)SvANY(sstr)),
10266 ((char*)SvANY(dstr)),
10267 sv_type_details->body_size + sv_type_details->offset, char);
10270 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10271 && !isGV_with_GP(dstr))
10272 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10274 /* The Copy above means that all the source (unduplicated) pointers
10275 are now in the destination. We can check the flags and the
10276 pointers in either, but it's possible that there's less cache
10277 missing by always going for the destination.
10278 FIXME - instrument and check that assumption */
10279 if (sv_type >= SVt_PVMG) {
10280 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10281 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10282 } else if (SvMAGIC(dstr))
10283 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10285 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10288 /* The cast silences a GCC warning about unhandled types. */
10289 switch ((int)sv_type) {
10299 /* FIXME for plugins */
10300 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10303 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10304 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10305 LvTARG(dstr) = dstr;
10306 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10307 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10309 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10311 if(isGV_with_GP(sstr)) {
10312 if (GvNAME_HEK(dstr))
10313 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10314 /* Don't call sv_add_backref here as it's going to be
10315 created as part of the magic cloning of the symbol
10317 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10318 at the point of this comment. */
10319 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10320 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10321 (void)GpREFCNT_inc(GvGP(dstr));
10323 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10326 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10327 if (IoOFP(dstr) == IoIFP(sstr))
10328 IoOFP(dstr) = IoIFP(dstr);
10330 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10331 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10332 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10333 /* I have no idea why fake dirp (rsfps)
10334 should be treated differently but otherwise
10335 we end up with leaks -- sky*/
10336 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10337 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10338 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10340 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10341 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10342 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10343 if (IoDIRP(dstr)) {
10344 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10347 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10350 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10351 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10352 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10355 if (AvARRAY((AV*)sstr)) {
10356 SV **dst_ary, **src_ary;
10357 SSize_t items = AvFILLp((AV*)sstr) + 1;
10359 src_ary = AvARRAY((AV*)sstr);
10360 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10361 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10362 AvARRAY((AV*)dstr) = dst_ary;
10363 AvALLOC((AV*)dstr) = dst_ary;
10364 if (AvREAL((AV*)sstr)) {
10365 while (items-- > 0)
10366 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10369 while (items-- > 0)
10370 *dst_ary++ = sv_dup(*src_ary++, param);
10372 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10373 while (items-- > 0) {
10374 *dst_ary++ = &PL_sv_undef;
10378 AvARRAY((AV*)dstr) = NULL;
10379 AvALLOC((AV*)dstr) = (SV**)NULL;
10383 if (HvARRAY((HV*)sstr)) {
10385 const bool sharekeys = !!HvSHAREKEYS(sstr);
10386 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10387 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10389 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10390 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10392 HvARRAY(dstr) = (HE**)darray;
10393 while (i <= sxhv->xhv_max) {
10394 const HE * const source = HvARRAY(sstr)[i];
10395 HvARRAY(dstr)[i] = source
10396 ? he_dup(source, sharekeys, param) : 0;
10401 const struct xpvhv_aux * const saux = HvAUX(sstr);
10402 struct xpvhv_aux * const daux = HvAUX(dstr);
10403 /* This flag isn't copied. */
10404 /* SvOOK_on(hv) attacks the IV flags. */
10405 SvFLAGS(dstr) |= SVf_OOK;
10407 hvname = saux->xhv_name;
10408 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10410 daux->xhv_riter = saux->xhv_riter;
10411 daux->xhv_eiter = saux->xhv_eiter
10412 ? he_dup(saux->xhv_eiter,
10413 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10414 daux->xhv_backreferences =
10415 saux->xhv_backreferences
10416 ? (AV*) SvREFCNT_inc(
10417 sv_dup((SV*)saux->xhv_backreferences, param))
10420 daux->xhv_mro_meta = saux->xhv_mro_meta
10421 ? mro_meta_dup(saux->xhv_mro_meta, param)
10424 /* Record stashes for possible cloning in Perl_clone(). */
10426 av_push(param->stashes, dstr);
10430 HvARRAY((HV*)dstr) = NULL;
10433 if (!(param->flags & CLONEf_COPY_STACKS)) {
10437 /* NOTE: not refcounted */
10438 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10440 if (!CvISXSUB(dstr))
10441 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10443 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10444 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10445 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10446 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10448 /* don't dup if copying back - CvGV isn't refcounted, so the
10449 * duped GV may never be freed. A bit of a hack! DAPM */
10450 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10451 NULL : gv_dup(CvGV(dstr), param) ;
10452 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10454 CvWEAKOUTSIDE(sstr)
10455 ? cv_dup( CvOUTSIDE(dstr), param)
10456 : cv_dup_inc(CvOUTSIDE(dstr), param);
10457 if (!CvISXSUB(dstr))
10458 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10464 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10470 /* duplicate a context */
10473 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10475 PERL_CONTEXT *ncxs;
10478 return (PERL_CONTEXT*)NULL;
10480 /* look for it in the table first */
10481 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10485 /* create anew and remember what it is */
10486 Newxz(ncxs, max + 1, PERL_CONTEXT);
10487 ptr_table_store(PL_ptr_table, cxs, ncxs);
10490 PERL_CONTEXT * const cx = &cxs[ix];
10491 PERL_CONTEXT * const ncx = &ncxs[ix];
10492 ncx->cx_type = cx->cx_type;
10493 if (CxTYPE(cx) == CXt_SUBST) {
10494 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10497 ncx->blk_oldsp = cx->blk_oldsp;
10498 ncx->blk_oldcop = cx->blk_oldcop;
10499 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10500 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10501 ncx->blk_oldpm = cx->blk_oldpm;
10502 ncx->blk_gimme = cx->blk_gimme;
10503 switch (CxTYPE(cx)) {
10505 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10506 ? cv_dup_inc(cx->blk_sub.cv, param)
10507 : cv_dup(cx->blk_sub.cv,param));
10508 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10509 ? av_dup_inc(cx->blk_sub.argarray, param)
10511 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10512 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10513 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10514 ncx->blk_sub.lval = cx->blk_sub.lval;
10515 ncx->blk_sub.retop = cx->blk_sub.retop;
10516 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10517 cx->blk_sub.oldcomppad);
10520 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10521 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10522 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10523 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10524 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10525 ncx->blk_eval.retop = cx->blk_eval.retop;
10528 ncx->blk_loop.label = cx->blk_loop.label;
10529 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10530 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10531 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10532 ? cx->blk_loop.iterdata
10533 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10534 ncx->blk_loop.oldcomppad
10535 = (PAD*)ptr_table_fetch(PL_ptr_table,
10536 cx->blk_loop.oldcomppad);
10537 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10538 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10539 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10540 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10541 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10544 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10545 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10546 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10547 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10548 ncx->blk_sub.retop = cx->blk_sub.retop;
10560 /* duplicate a stack info structure */
10563 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10568 return (PERL_SI*)NULL;
10570 /* look for it in the table first */
10571 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10575 /* create anew and remember what it is */
10576 Newxz(nsi, 1, PERL_SI);
10577 ptr_table_store(PL_ptr_table, si, nsi);
10579 nsi->si_stack = av_dup_inc(si->si_stack, param);
10580 nsi->si_cxix = si->si_cxix;
10581 nsi->si_cxmax = si->si_cxmax;
10582 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10583 nsi->si_type = si->si_type;
10584 nsi->si_prev = si_dup(si->si_prev, param);
10585 nsi->si_next = si_dup(si->si_next, param);
10586 nsi->si_markoff = si->si_markoff;
10591 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10592 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10593 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10594 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10595 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10596 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10597 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10598 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10599 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10600 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10601 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10602 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10603 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10604 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10607 #define pv_dup_inc(p) SAVEPV(p)
10608 #define pv_dup(p) SAVEPV(p)
10609 #define svp_dup_inc(p,pp) any_dup(p,pp)
10611 /* map any object to the new equivent - either something in the
10612 * ptr table, or something in the interpreter structure
10616 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10621 return (void*)NULL;
10623 /* look for it in the table first */
10624 ret = ptr_table_fetch(PL_ptr_table, v);
10628 /* see if it is part of the interpreter structure */
10629 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10630 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10638 /* duplicate the save stack */
10641 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10644 ANY * const ss = proto_perl->Isavestack;
10645 const I32 max = proto_perl->Isavestack_max;
10646 I32 ix = proto_perl->Isavestack_ix;
10659 void (*dptr) (void*);
10660 void (*dxptr) (pTHX_ void*);
10662 Newxz(nss, max, ANY);
10665 const I32 type = POPINT(ss,ix);
10666 TOPINT(nss,ix) = type;
10668 case SAVEt_HELEM: /* hash element */
10669 sv = (SV*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10672 case SAVEt_ITEM: /* normal string */
10673 case SAVEt_SV: /* scalar reference */
10674 sv = (SV*)POPPTR(ss,ix);
10675 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10678 case SAVEt_MORTALIZESV:
10679 sv = (SV*)POPPTR(ss,ix);
10680 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10682 case SAVEt_SHARED_PVREF: /* char* in shared space */
10683 c = (char*)POPPTR(ss,ix);
10684 TOPPTR(nss,ix) = savesharedpv(c);
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10688 case SAVEt_GENERIC_SVREF: /* generic sv */
10689 case SAVEt_SVREF: /* scalar reference */
10690 sv = (SV*)POPPTR(ss,ix);
10691 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10692 ptr = POPPTR(ss,ix);
10693 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10695 case SAVEt_HV: /* hash reference */
10696 case SAVEt_AV: /* array reference */
10697 sv = (SV*) POPPTR(ss,ix);
10698 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10700 case SAVEt_COMPPAD:
10702 sv = (SV*) POPPTR(ss,ix);
10703 TOPPTR(nss,ix) = sv_dup(sv, param);
10705 case SAVEt_INT: /* int reference */
10706 ptr = POPPTR(ss,ix);
10707 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10708 intval = (int)POPINT(ss,ix);
10709 TOPINT(nss,ix) = intval;
10711 case SAVEt_LONG: /* long reference */
10712 ptr = POPPTR(ss,ix);
10713 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10715 case SAVEt_CLEARSV:
10716 longval = (long)POPLONG(ss,ix);
10717 TOPLONG(nss,ix) = longval;
10719 case SAVEt_I32: /* I32 reference */
10720 case SAVEt_I16: /* I16 reference */
10721 case SAVEt_I8: /* I8 reference */
10722 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10723 ptr = POPPTR(ss,ix);
10724 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10726 TOPINT(nss,ix) = i;
10728 case SAVEt_IV: /* IV reference */
10729 ptr = POPPTR(ss,ix);
10730 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10732 TOPIV(nss,ix) = iv;
10734 case SAVEt_HPTR: /* HV* reference */
10735 case SAVEt_APTR: /* AV* reference */
10736 case SAVEt_SPTR: /* SV* reference */
10737 ptr = POPPTR(ss,ix);
10738 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10739 sv = (SV*)POPPTR(ss,ix);
10740 TOPPTR(nss,ix) = sv_dup(sv, param);
10742 case SAVEt_VPTR: /* random* reference */
10743 ptr = POPPTR(ss,ix);
10744 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10745 ptr = POPPTR(ss,ix);
10746 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10748 case SAVEt_GENERIC_PVREF: /* generic char* */
10749 case SAVEt_PPTR: /* char* reference */
10750 ptr = POPPTR(ss,ix);
10751 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10752 c = (char*)POPPTR(ss,ix);
10753 TOPPTR(nss,ix) = pv_dup(c);
10755 case SAVEt_GP: /* scalar reference */
10756 gp = (GP*)POPPTR(ss,ix);
10757 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10758 (void)GpREFCNT_inc(gp);
10759 gv = (GV*)POPPTR(ss,ix);
10760 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10763 ptr = POPPTR(ss,ix);
10764 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10765 /* these are assumed to be refcounted properly */
10767 switch (((OP*)ptr)->op_type) {
10769 case OP_LEAVESUBLV:
10773 case OP_LEAVEWRITE:
10774 TOPPTR(nss,ix) = ptr;
10777 (void) OpREFCNT_inc(o);
10781 TOPPTR(nss,ix) = NULL;
10786 TOPPTR(nss,ix) = NULL;
10789 c = (char*)POPPTR(ss,ix);
10790 TOPPTR(nss,ix) = pv_dup_inc(c);
10793 hv = (HV*)POPPTR(ss,ix);
10794 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10795 c = (char*)POPPTR(ss,ix);
10796 TOPPTR(nss,ix) = pv_dup_inc(c);
10798 case SAVEt_STACK_POS: /* Position on Perl stack */
10800 TOPINT(nss,ix) = i;
10802 case SAVEt_DESTRUCTOR:
10803 ptr = POPPTR(ss,ix);
10804 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10805 dptr = POPDPTR(ss,ix);
10806 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10807 any_dup(FPTR2DPTR(void *, dptr),
10810 case SAVEt_DESTRUCTOR_X:
10811 ptr = POPPTR(ss,ix);
10812 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10813 dxptr = POPDXPTR(ss,ix);
10814 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10815 any_dup(FPTR2DPTR(void *, dxptr),
10818 case SAVEt_REGCONTEXT:
10821 TOPINT(nss,ix) = i;
10824 case SAVEt_AELEM: /* array element */
10825 sv = (SV*)POPPTR(ss,ix);
10826 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10828 TOPINT(nss,ix) = i;
10829 av = (AV*)POPPTR(ss,ix);
10830 TOPPTR(nss,ix) = av_dup_inc(av, param);
10833 ptr = POPPTR(ss,ix);
10834 TOPPTR(nss,ix) = ptr;
10838 TOPINT(nss,ix) = i;
10839 ptr = POPPTR(ss,ix);
10842 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10843 HINTS_REFCNT_UNLOCK;
10845 TOPPTR(nss,ix) = ptr;
10846 if (i & HINT_LOCALIZE_HH) {
10847 hv = (HV*)POPPTR(ss,ix);
10848 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10852 longval = (long)POPLONG(ss,ix);
10853 TOPLONG(nss,ix) = longval;
10854 ptr = POPPTR(ss,ix);
10855 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10856 sv = (SV*)POPPTR(ss,ix);
10857 TOPPTR(nss,ix) = sv_dup(sv, param);
10860 ptr = POPPTR(ss,ix);
10861 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10862 longval = (long)POPBOOL(ss,ix);
10863 TOPBOOL(nss,ix) = (bool)longval;
10865 case SAVEt_SET_SVFLAGS:
10867 TOPINT(nss,ix) = i;
10869 TOPINT(nss,ix) = i;
10870 sv = (SV*)POPPTR(ss,ix);
10871 TOPPTR(nss,ix) = sv_dup(sv, param);
10873 case SAVEt_RE_STATE:
10875 const struct re_save_state *const old_state
10876 = (struct re_save_state *)
10877 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10878 struct re_save_state *const new_state
10879 = (struct re_save_state *)
10880 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10882 Copy(old_state, new_state, 1, struct re_save_state);
10883 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10885 new_state->re_state_bostr
10886 = pv_dup(old_state->re_state_bostr);
10887 new_state->re_state_reginput
10888 = pv_dup(old_state->re_state_reginput);
10889 new_state->re_state_regeol
10890 = pv_dup(old_state->re_state_regeol);
10891 new_state->re_state_regoffs
10892 = (regexp_paren_pair*)
10893 any_dup(old_state->re_state_regoffs, proto_perl);
10894 new_state->re_state_reglastparen
10895 = (U32*) any_dup(old_state->re_state_reglastparen,
10897 new_state->re_state_reglastcloseparen
10898 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10900 /* XXX This just has to be broken. The old save_re_context
10901 code did SAVEGENERICPV(PL_reg_start_tmp);
10902 PL_reg_start_tmp is char **.
10903 Look above to what the dup code does for
10904 SAVEt_GENERIC_PVREF
10905 It can never have worked.
10906 So this is merely a faithful copy of the exiting bug: */
10907 new_state->re_state_reg_start_tmp
10908 = (char **) pv_dup((char *)
10909 old_state->re_state_reg_start_tmp);
10910 /* I assume that it only ever "worked" because no-one called
10911 (pseudo)fork while the regexp engine had re-entered itself.
10913 #ifdef PERL_OLD_COPY_ON_WRITE
10914 new_state->re_state_nrs
10915 = sv_dup(old_state->re_state_nrs, param);
10917 new_state->re_state_reg_magic
10918 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10920 new_state->re_state_reg_oldcurpm
10921 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10923 new_state->re_state_reg_curpm
10924 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10926 new_state->re_state_reg_oldsaved
10927 = pv_dup(old_state->re_state_reg_oldsaved);
10928 new_state->re_state_reg_poscache
10929 = pv_dup(old_state->re_state_reg_poscache);
10930 new_state->re_state_reg_starttry
10931 = pv_dup(old_state->re_state_reg_starttry);
10934 case SAVEt_COMPILE_WARNINGS:
10935 ptr = POPPTR(ss,ix);
10936 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10939 ptr = POPPTR(ss,ix);
10940 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10944 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10952 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10953 * flag to the result. This is done for each stash before cloning starts,
10954 * so we know which stashes want their objects cloned */
10957 do_mark_cloneable_stash(pTHX_ SV *sv)
10959 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10961 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10962 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10963 if (cloner && GvCV(cloner)) {
10970 mXPUSHs(newSVhek(hvname));
10972 call_sv((SV*)GvCV(cloner), G_SCALAR);
10979 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10987 =for apidoc perl_clone
10989 Create and return a new interpreter by cloning the current one.
10991 perl_clone takes these flags as parameters:
10993 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10994 without it we only clone the data and zero the stacks,
10995 with it we copy the stacks and the new perl interpreter is
10996 ready to run at the exact same point as the previous one.
10997 The pseudo-fork code uses COPY_STACKS while the
10998 threads->create doesn't.
11000 CLONEf_KEEP_PTR_TABLE
11001 perl_clone keeps a ptr_table with the pointer of the old
11002 variable as a key and the new variable as a value,
11003 this allows it to check if something has been cloned and not
11004 clone it again but rather just use the value and increase the
11005 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11006 the ptr_table using the function
11007 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11008 reason to keep it around is if you want to dup some of your own
11009 variable who are outside the graph perl scans, example of this
11010 code is in threads.xs create
11013 This is a win32 thing, it is ignored on unix, it tells perls
11014 win32host code (which is c++) to clone itself, this is needed on
11015 win32 if you want to run two threads at the same time,
11016 if you just want to do some stuff in a separate perl interpreter
11017 and then throw it away and return to the original one,
11018 you don't need to do anything.
11023 /* XXX the above needs expanding by someone who actually understands it ! */
11024 EXTERN_C PerlInterpreter *
11025 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11028 perl_clone(PerlInterpreter *proto_perl, UV flags)
11031 #ifdef PERL_IMPLICIT_SYS
11033 /* perlhost.h so we need to call into it
11034 to clone the host, CPerlHost should have a c interface, sky */
11036 if (flags & CLONEf_CLONE_HOST) {
11037 return perl_clone_host(proto_perl,flags);
11039 return perl_clone_using(proto_perl, flags,
11041 proto_perl->IMemShared,
11042 proto_perl->IMemParse,
11044 proto_perl->IStdIO,
11048 proto_perl->IProc);
11052 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11053 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11054 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11055 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11056 struct IPerlDir* ipD, struct IPerlSock* ipS,
11057 struct IPerlProc* ipP)
11059 /* XXX many of the string copies here can be optimized if they're
11060 * constants; they need to be allocated as common memory and just
11061 * their pointers copied. */
11064 CLONE_PARAMS clone_params;
11065 CLONE_PARAMS* const param = &clone_params;
11067 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11068 /* for each stash, determine whether its objects should be cloned */
11069 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11070 PERL_SET_THX(my_perl);
11073 PoisonNew(my_perl, 1, PerlInterpreter);
11079 PL_savestack_ix = 0;
11080 PL_savestack_max = -1;
11081 PL_sig_pending = 0;
11083 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11084 # else /* !DEBUGGING */
11085 Zero(my_perl, 1, PerlInterpreter);
11086 # endif /* DEBUGGING */
11088 /* host pointers */
11090 PL_MemShared = ipMS;
11091 PL_MemParse = ipMP;
11098 #else /* !PERL_IMPLICIT_SYS */
11100 CLONE_PARAMS clone_params;
11101 CLONE_PARAMS* param = &clone_params;
11102 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11103 /* for each stash, determine whether its objects should be cloned */
11104 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11105 PERL_SET_THX(my_perl);
11108 PoisonNew(my_perl, 1, PerlInterpreter);
11114 PL_savestack_ix = 0;
11115 PL_savestack_max = -1;
11116 PL_sig_pending = 0;
11118 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11119 # else /* !DEBUGGING */
11120 Zero(my_perl, 1, PerlInterpreter);
11121 # endif /* DEBUGGING */
11122 #endif /* PERL_IMPLICIT_SYS */
11123 param->flags = flags;
11124 param->proto_perl = proto_perl;
11126 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11128 PL_body_arenas = NULL;
11129 Zero(&PL_body_roots, 1, PL_body_roots);
11131 PL_nice_chunk = NULL;
11132 PL_nice_chunk_size = 0;
11134 PL_sv_objcount = 0;
11136 PL_sv_arenaroot = NULL;
11138 PL_debug = proto_perl->Idebug;
11140 PL_hash_seed = proto_perl->Ihash_seed;
11141 PL_rehash_seed = proto_perl->Irehash_seed;
11143 #ifdef USE_REENTRANT_API
11144 /* XXX: things like -Dm will segfault here in perlio, but doing
11145 * PERL_SET_CONTEXT(proto_perl);
11146 * breaks too many other things
11148 Perl_reentrant_init(aTHX);
11151 /* create SV map for pointer relocation */
11152 PL_ptr_table = ptr_table_new();
11154 /* initialize these special pointers as early as possible */
11155 SvANY(&PL_sv_undef) = NULL;
11156 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11157 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11158 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11160 SvANY(&PL_sv_no) = new_XPVNV();
11161 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11162 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11163 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11164 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11165 SvCUR_set(&PL_sv_no, 0);
11166 SvLEN_set(&PL_sv_no, 1);
11167 SvIV_set(&PL_sv_no, 0);
11168 SvNV_set(&PL_sv_no, 0);
11169 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11171 SvANY(&PL_sv_yes) = new_XPVNV();
11172 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11173 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11174 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11175 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11176 SvCUR_set(&PL_sv_yes, 1);
11177 SvLEN_set(&PL_sv_yes, 2);
11178 SvIV_set(&PL_sv_yes, 1);
11179 SvNV_set(&PL_sv_yes, 1);
11180 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11182 /* create (a non-shared!) shared string table */
11183 PL_strtab = newHV();
11184 HvSHAREKEYS_off(PL_strtab);
11185 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11186 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11188 PL_compiling = proto_perl->Icompiling;
11190 /* These two PVs will be free'd special way so must set them same way op.c does */
11191 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11192 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11194 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11195 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11197 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11198 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11199 if (PL_compiling.cop_hints_hash) {
11201 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11202 HINTS_REFCNT_UNLOCK;
11204 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11205 #ifdef PERL_DEBUG_READONLY_OPS
11210 /* pseudo environmental stuff */
11211 PL_origargc = proto_perl->Iorigargc;
11212 PL_origargv = proto_perl->Iorigargv;
11214 param->stashes = newAV(); /* Setup array of objects to call clone on */
11216 /* Set tainting stuff before PerlIO_debug can possibly get called */
11217 PL_tainting = proto_perl->Itainting;
11218 PL_taint_warn = proto_perl->Itaint_warn;
11220 #ifdef PERLIO_LAYERS
11221 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11222 PerlIO_clone(aTHX_ proto_perl, param);
11225 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11226 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11227 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11228 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11229 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11230 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11233 PL_minus_c = proto_perl->Iminus_c;
11234 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11235 PL_localpatches = proto_perl->Ilocalpatches;
11236 PL_splitstr = proto_perl->Isplitstr;
11237 PL_minus_n = proto_perl->Iminus_n;
11238 PL_minus_p = proto_perl->Iminus_p;
11239 PL_minus_l = proto_perl->Iminus_l;
11240 PL_minus_a = proto_perl->Iminus_a;
11241 PL_minus_E = proto_perl->Iminus_E;
11242 PL_minus_F = proto_perl->Iminus_F;
11243 PL_doswitches = proto_perl->Idoswitches;
11244 PL_dowarn = proto_perl->Idowarn;
11245 PL_doextract = proto_perl->Idoextract;
11246 PL_sawampersand = proto_perl->Isawampersand;
11247 PL_unsafe = proto_perl->Iunsafe;
11248 PL_inplace = SAVEPV(proto_perl->Iinplace);
11249 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11250 PL_perldb = proto_perl->Iperldb;
11251 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11252 PL_exit_flags = proto_perl->Iexit_flags;
11254 /* magical thingies */
11255 /* XXX time(&PL_basetime) when asked for? */
11256 PL_basetime = proto_perl->Ibasetime;
11257 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11259 PL_maxsysfd = proto_perl->Imaxsysfd;
11260 PL_statusvalue = proto_perl->Istatusvalue;
11262 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11264 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11266 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11268 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11269 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11270 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11273 /* RE engine related */
11274 Zero(&PL_reg_state, 1, struct re_save_state);
11275 PL_reginterp_cnt = 0;
11276 PL_regmatch_slab = NULL;
11278 /* Clone the regex array */
11279 /* ORANGE FIXME for plugins, probably in the SV dup code.
11280 newSViv(PTR2IV(CALLREGDUPE(
11281 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11283 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11284 PL_regex_pad = AvARRAY(PL_regex_padav);
11286 /* shortcuts to various I/O objects */
11287 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11288 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11289 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11290 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11291 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11292 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11294 /* shortcuts to regexp stuff */
11295 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11297 /* shortcuts to misc objects */
11298 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11300 /* shortcuts to debugging objects */
11301 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11302 PL_DBline = gv_dup(proto_perl->IDBline, param);
11303 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11304 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11305 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11306 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11307 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11309 /* symbol tables */
11310 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11311 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11312 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11313 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11314 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11316 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11317 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11318 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11319 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11320 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11321 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11322 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11323 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11325 PL_sub_generation = proto_perl->Isub_generation;
11326 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11328 /* funky return mechanisms */
11329 PL_forkprocess = proto_perl->Iforkprocess;
11331 /* subprocess state */
11332 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11334 /* internal state */
11335 PL_maxo = proto_perl->Imaxo;
11336 if (proto_perl->Iop_mask)
11337 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11340 /* PL_asserting = proto_perl->Iasserting; */
11342 /* current interpreter roots */
11343 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11345 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11347 PL_main_start = proto_perl->Imain_start;
11348 PL_eval_root = proto_perl->Ieval_root;
11349 PL_eval_start = proto_perl->Ieval_start;
11351 /* runtime control stuff */
11352 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11354 PL_filemode = proto_perl->Ifilemode;
11355 PL_lastfd = proto_perl->Ilastfd;
11356 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11359 PL_gensym = proto_perl->Igensym;
11360 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11361 PL_laststatval = proto_perl->Ilaststatval;
11362 PL_laststype = proto_perl->Ilaststype;
11365 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11367 /* interpreter atexit processing */
11368 PL_exitlistlen = proto_perl->Iexitlistlen;
11369 if (PL_exitlistlen) {
11370 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11371 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11374 PL_exitlist = (PerlExitListEntry*)NULL;
11376 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11377 if (PL_my_cxt_size) {
11378 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11379 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11380 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11381 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11382 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11386 PL_my_cxt_list = (void**)NULL;
11387 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11388 PL_my_cxt_keys = (const char**)NULL;
11391 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11392 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11393 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11395 PL_profiledata = NULL;
11397 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11399 PAD_CLONE_VARS(proto_perl, param);
11401 #ifdef HAVE_INTERP_INTERN
11402 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11405 /* more statics moved here */
11406 PL_generation = proto_perl->Igeneration;
11407 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11409 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11410 PL_in_clean_all = proto_perl->Iin_clean_all;
11412 PL_uid = proto_perl->Iuid;
11413 PL_euid = proto_perl->Ieuid;
11414 PL_gid = proto_perl->Igid;
11415 PL_egid = proto_perl->Iegid;
11416 PL_nomemok = proto_perl->Inomemok;
11417 PL_an = proto_perl->Ian;
11418 PL_evalseq = proto_perl->Ievalseq;
11419 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11420 PL_origalen = proto_perl->Iorigalen;
11421 #ifdef PERL_USES_PL_PIDSTATUS
11422 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11424 PL_osname = SAVEPV(proto_perl->Iosname);
11425 PL_sighandlerp = proto_perl->Isighandlerp;
11427 PL_runops = proto_perl->Irunops;
11429 PL_parser = parser_dup(proto_perl->Iparser, param);
11431 PL_subline = proto_perl->Isubline;
11432 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11435 PL_cryptseen = proto_perl->Icryptseen;
11438 PL_hints = proto_perl->Ihints;
11440 PL_amagic_generation = proto_perl->Iamagic_generation;
11442 #ifdef USE_LOCALE_COLLATE
11443 PL_collation_ix = proto_perl->Icollation_ix;
11444 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11445 PL_collation_standard = proto_perl->Icollation_standard;
11446 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11447 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11448 #endif /* USE_LOCALE_COLLATE */
11450 #ifdef USE_LOCALE_NUMERIC
11451 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11452 PL_numeric_standard = proto_perl->Inumeric_standard;
11453 PL_numeric_local = proto_perl->Inumeric_local;
11454 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11455 #endif /* !USE_LOCALE_NUMERIC */
11457 /* utf8 character classes */
11458 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11459 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11460 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11461 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11462 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11463 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11464 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11465 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11466 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11467 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11468 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11469 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11470 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11471 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11472 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11473 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11474 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11475 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11476 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11477 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11479 /* Did the locale setup indicate UTF-8? */
11480 PL_utf8locale = proto_perl->Iutf8locale;
11481 /* Unicode features (see perlrun/-C) */
11482 PL_unicode = proto_perl->Iunicode;
11484 /* Pre-5.8 signals control */
11485 PL_signals = proto_perl->Isignals;
11487 /* times() ticks per second */
11488 PL_clocktick = proto_perl->Iclocktick;
11490 /* Recursion stopper for PerlIO_find_layer */
11491 PL_in_load_module = proto_perl->Iin_load_module;
11493 /* sort() routine */
11494 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11496 /* Not really needed/useful since the reenrant_retint is "volatile",
11497 * but do it for consistency's sake. */
11498 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11500 /* Hooks to shared SVs and locks. */
11501 PL_sharehook = proto_perl->Isharehook;
11502 PL_lockhook = proto_perl->Ilockhook;
11503 PL_unlockhook = proto_perl->Iunlockhook;
11504 PL_threadhook = proto_perl->Ithreadhook;
11505 PL_destroyhook = proto_perl->Idestroyhook;
11507 #ifdef THREADS_HAVE_PIDS
11508 PL_ppid = proto_perl->Ippid;
11512 PL_last_swash_hv = NULL; /* reinits on demand */
11513 PL_last_swash_klen = 0;
11514 PL_last_swash_key[0]= '\0';
11515 PL_last_swash_tmps = (U8*)NULL;
11516 PL_last_swash_slen = 0;
11518 PL_glob_index = proto_perl->Iglob_index;
11519 PL_srand_called = proto_perl->Isrand_called;
11520 PL_bitcount = NULL; /* reinits on demand */
11522 if (proto_perl->Ipsig_pend) {
11523 Newxz(PL_psig_pend, SIG_SIZE, int);
11526 PL_psig_pend = (int*)NULL;
11529 if (proto_perl->Ipsig_ptr) {
11530 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11531 Newxz(PL_psig_name, SIG_SIZE, SV*);
11532 for (i = 1; i < SIG_SIZE; i++) {
11533 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11534 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11538 PL_psig_ptr = (SV**)NULL;
11539 PL_psig_name = (SV**)NULL;
11542 /* intrpvar.h stuff */
11544 if (flags & CLONEf_COPY_STACKS) {
11545 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11546 PL_tmps_ix = proto_perl->Itmps_ix;
11547 PL_tmps_max = proto_perl->Itmps_max;
11548 PL_tmps_floor = proto_perl->Itmps_floor;
11549 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11551 while (i <= PL_tmps_ix) {
11552 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11556 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11557 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11558 Newxz(PL_markstack, i, I32);
11559 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11560 - proto_perl->Imarkstack);
11561 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11562 - proto_perl->Imarkstack);
11563 Copy(proto_perl->Imarkstack, PL_markstack,
11564 PL_markstack_ptr - PL_markstack + 1, I32);
11566 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11567 * NOTE: unlike the others! */
11568 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11569 PL_scopestack_max = proto_perl->Iscopestack_max;
11570 Newxz(PL_scopestack, PL_scopestack_max, I32);
11571 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11573 /* NOTE: si_dup() looks at PL_markstack */
11574 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11576 /* PL_curstack = PL_curstackinfo->si_stack; */
11577 PL_curstack = av_dup(proto_perl->Icurstack, param);
11578 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11580 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11581 PL_stack_base = AvARRAY(PL_curstack);
11582 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11583 - proto_perl->Istack_base);
11584 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11586 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11587 * NOTE: unlike the others! */
11588 PL_savestack_ix = proto_perl->Isavestack_ix;
11589 PL_savestack_max = proto_perl->Isavestack_max;
11590 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11591 PL_savestack = ss_dup(proto_perl, param);
11595 ENTER; /* perl_destruct() wants to LEAVE; */
11597 /* although we're not duplicating the tmps stack, we should still
11598 * add entries for any SVs on the tmps stack that got cloned by a
11599 * non-refcount means (eg a temp in @_); otherwise they will be
11602 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11603 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11604 proto_perl->Itmps_stack[i]);
11605 if (nsv && !SvREFCNT(nsv)) {
11607 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11612 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11613 PL_top_env = &PL_start_env;
11615 PL_op = proto_perl->Iop;
11618 PL_Xpv = (XPV*)NULL;
11619 my_perl->Ina = proto_perl->Ina;
11621 PL_statbuf = proto_perl->Istatbuf;
11622 PL_statcache = proto_perl->Istatcache;
11623 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11624 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11626 PL_timesbuf = proto_perl->Itimesbuf;
11629 PL_tainted = proto_perl->Itainted;
11630 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11631 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11632 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11633 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11634 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11635 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11636 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11637 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11638 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11640 PL_restartop = proto_perl->Irestartop;
11641 PL_in_eval = proto_perl->Iin_eval;
11642 PL_delaymagic = proto_perl->Idelaymagic;
11643 PL_dirty = proto_perl->Idirty;
11644 PL_localizing = proto_perl->Ilocalizing;
11646 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11647 PL_hv_fetch_ent_mh = NULL;
11648 PL_modcount = proto_perl->Imodcount;
11649 PL_lastgotoprobe = NULL;
11650 PL_dumpindent = proto_perl->Idumpindent;
11652 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11653 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11654 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11655 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11656 PL_efloatbuf = NULL; /* reinits on demand */
11657 PL_efloatsize = 0; /* reinits on demand */
11661 PL_screamfirst = NULL;
11662 PL_screamnext = NULL;
11663 PL_maxscream = -1; /* reinits on demand */
11664 PL_lastscream = NULL;
11667 PL_regdummy = proto_perl->Iregdummy;
11668 PL_colorset = 0; /* reinits PL_colors[] */
11669 /*PL_colors[6] = {0,0,0,0,0,0};*/
11673 /* Pluggable optimizer */
11674 PL_peepp = proto_perl->Ipeepp;
11676 PL_stashcache = newHV();
11678 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11679 proto_perl->Iwatchaddr);
11680 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11681 if (PL_debug && PL_watchaddr) {
11682 PerlIO_printf(Perl_debug_log,
11683 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11684 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11685 PTR2UV(PL_watchok));
11688 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11689 ptr_table_free(PL_ptr_table);
11690 PL_ptr_table = NULL;
11693 /* Call the ->CLONE method, if it exists, for each of the stashes
11694 identified by sv_dup() above.
11696 while(av_len(param->stashes) != -1) {
11697 HV* const stash = (HV*) av_shift(param->stashes);
11698 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11699 if (cloner && GvCV(cloner)) {
11704 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11706 call_sv((SV*)GvCV(cloner), G_DISCARD);
11712 SvREFCNT_dec(param->stashes);
11714 /* orphaned? eg threads->new inside BEGIN or use */
11715 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11716 SvREFCNT_inc_simple_void(PL_compcv);
11717 SAVEFREESV(PL_compcv);
11723 #endif /* USE_ITHREADS */
11726 =head1 Unicode Support
11728 =for apidoc sv_recode_to_utf8
11730 The encoding is assumed to be an Encode object, on entry the PV
11731 of the sv is assumed to be octets in that encoding, and the sv
11732 will be converted into Unicode (and UTF-8).
11734 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11735 is not a reference, nothing is done to the sv. If the encoding is not
11736 an C<Encode::XS> Encoding object, bad things will happen.
11737 (See F<lib/encoding.pm> and L<Encode>).
11739 The PV of the sv is returned.
11744 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11747 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11761 Passing sv_yes is wrong - it needs to be or'ed set of constants
11762 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11763 remove converted chars from source.
11765 Both will default the value - let them.
11767 XPUSHs(&PL_sv_yes);
11770 call_method("decode", G_SCALAR);
11774 s = SvPV_const(uni, len);
11775 if (s != SvPVX_const(sv)) {
11776 SvGROW(sv, len + 1);
11777 Move(s, SvPVX(sv), len + 1, char);
11778 SvCUR_set(sv, len);
11785 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11789 =for apidoc sv_cat_decode
11791 The encoding is assumed to be an Encode object, the PV of the ssv is
11792 assumed to be octets in that encoding and decoding the input starts
11793 from the position which (PV + *offset) pointed to. The dsv will be
11794 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11795 when the string tstr appears in decoding output or the input ends on
11796 the PV of the ssv. The value which the offset points will be modified
11797 to the last input position on the ssv.
11799 Returns TRUE if the terminator was found, else returns FALSE.
11804 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11805 SV *ssv, int *offset, char *tstr, int tlen)
11809 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11820 offsv = newSViv(*offset);
11822 mXPUSHp(tstr, tlen);
11824 call_method("cat_decode", G_SCALAR);
11826 ret = SvTRUE(TOPs);
11827 *offset = SvIV(offsv);
11833 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11838 /* ---------------------------------------------------------------------
11840 * support functions for report_uninit()
11843 /* the maxiumum size of array or hash where we will scan looking
11844 * for the undefined element that triggered the warning */
11846 #define FUV_MAX_SEARCH_SIZE 1000
11848 /* Look for an entry in the hash whose value has the same SV as val;
11849 * If so, return a mortal copy of the key. */
11852 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11855 register HE **array;
11858 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11859 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11862 array = HvARRAY(hv);
11864 for (i=HvMAX(hv); i>0; i--) {
11865 register HE *entry;
11866 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11867 if (HeVAL(entry) != val)
11869 if ( HeVAL(entry) == &PL_sv_undef ||
11870 HeVAL(entry) == &PL_sv_placeholder)
11874 if (HeKLEN(entry) == HEf_SVKEY)
11875 return sv_mortalcopy(HeKEY_sv(entry));
11876 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11882 /* Look for an entry in the array whose value has the same SV as val;
11883 * If so, return the index, otherwise return -1. */
11886 S_find_array_subscript(pTHX_ AV *av, SV* val)
11889 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11890 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11893 if (val != &PL_sv_undef) {
11894 SV ** const svp = AvARRAY(av);
11897 for (i=AvFILLp(av); i>=0; i--)
11904 /* S_varname(): return the name of a variable, optionally with a subscript.
11905 * If gv is non-zero, use the name of that global, along with gvtype (one
11906 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11907 * targ. Depending on the value of the subscript_type flag, return:
11910 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11911 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11912 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11913 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11916 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11917 SV* keyname, I32 aindex, int subscript_type)
11920 SV * const name = sv_newmortal();
11923 buffer[0] = gvtype;
11926 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11928 gv_fullname4(name, gv, buffer, 0);
11930 if ((unsigned int)SvPVX(name)[1] <= 26) {
11932 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11934 /* Swap the 1 unprintable control character for the 2 byte pretty
11935 version - ie substr($name, 1, 1) = $buffer; */
11936 sv_insert(name, 1, 1, buffer, 2);
11940 CV * const cv = find_runcv(NULL);
11944 if (!cv || !CvPADLIST(cv))
11946 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11947 sv = *av_fetch(av, targ, FALSE);
11948 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11951 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11952 SV * const sv = newSV(0);
11953 *SvPVX(name) = '$';
11954 Perl_sv_catpvf(aTHX_ name, "{%s}",
11955 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11958 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11959 *SvPVX(name) = '$';
11960 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11962 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11963 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11970 =for apidoc find_uninit_var
11972 Find the name of the undefined variable (if any) that caused the operator o
11973 to issue a "Use of uninitialized value" warning.
11974 If match is true, only return a name if it's value matches uninit_sv.
11975 So roughly speaking, if a unary operator (such as OP_COS) generates a
11976 warning, then following the direct child of the op may yield an
11977 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11978 other hand, with OP_ADD there are two branches to follow, so we only print
11979 the variable name if we get an exact match.
11981 The name is returned as a mortal SV.
11983 Assumes that PL_op is the op that originally triggered the error, and that
11984 PL_comppad/PL_curpad points to the currently executing pad.
11990 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11998 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11999 uninit_sv == &PL_sv_placeholder)))
12002 switch (obase->op_type) {
12009 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12010 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12013 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12015 if (pad) { /* @lex, %lex */
12016 sv = PAD_SVl(obase->op_targ);
12020 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12021 /* @global, %global */
12022 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12025 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12027 else /* @{expr}, %{expr} */
12028 return find_uninit_var(cUNOPx(obase)->op_first,
12032 /* attempt to find a match within the aggregate */
12034 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12036 subscript_type = FUV_SUBSCRIPT_HASH;
12039 index = find_array_subscript((AV*)sv, uninit_sv);
12041 subscript_type = FUV_SUBSCRIPT_ARRAY;
12044 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12047 return varname(gv, hash ? '%' : '@', obase->op_targ,
12048 keysv, index, subscript_type);
12052 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12054 return varname(NULL, '$', obase->op_targ,
12055 NULL, 0, FUV_SUBSCRIPT_NONE);
12058 gv = cGVOPx_gv(obase);
12059 if (!gv || (match && GvSV(gv) != uninit_sv))
12061 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12064 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12067 av = (AV*)PAD_SV(obase->op_targ);
12068 if (!av || SvRMAGICAL(av))
12070 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12071 if (!svp || *svp != uninit_sv)
12074 return varname(NULL, '$', obase->op_targ,
12075 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12078 gv = cGVOPx_gv(obase);
12084 if (!av || SvRMAGICAL(av))
12086 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12087 if (!svp || *svp != uninit_sv)
12090 return varname(gv, '$', 0,
12091 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12096 o = cUNOPx(obase)->op_first;
12097 if (!o || o->op_type != OP_NULL ||
12098 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12100 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12104 if (PL_op == obase)
12105 /* $a[uninit_expr] or $h{uninit_expr} */
12106 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12109 o = cBINOPx(obase)->op_first;
12110 kid = cBINOPx(obase)->op_last;
12112 /* get the av or hv, and optionally the gv */
12114 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12115 sv = PAD_SV(o->op_targ);
12117 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12118 && cUNOPo->op_first->op_type == OP_GV)
12120 gv = cGVOPx_gv(cUNOPo->op_first);
12123 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12128 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12129 /* index is constant */
12133 if (obase->op_type == OP_HELEM) {
12134 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12135 if (!he || HeVAL(he) != uninit_sv)
12139 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12140 if (!svp || *svp != uninit_sv)
12144 if (obase->op_type == OP_HELEM)
12145 return varname(gv, '%', o->op_targ,
12146 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12148 return varname(gv, '@', o->op_targ, NULL,
12149 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12152 /* index is an expression;
12153 * attempt to find a match within the aggregate */
12154 if (obase->op_type == OP_HELEM) {
12155 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12157 return varname(gv, '%', o->op_targ,
12158 keysv, 0, FUV_SUBSCRIPT_HASH);
12161 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12163 return varname(gv, '@', o->op_targ,
12164 NULL, index, FUV_SUBSCRIPT_ARRAY);
12169 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12171 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12176 /* only examine RHS */
12177 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12180 o = cUNOPx(obase)->op_first;
12181 if (o->op_type == OP_PUSHMARK)
12184 if (!o->op_sibling) {
12185 /* one-arg version of open is highly magical */
12187 if (o->op_type == OP_GV) { /* open FOO; */
12189 if (match && GvSV(gv) != uninit_sv)
12191 return varname(gv, '$', 0,
12192 NULL, 0, FUV_SUBSCRIPT_NONE);
12194 /* other possibilities not handled are:
12195 * open $x; or open my $x; should return '${*$x}'
12196 * open expr; should return '$'.expr ideally
12202 /* ops where $_ may be an implicit arg */
12206 if ( !(obase->op_flags & OPf_STACKED)) {
12207 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12208 ? PAD_SVl(obase->op_targ)
12211 sv = sv_newmortal();
12212 sv_setpvn(sv, "$_", 2);
12221 /* skip filehandle as it can't produce 'undef' warning */
12222 o = cUNOPx(obase)->op_first;
12223 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12224 o = o->op_sibling->op_sibling;
12230 match = 1; /* XS or custom code could trigger random warnings */
12235 /* XXX tmp hack: these two may call an XS sub, and currently
12236 XS subs don't have a SUB entry on the context stack, so CV and
12237 pad determination goes wrong, and BAD things happen. So, just
12238 don't try to determine the value under those circumstances.
12239 Need a better fix at dome point. DAPM 11/2007 */
12243 /* def-ness of rval pos() is independent of the def-ness of its arg */
12244 if ( !(obase->op_flags & OPf_MOD))
12249 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12250 return newSVpvs_flags("${$/}", SVs_TEMP);
12255 if (!(obase->op_flags & OPf_KIDS))
12257 o = cUNOPx(obase)->op_first;
12263 /* if all except one arg are constant, or have no side-effects,
12264 * or are optimized away, then it's unambiguous */
12266 for (kid=o; kid; kid = kid->op_sibling) {
12268 const OPCODE type = kid->op_type;
12269 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12270 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12271 || (type == OP_PUSHMARK)
12275 if (o2) { /* more than one found */
12282 return find_uninit_var(o2, uninit_sv, match);
12284 /* scan all args */
12286 sv = find_uninit_var(o, uninit_sv, 1);
12298 =for apidoc report_uninit
12300 Print appropriate "Use of uninitialized variable" warning
12306 Perl_report_uninit(pTHX_ SV* uninit_sv)
12310 SV* varname = NULL;
12312 varname = find_uninit_var(PL_op, uninit_sv,0);
12314 sv_insert(varname, 0, 0, " ", 1);
12316 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12317 varname ? SvPV_nolen_const(varname) : "",
12318 " in ", OP_DESC(PL_op));
12321 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12327 * c-indentation-style: bsd
12328 * c-basic-offset: 4
12329 * indent-tabs-mode: t
12332 * ex: set ts=8 sts=4 sw=4 noet: