3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* if adding more checks watch out for the following tests:
34 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
35 * lib/utf8.t lib/Unicode/Collate/t/index.t
38 # define ASSERT_UTF8_CACHE(cache) \
39 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); \
40 assert((cache)[2] <= (cache)[3]); \
41 assert((cache)[3] <= (cache)[1]);} \
44 # define ASSERT_UTF8_CACHE(cache) NOOP
47 #ifdef PERL_OLD_COPY_ON_WRITE
48 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
49 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
50 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
54 /* ============================================================================
56 =head1 Allocation and deallocation of SVs.
58 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
59 sv, av, hv...) contains type and reference count information, and for
60 many types, a pointer to the body (struct xrv, xpv, xpviv...), which
61 contains fields specific to each type. Some types store all they need
62 in the head, so don't have a body.
64 In all but the most memory-paranoid configuations (ex: PURIFY), heads
65 and bodies are allocated out of arenas, which by default are
66 approximately 4K chunks of memory parcelled up into N heads or bodies.
67 Sv-bodies are allocated by their sv-type, guaranteeing size
68 consistency needed to allocate safely from arrays.
70 For SV-heads, the first slot in each arena is reserved, and holds a
71 link to the next arena, some flags, and a note of the number of slots.
72 Snaked through each arena chain is a linked list of free items; when
73 this becomes empty, an extra arena is allocated and divided up into N
74 items which are threaded into the free list.
76 SV-bodies are similar, but they use arena-sets by default, which
77 separate the link and info from the arena itself, and reclaim the 1st
78 slot in the arena. SV-bodies are further described later.
80 The following global variables are associated with arenas:
82 PL_sv_arenaroot pointer to list of SV arenas
83 PL_sv_root pointer to list of free SV structures
85 PL_body_arenas head of linked-list of body arenas
86 PL_body_roots[] array of pointers to list of free bodies of svtype
87 arrays are indexed by the svtype needed
89 A few special SV heads are not allocated from an arena, but are
90 instead directly created in the interpreter structure, eg PL_sv_undef.
91 The size of arenas can be changed from the default by setting
92 PERL_ARENA_SIZE appropriately at compile time.
94 The SV arena serves the secondary purpose of allowing still-live SVs
95 to be located and destroyed during final cleanup.
97 At the lowest level, the macros new_SV() and del_SV() grab and free
98 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
99 to return the SV to the free list with error checking.) new_SV() calls
100 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
101 SVs in the free list have their SvTYPE field set to all ones.
103 At the time of very final cleanup, sv_free_arenas() is called from
104 perl_destruct() to physically free all the arenas allocated since the
105 start of the interpreter.
107 The function visit() scans the SV arenas list, and calls a specified
108 function for each SV it finds which is still live - ie which has an SvTYPE
109 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
110 following functions (specified as [function that calls visit()] / [function
111 called by visit() for each SV]):
113 sv_report_used() / do_report_used()
114 dump all remaining SVs (debugging aid)
116 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
117 Attempt to free all objects pointed to by RVs,
118 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
119 try to do the same for all objects indirectly
120 referenced by typeglobs too. Called once from
121 perl_destruct(), prior to calling sv_clean_all()
124 sv_clean_all() / do_clean_all()
125 SvREFCNT_dec(sv) each remaining SV, possibly
126 triggering an sv_free(). It also sets the
127 SVf_BREAK flag on the SV to indicate that the
128 refcnt has been artificially lowered, and thus
129 stopping sv_free() from giving spurious warnings
130 about SVs which unexpectedly have a refcnt
131 of zero. called repeatedly from perl_destruct()
132 until there are no SVs left.
134 =head2 Arena allocator API Summary
136 Private API to rest of sv.c
140 new_XIV(), del_XIV(),
141 new_XNV(), del_XNV(),
146 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
150 ============================================================================ */
153 * "A time to plant, and a time to uproot what was planted..."
157 Perl_offer_nice_chunk(pTHX_ void *chunk, U32 chunk_size)
162 new_chunk = (void *)(chunk);
163 new_chunk_size = (chunk_size);
164 if (new_chunk_size > PL_nice_chunk_size) {
165 Safefree(PL_nice_chunk);
166 PL_nice_chunk = (char *) new_chunk;
167 PL_nice_chunk_size = new_chunk_size;
173 #ifdef DEBUG_LEAKING_SCALARS
174 # define FREE_SV_DEBUG_FILE(sv) Safefree((sv)->sv_debug_file)
176 # define FREE_SV_DEBUG_FILE(sv)
180 # define SvARENA_CHAIN(sv) ((sv)->sv_u.svu_rv)
181 /* Whilst I'd love to do this, it seems that things like to check on
183 # define POSION_SV_HEAD(sv) PoisonNew(sv, 1, struct STRUCT_SV)
185 # define POSION_SV_HEAD(sv) PoisonNew(&SvANY(sv), 1, void *), \
186 PoisonNew(&SvREFCNT(sv), 1, U32)
188 # define SvARENA_CHAIN(sv) SvANY(sv)
189 # define POSION_SV_HEAD(sv)
192 #define plant_SV(p) \
194 FREE_SV_DEBUG_FILE(p); \
196 SvARENA_CHAIN(p) = (void *)PL_sv_root; \
197 SvFLAGS(p) = SVTYPEMASK; \
202 #define uproot_SV(p) \
205 PL_sv_root = (SV*)SvARENA_CHAIN(p); \
210 /* make some more SVs by adding another arena */
219 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
220 PL_nice_chunk = NULL;
221 PL_nice_chunk_size = 0;
224 char *chunk; /* must use New here to match call to */
225 Newx(chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
226 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
232 /* new_SV(): return a new, empty SV head */
234 #ifdef DEBUG_LEAKING_SCALARS
235 /* provide a real function for a debugger to play with */
244 sv = S_more_sv(aTHX);
248 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
249 sv->sv_debug_line = (U16) (PL_parser
250 ? PL_parser->copline == NOLINE
256 sv->sv_debug_inpad = 0;
257 sv->sv_debug_cloned = 0;
258 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
262 # define new_SV(p) (p)=S_new_SV(aTHX)
270 (p) = S_more_sv(aTHX); \
278 /* del_SV(): return an empty SV head to the free list */
291 S_del_sv(pTHX_ SV *p)
297 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
298 const SV * const sv = sva + 1;
299 const SV * const svend = &sva[SvREFCNT(sva)];
300 if (p >= sv && p < svend) {
306 if (ckWARN_d(WARN_INTERNAL))
307 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
308 "Attempt to free non-arena SV: 0x%"UVxf
309 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
316 #else /* ! DEBUGGING */
318 #define del_SV(p) plant_SV(p)
320 #endif /* DEBUGGING */
324 =head1 SV Manipulation Functions
326 =for apidoc sv_add_arena
328 Given a chunk of memory, link it to the head of the list of arenas,
329 and split it into a list of free SVs.
335 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
338 SV* const sva = (SV*)ptr;
342 /* The first SV in an arena isn't an SV. */
343 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
344 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
345 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
347 PL_sv_arenaroot = sva;
348 PL_sv_root = sva + 1;
350 svend = &sva[SvREFCNT(sva) - 1];
353 SvARENA_CHAIN(sv) = (void *)(SV*)(sv + 1);
357 /* Must always set typemask because it's always checked in on cleanup
358 when the arenas are walked looking for objects. */
359 SvFLAGS(sv) = SVTYPEMASK;
362 SvARENA_CHAIN(sv) = 0;
366 SvFLAGS(sv) = SVTYPEMASK;
369 /* visit(): call the named function for each non-free SV in the arenas
370 * whose flags field matches the flags/mask args. */
373 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
379 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
380 register const SV * const svend = &sva[SvREFCNT(sva)];
382 for (sv = sva + 1; sv < svend; ++sv) {
383 if (SvTYPE(sv) != SVTYPEMASK
384 && (sv->sv_flags & mask) == flags
397 /* called by sv_report_used() for each live SV */
400 do_report_used(pTHX_ SV *sv)
402 if (SvTYPE(sv) != SVTYPEMASK) {
403 PerlIO_printf(Perl_debug_log, "****\n");
410 =for apidoc sv_report_used
412 Dump the contents of all SVs not yet freed. (Debugging aid).
418 Perl_sv_report_used(pTHX)
421 visit(do_report_used, 0, 0);
427 /* called by sv_clean_objs() for each live SV */
430 do_clean_objs(pTHX_ SV *ref)
435 SV * const target = SvRV(ref);
436 if (SvOBJECT(target)) {
437 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(ref)));
438 if (SvWEAKREF(ref)) {
439 sv_del_backref(target, ref);
445 SvREFCNT_dec(target);
450 /* XXX Might want to check arrays, etc. */
453 /* called by sv_clean_objs() for each live SV */
455 #ifndef DISABLE_DESTRUCTOR_KLUDGE
457 do_clean_named_objs(pTHX_ SV *sv)
460 assert(SvTYPE(sv) == SVt_PVGV);
461 assert(isGV_with_GP(sv));
464 #ifdef PERL_DONT_CREATE_GVSV
467 SvOBJECT(GvSV(sv))) ||
468 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
469 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
470 /* In certain rare cases GvIOp(sv) can be NULL, which would make SvOBJECT(GvIO(sv)) dereference NULL. */
471 (GvIO(sv) ? (SvFLAGS(GvIOp(sv)) & SVs_OBJECT) : 0) ||
472 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
474 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
475 SvFLAGS(sv) |= SVf_BREAK;
483 =for apidoc sv_clean_objs
485 Attempt to destroy all objects not yet freed
491 Perl_sv_clean_objs(pTHX)
494 PL_in_clean_objs = TRUE;
495 visit(do_clean_objs, SVf_ROK, SVf_ROK);
496 #ifndef DISABLE_DESTRUCTOR_KLUDGE
497 /* some barnacles may yet remain, clinging to typeglobs */
498 visit(do_clean_named_objs, SVt_PVGV|SVpgv_GP, SVTYPEMASK|SVp_POK|SVpgv_GP);
500 PL_in_clean_objs = FALSE;
503 /* called by sv_clean_all() for each live SV */
506 do_clean_all(pTHX_ SV *sv)
509 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
510 SvFLAGS(sv) |= SVf_BREAK;
515 =for apidoc sv_clean_all
517 Decrement the refcnt of each remaining SV, possibly triggering a
518 cleanup. This function may have to be called multiple times to free
519 SVs which are in complex self-referential hierarchies.
525 Perl_sv_clean_all(pTHX)
529 PL_in_clean_all = TRUE;
530 cleaned = visit(do_clean_all, 0,0);
531 PL_in_clean_all = FALSE;
536 ARENASETS: a meta-arena implementation which separates arena-info
537 into struct arena_set, which contains an array of struct
538 arena_descs, each holding info for a single arena. By separating
539 the meta-info from the arena, we recover the 1st slot, formerly
540 borrowed for list management. The arena_set is about the size of an
541 arena, avoiding the needless malloc overhead of a naive linked-list.
543 The cost is 1 arena-set malloc per ~320 arena-mallocs, + the unused
544 memory in the last arena-set (1/2 on average). In trade, we get
545 back the 1st slot in each arena (ie 1.7% of a CV-arena, less for
546 smaller types). The recovery of the wasted space allows use of
547 small arenas for large, rare body types, by changing array* fields
548 in body_details_by_type[] below.
551 char *arena; /* the raw storage, allocated aligned */
552 size_t size; /* its size ~4k typ */
553 U32 misc; /* type, and in future other things. */
558 /* Get the maximum number of elements in set[] such that struct arena_set
559 will fit within PERL_ARENA_SIZE, which is probably just under 4K, and
560 therefore likely to be 1 aligned memory page. */
562 #define ARENAS_PER_SET ((PERL_ARENA_SIZE - sizeof(struct arena_set*) \
563 - 2 * sizeof(int)) / sizeof (struct arena_desc))
566 struct arena_set* next;
567 unsigned int set_size; /* ie ARENAS_PER_SET */
568 unsigned int curr; /* index of next available arena-desc */
569 struct arena_desc set[ARENAS_PER_SET];
573 =for apidoc sv_free_arenas
575 Deallocate the memory used by all arenas. Note that all the individual SV
576 heads and bodies within the arenas must already have been freed.
581 Perl_sv_free_arenas(pTHX)
588 /* Free arenas here, but be careful about fake ones. (We assume
589 contiguity of the fake ones with the corresponding real ones.) */
591 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
592 svanext = (SV*) SvANY(sva);
593 while (svanext && SvFAKE(svanext))
594 svanext = (SV*) SvANY(svanext);
601 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
604 struct arena_set *current = aroot;
607 assert(aroot->set[i].arena);
608 Safefree(aroot->set[i].arena);
616 i = PERL_ARENA_ROOTS_SIZE;
618 PL_body_roots[i] = 0;
620 Safefree(PL_nice_chunk);
621 PL_nice_chunk = NULL;
622 PL_nice_chunk_size = 0;
628 Here are mid-level routines that manage the allocation of bodies out
629 of the various arenas. There are 5 kinds of arenas:
631 1. SV-head arenas, which are discussed and handled above
632 2. regular body arenas
633 3. arenas for reduced-size bodies
635 5. pte arenas (thread related)
637 Arena types 2 & 3 are chained by body-type off an array of
638 arena-root pointers, which is indexed by svtype. Some of the
639 larger/less used body types are malloced singly, since a large
640 unused block of them is wasteful. Also, several svtypes dont have
641 bodies; the data fits into the sv-head itself. The arena-root
642 pointer thus has a few unused root-pointers (which may be hijacked
643 later for arena types 4,5)
645 3 differs from 2 as an optimization; some body types have several
646 unused fields in the front of the structure (which are kept in-place
647 for consistency). These bodies can be allocated in smaller chunks,
648 because the leading fields arent accessed. Pointers to such bodies
649 are decremented to point at the unused 'ghost' memory, knowing that
650 the pointers are used with offsets to the real memory.
652 HE, HEK arenas are managed separately, with separate code, but may
653 be merge-able later..
655 PTE arenas are not sv-bodies, but they share these mid-level
656 mechanics, so are considered here. The new mid-level mechanics rely
657 on the sv_type of the body being allocated, so we just reserve one
658 of the unused body-slots for PTEs, then use it in those (2) PTE
659 contexts below (line ~10k)
662 /* get_arena(size): this creates custom-sized arenas
663 TBD: export properly for hv.c: S_more_he().
666 Perl_get_arena(pTHX_ size_t arena_size, U32 misc)
669 struct arena_desc* adesc;
670 struct arena_set *aroot = (struct arena_set*) PL_body_arenas;
673 /* shouldnt need this
674 if (!arena_size) arena_size = PERL_ARENA_SIZE;
677 /* may need new arena-set to hold new arena */
678 if (!aroot || aroot->curr >= aroot->set_size) {
679 struct arena_set *newroot;
680 Newxz(newroot, 1, struct arena_set);
681 newroot->set_size = ARENAS_PER_SET;
682 newroot->next = aroot;
684 PL_body_arenas = (void *) newroot;
685 DEBUG_m(PerlIO_printf(Perl_debug_log, "new arenaset %p\n", (void*)aroot));
688 /* ok, now have arena-set with at least 1 empty/available arena-desc */
689 curr = aroot->curr++;
690 adesc = &(aroot->set[curr]);
691 assert(!adesc->arena);
693 Newx(adesc->arena, arena_size, char);
694 adesc->size = arena_size;
696 DEBUG_m(PerlIO_printf(Perl_debug_log, "arena %d added: %p size %"UVuf"\n",
697 curr, (void*)adesc->arena, (UV)arena_size));
703 /* return a thing to the free list */
705 #define del_body(thing, root) \
707 void ** const thing_copy = (void **)thing;\
708 *thing_copy = *root; \
709 *root = (void*)thing_copy; \
714 =head1 SV-Body Allocation
716 Allocation of SV-bodies is similar to SV-heads, differing as follows;
717 the allocation mechanism is used for many body types, so is somewhat
718 more complicated, it uses arena-sets, and has no need for still-live
721 At the outermost level, (new|del)_X*V macros return bodies of the
722 appropriate type. These macros call either (new|del)_body_type or
723 (new|del)_body_allocated macro pairs, depending on specifics of the
724 type. Most body types use the former pair, the latter pair is used to
725 allocate body types with "ghost fields".
727 "ghost fields" are fields that are unused in certain types, and
728 consequently dont need to actually exist. They are declared because
729 they're part of a "base type", which allows use of functions as
730 methods. The simplest examples are AVs and HVs, 2 aggregate types
731 which don't use the fields which support SCALAR semantics.
733 For these types, the arenas are carved up into *_allocated size
734 chunks, we thus avoid wasted memory for those unaccessed members.
735 When bodies are allocated, we adjust the pointer back in memory by the
736 size of the bit not allocated, so it's as if we allocated the full
737 structure. (But things will all go boom if you write to the part that
738 is "not there", because you'll be overwriting the last members of the
739 preceding structure in memory.)
741 We calculate the correction using the STRUCT_OFFSET macro. For
742 example, if xpv_allocated is the same structure as XPV then the two
743 OFFSETs sum to zero, and the pointer is unchanged. If the allocated
744 structure is smaller (no initial NV actually allocated) then the net
745 effect is to subtract the size of the NV from the pointer, to return a
746 new pointer as if an initial NV were actually allocated.
748 This is the same trick as was used for NV and IV bodies. Ironically it
749 doesn't need to be used for NV bodies any more, because NV is now at
750 the start of the structure. IV bodies don't need it either, because
751 they are no longer allocated.
753 In turn, the new_body_* allocators call S_new_body(), which invokes
754 new_body_inline macro, which takes a lock, and takes a body off the
755 linked list at PL_body_roots[sv_type], calling S_more_bodies() if
756 necessary to refresh an empty list. Then the lock is released, and
757 the body is returned.
759 S_more_bodies calls get_arena(), and carves it up into an array of N
760 bodies, which it strings into a linked list. It looks up arena-size
761 and body-size from the body_details table described below, thus
762 supporting the multiple body-types.
764 If PURIFY is defined, or PERL_ARENA_SIZE=0, arenas are not used, and
765 the (new|del)_X*V macros are mapped directly to malloc/free.
771 For each sv-type, struct body_details bodies_by_type[] carries
772 parameters which control these aspects of SV handling:
774 Arena_size determines whether arenas are used for this body type, and if
775 so, how big they are. PURIFY or PERL_ARENA_SIZE=0 set this field to
776 zero, forcing individual mallocs and frees.
778 Body_size determines how big a body is, and therefore how many fit into
779 each arena. Offset carries the body-pointer adjustment needed for
780 *_allocated body types, and is used in *_allocated macros.
782 But its main purpose is to parameterize info needed in
783 Perl_sv_upgrade(). The info here dramatically simplifies the function
784 vs the implementation in 5.8.7, making it table-driven. All fields
785 are used for this, except for arena_size.
787 For the sv-types that have no bodies, arenas are not used, so those
788 PL_body_roots[sv_type] are unused, and can be overloaded. In
789 something of a special case, SVt_NULL is borrowed for HE arenas;
790 PL_body_roots[HE_SVSLOT=SVt_NULL] is filled by S_more_he, but the
791 bodies_by_type[SVt_NULL] slot is not used, as the table is not
794 PTEs also use arenas, but are never seen in Perl_sv_upgrade. Nonetheless,
795 they get their own slot in bodies_by_type[PTE_SVSLOT =SVt_IV], so they can
796 just use the same allocation semantics. At first, PTEs were also
797 overloaded to a non-body sv-type, but this yielded hard-to-find malloc
798 bugs, so was simplified by claiming a new slot. This choice has no
799 consequence at this time.
803 struct body_details {
804 U8 body_size; /* Size to allocate */
805 U8 copy; /* Size of structure to copy (may be shorter) */
807 unsigned int type : 4; /* We have space for a sanity check. */
808 unsigned int cant_upgrade : 1; /* Cannot upgrade this type */
809 unsigned int zero_nv : 1; /* zero the NV when upgrading from this */
810 unsigned int arena : 1; /* Allocated from an arena */
811 size_t arena_size; /* Size of arena to allocate */
819 /* With -DPURFIY we allocate everything directly, and don't use arenas.
820 This seems a rather elegant way to simplify some of the code below. */
821 #define HASARENA FALSE
823 #define HASARENA TRUE
825 #define NOARENA FALSE
827 /* Size the arenas to exactly fit a given number of bodies. A count
828 of 0 fits the max number bodies into a PERL_ARENA_SIZE.block,
829 simplifying the default. If count > 0, the arena is sized to fit
830 only that many bodies, allowing arenas to be used for large, rare
831 bodies (XPVFM, XPVIO) without undue waste. The arena size is
832 limited by PERL_ARENA_SIZE, so we can safely oversize the
835 #define FIT_ARENA0(body_size) \
836 ((size_t)(PERL_ARENA_SIZE / body_size) * body_size)
837 #define FIT_ARENAn(count,body_size) \
838 ( count * body_size <= PERL_ARENA_SIZE) \
839 ? count * body_size \
840 : FIT_ARENA0 (body_size)
841 #define FIT_ARENA(count,body_size) \
843 ? FIT_ARENAn (count, body_size) \
844 : FIT_ARENA0 (body_size)
846 /* A macro to work out the offset needed to subtract from a pointer to (say)
853 to make its members accessible via a pointer to (say)
863 #define relative_STRUCT_OFFSET(longer, shorter, member) \
864 (STRUCT_OFFSET(shorter, member) - STRUCT_OFFSET(longer, member))
866 /* Calculate the length to copy. Specifically work out the length less any
867 final padding the compiler needed to add. See the comment in sv_upgrade
868 for why copying the padding proved to be a bug. */
870 #define copy_length(type, last_member) \
871 STRUCT_OFFSET(type, last_member) \
872 + sizeof (((type*)SvANY((SV*)0))->last_member)
874 static const struct body_details bodies_by_type[] = {
875 { sizeof(HE), 0, 0, SVt_NULL,
876 FALSE, NONV, NOARENA, FIT_ARENA(0, sizeof(HE)) },
878 /* The bind placeholder pretends to be an RV for now.
879 Also it's marked as "can't upgrade" to stop anyone using it before it's
881 { 0, 0, 0, SVt_BIND, TRUE, NONV, NOARENA, 0 },
883 /* IVs are in the head, so the allocation size is 0.
884 However, the slot is overloaded for PTEs. */
885 { sizeof(struct ptr_tbl_ent), /* This is used for PTEs. */
886 sizeof(IV), /* This is used to copy out the IV body. */
887 STRUCT_OFFSET(XPVIV, xiv_iv), SVt_IV, FALSE, NONV,
888 NOARENA /* IVS don't need an arena */,
889 /* But PTEs need to know the size of their arena */
890 FIT_ARENA(0, sizeof(struct ptr_tbl_ent))
893 /* 8 bytes on most ILP32 with IEEE doubles */
894 { sizeof(NV), sizeof(NV), 0, SVt_NV, FALSE, HADNV, HASARENA,
895 FIT_ARENA(0, sizeof(NV)) },
897 /* 8 bytes on most ILP32 with IEEE doubles */
898 { sizeof(xpv_allocated),
899 copy_length(XPV, xpv_len)
900 - relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
901 + relative_STRUCT_OFFSET(xpv_allocated, XPV, xpv_cur),
902 SVt_PV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpv_allocated)) },
905 { sizeof(xpviv_allocated),
906 copy_length(XPVIV, xiv_u)
907 - relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
908 + relative_STRUCT_OFFSET(xpviv_allocated, XPVIV, xpv_cur),
909 SVt_PVIV, FALSE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpviv_allocated)) },
912 { sizeof(XPVNV), copy_length(XPVNV, xiv_u), 0, SVt_PVNV, FALSE, HADNV,
913 HASARENA, FIT_ARENA(0, sizeof(XPVNV)) },
916 { sizeof(XPVMG), copy_length(XPVMG, xmg_stash), 0, SVt_PVMG, FALSE, HADNV,
917 HASARENA, FIT_ARENA(0, sizeof(XPVMG)) },
920 { sizeof(struct regexp_allocated), sizeof(struct regexp_allocated),
921 + relative_STRUCT_OFFSET(struct regexp_allocated, regexp, xpv_cur),
922 SVt_REGEXP, FALSE, NONV, HASARENA,
923 FIT_ARENA(0, sizeof(struct regexp_allocated))
927 { sizeof(XPVGV), sizeof(XPVGV), 0, SVt_PVGV, TRUE, HADNV,
928 HASARENA, FIT_ARENA(0, sizeof(XPVGV)) },
931 { sizeof(XPVLV), sizeof(XPVLV), 0, SVt_PVLV, TRUE, HADNV,
932 HASARENA, FIT_ARENA(0, sizeof(XPVLV)) },
934 { sizeof(xpvav_allocated),
935 copy_length(XPVAV, xmg_stash)
936 - relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
937 + relative_STRUCT_OFFSET(xpvav_allocated, XPVAV, xav_fill),
938 SVt_PVAV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvav_allocated)) },
940 { sizeof(xpvhv_allocated),
941 copy_length(XPVHV, xmg_stash)
942 - relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
943 + relative_STRUCT_OFFSET(xpvhv_allocated, XPVHV, xhv_fill),
944 SVt_PVHV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvhv_allocated)) },
947 { sizeof(xpvcv_allocated), sizeof(xpvcv_allocated),
948 + relative_STRUCT_OFFSET(xpvcv_allocated, XPVCV, xpv_cur),
949 SVt_PVCV, TRUE, NONV, HASARENA, FIT_ARENA(0, sizeof(xpvcv_allocated)) },
951 { sizeof(xpvfm_allocated), sizeof(xpvfm_allocated),
952 + relative_STRUCT_OFFSET(xpvfm_allocated, XPVFM, xpv_cur),
953 SVt_PVFM, TRUE, NONV, NOARENA, FIT_ARENA(20, sizeof(xpvfm_allocated)) },
955 /* XPVIO is 84 bytes, fits 48x */
956 { sizeof(XPVIO), sizeof(XPVIO), 0, SVt_PVIO, TRUE, HADNV,
957 HASARENA, FIT_ARENA(24, sizeof(XPVIO)) },
960 #define new_body_type(sv_type) \
961 (void *)((char *)S_new_body(aTHX_ sv_type))
963 #define del_body_type(p, sv_type) \
964 del_body(p, &PL_body_roots[sv_type])
967 #define new_body_allocated(sv_type) \
968 (void *)((char *)S_new_body(aTHX_ sv_type) \
969 - bodies_by_type[sv_type].offset)
971 #define del_body_allocated(p, sv_type) \
972 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
975 #define my_safemalloc(s) (void*)safemalloc(s)
976 #define my_safecalloc(s) (void*)safecalloc(s, 1)
977 #define my_safefree(p) safefree((char*)p)
981 #define new_XNV() my_safemalloc(sizeof(XPVNV))
982 #define del_XNV(p) my_safefree(p)
984 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
985 #define del_XPVNV(p) my_safefree(p)
987 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
988 #define del_XPVAV(p) my_safefree(p)
990 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
991 #define del_XPVHV(p) my_safefree(p)
993 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
994 #define del_XPVMG(p) my_safefree(p)
996 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
997 #define del_XPVGV(p) my_safefree(p)
1001 #define new_XNV() new_body_type(SVt_NV)
1002 #define del_XNV(p) del_body_type(p, SVt_NV)
1004 #define new_XPVNV() new_body_type(SVt_PVNV)
1005 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1007 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1008 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1010 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1011 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1013 #define new_XPVMG() new_body_type(SVt_PVMG)
1014 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1016 #define new_XPVGV() new_body_type(SVt_PVGV)
1017 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1021 /* no arena for you! */
1023 #define new_NOARENA(details) \
1024 my_safemalloc((details)->body_size + (details)->offset)
1025 #define new_NOARENAZ(details) \
1026 my_safecalloc((details)->body_size + (details)->offset)
1029 S_more_bodies (pTHX_ svtype sv_type)
1032 void ** const root = &PL_body_roots[sv_type];
1033 const struct body_details * const bdp = &bodies_by_type[sv_type];
1034 const size_t body_size = bdp->body_size;
1037 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1038 static bool done_sanity_check;
1040 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1041 * variables like done_sanity_check. */
1042 if (!done_sanity_check) {
1043 unsigned int i = SVt_LAST;
1045 done_sanity_check = TRUE;
1048 assert (bodies_by_type[i].type == i);
1052 assert(bdp->arena_size);
1054 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1056 end = start + bdp->arena_size - body_size;
1058 /* computed count doesnt reflect the 1st slot reservation */
1059 DEBUG_m(PerlIO_printf(Perl_debug_log,
1060 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1061 (void*)start, (void*)end,
1062 (int)bdp->arena_size, sv_type, (int)body_size,
1063 (int)bdp->arena_size / (int)body_size));
1065 *root = (void *)start;
1067 while (start < end) {
1068 char * const next = start + body_size;
1069 *(void**) start = (void *)next;
1072 *(void **)start = 0;
1077 /* grab a new thing from the free list, allocating more if necessary.
1078 The inline version is used for speed in hot routines, and the
1079 function using it serves the rest (unless PURIFY).
1081 #define new_body_inline(xpv, sv_type) \
1083 void ** const r3wt = &PL_body_roots[sv_type]; \
1084 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1085 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1086 *(r3wt) = *(void**)(xpv); \
1092 S_new_body(pTHX_ svtype sv_type)
1096 new_body_inline(xpv, sv_type);
1102 static const struct body_details fake_rv =
1103 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1106 =for apidoc sv_upgrade
1108 Upgrade an SV to a more complex form. Generally adds a new body type to the
1109 SV, then copies across as much information as possible from the old body.
1110 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1116 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1121 const svtype old_type = SvTYPE(sv);
1122 const struct body_details *new_type_details;
1123 const struct body_details *old_type_details
1124 = bodies_by_type + old_type;
1125 SV *referant = NULL;
1127 if (new_type != SVt_PV && SvIsCOW(sv)) {
1128 sv_force_normal_flags(sv, 0);
1131 if (old_type == new_type)
1134 old_body = SvANY(sv);
1136 /* Copying structures onto other structures that have been neatly zeroed
1137 has a subtle gotcha. Consider XPVMG
1139 +------+------+------+------+------+-------+-------+
1140 | NV | CUR | LEN | IV | MAGIC | STASH |
1141 +------+------+------+------+------+-------+-------+
1142 0 4 8 12 16 20 24 28
1144 where NVs are aligned to 8 bytes, so that sizeof that structure is
1145 actually 32 bytes long, with 4 bytes of padding at the end:
1147 +------+------+------+------+------+-------+-------+------+
1148 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1149 +------+------+------+------+------+-------+-------+------+
1150 0 4 8 12 16 20 24 28 32
1152 so what happens if you allocate memory for this structure:
1154 +------+------+------+------+------+-------+-------+------+------+...
1155 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1156 +------+------+------+------+------+-------+-------+------+------+...
1157 0 4 8 12 16 20 24 28 32 36
1159 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1160 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1161 started out as zero once, but it's quite possible that it isn't. So now,
1162 rather than a nicely zeroed GP, you have it pointing somewhere random.
1165 (In fact, GP ends up pointing at a previous GP structure, because the
1166 principle cause of the padding in XPVMG getting garbage is a copy of
1167 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1168 this happens to be moot because XPVGV has been re-ordered, with GP
1169 no longer after STASH)
1171 So we are careful and work out the size of used parts of all the
1179 referant = SvRV(sv);
1180 old_type_details = &fake_rv;
1181 if (new_type == SVt_NV)
1182 new_type = SVt_PVNV;
1184 if (new_type < SVt_PVIV) {
1185 new_type = (new_type == SVt_NV)
1186 ? SVt_PVNV : SVt_PVIV;
1191 if (new_type < SVt_PVNV) {
1192 new_type = SVt_PVNV;
1196 assert(new_type > SVt_PV);
1197 assert(SVt_IV < SVt_PV);
1198 assert(SVt_NV < SVt_PV);
1205 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1206 there's no way that it can be safely upgraded, because perl.c
1207 expects to Safefree(SvANY(PL_mess_sv)) */
1208 assert(sv != PL_mess_sv);
1209 /* This flag bit is used to mean other things in other scalar types.
1210 Given that it only has meaning inside the pad, it shouldn't be set
1211 on anything that can get upgraded. */
1212 assert(!SvPAD_TYPED(sv));
1215 if (old_type_details->cant_upgrade)
1216 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1217 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1220 if (old_type > new_type)
1221 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1222 (int)old_type, (int)new_type);
1224 new_type_details = bodies_by_type + new_type;
1226 SvFLAGS(sv) &= ~SVTYPEMASK;
1227 SvFLAGS(sv) |= new_type;
1229 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1230 the return statements above will have triggered. */
1231 assert (new_type != SVt_NULL);
1234 assert(old_type == SVt_NULL);
1235 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1239 assert(old_type == SVt_NULL);
1240 SvANY(sv) = new_XNV();
1245 assert(new_type_details->body_size);
1248 assert(new_type_details->arena);
1249 assert(new_type_details->arena_size);
1250 /* This points to the start of the allocated area. */
1251 new_body_inline(new_body, new_type);
1252 Zero(new_body, new_type_details->body_size, char);
1253 new_body = ((char *)new_body) - new_type_details->offset;
1255 /* We always allocated the full length item with PURIFY. To do this
1256 we fake things so that arena is false for all 16 types.. */
1257 new_body = new_NOARENAZ(new_type_details);
1259 SvANY(sv) = new_body;
1260 if (new_type == SVt_PVAV) {
1264 if (old_type_details->body_size) {
1267 /* It will have been zeroed when the new body was allocated.
1268 Lets not write to it, in case it confuses a write-back
1274 #ifndef NODEFAULT_SHAREKEYS
1275 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1277 HvMAX(sv) = 7; /* (start with 8 buckets) */
1278 if (old_type_details->body_size) {
1281 /* It will have been zeroed when the new body was allocated.
1282 Lets not write to it, in case it confuses a write-back
1287 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1288 The target created by newSVrv also is, and it can have magic.
1289 However, it never has SvPVX set.
1291 if (old_type == SVt_IV) {
1293 } else if (old_type >= SVt_PV) {
1294 assert(SvPVX_const(sv) == 0);
1297 if (old_type >= SVt_PVMG) {
1298 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1299 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1301 sv->sv_u.svu_array = NULL; /* or svu_hash */
1307 /* XXX Is this still needed? Was it ever needed? Surely as there is
1308 no route from NV to PVIV, NOK can never be true */
1309 assert(!SvNOKp(sv));
1321 assert(new_type_details->body_size);
1322 /* We always allocated the full length item with PURIFY. To do this
1323 we fake things so that arena is false for all 16 types.. */
1324 if(new_type_details->arena) {
1325 /* This points to the start of the allocated area. */
1326 new_body_inline(new_body, new_type);
1327 Zero(new_body, new_type_details->body_size, char);
1328 new_body = ((char *)new_body) - new_type_details->offset;
1330 new_body = new_NOARENAZ(new_type_details);
1332 SvANY(sv) = new_body;
1334 if (old_type_details->copy) {
1335 /* There is now the potential for an upgrade from something without
1336 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1337 int offset = old_type_details->offset;
1338 int length = old_type_details->copy;
1340 if (new_type_details->offset > old_type_details->offset) {
1341 const int difference
1342 = new_type_details->offset - old_type_details->offset;
1343 offset += difference;
1344 length -= difference;
1346 assert (length >= 0);
1348 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1352 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1353 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1354 * correct 0.0 for us. Otherwise, if the old body didn't have an
1355 * NV slot, but the new one does, then we need to initialise the
1356 * freshly created NV slot with whatever the correct bit pattern is
1358 if (old_type_details->zero_nv && !new_type_details->zero_nv
1359 && !isGV_with_GP(sv))
1363 if (new_type == SVt_PVIO)
1364 IoPAGE_LEN(sv) = 60;
1365 if (old_type < SVt_PV) {
1366 /* referant will be NULL unless the old type was SVt_IV emulating
1368 sv->sv_u.svu_rv = referant;
1372 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1373 (unsigned long)new_type);
1376 if (old_type_details->arena) {
1377 /* If there was an old body, then we need to free it.
1378 Note that there is an assumption that all bodies of types that
1379 can be upgraded came from arenas. Only the more complex non-
1380 upgradable types are allowed to be directly malloc()ed. */
1382 my_safefree(old_body);
1384 del_body((void*)((char*)old_body + old_type_details->offset),
1385 &PL_body_roots[old_type]);
1391 =for apidoc sv_backoff
1393 Remove any string offset. You should normally use the C<SvOOK_off> macro
1400 Perl_sv_backoff(pTHX_ register SV *sv)
1403 const char * const s = SvPVX_const(sv);
1404 PERL_UNUSED_CONTEXT;
1406 assert(SvTYPE(sv) != SVt_PVHV);
1407 assert(SvTYPE(sv) != SVt_PVAV);
1409 SvOOK_offset(sv, delta);
1411 SvLEN_set(sv, SvLEN(sv) + delta);
1412 SvPV_set(sv, SvPVX(sv) - delta);
1413 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1414 SvFLAGS(sv) &= ~SVf_OOK;
1421 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1422 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1423 Use the C<SvGROW> wrapper instead.
1429 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1433 if (PL_madskills && newlen >= 0x100000) {
1434 PerlIO_printf(Perl_debug_log,
1435 "Allocation too large: %"UVxf"\n", (UV)newlen);
1437 #ifdef HAS_64K_LIMIT
1438 if (newlen >= 0x10000) {
1439 PerlIO_printf(Perl_debug_log,
1440 "Allocation too large: %"UVxf"\n", (UV)newlen);
1443 #endif /* HAS_64K_LIMIT */
1446 if (SvTYPE(sv) < SVt_PV) {
1447 sv_upgrade(sv, SVt_PV);
1448 s = SvPVX_mutable(sv);
1450 else if (SvOOK(sv)) { /* pv is offset? */
1452 s = SvPVX_mutable(sv);
1453 if (newlen > SvLEN(sv))
1454 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1455 #ifdef HAS_64K_LIMIT
1456 if (newlen >= 0x10000)
1461 s = SvPVX_mutable(sv);
1463 if (newlen > SvLEN(sv)) { /* need more room? */
1464 newlen = PERL_STRLEN_ROUNDUP(newlen);
1465 if (SvLEN(sv) && s) {
1467 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1473 s = (char*)saferealloc(s, newlen);
1476 s = (char*)safemalloc(newlen);
1477 if (SvPVX_const(sv) && SvCUR(sv)) {
1478 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1482 SvLEN_set(sv, newlen);
1488 =for apidoc sv_setiv
1490 Copies an integer into the given SV, upgrading first if necessary.
1491 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1497 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1500 SV_CHECK_THINKFIRST_COW_DROP(sv);
1501 switch (SvTYPE(sv)) {
1504 sv_upgrade(sv, SVt_IV);
1507 sv_upgrade(sv, SVt_PVIV);
1516 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1520 (void)SvIOK_only(sv); /* validate number */
1526 =for apidoc sv_setiv_mg
1528 Like C<sv_setiv>, but also handles 'set' magic.
1534 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1541 =for apidoc sv_setuv
1543 Copies an unsigned integer into the given SV, upgrading first if necessary.
1544 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1550 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1552 /* With these two if statements:
1553 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1556 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1558 If you wish to remove them, please benchmark to see what the effect is
1560 if (u <= (UV)IV_MAX) {
1561 sv_setiv(sv, (IV)u);
1570 =for apidoc sv_setuv_mg
1572 Like C<sv_setuv>, but also handles 'set' magic.
1578 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1585 =for apidoc sv_setnv
1587 Copies a double into the given SV, upgrading first if necessary.
1588 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1594 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1597 SV_CHECK_THINKFIRST_COW_DROP(sv);
1598 switch (SvTYPE(sv)) {
1601 sv_upgrade(sv, SVt_NV);
1605 sv_upgrade(sv, SVt_PVNV);
1614 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1619 (void)SvNOK_only(sv); /* validate number */
1624 =for apidoc sv_setnv_mg
1626 Like C<sv_setnv>, but also handles 'set' magic.
1632 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1638 /* Print an "isn't numeric" warning, using a cleaned-up,
1639 * printable version of the offending string
1643 S_not_a_number(pTHX_ SV *sv)
1651 dsv = newSVpvs_flags("", SVs_TEMP);
1652 pv = sv_uni_display(dsv, sv, 10, 0);
1655 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1656 /* each *s can expand to 4 chars + "...\0",
1657 i.e. need room for 8 chars */
1659 const char *s = SvPVX_const(sv);
1660 const char * const end = s + SvCUR(sv);
1661 for ( ; s < end && d < limit; s++ ) {
1663 if (ch & 128 && !isPRINT_LC(ch)) {
1672 else if (ch == '\r') {
1676 else if (ch == '\f') {
1680 else if (ch == '\\') {
1684 else if (ch == '\0') {
1688 else if (isPRINT_LC(ch))
1705 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1706 "Argument \"%s\" isn't numeric in %s", pv,
1709 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1710 "Argument \"%s\" isn't numeric", pv);
1714 =for apidoc looks_like_number
1716 Test if the content of an SV looks like a number (or is a number).
1717 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1718 non-numeric warning), even if your atof() doesn't grok them.
1724 Perl_looks_like_number(pTHX_ SV *sv)
1726 register const char *sbegin;
1730 sbegin = SvPVX_const(sv);
1733 else if (SvPOKp(sv))
1734 sbegin = SvPV_const(sv, len);
1736 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1737 return grok_number(sbegin, len, NULL);
1741 S_glob_2number(pTHX_ GV * const gv)
1743 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1744 SV *const buffer = sv_newmortal();
1746 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1749 gv_efullname3(buffer, gv, "*");
1750 SvFLAGS(gv) |= wasfake;
1752 /* We know that all GVs stringify to something that is not-a-number,
1753 so no need to test that. */
1754 if (ckWARN(WARN_NUMERIC))
1755 not_a_number(buffer);
1756 /* We just want something true to return, so that S_sv_2iuv_common
1757 can tail call us and return true. */
1762 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1764 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1765 SV *const buffer = sv_newmortal();
1767 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1770 gv_efullname3(buffer, gv, "*");
1771 SvFLAGS(gv) |= wasfake;
1773 assert(SvPOK(buffer));
1775 *len = SvCUR(buffer);
1777 return SvPVX(buffer);
1780 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1781 until proven guilty, assume that things are not that bad... */
1786 As 64 bit platforms often have an NV that doesn't preserve all bits of
1787 an IV (an assumption perl has been based on to date) it becomes necessary
1788 to remove the assumption that the NV always carries enough precision to
1789 recreate the IV whenever needed, and that the NV is the canonical form.
1790 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1791 precision as a side effect of conversion (which would lead to insanity
1792 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1793 1) to distinguish between IV/UV/NV slots that have cached a valid
1794 conversion where precision was lost and IV/UV/NV slots that have a
1795 valid conversion which has lost no precision
1796 2) to ensure that if a numeric conversion to one form is requested that
1797 would lose precision, the precise conversion (or differently
1798 imprecise conversion) is also performed and cached, to prevent
1799 requests for different numeric formats on the same SV causing
1800 lossy conversion chains. (lossless conversion chains are perfectly
1805 SvIOKp is true if the IV slot contains a valid value
1806 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1807 SvNOKp is true if the NV slot contains a valid value
1808 SvNOK is true only if the NV value is accurate
1811 while converting from PV to NV, check to see if converting that NV to an
1812 IV(or UV) would lose accuracy over a direct conversion from PV to
1813 IV(or UV). If it would, cache both conversions, return NV, but mark
1814 SV as IOK NOKp (ie not NOK).
1816 While converting from PV to IV, check to see if converting that IV to an
1817 NV would lose accuracy over a direct conversion from PV to NV. If it
1818 would, cache both conversions, flag similarly.
1820 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1821 correctly because if IV & NV were set NV *always* overruled.
1822 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1823 changes - now IV and NV together means that the two are interchangeable:
1824 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1826 The benefit of this is that operations such as pp_add know that if
1827 SvIOK is true for both left and right operands, then integer addition
1828 can be used instead of floating point (for cases where the result won't
1829 overflow). Before, floating point was always used, which could lead to
1830 loss of precision compared with integer addition.
1832 * making IV and NV equal status should make maths accurate on 64 bit
1834 * may speed up maths somewhat if pp_add and friends start to use
1835 integers when possible instead of fp. (Hopefully the overhead in
1836 looking for SvIOK and checking for overflow will not outweigh the
1837 fp to integer speedup)
1838 * will slow down integer operations (callers of SvIV) on "inaccurate"
1839 values, as the change from SvIOK to SvIOKp will cause a call into
1840 sv_2iv each time rather than a macro access direct to the IV slot
1841 * should speed up number->string conversion on integers as IV is
1842 favoured when IV and NV are equally accurate
1844 ####################################################################
1845 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1846 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1847 On the other hand, SvUOK is true iff UV.
1848 ####################################################################
1850 Your mileage will vary depending your CPU's relative fp to integer
1854 #ifndef NV_PRESERVES_UV
1855 # define IS_NUMBER_UNDERFLOW_IV 1
1856 # define IS_NUMBER_UNDERFLOW_UV 2
1857 # define IS_NUMBER_IV_AND_UV 2
1858 # define IS_NUMBER_OVERFLOW_IV 4
1859 # define IS_NUMBER_OVERFLOW_UV 5
1861 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1863 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1865 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
1868 PERL_UNUSED_ARG(numtype); /* Used only under DEBUGGING? */
1869 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
1870 if (SvNVX(sv) < (NV)IV_MIN) {
1871 (void)SvIOKp_on(sv);
1873 SvIV_set(sv, IV_MIN);
1874 return IS_NUMBER_UNDERFLOW_IV;
1876 if (SvNVX(sv) > (NV)UV_MAX) {
1877 (void)SvIOKp_on(sv);
1880 SvUV_set(sv, UV_MAX);
1881 return IS_NUMBER_OVERFLOW_UV;
1883 (void)SvIOKp_on(sv);
1885 /* Can't use strtol etc to convert this string. (See truth table in
1887 if (SvNVX(sv) <= (UV)IV_MAX) {
1888 SvIV_set(sv, I_V(SvNVX(sv)));
1889 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1890 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1892 /* Integer is imprecise. NOK, IOKp */
1894 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1897 SvUV_set(sv, U_V(SvNVX(sv)));
1898 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1899 if (SvUVX(sv) == UV_MAX) {
1900 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1901 possibly be preserved by NV. Hence, it must be overflow.
1903 return IS_NUMBER_OVERFLOW_UV;
1905 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1907 /* Integer is imprecise. NOK, IOKp */
1909 return IS_NUMBER_OVERFLOW_IV;
1911 #endif /* !NV_PRESERVES_UV*/
1914 S_sv_2iuv_common(pTHX_ SV *sv) {
1917 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1918 * without also getting a cached IV/UV from it at the same time
1919 * (ie PV->NV conversion should detect loss of accuracy and cache
1920 * IV or UV at same time to avoid this. */
1921 /* IV-over-UV optimisation - choose to cache IV if possible */
1923 if (SvTYPE(sv) == SVt_NV)
1924 sv_upgrade(sv, SVt_PVNV);
1926 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1927 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1928 certainly cast into the IV range at IV_MAX, whereas the correct
1929 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1931 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1932 if (Perl_isnan(SvNVX(sv))) {
1938 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1939 SvIV_set(sv, I_V(SvNVX(sv)));
1940 if (SvNVX(sv) == (NV) SvIVX(sv)
1941 #ifndef NV_PRESERVES_UV
1942 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1943 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1944 /* Don't flag it as "accurately an integer" if the number
1945 came from a (by definition imprecise) NV operation, and
1946 we're outside the range of NV integer precision */
1950 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1952 /* scalar has trailing garbage, eg "42a" */
1954 DEBUG_c(PerlIO_printf(Perl_debug_log,
1955 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1961 /* IV not precise. No need to convert from PV, as NV
1962 conversion would already have cached IV if it detected
1963 that PV->IV would be better than PV->NV->IV
1964 flags already correct - don't set public IOK. */
1965 DEBUG_c(PerlIO_printf(Perl_debug_log,
1966 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1971 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1972 but the cast (NV)IV_MIN rounds to a the value less (more
1973 negative) than IV_MIN which happens to be equal to SvNVX ??
1974 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1975 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1976 (NV)UVX == NVX are both true, but the values differ. :-(
1977 Hopefully for 2s complement IV_MIN is something like
1978 0x8000000000000000 which will be exact. NWC */
1981 SvUV_set(sv, U_V(SvNVX(sv)));
1983 (SvNVX(sv) == (NV) SvUVX(sv))
1984 #ifndef NV_PRESERVES_UV
1985 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1986 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1987 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1988 /* Don't flag it as "accurately an integer" if the number
1989 came from a (by definition imprecise) NV operation, and
1990 we're outside the range of NV integer precision */
1996 DEBUG_c(PerlIO_printf(Perl_debug_log,
1997 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2003 else if (SvPOKp(sv) && SvLEN(sv)) {
2005 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2006 /* We want to avoid a possible problem when we cache an IV/ a UV which
2007 may be later translated to an NV, and the resulting NV is not
2008 the same as the direct translation of the initial string
2009 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2010 be careful to ensure that the value with the .456 is around if the
2011 NV value is requested in the future).
2013 This means that if we cache such an IV/a UV, we need to cache the
2014 NV as well. Moreover, we trade speed for space, and do not
2015 cache the NV if we are sure it's not needed.
2018 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2019 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2020 == IS_NUMBER_IN_UV) {
2021 /* It's definitely an integer, only upgrade to PVIV */
2022 if (SvTYPE(sv) < SVt_PVIV)
2023 sv_upgrade(sv, SVt_PVIV);
2025 } else if (SvTYPE(sv) < SVt_PVNV)
2026 sv_upgrade(sv, SVt_PVNV);
2028 /* If NVs preserve UVs then we only use the UV value if we know that
2029 we aren't going to call atof() below. If NVs don't preserve UVs
2030 then the value returned may have more precision than atof() will
2031 return, even though value isn't perfectly accurate. */
2032 if ((numtype & (IS_NUMBER_IN_UV
2033 #ifdef NV_PRESERVES_UV
2036 )) == IS_NUMBER_IN_UV) {
2037 /* This won't turn off the public IOK flag if it was set above */
2038 (void)SvIOKp_on(sv);
2040 if (!(numtype & IS_NUMBER_NEG)) {
2042 if (value <= (UV)IV_MAX) {
2043 SvIV_set(sv, (IV)value);
2045 /* it didn't overflow, and it was positive. */
2046 SvUV_set(sv, value);
2050 /* 2s complement assumption */
2051 if (value <= (UV)IV_MIN) {
2052 SvIV_set(sv, -(IV)value);
2054 /* Too negative for an IV. This is a double upgrade, but
2055 I'm assuming it will be rare. */
2056 if (SvTYPE(sv) < SVt_PVNV)
2057 sv_upgrade(sv, SVt_PVNV);
2061 SvNV_set(sv, -(NV)value);
2062 SvIV_set(sv, IV_MIN);
2066 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2067 will be in the previous block to set the IV slot, and the next
2068 block to set the NV slot. So no else here. */
2070 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2071 != IS_NUMBER_IN_UV) {
2072 /* It wasn't an (integer that doesn't overflow the UV). */
2073 SvNV_set(sv, Atof(SvPVX_const(sv)));
2075 if (! numtype && ckWARN(WARN_NUMERIC))
2078 #if defined(USE_LONG_DOUBLE)
2079 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2080 PTR2UV(sv), SvNVX(sv)));
2082 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2083 PTR2UV(sv), SvNVX(sv)));
2086 #ifdef NV_PRESERVES_UV
2087 (void)SvIOKp_on(sv);
2089 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2090 SvIV_set(sv, I_V(SvNVX(sv)));
2091 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2094 NOOP; /* Integer is imprecise. NOK, IOKp */
2096 /* UV will not work better than IV */
2098 if (SvNVX(sv) > (NV)UV_MAX) {
2100 /* Integer is inaccurate. NOK, IOKp, is UV */
2101 SvUV_set(sv, UV_MAX);
2103 SvUV_set(sv, U_V(SvNVX(sv)));
2104 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2105 NV preservse UV so can do correct comparison. */
2106 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2109 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2114 #else /* NV_PRESERVES_UV */
2115 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2116 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2117 /* The IV/UV slot will have been set from value returned by
2118 grok_number above. The NV slot has just been set using
2121 assert (SvIOKp(sv));
2123 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2124 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2125 /* Small enough to preserve all bits. */
2126 (void)SvIOKp_on(sv);
2128 SvIV_set(sv, I_V(SvNVX(sv)));
2129 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2131 /* Assumption: first non-preserved integer is < IV_MAX,
2132 this NV is in the preserved range, therefore: */
2133 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2135 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2139 0 0 already failed to read UV.
2140 0 1 already failed to read UV.
2141 1 0 you won't get here in this case. IV/UV
2142 slot set, public IOK, Atof() unneeded.
2143 1 1 already read UV.
2144 so there's no point in sv_2iuv_non_preserve() attempting
2145 to use atol, strtol, strtoul etc. */
2146 sv_2iuv_non_preserve (sv, numtype);
2149 #endif /* NV_PRESERVES_UV */
2150 /* It might be more code efficient to go through the entire logic above
2151 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2152 gets complex and potentially buggy, so more programmer efficient
2153 to do it this way, by turning off the public flags: */
2155 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2159 if (isGV_with_GP(sv))
2160 return glob_2number((GV *)sv);
2162 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2163 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2166 if (SvTYPE(sv) < SVt_IV)
2167 /* Typically the caller expects that sv_any is not NULL now. */
2168 sv_upgrade(sv, SVt_IV);
2169 /* Return 0 from the caller. */
2176 =for apidoc sv_2iv_flags
2178 Return the integer value of an SV, doing any necessary string
2179 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2180 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2186 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2191 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2192 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2193 cache IVs just in case. In practice it seems that they never
2194 actually anywhere accessible by user Perl code, let alone get used
2195 in anything other than a string context. */
2196 if (flags & SV_GMAGIC)
2201 return I_V(SvNVX(sv));
2203 if (SvPOKp(sv) && SvLEN(sv)) {
2206 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2208 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2209 == IS_NUMBER_IN_UV) {
2210 /* It's definitely an integer */
2211 if (numtype & IS_NUMBER_NEG) {
2212 if (value < (UV)IV_MIN)
2215 if (value < (UV)IV_MAX)
2220 if (ckWARN(WARN_NUMERIC))
2223 return I_V(Atof(SvPVX_const(sv)));
2228 assert(SvTYPE(sv) >= SVt_PVMG);
2229 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2230 } else if (SvTHINKFIRST(sv)) {
2234 SV * const tmpstr=AMG_CALLun(sv,numer);
2235 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2236 return SvIV(tmpstr);
2239 return PTR2IV(SvRV(sv));
2242 sv_force_normal_flags(sv, 0);
2244 if (SvREADONLY(sv) && !SvOK(sv)) {
2245 if (ckWARN(WARN_UNINITIALIZED))
2251 if (S_sv_2iuv_common(aTHX_ sv))
2254 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2255 PTR2UV(sv),SvIVX(sv)));
2256 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2260 =for apidoc sv_2uv_flags
2262 Return the unsigned integer value of an SV, doing any necessary string
2263 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2264 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2270 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2275 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2276 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2277 cache IVs just in case. */
2278 if (flags & SV_GMAGIC)
2283 return U_V(SvNVX(sv));
2284 if (SvPOKp(sv) && SvLEN(sv)) {
2287 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2289 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2290 == IS_NUMBER_IN_UV) {
2291 /* It's definitely an integer */
2292 if (!(numtype & IS_NUMBER_NEG))
2296 if (ckWARN(WARN_NUMERIC))
2299 return U_V(Atof(SvPVX_const(sv)));
2304 assert(SvTYPE(sv) >= SVt_PVMG);
2305 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2306 } else if (SvTHINKFIRST(sv)) {
2310 SV *const tmpstr = AMG_CALLun(sv,numer);
2311 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2312 return SvUV(tmpstr);
2315 return PTR2UV(SvRV(sv));
2318 sv_force_normal_flags(sv, 0);
2320 if (SvREADONLY(sv) && !SvOK(sv)) {
2321 if (ckWARN(WARN_UNINITIALIZED))
2327 if (S_sv_2iuv_common(aTHX_ sv))
2331 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2332 PTR2UV(sv),SvUVX(sv)));
2333 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2339 Return the num value of an SV, doing any necessary string or integer
2340 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2347 Perl_sv_2nv(pTHX_ register SV *sv)
2352 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2353 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2354 cache IVs just in case. */
2358 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2359 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2360 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2362 return Atof(SvPVX_const(sv));
2366 return (NV)SvUVX(sv);
2368 return (NV)SvIVX(sv);
2373 assert(SvTYPE(sv) >= SVt_PVMG);
2374 /* This falls through to the report_uninit near the end of the
2376 } else if (SvTHINKFIRST(sv)) {
2380 SV *const tmpstr = AMG_CALLun(sv,numer);
2381 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2382 return SvNV(tmpstr);
2385 return PTR2NV(SvRV(sv));
2388 sv_force_normal_flags(sv, 0);
2390 if (SvREADONLY(sv) && !SvOK(sv)) {
2391 if (ckWARN(WARN_UNINITIALIZED))
2396 if (SvTYPE(sv) < SVt_NV) {
2397 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2398 sv_upgrade(sv, SVt_NV);
2399 #ifdef USE_LONG_DOUBLE
2401 STORE_NUMERIC_LOCAL_SET_STANDARD();
2402 PerlIO_printf(Perl_debug_log,
2403 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2404 PTR2UV(sv), SvNVX(sv));
2405 RESTORE_NUMERIC_LOCAL();
2409 STORE_NUMERIC_LOCAL_SET_STANDARD();
2410 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2411 PTR2UV(sv), SvNVX(sv));
2412 RESTORE_NUMERIC_LOCAL();
2416 else if (SvTYPE(sv) < SVt_PVNV)
2417 sv_upgrade(sv, SVt_PVNV);
2422 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2423 #ifdef NV_PRESERVES_UV
2429 /* Only set the public NV OK flag if this NV preserves the IV */
2430 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2432 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2433 : (SvIVX(sv) == I_V(SvNVX(sv))))
2439 else if (SvPOKp(sv) && SvLEN(sv)) {
2441 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2442 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2444 #ifdef NV_PRESERVES_UV
2445 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2446 == IS_NUMBER_IN_UV) {
2447 /* It's definitely an integer */
2448 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2450 SvNV_set(sv, Atof(SvPVX_const(sv)));
2456 SvNV_set(sv, Atof(SvPVX_const(sv)));
2457 /* Only set the public NV OK flag if this NV preserves the value in
2458 the PV at least as well as an IV/UV would.
2459 Not sure how to do this 100% reliably. */
2460 /* if that shift count is out of range then Configure's test is
2461 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2463 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2464 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2465 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2466 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2467 /* Can't use strtol etc to convert this string, so don't try.
2468 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2471 /* value has been set. It may not be precise. */
2472 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2473 /* 2s complement assumption for (UV)IV_MIN */
2474 SvNOK_on(sv); /* Integer is too negative. */
2479 if (numtype & IS_NUMBER_NEG) {
2480 SvIV_set(sv, -(IV)value);
2481 } else if (value <= (UV)IV_MAX) {
2482 SvIV_set(sv, (IV)value);
2484 SvUV_set(sv, value);
2488 if (numtype & IS_NUMBER_NOT_INT) {
2489 /* I believe that even if the original PV had decimals,
2490 they are lost beyond the limit of the FP precision.
2491 However, neither is canonical, so both only get p
2492 flags. NWC, 2000/11/25 */
2493 /* Both already have p flags, so do nothing */
2495 const NV nv = SvNVX(sv);
2496 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2497 if (SvIVX(sv) == I_V(nv)) {
2500 /* It had no "." so it must be integer. */
2504 /* between IV_MAX and NV(UV_MAX).
2505 Could be slightly > UV_MAX */
2507 if (numtype & IS_NUMBER_NOT_INT) {
2508 /* UV and NV both imprecise. */
2510 const UV nv_as_uv = U_V(nv);
2512 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2521 /* It might be more code efficient to go through the entire logic above
2522 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2523 gets complex and potentially buggy, so more programmer efficient
2524 to do it this way, by turning off the public flags: */
2526 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2527 #endif /* NV_PRESERVES_UV */
2530 if (isGV_with_GP(sv)) {
2531 glob_2number((GV *)sv);
2535 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2537 assert (SvTYPE(sv) >= SVt_NV);
2538 /* Typically the caller expects that sv_any is not NULL now. */
2539 /* XXX Ilya implies that this is a bug in callers that assume this
2540 and ideally should be fixed. */
2543 #if defined(USE_LONG_DOUBLE)
2545 STORE_NUMERIC_LOCAL_SET_STANDARD();
2546 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2547 PTR2UV(sv), SvNVX(sv));
2548 RESTORE_NUMERIC_LOCAL();
2552 STORE_NUMERIC_LOCAL_SET_STANDARD();
2553 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2554 PTR2UV(sv), SvNVX(sv));
2555 RESTORE_NUMERIC_LOCAL();
2564 Return an SV with the numeric value of the source SV, doing any necessary
2565 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2566 access this function.
2572 Perl_sv_2num(pTHX_ register SV *sv)
2577 SV * const tmpsv = AMG_CALLun(sv,numer);
2578 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2579 return sv_2num(tmpsv);
2581 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2584 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2585 * UV as a string towards the end of buf, and return pointers to start and
2588 * We assume that buf is at least TYPE_CHARS(UV) long.
2592 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2594 char *ptr = buf + TYPE_CHARS(UV);
2595 char * const ebuf = ptr;
2608 *--ptr = '0' + (char)(uv % 10);
2617 =for apidoc sv_2pv_flags
2619 Returns a pointer to the string value of an SV, and sets *lp to its length.
2620 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2622 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2623 usually end up here too.
2629 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2639 if (SvGMAGICAL(sv)) {
2640 if (flags & SV_GMAGIC)
2645 if (flags & SV_MUTABLE_RETURN)
2646 return SvPVX_mutable(sv);
2647 if (flags & SV_CONST_RETURN)
2648 return (char *)SvPVX_const(sv);
2651 if (SvIOKp(sv) || SvNOKp(sv)) {
2652 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2657 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2658 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2660 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2667 #ifdef FIXNEGATIVEZERO
2668 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2674 SvUPGRADE(sv, SVt_PV);
2677 s = SvGROW_mutable(sv, len + 1);
2680 return (char*)memcpy(s, tbuf, len + 1);
2686 assert(SvTYPE(sv) >= SVt_PVMG);
2687 /* This falls through to the report_uninit near the end of the
2689 } else if (SvTHINKFIRST(sv)) {
2693 SV *const tmpstr = AMG_CALLun(sv,string);
2694 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2696 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2700 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2701 if (flags & SV_CONST_RETURN) {
2702 pv = (char *) SvPVX_const(tmpstr);
2704 pv = (flags & SV_MUTABLE_RETURN)
2705 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2708 *lp = SvCUR(tmpstr);
2710 pv = sv_2pv_flags(tmpstr, lp, flags);
2723 const SV *const referent = (SV*)SvRV(sv);
2727 retval = buffer = savepvn("NULLREF", len);
2728 } else if (SvTYPE(referent) == SVt_REGEXP) {
2733 /* FIXME - get rid of this cast away of const, or work out
2734 how to do it better. */
2735 temp.mg_obj = (SV *)referent;
2736 assert(temp.mg_obj);
2737 (str) = CALLREG_AS_STR(&temp,lp,&flags,&haseval);
2742 PL_reginterp_cnt += haseval;
2745 const char *const typestr = sv_reftype(referent, 0);
2746 const STRLEN typelen = strlen(typestr);
2747 UV addr = PTR2UV(referent);
2748 const char *stashname = NULL;
2749 STRLEN stashnamelen = 0; /* hush, gcc */
2750 const char *buffer_end;
2752 if (SvOBJECT(referent)) {
2753 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2756 stashname = HEK_KEY(name);
2757 stashnamelen = HEK_LEN(name);
2759 if (HEK_UTF8(name)) {
2765 stashname = "__ANON__";
2768 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2769 + 2 * sizeof(UV) + 2 /* )\0 */;
2771 len = typelen + 3 /* (0x */
2772 + 2 * sizeof(UV) + 2 /* )\0 */;
2775 Newx(buffer, len, char);
2776 buffer_end = retval = buffer + len;
2778 /* Working backwards */
2782 *--retval = PL_hexdigit[addr & 15];
2783 } while (addr >>= 4);
2789 memcpy(retval, typestr, typelen);
2793 retval -= stashnamelen;
2794 memcpy(retval, stashname, stashnamelen);
2796 /* retval may not neccesarily have reached the start of the
2798 assert (retval >= buffer);
2800 len = buffer_end - retval - 1; /* -1 for that \0 */
2808 if (SvREADONLY(sv) && !SvOK(sv)) {
2809 if (ckWARN(WARN_UNINITIALIZED))
2816 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2817 /* I'm assuming that if both IV and NV are equally valid then
2818 converting the IV is going to be more efficient */
2819 const U32 isUIOK = SvIsUV(sv);
2820 char buf[TYPE_CHARS(UV)];
2824 if (SvTYPE(sv) < SVt_PVIV)
2825 sv_upgrade(sv, SVt_PVIV);
2826 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2828 /* inlined from sv_setpvn */
2829 s = SvGROW_mutable(sv, len + 1);
2830 Move(ptr, s, len, char);
2834 else if (SvNOKp(sv)) {
2835 const int olderrno = errno;
2836 if (SvTYPE(sv) < SVt_PVNV)
2837 sv_upgrade(sv, SVt_PVNV);
2838 /* The +20 is pure guesswork. Configure test needed. --jhi */
2839 s = SvGROW_mutable(sv, NV_DIG + 20);
2840 /* some Xenix systems wipe out errno here */
2842 if (SvNVX(sv) == 0.0)
2843 my_strlcpy(s, "0", SvLEN(sv));
2847 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2850 #ifdef FIXNEGATIVEZERO
2851 if (*s == '-' && s[1] == '0' && !s[2]) {
2863 if (isGV_with_GP(sv))
2864 return glob_2pv((GV *)sv, lp);
2866 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2870 if (SvTYPE(sv) < SVt_PV)
2871 /* Typically the caller expects that sv_any is not NULL now. */
2872 sv_upgrade(sv, SVt_PV);
2876 const STRLEN len = s - SvPVX_const(sv);
2882 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2883 PTR2UV(sv),SvPVX_const(sv)));
2884 if (flags & SV_CONST_RETURN)
2885 return (char *)SvPVX_const(sv);
2886 if (flags & SV_MUTABLE_RETURN)
2887 return SvPVX_mutable(sv);
2892 =for apidoc sv_copypv
2894 Copies a stringified representation of the source SV into the
2895 destination SV. Automatically performs any necessary mg_get and
2896 coercion of numeric values into strings. Guaranteed to preserve
2897 UTF8 flag even from overloaded objects. Similar in nature to
2898 sv_2pv[_flags] but operates directly on an SV instead of just the
2899 string. Mostly uses sv_2pv_flags to do its work, except when that
2900 would lose the UTF-8'ness of the PV.
2906 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2909 const char * const s = SvPV_const(ssv,len);
2910 sv_setpvn(dsv,s,len);
2918 =for apidoc sv_2pvbyte
2920 Return a pointer to the byte-encoded representation of the SV, and set *lp
2921 to its length. May cause the SV to be downgraded from UTF-8 as a
2924 Usually accessed via the C<SvPVbyte> macro.
2930 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2932 sv_utf8_downgrade(sv,0);
2933 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2937 =for apidoc sv_2pvutf8
2939 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2940 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2942 Usually accessed via the C<SvPVutf8> macro.
2948 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2950 sv_utf8_upgrade(sv);
2951 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2956 =for apidoc sv_2bool
2958 This function is only called on magical items, and is only used by
2959 sv_true() or its macro equivalent.
2965 Perl_sv_2bool(pTHX_ register SV *sv)
2974 SV * const tmpsv = AMG_CALLun(sv,bool_);
2975 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2976 return (bool)SvTRUE(tmpsv);
2978 return SvRV(sv) != 0;
2981 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2983 (*sv->sv_u.svu_pv > '0' ||
2984 Xpvtmp->xpv_cur > 1 ||
2985 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
2992 return SvIVX(sv) != 0;
2995 return SvNVX(sv) != 0.0;
2997 if (isGV_with_GP(sv))
3007 =for apidoc sv_utf8_upgrade
3009 Converts the PV of an SV to its UTF-8-encoded form.
3010 Forces the SV to string form if it is not already.
3011 Always sets the SvUTF8 flag to avoid future validity checks even
3012 if all the bytes have hibit clear.
3014 This is not as a general purpose byte encoding to Unicode interface:
3015 use the Encode extension for that.
3017 =for apidoc sv_utf8_upgrade_flags
3019 Converts the PV of an SV to its UTF-8-encoded form.
3020 Forces the SV to string form if it is not already.
3021 Always sets the SvUTF8 flag to avoid future validity checks even
3022 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3023 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3024 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3026 This is not as a general purpose byte encoding to Unicode interface:
3027 use the Encode extension for that.
3033 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3036 if (sv == &PL_sv_undef)
3040 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3041 (void) sv_2pv_flags(sv,&len, flags);
3045 (void) SvPV_force(sv,len);
3054 sv_force_normal_flags(sv, 0);
3057 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3058 sv_recode_to_utf8(sv, PL_encoding);
3059 else { /* Assume Latin-1/EBCDIC */
3060 /* This function could be much more efficient if we
3061 * had a FLAG in SVs to signal if there are any hibit
3062 * chars in the PV. Given that there isn't such a flag
3063 * make the loop as fast as possible. */
3064 const U8 * const s = (U8 *) SvPVX_const(sv);
3065 const U8 * const e = (U8 *) SvEND(sv);
3070 /* Check for hi bit */
3071 if (!NATIVE_IS_INVARIANT(ch)) {
3072 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3073 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3075 SvPV_free(sv); /* No longer using what was there before. */
3076 SvPV_set(sv, (char*)recoded);
3077 SvCUR_set(sv, len - 1);
3078 SvLEN_set(sv, len); /* No longer know the real size. */
3082 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3089 =for apidoc sv_utf8_downgrade
3091 Attempts to convert the PV of an SV from characters to bytes.
3092 If the PV contains a character beyond byte, this conversion will fail;
3093 in this case, either returns false or, if C<fail_ok> is not
3096 This is not as a general purpose Unicode to byte encoding interface:
3097 use the Encode extension for that.
3103 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3106 if (SvPOKp(sv) && SvUTF8(sv)) {
3112 sv_force_normal_flags(sv, 0);
3114 s = (U8 *) SvPV(sv, len);
3115 if (!utf8_to_bytes(s, &len)) {
3120 Perl_croak(aTHX_ "Wide character in %s",
3123 Perl_croak(aTHX_ "Wide character");
3134 =for apidoc sv_utf8_encode
3136 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3137 flag off so that it looks like octets again.
3143 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3146 sv_force_normal_flags(sv, 0);
3148 if (SvREADONLY(sv)) {
3149 Perl_croak(aTHX_ PL_no_modify);
3151 (void) sv_utf8_upgrade(sv);
3156 =for apidoc sv_utf8_decode
3158 If the PV of the SV is an octet sequence in UTF-8
3159 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3160 so that it looks like a character. If the PV contains only single-byte
3161 characters, the C<SvUTF8> flag stays being off.
3162 Scans PV for validity and returns false if the PV is invalid UTF-8.
3168 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3174 /* The octets may have got themselves encoded - get them back as
3177 if (!sv_utf8_downgrade(sv, TRUE))
3180 /* it is actually just a matter of turning the utf8 flag on, but
3181 * we want to make sure everything inside is valid utf8 first.
3183 c = (const U8 *) SvPVX_const(sv);
3184 if (!is_utf8_string(c, SvCUR(sv)+1))
3186 e = (const U8 *) SvEND(sv);
3189 if (!UTF8_IS_INVARIANT(ch)) {
3199 =for apidoc sv_setsv
3201 Copies the contents of the source SV C<ssv> into the destination SV
3202 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3203 function if the source SV needs to be reused. Does not handle 'set' magic.
3204 Loosely speaking, it performs a copy-by-value, obliterating any previous
3205 content of the destination.
3207 You probably want to use one of the assortment of wrappers, such as
3208 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3209 C<SvSetMagicSV_nosteal>.
3211 =for apidoc sv_setsv_flags
3213 Copies the contents of the source SV C<ssv> into the destination SV
3214 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3215 function if the source SV needs to be reused. Does not handle 'set' magic.
3216 Loosely speaking, it performs a copy-by-value, obliterating any previous
3217 content of the destination.
3218 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3219 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3220 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3221 and C<sv_setsv_nomg> are implemented in terms of this function.
3223 You probably want to use one of the assortment of wrappers, such as
3224 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3225 C<SvSetMagicSV_nosteal>.
3227 This is the primary function for copying scalars, and most other
3228 copy-ish functions and macros use this underneath.
3234 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3236 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3238 if (dtype != SVt_PVGV) {
3239 const char * const name = GvNAME(sstr);
3240 const STRLEN len = GvNAMELEN(sstr);
3242 if (dtype >= SVt_PV) {
3248 SvUPGRADE(dstr, SVt_PVGV);
3249 (void)SvOK_off(dstr);
3250 /* FIXME - why are we doing this, then turning it off and on again
3252 isGV_with_GP_on(dstr);
3254 GvSTASH(dstr) = GvSTASH(sstr);
3256 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3257 gv_name_set((GV *)dstr, name, len, GV_ADD);
3258 SvFAKE_on(dstr); /* can coerce to non-glob */
3261 #ifdef GV_UNIQUE_CHECK
3262 if (GvUNIQUE((GV*)dstr)) {
3263 Perl_croak(aTHX_ PL_no_modify);
3267 if(GvGP((GV*)sstr)) {
3268 /* If source has method cache entry, clear it */
3270 SvREFCNT_dec(GvCV(sstr));
3274 /* If source has a real method, then a method is
3276 else if(GvCV((GV*)sstr)) {
3281 /* If dest already had a real method, that's a change as well */
3282 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3286 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3290 isGV_with_GP_off(dstr);
3291 (void)SvOK_off(dstr);
3292 isGV_with_GP_on(dstr);
3293 GvINTRO_off(dstr); /* one-shot flag */
3294 GvGP(dstr) = gp_ref(GvGP(sstr));
3295 if (SvTAINTED(sstr))
3297 if (GvIMPORTED(dstr) != GVf_IMPORTED
3298 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3300 GvIMPORTED_on(dstr);
3303 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3304 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3309 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3310 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3312 const int intro = GvINTRO(dstr);
3315 const U32 stype = SvTYPE(sref);
3318 #ifdef GV_UNIQUE_CHECK
3319 if (GvUNIQUE((GV*)dstr)) {
3320 Perl_croak(aTHX_ PL_no_modify);
3325 GvINTRO_off(dstr); /* one-shot flag */
3326 GvLINE(dstr) = CopLINE(PL_curcop);
3327 GvEGV(dstr) = (GV*)dstr;
3332 location = (SV **) &GvCV(dstr);
3333 import_flag = GVf_IMPORTED_CV;
3336 location = (SV **) &GvHV(dstr);
3337 import_flag = GVf_IMPORTED_HV;
3340 location = (SV **) &GvAV(dstr);
3341 import_flag = GVf_IMPORTED_AV;
3344 location = (SV **) &GvIOp(dstr);
3347 location = (SV **) &GvFORM(dstr);
3349 location = &GvSV(dstr);
3350 import_flag = GVf_IMPORTED_SV;
3353 if (stype == SVt_PVCV) {
3354 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3355 if (GvCVGEN(dstr)) {
3356 SvREFCNT_dec(GvCV(dstr));
3358 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3361 SAVEGENERICSV(*location);
3365 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3366 CV* const cv = (CV*)*location;
3368 if (!GvCVGEN((GV*)dstr) &&
3369 (CvROOT(cv) || CvXSUB(cv)))
3371 /* Redefining a sub - warning is mandatory if
3372 it was a const and its value changed. */
3373 if (CvCONST(cv) && CvCONST((CV*)sref)
3374 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3376 /* They are 2 constant subroutines generated from
3377 the same constant. This probably means that
3378 they are really the "same" proxy subroutine
3379 instantiated in 2 places. Most likely this is
3380 when a constant is exported twice. Don't warn.
3383 else if (ckWARN(WARN_REDEFINE)
3385 && (!CvCONST((CV*)sref)
3386 || sv_cmp(cv_const_sv(cv),
3387 cv_const_sv((CV*)sref))))) {
3388 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3391 ? "Constant subroutine %s::%s redefined"
3392 : "Subroutine %s::%s redefined"),
3393 HvNAME_get(GvSTASH((GV*)dstr)),
3394 GvENAME((GV*)dstr));
3398 cv_ckproto_len(cv, (GV*)dstr,
3399 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3400 SvPOK(sref) ? SvCUR(sref) : 0);
3402 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3403 GvASSUMECV_on(dstr);
3404 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3407 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3408 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3409 GvFLAGS(dstr) |= import_flag;
3414 if (SvTAINTED(sstr))
3420 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3423 register U32 sflags;
3425 register svtype stype;
3430 if (SvIS_FREED(dstr)) {
3431 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3432 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3434 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3436 sstr = &PL_sv_undef;
3437 if (SvIS_FREED(sstr)) {
3438 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3439 (void*)sstr, (void*)dstr);
3441 stype = SvTYPE(sstr);
3442 dtype = SvTYPE(dstr);
3444 (void)SvAMAGIC_off(dstr);
3447 /* need to nuke the magic */
3449 SvRMAGICAL_off(dstr);
3452 /* There's a lot of redundancy below but we're going for speed here */
3457 if (dtype != SVt_PVGV) {
3458 (void)SvOK_off(dstr);
3466 sv_upgrade(dstr, SVt_IV);
3470 sv_upgrade(dstr, SVt_PVIV);
3473 goto end_of_first_switch;
3475 (void)SvIOK_only(dstr);
3476 SvIV_set(dstr, SvIVX(sstr));
3479 /* SvTAINTED can only be true if the SV has taint magic, which in
3480 turn means that the SV type is PVMG (or greater). This is the
3481 case statement for SVt_IV, so this cannot be true (whatever gcov
3483 assert(!SvTAINTED(sstr));
3488 if (dtype < SVt_PV && dtype != SVt_IV)
3489 sv_upgrade(dstr, SVt_IV);
3497 sv_upgrade(dstr, SVt_NV);
3501 sv_upgrade(dstr, SVt_PVNV);
3504 goto end_of_first_switch;
3506 SvNV_set(dstr, SvNVX(sstr));
3507 (void)SvNOK_only(dstr);
3508 /* SvTAINTED can only be true if the SV has taint magic, which in
3509 turn means that the SV type is PVMG (or greater). This is the
3510 case statement for SVt_NV, so this cannot be true (whatever gcov
3512 assert(!SvTAINTED(sstr));
3518 #ifdef PERL_OLD_COPY_ON_WRITE
3519 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3520 if (dtype < SVt_PVIV)
3521 sv_upgrade(dstr, SVt_PVIV);
3529 sv_upgrade(dstr, SVt_PV);
3532 if (dtype < SVt_PVIV)
3533 sv_upgrade(dstr, SVt_PVIV);
3536 if (dtype < SVt_PVNV)
3537 sv_upgrade(dstr, SVt_PVNV);
3541 const char * const type = sv_reftype(sstr,0);
3543 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3545 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3549 /* case SVt_BIND: */
3552 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3553 glob_assign_glob(dstr, sstr, dtype);
3556 /* SvVALID means that this PVGV is playing at being an FBM. */
3560 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3562 if (SvTYPE(sstr) != stype) {
3563 stype = SvTYPE(sstr);
3564 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3565 glob_assign_glob(dstr, sstr, dtype);
3570 if (stype == SVt_PVLV)
3571 SvUPGRADE(dstr, SVt_PVNV);
3573 SvUPGRADE(dstr, (svtype)stype);
3575 end_of_first_switch:
3577 /* dstr may have been upgraded. */
3578 dtype = SvTYPE(dstr);
3579 sflags = SvFLAGS(sstr);
3581 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3582 /* Assigning to a subroutine sets the prototype. */
3585 const char *const ptr = SvPV_const(sstr, len);
3587 SvGROW(dstr, len + 1);
3588 Copy(ptr, SvPVX(dstr), len + 1, char);
3589 SvCUR_set(dstr, len);
3591 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3595 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3596 const char * const type = sv_reftype(dstr,0);
3598 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3600 Perl_croak(aTHX_ "Cannot copy to %s", type);
3601 } else if (sflags & SVf_ROK) {
3602 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3603 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3606 if (GvIMPORTED(dstr) != GVf_IMPORTED
3607 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3609 GvIMPORTED_on(dstr);
3614 glob_assign_glob(dstr, sstr, dtype);
3618 if (dtype >= SVt_PV) {
3619 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3620 glob_assign_ref(dstr, sstr);
3623 if (SvPVX_const(dstr)) {
3629 (void)SvOK_off(dstr);
3630 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3631 SvFLAGS(dstr) |= sflags & SVf_ROK;
3632 assert(!(sflags & SVp_NOK));
3633 assert(!(sflags & SVp_IOK));
3634 assert(!(sflags & SVf_NOK));
3635 assert(!(sflags & SVf_IOK));
3637 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3638 if (!(sflags & SVf_OK)) {
3639 if (ckWARN(WARN_MISC))
3640 Perl_warner(aTHX_ packWARN(WARN_MISC),
3641 "Undefined value assigned to typeglob");
3644 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3645 if (dstr != (SV*)gv) {
3648 GvGP(dstr) = gp_ref(GvGP(gv));
3652 else if (sflags & SVp_POK) {
3656 * Check to see if we can just swipe the string. If so, it's a
3657 * possible small lose on short strings, but a big win on long ones.
3658 * It might even be a win on short strings if SvPVX_const(dstr)
3659 * has to be allocated and SvPVX_const(sstr) has to be freed.
3660 * Likewise if we can set up COW rather than doing an actual copy, we
3661 * drop to the else clause, as the swipe code and the COW setup code
3662 * have much in common.
3665 /* Whichever path we take through the next code, we want this true,
3666 and doing it now facilitates the COW check. */
3667 (void)SvPOK_only(dstr);
3670 /* If we're already COW then this clause is not true, and if COW
3671 is allowed then we drop down to the else and make dest COW
3672 with us. If caller hasn't said that we're allowed to COW
3673 shared hash keys then we don't do the COW setup, even if the
3674 source scalar is a shared hash key scalar. */
3675 (((flags & SV_COW_SHARED_HASH_KEYS)
3676 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3677 : 1 /* If making a COW copy is forbidden then the behaviour we
3678 desire is as if the source SV isn't actually already
3679 COW, even if it is. So we act as if the source flags
3680 are not COW, rather than actually testing them. */
3682 #ifndef PERL_OLD_COPY_ON_WRITE
3683 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3684 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3685 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3686 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3687 but in turn, it's somewhat dead code, never expected to go
3688 live, but more kept as a placeholder on how to do it better
3689 in a newer implementation. */
3690 /* If we are COW and dstr is a suitable target then we drop down
3691 into the else and make dest a COW of us. */
3692 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3697 (sflags & SVs_TEMP) && /* slated for free anyway? */
3698 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3699 (!(flags & SV_NOSTEAL)) &&
3700 /* and we're allowed to steal temps */
3701 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3702 SvLEN(sstr) && /* and really is a string */
3703 /* and won't be needed again, potentially */
3704 !(PL_op && PL_op->op_type == OP_AASSIGN))
3705 #ifdef PERL_OLD_COPY_ON_WRITE
3706 && ((flags & SV_COW_SHARED_HASH_KEYS)
3707 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3708 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3709 && SvTYPE(sstr) >= SVt_PVIV))
3713 /* Failed the swipe test, and it's not a shared hash key either.
3714 Have to copy the string. */
3715 STRLEN len = SvCUR(sstr);
3716 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3717 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3718 SvCUR_set(dstr, len);
3719 *SvEND(dstr) = '\0';
3721 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3723 /* Either it's a shared hash key, or it's suitable for
3724 copy-on-write or we can swipe the string. */
3726 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3730 #ifdef PERL_OLD_COPY_ON_WRITE
3732 /* I believe I should acquire a global SV mutex if
3733 it's a COW sv (not a shared hash key) to stop
3734 it going un copy-on-write.
3735 If the source SV has gone un copy on write between up there
3736 and down here, then (assert() that) it is of the correct
3737 form to make it copy on write again */
3738 if ((sflags & (SVf_FAKE | SVf_READONLY))
3739 != (SVf_FAKE | SVf_READONLY)) {
3740 SvREADONLY_on(sstr);
3742 /* Make the source SV into a loop of 1.
3743 (about to become 2) */
3744 SV_COW_NEXT_SV_SET(sstr, sstr);
3748 /* Initial code is common. */
3749 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3754 /* making another shared SV. */
3755 STRLEN cur = SvCUR(sstr);
3756 STRLEN len = SvLEN(sstr);
3757 #ifdef PERL_OLD_COPY_ON_WRITE
3759 assert (SvTYPE(dstr) >= SVt_PVIV);
3760 /* SvIsCOW_normal */
3761 /* splice us in between source and next-after-source. */
3762 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3763 SV_COW_NEXT_SV_SET(sstr, dstr);
3764 SvPV_set(dstr, SvPVX_mutable(sstr));
3768 /* SvIsCOW_shared_hash */
3769 DEBUG_C(PerlIO_printf(Perl_debug_log,
3770 "Copy on write: Sharing hash\n"));
3772 assert (SvTYPE(dstr) >= SVt_PV);
3774 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3776 SvLEN_set(dstr, len);
3777 SvCUR_set(dstr, cur);
3778 SvREADONLY_on(dstr);
3780 /* Relesase a global SV mutex. */
3783 { /* Passes the swipe test. */
3784 SvPV_set(dstr, SvPVX_mutable(sstr));
3785 SvLEN_set(dstr, SvLEN(sstr));
3786 SvCUR_set(dstr, SvCUR(sstr));
3789 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3790 SvPV_set(sstr, NULL);
3796 if (sflags & SVp_NOK) {
3797 SvNV_set(dstr, SvNVX(sstr));
3799 if (sflags & SVp_IOK) {
3800 SvIV_set(dstr, SvIVX(sstr));
3801 /* Must do this otherwise some other overloaded use of 0x80000000
3802 gets confused. I guess SVpbm_VALID */
3803 if (sflags & SVf_IVisUV)
3806 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3808 const MAGIC * const smg = SvVSTRING_mg(sstr);
3810 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3811 smg->mg_ptr, smg->mg_len);
3812 SvRMAGICAL_on(dstr);
3816 else if (sflags & (SVp_IOK|SVp_NOK)) {
3817 (void)SvOK_off(dstr);
3818 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3819 if (sflags & SVp_IOK) {
3820 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3821 SvIV_set(dstr, SvIVX(sstr));
3823 if (sflags & SVp_NOK) {
3824 SvNV_set(dstr, SvNVX(sstr));
3828 if (isGV_with_GP(sstr)) {
3829 /* This stringification rule for globs is spread in 3 places.
3830 This feels bad. FIXME. */
3831 const U32 wasfake = sflags & SVf_FAKE;
3833 /* FAKE globs can get coerced, so need to turn this off
3834 temporarily if it is on. */
3836 gv_efullname3(dstr, (GV *)sstr, "*");
3837 SvFLAGS(sstr) |= wasfake;
3840 (void)SvOK_off(dstr);
3842 if (SvTAINTED(sstr))
3847 =for apidoc sv_setsv_mg
3849 Like C<sv_setsv>, but also handles 'set' magic.
3855 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3857 sv_setsv(dstr,sstr);
3861 #ifdef PERL_OLD_COPY_ON_WRITE
3863 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3865 STRLEN cur = SvCUR(sstr);
3866 STRLEN len = SvLEN(sstr);
3867 register char *new_pv;
3870 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3871 (void*)sstr, (void*)dstr);
3878 if (SvTHINKFIRST(dstr))
3879 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3880 else if (SvPVX_const(dstr))
3881 Safefree(SvPVX_const(dstr));
3885 SvUPGRADE(dstr, SVt_PVIV);
3887 assert (SvPOK(sstr));
3888 assert (SvPOKp(sstr));
3889 assert (!SvIOK(sstr));
3890 assert (!SvIOKp(sstr));
3891 assert (!SvNOK(sstr));
3892 assert (!SvNOKp(sstr));
3894 if (SvIsCOW(sstr)) {
3896 if (SvLEN(sstr) == 0) {
3897 /* source is a COW shared hash key. */
3898 DEBUG_C(PerlIO_printf(Perl_debug_log,
3899 "Fast copy on write: Sharing hash\n"));
3900 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3903 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3905 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3906 SvUPGRADE(sstr, SVt_PVIV);
3907 SvREADONLY_on(sstr);
3909 DEBUG_C(PerlIO_printf(Perl_debug_log,
3910 "Fast copy on write: Converting sstr to COW\n"));
3911 SV_COW_NEXT_SV_SET(dstr, sstr);
3913 SV_COW_NEXT_SV_SET(sstr, dstr);
3914 new_pv = SvPVX_mutable(sstr);
3917 SvPV_set(dstr, new_pv);
3918 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3921 SvLEN_set(dstr, len);
3922 SvCUR_set(dstr, cur);
3931 =for apidoc sv_setpvn
3933 Copies a string into an SV. The C<len> parameter indicates the number of
3934 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3935 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3941 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3944 register char *dptr;
3946 SV_CHECK_THINKFIRST_COW_DROP(sv);
3952 /* len is STRLEN which is unsigned, need to copy to signed */
3955 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3957 SvUPGRADE(sv, SVt_PV);
3959 dptr = SvGROW(sv, len + 1);
3960 Move(ptr,dptr,len,char);
3963 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3968 =for apidoc sv_setpvn_mg
3970 Like C<sv_setpvn>, but also handles 'set' magic.
3976 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3978 sv_setpvn(sv,ptr,len);
3983 =for apidoc sv_setpv
3985 Copies a string into an SV. The string must be null-terminated. Does not
3986 handle 'set' magic. See C<sv_setpv_mg>.
3992 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
3995 register STRLEN len;
3997 SV_CHECK_THINKFIRST_COW_DROP(sv);
4003 SvUPGRADE(sv, SVt_PV);
4005 SvGROW(sv, len + 1);
4006 Move(ptr,SvPVX(sv),len+1,char);
4008 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4013 =for apidoc sv_setpv_mg
4015 Like C<sv_setpv>, but also handles 'set' magic.
4021 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4028 =for apidoc sv_usepvn_flags
4030 Tells an SV to use C<ptr> to find its string value. Normally the
4031 string is stored inside the SV but sv_usepvn allows the SV to use an
4032 outside string. The C<ptr> should point to memory that was allocated
4033 by C<malloc>. The string length, C<len>, must be supplied. By default
4034 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4035 so that pointer should not be freed or used by the programmer after
4036 giving it to sv_usepvn, and neither should any pointers from "behind"
4037 that pointer (e.g. ptr + 1) be used.
4039 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4040 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4041 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4042 C<len>, and already meets the requirements for storing in C<SvPVX>)
4048 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4052 SV_CHECK_THINKFIRST_COW_DROP(sv);
4053 SvUPGRADE(sv, SVt_PV);
4056 if (flags & SV_SMAGIC)
4060 if (SvPVX_const(sv))
4064 if (flags & SV_HAS_TRAILING_NUL)
4065 assert(ptr[len] == '\0');
4068 allocate = (flags & SV_HAS_TRAILING_NUL)
4069 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4070 if (flags & SV_HAS_TRAILING_NUL) {
4071 /* It's long enough - do nothing.
4072 Specfically Perl_newCONSTSUB is relying on this. */
4075 /* Force a move to shake out bugs in callers. */
4076 char *new_ptr = (char*)safemalloc(allocate);
4077 Copy(ptr, new_ptr, len, char);
4078 PoisonFree(ptr,len,char);
4082 ptr = (char*) saferealloc (ptr, allocate);
4087 SvLEN_set(sv, allocate);
4088 if (!(flags & SV_HAS_TRAILING_NUL)) {
4091 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4093 if (flags & SV_SMAGIC)
4097 #ifdef PERL_OLD_COPY_ON_WRITE
4098 /* Need to do this *after* making the SV normal, as we need the buffer
4099 pointer to remain valid until after we've copied it. If we let go too early,
4100 another thread could invalidate it by unsharing last of the same hash key
4101 (which it can do by means other than releasing copy-on-write Svs)
4102 or by changing the other copy-on-write SVs in the loop. */
4104 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4106 { /* this SV was SvIsCOW_normal(sv) */
4107 /* we need to find the SV pointing to us. */
4108 SV *current = SV_COW_NEXT_SV(after);
4110 if (current == sv) {
4111 /* The SV we point to points back to us (there were only two of us
4113 Hence other SV is no longer copy on write either. */
4115 SvREADONLY_off(after);
4117 /* We need to follow the pointers around the loop. */
4119 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4122 /* don't loop forever if the structure is bust, and we have
4123 a pointer into a closed loop. */
4124 assert (current != after);
4125 assert (SvPVX_const(current) == pvx);
4127 /* Make the SV before us point to the SV after us. */
4128 SV_COW_NEXT_SV_SET(current, after);
4134 =for apidoc sv_force_normal_flags
4136 Undo various types of fakery on an SV: if the PV is a shared string, make
4137 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4138 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4139 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4140 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4141 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4142 set to some other value.) In addition, the C<flags> parameter gets passed to
4143 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4144 with flags set to 0.
4150 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4153 #ifdef PERL_OLD_COPY_ON_WRITE
4154 if (SvREADONLY(sv)) {
4155 /* At this point I believe I should acquire a global SV mutex. */
4157 const char * const pvx = SvPVX_const(sv);
4158 const STRLEN len = SvLEN(sv);
4159 const STRLEN cur = SvCUR(sv);
4160 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4161 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4162 we'll fail an assertion. */
4163 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4166 PerlIO_printf(Perl_debug_log,
4167 "Copy on write: Force normal %ld\n",
4173 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4176 if (flags & SV_COW_DROP_PV) {
4177 /* OK, so we don't need to copy our buffer. */
4180 SvGROW(sv, cur + 1);
4181 Move(pvx,SvPVX(sv),cur,char);
4186 sv_release_COW(sv, pvx, next);
4188 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4194 else if (IN_PERL_RUNTIME)
4195 Perl_croak(aTHX_ PL_no_modify);
4196 /* At this point I believe that I can drop the global SV mutex. */
4199 if (SvREADONLY(sv)) {
4201 const char * const pvx = SvPVX_const(sv);
4202 const STRLEN len = SvCUR(sv);
4207 SvGROW(sv, len + 1);
4208 Move(pvx,SvPVX(sv),len,char);
4210 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4212 else if (IN_PERL_RUNTIME)
4213 Perl_croak(aTHX_ PL_no_modify);
4217 sv_unref_flags(sv, flags);
4218 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4225 Efficient removal of characters from the beginning of the string buffer.
4226 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4227 the string buffer. The C<ptr> becomes the first character of the adjusted
4228 string. Uses the "OOK hack".
4229 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4230 refer to the same chunk of data.
4236 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4242 const U8 *real_start;
4245 if (!ptr || !SvPOKp(sv))
4247 delta = ptr - SvPVX_const(sv);
4249 /* Nothing to do. */
4252 assert(ptr > SvPVX_const(sv));
4253 SV_CHECK_THINKFIRST(sv);
4256 if (!SvLEN(sv)) { /* make copy of shared string */
4257 const char *pvx = SvPVX_const(sv);
4258 const STRLEN len = SvCUR(sv);
4259 SvGROW(sv, len + 1);
4260 Move(pvx,SvPVX(sv),len,char);
4263 SvFLAGS(sv) |= SVf_OOK;
4266 SvOOK_offset(sv, old_delta);
4268 SvLEN_set(sv, SvLEN(sv) - delta);
4269 SvCUR_set(sv, SvCUR(sv) - delta);
4270 SvPV_set(sv, SvPVX(sv) + delta);
4272 p = (U8 *)SvPVX_const(sv);
4277 real_start = p - delta;
4281 if (delta < 0x100) {
4285 p -= sizeof(STRLEN);
4286 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4290 /* Fill the preceding buffer with sentinals to verify that no-one is
4292 while (p > real_start) {
4300 =for apidoc sv_catpvn
4302 Concatenates the string onto the end of the string which is in the SV. The
4303 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4304 status set, then the bytes appended should be valid UTF-8.
4305 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4307 =for apidoc sv_catpvn_flags
4309 Concatenates the string onto the end of the string which is in the SV. The
4310 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4311 status set, then the bytes appended should be valid UTF-8.
4312 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4313 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4314 in terms of this function.
4320 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4324 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4326 SvGROW(dsv, dlen + slen + 1);
4328 sstr = SvPVX_const(dsv);
4329 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4330 SvCUR_set(dsv, SvCUR(dsv) + slen);
4332 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4334 if (flags & SV_SMAGIC)
4339 =for apidoc sv_catsv
4341 Concatenates the string from SV C<ssv> onto the end of the string in
4342 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4343 not 'set' magic. See C<sv_catsv_mg>.
4345 =for apidoc sv_catsv_flags
4347 Concatenates the string from SV C<ssv> onto the end of the string in
4348 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4349 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4350 and C<sv_catsv_nomg> are implemented in terms of this function.
4355 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4360 const char *spv = SvPV_const(ssv, slen);
4362 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4363 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4364 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4365 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4366 dsv->sv_flags doesn't have that bit set.
4367 Andy Dougherty 12 Oct 2001
4369 const I32 sutf8 = DO_UTF8(ssv);
4372 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4374 dutf8 = DO_UTF8(dsv);
4376 if (dutf8 != sutf8) {
4378 /* Not modifying source SV, so taking a temporary copy. */
4379 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4381 sv_utf8_upgrade(csv);
4382 spv = SvPV_const(csv, slen);
4385 sv_utf8_upgrade_nomg(dsv);
4387 sv_catpvn_nomg(dsv, spv, slen);
4390 if (flags & SV_SMAGIC)
4395 =for apidoc sv_catpv
4397 Concatenates the string onto the end of the string which is in the SV.
4398 If the SV has the UTF-8 status set, then the bytes appended should be
4399 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4404 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4407 register STRLEN len;
4413 junk = SvPV_force(sv, tlen);
4415 SvGROW(sv, tlen + len + 1);
4417 ptr = SvPVX_const(sv);
4418 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4419 SvCUR_set(sv, SvCUR(sv) + len);
4420 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4425 =for apidoc sv_catpv_mg
4427 Like C<sv_catpv>, but also handles 'set' magic.
4433 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4442 Creates a new SV. A non-zero C<len> parameter indicates the number of
4443 bytes of preallocated string space the SV should have. An extra byte for a
4444 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4445 space is allocated.) The reference count for the new SV is set to 1.
4447 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4448 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4449 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4450 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4451 modules supporting older perls.
4457 Perl_newSV(pTHX_ STRLEN len)
4464 sv_upgrade(sv, SVt_PV);
4465 SvGROW(sv, len + 1);
4470 =for apidoc sv_magicext
4472 Adds magic to an SV, upgrading it if necessary. Applies the
4473 supplied vtable and returns a pointer to the magic added.
4475 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4476 In particular, you can add magic to SvREADONLY SVs, and add more than
4477 one instance of the same 'how'.
4479 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4480 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4481 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4482 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4484 (This is now used as a subroutine by C<sv_magic>.)
4489 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4490 const char* name, I32 namlen)
4495 SvUPGRADE(sv, SVt_PVMG);
4496 Newxz(mg, 1, MAGIC);
4497 mg->mg_moremagic = SvMAGIC(sv);
4498 SvMAGIC_set(sv, mg);
4500 /* Sometimes a magic contains a reference loop, where the sv and
4501 object refer to each other. To prevent a reference loop that
4502 would prevent such objects being freed, we look for such loops
4503 and if we find one we avoid incrementing the object refcount.
4505 Note we cannot do this to avoid self-tie loops as intervening RV must
4506 have its REFCNT incremented to keep it in existence.
4509 if (!obj || obj == sv ||
4510 how == PERL_MAGIC_arylen ||
4511 how == PERL_MAGIC_symtab ||
4512 (SvTYPE(obj) == SVt_PVGV &&
4513 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4514 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4515 GvFORM(obj) == (CV*)sv)))
4520 mg->mg_obj = SvREFCNT_inc_simple(obj);
4521 mg->mg_flags |= MGf_REFCOUNTED;
4524 /* Normal self-ties simply pass a null object, and instead of
4525 using mg_obj directly, use the SvTIED_obj macro to produce a
4526 new RV as needed. For glob "self-ties", we are tieing the PVIO
4527 with an RV obj pointing to the glob containing the PVIO. In
4528 this case, to avoid a reference loop, we need to weaken the
4532 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4533 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4539 mg->mg_len = namlen;
4542 mg->mg_ptr = savepvn(name, namlen);
4543 else if (namlen == HEf_SVKEY)
4544 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4546 mg->mg_ptr = (char *) name;
4548 mg->mg_virtual = (MGVTBL *) vtable;
4552 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4557 =for apidoc sv_magic
4559 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4560 then adds a new magic item of type C<how> to the head of the magic list.
4562 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4563 handling of the C<name> and C<namlen> arguments.
4565 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4566 to add more than one instance of the same 'how'.
4572 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4575 const MGVTBL *vtable;
4578 #ifdef PERL_OLD_COPY_ON_WRITE
4580 sv_force_normal_flags(sv, 0);
4582 if (SvREADONLY(sv)) {
4584 /* its okay to attach magic to shared strings; the subsequent
4585 * upgrade to PVMG will unshare the string */
4586 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4589 && how != PERL_MAGIC_regex_global
4590 && how != PERL_MAGIC_bm
4591 && how != PERL_MAGIC_fm
4592 && how != PERL_MAGIC_sv
4593 && how != PERL_MAGIC_backref
4596 Perl_croak(aTHX_ PL_no_modify);
4599 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4600 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4601 /* sv_magic() refuses to add a magic of the same 'how' as an
4604 if (how == PERL_MAGIC_taint) {
4606 /* Any scalar which already had taint magic on which someone
4607 (erroneously?) did SvIOK_on() or similar will now be
4608 incorrectly sporting public "OK" flags. */
4609 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4617 vtable = &PL_vtbl_sv;
4619 case PERL_MAGIC_overload:
4620 vtable = &PL_vtbl_amagic;
4622 case PERL_MAGIC_overload_elem:
4623 vtable = &PL_vtbl_amagicelem;
4625 case PERL_MAGIC_overload_table:
4626 vtable = &PL_vtbl_ovrld;
4629 vtable = &PL_vtbl_bm;
4631 case PERL_MAGIC_regdata:
4632 vtable = &PL_vtbl_regdata;
4634 case PERL_MAGIC_regdatum:
4635 vtable = &PL_vtbl_regdatum;
4637 case PERL_MAGIC_env:
4638 vtable = &PL_vtbl_env;
4641 vtable = &PL_vtbl_fm;
4643 case PERL_MAGIC_envelem:
4644 vtable = &PL_vtbl_envelem;
4646 case PERL_MAGIC_regex_global:
4647 vtable = &PL_vtbl_mglob;
4649 case PERL_MAGIC_isa:
4650 vtable = &PL_vtbl_isa;
4652 case PERL_MAGIC_isaelem:
4653 vtable = &PL_vtbl_isaelem;
4655 case PERL_MAGIC_nkeys:
4656 vtable = &PL_vtbl_nkeys;
4658 case PERL_MAGIC_dbfile:
4661 case PERL_MAGIC_dbline:
4662 vtable = &PL_vtbl_dbline;
4664 #ifdef USE_LOCALE_COLLATE
4665 case PERL_MAGIC_collxfrm:
4666 vtable = &PL_vtbl_collxfrm;
4668 #endif /* USE_LOCALE_COLLATE */
4669 case PERL_MAGIC_tied:
4670 vtable = &PL_vtbl_pack;
4672 case PERL_MAGIC_tiedelem:
4673 case PERL_MAGIC_tiedscalar:
4674 vtable = &PL_vtbl_packelem;
4677 vtable = &PL_vtbl_regexp;
4679 case PERL_MAGIC_hints:
4680 /* As this vtable is all NULL, we can reuse it. */
4681 case PERL_MAGIC_sig:
4682 vtable = &PL_vtbl_sig;
4684 case PERL_MAGIC_sigelem:
4685 vtable = &PL_vtbl_sigelem;
4687 case PERL_MAGIC_taint:
4688 vtable = &PL_vtbl_taint;
4690 case PERL_MAGIC_uvar:
4691 vtable = &PL_vtbl_uvar;
4693 case PERL_MAGIC_vec:
4694 vtable = &PL_vtbl_vec;
4696 case PERL_MAGIC_arylen_p:
4697 case PERL_MAGIC_rhash:
4698 case PERL_MAGIC_symtab:
4699 case PERL_MAGIC_vstring:
4702 case PERL_MAGIC_utf8:
4703 vtable = &PL_vtbl_utf8;
4705 case PERL_MAGIC_substr:
4706 vtable = &PL_vtbl_substr;
4708 case PERL_MAGIC_defelem:
4709 vtable = &PL_vtbl_defelem;
4711 case PERL_MAGIC_arylen:
4712 vtable = &PL_vtbl_arylen;
4714 case PERL_MAGIC_pos:
4715 vtable = &PL_vtbl_pos;
4717 case PERL_MAGIC_backref:
4718 vtable = &PL_vtbl_backref;
4720 case PERL_MAGIC_hintselem:
4721 vtable = &PL_vtbl_hintselem;
4723 case PERL_MAGIC_ext:
4724 /* Reserved for use by extensions not perl internals. */
4725 /* Useful for attaching extension internal data to perl vars. */
4726 /* Note that multiple extensions may clash if magical scalars */
4727 /* etc holding private data from one are passed to another. */
4731 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4734 /* Rest of work is done else where */
4735 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4738 case PERL_MAGIC_taint:
4741 case PERL_MAGIC_ext:
4742 case PERL_MAGIC_dbfile:
4749 =for apidoc sv_unmagic
4751 Removes all magic of type C<type> from an SV.
4757 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4761 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4763 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4764 for (mg = *mgp; mg; mg = *mgp) {
4765 if (mg->mg_type == type) {
4766 const MGVTBL* const vtbl = mg->mg_virtual;
4767 *mgp = mg->mg_moremagic;
4768 if (vtbl && vtbl->svt_free)
4769 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4770 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4772 Safefree(mg->mg_ptr);
4773 else if (mg->mg_len == HEf_SVKEY)
4774 SvREFCNT_dec((SV*)mg->mg_ptr);
4775 else if (mg->mg_type == PERL_MAGIC_utf8)
4776 Safefree(mg->mg_ptr);
4778 if (mg->mg_flags & MGf_REFCOUNTED)
4779 SvREFCNT_dec(mg->mg_obj);
4783 mgp = &mg->mg_moremagic;
4787 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4788 SvMAGIC_set(sv, NULL);
4795 =for apidoc sv_rvweaken
4797 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4798 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4799 push a back-reference to this RV onto the array of backreferences
4800 associated with that magic. If the RV is magical, set magic will be
4801 called after the RV is cleared.
4807 Perl_sv_rvweaken(pTHX_ SV *sv)
4810 if (!SvOK(sv)) /* let undefs pass */
4813 Perl_croak(aTHX_ "Can't weaken a nonreference");
4814 else if (SvWEAKREF(sv)) {
4815 if (ckWARN(WARN_MISC))
4816 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4820 Perl_sv_add_backref(aTHX_ tsv, sv);
4826 /* Give tsv backref magic if it hasn't already got it, then push a
4827 * back-reference to sv onto the array associated with the backref magic.
4831 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4836 if (SvTYPE(tsv) == SVt_PVHV) {
4837 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4841 /* There is no AV in the offical place - try a fixup. */
4842 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4845 /* Aha. They've got it stowed in magic. Bring it back. */
4846 av = (AV*)mg->mg_obj;
4847 /* Stop mg_free decreasing the refernce count. */
4849 /* Stop mg_free even calling the destructor, given that
4850 there's no AV to free up. */
4852 sv_unmagic(tsv, PERL_MAGIC_backref);
4856 SvREFCNT_inc_simple_void(av);
4861 const MAGIC *const mg
4862 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4864 av = (AV*)mg->mg_obj;
4868 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4869 /* av now has a refcnt of 2, which avoids it getting freed
4870 * before us during global cleanup. The extra ref is removed
4871 * by magic_killbackrefs() when tsv is being freed */
4874 if (AvFILLp(av) >= AvMAX(av)) {
4875 av_extend(av, AvFILLp(av)+1);
4877 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4880 /* delete a back-reference to ourselves from the backref magic associated
4881 * with the SV we point to.
4885 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4892 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4893 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4894 /* We mustn't attempt to "fix up" the hash here by moving the
4895 backreference array back to the hv_aux structure, as that is stored
4896 in the main HvARRAY(), and hfreentries assumes that no-one
4897 reallocates HvARRAY() while it is running. */
4900 const MAGIC *const mg
4901 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4903 av = (AV *)mg->mg_obj;
4906 if (PL_in_clean_all)
4908 Perl_croak(aTHX_ "panic: del_backref");
4915 /* We shouldn't be in here more than once, but for paranoia reasons lets
4917 for (i = AvFILLp(av); i >= 0; i--) {
4919 const SSize_t fill = AvFILLp(av);
4921 /* We weren't the last entry.
4922 An unordered list has this property that you can take the
4923 last element off the end to fill the hole, and it's still
4924 an unordered list :-)
4929 AvFILLp(av) = fill - 1;
4935 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4937 SV **svp = AvARRAY(av);
4939 PERL_UNUSED_ARG(sv);
4941 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4942 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4943 if (svp && !SvIS_FREED(av)) {
4944 SV *const *const last = svp + AvFILLp(av);
4946 while (svp <= last) {
4948 SV *const referrer = *svp;
4949 if (SvWEAKREF(referrer)) {
4950 /* XXX Should we check that it hasn't changed? */
4951 SvRV_set(referrer, 0);
4953 SvWEAKREF_off(referrer);
4954 SvSETMAGIC(referrer);
4955 } else if (SvTYPE(referrer) == SVt_PVGV ||
4956 SvTYPE(referrer) == SVt_PVLV) {
4957 /* You lookin' at me? */
4958 assert(GvSTASH(referrer));
4959 assert(GvSTASH(referrer) == (HV*)sv);
4960 GvSTASH(referrer) = 0;
4963 "panic: magic_killbackrefs (flags=%"UVxf")",
4964 (UV)SvFLAGS(referrer));
4972 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4977 =for apidoc sv_insert
4979 Inserts a string at the specified offset/length within the SV. Similar to
4980 the Perl substr() function.
4986 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
4991 register char *midend;
4992 register char *bigend;
4998 Perl_croak(aTHX_ "Can't modify non-existent substring");
4999 SvPV_force(bigstr, curlen);
5000 (void)SvPOK_only_UTF8(bigstr);
5001 if (offset + len > curlen) {
5002 SvGROW(bigstr, offset+len+1);
5003 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5004 SvCUR_set(bigstr, offset+len);
5008 i = littlelen - len;
5009 if (i > 0) { /* string might grow */
5010 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5011 mid = big + offset + len;
5012 midend = bigend = big + SvCUR(bigstr);
5015 while (midend > mid) /* shove everything down */
5016 *--bigend = *--midend;
5017 Move(little,big+offset,littlelen,char);
5018 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5023 Move(little,SvPVX(bigstr)+offset,len,char);
5028 big = SvPVX(bigstr);
5031 bigend = big + SvCUR(bigstr);
5033 if (midend > bigend)
5034 Perl_croak(aTHX_ "panic: sv_insert");
5036 if (mid - big > bigend - midend) { /* faster to shorten from end */
5038 Move(little, mid, littlelen,char);
5041 i = bigend - midend;
5043 Move(midend, mid, i,char);
5047 SvCUR_set(bigstr, mid - big);
5049 else if ((i = mid - big)) { /* faster from front */
5050 midend -= littlelen;
5052 Move(big, midend - i, i, char);
5053 sv_chop(bigstr,midend-i);
5055 Move(little, mid, littlelen,char);
5057 else if (littlelen) {
5058 midend -= littlelen;
5059 sv_chop(bigstr,midend);
5060 Move(little,midend,littlelen,char);
5063 sv_chop(bigstr,midend);
5069 =for apidoc sv_replace
5071 Make the first argument a copy of the second, then delete the original.
5072 The target SV physically takes over ownership of the body of the source SV
5073 and inherits its flags; however, the target keeps any magic it owns,
5074 and any magic in the source is discarded.
5075 Note that this is a rather specialist SV copying operation; most of the
5076 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5082 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5085 const U32 refcnt = SvREFCNT(sv);
5086 SV_CHECK_THINKFIRST_COW_DROP(sv);
5087 if (SvREFCNT(nsv) != 1) {
5088 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5089 UVuf " != 1)", (UV) SvREFCNT(nsv));
5091 if (SvMAGICAL(sv)) {
5095 sv_upgrade(nsv, SVt_PVMG);
5096 SvMAGIC_set(nsv, SvMAGIC(sv));
5097 SvFLAGS(nsv) |= SvMAGICAL(sv);
5099 SvMAGIC_set(sv, NULL);
5103 assert(!SvREFCNT(sv));
5104 #ifdef DEBUG_LEAKING_SCALARS
5105 sv->sv_flags = nsv->sv_flags;
5106 sv->sv_any = nsv->sv_any;
5107 sv->sv_refcnt = nsv->sv_refcnt;
5108 sv->sv_u = nsv->sv_u;
5110 StructCopy(nsv,sv,SV);
5112 if(SvTYPE(sv) == SVt_IV) {
5114 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5118 #ifdef PERL_OLD_COPY_ON_WRITE
5119 if (SvIsCOW_normal(nsv)) {
5120 /* We need to follow the pointers around the loop to make the
5121 previous SV point to sv, rather than nsv. */
5124 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5127 assert(SvPVX_const(current) == SvPVX_const(nsv));
5129 /* Make the SV before us point to the SV after us. */
5131 PerlIO_printf(Perl_debug_log, "previous is\n");
5133 PerlIO_printf(Perl_debug_log,
5134 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5135 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5137 SV_COW_NEXT_SV_SET(current, sv);
5140 SvREFCNT(sv) = refcnt;
5141 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5147 =for apidoc sv_clear
5149 Clear an SV: call any destructors, free up any memory used by the body,
5150 and free the body itself. The SV's head is I<not> freed, although
5151 its type is set to all 1's so that it won't inadvertently be assumed
5152 to be live during global destruction etc.
5153 This function should only be called when REFCNT is zero. Most of the time
5154 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5161 Perl_sv_clear(pTHX_ register SV *sv)
5164 const U32 type = SvTYPE(sv);
5165 const struct body_details *const sv_type_details
5166 = bodies_by_type + type;
5170 assert(SvREFCNT(sv) == 0);
5171 assert(SvTYPE(sv) != SVTYPEMASK);
5173 if (type <= SVt_IV) {
5174 /* See the comment in sv.h about the collusion between this early
5175 return and the overloading of the NULL and IV slots in the size
5178 SV * const target = SvRV(sv);
5180 sv_del_backref(target, sv);
5182 SvREFCNT_dec(target);
5184 SvFLAGS(sv) &= SVf_BREAK;
5185 SvFLAGS(sv) |= SVTYPEMASK;
5190 if (PL_defstash && /* Still have a symbol table? */
5197 stash = SvSTASH(sv);
5198 destructor = StashHANDLER(stash,DESTROY);
5200 SV* const tmpref = newRV(sv);
5201 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5203 PUSHSTACKi(PERLSI_DESTROY);
5208 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5214 if(SvREFCNT(tmpref) < 2) {
5215 /* tmpref is not kept alive! */
5217 SvRV_set(tmpref, NULL);
5220 SvREFCNT_dec(tmpref);
5222 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5226 if (PL_in_clean_objs)
5227 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5229 /* DESTROY gave object new lease on life */
5235 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5236 SvOBJECT_off(sv); /* Curse the object. */
5237 if (type != SVt_PVIO)
5238 --PL_sv_objcount; /* XXX Might want something more general */
5241 if (type >= SVt_PVMG) {
5242 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5243 SvREFCNT_dec(SvOURSTASH(sv));
5244 } else if (SvMAGIC(sv))
5246 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5247 SvREFCNT_dec(SvSTASH(sv));
5250 /* case SVt_BIND: */
5253 IoIFP(sv) != PerlIO_stdin() &&
5254 IoIFP(sv) != PerlIO_stdout() &&
5255 IoIFP(sv) != PerlIO_stderr())
5257 io_close((IO*)sv, FALSE);
5259 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5260 PerlDir_close(IoDIRP(sv));
5261 IoDIRP(sv) = (DIR*)NULL;
5262 Safefree(IoTOP_NAME(sv));
5263 Safefree(IoFMT_NAME(sv));
5264 Safefree(IoBOTTOM_NAME(sv));
5267 /* FIXME for plugins */
5268 pregfree2((REGEXP*) sv);
5275 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5279 if (PL_comppad == (AV*)sv) {
5286 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5287 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5288 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5289 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5291 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5292 SvREFCNT_dec(LvTARG(sv));
5294 if (isGV_with_GP(sv)) {
5295 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5296 mro_method_changed_in(stash);
5299 unshare_hek(GvNAME_HEK(sv));
5300 /* If we're in a stash, we don't own a reference to it. However it does
5301 have a back reference to us, which needs to be cleared. */
5302 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5303 sv_del_backref((SV*)stash, sv);
5305 /* FIXME. There are probably more unreferenced pointers to SVs in the
5306 interpreter struct that we should check and tidy in a similar
5308 if ((GV*)sv == PL_last_in_gv)
5309 PL_last_in_gv = NULL;
5315 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5318 SvOOK_offset(sv, offset);
5319 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5320 /* Don't even bother with turning off the OOK flag. */
5323 SV * const target = SvRV(sv);
5325 sv_del_backref(target, sv);
5327 SvREFCNT_dec(target);
5329 #ifdef PERL_OLD_COPY_ON_WRITE
5330 else if (SvPVX_const(sv)) {
5332 /* I believe I need to grab the global SV mutex here and
5333 then recheck the COW status. */
5335 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5339 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5341 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5344 /* And drop it here. */
5346 } else if (SvLEN(sv)) {
5347 Safefree(SvPVX_const(sv));
5351 else if (SvPVX_const(sv) && SvLEN(sv))
5352 Safefree(SvPVX_mutable(sv));
5353 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5354 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5363 SvFLAGS(sv) &= SVf_BREAK;
5364 SvFLAGS(sv) |= SVTYPEMASK;
5366 if (sv_type_details->arena) {
5367 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5368 &PL_body_roots[type]);
5370 else if (sv_type_details->body_size) {
5371 my_safefree(SvANY(sv));
5376 =for apidoc sv_newref
5378 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5385 Perl_sv_newref(pTHX_ SV *sv)
5387 PERL_UNUSED_CONTEXT;
5396 Decrement an SV's reference count, and if it drops to zero, call
5397 C<sv_clear> to invoke destructors and free up any memory used by
5398 the body; finally, deallocate the SV's head itself.
5399 Normally called via a wrapper macro C<SvREFCNT_dec>.
5405 Perl_sv_free(pTHX_ SV *sv)
5410 if (SvREFCNT(sv) == 0) {
5411 if (SvFLAGS(sv) & SVf_BREAK)
5412 /* this SV's refcnt has been artificially decremented to
5413 * trigger cleanup */
5415 if (PL_in_clean_all) /* All is fair */
5417 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5418 /* make sure SvREFCNT(sv)==0 happens very seldom */
5419 SvREFCNT(sv) = (~(U32)0)/2;
5422 if (ckWARN_d(WARN_INTERNAL)) {
5423 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5424 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5425 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5426 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5427 Perl_dump_sv_child(aTHX_ sv);
5429 #ifdef DEBUG_LEAKING_SCALARS
5436 if (--(SvREFCNT(sv)) > 0)
5438 Perl_sv_free2(aTHX_ sv);
5442 Perl_sv_free2(pTHX_ SV *sv)
5447 if (ckWARN_d(WARN_DEBUGGING))
5448 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5449 "Attempt to free temp prematurely: SV 0x%"UVxf
5450 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5454 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5455 /* make sure SvREFCNT(sv)==0 happens very seldom */
5456 SvREFCNT(sv) = (~(U32)0)/2;
5467 Returns the length of the string in the SV. Handles magic and type
5468 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5474 Perl_sv_len(pTHX_ register SV *sv)
5482 len = mg_length(sv);
5484 (void)SvPV_const(sv, len);
5489 =for apidoc sv_len_utf8
5491 Returns the number of characters in the string in an SV, counting wide
5492 UTF-8 bytes as a single character. Handles magic and type coercion.
5498 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5499 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5500 * (Note that the mg_len is not the length of the mg_ptr field.
5501 * This allows the cache to store the character length of the string without
5502 * needing to malloc() extra storage to attach to the mg_ptr.)
5507 Perl_sv_len_utf8(pTHX_ register SV *sv)
5513 return mg_length(sv);
5517 const U8 *s = (U8*)SvPV_const(sv, len);
5521 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5523 if (mg && mg->mg_len != -1) {
5525 if (PL_utf8cache < 0) {
5526 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5528 /* Need to turn the assertions off otherwise we may
5529 recurse infinitely while printing error messages.
5531 SAVEI8(PL_utf8cache);
5533 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5534 " real %"UVuf" for %"SVf,
5535 (UV) ulen, (UV) real, SVfARG(sv));
5540 ulen = Perl_utf8_length(aTHX_ s, s + len);
5541 if (!SvREADONLY(sv)) {
5543 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5544 &PL_vtbl_utf8, 0, 0);
5552 return Perl_utf8_length(aTHX_ s, s + len);
5556 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5559 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5562 const U8 *s = start;
5564 while (s < send && uoffset--)
5567 /* This is the existing behaviour. Possibly it should be a croak, as
5568 it's actually a bounds error */
5574 /* Given the length of the string in both bytes and UTF-8 characters, decide
5575 whether to walk forwards or backwards to find the byte corresponding to
5576 the passed in UTF-8 offset. */
5578 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5579 STRLEN uoffset, STRLEN uend)
5581 STRLEN backw = uend - uoffset;
5582 if (uoffset < 2 * backw) {
5583 /* The assumption is that going forwards is twice the speed of going
5584 forward (that's where the 2 * backw comes from).
5585 (The real figure of course depends on the UTF-8 data.) */
5586 return sv_pos_u2b_forwards(start, send, uoffset);
5591 while (UTF8_IS_CONTINUATION(*send))
5594 return send - start;
5597 /* For the string representation of the given scalar, find the byte
5598 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5599 give another position in the string, *before* the sought offset, which
5600 (which is always true, as 0, 0 is a valid pair of positions), which should
5601 help reduce the amount of linear searching.
5602 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5603 will be used to reduce the amount of linear searching. The cache will be
5604 created if necessary, and the found value offered to it for update. */
5606 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5607 const U8 *const send, STRLEN uoffset,
5608 STRLEN uoffset0, STRLEN boffset0) {
5609 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5612 assert (uoffset >= uoffset0);
5614 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5615 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5616 if ((*mgp)->mg_ptr) {
5617 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5618 if (cache[0] == uoffset) {
5619 /* An exact match. */
5622 if (cache[2] == uoffset) {
5623 /* An exact match. */
5627 if (cache[0] < uoffset) {
5628 /* The cache already knows part of the way. */
5629 if (cache[0] > uoffset0) {
5630 /* The cache knows more than the passed in pair */
5631 uoffset0 = cache[0];
5632 boffset0 = cache[1];
5634 if ((*mgp)->mg_len != -1) {
5635 /* And we know the end too. */
5637 + sv_pos_u2b_midway(start + boffset0, send,
5639 (*mgp)->mg_len - uoffset0);
5642 + sv_pos_u2b_forwards(start + boffset0,
5643 send, uoffset - uoffset0);
5646 else if (cache[2] < uoffset) {
5647 /* We're between the two cache entries. */
5648 if (cache[2] > uoffset0) {
5649 /* and the cache knows more than the passed in pair */
5650 uoffset0 = cache[2];
5651 boffset0 = cache[3];
5655 + sv_pos_u2b_midway(start + boffset0,
5658 cache[0] - uoffset0);
5661 + sv_pos_u2b_midway(start + boffset0,
5664 cache[2] - uoffset0);
5668 else if ((*mgp)->mg_len != -1) {
5669 /* If we can take advantage of a passed in offset, do so. */
5670 /* In fact, offset0 is either 0, or less than offset, so don't
5671 need to worry about the other possibility. */
5673 + sv_pos_u2b_midway(start + boffset0, send,
5675 (*mgp)->mg_len - uoffset0);
5680 if (!found || PL_utf8cache < 0) {
5681 const STRLEN real_boffset
5682 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5683 send, uoffset - uoffset0);
5685 if (found && PL_utf8cache < 0) {
5686 if (real_boffset != boffset) {
5687 /* Need to turn the assertions off otherwise we may recurse
5688 infinitely while printing error messages. */
5689 SAVEI8(PL_utf8cache);
5691 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5692 " real %"UVuf" for %"SVf,
5693 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5696 boffset = real_boffset;
5699 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5705 =for apidoc sv_pos_u2b
5707 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5708 the start of the string, to a count of the equivalent number of bytes; if
5709 lenp is non-zero, it does the same to lenp, but this time starting from
5710 the offset, rather than from the start of the string. Handles magic and
5717 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5718 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5719 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5724 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5732 start = (U8*)SvPV_const(sv, len);
5734 STRLEN uoffset = (STRLEN) *offsetp;
5735 const U8 * const send = start + len;
5737 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5740 *offsetp = (I32) boffset;
5743 /* Convert the relative offset to absolute. */
5744 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5745 const STRLEN boffset2
5746 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5747 uoffset, boffset) - boffset;
5761 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5762 byte length pairing. The (byte) length of the total SV is passed in too,
5763 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5764 may not have updated SvCUR, so we can't rely on reading it directly.
5766 The proffered utf8/byte length pairing isn't used if the cache already has
5767 two pairs, and swapping either for the proffered pair would increase the
5768 RMS of the intervals between known byte offsets.
5770 The cache itself consists of 4 STRLEN values
5771 0: larger UTF-8 offset
5772 1: corresponding byte offset
5773 2: smaller UTF-8 offset
5774 3: corresponding byte offset
5776 Unused cache pairs have the value 0, 0.
5777 Keeping the cache "backwards" means that the invariant of
5778 cache[0] >= cache[2] is maintained even with empty slots, which means that
5779 the code that uses it doesn't need to worry if only 1 entry has actually
5780 been set to non-zero. It also makes the "position beyond the end of the
5781 cache" logic much simpler, as the first slot is always the one to start
5785 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5793 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5795 (*mgp)->mg_len = -1;
5799 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5800 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5801 (*mgp)->mg_ptr = (char *) cache;
5805 if (PL_utf8cache < 0) {
5806 const U8 *start = (const U8 *) SvPVX_const(sv);
5807 const STRLEN realutf8 = utf8_length(start, start + byte);
5809 if (realutf8 != utf8) {
5810 /* Need to turn the assertions off otherwise we may recurse
5811 infinitely while printing error messages. */
5812 SAVEI8(PL_utf8cache);
5814 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5815 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5819 /* Cache is held with the later position first, to simplify the code
5820 that deals with unbounded ends. */
5822 ASSERT_UTF8_CACHE(cache);
5823 if (cache[1] == 0) {
5824 /* Cache is totally empty */
5827 } else if (cache[3] == 0) {
5828 if (byte > cache[1]) {
5829 /* New one is larger, so goes first. */
5830 cache[2] = cache[0];
5831 cache[3] = cache[1];
5839 #define THREEWAY_SQUARE(a,b,c,d) \
5840 ((float)((d) - (c))) * ((float)((d) - (c))) \
5841 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5842 + ((float)((b) - (a))) * ((float)((b) - (a)))
5844 /* Cache has 2 slots in use, and we know three potential pairs.
5845 Keep the two that give the lowest RMS distance. Do the
5846 calcualation in bytes simply because we always know the byte
5847 length. squareroot has the same ordering as the positive value,
5848 so don't bother with the actual square root. */
5849 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5850 if (byte > cache[1]) {
5851 /* New position is after the existing pair of pairs. */
5852 const float keep_earlier
5853 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5854 const float keep_later
5855 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5857 if (keep_later < keep_earlier) {
5858 if (keep_later < existing) {
5859 cache[2] = cache[0];
5860 cache[3] = cache[1];
5866 if (keep_earlier < existing) {
5872 else if (byte > cache[3]) {
5873 /* New position is between the existing pair of pairs. */
5874 const float keep_earlier
5875 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5876 const float keep_later
5877 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5879 if (keep_later < keep_earlier) {
5880 if (keep_later < existing) {
5886 if (keep_earlier < existing) {
5893 /* New position is before the existing pair of pairs. */
5894 const float keep_earlier
5895 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5896 const float keep_later
5897 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5899 if (keep_later < keep_earlier) {
5900 if (keep_later < existing) {
5906 if (keep_earlier < existing) {
5907 cache[0] = cache[2];
5908 cache[1] = cache[3];
5915 ASSERT_UTF8_CACHE(cache);
5918 /* We already know all of the way, now we may be able to walk back. The same
5919 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5920 backward is half the speed of walking forward. */
5922 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5925 const STRLEN forw = target - s;
5926 STRLEN backw = end - target;
5928 if (forw < 2 * backw) {
5929 return utf8_length(s, target);
5932 while (end > target) {
5934 while (UTF8_IS_CONTINUATION(*end)) {
5943 =for apidoc sv_pos_b2u
5945 Converts the value pointed to by offsetp from a count of bytes from the
5946 start of the string, to a count of the equivalent number of UTF-8 chars.
5947 Handles magic and type coercion.
5953 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5954 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5959 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5962 const STRLEN byte = *offsetp;
5963 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5972 s = (const U8*)SvPV_const(sv, blen);
5975 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
5979 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5980 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
5982 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
5983 if (cache[1] == byte) {
5984 /* An exact match. */
5985 *offsetp = cache[0];
5988 if (cache[3] == byte) {
5989 /* An exact match. */
5990 *offsetp = cache[2];
5994 if (cache[1] < byte) {
5995 /* We already know part of the way. */
5996 if (mg->mg_len != -1) {
5997 /* Actually, we know the end too. */
5999 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6000 s + blen, mg->mg_len - cache[0]);
6002 len = cache[0] + utf8_length(s + cache[1], send);
6005 else if (cache[3] < byte) {
6006 /* We're between the two cached pairs, so we do the calculation
6007 offset by the byte/utf-8 positions for the earlier pair,
6008 then add the utf-8 characters from the string start to
6010 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6011 s + cache[1], cache[0] - cache[2])
6015 else { /* cache[3] > byte */
6016 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6020 ASSERT_UTF8_CACHE(cache);
6022 } else if (mg->mg_len != -1) {
6023 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6027 if (!found || PL_utf8cache < 0) {
6028 const STRLEN real_len = utf8_length(s, send);
6030 if (found && PL_utf8cache < 0) {
6031 if (len != real_len) {
6032 /* Need to turn the assertions off otherwise we may recurse
6033 infinitely while printing error messages. */
6034 SAVEI8(PL_utf8cache);
6036 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6037 " real %"UVuf" for %"SVf,
6038 (UV) len, (UV) real_len, SVfARG(sv));
6045 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6051 Returns a boolean indicating whether the strings in the two SVs are
6052 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6053 coerce its args to strings if necessary.
6059 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6068 SV* svrecode = NULL;
6075 /* if pv1 and pv2 are the same, second SvPV_const call may
6076 * invalidate pv1, so we may need to make a copy */
6077 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6078 pv1 = SvPV_const(sv1, cur1);
6079 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6081 pv1 = SvPV_const(sv1, cur1);
6089 pv2 = SvPV_const(sv2, cur2);
6091 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6092 /* Differing utf8ness.
6093 * Do not UTF8size the comparands as a side-effect. */
6096 svrecode = newSVpvn(pv2, cur2);
6097 sv_recode_to_utf8(svrecode, PL_encoding);
6098 pv2 = SvPV_const(svrecode, cur2);
6101 svrecode = newSVpvn(pv1, cur1);
6102 sv_recode_to_utf8(svrecode, PL_encoding);
6103 pv1 = SvPV_const(svrecode, cur1);
6105 /* Now both are in UTF-8. */
6107 SvREFCNT_dec(svrecode);
6112 bool is_utf8 = TRUE;
6115 /* sv1 is the UTF-8 one,
6116 * if is equal it must be downgrade-able */
6117 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6123 /* sv2 is the UTF-8 one,
6124 * if is equal it must be downgrade-able */
6125 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6131 /* Downgrade not possible - cannot be eq */
6139 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6141 SvREFCNT_dec(svrecode);
6151 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6152 string in C<sv1> is less than, equal to, or greater than the string in
6153 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6154 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6160 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6164 const char *pv1, *pv2;
6167 SV *svrecode = NULL;
6174 pv1 = SvPV_const(sv1, cur1);
6181 pv2 = SvPV_const(sv2, cur2);
6183 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6184 /* Differing utf8ness.
6185 * Do not UTF8size the comparands as a side-effect. */
6188 svrecode = newSVpvn(pv2, cur2);
6189 sv_recode_to_utf8(svrecode, PL_encoding);
6190 pv2 = SvPV_const(svrecode, cur2);
6193 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6198 svrecode = newSVpvn(pv1, cur1);
6199 sv_recode_to_utf8(svrecode, PL_encoding);
6200 pv1 = SvPV_const(svrecode, cur1);
6203 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6209 cmp = cur2 ? -1 : 0;
6213 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6216 cmp = retval < 0 ? -1 : 1;
6217 } else if (cur1 == cur2) {
6220 cmp = cur1 < cur2 ? -1 : 1;
6224 SvREFCNT_dec(svrecode);
6232 =for apidoc sv_cmp_locale
6234 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6235 'use bytes' aware, handles get magic, and will coerce its args to strings
6236 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6242 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6245 #ifdef USE_LOCALE_COLLATE
6251 if (PL_collation_standard)
6255 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6257 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6259 if (!pv1 || !len1) {
6270 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6273 return retval < 0 ? -1 : 1;
6276 * When the result of collation is equality, that doesn't mean
6277 * that there are no differences -- some locales exclude some
6278 * characters from consideration. So to avoid false equalities,
6279 * we use the raw string as a tiebreaker.
6285 #endif /* USE_LOCALE_COLLATE */
6287 return sv_cmp(sv1, sv2);
6291 #ifdef USE_LOCALE_COLLATE
6294 =for apidoc sv_collxfrm
6296 Add Collate Transform magic to an SV if it doesn't already have it.
6298 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6299 scalar data of the variable, but transformed to such a format that a normal
6300 memory comparison can be used to compare the data according to the locale
6307 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6312 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6313 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6319 Safefree(mg->mg_ptr);
6320 s = SvPV_const(sv, len);
6321 if ((xf = mem_collxfrm(s, len, &xlen))) {
6322 if (SvREADONLY(sv)) {
6325 return xf + sizeof(PL_collation_ix);
6328 #ifdef PERL_OLD_COPY_ON_WRITE
6330 sv_force_normal_flags(sv, 0);
6332 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6346 if (mg && mg->mg_ptr) {
6348 return mg->mg_ptr + sizeof(PL_collation_ix);
6356 #endif /* USE_LOCALE_COLLATE */
6361 Get a line from the filehandle and store it into the SV, optionally
6362 appending to the currently-stored string.
6368 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6373 register STDCHAR rslast;
6374 register STDCHAR *bp;
6379 if (SvTHINKFIRST(sv))
6380 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6381 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6383 However, perlbench says it's slower, because the existing swipe code
6384 is faster than copy on write.
6385 Swings and roundabouts. */
6386 SvUPGRADE(sv, SVt_PV);
6391 if (PerlIO_isutf8(fp)) {
6393 sv_utf8_upgrade_nomg(sv);
6394 sv_pos_u2b(sv,&append,0);
6396 } else if (SvUTF8(sv)) {
6397 SV * const tsv = newSV(0);
6398 sv_gets(tsv, fp, 0);
6399 sv_utf8_upgrade_nomg(tsv);
6400 SvCUR_set(sv,append);
6403 goto return_string_or_null;
6408 if (PerlIO_isutf8(fp))
6411 if (IN_PERL_COMPILETIME) {
6412 /* we always read code in line mode */
6416 else if (RsSNARF(PL_rs)) {
6417 /* If it is a regular disk file use size from stat() as estimate
6418 of amount we are going to read -- may result in mallocing
6419 more memory than we really need if the layers below reduce
6420 the size we read (e.g. CRLF or a gzip layer).
6423 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6424 const Off_t offset = PerlIO_tell(fp);
6425 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6426 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6432 else if (RsRECORD(PL_rs)) {
6437 /* Grab the size of the record we're getting */
6438 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6439 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6442 /* VMS wants read instead of fread, because fread doesn't respect */
6443 /* RMS record boundaries. This is not necessarily a good thing to be */
6444 /* doing, but we've got no other real choice - except avoid stdio
6445 as implementation - perhaps write a :vms layer ?
6447 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6449 bytesread = PerlIO_read(fp, buffer, recsize);
6453 SvCUR_set(sv, bytesread += append);
6454 buffer[bytesread] = '\0';
6455 goto return_string_or_null;
6457 else if (RsPARA(PL_rs)) {
6463 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6464 if (PerlIO_isutf8(fp)) {
6465 rsptr = SvPVutf8(PL_rs, rslen);
6468 if (SvUTF8(PL_rs)) {
6469 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6470 Perl_croak(aTHX_ "Wide character in $/");
6473 rsptr = SvPV_const(PL_rs, rslen);
6477 rslast = rslen ? rsptr[rslen - 1] : '\0';
6479 if (rspara) { /* have to do this both before and after */
6480 do { /* to make sure file boundaries work right */
6483 i = PerlIO_getc(fp);
6487 PerlIO_ungetc(fp,i);
6493 /* See if we know enough about I/O mechanism to cheat it ! */
6495 /* This used to be #ifdef test - it is made run-time test for ease
6496 of abstracting out stdio interface. One call should be cheap
6497 enough here - and may even be a macro allowing compile
6501 if (PerlIO_fast_gets(fp)) {
6504 * We're going to steal some values from the stdio struct
6505 * and put EVERYTHING in the innermost loop into registers.
6507 register STDCHAR *ptr;
6511 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6512 /* An ungetc()d char is handled separately from the regular
6513 * buffer, so we getc() it back out and stuff it in the buffer.
6515 i = PerlIO_getc(fp);
6516 if (i == EOF) return 0;
6517 *(--((*fp)->_ptr)) = (unsigned char) i;
6521 /* Here is some breathtakingly efficient cheating */
6523 cnt = PerlIO_get_cnt(fp); /* get count into register */
6524 /* make sure we have the room */
6525 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6526 /* Not room for all of it
6527 if we are looking for a separator and room for some
6529 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6530 /* just process what we have room for */
6531 shortbuffered = cnt - SvLEN(sv) + append + 1;
6532 cnt -= shortbuffered;
6536 /* remember that cnt can be negative */
6537 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6542 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6543 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6544 DEBUG_P(PerlIO_printf(Perl_debug_log,
6545 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6546 DEBUG_P(PerlIO_printf(Perl_debug_log,
6547 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6548 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6549 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6554 while (cnt > 0) { /* this | eat */
6556 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6557 goto thats_all_folks; /* screams | sed :-) */
6561 Copy(ptr, bp, cnt, char); /* this | eat */
6562 bp += cnt; /* screams | dust */
6563 ptr += cnt; /* louder | sed :-) */
6568 if (shortbuffered) { /* oh well, must extend */
6569 cnt = shortbuffered;
6571 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6573 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6574 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6578 DEBUG_P(PerlIO_printf(Perl_debug_log,
6579 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6580 PTR2UV(ptr),(long)cnt));
6581 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6583 DEBUG_P(PerlIO_printf(Perl_debug_log,
6584 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6585 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6586 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6588 /* This used to call 'filbuf' in stdio form, but as that behaves like
6589 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6590 another abstraction. */
6591 i = PerlIO_getc(fp); /* get more characters */
6593 DEBUG_P(PerlIO_printf(Perl_debug_log,
6594 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6595 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6596 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6598 cnt = PerlIO_get_cnt(fp);
6599 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6600 DEBUG_P(PerlIO_printf(Perl_debug_log,
6601 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6603 if (i == EOF) /* all done for ever? */
6604 goto thats_really_all_folks;
6606 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6608 SvGROW(sv, bpx + cnt + 2);
6609 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6611 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6613 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6614 goto thats_all_folks;
6618 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6619 memNE((char*)bp - rslen, rsptr, rslen))
6620 goto screamer; /* go back to the fray */
6621 thats_really_all_folks:
6623 cnt += shortbuffered;
6624 DEBUG_P(PerlIO_printf(Perl_debug_log,
6625 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6626 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6627 DEBUG_P(PerlIO_printf(Perl_debug_log,
6628 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6629 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6630 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6632 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6633 DEBUG_P(PerlIO_printf(Perl_debug_log,
6634 "Screamer: done, len=%ld, string=|%.*s|\n",
6635 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6639 /*The big, slow, and stupid way. */
6640 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6641 STDCHAR *buf = NULL;
6642 Newx(buf, 8192, STDCHAR);
6650 register const STDCHAR * const bpe = buf + sizeof(buf);
6652 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6653 ; /* keep reading */
6657 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6658 /* Accomodate broken VAXC compiler, which applies U8 cast to
6659 * both args of ?: operator, causing EOF to change into 255
6662 i = (U8)buf[cnt - 1];
6668 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6670 sv_catpvn(sv, (char *) buf, cnt);
6672 sv_setpvn(sv, (char *) buf, cnt);
6674 if (i != EOF && /* joy */
6676 SvCUR(sv) < rslen ||
6677 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6681 * If we're reading from a TTY and we get a short read,
6682 * indicating that the user hit his EOF character, we need
6683 * to notice it now, because if we try to read from the TTY
6684 * again, the EOF condition will disappear.
6686 * The comparison of cnt to sizeof(buf) is an optimization
6687 * that prevents unnecessary calls to feof().
6691 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6695 #ifdef USE_HEAP_INSTEAD_OF_STACK
6700 if (rspara) { /* have to do this both before and after */
6701 while (i != EOF) { /* to make sure file boundaries work right */
6702 i = PerlIO_getc(fp);
6704 PerlIO_ungetc(fp,i);
6710 return_string_or_null:
6711 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6717 Auto-increment of the value in the SV, doing string to numeric conversion
6718 if necessary. Handles 'get' magic.
6724 Perl_sv_inc(pTHX_ register SV *sv)
6733 if (SvTHINKFIRST(sv)) {
6735 sv_force_normal_flags(sv, 0);
6736 if (SvREADONLY(sv)) {
6737 if (IN_PERL_RUNTIME)
6738 Perl_croak(aTHX_ PL_no_modify);
6742 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6744 i = PTR2IV(SvRV(sv));
6749 flags = SvFLAGS(sv);
6750 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6751 /* It's (privately or publicly) a float, but not tested as an
6752 integer, so test it to see. */
6754 flags = SvFLAGS(sv);
6756 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6757 /* It's publicly an integer, or privately an integer-not-float */
6758 #ifdef PERL_PRESERVE_IVUV
6762 if (SvUVX(sv) == UV_MAX)
6763 sv_setnv(sv, UV_MAX_P1);
6765 (void)SvIOK_only_UV(sv);
6766 SvUV_set(sv, SvUVX(sv) + 1);
6768 if (SvIVX(sv) == IV_MAX)
6769 sv_setuv(sv, (UV)IV_MAX + 1);
6771 (void)SvIOK_only(sv);
6772 SvIV_set(sv, SvIVX(sv) + 1);
6777 if (flags & SVp_NOK) {
6778 (void)SvNOK_only(sv);
6779 SvNV_set(sv, SvNVX(sv) + 1.0);
6783 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6784 if ((flags & SVTYPEMASK) < SVt_PVIV)
6785 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6786 (void)SvIOK_only(sv);
6791 while (isALPHA(*d)) d++;
6792 while (isDIGIT(*d)) d++;
6794 #ifdef PERL_PRESERVE_IVUV
6795 /* Got to punt this as an integer if needs be, but we don't issue
6796 warnings. Probably ought to make the sv_iv_please() that does
6797 the conversion if possible, and silently. */
6798 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6799 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6800 /* Need to try really hard to see if it's an integer.
6801 9.22337203685478e+18 is an integer.
6802 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6803 so $a="9.22337203685478e+18"; $a+0; $a++
6804 needs to be the same as $a="9.22337203685478e+18"; $a++
6811 /* sv_2iv *should* have made this an NV */
6812 if (flags & SVp_NOK) {
6813 (void)SvNOK_only(sv);
6814 SvNV_set(sv, SvNVX(sv) + 1.0);
6817 /* I don't think we can get here. Maybe I should assert this
6818 And if we do get here I suspect that sv_setnv will croak. NWC
6820 #if defined(USE_LONG_DOUBLE)
6821 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",
6822 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6824 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6825 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6828 #endif /* PERL_PRESERVE_IVUV */
6829 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6833 while (d >= SvPVX_const(sv)) {
6841 /* MKS: The original code here died if letters weren't consecutive.
6842 * at least it didn't have to worry about non-C locales. The
6843 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6844 * arranged in order (although not consecutively) and that only
6845 * [A-Za-z] are accepted by isALPHA in the C locale.
6847 if (*d != 'z' && *d != 'Z') {
6848 do { ++*d; } while (!isALPHA(*d));
6851 *(d--) -= 'z' - 'a';
6856 *(d--) -= 'z' - 'a' + 1;
6860 /* oh,oh, the number grew */
6861 SvGROW(sv, SvCUR(sv) + 2);
6862 SvCUR_set(sv, SvCUR(sv) + 1);
6863 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6874 Auto-decrement of the value in the SV, doing string to numeric conversion
6875 if necessary. Handles 'get' magic.
6881 Perl_sv_dec(pTHX_ register SV *sv)
6889 if (SvTHINKFIRST(sv)) {
6891 sv_force_normal_flags(sv, 0);
6892 if (SvREADONLY(sv)) {
6893 if (IN_PERL_RUNTIME)
6894 Perl_croak(aTHX_ PL_no_modify);
6898 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6900 i = PTR2IV(SvRV(sv));
6905 /* Unlike sv_inc we don't have to worry about string-never-numbers
6906 and keeping them magic. But we mustn't warn on punting */
6907 flags = SvFLAGS(sv);
6908 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6909 /* It's publicly an integer, or privately an integer-not-float */
6910 #ifdef PERL_PRESERVE_IVUV
6914 if (SvUVX(sv) == 0) {
6915 (void)SvIOK_only(sv);
6919 (void)SvIOK_only_UV(sv);
6920 SvUV_set(sv, SvUVX(sv) - 1);
6923 if (SvIVX(sv) == IV_MIN)
6924 sv_setnv(sv, (NV)IV_MIN - 1.0);
6926 (void)SvIOK_only(sv);
6927 SvIV_set(sv, SvIVX(sv) - 1);
6932 if (flags & SVp_NOK) {
6933 SvNV_set(sv, SvNVX(sv) - 1.0);
6934 (void)SvNOK_only(sv);
6937 if (!(flags & SVp_POK)) {
6938 if ((flags & SVTYPEMASK) < SVt_PVIV)
6939 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6941 (void)SvIOK_only(sv);
6944 #ifdef PERL_PRESERVE_IVUV
6946 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6947 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6948 /* Need to try really hard to see if it's an integer.
6949 9.22337203685478e+18 is an integer.
6950 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6951 so $a="9.22337203685478e+18"; $a+0; $a--
6952 needs to be the same as $a="9.22337203685478e+18"; $a--
6959 /* sv_2iv *should* have made this an NV */
6960 if (flags & SVp_NOK) {
6961 (void)SvNOK_only(sv);
6962 SvNV_set(sv, SvNVX(sv) - 1.0);
6965 /* I don't think we can get here. Maybe I should assert this
6966 And if we do get here I suspect that sv_setnv will croak. NWC
6968 #if defined(USE_LONG_DOUBLE)
6969 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",
6970 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6972 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6973 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6977 #endif /* PERL_PRESERVE_IVUV */
6978 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
6982 =for apidoc sv_mortalcopy
6984 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
6985 The new SV is marked as mortal. It will be destroyed "soon", either by an
6986 explicit call to FREETMPS, or by an implicit call at places such as
6987 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
6992 /* Make a string that will exist for the duration of the expression
6993 * evaluation. Actually, it may have to last longer than that, but
6994 * hopefully we won't free it until it has been assigned to a
6995 * permanent location. */
6998 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7004 sv_setsv(sv,oldstr);
7006 PL_tmps_stack[++PL_tmps_ix] = sv;
7012 =for apidoc sv_newmortal
7014 Creates a new null SV which is mortal. The reference count of the SV is
7015 set to 1. It will be destroyed "soon", either by an explicit call to
7016 FREETMPS, or by an implicit call at places such as statement boundaries.
7017 See also C<sv_mortalcopy> and C<sv_2mortal>.
7023 Perl_sv_newmortal(pTHX)
7029 SvFLAGS(sv) = SVs_TEMP;
7031 PL_tmps_stack[++PL_tmps_ix] = sv;
7037 =for apidoc newSVpvn_flags
7039 Creates a new SV and copies a string into it. The reference count for the
7040 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7041 string. You are responsible for ensuring that the source string is at least
7042 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7043 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7044 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7045 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7046 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7048 #define newSVpvn_utf8(s, len, u) \
7049 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7055 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7060 /* All the flags we don't support must be zero.
7061 And we're new code so I'm going to assert this from the start. */
7062 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7064 sv_setpvn(sv,s,len);
7065 SvFLAGS(sv) |= (flags & SVf_UTF8);
7066 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7070 =for apidoc sv_2mortal
7072 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7073 by an explicit call to FREETMPS, or by an implicit call at places such as
7074 statement boundaries. SvTEMP() is turned on which means that the SV's
7075 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7076 and C<sv_mortalcopy>.
7082 Perl_sv_2mortal(pTHX_ register SV *sv)
7087 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7090 PL_tmps_stack[++PL_tmps_ix] = sv;
7098 Creates a new SV and copies a string into it. The reference count for the
7099 SV is set to 1. If C<len> is zero, Perl will compute the length using
7100 strlen(). For efficiency, consider using C<newSVpvn> instead.
7106 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7112 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7117 =for apidoc newSVpvn
7119 Creates a new SV and copies a string into it. The reference count for the
7120 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7121 string. You are responsible for ensuring that the source string is at least
7122 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7128 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7134 sv_setpvn(sv,s,len);
7139 =for apidoc newSVhek
7141 Creates a new SV from the hash key structure. It will generate scalars that
7142 point to the shared string table where possible. Returns a new (undefined)
7143 SV if the hek is NULL.
7149 Perl_newSVhek(pTHX_ const HEK *hek)
7159 if (HEK_LEN(hek) == HEf_SVKEY) {
7160 return newSVsv(*(SV**)HEK_KEY(hek));
7162 const int flags = HEK_FLAGS(hek);
7163 if (flags & HVhek_WASUTF8) {
7165 Andreas would like keys he put in as utf8 to come back as utf8
7167 STRLEN utf8_len = HEK_LEN(hek);
7168 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7169 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7172 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7174 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7175 /* We don't have a pointer to the hv, so we have to replicate the
7176 flag into every HEK. This hv is using custom a hasing
7177 algorithm. Hence we can't return a shared string scalar, as
7178 that would contain the (wrong) hash value, and might get passed
7179 into an hv routine with a regular hash.
7180 Similarly, a hash that isn't using shared hash keys has to have
7181 the flag in every key so that we know not to try to call
7182 share_hek_kek on it. */
7184 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7189 /* This will be overwhelminly the most common case. */
7191 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7192 more efficient than sharepvn(). */
7196 sv_upgrade(sv, SVt_PV);
7197 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7198 SvCUR_set(sv, HEK_LEN(hek));
7211 =for apidoc newSVpvn_share
7213 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7214 table. If the string does not already exist in the table, it is created
7215 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7216 value is used; otherwise the hash is computed. The string's hash can be later
7217 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7218 that as the string table is used for shared hash keys these strings will have
7219 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7225 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7229 bool is_utf8 = FALSE;
7230 const char *const orig_src = src;
7233 STRLEN tmplen = -len;
7235 /* See the note in hv.c:hv_fetch() --jhi */
7236 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7240 PERL_HASH(hash, src, len);
7242 sv_upgrade(sv, SVt_PV);
7243 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7251 if (src != orig_src)
7257 #if defined(PERL_IMPLICIT_CONTEXT)
7259 /* pTHX_ magic can't cope with varargs, so this is a no-context
7260 * version of the main function, (which may itself be aliased to us).
7261 * Don't access this version directly.
7265 Perl_newSVpvf_nocontext(const char* pat, ...)
7270 va_start(args, pat);
7271 sv = vnewSVpvf(pat, &args);
7278 =for apidoc newSVpvf
7280 Creates a new SV and initializes it with the string formatted like
7287 Perl_newSVpvf(pTHX_ const char* pat, ...)
7291 va_start(args, pat);
7292 sv = vnewSVpvf(pat, &args);
7297 /* backend for newSVpvf() and newSVpvf_nocontext() */
7300 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7305 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7312 Creates a new SV and copies a floating point value into it.
7313 The reference count for the SV is set to 1.
7319 Perl_newSVnv(pTHX_ NV n)
7332 Creates a new SV and copies an integer into it. The reference count for the
7339 Perl_newSViv(pTHX_ IV i)
7352 Creates a new SV and copies an unsigned integer into it.
7353 The reference count for the SV is set to 1.
7359 Perl_newSVuv(pTHX_ UV u)
7370 =for apidoc newSV_type
7372 Creates a new SV, of the type specified. The reference count for the new SV
7379 Perl_newSV_type(pTHX_ svtype type)
7384 sv_upgrade(sv, type);
7389 =for apidoc newRV_noinc
7391 Creates an RV wrapper for an SV. The reference count for the original
7392 SV is B<not> incremented.
7398 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7401 register SV *sv = newSV_type(SVt_IV);
7403 SvRV_set(sv, tmpRef);
7408 /* newRV_inc is the official function name to use now.
7409 * newRV_inc is in fact #defined to newRV in sv.h
7413 Perl_newRV(pTHX_ SV *sv)
7416 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7422 Creates a new SV which is an exact duplicate of the original SV.
7429 Perl_newSVsv(pTHX_ register SV *old)
7436 if (SvTYPE(old) == SVTYPEMASK) {
7437 if (ckWARN_d(WARN_INTERNAL))
7438 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7442 /* SV_GMAGIC is the default for sv_setv()
7443 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7444 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7445 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7450 =for apidoc sv_reset
7452 Underlying implementation for the C<reset> Perl function.
7453 Note that the perl-level function is vaguely deprecated.
7459 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7462 char todo[PERL_UCHAR_MAX+1];
7467 if (!*s) { /* reset ?? searches */
7468 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7470 const U32 count = mg->mg_len / sizeof(PMOP**);
7471 PMOP **pmp = (PMOP**) mg->mg_ptr;
7472 PMOP *const *const end = pmp + count;
7476 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7478 (*pmp)->op_pmflags &= ~PMf_USED;
7486 /* reset variables */
7488 if (!HvARRAY(stash))
7491 Zero(todo, 256, char);
7494 I32 i = (unsigned char)*s;
7498 max = (unsigned char)*s++;
7499 for ( ; i <= max; i++) {
7502 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7504 for (entry = HvARRAY(stash)[i];
7506 entry = HeNEXT(entry))
7511 if (!todo[(U8)*HeKEY(entry)])
7513 gv = (GV*)HeVAL(entry);
7516 if (SvTHINKFIRST(sv)) {
7517 if (!SvREADONLY(sv) && SvROK(sv))
7519 /* XXX Is this continue a bug? Why should THINKFIRST
7520 exempt us from resetting arrays and hashes? */
7524 if (SvTYPE(sv) >= SVt_PV) {
7526 if (SvPVX_const(sv) != NULL)
7534 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7536 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7539 # if defined(USE_ENVIRON_ARRAY)
7542 # endif /* USE_ENVIRON_ARRAY */
7553 Using various gambits, try to get an IO from an SV: the IO slot if its a
7554 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7555 named after the PV if we're a string.
7561 Perl_sv_2io(pTHX_ SV *sv)
7566 switch (SvTYPE(sv)) {
7574 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7578 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7580 return sv_2io(SvRV(sv));
7581 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7587 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7596 Using various gambits, try to get a CV from an SV; in addition, try if
7597 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7598 The flags in C<lref> are passed to sv_fetchsv.
7604 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7615 switch (SvTYPE(sv)) {
7634 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7635 tryAMAGICunDEREF(to_cv);
7638 if (SvTYPE(sv) == SVt_PVCV) {
7647 Perl_croak(aTHX_ "Not a subroutine reference");
7652 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7658 /* Some flags to gv_fetchsv mean don't really create the GV */
7659 if (SvTYPE(gv) != SVt_PVGV) {
7665 if (lref && !GvCVu(gv)) {
7669 gv_efullname3(tmpsv, gv, NULL);
7670 /* XXX this is probably not what they think they're getting.
7671 * It has the same effect as "sub name;", i.e. just a forward
7673 newSUB(start_subparse(FALSE, 0),
7674 newSVOP(OP_CONST, 0, tmpsv),
7678 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7688 Returns true if the SV has a true value by Perl's rules.
7689 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7690 instead use an in-line version.
7696 Perl_sv_true(pTHX_ register SV *sv)
7701 register const XPV* const tXpv = (XPV*)SvANY(sv);
7703 (tXpv->xpv_cur > 1 ||
7704 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7711 return SvIVX(sv) != 0;
7714 return SvNVX(sv) != 0.0;
7716 return sv_2bool(sv);
7722 =for apidoc sv_pvn_force
7724 Get a sensible string out of the SV somehow.
7725 A private implementation of the C<SvPV_force> macro for compilers which
7726 can't cope with complex macro expressions. Always use the macro instead.
7728 =for apidoc sv_pvn_force_flags
7730 Get a sensible string out of the SV somehow.
7731 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7732 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7733 implemented in terms of this function.
7734 You normally want to use the various wrapper macros instead: see
7735 C<SvPV_force> and C<SvPV_force_nomg>
7741 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7744 if (SvTHINKFIRST(sv) && !SvROK(sv))
7745 sv_force_normal_flags(sv, 0);
7755 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7756 const char * const ref = sv_reftype(sv,0);
7758 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7759 ref, OP_NAME(PL_op));
7761 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7763 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7764 || isGV_with_GP(sv))
7765 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7767 s = sv_2pv_flags(sv, &len, flags);
7771 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7774 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7775 SvGROW(sv, len + 1);
7776 Move(s,SvPVX(sv),len,char);
7778 SvPVX(sv)[len] = '\0';
7781 SvPOK_on(sv); /* validate pointer */
7783 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7784 PTR2UV(sv),SvPVX_const(sv)));
7787 return SvPVX_mutable(sv);
7791 =for apidoc sv_pvbyten_force
7793 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7799 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7801 sv_pvn_force(sv,lp);
7802 sv_utf8_downgrade(sv,0);
7808 =for apidoc sv_pvutf8n_force
7810 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7816 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7818 sv_pvn_force(sv,lp);
7819 sv_utf8_upgrade(sv);
7825 =for apidoc sv_reftype
7827 Returns a string describing what the SV is a reference to.
7833 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7835 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7836 inside return suggests a const propagation bug in g++. */
7837 if (ob && SvOBJECT(sv)) {
7838 char * const name = HvNAME_get(SvSTASH(sv));
7839 return name ? name : (char *) "__ANON__";
7842 switch (SvTYPE(sv)) {
7857 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7858 /* tied lvalues should appear to be
7859 * scalars for backwards compatitbility */
7860 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7861 ? "SCALAR" : "LVALUE");
7862 case SVt_PVAV: return "ARRAY";
7863 case SVt_PVHV: return "HASH";
7864 case SVt_PVCV: return "CODE";
7865 case SVt_PVGV: return "GLOB";
7866 case SVt_PVFM: return "FORMAT";
7867 case SVt_PVIO: return "IO";
7868 case SVt_BIND: return "BIND";
7869 case SVt_REGEXP: return "REGEXP";
7870 default: return "UNKNOWN";
7876 =for apidoc sv_isobject
7878 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7879 object. If the SV is not an RV, or if the object is not blessed, then this
7886 Perl_sv_isobject(pTHX_ SV *sv)
7902 Returns a boolean indicating whether the SV is blessed into the specified
7903 class. This does not check for subtypes; use C<sv_derived_from> to verify
7904 an inheritance relationship.
7910 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7921 hvname = HvNAME_get(SvSTASH(sv));
7925 return strEQ(hvname, name);
7931 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7932 it will be upgraded to one. If C<classname> is non-null then the new SV will
7933 be blessed in the specified package. The new SV is returned and its
7934 reference count is 1.
7940 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7947 SV_CHECK_THINKFIRST_COW_DROP(rv);
7948 (void)SvAMAGIC_off(rv);
7950 if (SvTYPE(rv) >= SVt_PVMG) {
7951 const U32 refcnt = SvREFCNT(rv);
7955 SvREFCNT(rv) = refcnt;
7957 sv_upgrade(rv, SVt_IV);
7958 } else if (SvROK(rv)) {
7959 SvREFCNT_dec(SvRV(rv));
7961 prepare_SV_for_RV(rv);
7969 HV* const stash = gv_stashpv(classname, GV_ADD);
7970 (void)sv_bless(rv, stash);
7976 =for apidoc sv_setref_pv
7978 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7979 argument will be upgraded to an RV. That RV will be modified to point to
7980 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7981 into the SV. The C<classname> argument indicates the package for the
7982 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
7983 will have a reference count of 1, and the RV will be returned.
7985 Do not use with other Perl types such as HV, AV, SV, CV, because those
7986 objects will become corrupted by the pointer copy process.
7988 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7994 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
7998 sv_setsv(rv, &PL_sv_undef);
8002 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8007 =for apidoc sv_setref_iv
8009 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8010 argument will be upgraded to an RV. That RV will be modified to point to
8011 the new SV. The C<classname> argument indicates the package for the
8012 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8013 will have a reference count of 1, and the RV will be returned.
8019 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8021 sv_setiv(newSVrv(rv,classname), iv);
8026 =for apidoc sv_setref_uv
8028 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8029 argument will be upgraded to an RV. That RV will be modified to point to
8030 the new SV. The C<classname> argument indicates the package for the
8031 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8032 will have a reference count of 1, and the RV will be returned.
8038 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8040 sv_setuv(newSVrv(rv,classname), uv);
8045 =for apidoc sv_setref_nv
8047 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8048 argument will be upgraded to an RV. That RV will be modified to point to
8049 the new SV. The C<classname> argument indicates the package for the
8050 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8051 will have a reference count of 1, and the RV will be returned.
8057 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8059 sv_setnv(newSVrv(rv,classname), nv);
8064 =for apidoc sv_setref_pvn
8066 Copies a string into a new SV, optionally blessing the SV. The length of the
8067 string must be specified with C<n>. The C<rv> argument will be upgraded to
8068 an RV. That RV will be modified to point to the new SV. The C<classname>
8069 argument indicates the package for the blessing. Set C<classname> to
8070 C<NULL> to avoid the blessing. The new SV will have a reference count
8071 of 1, and the RV will be returned.
8073 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8079 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8081 sv_setpvn(newSVrv(rv,classname), pv, n);
8086 =for apidoc sv_bless
8088 Blesses an SV into a specified package. The SV must be an RV. The package
8089 must be designated by its stash (see C<gv_stashpv()>). The reference count
8090 of the SV is unaffected.
8096 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8101 Perl_croak(aTHX_ "Can't bless non-reference value");
8103 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8104 if (SvIsCOW(tmpRef))
8105 sv_force_normal_flags(tmpRef, 0);
8106 if (SvREADONLY(tmpRef))
8107 Perl_croak(aTHX_ PL_no_modify);
8108 if (SvOBJECT(tmpRef)) {
8109 if (SvTYPE(tmpRef) != SVt_PVIO)
8111 SvREFCNT_dec(SvSTASH(tmpRef));
8114 SvOBJECT_on(tmpRef);
8115 if (SvTYPE(tmpRef) != SVt_PVIO)
8117 SvUPGRADE(tmpRef, SVt_PVMG);
8118 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8123 (void)SvAMAGIC_off(sv);
8125 if(SvSMAGICAL(tmpRef))
8126 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8134 /* Downgrades a PVGV to a PVMG.
8138 S_sv_unglob(pTHX_ SV *sv)
8143 SV * const temp = sv_newmortal();
8145 assert(SvTYPE(sv) == SVt_PVGV);
8147 gv_efullname3(temp, (GV *) sv, "*");
8150 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8151 mro_method_changed_in(stash);
8155 sv_del_backref((SV*)GvSTASH(sv), sv);
8159 if (GvNAME_HEK(sv)) {
8160 unshare_hek(GvNAME_HEK(sv));
8162 isGV_with_GP_off(sv);
8164 /* need to keep SvANY(sv) in the right arena */
8165 xpvmg = new_XPVMG();
8166 StructCopy(SvANY(sv), xpvmg, XPVMG);
8167 del_XPVGV(SvANY(sv));
8170 SvFLAGS(sv) &= ~SVTYPEMASK;
8171 SvFLAGS(sv) |= SVt_PVMG;
8173 /* Intentionally not calling any local SET magic, as this isn't so much a
8174 set operation as merely an internal storage change. */
8175 sv_setsv_flags(sv, temp, 0);
8179 =for apidoc sv_unref_flags
8181 Unsets the RV status of the SV, and decrements the reference count of
8182 whatever was being referenced by the RV. This can almost be thought of
8183 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8184 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8185 (otherwise the decrementing is conditional on the reference count being
8186 different from one or the reference being a readonly SV).
8193 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8195 SV* const target = SvRV(ref);
8197 if (SvWEAKREF(ref)) {
8198 sv_del_backref(target, ref);
8200 SvRV_set(ref, NULL);
8203 SvRV_set(ref, NULL);
8205 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8206 assigned to as BEGIN {$a = \"Foo"} will fail. */
8207 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8208 SvREFCNT_dec(target);
8209 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8210 sv_2mortal(target); /* Schedule for freeing later */
8214 =for apidoc sv_untaint
8216 Untaint an SV. Use C<SvTAINTED_off> instead.
8221 Perl_sv_untaint(pTHX_ SV *sv)
8223 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8224 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8231 =for apidoc sv_tainted
8233 Test an SV for taintedness. Use C<SvTAINTED> instead.
8238 Perl_sv_tainted(pTHX_ SV *sv)
8240 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8241 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8242 if (mg && (mg->mg_len & 1) )
8249 =for apidoc sv_setpviv
8251 Copies an integer into the given SV, also updating its string value.
8252 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8258 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8260 char buf[TYPE_CHARS(UV)];
8262 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8264 sv_setpvn(sv, ptr, ebuf - ptr);
8268 =for apidoc sv_setpviv_mg
8270 Like C<sv_setpviv>, but also handles 'set' magic.
8276 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8282 #if defined(PERL_IMPLICIT_CONTEXT)
8284 /* pTHX_ magic can't cope with varargs, so this is a no-context
8285 * version of the main function, (which may itself be aliased to us).
8286 * Don't access this version directly.
8290 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8294 va_start(args, pat);
8295 sv_vsetpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
8309 va_start(args, pat);
8310 sv_vsetpvf_mg(sv, pat, &args);
8316 =for apidoc sv_setpvf
8318 Works like C<sv_catpvf> but copies the text into the SV instead of
8319 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8325 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8328 va_start(args, pat);
8329 sv_vsetpvf(sv, pat, &args);
8334 =for apidoc sv_vsetpvf
8336 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8337 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8339 Usually used via its frontend C<sv_setpvf>.
8345 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8347 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8351 =for apidoc sv_setpvf_mg
8353 Like C<sv_setpvf>, but also handles 'set' magic.
8359 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8362 va_start(args, pat);
8363 sv_vsetpvf_mg(sv, pat, &args);
8368 =for apidoc sv_vsetpvf_mg
8370 Like C<sv_vsetpvf>, but also handles 'set' magic.
8372 Usually used via its frontend C<sv_setpvf_mg>.
8378 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8380 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8384 #if defined(PERL_IMPLICIT_CONTEXT)
8386 /* pTHX_ magic can't cope with varargs, so this is a no-context
8387 * version of the main function, (which may itself be aliased to us).
8388 * Don't access this version directly.
8392 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8396 va_start(args, pat);
8397 sv_vcatpvf(sv, pat, &args);
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_mg_nocontext(SV *sv, const char* pat, ...)
8411 va_start(args, pat);
8412 sv_vcatpvf_mg(sv, pat, &args);
8418 =for apidoc sv_catpvf
8420 Processes its arguments like C<sprintf> and appends the formatted
8421 output to an SV. If the appended data contains "wide" characters
8422 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8423 and characters >255 formatted with %c), the original SV might get
8424 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8425 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8426 valid UTF-8; if the original SV was bytes, the pattern should be too.
8431 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8434 va_start(args, pat);
8435 sv_vcatpvf(sv, pat, &args);
8440 =for apidoc sv_vcatpvf
8442 Processes its arguments like C<vsprintf> and appends the formatted output
8443 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8445 Usually used via its frontend C<sv_catpvf>.
8451 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8453 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8457 =for apidoc sv_catpvf_mg
8459 Like C<sv_catpvf>, but also handles 'set' magic.
8465 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8468 va_start(args, pat);
8469 sv_vcatpvf_mg(sv, pat, &args);
8474 =for apidoc sv_vcatpvf_mg
8476 Like C<sv_vcatpvf>, but also handles 'set' magic.
8478 Usually used via its frontend C<sv_catpvf_mg>.
8484 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8486 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8491 =for apidoc sv_vsetpvfn
8493 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8496 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8502 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8504 sv_setpvn(sv, "", 0);
8505 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8509 S_expect_number(pTHX_ char** pattern)
8513 switch (**pattern) {
8514 case '1': case '2': case '3':
8515 case '4': case '5': case '6':
8516 case '7': case '8': case '9':
8517 var = *(*pattern)++ - '0';
8518 while (isDIGIT(**pattern)) {
8519 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8521 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8529 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8531 const int neg = nv < 0;
8540 if (uv & 1 && uv == nv)
8541 uv--; /* Round to even */
8543 const unsigned dig = uv % 10;
8556 =for apidoc sv_vcatpvfn
8558 Processes its arguments like C<vsprintf> and appends the formatted output
8559 to an SV. Uses an array of SVs if the C style variable argument list is
8560 missing (NULL). When running with taint checks enabled, indicates via
8561 C<maybe_tainted> if results are untrustworthy (often due to the use of
8564 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8570 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8571 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8572 vec_utf8 = DO_UTF8(vecsv);
8574 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8577 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8585 static const char nullstr[] = "(null)";
8587 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8588 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8590 /* Times 4: a decimal digit takes more than 3 binary digits.
8591 * NV_DIG: mantissa takes than many decimal digits.
8592 * Plus 32: Playing safe. */
8593 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8594 /* large enough for "%#.#f" --chip */
8595 /* what about long double NVs? --jhi */
8597 PERL_UNUSED_ARG(maybe_tainted);
8599 /* no matter what, this is a string now */
8600 (void)SvPV_force(sv, origlen);
8602 /* special-case "", "%s", and "%-p" (SVf - see below) */
8605 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8607 const char * const s = va_arg(*args, char*);
8608 sv_catpv(sv, s ? s : nullstr);
8610 else if (svix < svmax) {
8611 sv_catsv(sv, *svargs);
8615 if (args && patlen == 3 && pat[0] == '%' &&
8616 pat[1] == '-' && pat[2] == 'p') {
8617 argsv = (SV*)va_arg(*args, void*);
8618 sv_catsv(sv, argsv);
8622 #ifndef USE_LONG_DOUBLE
8623 /* special-case "%.<number>[gf]" */
8624 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8625 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8626 unsigned digits = 0;
8630 while (*pp >= '0' && *pp <= '9')
8631 digits = 10 * digits + (*pp++ - '0');
8632 if (pp - pat == (int)patlen - 1) {
8640 /* Add check for digits != 0 because it seems that some
8641 gconverts are buggy in this case, and we don't yet have
8642 a Configure test for this. */
8643 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8644 /* 0, point, slack */
8645 Gconvert(nv, (int)digits, 0, ebuf);
8647 if (*ebuf) /* May return an empty string for digits==0 */
8650 } else if (!digits) {
8653 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8654 sv_catpvn(sv, p, l);
8660 #endif /* !USE_LONG_DOUBLE */
8662 if (!args && svix < svmax && DO_UTF8(*svargs))
8665 patend = (char*)pat + patlen;
8666 for (p = (char*)pat; p < patend; p = q) {
8669 bool vectorize = FALSE;
8670 bool vectorarg = FALSE;
8671 bool vec_utf8 = FALSE;
8677 bool has_precis = FALSE;
8679 const I32 osvix = svix;
8680 bool is_utf8 = FALSE; /* is this item utf8? */
8681 #ifdef HAS_LDBL_SPRINTF_BUG
8682 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8683 with sfio - Allen <allens@cpan.org> */
8684 bool fix_ldbl_sprintf_bug = FALSE;
8688 U8 utf8buf[UTF8_MAXBYTES+1];
8689 STRLEN esignlen = 0;
8691 const char *eptr = NULL;
8694 const U8 *vecstr = NULL;
8701 /* we need a long double target in case HAS_LONG_DOUBLE but
8704 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8712 const char *dotstr = ".";
8713 STRLEN dotstrlen = 1;
8714 I32 efix = 0; /* explicit format parameter index */
8715 I32 ewix = 0; /* explicit width index */
8716 I32 epix = 0; /* explicit precision index */
8717 I32 evix = 0; /* explicit vector index */
8718 bool asterisk = FALSE;
8720 /* echo everything up to the next format specification */
8721 for (q = p; q < patend && *q != '%'; ++q) ;
8723 if (has_utf8 && !pat_utf8)
8724 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8726 sv_catpvn(sv, p, q - p);
8733 We allow format specification elements in this order:
8734 \d+\$ explicit format parameter index
8736 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8737 0 flag (as above): repeated to allow "v02"
8738 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8739 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8741 [%bcdefginopsuxDFOUX] format (mandatory)
8746 As of perl5.9.3, printf format checking is on by default.
8747 Internally, perl uses %p formats to provide an escape to
8748 some extended formatting. This block deals with those
8749 extensions: if it does not match, (char*)q is reset and
8750 the normal format processing code is used.
8752 Currently defined extensions are:
8753 %p include pointer address (standard)
8754 %-p (SVf) include an SV (previously %_)
8755 %-<num>p include an SV with precision <num>
8756 %<num>p reserved for future extensions
8758 Robin Barker 2005-07-14
8760 %1p (VDf) removed. RMB 2007-10-19
8767 n = expect_number(&q);
8774 argsv = (SV*)va_arg(*args, void*);
8775 eptr = SvPV_const(argsv, elen);
8781 if (ckWARN_d(WARN_INTERNAL))
8782 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8783 "internal %%<num>p might conflict with future printf extensions");
8789 if ( (width = expect_number(&q)) ) {
8804 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8833 if ( (ewix = expect_number(&q)) )
8842 if ((vectorarg = asterisk)) {
8855 width = expect_number(&q);
8861 vecsv = va_arg(*args, SV*);
8863 vecsv = (evix > 0 && evix <= svmax)
8864 ? svargs[evix-1] : &PL_sv_undef;
8866 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8868 dotstr = SvPV_const(vecsv, dotstrlen);
8869 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8870 bad with tied or overloaded values that return UTF8. */
8873 else if (has_utf8) {
8874 vecsv = sv_mortalcopy(vecsv);
8875 sv_utf8_upgrade(vecsv);
8876 dotstr = SvPV_const(vecsv, dotstrlen);
8883 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8884 vecsv = svargs[efix ? efix-1 : svix++];
8885 vecstr = (U8*)SvPV_const(vecsv,veclen);
8886 vec_utf8 = DO_UTF8(vecsv);
8888 /* if this is a version object, we need to convert
8889 * back into v-string notation and then let the
8890 * vectorize happen normally
8892 if (sv_derived_from(vecsv, "version")) {
8893 char *version = savesvpv(vecsv);
8894 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8895 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8896 "vector argument not supported with alpha versions");
8899 vecsv = sv_newmortal();
8900 scan_vstring(version, version + veclen, vecsv);
8901 vecstr = (U8*)SvPV_const(vecsv, veclen);
8902 vec_utf8 = DO_UTF8(vecsv);
8914 i = va_arg(*args, int);
8916 i = (ewix ? ewix <= svmax : svix < svmax) ?
8917 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8919 width = (i < 0) ? -i : i;
8929 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8931 /* XXX: todo, support specified precision parameter */
8935 i = va_arg(*args, int);
8937 i = (ewix ? ewix <= svmax : svix < svmax)
8938 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8940 has_precis = !(i < 0);
8945 precis = precis * 10 + (*q++ - '0');
8954 case 'I': /* Ix, I32x, and I64x */
8956 if (q[1] == '6' && q[2] == '4') {
8962 if (q[1] == '3' && q[2] == '2') {
8972 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8983 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
8984 if (*(q + 1) == 'l') { /* lld, llf */
9010 if (!vectorize && !args) {
9012 const I32 i = efix-1;
9013 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9015 argsv = (svix >= 0 && svix < svmax)
9016 ? svargs[svix++] : &PL_sv_undef;
9027 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9029 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9031 eptr = (char*)utf8buf;
9032 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9046 eptr = va_arg(*args, char*);
9048 #ifdef MACOS_TRADITIONAL
9049 /* On MacOS, %#s format is used for Pascal strings */
9054 elen = strlen(eptr);
9056 eptr = (char *)nullstr;
9057 elen = sizeof nullstr - 1;
9061 eptr = SvPV_const(argsv, elen);
9062 if (DO_UTF8(argsv)) {
9063 I32 old_precis = precis;
9064 if (has_precis && precis < elen) {
9066 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9069 if (width) { /* fudge width (can't fudge elen) */
9070 if (has_precis && precis < elen)
9071 width += precis - old_precis;
9073 width += elen - sv_len_utf8(argsv);
9080 if (has_precis && elen > precis)
9087 if (alt || vectorize)
9089 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9110 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9119 esignbuf[esignlen++] = plus;
9123 case 'h': iv = (short)va_arg(*args, int); break;
9124 case 'l': iv = va_arg(*args, long); break;
9125 case 'V': iv = va_arg(*args, IV); break;
9126 default: iv = va_arg(*args, int); break;
9128 case 'q': iv = va_arg(*args, Quad_t); break;
9133 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9135 case 'h': iv = (short)tiv; break;
9136 case 'l': iv = (long)tiv; break;
9138 default: iv = tiv; break;
9140 case 'q': iv = (Quad_t)tiv; break;
9144 if ( !vectorize ) /* we already set uv above */
9149 esignbuf[esignlen++] = plus;
9153 esignbuf[esignlen++] = '-';
9197 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9208 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9209 case 'l': uv = va_arg(*args, unsigned long); break;
9210 case 'V': uv = va_arg(*args, UV); break;
9211 default: uv = va_arg(*args, unsigned); break;
9213 case 'q': uv = va_arg(*args, Uquad_t); break;
9218 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9220 case 'h': uv = (unsigned short)tuv; break;
9221 case 'l': uv = (unsigned long)tuv; break;
9223 default: uv = tuv; break;
9225 case 'q': uv = (Uquad_t)tuv; break;
9232 char *ptr = ebuf + sizeof ebuf;
9233 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9239 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9245 esignbuf[esignlen++] = '0';
9246 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9254 if (alt && *ptr != '0')
9263 esignbuf[esignlen++] = '0';
9264 esignbuf[esignlen++] = c;
9267 default: /* it had better be ten or less */
9271 } while (uv /= base);
9274 elen = (ebuf + sizeof ebuf) - ptr;
9278 zeros = precis - elen;
9279 else if (precis == 0 && elen == 1 && *eptr == '0'
9280 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9283 /* a precision nullifies the 0 flag. */
9290 /* FLOATING POINT */
9293 c = 'f'; /* maybe %F isn't supported here */
9301 /* This is evil, but floating point is even more evil */
9303 /* for SV-style calling, we can only get NV
9304 for C-style calling, we assume %f is double;
9305 for simplicity we allow any of %Lf, %llf, %qf for long double
9309 #if defined(USE_LONG_DOUBLE)
9313 /* [perl #20339] - we should accept and ignore %lf rather than die */
9317 #if defined(USE_LONG_DOUBLE)
9318 intsize = args ? 0 : 'q';
9322 #if defined(HAS_LONG_DOUBLE)
9331 /* now we need (long double) if intsize == 'q', else (double) */
9333 #if LONG_DOUBLESIZE > DOUBLESIZE
9335 va_arg(*args, long double) :
9336 va_arg(*args, double)
9338 va_arg(*args, double)
9343 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9344 else. frexp() has some unspecified behaviour for those three */
9345 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9347 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9348 will cast our (long double) to (double) */
9349 (void)Perl_frexp(nv, &i);
9350 if (i == PERL_INT_MIN)
9351 Perl_die(aTHX_ "panic: frexp");
9353 need = BIT_DIGITS(i);
9355 need += has_precis ? precis : 6; /* known default */
9360 #ifdef HAS_LDBL_SPRINTF_BUG
9361 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9362 with sfio - Allen <allens@cpan.org> */
9365 # define MY_DBL_MAX DBL_MAX
9366 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9367 # if DOUBLESIZE >= 8
9368 # define MY_DBL_MAX 1.7976931348623157E+308L
9370 # define MY_DBL_MAX 3.40282347E+38L
9374 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9375 # define MY_DBL_MAX_BUG 1L
9377 # define MY_DBL_MAX_BUG MY_DBL_MAX
9381 # define MY_DBL_MIN DBL_MIN
9382 # else /* XXX guessing! -Allen */
9383 # if DOUBLESIZE >= 8
9384 # define MY_DBL_MIN 2.2250738585072014E-308L
9386 # define MY_DBL_MIN 1.17549435E-38L
9390 if ((intsize == 'q') && (c == 'f') &&
9391 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9393 /* it's going to be short enough that
9394 * long double precision is not needed */
9396 if ((nv <= 0L) && (nv >= -0L))
9397 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9399 /* would use Perl_fp_class as a double-check but not
9400 * functional on IRIX - see perl.h comments */
9402 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9403 /* It's within the range that a double can represent */
9404 #if defined(DBL_MAX) && !defined(DBL_MIN)
9405 if ((nv >= ((long double)1/DBL_MAX)) ||
9406 (nv <= (-(long double)1/DBL_MAX)))
9408 fix_ldbl_sprintf_bug = TRUE;
9411 if (fix_ldbl_sprintf_bug == TRUE) {
9421 # undef MY_DBL_MAX_BUG
9424 #endif /* HAS_LDBL_SPRINTF_BUG */
9426 need += 20; /* fudge factor */
9427 if (PL_efloatsize < need) {
9428 Safefree(PL_efloatbuf);
9429 PL_efloatsize = need + 20; /* more fudge */
9430 Newx(PL_efloatbuf, PL_efloatsize, char);
9431 PL_efloatbuf[0] = '\0';
9434 if ( !(width || left || plus || alt) && fill != '0'
9435 && has_precis && intsize != 'q' ) { /* Shortcuts */
9436 /* See earlier comment about buggy Gconvert when digits,
9438 if ( c == 'g' && precis) {
9439 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9440 /* May return an empty string for digits==0 */
9441 if (*PL_efloatbuf) {
9442 elen = strlen(PL_efloatbuf);
9443 goto float_converted;
9445 } else if ( c == 'f' && !precis) {
9446 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9451 char *ptr = ebuf + sizeof ebuf;
9454 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9455 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9456 if (intsize == 'q') {
9457 /* Copy the one or more characters in a long double
9458 * format before the 'base' ([efgEFG]) character to
9459 * the format string. */
9460 static char const prifldbl[] = PERL_PRIfldbl;
9461 char const *p = prifldbl + sizeof(prifldbl) - 3;
9462 while (p >= prifldbl) { *--ptr = *p--; }
9467 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9472 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9484 /* No taint. Otherwise we are in the strange situation
9485 * where printf() taints but print($float) doesn't.
9487 #if defined(HAS_LONG_DOUBLE)
9488 elen = ((intsize == 'q')
9489 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9490 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9492 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9496 eptr = PL_efloatbuf;
9504 i = SvCUR(sv) - origlen;
9507 case 'h': *(va_arg(*args, short*)) = i; break;
9508 default: *(va_arg(*args, int*)) = i; break;
9509 case 'l': *(va_arg(*args, long*)) = i; break;
9510 case 'V': *(va_arg(*args, IV*)) = i; break;
9512 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9517 sv_setuv_mg(argsv, (UV)i);
9518 continue; /* not "break" */
9525 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9526 && ckWARN(WARN_PRINTF))
9528 SV * const msg = sv_newmortal();
9529 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9530 (PL_op->op_type == OP_PRTF) ? "" : "s");
9533 Perl_sv_catpvf(aTHX_ msg,
9534 "\"%%%c\"", c & 0xFF);
9536 Perl_sv_catpvf(aTHX_ msg,
9537 "\"%%\\%03"UVof"\"",
9540 sv_catpvs(msg, "end of string");
9541 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9544 /* output mangled stuff ... */
9550 /* ... right here, because formatting flags should not apply */
9551 SvGROW(sv, SvCUR(sv) + elen + 1);
9553 Copy(eptr, p, elen, char);
9556 SvCUR_set(sv, p - SvPVX_const(sv));
9558 continue; /* not "break" */
9561 if (is_utf8 != has_utf8) {
9564 sv_utf8_upgrade(sv);
9567 const STRLEN old_elen = elen;
9568 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9569 sv_utf8_upgrade(nsv);
9570 eptr = SvPVX_const(nsv);
9573 if (width) { /* fudge width (can't fudge elen) */
9574 width += elen - old_elen;
9580 have = esignlen + zeros + elen;
9582 Perl_croak_nocontext(PL_memory_wrap);
9584 need = (have > width ? have : width);
9587 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9588 Perl_croak_nocontext(PL_memory_wrap);
9589 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9591 if (esignlen && fill == '0') {
9593 for (i = 0; i < (int)esignlen; i++)
9597 memset(p, fill, gap);
9600 if (esignlen && fill != '0') {
9602 for (i = 0; i < (int)esignlen; i++)
9607 for (i = zeros; i; i--)
9611 Copy(eptr, p, elen, char);
9615 memset(p, ' ', gap);
9620 Copy(dotstr, p, dotstrlen, char);
9624 vectorize = FALSE; /* done iterating over vecstr */
9631 SvCUR_set(sv, p - SvPVX_const(sv));
9639 /* =========================================================================
9641 =head1 Cloning an interpreter
9643 All the macros and functions in this section are for the private use of
9644 the main function, perl_clone().
9646 The foo_dup() functions make an exact copy of an existing foo thingy.
9647 During the course of a cloning, a hash table is used to map old addresses
9648 to new addresses. The table is created and manipulated with the
9649 ptr_table_* functions.
9653 ============================================================================*/
9656 #if defined(USE_ITHREADS)
9658 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9659 #ifndef GpREFCNT_inc
9660 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9664 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9665 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9666 If this changes, please unmerge ss_dup. */
9667 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9668 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9669 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9670 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9671 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9672 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9673 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9674 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9675 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9676 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9677 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9678 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9679 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9680 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9682 /* clone a parser */
9685 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9692 /* look for it in the table first */
9693 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9697 /* create anew and remember what it is */
9698 Newxz(parser, 1, yy_parser);
9699 ptr_table_store(PL_ptr_table, proto, parser);
9701 parser->yyerrstatus = 0;
9702 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9704 /* XXX these not yet duped */
9705 parser->old_parser = NULL;
9706 parser->stack = NULL;
9708 parser->stack_size = 0;
9709 /* XXX parser->stack->state = 0; */
9711 /* XXX eventually, just Copy() most of the parser struct ? */
9713 parser->lex_brackets = proto->lex_brackets;
9714 parser->lex_casemods = proto->lex_casemods;
9715 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9716 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9717 parser->lex_casestack = savepvn(proto->lex_casestack,
9718 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9719 parser->lex_defer = proto->lex_defer;
9720 parser->lex_dojoin = proto->lex_dojoin;
9721 parser->lex_expect = proto->lex_expect;
9722 parser->lex_formbrack = proto->lex_formbrack;
9723 parser->lex_inpat = proto->lex_inpat;
9724 parser->lex_inwhat = proto->lex_inwhat;
9725 parser->lex_op = proto->lex_op;
9726 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9727 parser->lex_starts = proto->lex_starts;
9728 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9729 parser->multi_close = proto->multi_close;
9730 parser->multi_open = proto->multi_open;
9731 parser->multi_start = proto->multi_start;
9732 parser->multi_end = proto->multi_end;
9733 parser->pending_ident = proto->pending_ident;
9734 parser->preambled = proto->preambled;
9735 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9736 parser->linestr = sv_dup_inc(proto->linestr, param);
9737 parser->expect = proto->expect;
9738 parser->copline = proto->copline;
9739 parser->last_lop_op = proto->last_lop_op;
9740 parser->lex_state = proto->lex_state;
9741 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9742 /* rsfp_filters entries have fake IoDIRP() */
9743 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9744 parser->in_my = proto->in_my;
9745 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9746 parser->error_count = proto->error_count;
9749 parser->linestr = sv_dup_inc(proto->linestr, param);
9752 char * const ols = SvPVX(proto->linestr);
9753 char * const ls = SvPVX(parser->linestr);
9755 parser->bufptr = ls + (proto->bufptr >= ols ?
9756 proto->bufptr - ols : 0);
9757 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9758 proto->oldbufptr - ols : 0);
9759 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9760 proto->oldoldbufptr - ols : 0);
9761 parser->linestart = ls + (proto->linestart >= ols ?
9762 proto->linestart - ols : 0);
9763 parser->last_uni = ls + (proto->last_uni >= ols ?
9764 proto->last_uni - ols : 0);
9765 parser->last_lop = ls + (proto->last_lop >= ols ?
9766 proto->last_lop - ols : 0);
9768 parser->bufend = ls + SvCUR(parser->linestr);
9771 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9775 parser->endwhite = proto->endwhite;
9776 parser->faketokens = proto->faketokens;
9777 parser->lasttoke = proto->lasttoke;
9778 parser->nextwhite = proto->nextwhite;
9779 parser->realtokenstart = proto->realtokenstart;
9780 parser->skipwhite = proto->skipwhite;
9781 parser->thisclose = proto->thisclose;
9782 parser->thismad = proto->thismad;
9783 parser->thisopen = proto->thisopen;
9784 parser->thisstuff = proto->thisstuff;
9785 parser->thistoken = proto->thistoken;
9786 parser->thiswhite = proto->thiswhite;
9788 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9789 parser->curforce = proto->curforce;
9791 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9792 Copy(proto->nexttype, parser->nexttype, 5, I32);
9793 parser->nexttoke = proto->nexttoke;
9799 /* duplicate a file handle */
9802 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9806 PERL_UNUSED_ARG(type);
9809 return (PerlIO*)NULL;
9811 /* look for it in the table first */
9812 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9816 /* create anew and remember what it is */
9817 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9818 ptr_table_store(PL_ptr_table, fp, ret);
9822 /* duplicate a directory handle */
9825 Perl_dirp_dup(pTHX_ DIR *dp)
9827 PERL_UNUSED_CONTEXT;
9834 /* duplicate a typeglob */
9837 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9843 /* look for it in the table first */
9844 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9848 /* create anew and remember what it is */
9850 ptr_table_store(PL_ptr_table, gp, ret);
9853 ret->gp_refcnt = 0; /* must be before any other dups! */
9854 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9855 ret->gp_io = io_dup_inc(gp->gp_io, param);
9856 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9857 ret->gp_av = av_dup_inc(gp->gp_av, param);
9858 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9859 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9860 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9861 ret->gp_cvgen = gp->gp_cvgen;
9862 ret->gp_line = gp->gp_line;
9863 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9867 /* duplicate a chain of magic */
9870 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9872 MAGIC *mgprev = (MAGIC*)NULL;
9875 return (MAGIC*)NULL;
9876 /* look for it in the table first */
9877 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9881 for (; mg; mg = mg->mg_moremagic) {
9883 Newxz(nmg, 1, MAGIC);
9885 mgprev->mg_moremagic = nmg;
9888 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9889 nmg->mg_private = mg->mg_private;
9890 nmg->mg_type = mg->mg_type;
9891 nmg->mg_flags = mg->mg_flags;
9892 /* FIXME for plugins
9893 if (mg->mg_type == PERL_MAGIC_qr) {
9894 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9898 if(mg->mg_type == PERL_MAGIC_backref) {
9899 /* The backref AV has its reference count deliberately bumped by
9901 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9904 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9905 ? sv_dup_inc(mg->mg_obj, param)
9906 : sv_dup(mg->mg_obj, param);
9908 nmg->mg_len = mg->mg_len;
9909 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9910 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9911 if (mg->mg_len > 0) {
9912 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9913 if (mg->mg_type == PERL_MAGIC_overload_table &&
9914 AMT_AMAGIC((AMT*)mg->mg_ptr))
9916 const AMT * const amtp = (AMT*)mg->mg_ptr;
9917 AMT * const namtp = (AMT*)nmg->mg_ptr;
9919 for (i = 1; i < NofAMmeth; i++) {
9920 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9924 else if (mg->mg_len == HEf_SVKEY)
9925 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9927 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9928 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9935 #endif /* USE_ITHREADS */
9937 /* create a new pointer-mapping table */
9940 Perl_ptr_table_new(pTHX)
9943 PERL_UNUSED_CONTEXT;
9945 Newxz(tbl, 1, PTR_TBL_t);
9948 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9952 #define PTR_TABLE_HASH(ptr) \
9953 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
9956 we use the PTE_SVSLOT 'reservation' made above, both here (in the
9957 following define) and at call to new_body_inline made below in
9958 Perl_ptr_table_store()
9961 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
9963 /* map an existing pointer using a table */
9965 STATIC PTR_TBL_ENT_t *
9966 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
9967 PTR_TBL_ENT_t *tblent;
9968 const UV hash = PTR_TABLE_HASH(sv);
9970 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9971 for (; tblent; tblent = tblent->next) {
9972 if (tblent->oldval == sv)
9979 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
9981 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
9982 PERL_UNUSED_CONTEXT;
9983 return tblent ? tblent->newval : NULL;
9986 /* add a new entry to a pointer-mapping table */
9989 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
9991 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
9992 PERL_UNUSED_CONTEXT;
9995 tblent->newval = newsv;
9997 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
9999 new_body_inline(tblent, PTE_SVSLOT);
10001 tblent->oldval = oldsv;
10002 tblent->newval = newsv;
10003 tblent->next = tbl->tbl_ary[entry];
10004 tbl->tbl_ary[entry] = tblent;
10006 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10007 ptr_table_split(tbl);
10011 /* double the hash bucket size of an existing ptr table */
10014 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10016 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10017 const UV oldsize = tbl->tbl_max + 1;
10018 UV newsize = oldsize * 2;
10020 PERL_UNUSED_CONTEXT;
10022 Renew(ary, newsize, PTR_TBL_ENT_t*);
10023 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10024 tbl->tbl_max = --newsize;
10025 tbl->tbl_ary = ary;
10026 for (i=0; i < oldsize; i++, ary++) {
10027 PTR_TBL_ENT_t **curentp, **entp, *ent;
10030 curentp = ary + oldsize;
10031 for (entp = ary, ent = *ary; ent; ent = *entp) {
10032 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10034 ent->next = *curentp;
10044 /* remove all the entries from a ptr table */
10047 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10049 if (tbl && tbl->tbl_items) {
10050 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10051 UV riter = tbl->tbl_max;
10054 PTR_TBL_ENT_t *entry = array[riter];
10057 PTR_TBL_ENT_t * const oentry = entry;
10058 entry = entry->next;
10063 tbl->tbl_items = 0;
10067 /* clear and free a ptr table */
10070 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10075 ptr_table_clear(tbl);
10076 Safefree(tbl->tbl_ary);
10080 #if defined(USE_ITHREADS)
10083 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10086 SvRV_set(dstr, SvWEAKREF(sstr)
10087 ? sv_dup(SvRV(sstr), param)
10088 : sv_dup_inc(SvRV(sstr), param));
10091 else if (SvPVX_const(sstr)) {
10092 /* Has something there */
10094 /* Normal PV - clone whole allocated space */
10095 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10096 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10097 /* Not that normal - actually sstr is copy on write.
10098 But we are a true, independant SV, so: */
10099 SvREADONLY_off(dstr);
10104 /* Special case - not normally malloced for some reason */
10105 if (isGV_with_GP(sstr)) {
10106 /* Don't need to do anything here. */
10108 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10109 /* A "shared" PV - clone it as "shared" PV */
10111 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10115 /* Some other special case - random pointer */
10116 SvPV_set(dstr, SvPVX(sstr));
10121 /* Copy the NULL */
10122 SvPV_set(dstr, NULL);
10126 /* duplicate an SV of any type (including AV, HV etc) */
10129 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10134 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10136 /* look for it in the table first */
10137 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10141 if(param->flags & CLONEf_JOIN_IN) {
10142 /** We are joining here so we don't want do clone
10143 something that is bad **/
10144 if (SvTYPE(sstr) == SVt_PVHV) {
10145 const HEK * const hvname = HvNAME_HEK(sstr);
10147 /** don't clone stashes if they already exist **/
10148 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10152 /* create anew and remember what it is */
10155 #ifdef DEBUG_LEAKING_SCALARS
10156 dstr->sv_debug_optype = sstr->sv_debug_optype;
10157 dstr->sv_debug_line = sstr->sv_debug_line;
10158 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10159 dstr->sv_debug_cloned = 1;
10160 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10163 ptr_table_store(PL_ptr_table, sstr, dstr);
10166 SvFLAGS(dstr) = SvFLAGS(sstr);
10167 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10168 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10171 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10172 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10173 (void*)PL_watch_pvx, SvPVX_const(sstr));
10176 /* don't clone objects whose class has asked us not to */
10177 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10182 switch (SvTYPE(sstr)) {
10184 SvANY(dstr) = NULL;
10187 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10189 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10191 SvIV_set(dstr, SvIVX(sstr));
10195 SvANY(dstr) = new_XNV();
10196 SvNV_set(dstr, SvNVX(sstr));
10198 /* case SVt_BIND: */
10201 /* These are all the types that need complex bodies allocating. */
10203 const svtype sv_type = SvTYPE(sstr);
10204 const struct body_details *const sv_type_details
10205 = bodies_by_type + sv_type;
10209 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10213 if (GvUNIQUE((GV*)sstr)) {
10214 NOOP; /* Do sharing here, and fall through */
10227 assert(sv_type_details->body_size);
10228 if (sv_type_details->arena) {
10229 new_body_inline(new_body, sv_type);
10231 = (void*)((char*)new_body - sv_type_details->offset);
10233 new_body = new_NOARENA(sv_type_details);
10237 SvANY(dstr) = new_body;
10240 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10241 ((char*)SvANY(dstr)) + sv_type_details->offset,
10242 sv_type_details->copy, char);
10244 Copy(((char*)SvANY(sstr)),
10245 ((char*)SvANY(dstr)),
10246 sv_type_details->body_size + sv_type_details->offset, char);
10249 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10250 && !isGV_with_GP(dstr))
10251 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10253 /* The Copy above means that all the source (unduplicated) pointers
10254 are now in the destination. We can check the flags and the
10255 pointers in either, but it's possible that there's less cache
10256 missing by always going for the destination.
10257 FIXME - instrument and check that assumption */
10258 if (sv_type >= SVt_PVMG) {
10259 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10260 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10261 } else if (SvMAGIC(dstr))
10262 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10264 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10267 /* The cast silences a GCC warning about unhandled types. */
10268 switch ((int)sv_type) {
10278 /* FIXME for plugins */
10279 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10282 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10283 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10284 LvTARG(dstr) = dstr;
10285 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10286 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10288 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10290 if(isGV_with_GP(sstr)) {
10291 if (GvNAME_HEK(dstr))
10292 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10293 /* Don't call sv_add_backref here as it's going to be
10294 created as part of the magic cloning of the symbol
10296 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10297 at the point of this comment. */
10298 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10299 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10300 (void)GpREFCNT_inc(GvGP(dstr));
10302 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10305 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10306 if (IoOFP(dstr) == IoIFP(sstr))
10307 IoOFP(dstr) = IoIFP(dstr);
10309 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10310 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10311 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10312 /* I have no idea why fake dirp (rsfps)
10313 should be treated differently but otherwise
10314 we end up with leaks -- sky*/
10315 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10316 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10317 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10319 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10320 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10321 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10322 if (IoDIRP(dstr)) {
10323 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10326 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10329 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10330 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10331 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10334 if (AvARRAY((AV*)sstr)) {
10335 SV **dst_ary, **src_ary;
10336 SSize_t items = AvFILLp((AV*)sstr) + 1;
10338 src_ary = AvARRAY((AV*)sstr);
10339 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10340 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10341 AvARRAY((AV*)dstr) = dst_ary;
10342 AvALLOC((AV*)dstr) = dst_ary;
10343 if (AvREAL((AV*)sstr)) {
10344 while (items-- > 0)
10345 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10348 while (items-- > 0)
10349 *dst_ary++ = sv_dup(*src_ary++, param);
10351 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10352 while (items-- > 0) {
10353 *dst_ary++ = &PL_sv_undef;
10357 AvARRAY((AV*)dstr) = NULL;
10358 AvALLOC((AV*)dstr) = (SV**)NULL;
10362 if (HvARRAY((HV*)sstr)) {
10364 const bool sharekeys = !!HvSHAREKEYS(sstr);
10365 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10366 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10368 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10369 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10371 HvARRAY(dstr) = (HE**)darray;
10372 while (i <= sxhv->xhv_max) {
10373 const HE * const source = HvARRAY(sstr)[i];
10374 HvARRAY(dstr)[i] = source
10375 ? he_dup(source, sharekeys, param) : 0;
10380 const struct xpvhv_aux * const saux = HvAUX(sstr);
10381 struct xpvhv_aux * const daux = HvAUX(dstr);
10382 /* This flag isn't copied. */
10383 /* SvOOK_on(hv) attacks the IV flags. */
10384 SvFLAGS(dstr) |= SVf_OOK;
10386 hvname = saux->xhv_name;
10387 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10389 daux->xhv_riter = saux->xhv_riter;
10390 daux->xhv_eiter = saux->xhv_eiter
10391 ? he_dup(saux->xhv_eiter,
10392 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10393 daux->xhv_backreferences =
10394 saux->xhv_backreferences
10395 ? (AV*) SvREFCNT_inc(
10396 sv_dup((SV*)saux->xhv_backreferences, param))
10399 daux->xhv_mro_meta = saux->xhv_mro_meta
10400 ? mro_meta_dup(saux->xhv_mro_meta, param)
10403 /* Record stashes for possible cloning in Perl_clone(). */
10405 av_push(param->stashes, dstr);
10409 HvARRAY((HV*)dstr) = NULL;
10412 if (!(param->flags & CLONEf_COPY_STACKS)) {
10416 /* NOTE: not refcounted */
10417 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10419 if (!CvISXSUB(dstr))
10420 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10422 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10423 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10424 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10425 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10427 /* don't dup if copying back - CvGV isn't refcounted, so the
10428 * duped GV may never be freed. A bit of a hack! DAPM */
10429 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10430 NULL : gv_dup(CvGV(dstr), param) ;
10431 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10433 CvWEAKOUTSIDE(sstr)
10434 ? cv_dup( CvOUTSIDE(dstr), param)
10435 : cv_dup_inc(CvOUTSIDE(dstr), param);
10436 if (!CvISXSUB(dstr))
10437 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10443 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10449 /* duplicate a context */
10452 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10454 PERL_CONTEXT *ncxs;
10457 return (PERL_CONTEXT*)NULL;
10459 /* look for it in the table first */
10460 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10464 /* create anew and remember what it is */
10465 Newxz(ncxs, max + 1, PERL_CONTEXT);
10466 ptr_table_store(PL_ptr_table, cxs, ncxs);
10469 PERL_CONTEXT * const cx = &cxs[ix];
10470 PERL_CONTEXT * const ncx = &ncxs[ix];
10471 ncx->cx_type = cx->cx_type;
10472 if (CxTYPE(cx) == CXt_SUBST) {
10473 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10476 ncx->blk_oldsp = cx->blk_oldsp;
10477 ncx->blk_oldcop = cx->blk_oldcop;
10478 ncx->blk_oldmarksp = cx->blk_oldmarksp;
10479 ncx->blk_oldscopesp = cx->blk_oldscopesp;
10480 ncx->blk_oldpm = cx->blk_oldpm;
10481 ncx->blk_gimme = cx->blk_gimme;
10482 switch (CxTYPE(cx)) {
10484 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
10485 ? cv_dup_inc(cx->blk_sub.cv, param)
10486 : cv_dup(cx->blk_sub.cv,param));
10487 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
10488 ? av_dup_inc(cx->blk_sub.argarray, param)
10490 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
10491 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
10492 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10493 ncx->blk_sub.lval = cx->blk_sub.lval;
10494 ncx->blk_sub.retop = cx->blk_sub.retop;
10495 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10496 cx->blk_sub.oldcomppad);
10499 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
10500 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
10501 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
10502 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
10503 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
10504 ncx->blk_eval.retop = cx->blk_eval.retop;
10507 ncx->blk_loop.label = cx->blk_loop.label;
10508 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
10509 ncx->blk_loop.my_op = cx->blk_loop.my_op;
10510 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
10511 ? cx->blk_loop.iterdata
10512 : gv_dup((GV*)cx->blk_loop.iterdata, param));
10513 ncx->blk_loop.oldcomppad
10514 = (PAD*)ptr_table_fetch(PL_ptr_table,
10515 cx->blk_loop.oldcomppad);
10516 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
10517 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
10518 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
10519 ncx->blk_loop.iterix = cx->blk_loop.iterix;
10520 ncx->blk_loop.itermax = cx->blk_loop.itermax;
10523 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
10524 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10525 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
10526 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10527 ncx->blk_sub.retop = cx->blk_sub.retop;
10539 /* duplicate a stack info structure */
10542 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10547 return (PERL_SI*)NULL;
10549 /* look for it in the table first */
10550 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10554 /* create anew and remember what it is */
10555 Newxz(nsi, 1, PERL_SI);
10556 ptr_table_store(PL_ptr_table, si, nsi);
10558 nsi->si_stack = av_dup_inc(si->si_stack, param);
10559 nsi->si_cxix = si->si_cxix;
10560 nsi->si_cxmax = si->si_cxmax;
10561 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10562 nsi->si_type = si->si_type;
10563 nsi->si_prev = si_dup(si->si_prev, param);
10564 nsi->si_next = si_dup(si->si_next, param);
10565 nsi->si_markoff = si->si_markoff;
10570 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10571 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10572 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10573 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10574 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10575 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10576 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10577 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10578 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10579 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10580 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10581 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10582 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10583 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10586 #define pv_dup_inc(p) SAVEPV(p)
10587 #define pv_dup(p) SAVEPV(p)
10588 #define svp_dup_inc(p,pp) any_dup(p,pp)
10590 /* map any object to the new equivent - either something in the
10591 * ptr table, or something in the interpreter structure
10595 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10600 return (void*)NULL;
10602 /* look for it in the table first */
10603 ret = ptr_table_fetch(PL_ptr_table, v);
10607 /* see if it is part of the interpreter structure */
10608 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10609 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10617 /* duplicate the save stack */
10620 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10623 ANY * const ss = proto_perl->Isavestack;
10624 const I32 max = proto_perl->Isavestack_max;
10625 I32 ix = proto_perl->Isavestack_ix;
10638 void (*dptr) (void*);
10639 void (*dxptr) (pTHX_ void*);
10641 Newxz(nss, max, ANY);
10644 const I32 type = POPINT(ss,ix);
10645 TOPINT(nss,ix) = type;
10647 case SAVEt_HELEM: /* hash element */
10648 sv = (SV*)POPPTR(ss,ix);
10649 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10651 case SAVEt_ITEM: /* normal string */
10652 case SAVEt_SV: /* scalar reference */
10653 sv = (SV*)POPPTR(ss,ix);
10654 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10657 case SAVEt_MORTALIZESV:
10658 sv = (SV*)POPPTR(ss,ix);
10659 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10661 case SAVEt_SHARED_PVREF: /* char* in shared space */
10662 c = (char*)POPPTR(ss,ix);
10663 TOPPTR(nss,ix) = savesharedpv(c);
10664 ptr = POPPTR(ss,ix);
10665 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10667 case SAVEt_GENERIC_SVREF: /* generic sv */
10668 case SAVEt_SVREF: /* scalar reference */
10669 sv = (SV*)POPPTR(ss,ix);
10670 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10671 ptr = POPPTR(ss,ix);
10672 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10674 case SAVEt_HV: /* hash reference */
10675 case SAVEt_AV: /* array reference */
10676 sv = (SV*) POPPTR(ss,ix);
10677 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10679 case SAVEt_COMPPAD:
10681 sv = (SV*) POPPTR(ss,ix);
10682 TOPPTR(nss,ix) = sv_dup(sv, param);
10684 case SAVEt_INT: /* int reference */
10685 ptr = POPPTR(ss,ix);
10686 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10687 intval = (int)POPINT(ss,ix);
10688 TOPINT(nss,ix) = intval;
10690 case SAVEt_LONG: /* long reference */
10691 ptr = POPPTR(ss,ix);
10692 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10694 case SAVEt_CLEARSV:
10695 longval = (long)POPLONG(ss,ix);
10696 TOPLONG(nss,ix) = longval;
10698 case SAVEt_I32: /* I32 reference */
10699 case SAVEt_I16: /* I16 reference */
10700 case SAVEt_I8: /* I8 reference */
10701 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10702 ptr = POPPTR(ss,ix);
10703 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10705 TOPINT(nss,ix) = i;
10707 case SAVEt_IV: /* IV reference */
10708 ptr = POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10711 TOPIV(nss,ix) = iv;
10713 case SAVEt_HPTR: /* HV* reference */
10714 case SAVEt_APTR: /* AV* reference */
10715 case SAVEt_SPTR: /* SV* reference */
10716 ptr = POPPTR(ss,ix);
10717 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10718 sv = (SV*)POPPTR(ss,ix);
10719 TOPPTR(nss,ix) = sv_dup(sv, param);
10721 case SAVEt_VPTR: /* random* reference */
10722 ptr = POPPTR(ss,ix);
10723 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10724 ptr = POPPTR(ss,ix);
10725 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10727 case SAVEt_GENERIC_PVREF: /* generic char* */
10728 case SAVEt_PPTR: /* char* reference */
10729 ptr = POPPTR(ss,ix);
10730 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10731 c = (char*)POPPTR(ss,ix);
10732 TOPPTR(nss,ix) = pv_dup(c);
10734 case SAVEt_GP: /* scalar reference */
10735 gp = (GP*)POPPTR(ss,ix);
10736 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10737 (void)GpREFCNT_inc(gp);
10738 gv = (GV*)POPPTR(ss,ix);
10739 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10742 ptr = POPPTR(ss,ix);
10743 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10744 /* these are assumed to be refcounted properly */
10746 switch (((OP*)ptr)->op_type) {
10748 case OP_LEAVESUBLV:
10752 case OP_LEAVEWRITE:
10753 TOPPTR(nss,ix) = ptr;
10756 (void) OpREFCNT_inc(o);
10760 TOPPTR(nss,ix) = NULL;
10765 TOPPTR(nss,ix) = NULL;
10768 c = (char*)POPPTR(ss,ix);
10769 TOPPTR(nss,ix) = pv_dup_inc(c);
10772 hv = (HV*)POPPTR(ss,ix);
10773 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10774 c = (char*)POPPTR(ss,ix);
10775 TOPPTR(nss,ix) = pv_dup_inc(c);
10777 case SAVEt_STACK_POS: /* Position on Perl stack */
10779 TOPINT(nss,ix) = i;
10781 case SAVEt_DESTRUCTOR:
10782 ptr = POPPTR(ss,ix);
10783 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10784 dptr = POPDPTR(ss,ix);
10785 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10786 any_dup(FPTR2DPTR(void *, dptr),
10789 case SAVEt_DESTRUCTOR_X:
10790 ptr = POPPTR(ss,ix);
10791 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10792 dxptr = POPDXPTR(ss,ix);
10793 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10794 any_dup(FPTR2DPTR(void *, dxptr),
10797 case SAVEt_REGCONTEXT:
10800 TOPINT(nss,ix) = i;
10803 case SAVEt_AELEM: /* array element */
10804 sv = (SV*)POPPTR(ss,ix);
10805 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10807 TOPINT(nss,ix) = i;
10808 av = (AV*)POPPTR(ss,ix);
10809 TOPPTR(nss,ix) = av_dup_inc(av, param);
10812 ptr = POPPTR(ss,ix);
10813 TOPPTR(nss,ix) = ptr;
10817 TOPINT(nss,ix) = i;
10818 ptr = POPPTR(ss,ix);
10821 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10822 HINTS_REFCNT_UNLOCK;
10824 TOPPTR(nss,ix) = ptr;
10825 if (i & HINT_LOCALIZE_HH) {
10826 hv = (HV*)POPPTR(ss,ix);
10827 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10831 longval = (long)POPLONG(ss,ix);
10832 TOPLONG(nss,ix) = longval;
10833 ptr = POPPTR(ss,ix);
10834 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10835 sv = (SV*)POPPTR(ss,ix);
10836 TOPPTR(nss,ix) = sv_dup(sv, param);
10839 ptr = POPPTR(ss,ix);
10840 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10841 longval = (long)POPBOOL(ss,ix);
10842 TOPBOOL(nss,ix) = (bool)longval;
10844 case SAVEt_SET_SVFLAGS:
10846 TOPINT(nss,ix) = i;
10848 TOPINT(nss,ix) = i;
10849 sv = (SV*)POPPTR(ss,ix);
10850 TOPPTR(nss,ix) = sv_dup(sv, param);
10852 case SAVEt_RE_STATE:
10854 const struct re_save_state *const old_state
10855 = (struct re_save_state *)
10856 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10857 struct re_save_state *const new_state
10858 = (struct re_save_state *)
10859 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10861 Copy(old_state, new_state, 1, struct re_save_state);
10862 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10864 new_state->re_state_bostr
10865 = pv_dup(old_state->re_state_bostr);
10866 new_state->re_state_reginput
10867 = pv_dup(old_state->re_state_reginput);
10868 new_state->re_state_regeol
10869 = pv_dup(old_state->re_state_regeol);
10870 new_state->re_state_regoffs
10871 = (regexp_paren_pair*)
10872 any_dup(old_state->re_state_regoffs, proto_perl);
10873 new_state->re_state_reglastparen
10874 = (U32*) any_dup(old_state->re_state_reglastparen,
10876 new_state->re_state_reglastcloseparen
10877 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10879 /* XXX This just has to be broken. The old save_re_context
10880 code did SAVEGENERICPV(PL_reg_start_tmp);
10881 PL_reg_start_tmp is char **.
10882 Look above to what the dup code does for
10883 SAVEt_GENERIC_PVREF
10884 It can never have worked.
10885 So this is merely a faithful copy of the exiting bug: */
10886 new_state->re_state_reg_start_tmp
10887 = (char **) pv_dup((char *)
10888 old_state->re_state_reg_start_tmp);
10889 /* I assume that it only ever "worked" because no-one called
10890 (pseudo)fork while the regexp engine had re-entered itself.
10892 #ifdef PERL_OLD_COPY_ON_WRITE
10893 new_state->re_state_nrs
10894 = sv_dup(old_state->re_state_nrs, param);
10896 new_state->re_state_reg_magic
10897 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10899 new_state->re_state_reg_oldcurpm
10900 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10902 new_state->re_state_reg_curpm
10903 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10905 new_state->re_state_reg_oldsaved
10906 = pv_dup(old_state->re_state_reg_oldsaved);
10907 new_state->re_state_reg_poscache
10908 = pv_dup(old_state->re_state_reg_poscache);
10909 new_state->re_state_reg_starttry
10910 = pv_dup(old_state->re_state_reg_starttry);
10913 case SAVEt_COMPILE_WARNINGS:
10914 ptr = POPPTR(ss,ix);
10915 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10918 ptr = POPPTR(ss,ix);
10919 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10923 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10931 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10932 * flag to the result. This is done for each stash before cloning starts,
10933 * so we know which stashes want their objects cloned */
10936 do_mark_cloneable_stash(pTHX_ SV *sv)
10938 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10940 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10941 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10942 if (cloner && GvCV(cloner)) {
10949 mXPUSHs(newSVhek(hvname));
10951 call_sv((SV*)GvCV(cloner), G_SCALAR);
10958 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
10966 =for apidoc perl_clone
10968 Create and return a new interpreter by cloning the current one.
10970 perl_clone takes these flags as parameters:
10972 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10973 without it we only clone the data and zero the stacks,
10974 with it we copy the stacks and the new perl interpreter is
10975 ready to run at the exact same point as the previous one.
10976 The pseudo-fork code uses COPY_STACKS while the
10977 threads->create doesn't.
10979 CLONEf_KEEP_PTR_TABLE
10980 perl_clone keeps a ptr_table with the pointer of the old
10981 variable as a key and the new variable as a value,
10982 this allows it to check if something has been cloned and not
10983 clone it again but rather just use the value and increase the
10984 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10985 the ptr_table using the function
10986 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10987 reason to keep it around is if you want to dup some of your own
10988 variable who are outside the graph perl scans, example of this
10989 code is in threads.xs create
10992 This is a win32 thing, it is ignored on unix, it tells perls
10993 win32host code (which is c++) to clone itself, this is needed on
10994 win32 if you want to run two threads at the same time,
10995 if you just want to do some stuff in a separate perl interpreter
10996 and then throw it away and return to the original one,
10997 you don't need to do anything.
11002 /* XXX the above needs expanding by someone who actually understands it ! */
11003 EXTERN_C PerlInterpreter *
11004 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11007 perl_clone(PerlInterpreter *proto_perl, UV flags)
11010 #ifdef PERL_IMPLICIT_SYS
11012 /* perlhost.h so we need to call into it
11013 to clone the host, CPerlHost should have a c interface, sky */
11015 if (flags & CLONEf_CLONE_HOST) {
11016 return perl_clone_host(proto_perl,flags);
11018 return perl_clone_using(proto_perl, flags,
11020 proto_perl->IMemShared,
11021 proto_perl->IMemParse,
11023 proto_perl->IStdIO,
11027 proto_perl->IProc);
11031 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11032 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11033 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11034 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11035 struct IPerlDir* ipD, struct IPerlSock* ipS,
11036 struct IPerlProc* ipP)
11038 /* XXX many of the string copies here can be optimized if they're
11039 * constants; they need to be allocated as common memory and just
11040 * their pointers copied. */
11043 CLONE_PARAMS clone_params;
11044 CLONE_PARAMS* const param = &clone_params;
11046 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11047 /* for each stash, determine whether its objects should be cloned */
11048 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11049 PERL_SET_THX(my_perl);
11052 PoisonNew(my_perl, 1, PerlInterpreter);
11058 PL_savestack_ix = 0;
11059 PL_savestack_max = -1;
11060 PL_sig_pending = 0;
11062 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11063 # else /* !DEBUGGING */
11064 Zero(my_perl, 1, PerlInterpreter);
11065 # endif /* DEBUGGING */
11067 /* host pointers */
11069 PL_MemShared = ipMS;
11070 PL_MemParse = ipMP;
11077 #else /* !PERL_IMPLICIT_SYS */
11079 CLONE_PARAMS clone_params;
11080 CLONE_PARAMS* param = &clone_params;
11081 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11082 /* for each stash, determine whether its objects should be cloned */
11083 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11084 PERL_SET_THX(my_perl);
11087 PoisonNew(my_perl, 1, PerlInterpreter);
11093 PL_savestack_ix = 0;
11094 PL_savestack_max = -1;
11095 PL_sig_pending = 0;
11097 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11098 # else /* !DEBUGGING */
11099 Zero(my_perl, 1, PerlInterpreter);
11100 # endif /* DEBUGGING */
11101 #endif /* PERL_IMPLICIT_SYS */
11102 param->flags = flags;
11103 param->proto_perl = proto_perl;
11105 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11107 PL_body_arenas = NULL;
11108 Zero(&PL_body_roots, 1, PL_body_roots);
11110 PL_nice_chunk = NULL;
11111 PL_nice_chunk_size = 0;
11113 PL_sv_objcount = 0;
11115 PL_sv_arenaroot = NULL;
11117 PL_debug = proto_perl->Idebug;
11119 PL_hash_seed = proto_perl->Ihash_seed;
11120 PL_rehash_seed = proto_perl->Irehash_seed;
11122 #ifdef USE_REENTRANT_API
11123 /* XXX: things like -Dm will segfault here in perlio, but doing
11124 * PERL_SET_CONTEXT(proto_perl);
11125 * breaks too many other things
11127 Perl_reentrant_init(aTHX);
11130 /* create SV map for pointer relocation */
11131 PL_ptr_table = ptr_table_new();
11133 /* initialize these special pointers as early as possible */
11134 SvANY(&PL_sv_undef) = NULL;
11135 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11136 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11137 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11139 SvANY(&PL_sv_no) = new_XPVNV();
11140 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11141 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11142 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11143 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11144 SvCUR_set(&PL_sv_no, 0);
11145 SvLEN_set(&PL_sv_no, 1);
11146 SvIV_set(&PL_sv_no, 0);
11147 SvNV_set(&PL_sv_no, 0);
11148 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11150 SvANY(&PL_sv_yes) = new_XPVNV();
11151 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11152 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11153 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11154 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11155 SvCUR_set(&PL_sv_yes, 1);
11156 SvLEN_set(&PL_sv_yes, 2);
11157 SvIV_set(&PL_sv_yes, 1);
11158 SvNV_set(&PL_sv_yes, 1);
11159 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11161 /* create (a non-shared!) shared string table */
11162 PL_strtab = newHV();
11163 HvSHAREKEYS_off(PL_strtab);
11164 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11165 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11167 PL_compiling = proto_perl->Icompiling;
11169 /* These two PVs will be free'd special way so must set them same way op.c does */
11170 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11171 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11173 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11174 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11176 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11177 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11178 if (PL_compiling.cop_hints_hash) {
11180 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11181 HINTS_REFCNT_UNLOCK;
11183 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11184 #ifdef PERL_DEBUG_READONLY_OPS
11189 /* pseudo environmental stuff */
11190 PL_origargc = proto_perl->Iorigargc;
11191 PL_origargv = proto_perl->Iorigargv;
11193 param->stashes = newAV(); /* Setup array of objects to call clone on */
11195 /* Set tainting stuff before PerlIO_debug can possibly get called */
11196 PL_tainting = proto_perl->Itainting;
11197 PL_taint_warn = proto_perl->Itaint_warn;
11199 #ifdef PERLIO_LAYERS
11200 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11201 PerlIO_clone(aTHX_ proto_perl, param);
11204 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11205 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11206 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11207 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11208 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11209 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11212 PL_minus_c = proto_perl->Iminus_c;
11213 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11214 PL_localpatches = proto_perl->Ilocalpatches;
11215 PL_splitstr = proto_perl->Isplitstr;
11216 PL_preprocess = proto_perl->Ipreprocess;
11217 PL_minus_n = proto_perl->Iminus_n;
11218 PL_minus_p = proto_perl->Iminus_p;
11219 PL_minus_l = proto_perl->Iminus_l;
11220 PL_minus_a = proto_perl->Iminus_a;
11221 PL_minus_E = proto_perl->Iminus_E;
11222 PL_minus_F = proto_perl->Iminus_F;
11223 PL_doswitches = proto_perl->Idoswitches;
11224 PL_dowarn = proto_perl->Idowarn;
11225 PL_doextract = proto_perl->Idoextract;
11226 PL_sawampersand = proto_perl->Isawampersand;
11227 PL_unsafe = proto_perl->Iunsafe;
11228 PL_inplace = SAVEPV(proto_perl->Iinplace);
11229 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11230 PL_perldb = proto_perl->Iperldb;
11231 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11232 PL_exit_flags = proto_perl->Iexit_flags;
11234 /* magical thingies */
11235 /* XXX time(&PL_basetime) when asked for? */
11236 PL_basetime = proto_perl->Ibasetime;
11237 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11239 PL_maxsysfd = proto_perl->Imaxsysfd;
11240 PL_statusvalue = proto_perl->Istatusvalue;
11242 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11244 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11246 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11248 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11249 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11250 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11253 /* RE engine related */
11254 Zero(&PL_reg_state, 1, struct re_save_state);
11255 PL_reginterp_cnt = 0;
11256 PL_regmatch_slab = NULL;
11258 /* Clone the regex array */
11259 PL_regex_padav = newAV();
11261 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
11262 SV* const * const regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11264 av_push(PL_regex_padav, sv_dup_inc_NN(regexen[0],param));
11265 for(i = 1; i <= len; i++) {
11266 const SV * const regex = regexen[i];
11267 /* FIXME for plugins
11268 newSViv(PTR2IV(CALLREGDUPE(
11269 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11271 /* And while we're at it, can we FIXME on the whole hiding
11272 pointer inside an IV hack? */
11275 ? sv_dup_inc((SV*) regex, param)
11276 : newSViv(PTR2IV(sv_dup_inc(INT2PTR(SV *, SvIVX(regex)), param)))
11278 if (SvFLAGS(regex) & SVf_BREAK)
11279 SvFLAGS(sv) |= SVf_BREAK; /* unrefcnted PL_curpm */
11280 av_push(PL_regex_padav, sv);
11283 PL_regex_pad = AvARRAY(PL_regex_padav);
11285 /* shortcuts to various I/O objects */
11286 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11287 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11288 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11289 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11290 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11291 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11293 /* shortcuts to regexp stuff */
11294 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11296 /* shortcuts to misc objects */
11297 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11299 /* shortcuts to debugging objects */
11300 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11301 PL_DBline = gv_dup(proto_perl->IDBline, param);
11302 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11303 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11304 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11305 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11306 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11308 /* symbol tables */
11309 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11310 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11311 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11312 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11313 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11315 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11316 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11317 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11318 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11319 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11320 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11321 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11322 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11324 PL_sub_generation = proto_perl->Isub_generation;
11325 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11327 /* funky return mechanisms */
11328 PL_forkprocess = proto_perl->Iforkprocess;
11330 /* subprocess state */
11331 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11333 /* internal state */
11334 PL_maxo = proto_perl->Imaxo;
11335 if (proto_perl->Iop_mask)
11336 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11339 /* PL_asserting = proto_perl->Iasserting; */
11341 /* current interpreter roots */
11342 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11344 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11346 PL_main_start = proto_perl->Imain_start;
11347 PL_eval_root = proto_perl->Ieval_root;
11348 PL_eval_start = proto_perl->Ieval_start;
11350 /* runtime control stuff */
11351 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11353 PL_filemode = proto_perl->Ifilemode;
11354 PL_lastfd = proto_perl->Ilastfd;
11355 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11358 PL_gensym = proto_perl->Igensym;
11359 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11360 PL_laststatval = proto_perl->Ilaststatval;
11361 PL_laststype = proto_perl->Ilaststype;
11364 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11366 /* interpreter atexit processing */
11367 PL_exitlistlen = proto_perl->Iexitlistlen;
11368 if (PL_exitlistlen) {
11369 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11370 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11373 PL_exitlist = (PerlExitListEntry*)NULL;
11375 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11376 if (PL_my_cxt_size) {
11377 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11378 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11379 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11380 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11381 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11385 PL_my_cxt_list = (void**)NULL;
11386 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11387 PL_my_cxt_keys = (const char**)NULL;
11390 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11391 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11392 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11394 PL_profiledata = NULL;
11396 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11398 PAD_CLONE_VARS(proto_perl, param);
11400 #ifdef HAVE_INTERP_INTERN
11401 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11404 /* more statics moved here */
11405 PL_generation = proto_perl->Igeneration;
11406 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11408 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11409 PL_in_clean_all = proto_perl->Iin_clean_all;
11411 PL_uid = proto_perl->Iuid;
11412 PL_euid = proto_perl->Ieuid;
11413 PL_gid = proto_perl->Igid;
11414 PL_egid = proto_perl->Iegid;
11415 PL_nomemok = proto_perl->Inomemok;
11416 PL_an = proto_perl->Ian;
11417 PL_evalseq = proto_perl->Ievalseq;
11418 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11419 PL_origalen = proto_perl->Iorigalen;
11420 #ifdef PERL_USES_PL_PIDSTATUS
11421 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11423 PL_osname = SAVEPV(proto_perl->Iosname);
11424 PL_sighandlerp = proto_perl->Isighandlerp;
11426 PL_runops = proto_perl->Irunops;
11428 PL_parser = parser_dup(proto_perl->Iparser, param);
11430 PL_subline = proto_perl->Isubline;
11431 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11434 PL_cryptseen = proto_perl->Icryptseen;
11437 PL_hints = proto_perl->Ihints;
11439 PL_amagic_generation = proto_perl->Iamagic_generation;
11441 #ifdef USE_LOCALE_COLLATE
11442 PL_collation_ix = proto_perl->Icollation_ix;
11443 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11444 PL_collation_standard = proto_perl->Icollation_standard;
11445 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11446 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11447 #endif /* USE_LOCALE_COLLATE */
11449 #ifdef USE_LOCALE_NUMERIC
11450 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11451 PL_numeric_standard = proto_perl->Inumeric_standard;
11452 PL_numeric_local = proto_perl->Inumeric_local;
11453 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11454 #endif /* !USE_LOCALE_NUMERIC */
11456 /* utf8 character classes */
11457 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11458 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11459 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11460 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11461 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11462 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11463 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11464 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11465 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11466 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11467 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11468 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11469 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11470 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11471 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11472 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11473 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11474 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11475 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11476 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11478 /* Did the locale setup indicate UTF-8? */
11479 PL_utf8locale = proto_perl->Iutf8locale;
11480 /* Unicode features (see perlrun/-C) */
11481 PL_unicode = proto_perl->Iunicode;
11483 /* Pre-5.8 signals control */
11484 PL_signals = proto_perl->Isignals;
11486 /* times() ticks per second */
11487 PL_clocktick = proto_perl->Iclocktick;
11489 /* Recursion stopper for PerlIO_find_layer */
11490 PL_in_load_module = proto_perl->Iin_load_module;
11492 /* sort() routine */
11493 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11495 /* Not really needed/useful since the reenrant_retint is "volatile",
11496 * but do it for consistency's sake. */
11497 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11499 /* Hooks to shared SVs and locks. */
11500 PL_sharehook = proto_perl->Isharehook;
11501 PL_lockhook = proto_perl->Ilockhook;
11502 PL_unlockhook = proto_perl->Iunlockhook;
11503 PL_threadhook = proto_perl->Ithreadhook;
11504 PL_destroyhook = proto_perl->Idestroyhook;
11506 #ifdef THREADS_HAVE_PIDS
11507 PL_ppid = proto_perl->Ippid;
11511 PL_last_swash_hv = NULL; /* reinits on demand */
11512 PL_last_swash_klen = 0;
11513 PL_last_swash_key[0]= '\0';
11514 PL_last_swash_tmps = (U8*)NULL;
11515 PL_last_swash_slen = 0;
11517 PL_glob_index = proto_perl->Iglob_index;
11518 PL_srand_called = proto_perl->Isrand_called;
11519 PL_bitcount = NULL; /* reinits on demand */
11521 if (proto_perl->Ipsig_pend) {
11522 Newxz(PL_psig_pend, SIG_SIZE, int);
11525 PL_psig_pend = (int*)NULL;
11528 if (proto_perl->Ipsig_ptr) {
11529 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11530 Newxz(PL_psig_name, SIG_SIZE, SV*);
11531 for (i = 1; i < SIG_SIZE; i++) {
11532 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11533 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11537 PL_psig_ptr = (SV**)NULL;
11538 PL_psig_name = (SV**)NULL;
11541 /* intrpvar.h stuff */
11543 if (flags & CLONEf_COPY_STACKS) {
11544 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11545 PL_tmps_ix = proto_perl->Itmps_ix;
11546 PL_tmps_max = proto_perl->Itmps_max;
11547 PL_tmps_floor = proto_perl->Itmps_floor;
11548 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11550 while (i <= PL_tmps_ix) {
11551 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11555 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11556 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11557 Newxz(PL_markstack, i, I32);
11558 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11559 - proto_perl->Imarkstack);
11560 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11561 - proto_perl->Imarkstack);
11562 Copy(proto_perl->Imarkstack, PL_markstack,
11563 PL_markstack_ptr - PL_markstack + 1, I32);
11565 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11566 * NOTE: unlike the others! */
11567 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11568 PL_scopestack_max = proto_perl->Iscopestack_max;
11569 Newxz(PL_scopestack, PL_scopestack_max, I32);
11570 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11572 /* NOTE: si_dup() looks at PL_markstack */
11573 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11575 /* PL_curstack = PL_curstackinfo->si_stack; */
11576 PL_curstack = av_dup(proto_perl->Icurstack, param);
11577 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11579 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11580 PL_stack_base = AvARRAY(PL_curstack);
11581 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11582 - proto_perl->Istack_base);
11583 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11585 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11586 * NOTE: unlike the others! */
11587 PL_savestack_ix = proto_perl->Isavestack_ix;
11588 PL_savestack_max = proto_perl->Isavestack_max;
11589 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11590 PL_savestack = ss_dup(proto_perl, param);
11594 ENTER; /* perl_destruct() wants to LEAVE; */
11596 /* although we're not duplicating the tmps stack, we should still
11597 * add entries for any SVs on the tmps stack that got cloned by a
11598 * non-refcount means (eg a temp in @_); otherwise they will be
11601 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11602 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11603 proto_perl->Itmps_stack[i]);
11604 if (nsv && !SvREFCNT(nsv)) {
11606 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11611 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11612 PL_top_env = &PL_start_env;
11614 PL_op = proto_perl->Iop;
11617 PL_Xpv = (XPV*)NULL;
11618 my_perl->Ina = proto_perl->Ina;
11620 PL_statbuf = proto_perl->Istatbuf;
11621 PL_statcache = proto_perl->Istatcache;
11622 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11623 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11625 PL_timesbuf = proto_perl->Itimesbuf;
11628 PL_tainted = proto_perl->Itainted;
11629 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11630 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11631 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11632 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11633 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11634 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11635 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11636 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11637 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11639 PL_restartop = proto_perl->Irestartop;
11640 PL_in_eval = proto_perl->Iin_eval;
11641 PL_delaymagic = proto_perl->Idelaymagic;
11642 PL_dirty = proto_perl->Idirty;
11643 PL_localizing = proto_perl->Ilocalizing;
11645 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11646 PL_hv_fetch_ent_mh = NULL;
11647 PL_modcount = proto_perl->Imodcount;
11648 PL_lastgotoprobe = NULL;
11649 PL_dumpindent = proto_perl->Idumpindent;
11651 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11652 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11653 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11654 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11655 PL_efloatbuf = NULL; /* reinits on demand */
11656 PL_efloatsize = 0; /* reinits on demand */
11660 PL_screamfirst = NULL;
11661 PL_screamnext = NULL;
11662 PL_maxscream = -1; /* reinits on demand */
11663 PL_lastscream = NULL;
11666 PL_regdummy = proto_perl->Iregdummy;
11667 PL_colorset = 0; /* reinits PL_colors[] */
11668 /*PL_colors[6] = {0,0,0,0,0,0};*/
11672 /* Pluggable optimizer */
11673 PL_peepp = proto_perl->Ipeepp;
11675 PL_stashcache = newHV();
11677 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11678 proto_perl->Iwatchaddr);
11679 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11680 if (PL_debug && PL_watchaddr) {
11681 PerlIO_printf(Perl_debug_log,
11682 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11683 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11684 PTR2UV(PL_watchok));
11687 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11688 ptr_table_free(PL_ptr_table);
11689 PL_ptr_table = NULL;
11692 /* Call the ->CLONE method, if it exists, for each of the stashes
11693 identified by sv_dup() above.
11695 while(av_len(param->stashes) != -1) {
11696 HV* const stash = (HV*) av_shift(param->stashes);
11697 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11698 if (cloner && GvCV(cloner)) {
11703 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11705 call_sv((SV*)GvCV(cloner), G_DISCARD);
11711 SvREFCNT_dec(param->stashes);
11713 /* orphaned? eg threads->new inside BEGIN or use */
11714 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11715 SvREFCNT_inc_simple_void(PL_compcv);
11716 SAVEFREESV(PL_compcv);
11722 #endif /* USE_ITHREADS */
11725 =head1 Unicode Support
11727 =for apidoc sv_recode_to_utf8
11729 The encoding is assumed to be an Encode object, on entry the PV
11730 of the sv is assumed to be octets in that encoding, and the sv
11731 will be converted into Unicode (and UTF-8).
11733 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11734 is not a reference, nothing is done to the sv. If the encoding is not
11735 an C<Encode::XS> Encoding object, bad things will happen.
11736 (See F<lib/encoding.pm> and L<Encode>).
11738 The PV of the sv is returned.
11743 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11746 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11760 Passing sv_yes is wrong - it needs to be or'ed set of constants
11761 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11762 remove converted chars from source.
11764 Both will default the value - let them.
11766 XPUSHs(&PL_sv_yes);
11769 call_method("decode", G_SCALAR);
11773 s = SvPV_const(uni, len);
11774 if (s != SvPVX_const(sv)) {
11775 SvGROW(sv, len + 1);
11776 Move(s, SvPVX(sv), len + 1, char);
11777 SvCUR_set(sv, len);
11784 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11788 =for apidoc sv_cat_decode
11790 The encoding is assumed to be an Encode object, the PV of the ssv is
11791 assumed to be octets in that encoding and decoding the input starts
11792 from the position which (PV + *offset) pointed to. The dsv will be
11793 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11794 when the string tstr appears in decoding output or the input ends on
11795 the PV of the ssv. The value which the offset points will be modified
11796 to the last input position on the ssv.
11798 Returns TRUE if the terminator was found, else returns FALSE.
11803 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11804 SV *ssv, int *offset, char *tstr, int tlen)
11808 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11819 offsv = newSViv(*offset);
11821 mXPUSHp(tstr, tlen);
11823 call_method("cat_decode", G_SCALAR);
11825 ret = SvTRUE(TOPs);
11826 *offset = SvIV(offsv);
11832 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11837 /* ---------------------------------------------------------------------
11839 * support functions for report_uninit()
11842 /* the maxiumum size of array or hash where we will scan looking
11843 * for the undefined element that triggered the warning */
11845 #define FUV_MAX_SEARCH_SIZE 1000
11847 /* Look for an entry in the hash whose value has the same SV as val;
11848 * If so, return a mortal copy of the key. */
11851 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11854 register HE **array;
11857 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11858 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11861 array = HvARRAY(hv);
11863 for (i=HvMAX(hv); i>0; i--) {
11864 register HE *entry;
11865 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11866 if (HeVAL(entry) != val)
11868 if ( HeVAL(entry) == &PL_sv_undef ||
11869 HeVAL(entry) == &PL_sv_placeholder)
11873 if (HeKLEN(entry) == HEf_SVKEY)
11874 return sv_mortalcopy(HeKEY_sv(entry));
11875 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11881 /* Look for an entry in the array whose value has the same SV as val;
11882 * If so, return the index, otherwise return -1. */
11885 S_find_array_subscript(pTHX_ AV *av, SV* val)
11888 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11889 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11892 if (val != &PL_sv_undef) {
11893 SV ** const svp = AvARRAY(av);
11896 for (i=AvFILLp(av); i>=0; i--)
11903 /* S_varname(): return the name of a variable, optionally with a subscript.
11904 * If gv is non-zero, use the name of that global, along with gvtype (one
11905 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11906 * targ. Depending on the value of the subscript_type flag, return:
11909 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11910 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11911 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11912 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11915 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11916 SV* keyname, I32 aindex, int subscript_type)
11919 SV * const name = sv_newmortal();
11922 buffer[0] = gvtype;
11925 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11927 gv_fullname4(name, gv, buffer, 0);
11929 if ((unsigned int)SvPVX(name)[1] <= 26) {
11931 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11933 /* Swap the 1 unprintable control character for the 2 byte pretty
11934 version - ie substr($name, 1, 1) = $buffer; */
11935 sv_insert(name, 1, 1, buffer, 2);
11939 CV * const cv = find_runcv(NULL);
11943 if (!cv || !CvPADLIST(cv))
11945 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11946 sv = *av_fetch(av, targ, FALSE);
11947 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11950 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11951 SV * const sv = newSV(0);
11952 *SvPVX(name) = '$';
11953 Perl_sv_catpvf(aTHX_ name, "{%s}",
11954 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11957 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11958 *SvPVX(name) = '$';
11959 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11961 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11962 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11969 =for apidoc find_uninit_var
11971 Find the name of the undefined variable (if any) that caused the operator o
11972 to issue a "Use of uninitialized value" warning.
11973 If match is true, only return a name if it's value matches uninit_sv.
11974 So roughly speaking, if a unary operator (such as OP_COS) generates a
11975 warning, then following the direct child of the op may yield an
11976 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
11977 other hand, with OP_ADD there are two branches to follow, so we only print
11978 the variable name if we get an exact match.
11980 The name is returned as a mortal SV.
11982 Assumes that PL_op is the op that originally triggered the error, and that
11983 PL_comppad/PL_curpad points to the currently executing pad.
11989 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
11997 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
11998 uninit_sv == &PL_sv_placeholder)))
12001 switch (obase->op_type) {
12008 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12009 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12012 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12014 if (pad) { /* @lex, %lex */
12015 sv = PAD_SVl(obase->op_targ);
12019 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12020 /* @global, %global */
12021 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12024 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12026 else /* @{expr}, %{expr} */
12027 return find_uninit_var(cUNOPx(obase)->op_first,
12031 /* attempt to find a match within the aggregate */
12033 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12035 subscript_type = FUV_SUBSCRIPT_HASH;
12038 index = find_array_subscript((AV*)sv, uninit_sv);
12040 subscript_type = FUV_SUBSCRIPT_ARRAY;
12043 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12046 return varname(gv, hash ? '%' : '@', obase->op_targ,
12047 keysv, index, subscript_type);
12051 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12053 return varname(NULL, '$', obase->op_targ,
12054 NULL, 0, FUV_SUBSCRIPT_NONE);
12057 gv = cGVOPx_gv(obase);
12058 if (!gv || (match && GvSV(gv) != uninit_sv))
12060 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12063 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12066 av = (AV*)PAD_SV(obase->op_targ);
12067 if (!av || SvRMAGICAL(av))
12069 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12070 if (!svp || *svp != uninit_sv)
12073 return varname(NULL, '$', obase->op_targ,
12074 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12077 gv = cGVOPx_gv(obase);
12083 if (!av || SvRMAGICAL(av))
12085 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12086 if (!svp || *svp != uninit_sv)
12089 return varname(gv, '$', 0,
12090 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12095 o = cUNOPx(obase)->op_first;
12096 if (!o || o->op_type != OP_NULL ||
12097 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12099 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12103 if (PL_op == obase)
12104 /* $a[uninit_expr] or $h{uninit_expr} */
12105 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12108 o = cBINOPx(obase)->op_first;
12109 kid = cBINOPx(obase)->op_last;
12111 /* get the av or hv, and optionally the gv */
12113 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12114 sv = PAD_SV(o->op_targ);
12116 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12117 && cUNOPo->op_first->op_type == OP_GV)
12119 gv = cGVOPx_gv(cUNOPo->op_first);
12122 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12127 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12128 /* index is constant */
12132 if (obase->op_type == OP_HELEM) {
12133 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12134 if (!he || HeVAL(he) != uninit_sv)
12138 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12139 if (!svp || *svp != uninit_sv)
12143 if (obase->op_type == OP_HELEM)
12144 return varname(gv, '%', o->op_targ,
12145 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12147 return varname(gv, '@', o->op_targ, NULL,
12148 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12151 /* index is an expression;
12152 * attempt to find a match within the aggregate */
12153 if (obase->op_type == OP_HELEM) {
12154 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12156 return varname(gv, '%', o->op_targ,
12157 keysv, 0, FUV_SUBSCRIPT_HASH);
12160 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12162 return varname(gv, '@', o->op_targ,
12163 NULL, index, FUV_SUBSCRIPT_ARRAY);
12168 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12170 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12175 /* only examine RHS */
12176 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12179 o = cUNOPx(obase)->op_first;
12180 if (o->op_type == OP_PUSHMARK)
12183 if (!o->op_sibling) {
12184 /* one-arg version of open is highly magical */
12186 if (o->op_type == OP_GV) { /* open FOO; */
12188 if (match && GvSV(gv) != uninit_sv)
12190 return varname(gv, '$', 0,
12191 NULL, 0, FUV_SUBSCRIPT_NONE);
12193 /* other possibilities not handled are:
12194 * open $x; or open my $x; should return '${*$x}'
12195 * open expr; should return '$'.expr ideally
12201 /* ops where $_ may be an implicit arg */
12205 if ( !(obase->op_flags & OPf_STACKED)) {
12206 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12207 ? PAD_SVl(obase->op_targ)
12210 sv = sv_newmortal();
12211 sv_setpvn(sv, "$_", 2);
12220 /* skip filehandle as it can't produce 'undef' warning */
12221 o = cUNOPx(obase)->op_first;
12222 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12223 o = o->op_sibling->op_sibling;
12229 match = 1; /* XS or custom code could trigger random warnings */
12234 /* XXX tmp hack: these two may call an XS sub, and currently
12235 XS subs don't have a SUB entry on the context stack, so CV and
12236 pad determination goes wrong, and BAD things happen. So, just
12237 don't try to determine the value under those circumstances.
12238 Need a better fix at dome point. DAPM 11/2007 */
12242 /* def-ness of rval pos() is independent of the def-ness of its arg */
12243 if ( !(obase->op_flags & OPf_MOD))
12248 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12249 return newSVpvs_flags("${$/}", SVs_TEMP);
12254 if (!(obase->op_flags & OPf_KIDS))
12256 o = cUNOPx(obase)->op_first;
12262 /* if all except one arg are constant, or have no side-effects,
12263 * or are optimized away, then it's unambiguous */
12265 for (kid=o; kid; kid = kid->op_sibling) {
12267 const OPCODE type = kid->op_type;
12268 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12269 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12270 || (type == OP_PUSHMARK)
12274 if (o2) { /* more than one found */
12281 return find_uninit_var(o2, uninit_sv, match);
12283 /* scan all args */
12285 sv = find_uninit_var(o, uninit_sv, 1);
12297 =for apidoc report_uninit
12299 Print appropriate "Use of uninitialized variable" warning
12305 Perl_report_uninit(pTHX_ SV* uninit_sv)
12309 SV* varname = NULL;
12311 varname = find_uninit_var(PL_op, uninit_sv,0);
12313 sv_insert(varname, 0, 0, " ", 1);
12315 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12316 varname ? SvPV_nolen_const(varname) : "",
12317 " in ", OP_DESC(PL_op));
12320 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12326 * c-indentation-style: bsd
12327 * c-basic-offset: 4
12328 * indent-tabs-mode: t
12331 * ex: set ts=8 sts=4 sw=4 noet: