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 *const chunk, const 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 *const ptr, const U32 size, const 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, const U32 flags, const 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 *const 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 *const 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_ const size_t arena_size, const 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_allocated), sizeof(xpvio_allocated),
957 + relative_STRUCT_OFFSET(xpvio_allocated, XPVIO, xpv_cur),
958 SVt_PVIO, TRUE, NONV, HASARENA, FIT_ARENA(24, sizeof(xpvio_allocated)) },
961 #define new_body_type(sv_type) \
962 (void *)((char *)S_new_body(aTHX_ sv_type))
964 #define del_body_type(p, sv_type) \
965 del_body(p, &PL_body_roots[sv_type])
968 #define new_body_allocated(sv_type) \
969 (void *)((char *)S_new_body(aTHX_ sv_type) \
970 - bodies_by_type[sv_type].offset)
972 #define del_body_allocated(p, sv_type) \
973 del_body(p + bodies_by_type[sv_type].offset, &PL_body_roots[sv_type])
976 #define my_safemalloc(s) (void*)safemalloc(s)
977 #define my_safecalloc(s) (void*)safecalloc(s, 1)
978 #define my_safefree(p) safefree((char*)p)
982 #define new_XNV() my_safemalloc(sizeof(XPVNV))
983 #define del_XNV(p) my_safefree(p)
985 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
986 #define del_XPVNV(p) my_safefree(p)
988 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
989 #define del_XPVAV(p) my_safefree(p)
991 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
992 #define del_XPVHV(p) my_safefree(p)
994 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
995 #define del_XPVMG(p) my_safefree(p)
997 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
998 #define del_XPVGV(p) my_safefree(p)
1002 #define new_XNV() new_body_type(SVt_NV)
1003 #define del_XNV(p) del_body_type(p, SVt_NV)
1005 #define new_XPVNV() new_body_type(SVt_PVNV)
1006 #define del_XPVNV(p) del_body_type(p, SVt_PVNV)
1008 #define new_XPVAV() new_body_allocated(SVt_PVAV)
1009 #define del_XPVAV(p) del_body_allocated(p, SVt_PVAV)
1011 #define new_XPVHV() new_body_allocated(SVt_PVHV)
1012 #define del_XPVHV(p) del_body_allocated(p, SVt_PVHV)
1014 #define new_XPVMG() new_body_type(SVt_PVMG)
1015 #define del_XPVMG(p) del_body_type(p, SVt_PVMG)
1017 #define new_XPVGV() new_body_type(SVt_PVGV)
1018 #define del_XPVGV(p) del_body_type(p, SVt_PVGV)
1022 /* no arena for you! */
1024 #define new_NOARENA(details) \
1025 my_safemalloc((details)->body_size + (details)->offset)
1026 #define new_NOARENAZ(details) \
1027 my_safecalloc((details)->body_size + (details)->offset)
1030 S_more_bodies (pTHX_ const svtype sv_type)
1033 void ** const root = &PL_body_roots[sv_type];
1034 const struct body_details * const bdp = &bodies_by_type[sv_type];
1035 const size_t body_size = bdp->body_size;
1038 #if defined(DEBUGGING) && !defined(PERL_GLOBAL_STRUCT_PRIVATE)
1039 static bool done_sanity_check;
1041 /* PERL_GLOBAL_STRUCT_PRIVATE cannot coexist with global
1042 * variables like done_sanity_check. */
1043 if (!done_sanity_check) {
1044 unsigned int i = SVt_LAST;
1046 done_sanity_check = TRUE;
1049 assert (bodies_by_type[i].type == i);
1053 assert(bdp->arena_size);
1055 start = (char*) Perl_get_arena(aTHX_ bdp->arena_size, sv_type);
1057 end = start + bdp->arena_size - body_size;
1059 /* computed count doesnt reflect the 1st slot reservation */
1060 DEBUG_m(PerlIO_printf(Perl_debug_log,
1061 "arena %p end %p arena-size %d type %d size %d ct %d\n",
1062 (void*)start, (void*)end,
1063 (int)bdp->arena_size, sv_type, (int)body_size,
1064 (int)bdp->arena_size / (int)body_size));
1066 *root = (void *)start;
1068 while (start < end) {
1069 char * const next = start + body_size;
1070 *(void**) start = (void *)next;
1073 *(void **)start = 0;
1078 /* grab a new thing from the free list, allocating more if necessary.
1079 The inline version is used for speed in hot routines, and the
1080 function using it serves the rest (unless PURIFY).
1082 #define new_body_inline(xpv, sv_type) \
1084 void ** const r3wt = &PL_body_roots[sv_type]; \
1085 xpv = (PTR_TBL_ENT_t*) (*((void **)(r3wt)) \
1086 ? *((void **)(r3wt)) : more_bodies(sv_type)); \
1087 *(r3wt) = *(void**)(xpv); \
1093 S_new_body(pTHX_ const svtype sv_type)
1097 new_body_inline(xpv, sv_type);
1103 static const struct body_details fake_rv =
1104 { 0, 0, 0, SVt_IV, FALSE, NONV, NOARENA, 0 };
1107 =for apidoc sv_upgrade
1109 Upgrade an SV to a more complex form. Generally adds a new body type to the
1110 SV, then copies across as much information as possible from the old body.
1111 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1117 Perl_sv_upgrade(pTHX_ register SV *sv, svtype new_type)
1122 const svtype old_type = SvTYPE(sv);
1123 const struct body_details *new_type_details;
1124 const struct body_details *old_type_details
1125 = bodies_by_type + old_type;
1126 SV *referant = NULL;
1128 if (new_type != SVt_PV && SvIsCOW(sv)) {
1129 sv_force_normal_flags(sv, 0);
1132 if (old_type == new_type)
1135 old_body = SvANY(sv);
1137 /* Copying structures onto other structures that have been neatly zeroed
1138 has a subtle gotcha. Consider XPVMG
1140 +------+------+------+------+------+-------+-------+
1141 | NV | CUR | LEN | IV | MAGIC | STASH |
1142 +------+------+------+------+------+-------+-------+
1143 0 4 8 12 16 20 24 28
1145 where NVs are aligned to 8 bytes, so that sizeof that structure is
1146 actually 32 bytes long, with 4 bytes of padding at the end:
1148 +------+------+------+------+------+-------+-------+------+
1149 | NV | CUR | LEN | IV | MAGIC | STASH | ??? |
1150 +------+------+------+------+------+-------+-------+------+
1151 0 4 8 12 16 20 24 28 32
1153 so what happens if you allocate memory for this structure:
1155 +------+------+------+------+------+-------+-------+------+------+...
1156 | NV | CUR | LEN | IV | MAGIC | STASH | GP | NAME |
1157 +------+------+------+------+------+-------+-------+------+------+...
1158 0 4 8 12 16 20 24 28 32 36
1160 zero it, then copy sizeof(XPVMG) bytes on top of it? Not quite what you
1161 expect, because you copy the area marked ??? onto GP. Now, ??? may have
1162 started out as zero once, but it's quite possible that it isn't. So now,
1163 rather than a nicely zeroed GP, you have it pointing somewhere random.
1166 (In fact, GP ends up pointing at a previous GP structure, because the
1167 principle cause of the padding in XPVMG getting garbage is a copy of
1168 sizeof(XPVMG) bytes from a XPVGV structure in sv_unglob. Right now
1169 this happens to be moot because XPVGV has been re-ordered, with GP
1170 no longer after STASH)
1172 So we are careful and work out the size of used parts of all the
1180 referant = SvRV(sv);
1181 old_type_details = &fake_rv;
1182 if (new_type == SVt_NV)
1183 new_type = SVt_PVNV;
1185 if (new_type < SVt_PVIV) {
1186 new_type = (new_type == SVt_NV)
1187 ? SVt_PVNV : SVt_PVIV;
1192 if (new_type < SVt_PVNV) {
1193 new_type = SVt_PVNV;
1197 assert(new_type > SVt_PV);
1198 assert(SVt_IV < SVt_PV);
1199 assert(SVt_NV < SVt_PV);
1206 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1207 there's no way that it can be safely upgraded, because perl.c
1208 expects to Safefree(SvANY(PL_mess_sv)) */
1209 assert(sv != PL_mess_sv);
1210 /* This flag bit is used to mean other things in other scalar types.
1211 Given that it only has meaning inside the pad, it shouldn't be set
1212 on anything that can get upgraded. */
1213 assert(!SvPAD_TYPED(sv));
1216 if (old_type_details->cant_upgrade)
1217 Perl_croak(aTHX_ "Can't upgrade %s (%" UVuf ") to %" UVuf,
1218 sv_reftype(sv, 0), (UV) old_type, (UV) new_type);
1221 if (old_type > new_type)
1222 Perl_croak(aTHX_ "sv_upgrade from type %d down to type %d",
1223 (int)old_type, (int)new_type);
1225 new_type_details = bodies_by_type + new_type;
1227 SvFLAGS(sv) &= ~SVTYPEMASK;
1228 SvFLAGS(sv) |= new_type;
1230 /* This can't happen, as SVt_NULL is <= all values of new_type, so one of
1231 the return statements above will have triggered. */
1232 assert (new_type != SVt_NULL);
1235 assert(old_type == SVt_NULL);
1236 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
1240 assert(old_type == SVt_NULL);
1241 SvANY(sv) = new_XNV();
1246 assert(new_type_details->body_size);
1249 assert(new_type_details->arena);
1250 assert(new_type_details->arena_size);
1251 /* This points to the start of the allocated area. */
1252 new_body_inline(new_body, new_type);
1253 Zero(new_body, new_type_details->body_size, char);
1254 new_body = ((char *)new_body) - new_type_details->offset;
1256 /* We always allocated the full length item with PURIFY. To do this
1257 we fake things so that arena is false for all 16 types.. */
1258 new_body = new_NOARENAZ(new_type_details);
1260 SvANY(sv) = new_body;
1261 if (new_type == SVt_PVAV) {
1265 if (old_type_details->body_size) {
1268 /* It will have been zeroed when the new body was allocated.
1269 Lets not write to it, in case it confuses a write-back
1275 #ifndef NODEFAULT_SHAREKEYS
1276 HvSHAREKEYS_on(sv); /* key-sharing on by default */
1278 HvMAX(sv) = 7; /* (start with 8 buckets) */
1279 if (old_type_details->body_size) {
1282 /* It will have been zeroed when the new body was allocated.
1283 Lets not write to it, in case it confuses a write-back
1288 /* SVt_NULL isn't the only thing upgraded to AV or HV.
1289 The target created by newSVrv also is, and it can have magic.
1290 However, it never has SvPVX set.
1292 if (old_type == SVt_IV) {
1294 } else if (old_type >= SVt_PV) {
1295 assert(SvPVX_const(sv) == 0);
1298 if (old_type >= SVt_PVMG) {
1299 SvMAGIC_set(sv, ((XPVMG*)old_body)->xmg_u.xmg_magic);
1300 SvSTASH_set(sv, ((XPVMG*)old_body)->xmg_stash);
1302 sv->sv_u.svu_array = NULL; /* or svu_hash */
1308 /* XXX Is this still needed? Was it ever needed? Surely as there is
1309 no route from NV to PVIV, NOK can never be true */
1310 assert(!SvNOKp(sv));
1322 assert(new_type_details->body_size);
1323 /* We always allocated the full length item with PURIFY. To do this
1324 we fake things so that arena is false for all 16 types.. */
1325 if(new_type_details->arena) {
1326 /* This points to the start of the allocated area. */
1327 new_body_inline(new_body, new_type);
1328 Zero(new_body, new_type_details->body_size, char);
1329 new_body = ((char *)new_body) - new_type_details->offset;
1331 new_body = new_NOARENAZ(new_type_details);
1333 SvANY(sv) = new_body;
1335 if (old_type_details->copy) {
1336 /* There is now the potential for an upgrade from something without
1337 an offset (PVNV or PVMG) to something with one (PVCV, PVFM) */
1338 int offset = old_type_details->offset;
1339 int length = old_type_details->copy;
1341 if (new_type_details->offset > old_type_details->offset) {
1342 const int difference
1343 = new_type_details->offset - old_type_details->offset;
1344 offset += difference;
1345 length -= difference;
1347 assert (length >= 0);
1349 Copy((char *)old_body + offset, (char *)new_body + offset, length,
1353 #ifndef NV_ZERO_IS_ALLBITS_ZERO
1354 /* If NV 0.0 is stores as all bits 0 then Zero() already creates a
1355 * correct 0.0 for us. Otherwise, if the old body didn't have an
1356 * NV slot, but the new one does, then we need to initialise the
1357 * freshly created NV slot with whatever the correct bit pattern is
1359 if (old_type_details->zero_nv && !new_type_details->zero_nv
1360 && !isGV_with_GP(sv))
1364 if (new_type == SVt_PVIO)
1365 IoPAGE_LEN(sv) = 60;
1366 if (old_type < SVt_PV) {
1367 /* referant will be NULL unless the old type was SVt_IV emulating
1369 sv->sv_u.svu_rv = referant;
1373 Perl_croak(aTHX_ "panic: sv_upgrade to unknown type %lu",
1374 (unsigned long)new_type);
1377 if (old_type_details->arena) {
1378 /* If there was an old body, then we need to free it.
1379 Note that there is an assumption that all bodies of types that
1380 can be upgraded came from arenas. Only the more complex non-
1381 upgradable types are allowed to be directly malloc()ed. */
1383 my_safefree(old_body);
1385 del_body((void*)((char*)old_body + old_type_details->offset),
1386 &PL_body_roots[old_type]);
1392 =for apidoc sv_backoff
1394 Remove any string offset. You should normally use the C<SvOOK_off> macro
1401 Perl_sv_backoff(pTHX_ register SV *sv)
1404 const char * const s = SvPVX_const(sv);
1405 PERL_UNUSED_CONTEXT;
1407 assert(SvTYPE(sv) != SVt_PVHV);
1408 assert(SvTYPE(sv) != SVt_PVAV);
1410 SvOOK_offset(sv, delta);
1412 SvLEN_set(sv, SvLEN(sv) + delta);
1413 SvPV_set(sv, SvPVX(sv) - delta);
1414 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
1415 SvFLAGS(sv) &= ~SVf_OOK;
1422 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1423 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1424 Use the C<SvGROW> wrapper instead.
1430 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
1434 if (PL_madskills && newlen >= 0x100000) {
1435 PerlIO_printf(Perl_debug_log,
1436 "Allocation too large: %"UVxf"\n", (UV)newlen);
1438 #ifdef HAS_64K_LIMIT
1439 if (newlen >= 0x10000) {
1440 PerlIO_printf(Perl_debug_log,
1441 "Allocation too large: %"UVxf"\n", (UV)newlen);
1444 #endif /* HAS_64K_LIMIT */
1447 if (SvTYPE(sv) < SVt_PV) {
1448 sv_upgrade(sv, SVt_PV);
1449 s = SvPVX_mutable(sv);
1451 else if (SvOOK(sv)) { /* pv is offset? */
1453 s = SvPVX_mutable(sv);
1454 if (newlen > SvLEN(sv))
1455 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
1456 #ifdef HAS_64K_LIMIT
1457 if (newlen >= 0x10000)
1462 s = SvPVX_mutable(sv);
1464 if (newlen > SvLEN(sv)) { /* need more room? */
1465 newlen = PERL_STRLEN_ROUNDUP(newlen);
1466 if (SvLEN(sv) && s) {
1468 const STRLEN l = malloced_size((void*)SvPVX_const(sv));
1474 s = (char*)saferealloc(s, newlen);
1477 s = (char*)safemalloc(newlen);
1478 if (SvPVX_const(sv) && SvCUR(sv)) {
1479 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
1483 SvLEN_set(sv, newlen);
1489 =for apidoc sv_setiv
1491 Copies an integer into the given SV, upgrading first if necessary.
1492 Does not handle 'set' magic. See also C<sv_setiv_mg>.
1498 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
1501 SV_CHECK_THINKFIRST_COW_DROP(sv);
1502 switch (SvTYPE(sv)) {
1505 sv_upgrade(sv, SVt_IV);
1508 sv_upgrade(sv, SVt_PVIV);
1517 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
1521 (void)SvIOK_only(sv); /* validate number */
1527 =for apidoc sv_setiv_mg
1529 Like C<sv_setiv>, but also handles 'set' magic.
1535 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
1542 =for apidoc sv_setuv
1544 Copies an unsigned integer into the given SV, upgrading first if necessary.
1545 Does not handle 'set' magic. See also C<sv_setuv_mg>.
1551 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
1553 /* With these two if statements:
1554 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
1557 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
1559 If you wish to remove them, please benchmark to see what the effect is
1561 if (u <= (UV)IV_MAX) {
1562 sv_setiv(sv, (IV)u);
1571 =for apidoc sv_setuv_mg
1573 Like C<sv_setuv>, but also handles 'set' magic.
1579 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
1586 =for apidoc sv_setnv
1588 Copies a double into the given SV, upgrading first if necessary.
1589 Does not handle 'set' magic. See also C<sv_setnv_mg>.
1595 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
1598 SV_CHECK_THINKFIRST_COW_DROP(sv);
1599 switch (SvTYPE(sv)) {
1602 sv_upgrade(sv, SVt_NV);
1606 sv_upgrade(sv, SVt_PVNV);
1615 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
1620 (void)SvNOK_only(sv); /* validate number */
1625 =for apidoc sv_setnv_mg
1627 Like C<sv_setnv>, but also handles 'set' magic.
1633 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
1639 /* Print an "isn't numeric" warning, using a cleaned-up,
1640 * printable version of the offending string
1644 S_not_a_number(pTHX_ SV *sv)
1652 dsv = newSVpvs_flags("", SVs_TEMP);
1653 pv = sv_uni_display(dsv, sv, 10, 0);
1656 const char * const limit = tmpbuf + sizeof(tmpbuf) - 8;
1657 /* each *s can expand to 4 chars + "...\0",
1658 i.e. need room for 8 chars */
1660 const char *s = SvPVX_const(sv);
1661 const char * const end = s + SvCUR(sv);
1662 for ( ; s < end && d < limit; s++ ) {
1664 if (ch & 128 && !isPRINT_LC(ch)) {
1673 else if (ch == '\r') {
1677 else if (ch == '\f') {
1681 else if (ch == '\\') {
1685 else if (ch == '\0') {
1689 else if (isPRINT_LC(ch))
1706 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1707 "Argument \"%s\" isn't numeric in %s", pv,
1710 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
1711 "Argument \"%s\" isn't numeric", pv);
1715 =for apidoc looks_like_number
1717 Test if the content of an SV looks like a number (or is a number).
1718 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1719 non-numeric warning), even if your atof() doesn't grok them.
1725 Perl_looks_like_number(pTHX_ SV *sv)
1727 register const char *sbegin;
1731 sbegin = SvPVX_const(sv);
1734 else if (SvPOKp(sv))
1735 sbegin = SvPV_const(sv, len);
1737 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
1738 return grok_number(sbegin, len, NULL);
1742 S_glob_2number(pTHX_ GV * const gv)
1744 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1745 SV *const buffer = sv_newmortal();
1747 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1750 gv_efullname3(buffer, gv, "*");
1751 SvFLAGS(gv) |= wasfake;
1753 /* We know that all GVs stringify to something that is not-a-number,
1754 so no need to test that. */
1755 if (ckWARN(WARN_NUMERIC))
1756 not_a_number(buffer);
1757 /* We just want something true to return, so that S_sv_2iuv_common
1758 can tail call us and return true. */
1763 S_glob_2pv(pTHX_ GV * const gv, STRLEN * const len)
1765 const U32 wasfake = SvFLAGS(gv) & SVf_FAKE;
1766 SV *const buffer = sv_newmortal();
1768 /* FAKE globs can get coerced, so need to turn this off temporarily if it
1771 gv_efullname3(buffer, gv, "*");
1772 SvFLAGS(gv) |= wasfake;
1774 assert(SvPOK(buffer));
1776 *len = SvCUR(buffer);
1778 return SvPVX(buffer);
1781 /* Actually, ISO C leaves conversion of UV to IV undefined, but
1782 until proven guilty, assume that things are not that bad... */
1787 As 64 bit platforms often have an NV that doesn't preserve all bits of
1788 an IV (an assumption perl has been based on to date) it becomes necessary
1789 to remove the assumption that the NV always carries enough precision to
1790 recreate the IV whenever needed, and that the NV is the canonical form.
1791 Instead, IV/UV and NV need to be given equal rights. So as to not lose
1792 precision as a side effect of conversion (which would lead to insanity
1793 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1794 1) to distinguish between IV/UV/NV slots that have cached a valid
1795 conversion where precision was lost and IV/UV/NV slots that have a
1796 valid conversion which has lost no precision
1797 2) to ensure that if a numeric conversion to one form is requested that
1798 would lose precision, the precise conversion (or differently
1799 imprecise conversion) is also performed and cached, to prevent
1800 requests for different numeric formats on the same SV causing
1801 lossy conversion chains. (lossless conversion chains are perfectly
1806 SvIOKp is true if the IV slot contains a valid value
1807 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1808 SvNOKp is true if the NV slot contains a valid value
1809 SvNOK is true only if the NV value is accurate
1812 while converting from PV to NV, check to see if converting that NV to an
1813 IV(or UV) would lose accuracy over a direct conversion from PV to
1814 IV(or UV). If it would, cache both conversions, return NV, but mark
1815 SV as IOK NOKp (ie not NOK).
1817 While converting from PV to IV, check to see if converting that IV to an
1818 NV would lose accuracy over a direct conversion from PV to NV. If it
1819 would, cache both conversions, flag similarly.
1821 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1822 correctly because if IV & NV were set NV *always* overruled.
1823 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1824 changes - now IV and NV together means that the two are interchangeable:
1825 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
1827 The benefit of this is that operations such as pp_add know that if
1828 SvIOK is true for both left and right operands, then integer addition
1829 can be used instead of floating point (for cases where the result won't
1830 overflow). Before, floating point was always used, which could lead to
1831 loss of precision compared with integer addition.
1833 * making IV and NV equal status should make maths accurate on 64 bit
1835 * may speed up maths somewhat if pp_add and friends start to use
1836 integers when possible instead of fp. (Hopefully the overhead in
1837 looking for SvIOK and checking for overflow will not outweigh the
1838 fp to integer speedup)
1839 * will slow down integer operations (callers of SvIV) on "inaccurate"
1840 values, as the change from SvIOK to SvIOKp will cause a call into
1841 sv_2iv each time rather than a macro access direct to the IV slot
1842 * should speed up number->string conversion on integers as IV is
1843 favoured when IV and NV are equally accurate
1845 ####################################################################
1846 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1847 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1848 On the other hand, SvUOK is true iff UV.
1849 ####################################################################
1851 Your mileage will vary depending your CPU's relative fp to integer
1855 #ifndef NV_PRESERVES_UV
1856 # define IS_NUMBER_UNDERFLOW_IV 1
1857 # define IS_NUMBER_UNDERFLOW_UV 2
1858 # define IS_NUMBER_IV_AND_UV 2
1859 # define IS_NUMBER_OVERFLOW_IV 4
1860 # define IS_NUMBER_OVERFLOW_UV 5
1862 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
1864 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1866 S_sv_2iuv_non_preserve(pTHX_ register SV *sv
1873 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));
1874 if (SvNVX(sv) < (NV)IV_MIN) {
1875 (void)SvIOKp_on(sv);
1877 SvIV_set(sv, IV_MIN);
1878 return IS_NUMBER_UNDERFLOW_IV;
1880 if (SvNVX(sv) > (NV)UV_MAX) {
1881 (void)SvIOKp_on(sv);
1884 SvUV_set(sv, UV_MAX);
1885 return IS_NUMBER_OVERFLOW_UV;
1887 (void)SvIOKp_on(sv);
1889 /* Can't use strtol etc to convert this string. (See truth table in
1891 if (SvNVX(sv) <= (UV)IV_MAX) {
1892 SvIV_set(sv, I_V(SvNVX(sv)));
1893 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1894 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1896 /* Integer is imprecise. NOK, IOKp */
1898 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1901 SvUV_set(sv, U_V(SvNVX(sv)));
1902 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
1903 if (SvUVX(sv) == UV_MAX) {
1904 /* As we know that NVs don't preserve UVs, UV_MAX cannot
1905 possibly be preserved by NV. Hence, it must be overflow.
1907 return IS_NUMBER_OVERFLOW_UV;
1909 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
1911 /* Integer is imprecise. NOK, IOKp */
1913 return IS_NUMBER_OVERFLOW_IV;
1915 #endif /* !NV_PRESERVES_UV*/
1918 S_sv_2iuv_common(pTHX_ SV *sv) {
1921 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
1922 * without also getting a cached IV/UV from it at the same time
1923 * (ie PV->NV conversion should detect loss of accuracy and cache
1924 * IV or UV at same time to avoid this. */
1925 /* IV-over-UV optimisation - choose to cache IV if possible */
1927 if (SvTYPE(sv) == SVt_NV)
1928 sv_upgrade(sv, SVt_PVNV);
1930 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
1931 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
1932 certainly cast into the IV range at IV_MAX, whereas the correct
1933 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
1935 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
1936 if (Perl_isnan(SvNVX(sv))) {
1942 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
1943 SvIV_set(sv, I_V(SvNVX(sv)));
1944 if (SvNVX(sv) == (NV) SvIVX(sv)
1945 #ifndef NV_PRESERVES_UV
1946 && (((UV)1 << NV_PRESERVES_UV_BITS) >
1947 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
1948 /* Don't flag it as "accurately an integer" if the number
1949 came from a (by definition imprecise) NV operation, and
1950 we're outside the range of NV integer precision */
1954 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
1956 /* scalar has trailing garbage, eg "42a" */
1958 DEBUG_c(PerlIO_printf(Perl_debug_log,
1959 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
1965 /* IV not precise. No need to convert from PV, as NV
1966 conversion would already have cached IV if it detected
1967 that PV->IV would be better than PV->NV->IV
1968 flags already correct - don't set public IOK. */
1969 DEBUG_c(PerlIO_printf(Perl_debug_log,
1970 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
1975 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
1976 but the cast (NV)IV_MIN rounds to a the value less (more
1977 negative) than IV_MIN which happens to be equal to SvNVX ??
1978 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
1979 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
1980 (NV)UVX == NVX are both true, but the values differ. :-(
1981 Hopefully for 2s complement IV_MIN is something like
1982 0x8000000000000000 which will be exact. NWC */
1985 SvUV_set(sv, U_V(SvNVX(sv)));
1987 (SvNVX(sv) == (NV) SvUVX(sv))
1988 #ifndef NV_PRESERVES_UV
1989 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
1990 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
1991 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
1992 /* Don't flag it as "accurately an integer" if the number
1993 came from a (by definition imprecise) NV operation, and
1994 we're outside the range of NV integer precision */
2000 DEBUG_c(PerlIO_printf(Perl_debug_log,
2001 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2007 else if (SvPOKp(sv) && SvLEN(sv)) {
2009 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2010 /* We want to avoid a possible problem when we cache an IV/ a UV which
2011 may be later translated to an NV, and the resulting NV is not
2012 the same as the direct translation of the initial string
2013 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2014 be careful to ensure that the value with the .456 is around if the
2015 NV value is requested in the future).
2017 This means that if we cache such an IV/a UV, we need to cache the
2018 NV as well. Moreover, we trade speed for space, and do not
2019 cache the NV if we are sure it's not needed.
2022 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2023 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2024 == IS_NUMBER_IN_UV) {
2025 /* It's definitely an integer, only upgrade to PVIV */
2026 if (SvTYPE(sv) < SVt_PVIV)
2027 sv_upgrade(sv, SVt_PVIV);
2029 } else if (SvTYPE(sv) < SVt_PVNV)
2030 sv_upgrade(sv, SVt_PVNV);
2032 /* If NVs preserve UVs then we only use the UV value if we know that
2033 we aren't going to call atof() below. If NVs don't preserve UVs
2034 then the value returned may have more precision than atof() will
2035 return, even though value isn't perfectly accurate. */
2036 if ((numtype & (IS_NUMBER_IN_UV
2037 #ifdef NV_PRESERVES_UV
2040 )) == IS_NUMBER_IN_UV) {
2041 /* This won't turn off the public IOK flag if it was set above */
2042 (void)SvIOKp_on(sv);
2044 if (!(numtype & IS_NUMBER_NEG)) {
2046 if (value <= (UV)IV_MAX) {
2047 SvIV_set(sv, (IV)value);
2049 /* it didn't overflow, and it was positive. */
2050 SvUV_set(sv, value);
2054 /* 2s complement assumption */
2055 if (value <= (UV)IV_MIN) {
2056 SvIV_set(sv, -(IV)value);
2058 /* Too negative for an IV. This is a double upgrade, but
2059 I'm assuming it will be rare. */
2060 if (SvTYPE(sv) < SVt_PVNV)
2061 sv_upgrade(sv, SVt_PVNV);
2065 SvNV_set(sv, -(NV)value);
2066 SvIV_set(sv, IV_MIN);
2070 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2071 will be in the previous block to set the IV slot, and the next
2072 block to set the NV slot. So no else here. */
2074 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2075 != IS_NUMBER_IN_UV) {
2076 /* It wasn't an (integer that doesn't overflow the UV). */
2077 SvNV_set(sv, Atof(SvPVX_const(sv)));
2079 if (! numtype && ckWARN(WARN_NUMERIC))
2082 #if defined(USE_LONG_DOUBLE)
2083 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2084 PTR2UV(sv), SvNVX(sv)));
2086 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2087 PTR2UV(sv), SvNVX(sv)));
2090 #ifdef NV_PRESERVES_UV
2091 (void)SvIOKp_on(sv);
2093 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2094 SvIV_set(sv, I_V(SvNVX(sv)));
2095 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2098 NOOP; /* Integer is imprecise. NOK, IOKp */
2100 /* UV will not work better than IV */
2102 if (SvNVX(sv) > (NV)UV_MAX) {
2104 /* Integer is inaccurate. NOK, IOKp, is UV */
2105 SvUV_set(sv, UV_MAX);
2107 SvUV_set(sv, U_V(SvNVX(sv)));
2108 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2109 NV preservse UV so can do correct comparison. */
2110 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2113 NOOP; /* Integer is imprecise. NOK, IOKp, is UV */
2118 #else /* NV_PRESERVES_UV */
2119 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2120 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2121 /* The IV/UV slot will have been set from value returned by
2122 grok_number above. The NV slot has just been set using
2125 assert (SvIOKp(sv));
2127 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2128 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2129 /* Small enough to preserve all bits. */
2130 (void)SvIOKp_on(sv);
2132 SvIV_set(sv, I_V(SvNVX(sv)));
2133 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2135 /* Assumption: first non-preserved integer is < IV_MAX,
2136 this NV is in the preserved range, therefore: */
2137 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2139 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);
2143 0 0 already failed to read UV.
2144 0 1 already failed to read UV.
2145 1 0 you won't get here in this case. IV/UV
2146 slot set, public IOK, Atof() unneeded.
2147 1 1 already read UV.
2148 so there's no point in sv_2iuv_non_preserve() attempting
2149 to use atol, strtol, strtoul etc. */
2151 sv_2iuv_non_preserve (sv, numtype);
2153 sv_2iuv_non_preserve (sv);
2157 #endif /* NV_PRESERVES_UV */
2158 /* It might be more code efficient to go through the entire logic above
2159 and conditionally set with SvIOKp_on() rather than SvIOK(), but it
2160 gets complex and potentially buggy, so more programmer efficient
2161 to do it this way, by turning off the public flags: */
2163 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2167 if (isGV_with_GP(sv))
2168 return glob_2number((GV *)sv);
2170 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2171 if (!PL_localizing && ckWARN(WARN_UNINITIALIZED))
2174 if (SvTYPE(sv) < SVt_IV)
2175 /* Typically the caller expects that sv_any is not NULL now. */
2176 sv_upgrade(sv, SVt_IV);
2177 /* Return 0 from the caller. */
2184 =for apidoc sv_2iv_flags
2186 Return the integer value of an SV, doing any necessary string
2187 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2188 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2194 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2199 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2200 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2201 cache IVs just in case. In practice it seems that they never
2202 actually anywhere accessible by user Perl code, let alone get used
2203 in anything other than a string context. */
2204 if (flags & SV_GMAGIC)
2209 return I_V(SvNVX(sv));
2211 if (SvPOKp(sv) && SvLEN(sv)) {
2214 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2216 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2217 == IS_NUMBER_IN_UV) {
2218 /* It's definitely an integer */
2219 if (numtype & IS_NUMBER_NEG) {
2220 if (value < (UV)IV_MIN)
2223 if (value < (UV)IV_MAX)
2228 if (ckWARN(WARN_NUMERIC))
2231 return I_V(Atof(SvPVX_const(sv)));
2236 assert(SvTYPE(sv) >= SVt_PVMG);
2237 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2238 } else if (SvTHINKFIRST(sv)) {
2242 SV * const tmpstr=AMG_CALLun(sv,numer);
2243 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2244 return SvIV(tmpstr);
2247 return PTR2IV(SvRV(sv));
2250 sv_force_normal_flags(sv, 0);
2252 if (SvREADONLY(sv) && !SvOK(sv)) {
2253 if (ckWARN(WARN_UNINITIALIZED))
2259 if (S_sv_2iuv_common(aTHX_ sv))
2262 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2263 PTR2UV(sv),SvIVX(sv)));
2264 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2268 =for apidoc sv_2uv_flags
2270 Return the unsigned integer value of an SV, doing any necessary string
2271 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2272 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2278 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2283 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2284 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2285 cache IVs just in case. */
2286 if (flags & SV_GMAGIC)
2291 return U_V(SvNVX(sv));
2292 if (SvPOKp(sv) && SvLEN(sv)) {
2295 = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2297 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2298 == IS_NUMBER_IN_UV) {
2299 /* It's definitely an integer */
2300 if (!(numtype & IS_NUMBER_NEG))
2304 if (ckWARN(WARN_NUMERIC))
2307 return U_V(Atof(SvPVX_const(sv)));
2312 assert(SvTYPE(sv) >= SVt_PVMG);
2313 /* This falls through to the report_uninit inside S_sv_2iuv_common. */
2314 } else if (SvTHINKFIRST(sv)) {
2318 SV *const tmpstr = AMG_CALLun(sv,numer);
2319 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2320 return SvUV(tmpstr);
2323 return PTR2UV(SvRV(sv));
2326 sv_force_normal_flags(sv, 0);
2328 if (SvREADONLY(sv) && !SvOK(sv)) {
2329 if (ckWARN(WARN_UNINITIALIZED))
2335 if (S_sv_2iuv_common(aTHX_ sv))
2339 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2340 PTR2UV(sv),SvUVX(sv)));
2341 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
2347 Return the num value of an SV, doing any necessary string or integer
2348 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2355 Perl_sv_2nv(pTHX_ register SV *sv)
2360 if (SvGMAGICAL(sv) || (SvTYPE(sv) == SVt_PVGV && SvVALID(sv))) {
2361 /* FBMs use the same flag bit as SVf_IVisUV, so must let them
2362 cache IVs just in case. */
2366 if ((SvPOKp(sv) && SvLEN(sv)) && !SvIOKp(sv)) {
2367 if (!SvIOKp(sv) && ckWARN(WARN_NUMERIC) &&
2368 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
2370 return Atof(SvPVX_const(sv));
2374 return (NV)SvUVX(sv);
2376 return (NV)SvIVX(sv);
2381 assert(SvTYPE(sv) >= SVt_PVMG);
2382 /* This falls through to the report_uninit near the end of the
2384 } else if (SvTHINKFIRST(sv)) {
2388 SV *const tmpstr = AMG_CALLun(sv,numer);
2389 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2390 return SvNV(tmpstr);
2393 return PTR2NV(SvRV(sv));
2396 sv_force_normal_flags(sv, 0);
2398 if (SvREADONLY(sv) && !SvOK(sv)) {
2399 if (ckWARN(WARN_UNINITIALIZED))
2404 if (SvTYPE(sv) < SVt_NV) {
2405 /* The logic to use SVt_PVNV if necessary is in sv_upgrade. */
2406 sv_upgrade(sv, SVt_NV);
2407 #ifdef USE_LONG_DOUBLE
2409 STORE_NUMERIC_LOCAL_SET_STANDARD();
2410 PerlIO_printf(Perl_debug_log,
2411 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2412 PTR2UV(sv), SvNVX(sv));
2413 RESTORE_NUMERIC_LOCAL();
2417 STORE_NUMERIC_LOCAL_SET_STANDARD();
2418 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
2419 PTR2UV(sv), SvNVX(sv));
2420 RESTORE_NUMERIC_LOCAL();
2424 else if (SvTYPE(sv) < SVt_PVNV)
2425 sv_upgrade(sv, SVt_PVNV);
2430 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
2431 #ifdef NV_PRESERVES_UV
2437 /* Only set the public NV OK flag if this NV preserves the IV */
2438 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2440 SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2441 : (SvIVX(sv) == I_V(SvNVX(sv))))
2447 else if (SvPOKp(sv) && SvLEN(sv)) {
2449 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
2450 if (!SvIOKp(sv) && !numtype && ckWARN(WARN_NUMERIC))
2452 #ifdef NV_PRESERVES_UV
2453 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2454 == IS_NUMBER_IN_UV) {
2455 /* It's definitely an integer */
2456 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
2458 SvNV_set(sv, Atof(SvPVX_const(sv)));
2464 SvNV_set(sv, Atof(SvPVX_const(sv)));
2465 /* Only set the public NV OK flag if this NV preserves the value in
2466 the PV at least as well as an IV/UV would.
2467 Not sure how to do this 100% reliably. */
2468 /* if that shift count is out of range then Configure's test is
2469 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2471 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2472 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2473 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
2474 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2475 /* Can't use strtol etc to convert this string, so don't try.
2476 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2479 /* value has been set. It may not be precise. */
2480 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2481 /* 2s complement assumption for (UV)IV_MIN */
2482 SvNOK_on(sv); /* Integer is too negative. */
2487 if (numtype & IS_NUMBER_NEG) {
2488 SvIV_set(sv, -(IV)value);
2489 } else if (value <= (UV)IV_MAX) {
2490 SvIV_set(sv, (IV)value);
2492 SvUV_set(sv, value);
2496 if (numtype & IS_NUMBER_NOT_INT) {
2497 /* I believe that even if the original PV had decimals,
2498 they are lost beyond the limit of the FP precision.
2499 However, neither is canonical, so both only get p
2500 flags. NWC, 2000/11/25 */
2501 /* Both already have p flags, so do nothing */
2503 const NV nv = SvNVX(sv);
2504 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2505 if (SvIVX(sv) == I_V(nv)) {
2508 /* It had no "." so it must be integer. */
2512 /* between IV_MAX and NV(UV_MAX).
2513 Could be slightly > UV_MAX */
2515 if (numtype & IS_NUMBER_NOT_INT) {
2516 /* UV and NV both imprecise. */
2518 const UV nv_as_uv = U_V(nv);
2520 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2529 /* It might be more code efficient to go through the entire logic above
2530 and conditionally set with SvNOKp_on() rather than SvNOK(), but it
2531 gets complex and potentially buggy, so more programmer efficient
2532 to do it this way, by turning off the public flags: */
2534 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK);
2535 #endif /* NV_PRESERVES_UV */
2538 if (isGV_with_GP(sv)) {
2539 glob_2number((GV *)sv);
2543 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2545 assert (SvTYPE(sv) >= SVt_NV);
2546 /* Typically the caller expects that sv_any is not NULL now. */
2547 /* XXX Ilya implies that this is a bug in callers that assume this
2548 and ideally should be fixed. */
2551 #if defined(USE_LONG_DOUBLE)
2553 STORE_NUMERIC_LOCAL_SET_STANDARD();
2554 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2555 PTR2UV(sv), SvNVX(sv));
2556 RESTORE_NUMERIC_LOCAL();
2560 STORE_NUMERIC_LOCAL_SET_STANDARD();
2561 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
2562 PTR2UV(sv), SvNVX(sv));
2563 RESTORE_NUMERIC_LOCAL();
2572 Return an SV with the numeric value of the source SV, doing any necessary
2573 reference or overload conversion. You must use the C<SvNUM(sv)> macro to
2574 access this function.
2580 Perl_sv_2num(pTHX_ register SV *sv)
2585 SV * const tmpsv = AMG_CALLun(sv,numer);
2586 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2587 return sv_2num(tmpsv);
2589 return sv_2mortal(newSVuv(PTR2UV(SvRV(sv))));
2592 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2593 * UV as a string towards the end of buf, and return pointers to start and
2596 * We assume that buf is at least TYPE_CHARS(UV) long.
2600 S_uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2602 char *ptr = buf + TYPE_CHARS(UV);
2603 char * const ebuf = ptr;
2616 *--ptr = '0' + (char)(uv % 10);
2625 =for apidoc sv_2pv_flags
2627 Returns a pointer to the string value of an SV, and sets *lp to its length.
2628 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2630 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2631 usually end up here too.
2637 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2647 if (SvGMAGICAL(sv)) {
2648 if (flags & SV_GMAGIC)
2653 if (flags & SV_MUTABLE_RETURN)
2654 return SvPVX_mutable(sv);
2655 if (flags & SV_CONST_RETURN)
2656 return (char *)SvPVX_const(sv);
2659 if (SvIOKp(sv) || SvNOKp(sv)) {
2660 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2665 ? my_snprintf(tbuf, sizeof(tbuf), "%"UVuf, (UV)SvUVX(sv))
2666 : my_snprintf(tbuf, sizeof(tbuf), "%"IVdf, (IV)SvIVX(sv));
2668 Gconvert(SvNVX(sv), NV_DIG, 0, tbuf);
2675 #ifdef FIXNEGATIVEZERO
2676 if (len == 2 && tbuf[0] == '-' && tbuf[1] == '0') {
2682 SvUPGRADE(sv, SVt_PV);
2685 s = SvGROW_mutable(sv, len + 1);
2688 return (char*)memcpy(s, tbuf, len + 1);
2694 assert(SvTYPE(sv) >= SVt_PVMG);
2695 /* This falls through to the report_uninit near the end of the
2697 } else if (SvTHINKFIRST(sv)) {
2701 SV *const tmpstr = AMG_CALLun(sv,string);
2702 if (tmpstr && (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
2704 /* char *pv = lp ? SvPV(tmpstr, *lp) : SvPV_nolen(tmpstr);
2708 if ((SvFLAGS(tmpstr) & (SVf_POK)) == SVf_POK) {
2709 if (flags & SV_CONST_RETURN) {
2710 pv = (char *) SvPVX_const(tmpstr);
2712 pv = (flags & SV_MUTABLE_RETURN)
2713 ? SvPVX_mutable(tmpstr) : SvPVX(tmpstr);
2716 *lp = SvCUR(tmpstr);
2718 pv = sv_2pv_flags(tmpstr, lp, flags);
2731 const SV *const referent = (SV*)SvRV(sv);
2735 retval = buffer = savepvn("NULLREF", len);
2736 } else if (SvTYPE(referent) == SVt_REGEXP) {
2737 const REGEXP * const re = (REGEXP *)referent;
2742 /* If the regex is UTF-8 we want the containing scalar to
2743 have an UTF-8 flag too */
2749 if ((seen_evals = RX_SEEN_EVALS(re)))
2750 PL_reginterp_cnt += seen_evals;
2753 *lp = RX_WRAPLEN(re);
2755 return RX_WRAPPED(re);
2757 const char *const typestr = sv_reftype(referent, 0);
2758 const STRLEN typelen = strlen(typestr);
2759 UV addr = PTR2UV(referent);
2760 const char *stashname = NULL;
2761 STRLEN stashnamelen = 0; /* hush, gcc */
2762 const char *buffer_end;
2764 if (SvOBJECT(referent)) {
2765 const HEK *const name = HvNAME_HEK(SvSTASH(referent));
2768 stashname = HEK_KEY(name);
2769 stashnamelen = HEK_LEN(name);
2771 if (HEK_UTF8(name)) {
2777 stashname = "__ANON__";
2780 len = stashnamelen + 1 /* = */ + typelen + 3 /* (0x */
2781 + 2 * sizeof(UV) + 2 /* )\0 */;
2783 len = typelen + 3 /* (0x */
2784 + 2 * sizeof(UV) + 2 /* )\0 */;
2787 Newx(buffer, len, char);
2788 buffer_end = retval = buffer + len;
2790 /* Working backwards */
2794 *--retval = PL_hexdigit[addr & 15];
2795 } while (addr >>= 4);
2801 memcpy(retval, typestr, typelen);
2805 retval -= stashnamelen;
2806 memcpy(retval, stashname, stashnamelen);
2808 /* retval may not neccesarily have reached the start of the
2810 assert (retval >= buffer);
2812 len = buffer_end - retval - 1; /* -1 for that \0 */
2820 if (SvREADONLY(sv) && !SvOK(sv)) {
2823 if (flags & SV_UNDEF_RETURNS_NULL)
2825 if (ckWARN(WARN_UNINITIALIZED))
2830 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
2831 /* I'm assuming that if both IV and NV are equally valid then
2832 converting the IV is going to be more efficient */
2833 const U32 isUIOK = SvIsUV(sv);
2834 char buf[TYPE_CHARS(UV)];
2838 if (SvTYPE(sv) < SVt_PVIV)
2839 sv_upgrade(sv, SVt_PVIV);
2840 ptr = uiv_2buf(buf, SvIVX(sv), SvUVX(sv), isUIOK, &ebuf);
2842 /* inlined from sv_setpvn */
2843 s = SvGROW_mutable(sv, len + 1);
2844 Move(ptr, s, len, char);
2848 else if (SvNOKp(sv)) {
2849 const int olderrno = errno;
2850 if (SvTYPE(sv) < SVt_PVNV)
2851 sv_upgrade(sv, SVt_PVNV);
2852 /* The +20 is pure guesswork. Configure test needed. --jhi */
2853 s = SvGROW_mutable(sv, NV_DIG + 20);
2854 /* some Xenix systems wipe out errno here */
2856 if (SvNVX(sv) == 0.0)
2857 my_strlcpy(s, "0", SvLEN(sv));
2861 Gconvert(SvNVX(sv), NV_DIG, 0, s);
2864 #ifdef FIXNEGATIVEZERO
2865 if (*s == '-' && s[1] == '0' && !s[2]) {
2877 if (isGV_with_GP(sv))
2878 return glob_2pv((GV *)sv, lp);
2882 if (flags & SV_UNDEF_RETURNS_NULL)
2884 if (!PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP) && ckWARN(WARN_UNINITIALIZED))
2886 if (SvTYPE(sv) < SVt_PV)
2887 /* Typically the caller expects that sv_any is not NULL now. */
2888 sv_upgrade(sv, SVt_PV);
2892 const STRLEN len = s - SvPVX_const(sv);
2898 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
2899 PTR2UV(sv),SvPVX_const(sv)));
2900 if (flags & SV_CONST_RETURN)
2901 return (char *)SvPVX_const(sv);
2902 if (flags & SV_MUTABLE_RETURN)
2903 return SvPVX_mutable(sv);
2908 =for apidoc sv_copypv
2910 Copies a stringified representation of the source SV into the
2911 destination SV. Automatically performs any necessary mg_get and
2912 coercion of numeric values into strings. Guaranteed to preserve
2913 UTF8 flag even from overloaded objects. Similar in nature to
2914 sv_2pv[_flags] but operates directly on an SV instead of just the
2915 string. Mostly uses sv_2pv_flags to do its work, except when that
2916 would lose the UTF-8'ness of the PV.
2922 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
2925 const char * const s = SvPV_const(ssv,len);
2926 sv_setpvn(dsv,s,len);
2934 =for apidoc sv_2pvbyte
2936 Return a pointer to the byte-encoded representation of the SV, and set *lp
2937 to its length. May cause the SV to be downgraded from UTF-8 as a
2940 Usually accessed via the C<SvPVbyte> macro.
2946 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
2948 sv_utf8_downgrade(sv,0);
2949 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2953 =for apidoc sv_2pvutf8
2955 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
2956 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
2958 Usually accessed via the C<SvPVutf8> macro.
2964 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
2966 sv_utf8_upgrade(sv);
2967 return lp ? SvPV(sv,*lp) : SvPV_nolen(sv);
2972 =for apidoc sv_2bool
2974 This function is only called on magical items, and is only used by
2975 sv_true() or its macro equivalent.
2981 Perl_sv_2bool(pTHX_ register SV *sv)
2990 SV * const tmpsv = AMG_CALLun(sv,bool_);
2991 if (tmpsv && (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
2992 return (bool)SvTRUE(tmpsv);
2994 return SvRV(sv) != 0;
2997 register XPV* const Xpvtmp = (XPV*)SvANY(sv);
2999 (*sv->sv_u.svu_pv > '0' ||
3000 Xpvtmp->xpv_cur > 1 ||
3001 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
3008 return SvIVX(sv) != 0;
3011 return SvNVX(sv) != 0.0;
3013 if (isGV_with_GP(sv))
3023 =for apidoc sv_utf8_upgrade
3025 Converts the PV of an SV to its UTF-8-encoded form.
3026 Forces the SV to string form if it is not already.
3027 Always sets the SvUTF8 flag to avoid future validity checks even
3028 if all the bytes have hibit clear.
3030 This is not as a general purpose byte encoding to Unicode interface:
3031 use the Encode extension for that.
3033 =for apidoc sv_utf8_upgrade_flags
3035 Converts the PV of an SV to its UTF-8-encoded form.
3036 Forces the SV to string form if it is not already.
3037 Always sets the SvUTF8 flag to avoid future validity checks even
3038 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3039 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3040 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3042 This is not as a general purpose byte encoding to Unicode interface:
3043 use the Encode extension for that.
3049 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3052 if (sv == &PL_sv_undef)
3056 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3057 (void) sv_2pv_flags(sv,&len, flags);
3061 (void) SvPV_force(sv,len);
3070 sv_force_normal_flags(sv, 0);
3073 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3074 sv_recode_to_utf8(sv, PL_encoding);
3075 else { /* Assume Latin-1/EBCDIC */
3076 /* This function could be much more efficient if we
3077 * had a FLAG in SVs to signal if there are any hibit
3078 * chars in the PV. Given that there isn't such a flag
3079 * make the loop as fast as possible. */
3080 const U8 * const s = (U8 *) SvPVX_const(sv);
3081 const U8 * const e = (U8 *) SvEND(sv);
3086 /* Check for hi bit */
3087 if (!NATIVE_IS_INVARIANT(ch)) {
3088 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3089 U8 * const recoded = bytes_to_utf8((U8*)s, &len);
3091 SvPV_free(sv); /* No longer using what was there before. */
3092 SvPV_set(sv, (char*)recoded);
3093 SvCUR_set(sv, len - 1);
3094 SvLEN_set(sv, len); /* No longer know the real size. */
3098 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3105 =for apidoc sv_utf8_downgrade
3107 Attempts to convert the PV of an SV from characters to bytes.
3108 If the PV contains a character beyond byte, this conversion will fail;
3109 in this case, either returns false or, if C<fail_ok> is not
3112 This is not as a general purpose Unicode to byte encoding interface:
3113 use the Encode extension for that.
3119 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3122 if (SvPOKp(sv) && SvUTF8(sv)) {
3128 sv_force_normal_flags(sv, 0);
3130 s = (U8 *) SvPV(sv, len);
3131 if (!utf8_to_bytes(s, &len)) {
3136 Perl_croak(aTHX_ "Wide character in %s",
3139 Perl_croak(aTHX_ "Wide character");
3150 =for apidoc sv_utf8_encode
3152 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3153 flag off so that it looks like octets again.
3159 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3162 sv_force_normal_flags(sv, 0);
3164 if (SvREADONLY(sv)) {
3165 Perl_croak(aTHX_ PL_no_modify);
3167 (void) sv_utf8_upgrade(sv);
3172 =for apidoc sv_utf8_decode
3174 If the PV of the SV is an octet sequence in UTF-8
3175 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3176 so that it looks like a character. If the PV contains only single-byte
3177 characters, the C<SvUTF8> flag stays being off.
3178 Scans PV for validity and returns false if the PV is invalid UTF-8.
3184 Perl_sv_utf8_decode(pTHX_ register SV *sv)
3190 /* The octets may have got themselves encoded - get them back as
3193 if (!sv_utf8_downgrade(sv, TRUE))
3196 /* it is actually just a matter of turning the utf8 flag on, but
3197 * we want to make sure everything inside is valid utf8 first.
3199 c = (const U8 *) SvPVX_const(sv);
3200 if (!is_utf8_string(c, SvCUR(sv)+1))
3202 e = (const U8 *) SvEND(sv);
3205 if (!UTF8_IS_INVARIANT(ch)) {
3215 =for apidoc sv_setsv
3217 Copies the contents of the source SV C<ssv> into the destination SV
3218 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3219 function if the source SV needs to be reused. Does not handle 'set' magic.
3220 Loosely speaking, it performs a copy-by-value, obliterating any previous
3221 content of the destination.
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 =for apidoc sv_setsv_flags
3229 Copies the contents of the source SV C<ssv> into the destination SV
3230 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3231 function if the source SV needs to be reused. Does not handle 'set' magic.
3232 Loosely speaking, it performs a copy-by-value, obliterating any previous
3233 content of the destination.
3234 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3235 C<ssv> if appropriate, else not. If the C<flags> parameter has the
3236 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
3237 and C<sv_setsv_nomg> are implemented in terms of this function.
3239 You probably want to use one of the assortment of wrappers, such as
3240 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3241 C<SvSetMagicSV_nosteal>.
3243 This is the primary function for copying scalars, and most other
3244 copy-ish functions and macros use this underneath.
3250 S_glob_assign_glob(pTHX_ SV *dstr, SV *sstr, const int dtype)
3252 I32 mro_changes = 0; /* 1 = method, 2 = isa */
3254 if (dtype != SVt_PVGV) {
3255 const char * const name = GvNAME(sstr);
3256 const STRLEN len = GvNAMELEN(sstr);
3258 if (dtype >= SVt_PV) {
3264 SvUPGRADE(dstr, SVt_PVGV);
3265 (void)SvOK_off(dstr);
3266 /* FIXME - why are we doing this, then turning it off and on again
3268 isGV_with_GP_on(dstr);
3270 GvSTASH(dstr) = GvSTASH(sstr);
3272 Perl_sv_add_backref(aTHX_ (SV*)GvSTASH(dstr), dstr);
3273 gv_name_set((GV *)dstr, name, len, GV_ADD);
3274 SvFAKE_on(dstr); /* can coerce to non-glob */
3277 #ifdef GV_UNIQUE_CHECK
3278 if (GvUNIQUE((GV*)dstr)) {
3279 Perl_croak(aTHX_ PL_no_modify);
3283 if(GvGP((GV*)sstr)) {
3284 /* If source has method cache entry, clear it */
3286 SvREFCNT_dec(GvCV(sstr));
3290 /* If source has a real method, then a method is
3292 else if(GvCV((GV*)sstr)) {
3297 /* If dest already had a real method, that's a change as well */
3298 if(!mro_changes && GvGP((GV*)dstr) && GvCVu((GV*)dstr)) {
3302 if(strEQ(GvNAME((GV*)dstr),"ISA"))
3306 isGV_with_GP_off(dstr);
3307 (void)SvOK_off(dstr);
3308 isGV_with_GP_on(dstr);
3309 GvINTRO_off(dstr); /* one-shot flag */
3310 GvGP(dstr) = gp_ref(GvGP(sstr));
3311 if (SvTAINTED(sstr))
3313 if (GvIMPORTED(dstr) != GVf_IMPORTED
3314 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3316 GvIMPORTED_on(dstr);
3319 if(mro_changes == 2) mro_isa_changed_in(GvSTASH(dstr));
3320 else if(mro_changes) mro_method_changed_in(GvSTASH(dstr));
3325 S_glob_assign_ref(pTHX_ SV *dstr, SV *sstr) {
3326 SV * const sref = SvREFCNT_inc(SvRV(sstr));
3328 const int intro = GvINTRO(dstr);
3331 const U32 stype = SvTYPE(sref);
3334 #ifdef GV_UNIQUE_CHECK
3335 if (GvUNIQUE((GV*)dstr)) {
3336 Perl_croak(aTHX_ PL_no_modify);
3341 GvINTRO_off(dstr); /* one-shot flag */
3342 GvLINE(dstr) = CopLINE(PL_curcop);
3343 GvEGV(dstr) = (GV*)dstr;
3348 location = (SV **) &GvCV(dstr);
3349 import_flag = GVf_IMPORTED_CV;
3352 location = (SV **) &GvHV(dstr);
3353 import_flag = GVf_IMPORTED_HV;
3356 location = (SV **) &GvAV(dstr);
3357 import_flag = GVf_IMPORTED_AV;
3360 location = (SV **) &GvIOp(dstr);
3363 location = (SV **) &GvFORM(dstr);
3365 location = &GvSV(dstr);
3366 import_flag = GVf_IMPORTED_SV;
3369 if (stype == SVt_PVCV) {
3370 /*if (GvCVGEN(dstr) && (GvCV(dstr) != (CV*)sref || GvCVGEN(dstr))) {*/
3371 if (GvCVGEN(dstr)) {
3372 SvREFCNT_dec(GvCV(dstr));
3374 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3377 SAVEGENERICSV(*location);
3381 if (stype == SVt_PVCV && (*location != sref || GvCVGEN(dstr))) {
3382 CV* const cv = (CV*)*location;
3384 if (!GvCVGEN((GV*)dstr) &&
3385 (CvROOT(cv) || CvXSUB(cv)))
3387 /* Redefining a sub - warning is mandatory if
3388 it was a const and its value changed. */
3389 if (CvCONST(cv) && CvCONST((CV*)sref)
3390 && cv_const_sv(cv) == cv_const_sv((CV*)sref)) {
3392 /* They are 2 constant subroutines generated from
3393 the same constant. This probably means that
3394 they are really the "same" proxy subroutine
3395 instantiated in 2 places. Most likely this is
3396 when a constant is exported twice. Don't warn.
3399 else if (ckWARN(WARN_REDEFINE)
3401 && (!CvCONST((CV*)sref)
3402 || sv_cmp(cv_const_sv(cv),
3403 cv_const_sv((CV*)sref))))) {
3404 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
3407 ? "Constant subroutine %s::%s redefined"
3408 : "Subroutine %s::%s redefined"),
3409 HvNAME_get(GvSTASH((GV*)dstr)),
3410 GvENAME((GV*)dstr));
3414 cv_ckproto_len(cv, (GV*)dstr,
3415 SvPOK(sref) ? SvPVX_const(sref) : NULL,
3416 SvPOK(sref) ? SvCUR(sref) : 0);
3418 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3419 GvASSUMECV_on(dstr);
3420 if(GvSTASH(dstr)) mro_method_changed_in(GvSTASH(dstr)); /* sub foo { 1 } sub bar { 2 } *bar = \&foo */
3423 if (import_flag && !(GvFLAGS(dstr) & import_flag)
3424 && CopSTASH_ne(PL_curcop, GvSTASH(dstr))) {
3425 GvFLAGS(dstr) |= import_flag;
3430 if (SvTAINTED(sstr))
3436 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3439 register U32 sflags;
3441 register svtype stype;
3446 if (SvIS_FREED(dstr)) {
3447 Perl_croak(aTHX_ "panic: attempt to copy value %" SVf
3448 " to a freed scalar %p", SVfARG(sstr), (void *)dstr);
3450 SV_CHECK_THINKFIRST_COW_DROP(dstr);
3452 sstr = &PL_sv_undef;
3453 if (SvIS_FREED(sstr)) {
3454 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p to %p",
3455 (void*)sstr, (void*)dstr);
3457 stype = SvTYPE(sstr);
3458 dtype = SvTYPE(dstr);
3460 (void)SvAMAGIC_off(dstr);
3463 /* need to nuke the magic */
3465 SvRMAGICAL_off(dstr);
3468 /* There's a lot of redundancy below but we're going for speed here */
3473 if (dtype != SVt_PVGV) {
3474 (void)SvOK_off(dstr);
3482 sv_upgrade(dstr, SVt_IV);
3486 sv_upgrade(dstr, SVt_PVIV);
3489 goto end_of_first_switch;
3491 (void)SvIOK_only(dstr);
3492 SvIV_set(dstr, SvIVX(sstr));
3495 /* SvTAINTED can only be true if the SV has taint magic, which in
3496 turn means that the SV type is PVMG (or greater). This is the
3497 case statement for SVt_IV, so this cannot be true (whatever gcov
3499 assert(!SvTAINTED(sstr));
3504 if (dtype < SVt_PV && dtype != SVt_IV)
3505 sv_upgrade(dstr, SVt_IV);
3513 sv_upgrade(dstr, SVt_NV);
3517 sv_upgrade(dstr, SVt_PVNV);
3520 goto end_of_first_switch;
3522 SvNV_set(dstr, SvNVX(sstr));
3523 (void)SvNOK_only(dstr);
3524 /* SvTAINTED can only be true if the SV has taint magic, which in
3525 turn means that the SV type is PVMG (or greater). This is the
3526 case statement for SVt_NV, so this cannot be true (whatever gcov
3528 assert(!SvTAINTED(sstr));
3534 #ifdef PERL_OLD_COPY_ON_WRITE
3535 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
3536 if (dtype < SVt_PVIV)
3537 sv_upgrade(dstr, SVt_PVIV);
3545 sv_upgrade(dstr, SVt_PV);
3548 if (dtype < SVt_PVIV)
3549 sv_upgrade(dstr, SVt_PVIV);
3552 if (dtype < SVt_PVNV)
3553 sv_upgrade(dstr, SVt_PVNV);
3557 const char * const type = sv_reftype(sstr,0);
3559 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
3561 Perl_croak(aTHX_ "Bizarre copy of %s", type);
3565 /* case SVt_BIND: */
3568 if (isGV_with_GP(sstr) && dtype <= SVt_PVGV) {
3569 glob_assign_glob(dstr, sstr, dtype);
3572 /* SvVALID means that this PVGV is playing at being an FBM. */
3576 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
3578 if (SvTYPE(sstr) != stype) {
3579 stype = SvTYPE(sstr);
3580 if (isGV_with_GP(sstr) && stype == SVt_PVGV && dtype <= SVt_PVGV) {
3581 glob_assign_glob(dstr, sstr, dtype);
3586 if (stype == SVt_PVLV)
3587 SvUPGRADE(dstr, SVt_PVNV);
3589 SvUPGRADE(dstr, (svtype)stype);
3591 end_of_first_switch:
3593 /* dstr may have been upgraded. */
3594 dtype = SvTYPE(dstr);
3595 sflags = SvFLAGS(sstr);
3597 if (dtype == SVt_PVCV || dtype == SVt_PVFM) {
3598 /* Assigning to a subroutine sets the prototype. */
3601 const char *const ptr = SvPV_const(sstr, len);
3603 SvGROW(dstr, len + 1);
3604 Copy(ptr, SvPVX(dstr), len + 1, char);
3605 SvCUR_set(dstr, len);
3607 SvFLAGS(dstr) |= sflags & SVf_UTF8;
3611 } else if (dtype == SVt_PVAV || dtype == SVt_PVHV) {
3612 const char * const type = sv_reftype(dstr,0);
3614 Perl_croak(aTHX_ "Cannot copy to %s in %s", type, OP_NAME(PL_op));
3616 Perl_croak(aTHX_ "Cannot copy to %s", type);
3617 } else if (sflags & SVf_ROK) {
3618 if (isGV_with_GP(dstr) && dtype == SVt_PVGV
3619 && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3622 if (GvIMPORTED(dstr) != GVf_IMPORTED
3623 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3625 GvIMPORTED_on(dstr);
3630 glob_assign_glob(dstr, sstr, dtype);
3634 if (dtype >= SVt_PV) {
3635 if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3636 glob_assign_ref(dstr, sstr);
3639 if (SvPVX_const(dstr)) {
3645 (void)SvOK_off(dstr);
3646 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
3647 SvFLAGS(dstr) |= sflags & SVf_ROK;
3648 assert(!(sflags & SVp_NOK));
3649 assert(!(sflags & SVp_IOK));
3650 assert(!(sflags & SVf_NOK));
3651 assert(!(sflags & SVf_IOK));
3653 else if (dtype == SVt_PVGV && isGV_with_GP(dstr)) {
3654 if (!(sflags & SVf_OK)) {
3655 if (ckWARN(WARN_MISC))
3656 Perl_warner(aTHX_ packWARN(WARN_MISC),
3657 "Undefined value assigned to typeglob");
3660 GV *gv = gv_fetchsv(sstr, GV_ADD, SVt_PVGV);
3661 if (dstr != (SV*)gv) {
3664 GvGP(dstr) = gp_ref(GvGP(gv));
3668 else if (sflags & SVp_POK) {
3672 * Check to see if we can just swipe the string. If so, it's a
3673 * possible small lose on short strings, but a big win on long ones.
3674 * It might even be a win on short strings if SvPVX_const(dstr)
3675 * has to be allocated and SvPVX_const(sstr) has to be freed.
3676 * Likewise if we can set up COW rather than doing an actual copy, we
3677 * drop to the else clause, as the swipe code and the COW setup code
3678 * have much in common.
3681 /* Whichever path we take through the next code, we want this true,
3682 and doing it now facilitates the COW check. */
3683 (void)SvPOK_only(dstr);
3686 /* If we're already COW then this clause is not true, and if COW
3687 is allowed then we drop down to the else and make dest COW
3688 with us. If caller hasn't said that we're allowed to COW
3689 shared hash keys then we don't do the COW setup, even if the
3690 source scalar is a shared hash key scalar. */
3691 (((flags & SV_COW_SHARED_HASH_KEYS)
3692 ? (sflags & (SVf_FAKE|SVf_READONLY)) != (SVf_FAKE|SVf_READONLY)
3693 : 1 /* If making a COW copy is forbidden then the behaviour we
3694 desire is as if the source SV isn't actually already
3695 COW, even if it is. So we act as if the source flags
3696 are not COW, rather than actually testing them. */
3698 #ifndef PERL_OLD_COPY_ON_WRITE
3699 /* The change that added SV_COW_SHARED_HASH_KEYS makes the logic
3700 when PERL_OLD_COPY_ON_WRITE is defined a little wrong.
3701 Conceptually PERL_OLD_COPY_ON_WRITE being defined should
3702 override SV_COW_SHARED_HASH_KEYS, because it means "always COW"
3703 but in turn, it's somewhat dead code, never expected to go
3704 live, but more kept as a placeholder on how to do it better
3705 in a newer implementation. */
3706 /* If we are COW and dstr is a suitable target then we drop down
3707 into the else and make dest a COW of us. */
3708 || (SvFLAGS(dstr) & CAN_COW_MASK) != CAN_COW_FLAGS
3713 (sflags & SVs_TEMP) && /* slated for free anyway? */
3714 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3715 (!(flags & SV_NOSTEAL)) &&
3716 /* and we're allowed to steal temps */
3717 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3718 SvLEN(sstr) && /* and really is a string */
3719 /* and won't be needed again, potentially */
3720 !(PL_op && PL_op->op_type == OP_AASSIGN))
3721 #ifdef PERL_OLD_COPY_ON_WRITE
3722 && ((flags & SV_COW_SHARED_HASH_KEYS)
3723 ? (!((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3724 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
3725 && SvTYPE(sstr) >= SVt_PVIV))
3729 /* Failed the swipe test, and it's not a shared hash key either.
3730 Have to copy the string. */
3731 STRLEN len = SvCUR(sstr);
3732 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3733 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
3734 SvCUR_set(dstr, len);
3735 *SvEND(dstr) = '\0';
3737 /* If PERL_OLD_COPY_ON_WRITE is not defined, then isSwipe will always
3739 /* Either it's a shared hash key, or it's suitable for
3740 copy-on-write or we can swipe the string. */
3742 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
3746 #ifdef PERL_OLD_COPY_ON_WRITE
3748 /* I believe I should acquire a global SV mutex if
3749 it's a COW sv (not a shared hash key) to stop
3750 it going un copy-on-write.
3751 If the source SV has gone un copy on write between up there
3752 and down here, then (assert() that) it is of the correct
3753 form to make it copy on write again */
3754 if ((sflags & (SVf_FAKE | SVf_READONLY))
3755 != (SVf_FAKE | SVf_READONLY)) {
3756 SvREADONLY_on(sstr);
3758 /* Make the source SV into a loop of 1.
3759 (about to become 2) */
3760 SV_COW_NEXT_SV_SET(sstr, sstr);
3764 /* Initial code is common. */
3765 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
3770 /* making another shared SV. */
3771 STRLEN cur = SvCUR(sstr);
3772 STRLEN len = SvLEN(sstr);
3773 #ifdef PERL_OLD_COPY_ON_WRITE
3775 assert (SvTYPE(dstr) >= SVt_PVIV);
3776 /* SvIsCOW_normal */
3777 /* splice us in between source and next-after-source. */
3778 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3779 SV_COW_NEXT_SV_SET(sstr, dstr);
3780 SvPV_set(dstr, SvPVX_mutable(sstr));
3784 /* SvIsCOW_shared_hash */
3785 DEBUG_C(PerlIO_printf(Perl_debug_log,
3786 "Copy on write: Sharing hash\n"));
3788 assert (SvTYPE(dstr) >= SVt_PV);
3790 HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)))));
3792 SvLEN_set(dstr, len);
3793 SvCUR_set(dstr, cur);
3794 SvREADONLY_on(dstr);
3796 /* Relesase a global SV mutex. */
3799 { /* Passes the swipe test. */
3800 SvPV_set(dstr, SvPVX_mutable(sstr));
3801 SvLEN_set(dstr, SvLEN(sstr));
3802 SvCUR_set(dstr, SvCUR(sstr));
3805 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
3806 SvPV_set(sstr, NULL);
3812 if (sflags & SVp_NOK) {
3813 SvNV_set(dstr, SvNVX(sstr));
3815 if (sflags & SVp_IOK) {
3816 SvIV_set(dstr, SvIVX(sstr));
3817 /* Must do this otherwise some other overloaded use of 0x80000000
3818 gets confused. I guess SVpbm_VALID */
3819 if (sflags & SVf_IVisUV)
3822 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_NOK|SVp_NOK|SVf_UTF8);
3824 const MAGIC * const smg = SvVSTRING_mg(sstr);
3826 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
3827 smg->mg_ptr, smg->mg_len);
3828 SvRMAGICAL_on(dstr);
3832 else if (sflags & (SVp_IOK|SVp_NOK)) {
3833 (void)SvOK_off(dstr);
3834 SvFLAGS(dstr) |= sflags & (SVf_IOK|SVp_IOK|SVf_IVisUV|SVf_NOK|SVp_NOK);
3835 if (sflags & SVp_IOK) {
3836 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
3837 SvIV_set(dstr, SvIVX(sstr));
3839 if (sflags & SVp_NOK) {
3840 SvNV_set(dstr, SvNVX(sstr));
3844 if (isGV_with_GP(sstr)) {
3845 /* This stringification rule for globs is spread in 3 places.
3846 This feels bad. FIXME. */
3847 const U32 wasfake = sflags & SVf_FAKE;
3849 /* FAKE globs can get coerced, so need to turn this off
3850 temporarily if it is on. */
3852 gv_efullname3(dstr, (GV *)sstr, "*");
3853 SvFLAGS(sstr) |= wasfake;
3856 (void)SvOK_off(dstr);
3858 if (SvTAINTED(sstr))
3863 =for apidoc sv_setsv_mg
3865 Like C<sv_setsv>, but also handles 'set' magic.
3871 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
3873 sv_setsv(dstr,sstr);
3877 #ifdef PERL_OLD_COPY_ON_WRITE
3879 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
3881 STRLEN cur = SvCUR(sstr);
3882 STRLEN len = SvLEN(sstr);
3883 register char *new_pv;
3886 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
3887 (void*)sstr, (void*)dstr);
3894 if (SvTHINKFIRST(dstr))
3895 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3896 else if (SvPVX_const(dstr))
3897 Safefree(SvPVX_const(dstr));
3901 SvUPGRADE(dstr, SVt_PVIV);
3903 assert (SvPOK(sstr));
3904 assert (SvPOKp(sstr));
3905 assert (!SvIOK(sstr));
3906 assert (!SvIOKp(sstr));
3907 assert (!SvNOK(sstr));
3908 assert (!SvNOKp(sstr));
3910 if (SvIsCOW(sstr)) {
3912 if (SvLEN(sstr) == 0) {
3913 /* source is a COW shared hash key. */
3914 DEBUG_C(PerlIO_printf(Perl_debug_log,
3915 "Fast copy on write: Sharing hash\n"));
3916 new_pv = HEK_KEY(share_hek_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr))));
3919 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3921 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
3922 SvUPGRADE(sstr, SVt_PVIV);
3923 SvREADONLY_on(sstr);
3925 DEBUG_C(PerlIO_printf(Perl_debug_log,
3926 "Fast copy on write: Converting sstr to COW\n"));
3927 SV_COW_NEXT_SV_SET(dstr, sstr);
3929 SV_COW_NEXT_SV_SET(sstr, dstr);
3930 new_pv = SvPVX_mutable(sstr);
3933 SvPV_set(dstr, new_pv);
3934 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
3937 SvLEN_set(dstr, len);
3938 SvCUR_set(dstr, cur);
3947 =for apidoc sv_setpvn
3949 Copies a string into an SV. The C<len> parameter indicates the number of
3950 bytes to be copied. If the C<ptr> argument is NULL the SV will become
3951 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
3957 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3960 register char *dptr;
3962 SV_CHECK_THINKFIRST_COW_DROP(sv);
3968 /* len is STRLEN which is unsigned, need to copy to signed */
3971 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
3973 SvUPGRADE(sv, SVt_PV);
3975 dptr = SvGROW(sv, len + 1);
3976 Move(ptr,dptr,len,char);
3979 (void)SvPOK_only_UTF8(sv); /* validate pointer */
3984 =for apidoc sv_setpvn_mg
3986 Like C<sv_setpvn>, but also handles 'set' magic.
3992 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
3994 sv_setpvn(sv,ptr,len);
3999 =for apidoc sv_setpv
4001 Copies a string into an SV. The string must be null-terminated. Does not
4002 handle 'set' magic. See C<sv_setpv_mg>.
4008 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4011 register STRLEN len;
4013 SV_CHECK_THINKFIRST_COW_DROP(sv);
4019 SvUPGRADE(sv, SVt_PV);
4021 SvGROW(sv, len + 1);
4022 Move(ptr,SvPVX(sv),len+1,char);
4024 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4029 =for apidoc sv_setpv_mg
4031 Like C<sv_setpv>, but also handles 'set' magic.
4037 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4044 =for apidoc sv_usepvn_flags
4046 Tells an SV to use C<ptr> to find its string value. Normally the
4047 string is stored inside the SV but sv_usepvn allows the SV to use an
4048 outside string. The C<ptr> should point to memory that was allocated
4049 by C<malloc>. The string length, C<len>, must be supplied. By default
4050 this function will realloc (i.e. move) the memory pointed to by C<ptr>,
4051 so that pointer should not be freed or used by the programmer after
4052 giving it to sv_usepvn, and neither should any pointers from "behind"
4053 that pointer (e.g. ptr + 1) be used.
4055 If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
4056 SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
4057 will be skipped. (i.e. the buffer is actually at least 1 byte longer than
4058 C<len>, and already meets the requirements for storing in C<SvPVX>)
4064 Perl_sv_usepvn_flags(pTHX_ SV *sv, char *ptr, STRLEN len, U32 flags)
4068 SV_CHECK_THINKFIRST_COW_DROP(sv);
4069 SvUPGRADE(sv, SVt_PV);
4072 if (flags & SV_SMAGIC)
4076 if (SvPVX_const(sv))
4080 if (flags & SV_HAS_TRAILING_NUL)
4081 assert(ptr[len] == '\0');
4084 allocate = (flags & SV_HAS_TRAILING_NUL)
4085 ? len + 1: PERL_STRLEN_ROUNDUP(len + 1);
4086 if (flags & SV_HAS_TRAILING_NUL) {
4087 /* It's long enough - do nothing.
4088 Specfically Perl_newCONSTSUB is relying on this. */
4091 /* Force a move to shake out bugs in callers. */
4092 char *new_ptr = (char*)safemalloc(allocate);
4093 Copy(ptr, new_ptr, len, char);
4094 PoisonFree(ptr,len,char);
4098 ptr = (char*) saferealloc (ptr, allocate);
4103 SvLEN_set(sv, allocate);
4104 if (!(flags & SV_HAS_TRAILING_NUL)) {
4107 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4109 if (flags & SV_SMAGIC)
4113 #ifdef PERL_OLD_COPY_ON_WRITE
4114 /* Need to do this *after* making the SV normal, as we need the buffer
4115 pointer to remain valid until after we've copied it. If we let go too early,
4116 another thread could invalidate it by unsharing last of the same hash key
4117 (which it can do by means other than releasing copy-on-write Svs)
4118 or by changing the other copy-on-write SVs in the loop. */
4120 S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, SV *after)
4122 { /* this SV was SvIsCOW_normal(sv) */
4123 /* we need to find the SV pointing to us. */
4124 SV *current = SV_COW_NEXT_SV(after);
4126 if (current == sv) {
4127 /* The SV we point to points back to us (there were only two of us
4129 Hence other SV is no longer copy on write either. */
4131 SvREADONLY_off(after);
4133 /* We need to follow the pointers around the loop. */
4135 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4138 /* don't loop forever if the structure is bust, and we have
4139 a pointer into a closed loop. */
4140 assert (current != after);
4141 assert (SvPVX_const(current) == pvx);
4143 /* Make the SV before us point to the SV after us. */
4144 SV_COW_NEXT_SV_SET(current, after);
4150 =for apidoc sv_force_normal_flags
4152 Undo various types of fakery on an SV: if the PV is a shared string, make
4153 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4154 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4155 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4156 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4157 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4158 set to some other value.) In addition, the C<flags> parameter gets passed to
4159 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4160 with flags set to 0.
4166 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4169 #ifdef PERL_OLD_COPY_ON_WRITE
4170 if (SvREADONLY(sv)) {
4171 /* At this point I believe I should acquire a global SV mutex. */
4173 const char * const pvx = SvPVX_const(sv);
4174 const STRLEN len = SvLEN(sv);
4175 const STRLEN cur = SvCUR(sv);
4176 /* next COW sv in the loop. If len is 0 then this is a shared-hash
4177 key scalar, so we mustn't attempt to call SV_COW_NEXT_SV(), as
4178 we'll fail an assertion. */
4179 SV * const next = len ? SV_COW_NEXT_SV(sv) : 0;
4182 PerlIO_printf(Perl_debug_log,
4183 "Copy on write: Force normal %ld\n",
4189 /* This SV doesn't own the buffer, so need to Newx() a new one: */
4192 if (flags & SV_COW_DROP_PV) {
4193 /* OK, so we don't need to copy our buffer. */
4196 SvGROW(sv, cur + 1);
4197 Move(pvx,SvPVX(sv),cur,char);
4202 sv_release_COW(sv, pvx, next);
4204 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4210 else if (IN_PERL_RUNTIME)
4211 Perl_croak(aTHX_ PL_no_modify);
4212 /* At this point I believe that I can drop the global SV mutex. */
4215 if (SvREADONLY(sv)) {
4217 const char * const pvx = SvPVX_const(sv);
4218 const STRLEN len = SvCUR(sv);
4223 SvGROW(sv, len + 1);
4224 Move(pvx,SvPVX(sv),len,char);
4226 unshare_hek(SvSHARED_HEK_FROM_PV(pvx));
4228 else if (IN_PERL_RUNTIME)
4229 Perl_croak(aTHX_ PL_no_modify);
4233 sv_unref_flags(sv, flags);
4234 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4241 Efficient removal of characters from the beginning of the string buffer.
4242 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4243 the string buffer. The C<ptr> becomes the first character of the adjusted
4244 string. Uses the "OOK hack".
4245 Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
4246 refer to the same chunk of data.
4252 Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
4258 const U8 *real_start;
4261 if (!ptr || !SvPOKp(sv))
4263 delta = ptr - SvPVX_const(sv);
4265 /* Nothing to do. */
4268 assert(ptr > SvPVX_const(sv));
4269 SV_CHECK_THINKFIRST(sv);
4272 if (!SvLEN(sv)) { /* make copy of shared string */
4273 const char *pvx = SvPVX_const(sv);
4274 const STRLEN len = SvCUR(sv);
4275 SvGROW(sv, len + 1);
4276 Move(pvx,SvPVX(sv),len,char);
4279 SvFLAGS(sv) |= SVf_OOK;
4282 SvOOK_offset(sv, old_delta);
4284 SvLEN_set(sv, SvLEN(sv) - delta);
4285 SvCUR_set(sv, SvCUR(sv) - delta);
4286 SvPV_set(sv, SvPVX(sv) + delta);
4288 p = (U8 *)SvPVX_const(sv);
4293 real_start = p - delta;
4297 if (delta < 0x100) {
4301 p -= sizeof(STRLEN);
4302 Copy((U8*)&delta, p, sizeof(STRLEN), U8);
4306 /* Fill the preceding buffer with sentinals to verify that no-one is
4308 while (p > real_start) {
4316 =for apidoc sv_catpvn
4318 Concatenates the string onto the end of the string which is in the SV. The
4319 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4320 status set, then the bytes appended should be valid UTF-8.
4321 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
4323 =for apidoc sv_catpvn_flags
4325 Concatenates the string onto the end of the string which is in the SV. The
4326 C<len> indicates number of bytes to copy. If the SV has the UTF-8
4327 status set, then the bytes appended should be valid UTF-8.
4328 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4329 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4330 in terms of this function.
4336 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4340 const char * const dstr = SvPV_force_flags(dsv, dlen, flags);
4342 SvGROW(dsv, dlen + slen + 1);
4344 sstr = SvPVX_const(dsv);
4345 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4346 SvCUR_set(dsv, SvCUR(dsv) + slen);
4348 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4350 if (flags & SV_SMAGIC)
4355 =for apidoc sv_catsv
4357 Concatenates the string from SV C<ssv> onto the end of the string in
4358 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4359 not 'set' magic. See C<sv_catsv_mg>.
4361 =for apidoc sv_catsv_flags
4363 Concatenates the string from SV C<ssv> onto the end of the string in
4364 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4365 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4366 and C<sv_catsv_nomg> are implemented in terms of this function.
4371 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
4376 const char *spv = SvPV_const(ssv, slen);
4378 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4379 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
4380 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4381 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4382 dsv->sv_flags doesn't have that bit set.
4383 Andy Dougherty 12 Oct 2001
4385 const I32 sutf8 = DO_UTF8(ssv);
4388 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4390 dutf8 = DO_UTF8(dsv);
4392 if (dutf8 != sutf8) {
4394 /* Not modifying source SV, so taking a temporary copy. */
4395 SV* const csv = newSVpvn_flags(spv, slen, SVs_TEMP);
4397 sv_utf8_upgrade(csv);
4398 spv = SvPV_const(csv, slen);
4401 sv_utf8_upgrade_nomg(dsv);
4403 sv_catpvn_nomg(dsv, spv, slen);
4406 if (flags & SV_SMAGIC)
4411 =for apidoc sv_catpv
4413 Concatenates the string onto the end of the string which is in the SV.
4414 If the SV has the UTF-8 status set, then the bytes appended should be
4415 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
4420 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
4423 register STRLEN len;
4429 junk = SvPV_force(sv, tlen);
4431 SvGROW(sv, tlen + len + 1);
4433 ptr = SvPVX_const(sv);
4434 Move(ptr,SvPVX(sv)+tlen,len+1,char);
4435 SvCUR_set(sv, SvCUR(sv) + len);
4436 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4441 =for apidoc sv_catpv_mg
4443 Like C<sv_catpv>, but also handles 'set' magic.
4449 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
4458 Creates a new SV. A non-zero C<len> parameter indicates the number of
4459 bytes of preallocated string space the SV should have. An extra byte for a
4460 trailing NUL is also reserved. (SvPOK is not set for the SV even if string
4461 space is allocated.) The reference count for the new SV is set to 1.
4463 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
4464 parameter, I<x>, a debug aid which allowed callers to identify themselves.
4465 This aid has been superseded by a new build option, PERL_MEM_LOG (see
4466 L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
4467 modules supporting older perls.
4473 Perl_newSV(pTHX_ STRLEN len)
4480 sv_upgrade(sv, SVt_PV);
4481 SvGROW(sv, len + 1);
4486 =for apidoc sv_magicext
4488 Adds magic to an SV, upgrading it if necessary. Applies the
4489 supplied vtable and returns a pointer to the magic added.
4491 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
4492 In particular, you can add magic to SvREADONLY SVs, and add more than
4493 one instance of the same 'how'.
4495 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
4496 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
4497 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
4498 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
4500 (This is now used as a subroutine by C<sv_magic>.)
4505 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
4506 const char* name, I32 namlen)
4511 SvUPGRADE(sv, SVt_PVMG);
4512 Newxz(mg, 1, MAGIC);
4513 mg->mg_moremagic = SvMAGIC(sv);
4514 SvMAGIC_set(sv, mg);
4516 /* Sometimes a magic contains a reference loop, where the sv and
4517 object refer to each other. To prevent a reference loop that
4518 would prevent such objects being freed, we look for such loops
4519 and if we find one we avoid incrementing the object refcount.
4521 Note we cannot do this to avoid self-tie loops as intervening RV must
4522 have its REFCNT incremented to keep it in existence.
4525 if (!obj || obj == sv ||
4526 how == PERL_MAGIC_arylen ||
4527 how == PERL_MAGIC_symtab ||
4528 (SvTYPE(obj) == SVt_PVGV &&
4529 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4530 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
4531 GvFORM(obj) == (CV*)sv)))
4536 mg->mg_obj = SvREFCNT_inc_simple(obj);
4537 mg->mg_flags |= MGf_REFCOUNTED;
4540 /* Normal self-ties simply pass a null object, and instead of
4541 using mg_obj directly, use the SvTIED_obj macro to produce a
4542 new RV as needed. For glob "self-ties", we are tieing the PVIO
4543 with an RV obj pointing to the glob containing the PVIO. In
4544 this case, to avoid a reference loop, we need to weaken the
4548 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4549 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4555 mg->mg_len = namlen;
4558 mg->mg_ptr = savepvn(name, namlen);
4559 else if (namlen == HEf_SVKEY)
4560 mg->mg_ptr = (char*)SvREFCNT_inc_simple_NN((SV*)name);
4562 mg->mg_ptr = (char *) name;
4564 mg->mg_virtual = (MGVTBL *) vtable;
4568 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4573 =for apidoc sv_magic
4575 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4576 then adds a new magic item of type C<how> to the head of the magic list.
4578 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
4579 handling of the C<name> and C<namlen> arguments.
4581 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
4582 to add more than one instance of the same 'how'.
4588 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
4591 const MGVTBL *vtable;
4594 #ifdef PERL_OLD_COPY_ON_WRITE
4596 sv_force_normal_flags(sv, 0);
4598 if (SvREADONLY(sv)) {
4600 /* its okay to attach magic to shared strings; the subsequent
4601 * upgrade to PVMG will unshare the string */
4602 !(SvFAKE(sv) && SvTYPE(sv) < SVt_PVMG)
4605 && how != PERL_MAGIC_regex_global
4606 && how != PERL_MAGIC_bm
4607 && how != PERL_MAGIC_fm
4608 && how != PERL_MAGIC_sv
4609 && how != PERL_MAGIC_backref
4612 Perl_croak(aTHX_ PL_no_modify);
4615 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4616 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
4617 /* sv_magic() refuses to add a magic of the same 'how' as an
4620 if (how == PERL_MAGIC_taint) {
4622 /* Any scalar which already had taint magic on which someone
4623 (erroneously?) did SvIOK_on() or similar will now be
4624 incorrectly sporting public "OK" flags. */
4625 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4633 vtable = &PL_vtbl_sv;
4635 case PERL_MAGIC_overload:
4636 vtable = &PL_vtbl_amagic;
4638 case PERL_MAGIC_overload_elem:
4639 vtable = &PL_vtbl_amagicelem;
4641 case PERL_MAGIC_overload_table:
4642 vtable = &PL_vtbl_ovrld;
4645 vtable = &PL_vtbl_bm;
4647 case PERL_MAGIC_regdata:
4648 vtable = &PL_vtbl_regdata;
4650 case PERL_MAGIC_regdatum:
4651 vtable = &PL_vtbl_regdatum;
4653 case PERL_MAGIC_env:
4654 vtable = &PL_vtbl_env;
4657 vtable = &PL_vtbl_fm;
4659 case PERL_MAGIC_envelem:
4660 vtable = &PL_vtbl_envelem;
4662 case PERL_MAGIC_regex_global:
4663 vtable = &PL_vtbl_mglob;
4665 case PERL_MAGIC_isa:
4666 vtable = &PL_vtbl_isa;
4668 case PERL_MAGIC_isaelem:
4669 vtable = &PL_vtbl_isaelem;
4671 case PERL_MAGIC_nkeys:
4672 vtable = &PL_vtbl_nkeys;
4674 case PERL_MAGIC_dbfile:
4677 case PERL_MAGIC_dbline:
4678 vtable = &PL_vtbl_dbline;
4680 #ifdef USE_LOCALE_COLLATE
4681 case PERL_MAGIC_collxfrm:
4682 vtable = &PL_vtbl_collxfrm;
4684 #endif /* USE_LOCALE_COLLATE */
4685 case PERL_MAGIC_tied:
4686 vtable = &PL_vtbl_pack;
4688 case PERL_MAGIC_tiedelem:
4689 case PERL_MAGIC_tiedscalar:
4690 vtable = &PL_vtbl_packelem;
4693 vtable = &PL_vtbl_regexp;
4695 case PERL_MAGIC_hints:
4696 /* As this vtable is all NULL, we can reuse it. */
4697 case PERL_MAGIC_sig:
4698 vtable = &PL_vtbl_sig;
4700 case PERL_MAGIC_sigelem:
4701 vtable = &PL_vtbl_sigelem;
4703 case PERL_MAGIC_taint:
4704 vtable = &PL_vtbl_taint;
4706 case PERL_MAGIC_uvar:
4707 vtable = &PL_vtbl_uvar;
4709 case PERL_MAGIC_vec:
4710 vtable = &PL_vtbl_vec;
4712 case PERL_MAGIC_arylen_p:
4713 case PERL_MAGIC_rhash:
4714 case PERL_MAGIC_symtab:
4715 case PERL_MAGIC_vstring:
4718 case PERL_MAGIC_utf8:
4719 vtable = &PL_vtbl_utf8;
4721 case PERL_MAGIC_substr:
4722 vtable = &PL_vtbl_substr;
4724 case PERL_MAGIC_defelem:
4725 vtable = &PL_vtbl_defelem;
4727 case PERL_MAGIC_arylen:
4728 vtable = &PL_vtbl_arylen;
4730 case PERL_MAGIC_pos:
4731 vtable = &PL_vtbl_pos;
4733 case PERL_MAGIC_backref:
4734 vtable = &PL_vtbl_backref;
4736 case PERL_MAGIC_hintselem:
4737 vtable = &PL_vtbl_hintselem;
4739 case PERL_MAGIC_ext:
4740 /* Reserved for use by extensions not perl internals. */
4741 /* Useful for attaching extension internal data to perl vars. */
4742 /* Note that multiple extensions may clash if magical scalars */
4743 /* etc holding private data from one are passed to another. */
4747 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
4750 /* Rest of work is done else where */
4751 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
4754 case PERL_MAGIC_taint:
4757 case PERL_MAGIC_ext:
4758 case PERL_MAGIC_dbfile:
4765 =for apidoc sv_unmagic
4767 Removes all magic of type C<type> from an SV.
4773 Perl_sv_unmagic(pTHX_ SV *sv, int type)
4777 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
4779 mgp = &(((XPVMG*) SvANY(sv))->xmg_u.xmg_magic);
4780 for (mg = *mgp; mg; mg = *mgp) {
4781 if (mg->mg_type == type) {
4782 const MGVTBL* const vtbl = mg->mg_virtual;
4783 *mgp = mg->mg_moremagic;
4784 if (vtbl && vtbl->svt_free)
4785 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
4786 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
4788 Safefree(mg->mg_ptr);
4789 else if (mg->mg_len == HEf_SVKEY)
4790 SvREFCNT_dec((SV*)mg->mg_ptr);
4791 else if (mg->mg_type == PERL_MAGIC_utf8)
4792 Safefree(mg->mg_ptr);
4794 if (mg->mg_flags & MGf_REFCOUNTED)
4795 SvREFCNT_dec(mg->mg_obj);
4799 mgp = &mg->mg_moremagic;
4803 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
4804 SvMAGIC_set(sv, NULL);
4811 =for apidoc sv_rvweaken
4813 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4814 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4815 push a back-reference to this RV onto the array of backreferences
4816 associated with that magic. If the RV is magical, set magic will be
4817 called after the RV is cleared.
4823 Perl_sv_rvweaken(pTHX_ SV *sv)
4826 if (!SvOK(sv)) /* let undefs pass */
4829 Perl_croak(aTHX_ "Can't weaken a nonreference");
4830 else if (SvWEAKREF(sv)) {
4831 if (ckWARN(WARN_MISC))
4832 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
4836 Perl_sv_add_backref(aTHX_ tsv, sv);
4842 /* Give tsv backref magic if it hasn't already got it, then push a
4843 * back-reference to sv onto the array associated with the backref magic.
4847 Perl_sv_add_backref(pTHX_ SV *tsv, SV *sv)
4852 if (SvTYPE(tsv) == SVt_PVHV) {
4853 AV **const avp = Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4857 /* There is no AV in the offical place - try a fixup. */
4858 MAGIC *const mg = mg_find(tsv, PERL_MAGIC_backref);
4861 /* Aha. They've got it stowed in magic. Bring it back. */
4862 av = (AV*)mg->mg_obj;
4863 /* Stop mg_free decreasing the refernce count. */
4865 /* Stop mg_free even calling the destructor, given that
4866 there's no AV to free up. */
4868 sv_unmagic(tsv, PERL_MAGIC_backref);
4872 SvREFCNT_inc_simple_void(av);
4877 const MAGIC *const mg
4878 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4880 av = (AV*)mg->mg_obj;
4884 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
4885 /* av now has a refcnt of 2, which avoids it getting freed
4886 * before us during global cleanup. The extra ref is removed
4887 * by magic_killbackrefs() when tsv is being freed */
4890 if (AvFILLp(av) >= AvMAX(av)) {
4891 av_extend(av, AvFILLp(av)+1);
4893 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
4896 /* delete a back-reference to ourselves from the backref magic associated
4897 * with the SV we point to.
4901 S_sv_del_backref(pTHX_ SV *tsv, SV *sv)
4908 if (SvTYPE(tsv) == SVt_PVHV && SvOOK(tsv)) {
4909 av = *Perl_hv_backreferences_p(aTHX_ (HV*)tsv);
4910 /* We mustn't attempt to "fix up" the hash here by moving the
4911 backreference array back to the hv_aux structure, as that is stored
4912 in the main HvARRAY(), and hfreentries assumes that no-one
4913 reallocates HvARRAY() while it is running. */
4916 const MAGIC *const mg
4917 = SvMAGICAL(tsv) ? mg_find(tsv, PERL_MAGIC_backref) : NULL;
4919 av = (AV *)mg->mg_obj;
4922 if (PL_in_clean_all)
4924 Perl_croak(aTHX_ "panic: del_backref");
4931 /* We shouldn't be in here more than once, but for paranoia reasons lets
4933 for (i = AvFILLp(av); i >= 0; i--) {
4935 const SSize_t fill = AvFILLp(av);
4937 /* We weren't the last entry.
4938 An unordered list has this property that you can take the
4939 last element off the end to fill the hole, and it's still
4940 an unordered list :-)
4945 AvFILLp(av) = fill - 1;
4951 Perl_sv_kill_backrefs(pTHX_ SV *sv, AV *av)
4953 SV **svp = AvARRAY(av);
4955 PERL_UNUSED_ARG(sv);
4957 /* Not sure why the av can get freed ahead of its sv, but somehow it does
4958 in ext/B/t/bytecode.t test 15 (involving print <DATA>) */
4959 if (svp && !SvIS_FREED(av)) {
4960 SV *const *const last = svp + AvFILLp(av);
4962 while (svp <= last) {
4964 SV *const referrer = *svp;
4965 if (SvWEAKREF(referrer)) {
4966 /* XXX Should we check that it hasn't changed? */
4967 SvRV_set(referrer, 0);
4969 SvWEAKREF_off(referrer);
4970 SvSETMAGIC(referrer);
4971 } else if (SvTYPE(referrer) == SVt_PVGV ||
4972 SvTYPE(referrer) == SVt_PVLV) {
4973 /* You lookin' at me? */
4974 assert(GvSTASH(referrer));
4975 assert(GvSTASH(referrer) == (HV*)sv);
4976 GvSTASH(referrer) = 0;
4979 "panic: magic_killbackrefs (flags=%"UVxf")",
4980 (UV)SvFLAGS(referrer));
4988 SvREFCNT_dec(av); /* remove extra count added by sv_add_backref() */
4993 =for apidoc sv_insert
4995 Inserts a string at the specified offset/length within the SV. Similar to
4996 the Perl substr() function.
5002 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5007 register char *midend;
5008 register char *bigend;
5014 Perl_croak(aTHX_ "Can't modify non-existent substring");
5015 SvPV_force(bigstr, curlen);
5016 (void)SvPOK_only_UTF8(bigstr);
5017 if (offset + len > curlen) {
5018 SvGROW(bigstr, offset+len+1);
5019 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5020 SvCUR_set(bigstr, offset+len);
5024 i = littlelen - len;
5025 if (i > 0) { /* string might grow */
5026 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5027 mid = big + offset + len;
5028 midend = bigend = big + SvCUR(bigstr);
5031 while (midend > mid) /* shove everything down */
5032 *--bigend = *--midend;
5033 Move(little,big+offset,littlelen,char);
5034 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5039 Move(little,SvPVX(bigstr)+offset,len,char);
5044 big = SvPVX(bigstr);
5047 bigend = big + SvCUR(bigstr);
5049 if (midend > bigend)
5050 Perl_croak(aTHX_ "panic: sv_insert");
5052 if (mid - big > bigend - midend) { /* faster to shorten from end */
5054 Move(little, mid, littlelen,char);
5057 i = bigend - midend;
5059 Move(midend, mid, i,char);
5063 SvCUR_set(bigstr, mid - big);
5065 else if ((i = mid - big)) { /* faster from front */
5066 midend -= littlelen;
5068 Move(big, midend - i, i, char);
5069 sv_chop(bigstr,midend-i);
5071 Move(little, mid, littlelen,char);
5073 else if (littlelen) {
5074 midend -= littlelen;
5075 sv_chop(bigstr,midend);
5076 Move(little,midend,littlelen,char);
5079 sv_chop(bigstr,midend);
5085 =for apidoc sv_replace
5087 Make the first argument a copy of the second, then delete the original.
5088 The target SV physically takes over ownership of the body of the source SV
5089 and inherits its flags; however, the target keeps any magic it owns,
5090 and any magic in the source is discarded.
5091 Note that this is a rather specialist SV copying operation; most of the
5092 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5098 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5101 const U32 refcnt = SvREFCNT(sv);
5102 SV_CHECK_THINKFIRST_COW_DROP(sv);
5103 if (SvREFCNT(nsv) != 1) {
5104 Perl_croak(aTHX_ "panic: reference miscount on nsv in sv_replace() (%"
5105 UVuf " != 1)", (UV) SvREFCNT(nsv));
5107 if (SvMAGICAL(sv)) {
5111 sv_upgrade(nsv, SVt_PVMG);
5112 SvMAGIC_set(nsv, SvMAGIC(sv));
5113 SvFLAGS(nsv) |= SvMAGICAL(sv);
5115 SvMAGIC_set(sv, NULL);
5119 assert(!SvREFCNT(sv));
5120 #ifdef DEBUG_LEAKING_SCALARS
5121 sv->sv_flags = nsv->sv_flags;
5122 sv->sv_any = nsv->sv_any;
5123 sv->sv_refcnt = nsv->sv_refcnt;
5124 sv->sv_u = nsv->sv_u;
5126 StructCopy(nsv,sv,SV);
5128 if(SvTYPE(sv) == SVt_IV) {
5130 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
5134 #ifdef PERL_OLD_COPY_ON_WRITE
5135 if (SvIsCOW_normal(nsv)) {
5136 /* We need to follow the pointers around the loop to make the
5137 previous SV point to sv, rather than nsv. */
5140 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5143 assert(SvPVX_const(current) == SvPVX_const(nsv));
5145 /* Make the SV before us point to the SV after us. */
5147 PerlIO_printf(Perl_debug_log, "previous is\n");
5149 PerlIO_printf(Perl_debug_log,
5150 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5151 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5153 SV_COW_NEXT_SV_SET(current, sv);
5156 SvREFCNT(sv) = refcnt;
5157 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5163 =for apidoc sv_clear
5165 Clear an SV: call any destructors, free up any memory used by the body,
5166 and free the body itself. The SV's head is I<not> freed, although
5167 its type is set to all 1's so that it won't inadvertently be assumed
5168 to be live during global destruction etc.
5169 This function should only be called when REFCNT is zero. Most of the time
5170 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5177 Perl_sv_clear(pTHX_ register SV *sv)
5180 const U32 type = SvTYPE(sv);
5181 const struct body_details *const sv_type_details
5182 = bodies_by_type + type;
5186 assert(SvREFCNT(sv) == 0);
5187 assert(SvTYPE(sv) != SVTYPEMASK);
5189 if (type <= SVt_IV) {
5190 /* See the comment in sv.h about the collusion between this early
5191 return and the overloading of the NULL and IV slots in the size
5194 SV * const target = SvRV(sv);
5196 sv_del_backref(target, sv);
5198 SvREFCNT_dec(target);
5200 SvFLAGS(sv) &= SVf_BREAK;
5201 SvFLAGS(sv) |= SVTYPEMASK;
5206 if (PL_defstash && /* Still have a symbol table? */
5213 stash = SvSTASH(sv);
5214 destructor = StashHANDLER(stash,DESTROY);
5216 SV* const tmpref = newRV(sv);
5217 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5219 PUSHSTACKi(PERLSI_DESTROY);
5224 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5230 if(SvREFCNT(tmpref) < 2) {
5231 /* tmpref is not kept alive! */
5233 SvRV_set(tmpref, NULL);
5236 SvREFCNT_dec(tmpref);
5238 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5242 if (PL_in_clean_objs)
5243 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5245 /* DESTROY gave object new lease on life */
5251 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5252 SvOBJECT_off(sv); /* Curse the object. */
5253 if (type != SVt_PVIO)
5254 --PL_sv_objcount; /* XXX Might want something more general */
5257 if (type >= SVt_PVMG) {
5258 if (type == SVt_PVMG && SvPAD_OUR(sv)) {
5259 SvREFCNT_dec(SvOURSTASH(sv));
5260 } else if (SvMAGIC(sv))
5262 if (type == SVt_PVMG && SvPAD_TYPED(sv))
5263 SvREFCNT_dec(SvSTASH(sv));
5266 /* case SVt_BIND: */
5269 IoIFP(sv) != PerlIO_stdin() &&
5270 IoIFP(sv) != PerlIO_stdout() &&
5271 IoIFP(sv) != PerlIO_stderr())
5273 io_close((IO*)sv, FALSE);
5275 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5276 PerlDir_close(IoDIRP(sv));
5277 IoDIRP(sv) = (DIR*)NULL;
5278 Safefree(IoTOP_NAME(sv));
5279 Safefree(IoFMT_NAME(sv));
5280 Safefree(IoBOTTOM_NAME(sv));
5283 /* FIXME for plugins */
5284 pregfree2((REGEXP*) sv);
5291 Perl_hv_kill_backrefs(aTHX_ (HV*)sv);
5295 if (PL_comppad == (AV*)sv) {
5302 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5303 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5304 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5305 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5307 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5308 SvREFCNT_dec(LvTARG(sv));
5310 if (isGV_with_GP(sv)) {
5311 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
5312 mro_method_changed_in(stash);
5315 unshare_hek(GvNAME_HEK(sv));
5316 /* If we're in a stash, we don't own a reference to it. However it does
5317 have a back reference to us, which needs to be cleared. */
5318 if (!SvVALID(sv) && (stash = GvSTASH(sv)))
5319 sv_del_backref((SV*)stash, sv);
5321 /* FIXME. There are probably more unreferenced pointers to SVs in the
5322 interpreter struct that we should check and tidy in a similar
5324 if ((GV*)sv == PL_last_in_gv)
5325 PL_last_in_gv = NULL;
5331 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5334 SvOOK_offset(sv, offset);
5335 SvPV_set(sv, SvPVX_mutable(sv) - offset);
5336 /* Don't even bother with turning off the OOK flag. */
5339 SV * const target = SvRV(sv);
5341 sv_del_backref(target, sv);
5343 SvREFCNT_dec(target);
5345 #ifdef PERL_OLD_COPY_ON_WRITE
5346 else if (SvPVX_const(sv)) {
5348 /* I believe I need to grab the global SV mutex here and
5349 then recheck the COW status. */
5351 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5355 sv_release_COW(sv, SvPVX_const(sv), SV_COW_NEXT_SV(sv));
5357 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5360 /* And drop it here. */
5362 } else if (SvLEN(sv)) {
5363 Safefree(SvPVX_const(sv));
5367 else if (SvPVX_const(sv) && SvLEN(sv))
5368 Safefree(SvPVX_mutable(sv));
5369 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5370 unshare_hek(SvSHARED_HEK_FROM_PV(SvPVX_const(sv)));
5379 SvFLAGS(sv) &= SVf_BREAK;
5380 SvFLAGS(sv) |= SVTYPEMASK;
5382 if (sv_type_details->arena) {
5383 del_body(((char *)SvANY(sv) + sv_type_details->offset),
5384 &PL_body_roots[type]);
5386 else if (sv_type_details->body_size) {
5387 my_safefree(SvANY(sv));
5392 =for apidoc sv_newref
5394 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5401 Perl_sv_newref(pTHX_ SV *sv)
5403 PERL_UNUSED_CONTEXT;
5412 Decrement an SV's reference count, and if it drops to zero, call
5413 C<sv_clear> to invoke destructors and free up any memory used by
5414 the body; finally, deallocate the SV's head itself.
5415 Normally called via a wrapper macro C<SvREFCNT_dec>.
5421 Perl_sv_free(pTHX_ SV *sv)
5426 if (SvREFCNT(sv) == 0) {
5427 if (SvFLAGS(sv) & SVf_BREAK)
5428 /* this SV's refcnt has been artificially decremented to
5429 * trigger cleanup */
5431 if (PL_in_clean_all) /* All is fair */
5433 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5434 /* make sure SvREFCNT(sv)==0 happens very seldom */
5435 SvREFCNT(sv) = (~(U32)0)/2;
5438 if (ckWARN_d(WARN_INTERNAL)) {
5439 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
5440 Perl_dump_sv_child(aTHX_ sv);
5442 #ifdef DEBUG_LEAKING_SCALARS
5445 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5446 if (PL_warnhook == PERL_WARNHOOK_FATAL
5447 || ckDEAD(packWARN(WARN_INTERNAL))) {
5448 /* Don't let Perl_warner cause us to escape our fate: */
5452 /* This may not return: */
5453 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
5454 "Attempt to free unreferenced scalar: SV 0x%"UVxf
5455 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5458 #ifdef DEBUG_LEAKING_SCALARS_ABORT
5463 if (--(SvREFCNT(sv)) > 0)
5465 Perl_sv_free2(aTHX_ sv);
5469 Perl_sv_free2(pTHX_ SV *sv)
5474 if (ckWARN_d(WARN_DEBUGGING))
5475 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
5476 "Attempt to free temp prematurely: SV 0x%"UVxf
5477 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
5481 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5482 /* make sure SvREFCNT(sv)==0 happens very seldom */
5483 SvREFCNT(sv) = (~(U32)0)/2;
5494 Returns the length of the string in the SV. Handles magic and type
5495 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
5501 Perl_sv_len(pTHX_ register SV *sv)
5509 len = mg_length(sv);
5511 (void)SvPV_const(sv, len);
5516 =for apidoc sv_len_utf8
5518 Returns the number of characters in the string in an SV, counting wide
5519 UTF-8 bytes as a single character. Handles magic and type coercion.
5525 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5526 * mg_ptr is used, by sv_pos_u2b() and sv_pos_b2u() - see the comments below.
5527 * (Note that the mg_len is not the length of the mg_ptr field.
5528 * This allows the cache to store the character length of the string without
5529 * needing to malloc() extra storage to attach to the mg_ptr.)
5534 Perl_sv_len_utf8(pTHX_ register SV *sv)
5540 return mg_length(sv);
5544 const U8 *s = (U8*)SvPV_const(sv, len);
5548 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : NULL;
5550 if (mg && mg->mg_len != -1) {
5552 if (PL_utf8cache < 0) {
5553 const STRLEN real = Perl_utf8_length(aTHX_ s, s + len);
5555 /* Need to turn the assertions off otherwise we may
5556 recurse infinitely while printing error messages.
5558 SAVEI8(PL_utf8cache);
5560 Perl_croak(aTHX_ "panic: sv_len_utf8 cache %"UVuf
5561 " real %"UVuf" for %"SVf,
5562 (UV) ulen, (UV) real, SVfARG(sv));
5567 ulen = Perl_utf8_length(aTHX_ s, s + len);
5568 if (!SvREADONLY(sv)) {
5570 mg = sv_magicext(sv, 0, PERL_MAGIC_utf8,
5571 &PL_vtbl_utf8, 0, 0);
5579 return Perl_utf8_length(aTHX_ s, s + len);
5583 /* Walk forwards to find the byte corresponding to the passed in UTF-8
5586 S_sv_pos_u2b_forwards(const U8 *const start, const U8 *const send,
5589 const U8 *s = start;
5591 while (s < send && uoffset--)
5594 /* This is the existing behaviour. Possibly it should be a croak, as
5595 it's actually a bounds error */
5601 /* Given the length of the string in both bytes and UTF-8 characters, decide
5602 whether to walk forwards or backwards to find the byte corresponding to
5603 the passed in UTF-8 offset. */
5605 S_sv_pos_u2b_midway(const U8 *const start, const U8 *send,
5606 STRLEN uoffset, STRLEN uend)
5608 STRLEN backw = uend - uoffset;
5609 if (uoffset < 2 * backw) {
5610 /* The assumption is that going forwards is twice the speed of going
5611 forward (that's where the 2 * backw comes from).
5612 (The real figure of course depends on the UTF-8 data.) */
5613 return sv_pos_u2b_forwards(start, send, uoffset);
5618 while (UTF8_IS_CONTINUATION(*send))
5621 return send - start;
5624 /* For the string representation of the given scalar, find the byte
5625 corresponding to the passed in UTF-8 offset. uoffset0 and boffset0
5626 give another position in the string, *before* the sought offset, which
5627 (which is always true, as 0, 0 is a valid pair of positions), which should
5628 help reduce the amount of linear searching.
5629 If *mgp is non-NULL, it should point to the UTF-8 cache magic, which
5630 will be used to reduce the amount of linear searching. The cache will be
5631 created if necessary, and the found value offered to it for update. */
5633 S_sv_pos_u2b_cached(pTHX_ SV *sv, MAGIC **mgp, const U8 *const start,
5634 const U8 *const send, STRLEN uoffset,
5635 STRLEN uoffset0, STRLEN boffset0) {
5636 STRLEN boffset = 0; /* Actually always set, but let's keep gcc happy. */
5639 assert (uoffset >= uoffset0);
5641 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
5642 && (*mgp || (*mgp = mg_find(sv, PERL_MAGIC_utf8)))) {
5643 if ((*mgp)->mg_ptr) {
5644 STRLEN *cache = (STRLEN *) (*mgp)->mg_ptr;
5645 if (cache[0] == uoffset) {
5646 /* An exact match. */
5649 if (cache[2] == uoffset) {
5650 /* An exact match. */
5654 if (cache[0] < uoffset) {
5655 /* The cache already knows part of the way. */
5656 if (cache[0] > uoffset0) {
5657 /* The cache knows more than the passed in pair */
5658 uoffset0 = cache[0];
5659 boffset0 = cache[1];
5661 if ((*mgp)->mg_len != -1) {
5662 /* And we know the end too. */
5664 + sv_pos_u2b_midway(start + boffset0, send,
5666 (*mgp)->mg_len - uoffset0);
5669 + sv_pos_u2b_forwards(start + boffset0,
5670 send, uoffset - uoffset0);
5673 else if (cache[2] < uoffset) {
5674 /* We're between the two cache entries. */
5675 if (cache[2] > uoffset0) {
5676 /* and the cache knows more than the passed in pair */
5677 uoffset0 = cache[2];
5678 boffset0 = cache[3];
5682 + sv_pos_u2b_midway(start + boffset0,
5685 cache[0] - uoffset0);
5688 + sv_pos_u2b_midway(start + boffset0,
5691 cache[2] - uoffset0);
5695 else if ((*mgp)->mg_len != -1) {
5696 /* If we can take advantage of a passed in offset, do so. */
5697 /* In fact, offset0 is either 0, or less than offset, so don't
5698 need to worry about the other possibility. */
5700 + sv_pos_u2b_midway(start + boffset0, send,
5702 (*mgp)->mg_len - uoffset0);
5707 if (!found || PL_utf8cache < 0) {
5708 const STRLEN real_boffset
5709 = boffset0 + sv_pos_u2b_forwards(start + boffset0,
5710 send, uoffset - uoffset0);
5712 if (found && PL_utf8cache < 0) {
5713 if (real_boffset != boffset) {
5714 /* Need to turn the assertions off otherwise we may recurse
5715 infinitely while printing error messages. */
5716 SAVEI8(PL_utf8cache);
5718 Perl_croak(aTHX_ "panic: sv_pos_u2b_cache cache %"UVuf
5719 " real %"UVuf" for %"SVf,
5720 (UV) boffset, (UV) real_boffset, SVfARG(sv));
5723 boffset = real_boffset;
5726 S_utf8_mg_pos_cache_update(aTHX_ sv, mgp, boffset, uoffset, send - start);
5732 =for apidoc sv_pos_u2b
5734 Converts the value pointed to by offsetp from a count of UTF-8 chars from
5735 the start of the string, to a count of the equivalent number of bytes; if
5736 lenp is non-zero, it does the same to lenp, but this time starting from
5737 the offset, rather than from the start of the string. Handles magic and
5744 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5745 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5746 * byte offsets. See also the comments of S_utf8_mg_pos_cache_update().
5751 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
5759 start = (U8*)SvPV_const(sv, len);
5761 STRLEN uoffset = (STRLEN) *offsetp;
5762 const U8 * const send = start + len;
5764 const STRLEN boffset = sv_pos_u2b_cached(sv, &mg, start, send,
5767 *offsetp = (I32) boffset;
5770 /* Convert the relative offset to absolute. */
5771 const STRLEN uoffset2 = uoffset + (STRLEN) *lenp;
5772 const STRLEN boffset2
5773 = sv_pos_u2b_cached(sv, &mg, start, send, uoffset2,
5774 uoffset, boffset) - boffset;
5788 /* Create and update the UTF8 magic offset cache, with the proffered utf8/
5789 byte length pairing. The (byte) length of the total SV is passed in too,
5790 as blen, because for some (more esoteric) SVs, the call to SvPV_const()
5791 may not have updated SvCUR, so we can't rely on reading it directly.
5793 The proffered utf8/byte length pairing isn't used if the cache already has
5794 two pairs, and swapping either for the proffered pair would increase the
5795 RMS of the intervals between known byte offsets.
5797 The cache itself consists of 4 STRLEN values
5798 0: larger UTF-8 offset
5799 1: corresponding byte offset
5800 2: smaller UTF-8 offset
5801 3: corresponding byte offset
5803 Unused cache pairs have the value 0, 0.
5804 Keeping the cache "backwards" means that the invariant of
5805 cache[0] >= cache[2] is maintained even with empty slots, which means that
5806 the code that uses it doesn't need to worry if only 1 entry has actually
5807 been set to non-zero. It also makes the "position beyond the end of the
5808 cache" logic much simpler, as the first slot is always the one to start
5812 S_utf8_mg_pos_cache_update(pTHX_ SV *sv, MAGIC **mgp, STRLEN byte, STRLEN utf8,
5820 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0,
5822 (*mgp)->mg_len = -1;
5826 if (!(cache = (STRLEN *)(*mgp)->mg_ptr)) {
5827 Newxz(cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5828 (*mgp)->mg_ptr = (char *) cache;
5832 if (PL_utf8cache < 0) {
5833 const U8 *start = (const U8 *) SvPVX_const(sv);
5834 const STRLEN realutf8 = utf8_length(start, start + byte);
5836 if (realutf8 != utf8) {
5837 /* Need to turn the assertions off otherwise we may recurse
5838 infinitely while printing error messages. */
5839 SAVEI8(PL_utf8cache);
5841 Perl_croak(aTHX_ "panic: utf8_mg_pos_cache_update cache %"UVuf
5842 " real %"UVuf" for %"SVf, (UV) utf8, (UV) realutf8, SVfARG(sv));
5846 /* Cache is held with the later position first, to simplify the code
5847 that deals with unbounded ends. */
5849 ASSERT_UTF8_CACHE(cache);
5850 if (cache[1] == 0) {
5851 /* Cache is totally empty */
5854 } else if (cache[3] == 0) {
5855 if (byte > cache[1]) {
5856 /* New one is larger, so goes first. */
5857 cache[2] = cache[0];
5858 cache[3] = cache[1];
5866 #define THREEWAY_SQUARE(a,b,c,d) \
5867 ((float)((d) - (c))) * ((float)((d) - (c))) \
5868 + ((float)((c) - (b))) * ((float)((c) - (b))) \
5869 + ((float)((b) - (a))) * ((float)((b) - (a)))
5871 /* Cache has 2 slots in use, and we know three potential pairs.
5872 Keep the two that give the lowest RMS distance. Do the
5873 calcualation in bytes simply because we always know the byte
5874 length. squareroot has the same ordering as the positive value,
5875 so don't bother with the actual square root. */
5876 const float existing = THREEWAY_SQUARE(0, cache[3], cache[1], blen);
5877 if (byte > cache[1]) {
5878 /* New position is after the existing pair of pairs. */
5879 const float keep_earlier
5880 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5881 const float keep_later
5882 = THREEWAY_SQUARE(0, cache[1], byte, blen);
5884 if (keep_later < keep_earlier) {
5885 if (keep_later < existing) {
5886 cache[2] = cache[0];
5887 cache[3] = cache[1];
5893 if (keep_earlier < existing) {
5899 else if (byte > cache[3]) {
5900 /* New position is between the existing pair of pairs. */
5901 const float keep_earlier
5902 = THREEWAY_SQUARE(0, cache[3], byte, blen);
5903 const float keep_later
5904 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5906 if (keep_later < keep_earlier) {
5907 if (keep_later < existing) {
5913 if (keep_earlier < existing) {
5920 /* New position is before the existing pair of pairs. */
5921 const float keep_earlier
5922 = THREEWAY_SQUARE(0, byte, cache[3], blen);
5923 const float keep_later
5924 = THREEWAY_SQUARE(0, byte, cache[1], blen);
5926 if (keep_later < keep_earlier) {
5927 if (keep_later < existing) {
5933 if (keep_earlier < existing) {
5934 cache[0] = cache[2];
5935 cache[1] = cache[3];
5942 ASSERT_UTF8_CACHE(cache);
5945 /* We already know all of the way, now we may be able to walk back. The same
5946 assumption is made as in S_sv_pos_u2b_midway(), namely that walking
5947 backward is half the speed of walking forward. */
5949 S_sv_pos_b2u_midway(pTHX_ const U8 *s, const U8 *const target, const U8 *end,
5952 const STRLEN forw = target - s;
5953 STRLEN backw = end - target;
5955 if (forw < 2 * backw) {
5956 return utf8_length(s, target);
5959 while (end > target) {
5961 while (UTF8_IS_CONTINUATION(*end)) {
5970 =for apidoc sv_pos_b2u
5972 Converts the value pointed to by offsetp from a count of bytes from the
5973 start of the string, to a count of the equivalent number of UTF-8 chars.
5974 Handles magic and type coercion.
5980 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5981 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5986 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
5989 const STRLEN byte = *offsetp;
5990 STRLEN len = 0; /* Actually always set, but let's keep gcc happy. */
5999 s = (const U8*)SvPV_const(sv, blen);
6002 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6006 if (SvMAGICAL(sv) && !SvREADONLY(sv) && PL_utf8cache
6007 && (mg = mg_find(sv, PERL_MAGIC_utf8))) {
6009 STRLEN * const cache = (STRLEN *) mg->mg_ptr;
6010 if (cache[1] == byte) {
6011 /* An exact match. */
6012 *offsetp = cache[0];
6015 if (cache[3] == byte) {
6016 /* An exact match. */
6017 *offsetp = cache[2];
6021 if (cache[1] < byte) {
6022 /* We already know part of the way. */
6023 if (mg->mg_len != -1) {
6024 /* Actually, we know the end too. */
6026 + S_sv_pos_b2u_midway(aTHX_ s + cache[1], send,
6027 s + blen, mg->mg_len - cache[0]);
6029 len = cache[0] + utf8_length(s + cache[1], send);
6032 else if (cache[3] < byte) {
6033 /* We're between the two cached pairs, so we do the calculation
6034 offset by the byte/utf-8 positions for the earlier pair,
6035 then add the utf-8 characters from the string start to
6037 len = S_sv_pos_b2u_midway(aTHX_ s + cache[3], send,
6038 s + cache[1], cache[0] - cache[2])
6042 else { /* cache[3] > byte */
6043 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + cache[3],
6047 ASSERT_UTF8_CACHE(cache);
6049 } else if (mg->mg_len != -1) {
6050 len = S_sv_pos_b2u_midway(aTHX_ s, send, s + blen, mg->mg_len);
6054 if (!found || PL_utf8cache < 0) {
6055 const STRLEN real_len = utf8_length(s, send);
6057 if (found && PL_utf8cache < 0) {
6058 if (len != real_len) {
6059 /* Need to turn the assertions off otherwise we may recurse
6060 infinitely while printing error messages. */
6061 SAVEI8(PL_utf8cache);
6063 Perl_croak(aTHX_ "panic: sv_pos_b2u cache %"UVuf
6064 " real %"UVuf" for %"SVf,
6065 (UV) len, (UV) real_len, SVfARG(sv));
6072 S_utf8_mg_pos_cache_update(aTHX_ sv, &mg, byte, len, blen);
6078 Returns a boolean indicating whether the strings in the two SVs are
6079 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6080 coerce its args to strings if necessary.
6086 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6095 SV* svrecode = NULL;
6102 /* if pv1 and pv2 are the same, second SvPV_const call may
6103 * invalidate pv1, so we may need to make a copy */
6104 if (sv1 == sv2 && (SvTHINKFIRST(sv1) || SvGMAGICAL(sv1))) {
6105 pv1 = SvPV_const(sv1, cur1);
6106 sv1 = newSVpvn_flags(pv1, cur1, SVs_TEMP | SvUTF8(sv2));
6108 pv1 = SvPV_const(sv1, cur1);
6116 pv2 = SvPV_const(sv2, cur2);
6118 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6119 /* Differing utf8ness.
6120 * Do not UTF8size the comparands as a side-effect. */
6123 svrecode = newSVpvn(pv2, cur2);
6124 sv_recode_to_utf8(svrecode, PL_encoding);
6125 pv2 = SvPV_const(svrecode, cur2);
6128 svrecode = newSVpvn(pv1, cur1);
6129 sv_recode_to_utf8(svrecode, PL_encoding);
6130 pv1 = SvPV_const(svrecode, cur1);
6132 /* Now both are in UTF-8. */
6134 SvREFCNT_dec(svrecode);
6139 bool is_utf8 = TRUE;
6142 /* sv1 is the UTF-8 one,
6143 * if is equal it must be downgrade-able */
6144 char * const pv = (char*)bytes_from_utf8((const U8*)pv1,
6150 /* sv2 is the UTF-8 one,
6151 * if is equal it must be downgrade-able */
6152 char * const pv = (char *)bytes_from_utf8((const U8*)pv2,
6158 /* Downgrade not possible - cannot be eq */
6166 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6168 SvREFCNT_dec(svrecode);
6178 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6179 string in C<sv1> is less than, equal to, or greater than the string in
6180 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6181 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6187 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6191 const char *pv1, *pv2;
6194 SV *svrecode = NULL;
6201 pv1 = SvPV_const(sv1, cur1);
6208 pv2 = SvPV_const(sv2, cur2);
6210 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6211 /* Differing utf8ness.
6212 * Do not UTF8size the comparands as a side-effect. */
6215 svrecode = newSVpvn(pv2, cur2);
6216 sv_recode_to_utf8(svrecode, PL_encoding);
6217 pv2 = SvPV_const(svrecode, cur2);
6220 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6225 svrecode = newSVpvn(pv1, cur1);
6226 sv_recode_to_utf8(svrecode, PL_encoding);
6227 pv1 = SvPV_const(svrecode, cur1);
6230 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6236 cmp = cur2 ? -1 : 0;
6240 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6243 cmp = retval < 0 ? -1 : 1;
6244 } else if (cur1 == cur2) {
6247 cmp = cur1 < cur2 ? -1 : 1;
6251 SvREFCNT_dec(svrecode);
6259 =for apidoc sv_cmp_locale
6261 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6262 'use bytes' aware, handles get magic, and will coerce its args to strings
6263 if necessary. See also C<sv_cmp>.
6269 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6272 #ifdef USE_LOCALE_COLLATE
6278 if (PL_collation_standard)
6282 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6284 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6286 if (!pv1 || !len1) {
6297 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6300 return retval < 0 ? -1 : 1;
6303 * When the result of collation is equality, that doesn't mean
6304 * that there are no differences -- some locales exclude some
6305 * characters from consideration. So to avoid false equalities,
6306 * we use the raw string as a tiebreaker.
6312 #endif /* USE_LOCALE_COLLATE */
6314 return sv_cmp(sv1, sv2);
6318 #ifdef USE_LOCALE_COLLATE
6321 =for apidoc sv_collxfrm
6323 Add Collate Transform magic to an SV if it doesn't already have it.
6325 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6326 scalar data of the variable, but transformed to such a format that a normal
6327 memory comparison can be used to compare the data according to the locale
6334 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6339 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6340 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6346 Safefree(mg->mg_ptr);
6347 s = SvPV_const(sv, len);
6348 if ((xf = mem_collxfrm(s, len, &xlen))) {
6349 if (SvREADONLY(sv)) {
6352 return xf + sizeof(PL_collation_ix);
6355 #ifdef PERL_OLD_COPY_ON_WRITE
6357 sv_force_normal_flags(sv, 0);
6359 mg = sv_magicext(sv, 0, PERL_MAGIC_collxfrm, &PL_vtbl_collxfrm,
6373 if (mg && mg->mg_ptr) {
6375 return mg->mg_ptr + sizeof(PL_collation_ix);
6383 #endif /* USE_LOCALE_COLLATE */
6388 Get a line from the filehandle and store it into the SV, optionally
6389 appending to the currently-stored string.
6395 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6400 register STDCHAR rslast;
6401 register STDCHAR *bp;
6406 if (SvTHINKFIRST(sv))
6407 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6408 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6410 However, perlbench says it's slower, because the existing swipe code
6411 is faster than copy on write.
6412 Swings and roundabouts. */
6413 SvUPGRADE(sv, SVt_PV);
6418 if (PerlIO_isutf8(fp)) {
6420 sv_utf8_upgrade_nomg(sv);
6421 sv_pos_u2b(sv,&append,0);
6423 } else if (SvUTF8(sv)) {
6424 SV * const tsv = newSV(0);
6425 sv_gets(tsv, fp, 0);
6426 sv_utf8_upgrade_nomg(tsv);
6427 SvCUR_set(sv,append);
6430 goto return_string_or_null;
6435 if (PerlIO_isutf8(fp))
6438 if (IN_PERL_COMPILETIME) {
6439 /* we always read code in line mode */
6443 else if (RsSNARF(PL_rs)) {
6444 /* If it is a regular disk file use size from stat() as estimate
6445 of amount we are going to read -- may result in mallocing
6446 more memory than we really need if the layers below reduce
6447 the size we read (e.g. CRLF or a gzip layer).
6450 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6451 const Off_t offset = PerlIO_tell(fp);
6452 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6453 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6459 else if (RsRECORD(PL_rs)) {
6464 /* Grab the size of the record we're getting */
6465 recsize = SvUV(SvRV(PL_rs)); /* RsRECORD() guarantees > 0. */
6466 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6469 /* VMS wants read instead of fread, because fread doesn't respect */
6470 /* RMS record boundaries. This is not necessarily a good thing to be */
6471 /* doing, but we've got no other real choice - except avoid stdio
6472 as implementation - perhaps write a :vms layer ?
6474 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6476 bytesread = PerlIO_read(fp, buffer, recsize);
6480 SvCUR_set(sv, bytesread += append);
6481 buffer[bytesread] = '\0';
6482 goto return_string_or_null;
6484 else if (RsPARA(PL_rs)) {
6490 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6491 if (PerlIO_isutf8(fp)) {
6492 rsptr = SvPVutf8(PL_rs, rslen);
6495 if (SvUTF8(PL_rs)) {
6496 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6497 Perl_croak(aTHX_ "Wide character in $/");
6500 rsptr = SvPV_const(PL_rs, rslen);
6504 rslast = rslen ? rsptr[rslen - 1] : '\0';
6506 if (rspara) { /* have to do this both before and after */
6507 do { /* to make sure file boundaries work right */
6510 i = PerlIO_getc(fp);
6514 PerlIO_ungetc(fp,i);
6520 /* See if we know enough about I/O mechanism to cheat it ! */
6522 /* This used to be #ifdef test - it is made run-time test for ease
6523 of abstracting out stdio interface. One call should be cheap
6524 enough here - and may even be a macro allowing compile
6528 if (PerlIO_fast_gets(fp)) {
6531 * We're going to steal some values from the stdio struct
6532 * and put EVERYTHING in the innermost loop into registers.
6534 register STDCHAR *ptr;
6538 #if defined(VMS) && defined(PERLIO_IS_STDIO)
6539 /* An ungetc()d char is handled separately from the regular
6540 * buffer, so we getc() it back out and stuff it in the buffer.
6542 i = PerlIO_getc(fp);
6543 if (i == EOF) return 0;
6544 *(--((*fp)->_ptr)) = (unsigned char) i;
6548 /* Here is some breathtakingly efficient cheating */
6550 cnt = PerlIO_get_cnt(fp); /* get count into register */
6551 /* make sure we have the room */
6552 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6553 /* Not room for all of it
6554 if we are looking for a separator and room for some
6556 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6557 /* just process what we have room for */
6558 shortbuffered = cnt - SvLEN(sv) + append + 1;
6559 cnt -= shortbuffered;
6563 /* remember that cnt can be negative */
6564 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
6569 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
6570 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
6571 DEBUG_P(PerlIO_printf(Perl_debug_log,
6572 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6573 DEBUG_P(PerlIO_printf(Perl_debug_log,
6574 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6575 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6576 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
6581 while (cnt > 0) { /* this | eat */
6583 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6584 goto thats_all_folks; /* screams | sed :-) */
6588 Copy(ptr, bp, cnt, char); /* this | eat */
6589 bp += cnt; /* screams | dust */
6590 ptr += cnt; /* louder | sed :-) */
6595 if (shortbuffered) { /* oh well, must extend */
6596 cnt = shortbuffered;
6598 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6600 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
6601 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6605 DEBUG_P(PerlIO_printf(Perl_debug_log,
6606 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6607 PTR2UV(ptr),(long)cnt));
6608 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
6610 DEBUG_P(PerlIO_printf(Perl_debug_log,
6611 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6612 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6613 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6615 /* This used to call 'filbuf' in stdio form, but as that behaves like
6616 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6617 another abstraction. */
6618 i = PerlIO_getc(fp); /* get more characters */
6620 DEBUG_P(PerlIO_printf(Perl_debug_log,
6621 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6622 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6623 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6625 cnt = PerlIO_get_cnt(fp);
6626 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
6627 DEBUG_P(PerlIO_printf(Perl_debug_log,
6628 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6630 if (i == EOF) /* all done for ever? */
6631 goto thats_really_all_folks;
6633 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
6635 SvGROW(sv, bpx + cnt + 2);
6636 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
6638 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
6640 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
6641 goto thats_all_folks;
6645 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
6646 memNE((char*)bp - rslen, rsptr, rslen))
6647 goto screamer; /* go back to the fray */
6648 thats_really_all_folks:
6650 cnt += shortbuffered;
6651 DEBUG_P(PerlIO_printf(Perl_debug_log,
6652 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
6653 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
6654 DEBUG_P(PerlIO_printf(Perl_debug_log,
6655 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
6656 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
6657 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
6659 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
6660 DEBUG_P(PerlIO_printf(Perl_debug_log,
6661 "Screamer: done, len=%ld, string=|%.*s|\n",
6662 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
6666 /*The big, slow, and stupid way. */
6667 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6668 STDCHAR *buf = NULL;
6669 Newx(buf, 8192, STDCHAR);
6677 register const STDCHAR * const bpe = buf + sizeof(buf);
6679 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
6680 ; /* keep reading */
6684 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
6685 /* Accomodate broken VAXC compiler, which applies U8 cast to
6686 * both args of ?: operator, causing EOF to change into 255
6689 i = (U8)buf[cnt - 1];
6695 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6697 sv_catpvn(sv, (char *) buf, cnt);
6699 sv_setpvn(sv, (char *) buf, cnt);
6701 if (i != EOF && /* joy */
6703 SvCUR(sv) < rslen ||
6704 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
6708 * If we're reading from a TTY and we get a short read,
6709 * indicating that the user hit his EOF character, we need
6710 * to notice it now, because if we try to read from the TTY
6711 * again, the EOF condition will disappear.
6713 * The comparison of cnt to sizeof(buf) is an optimization
6714 * that prevents unnecessary calls to feof().
6718 if (!(cnt < (I32)sizeof(buf) && PerlIO_eof(fp)))
6722 #ifdef USE_HEAP_INSTEAD_OF_STACK
6727 if (rspara) { /* have to do this both before and after */
6728 while (i != EOF) { /* to make sure file boundaries work right */
6729 i = PerlIO_getc(fp);
6731 PerlIO_ungetc(fp,i);
6737 return_string_or_null:
6738 return (SvCUR(sv) - append) ? SvPVX(sv) : NULL;
6744 Auto-increment of the value in the SV, doing string to numeric conversion
6745 if necessary. Handles 'get' magic.
6751 Perl_sv_inc(pTHX_ register SV *sv)
6760 if (SvTHINKFIRST(sv)) {
6762 sv_force_normal_flags(sv, 0);
6763 if (SvREADONLY(sv)) {
6764 if (IN_PERL_RUNTIME)
6765 Perl_croak(aTHX_ PL_no_modify);
6769 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6771 i = PTR2IV(SvRV(sv));
6776 flags = SvFLAGS(sv);
6777 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6778 /* It's (privately or publicly) a float, but not tested as an
6779 integer, so test it to see. */
6781 flags = SvFLAGS(sv);
6783 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6784 /* It's publicly an integer, or privately an integer-not-float */
6785 #ifdef PERL_PRESERVE_IVUV
6789 if (SvUVX(sv) == UV_MAX)
6790 sv_setnv(sv, UV_MAX_P1);
6792 (void)SvIOK_only_UV(sv);
6793 SvUV_set(sv, SvUVX(sv) + 1);
6795 if (SvIVX(sv) == IV_MAX)
6796 sv_setuv(sv, (UV)IV_MAX + 1);
6798 (void)SvIOK_only(sv);
6799 SvIV_set(sv, SvIVX(sv) + 1);
6804 if (flags & SVp_NOK) {
6805 const NV was = SvNVX(sv);
6806 if (NV_OVERFLOWS_INTEGERS_AT &&
6807 was >= NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6808 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6809 "Lost precision when incrementing %" NVff " by 1",
6812 (void)SvNOK_only(sv);
6813 SvNV_set(sv, was + 1.0);
6817 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
6818 if ((flags & SVTYPEMASK) < SVt_PVIV)
6819 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV ? SVt_PVIV : SVt_IV));
6820 (void)SvIOK_only(sv);
6825 while (isALPHA(*d)) d++;
6826 while (isDIGIT(*d)) d++;
6828 #ifdef PERL_PRESERVE_IVUV
6829 /* Got to punt this as an integer if needs be, but we don't issue
6830 warnings. Probably ought to make the sv_iv_please() that does
6831 the conversion if possible, and silently. */
6832 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6833 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6834 /* Need to try really hard to see if it's an integer.
6835 9.22337203685478e+18 is an integer.
6836 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6837 so $a="9.22337203685478e+18"; $a+0; $a++
6838 needs to be the same as $a="9.22337203685478e+18"; $a++
6845 /* sv_2iv *should* have made this an NV */
6846 if (flags & SVp_NOK) {
6847 (void)SvNOK_only(sv);
6848 SvNV_set(sv, SvNVX(sv) + 1.0);
6851 /* I don't think we can get here. Maybe I should assert this
6852 And if we do get here I suspect that sv_setnv will croak. NWC
6854 #if defined(USE_LONG_DOUBLE)
6855 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",
6856 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6858 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
6859 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
6862 #endif /* PERL_PRESERVE_IVUV */
6863 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
6867 while (d >= SvPVX_const(sv)) {
6875 /* MKS: The original code here died if letters weren't consecutive.
6876 * at least it didn't have to worry about non-C locales. The
6877 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
6878 * arranged in order (although not consecutively) and that only
6879 * [A-Za-z] are accepted by isALPHA in the C locale.
6881 if (*d != 'z' && *d != 'Z') {
6882 do { ++*d; } while (!isALPHA(*d));
6885 *(d--) -= 'z' - 'a';
6890 *(d--) -= 'z' - 'a' + 1;
6894 /* oh,oh, the number grew */
6895 SvGROW(sv, SvCUR(sv) + 2);
6896 SvCUR_set(sv, SvCUR(sv) + 1);
6897 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
6908 Auto-decrement of the value in the SV, doing string to numeric conversion
6909 if necessary. Handles 'get' magic.
6915 Perl_sv_dec(pTHX_ register SV *sv)
6923 if (SvTHINKFIRST(sv)) {
6925 sv_force_normal_flags(sv, 0);
6926 if (SvREADONLY(sv)) {
6927 if (IN_PERL_RUNTIME)
6928 Perl_croak(aTHX_ PL_no_modify);
6932 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6934 i = PTR2IV(SvRV(sv));
6939 /* Unlike sv_inc we don't have to worry about string-never-numbers
6940 and keeping them magic. But we mustn't warn on punting */
6941 flags = SvFLAGS(sv);
6942 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6943 /* It's publicly an integer, or privately an integer-not-float */
6944 #ifdef PERL_PRESERVE_IVUV
6948 if (SvUVX(sv) == 0) {
6949 (void)SvIOK_only(sv);
6953 (void)SvIOK_only_UV(sv);
6954 SvUV_set(sv, SvUVX(sv) - 1);
6957 if (SvIVX(sv) == IV_MIN) {
6958 sv_setnv(sv, (NV)IV_MIN);
6962 (void)SvIOK_only(sv);
6963 SvIV_set(sv, SvIVX(sv) - 1);
6968 if (flags & SVp_NOK) {
6971 const NV was = SvNVX(sv);
6972 if (NV_OVERFLOWS_INTEGERS_AT &&
6973 was <= -NV_OVERFLOWS_INTEGERS_AT && ckWARN(WARN_IMPRECISION)) {
6974 Perl_warner(aTHX_ packWARN(WARN_IMPRECISION),
6975 "Lost precision when decrementing %" NVff " by 1",
6978 (void)SvNOK_only(sv);
6979 SvNV_set(sv, was - 1.0);
6983 if (!(flags & SVp_POK)) {
6984 if ((flags & SVTYPEMASK) < SVt_PVIV)
6985 sv_upgrade(sv, ((flags & SVTYPEMASK) > SVt_IV) ? SVt_PVIV : SVt_IV);
6987 (void)SvIOK_only(sv);
6990 #ifdef PERL_PRESERVE_IVUV
6992 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
6993 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6994 /* Need to try really hard to see if it's an integer.
6995 9.22337203685478e+18 is an integer.
6996 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6997 so $a="9.22337203685478e+18"; $a+0; $a--
6998 needs to be the same as $a="9.22337203685478e+18"; $a--
7005 /* sv_2iv *should* have made this an NV */
7006 if (flags & SVp_NOK) {
7007 (void)SvNOK_only(sv);
7008 SvNV_set(sv, SvNVX(sv) - 1.0);
7011 /* I don't think we can get here. Maybe I should assert this
7012 And if we do get here I suspect that sv_setnv will croak. NWC
7014 #if defined(USE_LONG_DOUBLE)
7015 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",
7016 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7018 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7019 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
7023 #endif /* PERL_PRESERVE_IVUV */
7024 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
7028 =for apidoc sv_mortalcopy
7030 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7031 The new SV is marked as mortal. It will be destroyed "soon", either by an
7032 explicit call to FREETMPS, or by an implicit call at places such as
7033 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7038 /* Make a string that will exist for the duration of the expression
7039 * evaluation. Actually, it may have to last longer than that, but
7040 * hopefully we won't free it until it has been assigned to a
7041 * permanent location. */
7044 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7050 sv_setsv(sv,oldstr);
7052 PL_tmps_stack[++PL_tmps_ix] = sv;
7058 =for apidoc sv_newmortal
7060 Creates a new null SV which is mortal. The reference count of the SV is
7061 set to 1. It will be destroyed "soon", either by an explicit call to
7062 FREETMPS, or by an implicit call at places such as statement boundaries.
7063 See also C<sv_mortalcopy> and C<sv_2mortal>.
7069 Perl_sv_newmortal(pTHX)
7075 SvFLAGS(sv) = SVs_TEMP;
7077 PL_tmps_stack[++PL_tmps_ix] = sv;
7083 =for apidoc newSVpvn_flags
7085 Creates a new SV and copies a string into it. The reference count for the
7086 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7087 string. You are responsible for ensuring that the source string is at least
7088 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7089 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
7090 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
7091 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
7092 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
7094 #define newSVpvn_utf8(s, len, u) \
7095 newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
7101 Perl_newSVpvn_flags(pTHX_ const char *s, STRLEN len, U32 flags)
7106 /* All the flags we don't support must be zero.
7107 And we're new code so I'm going to assert this from the start. */
7108 assert(!(flags & ~(SVf_UTF8|SVs_TEMP)));
7110 sv_setpvn(sv,s,len);
7111 SvFLAGS(sv) |= (flags & SVf_UTF8);
7112 return (flags & SVs_TEMP) ? sv_2mortal(sv) : sv;
7116 =for apidoc sv_2mortal
7118 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7119 by an explicit call to FREETMPS, or by an implicit call at places such as
7120 statement boundaries. SvTEMP() is turned on which means that the SV's
7121 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7122 and C<sv_mortalcopy>.
7128 Perl_sv_2mortal(pTHX_ register SV *sv)
7133 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7136 PL_tmps_stack[++PL_tmps_ix] = sv;
7144 Creates a new SV and copies a string into it. The reference count for the
7145 SV is set to 1. If C<len> is zero, Perl will compute the length using
7146 strlen(). For efficiency, consider using C<newSVpvn> instead.
7152 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7158 sv_setpvn(sv, s, len || s == NULL ? len : strlen(s));
7163 =for apidoc newSVpvn
7165 Creates a new SV and copies a string into it. The reference count for the
7166 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7167 string. You are responsible for ensuring that the source string is at least
7168 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7174 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7180 sv_setpvn(sv,s,len);
7185 =for apidoc newSVhek
7187 Creates a new SV from the hash key structure. It will generate scalars that
7188 point to the shared string table where possible. Returns a new (undefined)
7189 SV if the hek is NULL.
7195 Perl_newSVhek(pTHX_ const HEK *hek)
7205 if (HEK_LEN(hek) == HEf_SVKEY) {
7206 return newSVsv(*(SV**)HEK_KEY(hek));
7208 const int flags = HEK_FLAGS(hek);
7209 if (flags & HVhek_WASUTF8) {
7211 Andreas would like keys he put in as utf8 to come back as utf8
7213 STRLEN utf8_len = HEK_LEN(hek);
7214 const U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7215 SV * const sv = newSVpvn ((const char*)as_utf8, utf8_len);
7218 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7220 } else if (flags & (HVhek_REHASH|HVhek_UNSHARED)) {
7221 /* We don't have a pointer to the hv, so we have to replicate the
7222 flag into every HEK. This hv is using custom a hasing
7223 algorithm. Hence we can't return a shared string scalar, as
7224 that would contain the (wrong) hash value, and might get passed
7225 into an hv routine with a regular hash.
7226 Similarly, a hash that isn't using shared hash keys has to have
7227 the flag in every key so that we know not to try to call
7228 share_hek_kek on it. */
7230 SV * const sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7235 /* This will be overwhelminly the most common case. */
7237 /* Inline most of newSVpvn_share(), because share_hek_hek() is far
7238 more efficient than sharepvn(). */
7242 sv_upgrade(sv, SVt_PV);
7243 SvPV_set(sv, (char *)HEK_KEY(share_hek_hek(hek)));
7244 SvCUR_set(sv, HEK_LEN(hek));
7257 =for apidoc newSVpvn_share
7259 Creates a new SV with its SvPVX_const pointing to a shared string in the string
7260 table. If the string does not already exist in the table, it is created
7261 first. Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
7262 value is used; otherwise the hash is computed. The string's hash can be later
7263 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
7264 that as the string table is used for shared hash keys these strings will have
7265 SvPVX_const == HeKEY and hash lookup will avoid string compare.
7271 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7275 bool is_utf8 = FALSE;
7276 const char *const orig_src = src;
7279 STRLEN tmplen = -len;
7281 /* See the note in hv.c:hv_fetch() --jhi */
7282 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7286 PERL_HASH(hash, src, len);
7288 sv_upgrade(sv, SVt_PV);
7289 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7297 if (src != orig_src)
7303 #if defined(PERL_IMPLICIT_CONTEXT)
7305 /* pTHX_ magic can't cope with varargs, so this is a no-context
7306 * version of the main function, (which may itself be aliased to us).
7307 * Don't access this version directly.
7311 Perl_newSVpvf_nocontext(const char* pat, ...)
7316 va_start(args, pat);
7317 sv = vnewSVpvf(pat, &args);
7324 =for apidoc newSVpvf
7326 Creates a new SV and initializes it with the string formatted like
7333 Perl_newSVpvf(pTHX_ const char* pat, ...)
7337 va_start(args, pat);
7338 sv = vnewSVpvf(pat, &args);
7343 /* backend for newSVpvf() and newSVpvf_nocontext() */
7346 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7351 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
7358 Creates a new SV and copies a floating point value into it.
7359 The reference count for the SV is set to 1.
7365 Perl_newSVnv(pTHX_ NV n)
7378 Creates a new SV and copies an integer into it. The reference count for the
7385 Perl_newSViv(pTHX_ IV i)
7398 Creates a new SV and copies an unsigned integer into it.
7399 The reference count for the SV is set to 1.
7405 Perl_newSVuv(pTHX_ UV u)
7416 =for apidoc newSV_type
7418 Creates a new SV, of the type specified. The reference count for the new SV
7425 Perl_newSV_type(pTHX_ svtype type)
7430 sv_upgrade(sv, type);
7435 =for apidoc newRV_noinc
7437 Creates an RV wrapper for an SV. The reference count for the original
7438 SV is B<not> incremented.
7444 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7447 register SV *sv = newSV_type(SVt_IV);
7449 SvRV_set(sv, tmpRef);
7454 /* newRV_inc is the official function name to use now.
7455 * newRV_inc is in fact #defined to newRV in sv.h
7459 Perl_newRV(pTHX_ SV *sv)
7462 return newRV_noinc(SvREFCNT_inc_simple_NN(sv));
7468 Creates a new SV which is an exact duplicate of the original SV.
7475 Perl_newSVsv(pTHX_ register SV *old)
7482 if (SvTYPE(old) == SVTYPEMASK) {
7483 if (ckWARN_d(WARN_INTERNAL))
7484 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7488 /* SV_GMAGIC is the default for sv_setv()
7489 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7490 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7491 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7496 =for apidoc sv_reset
7498 Underlying implementation for the C<reset> Perl function.
7499 Note that the perl-level function is vaguely deprecated.
7505 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7508 char todo[PERL_UCHAR_MAX+1];
7513 if (!*s) { /* reset ?? searches */
7514 MAGIC * const mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7516 const U32 count = mg->mg_len / sizeof(PMOP**);
7517 PMOP **pmp = (PMOP**) mg->mg_ptr;
7518 PMOP *const *const end = pmp + count;
7522 SvREADONLY_off(PL_regex_pad[(*pmp)->op_pmoffset]);
7524 (*pmp)->op_pmflags &= ~PMf_USED;
7532 /* reset variables */
7534 if (!HvARRAY(stash))
7537 Zero(todo, 256, char);
7540 I32 i = (unsigned char)*s;
7544 max = (unsigned char)*s++;
7545 for ( ; i <= max; i++) {
7548 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7550 for (entry = HvARRAY(stash)[i];
7552 entry = HeNEXT(entry))
7557 if (!todo[(U8)*HeKEY(entry)])
7559 gv = (GV*)HeVAL(entry);
7562 if (SvTHINKFIRST(sv)) {
7563 if (!SvREADONLY(sv) && SvROK(sv))
7565 /* XXX Is this continue a bug? Why should THINKFIRST
7566 exempt us from resetting arrays and hashes? */
7570 if (SvTYPE(sv) >= SVt_PV) {
7572 if (SvPVX_const(sv) != NULL)
7580 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
7582 Perl_die(aTHX_ "Can't reset %%ENV on this system");
7585 # if defined(USE_ENVIRON_ARRAY)
7588 # endif /* USE_ENVIRON_ARRAY */
7599 Using various gambits, try to get an IO from an SV: the IO slot if its a
7600 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7601 named after the PV if we're a string.
7607 Perl_sv_2io(pTHX_ SV *sv)
7612 switch (SvTYPE(sv)) {
7620 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7624 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7626 return sv_2io(SvRV(sv));
7627 gv = gv_fetchsv(sv, 0, SVt_PVIO);
7633 Perl_croak(aTHX_ "Bad filehandle: %"SVf, SVfARG(sv));
7642 Using various gambits, try to get a CV from an SV; in addition, try if
7643 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7644 The flags in C<lref> are passed to sv_fetchsv.
7650 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7661 switch (SvTYPE(sv)) {
7680 SV * const *sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7681 tryAMAGICunDEREF(to_cv);
7684 if (SvTYPE(sv) == SVt_PVCV) {
7693 Perl_croak(aTHX_ "Not a subroutine reference");
7698 gv = gv_fetchsv(sv, lref, SVt_PVCV);
7704 /* Some flags to gv_fetchsv mean don't really create the GV */
7705 if (SvTYPE(gv) != SVt_PVGV) {
7711 if (lref && !GvCVu(gv)) {
7715 gv_efullname3(tmpsv, gv, NULL);
7716 /* XXX this is probably not what they think they're getting.
7717 * It has the same effect as "sub name;", i.e. just a forward
7719 newSUB(start_subparse(FALSE, 0),
7720 newSVOP(OP_CONST, 0, tmpsv),
7724 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7734 Returns true if the SV has a true value by Perl's rules.
7735 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7736 instead use an in-line version.
7742 Perl_sv_true(pTHX_ register SV *sv)
7747 register const XPV* const tXpv = (XPV*)SvANY(sv);
7749 (tXpv->xpv_cur > 1 ||
7750 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
7757 return SvIVX(sv) != 0;
7760 return SvNVX(sv) != 0.0;
7762 return sv_2bool(sv);
7768 =for apidoc sv_pvn_force
7770 Get a sensible string out of the SV somehow.
7771 A private implementation of the C<SvPV_force> macro for compilers which
7772 can't cope with complex macro expressions. Always use the macro instead.
7774 =for apidoc sv_pvn_force_flags
7776 Get a sensible string out of the SV somehow.
7777 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7778 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7779 implemented in terms of this function.
7780 You normally want to use the various wrapper macros instead: see
7781 C<SvPV_force> and C<SvPV_force_nomg>
7787 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7790 if (SvTHINKFIRST(sv) && !SvROK(sv))
7791 sv_force_normal_flags(sv, 0);
7801 if (SvREADONLY(sv) && !(flags & SV_MUTABLE_RETURN)) {
7802 const char * const ref = sv_reftype(sv,0);
7804 Perl_croak(aTHX_ "Can't coerce readonly %s to string in %s",
7805 ref, OP_NAME(PL_op));
7807 Perl_croak(aTHX_ "Can't coerce readonly %s to string", ref);
7809 if ((SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM)
7810 || isGV_with_GP(sv))
7811 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
7813 s = sv_2pv_flags(sv, &len, flags);
7817 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
7820 SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7821 SvGROW(sv, len + 1);
7822 Move(s,SvPVX(sv),len,char);
7824 SvPVX(sv)[len] = '\0';
7827 SvPOK_on(sv); /* validate pointer */
7829 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7830 PTR2UV(sv),SvPVX_const(sv)));
7833 return SvPVX_mutable(sv);
7837 =for apidoc sv_pvbyten_force
7839 The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
7845 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7847 sv_pvn_force(sv,lp);
7848 sv_utf8_downgrade(sv,0);
7854 =for apidoc sv_pvutf8n_force
7856 The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
7862 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7864 sv_pvn_force(sv,lp);
7865 sv_utf8_upgrade(sv);
7871 =for apidoc sv_reftype
7873 Returns a string describing what the SV is a reference to.
7879 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
7881 /* The fact that I don't need to downcast to char * everywhere, only in ?:
7882 inside return suggests a const propagation bug in g++. */
7883 if (ob && SvOBJECT(sv)) {
7884 char * const name = HvNAME_get(SvSTASH(sv));
7885 return name ? name : (char *) "__ANON__";
7888 switch (SvTYPE(sv)) {
7903 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
7904 /* tied lvalues should appear to be
7905 * scalars for backwards compatitbility */
7906 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
7907 ? "SCALAR" : "LVALUE");
7908 case SVt_PVAV: return "ARRAY";
7909 case SVt_PVHV: return "HASH";
7910 case SVt_PVCV: return "CODE";
7911 case SVt_PVGV: return "GLOB";
7912 case SVt_PVFM: return "FORMAT";
7913 case SVt_PVIO: return "IO";
7914 case SVt_BIND: return "BIND";
7915 case SVt_REGEXP: return "REGEXP";
7916 default: return "UNKNOWN";
7922 =for apidoc sv_isobject
7924 Returns a boolean indicating whether the SV is an RV pointing to a blessed
7925 object. If the SV is not an RV, or if the object is not blessed, then this
7932 Perl_sv_isobject(pTHX_ SV *sv)
7948 Returns a boolean indicating whether the SV is blessed into the specified
7949 class. This does not check for subtypes; use C<sv_derived_from> to verify
7950 an inheritance relationship.
7956 Perl_sv_isa(pTHX_ SV *sv, const char *name)
7967 hvname = HvNAME_get(SvSTASH(sv));
7971 return strEQ(hvname, name);
7977 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7978 it will be upgraded to one. If C<classname> is non-null then the new SV will
7979 be blessed in the specified package. The new SV is returned and its
7980 reference count is 1.
7986 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
7993 SV_CHECK_THINKFIRST_COW_DROP(rv);
7994 (void)SvAMAGIC_off(rv);
7996 if (SvTYPE(rv) >= SVt_PVMG) {
7997 const U32 refcnt = SvREFCNT(rv);
8001 SvREFCNT(rv) = refcnt;
8003 sv_upgrade(rv, SVt_IV);
8004 } else if (SvROK(rv)) {
8005 SvREFCNT_dec(SvRV(rv));
8007 prepare_SV_for_RV(rv);
8015 HV* const stash = gv_stashpv(classname, GV_ADD);
8016 (void)sv_bless(rv, stash);
8022 =for apidoc sv_setref_pv
8024 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8025 argument will be upgraded to an RV. That RV will be modified to point to
8026 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8027 into the SV. The C<classname> argument indicates the package for the
8028 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8029 will have a reference count of 1, and the RV will be returned.
8031 Do not use with other Perl types such as HV, AV, SV, CV, because those
8032 objects will become corrupted by the pointer copy process.
8034 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8040 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8044 sv_setsv(rv, &PL_sv_undef);
8048 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8053 =for apidoc sv_setref_iv
8055 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8056 argument will be upgraded to an RV. That RV will be modified to point to
8057 the new SV. The C<classname> argument indicates the package for the
8058 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8059 will have a reference count of 1, and the RV will be returned.
8065 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8067 sv_setiv(newSVrv(rv,classname), iv);
8072 =for apidoc sv_setref_uv
8074 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8075 argument will be upgraded to an RV. That RV will be modified to point to
8076 the new SV. The C<classname> argument indicates the package for the
8077 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8078 will have a reference count of 1, and the RV will be returned.
8084 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8086 sv_setuv(newSVrv(rv,classname), uv);
8091 =for apidoc sv_setref_nv
8093 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8094 argument will be upgraded to an RV. That RV will be modified to point to
8095 the new SV. The C<classname> argument indicates the package for the
8096 blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
8097 will have a reference count of 1, and the RV will be returned.
8103 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8105 sv_setnv(newSVrv(rv,classname), nv);
8110 =for apidoc sv_setref_pvn
8112 Copies a string into a new SV, optionally blessing the SV. The length of the
8113 string must be specified with C<n>. The C<rv> argument will be upgraded to
8114 an RV. That RV will be modified to point to the new SV. The C<classname>
8115 argument indicates the package for the blessing. Set C<classname> to
8116 C<NULL> to avoid the blessing. The new SV will have a reference count
8117 of 1, and the RV will be returned.
8119 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8125 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, const char *pv, STRLEN n)
8127 sv_setpvn(newSVrv(rv,classname), pv, n);
8132 =for apidoc sv_bless
8134 Blesses an SV into a specified package. The SV must be an RV. The package
8135 must be designated by its stash (see C<gv_stashpv()>). The reference count
8136 of the SV is unaffected.
8142 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8147 Perl_croak(aTHX_ "Can't bless non-reference value");
8149 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8150 if (SvIsCOW(tmpRef))
8151 sv_force_normal_flags(tmpRef, 0);
8152 if (SvREADONLY(tmpRef))
8153 Perl_croak(aTHX_ PL_no_modify);
8154 if (SvOBJECT(tmpRef)) {
8155 if (SvTYPE(tmpRef) != SVt_PVIO)
8157 SvREFCNT_dec(SvSTASH(tmpRef));
8160 SvOBJECT_on(tmpRef);
8161 if (SvTYPE(tmpRef) != SVt_PVIO)
8163 SvUPGRADE(tmpRef, SVt_PVMG);
8164 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc_simple(stash));
8169 (void)SvAMAGIC_off(sv);
8171 if(SvSMAGICAL(tmpRef))
8172 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8180 /* Downgrades a PVGV to a PVMG.
8184 S_sv_unglob(pTHX_ SV *sv)
8189 SV * const temp = sv_newmortal();
8191 assert(SvTYPE(sv) == SVt_PVGV);
8193 gv_efullname3(temp, (GV *) sv, "*");
8196 if(GvCVu((GV*)sv) && (stash = GvSTASH((GV*)sv)) && HvNAME_get(stash))
8197 mro_method_changed_in(stash);
8201 sv_del_backref((SV*)GvSTASH(sv), sv);
8205 if (GvNAME_HEK(sv)) {
8206 unshare_hek(GvNAME_HEK(sv));
8208 isGV_with_GP_off(sv);
8210 /* need to keep SvANY(sv) in the right arena */
8211 xpvmg = new_XPVMG();
8212 StructCopy(SvANY(sv), xpvmg, XPVMG);
8213 del_XPVGV(SvANY(sv));
8216 SvFLAGS(sv) &= ~SVTYPEMASK;
8217 SvFLAGS(sv) |= SVt_PVMG;
8219 /* Intentionally not calling any local SET magic, as this isn't so much a
8220 set operation as merely an internal storage change. */
8221 sv_setsv_flags(sv, temp, 0);
8225 =for apidoc sv_unref_flags
8227 Unsets the RV status of the SV, and decrements the reference count of
8228 whatever was being referenced by the RV. This can almost be thought of
8229 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8230 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8231 (otherwise the decrementing is conditional on the reference count being
8232 different from one or the reference being a readonly SV).
8239 Perl_sv_unref_flags(pTHX_ SV *ref, U32 flags)
8241 SV* const target = SvRV(ref);
8243 if (SvWEAKREF(ref)) {
8244 sv_del_backref(target, ref);
8246 SvRV_set(ref, NULL);
8249 SvRV_set(ref, NULL);
8251 /* You can't have a || SvREADONLY(target) here, as $a = $$a, where $a was
8252 assigned to as BEGIN {$a = \"Foo"} will fail. */
8253 if (SvREFCNT(target) != 1 || (flags & SV_IMMEDIATE_UNREF))
8254 SvREFCNT_dec(target);
8255 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8256 sv_2mortal(target); /* Schedule for freeing later */
8260 =for apidoc sv_untaint
8262 Untaint an SV. Use C<SvTAINTED_off> instead.
8267 Perl_sv_untaint(pTHX_ SV *sv)
8269 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8270 MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8277 =for apidoc sv_tainted
8279 Test an SV for taintedness. Use C<SvTAINTED> instead.
8284 Perl_sv_tainted(pTHX_ SV *sv)
8286 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8287 const MAGIC * const mg = mg_find(sv, PERL_MAGIC_taint);
8288 if (mg && (mg->mg_len & 1) )
8295 =for apidoc sv_setpviv
8297 Copies an integer into the given SV, also updating its string value.
8298 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8304 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8306 char buf[TYPE_CHARS(UV)];
8308 char * const ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8310 sv_setpvn(sv, ptr, ebuf - ptr);
8314 =for apidoc sv_setpviv_mg
8316 Like C<sv_setpviv>, but also handles 'set' magic.
8322 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8328 #if defined(PERL_IMPLICIT_CONTEXT)
8330 /* pTHX_ magic can't cope with varargs, so this is a no-context
8331 * version of the main function, (which may itself be aliased to us).
8332 * Don't access this version directly.
8336 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8340 va_start(args, pat);
8341 sv_vsetpvf(sv, pat, &args);
8345 /* pTHX_ magic can't cope with varargs, so this is a no-context
8346 * version of the main function, (which may itself be aliased to us).
8347 * Don't access this version directly.
8351 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8355 va_start(args, pat);
8356 sv_vsetpvf_mg(sv, pat, &args);
8362 =for apidoc sv_setpvf
8364 Works like C<sv_catpvf> but copies the text into the SV instead of
8365 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8371 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8374 va_start(args, pat);
8375 sv_vsetpvf(sv, pat, &args);
8380 =for apidoc sv_vsetpvf
8382 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8383 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8385 Usually used via its frontend C<sv_setpvf>.
8391 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8393 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8397 =for apidoc sv_setpvf_mg
8399 Like C<sv_setpvf>, but also handles 'set' magic.
8405 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8408 va_start(args, pat);
8409 sv_vsetpvf_mg(sv, pat, &args);
8414 =for apidoc sv_vsetpvf_mg
8416 Like C<sv_vsetpvf>, but also handles 'set' magic.
8418 Usually used via its frontend C<sv_setpvf_mg>.
8424 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8426 sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8430 #if defined(PERL_IMPLICIT_CONTEXT)
8432 /* pTHX_ magic can't cope with varargs, so this is a no-context
8433 * version of the main function, (which may itself be aliased to us).
8434 * Don't access this version directly.
8438 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8442 va_start(args, pat);
8443 sv_vcatpvf(sv, pat, &args);
8447 /* pTHX_ magic can't cope with varargs, so this is a no-context
8448 * version of the main function, (which may itself be aliased to us).
8449 * Don't access this version directly.
8453 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8457 va_start(args, pat);
8458 sv_vcatpvf_mg(sv, pat, &args);
8464 =for apidoc sv_catpvf
8466 Processes its arguments like C<sprintf> and appends the formatted
8467 output to an SV. If the appended data contains "wide" characters
8468 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8469 and characters >255 formatted with %c), the original SV might get
8470 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8471 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8472 valid UTF-8; if the original SV was bytes, the pattern should be too.
8477 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8480 va_start(args, pat);
8481 sv_vcatpvf(sv, pat, &args);
8486 =for apidoc sv_vcatpvf
8488 Processes its arguments like C<vsprintf> and appends the formatted output
8489 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8491 Usually used via its frontend C<sv_catpvf>.
8497 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8499 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8503 =for apidoc sv_catpvf_mg
8505 Like C<sv_catpvf>, but also handles 'set' magic.
8511 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8514 va_start(args, pat);
8515 sv_vcatpvf_mg(sv, pat, &args);
8520 =for apidoc sv_vcatpvf_mg
8522 Like C<sv_vcatpvf>, but also handles 'set' magic.
8524 Usually used via its frontend C<sv_catpvf_mg>.
8530 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8532 sv_vcatpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
8537 =for apidoc sv_vsetpvfn
8539 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
8542 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
8548 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8550 sv_setpvn(sv, "", 0);
8551 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
8555 S_expect_number(pTHX_ char** pattern)
8559 switch (**pattern) {
8560 case '1': case '2': case '3':
8561 case '4': case '5': case '6':
8562 case '7': case '8': case '9':
8563 var = *(*pattern)++ - '0';
8564 while (isDIGIT(**pattern)) {
8565 const I32 tmp = var * 10 + (*(*pattern)++ - '0');
8567 Perl_croak(aTHX_ "Integer overflow in format string for %s", (PL_op ? OP_NAME(PL_op) : "sv_vcatpvfn"));
8575 S_F0convert(NV nv, char *endbuf, STRLEN *len)
8577 const int neg = nv < 0;
8586 if (uv & 1 && uv == nv)
8587 uv--; /* Round to even */
8589 const unsigned dig = uv % 10;
8602 =for apidoc sv_vcatpvfn
8604 Processes its arguments like C<vsprintf> and appends the formatted output
8605 to an SV. Uses an array of SVs if the C style variable argument list is
8606 missing (NULL). When running with taint checks enabled, indicates via
8607 C<maybe_tainted> if results are untrustworthy (often due to the use of
8610 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
8616 #define VECTORIZE_ARGS vecsv = va_arg(*args, SV*);\
8617 vecstr = (U8*)SvPV_const(vecsv,veclen);\
8618 vec_utf8 = DO_UTF8(vecsv);
8620 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
8623 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
8631 static const char nullstr[] = "(null)";
8633 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
8634 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
8636 /* Times 4: a decimal digit takes more than 3 binary digits.
8637 * NV_DIG: mantissa takes than many decimal digits.
8638 * Plus 32: Playing safe. */
8639 char ebuf[IV_DIG * 4 + NV_DIG + 32];
8640 /* large enough for "%#.#f" --chip */
8641 /* what about long double NVs? --jhi */
8643 PERL_UNUSED_ARG(maybe_tainted);
8645 /* no matter what, this is a string now */
8646 (void)SvPV_force(sv, origlen);
8648 /* special-case "", "%s", and "%-p" (SVf - see below) */
8651 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
8653 const char * const s = va_arg(*args, char*);
8654 sv_catpv(sv, s ? s : nullstr);
8656 else if (svix < svmax) {
8657 sv_catsv(sv, *svargs);
8661 if (args && patlen == 3 && pat[0] == '%' &&
8662 pat[1] == '-' && pat[2] == 'p') {
8663 argsv = (SV*)va_arg(*args, void*);
8664 sv_catsv(sv, argsv);
8668 #ifndef USE_LONG_DOUBLE
8669 /* special-case "%.<number>[gf]" */
8670 if ( !args && patlen <= 5 && pat[0] == '%' && pat[1] == '.'
8671 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
8672 unsigned digits = 0;
8676 while (*pp >= '0' && *pp <= '9')
8677 digits = 10 * digits + (*pp++ - '0');
8678 if (pp - pat == (int)patlen - 1) {
8686 /* Add check for digits != 0 because it seems that some
8687 gconverts are buggy in this case, and we don't yet have
8688 a Configure test for this. */
8689 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
8690 /* 0, point, slack */
8691 Gconvert(nv, (int)digits, 0, ebuf);
8693 if (*ebuf) /* May return an empty string for digits==0 */
8696 } else if (!digits) {
8699 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
8700 sv_catpvn(sv, p, l);
8706 #endif /* !USE_LONG_DOUBLE */
8708 if (!args && svix < svmax && DO_UTF8(*svargs))
8711 patend = (char*)pat + patlen;
8712 for (p = (char*)pat; p < patend; p = q) {
8715 bool vectorize = FALSE;
8716 bool vectorarg = FALSE;
8717 bool vec_utf8 = FALSE;
8723 bool has_precis = FALSE;
8725 const I32 osvix = svix;
8726 bool is_utf8 = FALSE; /* is this item utf8? */
8727 #ifdef HAS_LDBL_SPRINTF_BUG
8728 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
8729 with sfio - Allen <allens@cpan.org> */
8730 bool fix_ldbl_sprintf_bug = FALSE;
8734 U8 utf8buf[UTF8_MAXBYTES+1];
8735 STRLEN esignlen = 0;
8737 const char *eptr = NULL;
8740 const U8 *vecstr = NULL;
8747 /* we need a long double target in case HAS_LONG_DOUBLE but
8750 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
8758 const char *dotstr = ".";
8759 STRLEN dotstrlen = 1;
8760 I32 efix = 0; /* explicit format parameter index */
8761 I32 ewix = 0; /* explicit width index */
8762 I32 epix = 0; /* explicit precision index */
8763 I32 evix = 0; /* explicit vector index */
8764 bool asterisk = FALSE;
8766 /* echo everything up to the next format specification */
8767 for (q = p; q < patend && *q != '%'; ++q) ;
8769 if (has_utf8 && !pat_utf8)
8770 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
8772 sv_catpvn(sv, p, q - p);
8779 We allow format specification elements in this order:
8780 \d+\$ explicit format parameter index
8782 v|\*(\d+\$)?v vector with optional (optionally specified) arg
8783 0 flag (as above): repeated to allow "v02"
8784 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8785 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8787 [%bcdefginopsuxDFOUX] format (mandatory)
8792 As of perl5.9.3, printf format checking is on by default.
8793 Internally, perl uses %p formats to provide an escape to
8794 some extended formatting. This block deals with those
8795 extensions: if it does not match, (char*)q is reset and
8796 the normal format processing code is used.
8798 Currently defined extensions are:
8799 %p include pointer address (standard)
8800 %-p (SVf) include an SV (previously %_)
8801 %-<num>p include an SV with precision <num>
8802 %<num>p reserved for future extensions
8804 Robin Barker 2005-07-14
8806 %1p (VDf) removed. RMB 2007-10-19
8813 n = expect_number(&q);
8820 argsv = (SV*)va_arg(*args, void*);
8821 eptr = SvPV_const(argsv, elen);
8827 if (ckWARN_d(WARN_INTERNAL))
8828 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8829 "internal %%<num>p might conflict with future printf extensions");
8835 if ( (width = expect_number(&q)) ) {
8850 if (plus == '+' && *q == ' ') /* '+' over ' ' */
8879 if ( (ewix = expect_number(&q)) )
8888 if ((vectorarg = asterisk)) {
8901 width = expect_number(&q);
8907 vecsv = va_arg(*args, SV*);
8909 vecsv = (evix > 0 && evix <= svmax)
8910 ? svargs[evix-1] : &PL_sv_undef;
8912 vecsv = svix < svmax ? svargs[svix++] : &PL_sv_undef;
8914 dotstr = SvPV_const(vecsv, dotstrlen);
8915 /* Keep the DO_UTF8 test *after* the SvPV call, else things go
8916 bad with tied or overloaded values that return UTF8. */
8919 else if (has_utf8) {
8920 vecsv = sv_mortalcopy(vecsv);
8921 sv_utf8_upgrade(vecsv);
8922 dotstr = SvPV_const(vecsv, dotstrlen);
8929 else if (efix ? (efix > 0 && efix <= svmax) : svix < svmax) {
8930 vecsv = svargs[efix ? efix-1 : svix++];
8931 vecstr = (U8*)SvPV_const(vecsv,veclen);
8932 vec_utf8 = DO_UTF8(vecsv);
8934 /* if this is a version object, we need to convert
8935 * back into v-string notation and then let the
8936 * vectorize happen normally
8938 if (sv_derived_from(vecsv, "version")) {
8939 char *version = savesvpv(vecsv);
8940 if ( hv_exists((HV*)SvRV(vecsv), "alpha", 5 ) ) {
8941 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
8942 "vector argument not supported with alpha versions");
8945 vecsv = sv_newmortal();
8946 scan_vstring(version, version + veclen, vecsv);
8947 vecstr = (U8*)SvPV_const(vecsv, veclen);
8948 vec_utf8 = DO_UTF8(vecsv);
8960 i = va_arg(*args, int);
8962 i = (ewix ? ewix <= svmax : svix < svmax) ?
8963 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8965 width = (i < 0) ? -i : i;
8975 if ( ((epix = expect_number(&q))) && (*q++ != '$') )
8977 /* XXX: todo, support specified precision parameter */
8981 i = va_arg(*args, int);
8983 i = (ewix ? ewix <= svmax : svix < svmax)
8984 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
8986 has_precis = !(i < 0);
8991 precis = precis * 10 + (*q++ - '0');
9000 case 'I': /* Ix, I32x, and I64x */
9002 if (q[1] == '6' && q[2] == '4') {
9008 if (q[1] == '3' && q[2] == '2') {
9018 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9029 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9030 if (*(q + 1) == 'l') { /* lld, llf */
9056 if (!vectorize && !args) {
9058 const I32 i = efix-1;
9059 argsv = (i >= 0 && i < svmax) ? svargs[i] : &PL_sv_undef;
9061 argsv = (svix >= 0 && svix < svmax)
9062 ? svargs[svix++] : &PL_sv_undef;
9073 uv = (args) ? va_arg(*args, int) : SvIV(argsv);
9075 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9077 eptr = (char*)utf8buf;
9078 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9092 eptr = va_arg(*args, char*);
9094 #ifdef MACOS_TRADITIONAL
9095 /* On MacOS, %#s format is used for Pascal strings */
9100 elen = strlen(eptr);
9102 eptr = (char *)nullstr;
9103 elen = sizeof nullstr - 1;
9107 eptr = SvPV_const(argsv, elen);
9108 if (DO_UTF8(argsv)) {
9109 I32 old_precis = precis;
9110 if (has_precis && precis < elen) {
9112 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9115 if (width) { /* fudge width (can't fudge elen) */
9116 if (has_precis && precis < elen)
9117 width += precis - old_precis;
9119 width += elen - sv_len_utf8(argsv);
9126 if (has_precis && elen > precis)
9133 if (alt || vectorize)
9135 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9156 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9165 esignbuf[esignlen++] = plus;
9169 case 'h': iv = (short)va_arg(*args, int); break;
9170 case 'l': iv = va_arg(*args, long); break;
9171 case 'V': iv = va_arg(*args, IV); break;
9172 default: iv = va_arg(*args, int); break;
9174 case 'q': iv = va_arg(*args, Quad_t); break;
9179 IV tiv = SvIV(argsv); /* work around GCC bug #13488 */
9181 case 'h': iv = (short)tiv; break;
9182 case 'l': iv = (long)tiv; break;
9184 default: iv = tiv; break;
9186 case 'q': iv = (Quad_t)tiv; break;
9190 if ( !vectorize ) /* we already set uv above */
9195 esignbuf[esignlen++] = plus;
9199 esignbuf[esignlen++] = '-';
9243 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9254 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9255 case 'l': uv = va_arg(*args, unsigned long); break;
9256 case 'V': uv = va_arg(*args, UV); break;
9257 default: uv = va_arg(*args, unsigned); break;
9259 case 'q': uv = va_arg(*args, Uquad_t); break;
9264 UV tuv = SvUV(argsv); /* work around GCC bug #13488 */
9266 case 'h': uv = (unsigned short)tuv; break;
9267 case 'l': uv = (unsigned long)tuv; break;
9269 default: uv = tuv; break;
9271 case 'q': uv = (Uquad_t)tuv; break;
9278 char *ptr = ebuf + sizeof ebuf;
9279 bool tempalt = uv ? alt : FALSE; /* Vectors can't change alt */
9285 p = (char *)((c == 'X') ? PL_hexdigit + 16 : PL_hexdigit);
9291 esignbuf[esignlen++] = '0';
9292 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9300 if (alt && *ptr != '0')
9309 esignbuf[esignlen++] = '0';
9310 esignbuf[esignlen++] = c;
9313 default: /* it had better be ten or less */
9317 } while (uv /= base);
9320 elen = (ebuf + sizeof ebuf) - ptr;
9324 zeros = precis - elen;
9325 else if (precis == 0 && elen == 1 && *eptr == '0'
9326 && !(base == 8 && alt)) /* "%#.0o" prints "0" */
9329 /* a precision nullifies the 0 flag. */
9336 /* FLOATING POINT */
9339 c = 'f'; /* maybe %F isn't supported here */
9347 /* This is evil, but floating point is even more evil */
9349 /* for SV-style calling, we can only get NV
9350 for C-style calling, we assume %f is double;
9351 for simplicity we allow any of %Lf, %llf, %qf for long double
9355 #if defined(USE_LONG_DOUBLE)
9359 /* [perl #20339] - we should accept and ignore %lf rather than die */
9363 #if defined(USE_LONG_DOUBLE)
9364 intsize = args ? 0 : 'q';
9368 #if defined(HAS_LONG_DOUBLE)
9377 /* now we need (long double) if intsize == 'q', else (double) */
9379 #if LONG_DOUBLESIZE > DOUBLESIZE
9381 va_arg(*args, long double) :
9382 va_arg(*args, double)
9384 va_arg(*args, double)
9389 /* nv * 0 will be NaN for NaN, +Inf and -Inf, and 0 for anything
9390 else. frexp() has some unspecified behaviour for those three */
9391 if (c != 'e' && c != 'E' && (nv * 0) == 0) {
9393 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9394 will cast our (long double) to (double) */
9395 (void)Perl_frexp(nv, &i);
9396 if (i == PERL_INT_MIN)
9397 Perl_die(aTHX_ "panic: frexp");
9399 need = BIT_DIGITS(i);
9401 need += has_precis ? precis : 6; /* known default */
9406 #ifdef HAS_LDBL_SPRINTF_BUG
9407 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9408 with sfio - Allen <allens@cpan.org> */
9411 # define MY_DBL_MAX DBL_MAX
9412 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9413 # if DOUBLESIZE >= 8
9414 # define MY_DBL_MAX 1.7976931348623157E+308L
9416 # define MY_DBL_MAX 3.40282347E+38L
9420 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9421 # define MY_DBL_MAX_BUG 1L
9423 # define MY_DBL_MAX_BUG MY_DBL_MAX
9427 # define MY_DBL_MIN DBL_MIN
9428 # else /* XXX guessing! -Allen */
9429 # if DOUBLESIZE >= 8
9430 # define MY_DBL_MIN 2.2250738585072014E-308L
9432 # define MY_DBL_MIN 1.17549435E-38L
9436 if ((intsize == 'q') && (c == 'f') &&
9437 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9439 /* it's going to be short enough that
9440 * long double precision is not needed */
9442 if ((nv <= 0L) && (nv >= -0L))
9443 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9445 /* would use Perl_fp_class as a double-check but not
9446 * functional on IRIX - see perl.h comments */
9448 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9449 /* It's within the range that a double can represent */
9450 #if defined(DBL_MAX) && !defined(DBL_MIN)
9451 if ((nv >= ((long double)1/DBL_MAX)) ||
9452 (nv <= (-(long double)1/DBL_MAX)))
9454 fix_ldbl_sprintf_bug = TRUE;
9457 if (fix_ldbl_sprintf_bug == TRUE) {
9467 # undef MY_DBL_MAX_BUG
9470 #endif /* HAS_LDBL_SPRINTF_BUG */
9472 need += 20; /* fudge factor */
9473 if (PL_efloatsize < need) {
9474 Safefree(PL_efloatbuf);
9475 PL_efloatsize = need + 20; /* more fudge */
9476 Newx(PL_efloatbuf, PL_efloatsize, char);
9477 PL_efloatbuf[0] = '\0';
9480 if ( !(width || left || plus || alt) && fill != '0'
9481 && has_precis && intsize != 'q' ) { /* Shortcuts */
9482 /* See earlier comment about buggy Gconvert when digits,
9484 if ( c == 'g' && precis) {
9485 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9486 /* May return an empty string for digits==0 */
9487 if (*PL_efloatbuf) {
9488 elen = strlen(PL_efloatbuf);
9489 goto float_converted;
9491 } else if ( c == 'f' && !precis) {
9492 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9497 char *ptr = ebuf + sizeof ebuf;
9500 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9501 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9502 if (intsize == 'q') {
9503 /* Copy the one or more characters in a long double
9504 * format before the 'base' ([efgEFG]) character to
9505 * the format string. */
9506 static char const prifldbl[] = PERL_PRIfldbl;
9507 char const *p = prifldbl + sizeof(prifldbl) - 3;
9508 while (p >= prifldbl) { *--ptr = *p--; }
9513 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9518 do { *--ptr = '0' + (base % 10); } while (base /= 10);
9530 /* No taint. Otherwise we are in the strange situation
9531 * where printf() taints but print($float) doesn't.
9533 #if defined(HAS_LONG_DOUBLE)
9534 elen = ((intsize == 'q')
9535 ? my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, nv)
9536 : my_snprintf(PL_efloatbuf, PL_efloatsize, ptr, (double)nv));
9538 elen = my_sprintf(PL_efloatbuf, ptr, nv);
9542 eptr = PL_efloatbuf;
9550 i = SvCUR(sv) - origlen;
9553 case 'h': *(va_arg(*args, short*)) = i; break;
9554 default: *(va_arg(*args, int*)) = i; break;
9555 case 'l': *(va_arg(*args, long*)) = i; break;
9556 case 'V': *(va_arg(*args, IV*)) = i; break;
9558 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9563 sv_setuv_mg(argsv, (UV)i);
9564 continue; /* not "break" */
9571 && (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)
9572 && ckWARN(WARN_PRINTF))
9574 SV * const msg = sv_newmortal();
9575 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9576 (PL_op->op_type == OP_PRTF) ? "" : "s");
9579 Perl_sv_catpvf(aTHX_ msg,
9580 "\"%%%c\"", c & 0xFF);
9582 Perl_sv_catpvf(aTHX_ msg,
9583 "\"%%\\%03"UVof"\"",
9586 sv_catpvs(msg, "end of string");
9587 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, SVfARG(msg)); /* yes, this is reentrant */
9590 /* output mangled stuff ... */
9596 /* ... right here, because formatting flags should not apply */
9597 SvGROW(sv, SvCUR(sv) + elen + 1);
9599 Copy(eptr, p, elen, char);
9602 SvCUR_set(sv, p - SvPVX_const(sv));
9604 continue; /* not "break" */
9607 if (is_utf8 != has_utf8) {
9610 sv_utf8_upgrade(sv);
9613 const STRLEN old_elen = elen;
9614 SV * const nsv = newSVpvn_flags(eptr, elen, SVs_TEMP);
9615 sv_utf8_upgrade(nsv);
9616 eptr = SvPVX_const(nsv);
9619 if (width) { /* fudge width (can't fudge elen) */
9620 width += elen - old_elen;
9626 have = esignlen + zeros + elen;
9628 Perl_croak_nocontext(PL_memory_wrap);
9630 need = (have > width ? have : width);
9633 if (need >= (((STRLEN)~0) - SvCUR(sv) - dotstrlen - 1))
9634 Perl_croak_nocontext(PL_memory_wrap);
9635 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
9637 if (esignlen && fill == '0') {
9639 for (i = 0; i < (int)esignlen; i++)
9643 memset(p, fill, gap);
9646 if (esignlen && fill != '0') {
9648 for (i = 0; i < (int)esignlen; i++)
9653 for (i = zeros; i; i--)
9657 Copy(eptr, p, elen, char);
9661 memset(p, ' ', gap);
9666 Copy(dotstr, p, dotstrlen, char);
9670 vectorize = FALSE; /* done iterating over vecstr */
9677 SvCUR_set(sv, p - SvPVX_const(sv));
9685 /* =========================================================================
9687 =head1 Cloning an interpreter
9689 All the macros and functions in this section are for the private use of
9690 the main function, perl_clone().
9692 The foo_dup() functions make an exact copy of an existing foo thingy.
9693 During the course of a cloning, a hash table is used to map old addresses
9694 to new addresses. The table is created and manipulated with the
9695 ptr_table_* functions.
9699 ============================================================================*/
9702 #if defined(USE_ITHREADS)
9704 /* XXX Remove this so it doesn't have to go thru the macro and return for nothing */
9705 #ifndef GpREFCNT_inc
9706 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9710 /* Certain cases in Perl_ss_dup have been merged, by relying on the fact
9711 that currently av_dup, gv_dup and hv_dup are the same as sv_dup.
9712 If this changes, please unmerge ss_dup. */
9713 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9714 #define sv_dup_inc_NN(s,t) SvREFCNT_inc_NN(sv_dup(s,t))
9715 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9716 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9717 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9718 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9719 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9720 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9721 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9722 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9723 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9724 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9725 #define SAVEPV(p) ((p) ? savepv(p) : NULL)
9726 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
9728 /* clone a parser */
9731 Perl_parser_dup(pTHX_ const yy_parser *proto, CLONE_PARAMS* param)
9738 /* look for it in the table first */
9739 parser = (yy_parser *)ptr_table_fetch(PL_ptr_table, proto);
9743 /* create anew and remember what it is */
9744 Newxz(parser, 1, yy_parser);
9745 ptr_table_store(PL_ptr_table, proto, parser);
9747 parser->yyerrstatus = 0;
9748 parser->yychar = YYEMPTY; /* Cause a token to be read. */
9750 /* XXX these not yet duped */
9751 parser->old_parser = NULL;
9752 parser->stack = NULL;
9754 parser->stack_size = 0;
9755 /* XXX parser->stack->state = 0; */
9757 /* XXX eventually, just Copy() most of the parser struct ? */
9759 parser->lex_brackets = proto->lex_brackets;
9760 parser->lex_casemods = proto->lex_casemods;
9761 parser->lex_brackstack = savepvn(proto->lex_brackstack,
9762 (proto->lex_brackets < 120 ? 120 : proto->lex_brackets));
9763 parser->lex_casestack = savepvn(proto->lex_casestack,
9764 (proto->lex_casemods < 12 ? 12 : proto->lex_casemods));
9765 parser->lex_defer = proto->lex_defer;
9766 parser->lex_dojoin = proto->lex_dojoin;
9767 parser->lex_expect = proto->lex_expect;
9768 parser->lex_formbrack = proto->lex_formbrack;
9769 parser->lex_inpat = proto->lex_inpat;
9770 parser->lex_inwhat = proto->lex_inwhat;
9771 parser->lex_op = proto->lex_op;
9772 parser->lex_repl = sv_dup_inc(proto->lex_repl, param);
9773 parser->lex_starts = proto->lex_starts;
9774 parser->lex_stuff = sv_dup_inc(proto->lex_stuff, param);
9775 parser->multi_close = proto->multi_close;
9776 parser->multi_open = proto->multi_open;
9777 parser->multi_start = proto->multi_start;
9778 parser->multi_end = proto->multi_end;
9779 parser->pending_ident = proto->pending_ident;
9780 parser->preambled = proto->preambled;
9781 parser->sublex_info = proto->sublex_info; /* XXX not quite right */
9782 parser->linestr = sv_dup_inc(proto->linestr, param);
9783 parser->expect = proto->expect;
9784 parser->copline = proto->copline;
9785 parser->last_lop_op = proto->last_lop_op;
9786 parser->lex_state = proto->lex_state;
9787 parser->rsfp = fp_dup(proto->rsfp, '<', param);
9788 /* rsfp_filters entries have fake IoDIRP() */
9789 parser->rsfp_filters= av_dup_inc(proto->rsfp_filters, param);
9790 parser->in_my = proto->in_my;
9791 parser->in_my_stash = hv_dup(proto->in_my_stash, param);
9792 parser->error_count = proto->error_count;
9795 parser->linestr = sv_dup_inc(proto->linestr, param);
9798 char * const ols = SvPVX(proto->linestr);
9799 char * const ls = SvPVX(parser->linestr);
9801 parser->bufptr = ls + (proto->bufptr >= ols ?
9802 proto->bufptr - ols : 0);
9803 parser->oldbufptr = ls + (proto->oldbufptr >= ols ?
9804 proto->oldbufptr - ols : 0);
9805 parser->oldoldbufptr= ls + (proto->oldoldbufptr >= ols ?
9806 proto->oldoldbufptr - ols : 0);
9807 parser->linestart = ls + (proto->linestart >= ols ?
9808 proto->linestart - ols : 0);
9809 parser->last_uni = ls + (proto->last_uni >= ols ?
9810 proto->last_uni - ols : 0);
9811 parser->last_lop = ls + (proto->last_lop >= ols ?
9812 proto->last_lop - ols : 0);
9814 parser->bufend = ls + SvCUR(parser->linestr);
9817 Copy(proto->tokenbuf, parser->tokenbuf, 256, char);
9821 parser->endwhite = proto->endwhite;
9822 parser->faketokens = proto->faketokens;
9823 parser->lasttoke = proto->lasttoke;
9824 parser->nextwhite = proto->nextwhite;
9825 parser->realtokenstart = proto->realtokenstart;
9826 parser->skipwhite = proto->skipwhite;
9827 parser->thisclose = proto->thisclose;
9828 parser->thismad = proto->thismad;
9829 parser->thisopen = proto->thisopen;
9830 parser->thisstuff = proto->thisstuff;
9831 parser->thistoken = proto->thistoken;
9832 parser->thiswhite = proto->thiswhite;
9834 Copy(proto->nexttoke, parser->nexttoke, 5, NEXTTOKE);
9835 parser->curforce = proto->curforce;
9837 Copy(proto->nextval, parser->nextval, 5, YYSTYPE);
9838 Copy(proto->nexttype, parser->nexttype, 5, I32);
9839 parser->nexttoke = proto->nexttoke;
9845 /* duplicate a file handle */
9848 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
9852 PERL_UNUSED_ARG(type);
9855 return (PerlIO*)NULL;
9857 /* look for it in the table first */
9858 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9862 /* create anew and remember what it is */
9863 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
9864 ptr_table_store(PL_ptr_table, fp, ret);
9868 /* duplicate a directory handle */
9871 Perl_dirp_dup(pTHX_ DIR *dp)
9873 PERL_UNUSED_CONTEXT;
9880 /* duplicate a typeglob */
9883 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
9889 /* look for it in the table first */
9890 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9894 /* create anew and remember what it is */
9896 ptr_table_store(PL_ptr_table, gp, ret);
9899 ret->gp_refcnt = 0; /* must be before any other dups! */
9900 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9901 ret->gp_io = io_dup_inc(gp->gp_io, param);
9902 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9903 ret->gp_av = av_dup_inc(gp->gp_av, param);
9904 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9905 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9906 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
9907 ret->gp_cvgen = gp->gp_cvgen;
9908 ret->gp_line = gp->gp_line;
9909 ret->gp_file_hek = hek_dup(gp->gp_file_hek, param);
9913 /* duplicate a chain of magic */
9916 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
9918 MAGIC *mgprev = (MAGIC*)NULL;
9921 return (MAGIC*)NULL;
9922 /* look for it in the table first */
9923 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9927 for (; mg; mg = mg->mg_moremagic) {
9929 Newxz(nmg, 1, MAGIC);
9931 mgprev->mg_moremagic = nmg;
9934 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9935 nmg->mg_private = mg->mg_private;
9936 nmg->mg_type = mg->mg_type;
9937 nmg->mg_flags = mg->mg_flags;
9938 /* FIXME for plugins
9939 if (mg->mg_type == PERL_MAGIC_qr) {
9940 nmg->mg_obj = (SV*)CALLREGDUPE((REGEXP*)mg->mg_obj, param);
9944 if(mg->mg_type == PERL_MAGIC_backref) {
9945 /* The backref AV has its reference count deliberately bumped by
9947 nmg->mg_obj = SvREFCNT_inc(av_dup_inc((AV*) mg->mg_obj, param));
9950 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
9951 ? sv_dup_inc(mg->mg_obj, param)
9952 : sv_dup(mg->mg_obj, param);
9954 nmg->mg_len = mg->mg_len;
9955 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
9956 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
9957 if (mg->mg_len > 0) {
9958 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
9959 if (mg->mg_type == PERL_MAGIC_overload_table &&
9960 AMT_AMAGIC((AMT*)mg->mg_ptr))
9962 const AMT * const amtp = (AMT*)mg->mg_ptr;
9963 AMT * const namtp = (AMT*)nmg->mg_ptr;
9965 for (i = 1; i < NofAMmeth; i++) {
9966 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
9970 else if (mg->mg_len == HEf_SVKEY)
9971 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
9973 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9974 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9981 #endif /* USE_ITHREADS */
9983 /* create a new pointer-mapping table */
9986 Perl_ptr_table_new(pTHX)
9989 PERL_UNUSED_CONTEXT;
9991 Newxz(tbl, 1, PTR_TBL_t);
9994 Newxz(tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9998 #define PTR_TABLE_HASH(ptr) \
9999 ((PTR2UV(ptr) >> 3) ^ (PTR2UV(ptr) >> (3 + 7)) ^ (PTR2UV(ptr) >> (3 + 17)))
10002 we use the PTE_SVSLOT 'reservation' made above, both here (in the
10003 following define) and at call to new_body_inline made below in
10004 Perl_ptr_table_store()
10007 #define del_pte(p) del_body_type(p, PTE_SVSLOT)
10009 /* map an existing pointer using a table */
10011 STATIC PTR_TBL_ENT_t *
10012 S_ptr_table_find(PTR_TBL_t *tbl, const void *sv) {
10013 PTR_TBL_ENT_t *tblent;
10014 const UV hash = PTR_TABLE_HASH(sv);
10016 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10017 for (; tblent; tblent = tblent->next) {
10018 if (tblent->oldval == sv)
10025 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, const void *sv)
10027 PTR_TBL_ENT_t const *const tblent = ptr_table_find(tbl, sv);
10028 PERL_UNUSED_CONTEXT;
10029 return tblent ? tblent->newval : NULL;
10032 /* add a new entry to a pointer-mapping table */
10035 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, const void *oldsv, void *newsv)
10037 PTR_TBL_ENT_t *tblent = ptr_table_find(tbl, oldsv);
10038 PERL_UNUSED_CONTEXT;
10041 tblent->newval = newsv;
10043 const UV entry = PTR_TABLE_HASH(oldsv) & tbl->tbl_max;
10045 new_body_inline(tblent, PTE_SVSLOT);
10047 tblent->oldval = oldsv;
10048 tblent->newval = newsv;
10049 tblent->next = tbl->tbl_ary[entry];
10050 tbl->tbl_ary[entry] = tblent;
10052 if (tblent->next && tbl->tbl_items > tbl->tbl_max)
10053 ptr_table_split(tbl);
10057 /* double the hash bucket size of an existing ptr table */
10060 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10062 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10063 const UV oldsize = tbl->tbl_max + 1;
10064 UV newsize = oldsize * 2;
10066 PERL_UNUSED_CONTEXT;
10068 Renew(ary, newsize, PTR_TBL_ENT_t*);
10069 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10070 tbl->tbl_max = --newsize;
10071 tbl->tbl_ary = ary;
10072 for (i=0; i < oldsize; i++, ary++) {
10073 PTR_TBL_ENT_t **curentp, **entp, *ent;
10076 curentp = ary + oldsize;
10077 for (entp = ary, ent = *ary; ent; ent = *entp) {
10078 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10080 ent->next = *curentp;
10090 /* remove all the entries from a ptr table */
10093 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10095 if (tbl && tbl->tbl_items) {
10096 register PTR_TBL_ENT_t * const * const array = tbl->tbl_ary;
10097 UV riter = tbl->tbl_max;
10100 PTR_TBL_ENT_t *entry = array[riter];
10103 PTR_TBL_ENT_t * const oentry = entry;
10104 entry = entry->next;
10109 tbl->tbl_items = 0;
10113 /* clear and free a ptr table */
10116 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10121 ptr_table_clear(tbl);
10122 Safefree(tbl->tbl_ary);
10126 #if defined(USE_ITHREADS)
10129 Perl_rvpv_dup(pTHX_ SV *dstr, const SV *sstr, CLONE_PARAMS* param)
10132 SvRV_set(dstr, SvWEAKREF(sstr)
10133 ? sv_dup(SvRV(sstr), param)
10134 : sv_dup_inc(SvRV(sstr), param));
10137 else if (SvPVX_const(sstr)) {
10138 /* Has something there */
10140 /* Normal PV - clone whole allocated space */
10141 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
10142 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10143 /* Not that normal - actually sstr is copy on write.
10144 But we are a true, independant SV, so: */
10145 SvREADONLY_off(dstr);
10150 /* Special case - not normally malloced for some reason */
10151 if (isGV_with_GP(sstr)) {
10152 /* Don't need to do anything here. */
10154 else if ((SvREADONLY(sstr) && SvFAKE(sstr))) {
10155 /* A "shared" PV - clone it as "shared" PV */
10157 HEK_KEY(hek_dup(SvSHARED_HEK_FROM_PV(SvPVX_const(sstr)),
10161 /* Some other special case - random pointer */
10162 SvPV_set(dstr, SvPVX(sstr));
10167 /* Copy the NULL */
10168 SvPV_set(dstr, NULL);
10172 /* duplicate an SV of any type (including AV, HV etc) */
10175 Perl_sv_dup(pTHX_ const SV *sstr, CLONE_PARAMS* param)
10182 if (SvTYPE(sstr) == SVTYPEMASK) {
10183 #ifdef DEBUG_LEAKING_SCALARS_ABORT
10188 /* look for it in the table first */
10189 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10193 if(param->flags & CLONEf_JOIN_IN) {
10194 /** We are joining here so we don't want do clone
10195 something that is bad **/
10196 if (SvTYPE(sstr) == SVt_PVHV) {
10197 const HEK * const hvname = HvNAME_HEK(sstr);
10199 /** don't clone stashes if they already exist **/
10200 return (SV*)gv_stashpvn(HEK_KEY(hvname), HEK_LEN(hvname), 0);
10204 /* create anew and remember what it is */
10207 #ifdef DEBUG_LEAKING_SCALARS
10208 dstr->sv_debug_optype = sstr->sv_debug_optype;
10209 dstr->sv_debug_line = sstr->sv_debug_line;
10210 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10211 dstr->sv_debug_cloned = 1;
10212 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10215 ptr_table_store(PL_ptr_table, sstr, dstr);
10218 SvFLAGS(dstr) = SvFLAGS(sstr);
10219 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10220 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10223 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
10224 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10225 (void*)PL_watch_pvx, SvPVX_const(sstr));
10228 /* don't clone objects whose class has asked us not to */
10229 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10234 switch (SvTYPE(sstr)) {
10236 SvANY(dstr) = NULL;
10239 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
10241 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10243 SvIV_set(dstr, SvIVX(sstr));
10247 SvANY(dstr) = new_XNV();
10248 SvNV_set(dstr, SvNVX(sstr));
10250 /* case SVt_BIND: */
10253 /* These are all the types that need complex bodies allocating. */
10255 const svtype sv_type = SvTYPE(sstr);
10256 const struct body_details *const sv_type_details
10257 = bodies_by_type + sv_type;
10261 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10265 if (GvUNIQUE((GV*)sstr)) {
10266 NOOP; /* Do sharing here, and fall through */
10279 assert(sv_type_details->body_size);
10280 if (sv_type_details->arena) {
10281 new_body_inline(new_body, sv_type);
10283 = (void*)((char*)new_body - sv_type_details->offset);
10285 new_body = new_NOARENA(sv_type_details);
10289 SvANY(dstr) = new_body;
10292 Copy(((char*)SvANY(sstr)) + sv_type_details->offset,
10293 ((char*)SvANY(dstr)) + sv_type_details->offset,
10294 sv_type_details->copy, char);
10296 Copy(((char*)SvANY(sstr)),
10297 ((char*)SvANY(dstr)),
10298 sv_type_details->body_size + sv_type_details->offset, char);
10301 if (sv_type != SVt_PVAV && sv_type != SVt_PVHV
10302 && !isGV_with_GP(dstr))
10303 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10305 /* The Copy above means that all the source (unduplicated) pointers
10306 are now in the destination. We can check the flags and the
10307 pointers in either, but it's possible that there's less cache
10308 missing by always going for the destination.
10309 FIXME - instrument and check that assumption */
10310 if (sv_type >= SVt_PVMG) {
10311 if ((sv_type == SVt_PVMG) && SvPAD_OUR(dstr)) {
10312 SvOURSTASH_set(dstr, hv_dup_inc(SvOURSTASH(dstr), param));
10313 } else if (SvMAGIC(dstr))
10314 SvMAGIC_set(dstr, mg_dup(SvMAGIC(dstr), param));
10316 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(dstr), param));
10319 /* The cast silences a GCC warning about unhandled types. */
10320 switch ((int)sv_type) {
10330 /* FIXME for plugins */
10331 re_dup_guts((REGEXP*) sstr, (REGEXP*) dstr, param);
10334 /* XXX LvTARGOFF sometimes holds PMOP* when DEBUGGING */
10335 if (LvTYPE(dstr) == 't') /* for tie: unrefcnted fake (SV**) */
10336 LvTARG(dstr) = dstr;
10337 else if (LvTYPE(dstr) == 'T') /* for tie: fake HE */
10338 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(dstr), 0, param);
10340 LvTARG(dstr) = sv_dup_inc(LvTARG(dstr), param);
10342 if(isGV_with_GP(sstr)) {
10343 if (GvNAME_HEK(dstr))
10344 GvNAME_HEK(dstr) = hek_dup(GvNAME_HEK(dstr), param);
10345 /* Don't call sv_add_backref here as it's going to be
10346 created as part of the magic cloning of the symbol
10348 /* Danger Will Robinson - GvGP(dstr) isn't initialised
10349 at the point of this comment. */
10350 GvSTASH(dstr) = hv_dup(GvSTASH(dstr), param);
10351 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10352 (void)GpREFCNT_inc(GvGP(dstr));
10354 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10357 IoIFP(dstr) = fp_dup(IoIFP(dstr), IoTYPE(dstr), param);
10358 if (IoOFP(dstr) == IoIFP(sstr))
10359 IoOFP(dstr) = IoIFP(dstr);
10361 IoOFP(dstr) = fp_dup(IoOFP(dstr), IoTYPE(dstr), param);
10362 /* PL_parser->rsfp_filters entries have fake IoDIRP() */
10363 if(IoFLAGS(dstr) & IOf_FAKE_DIRP) {
10364 /* I have no idea why fake dirp (rsfps)
10365 should be treated differently but otherwise
10366 we end up with leaks -- sky*/
10367 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(dstr), param);
10368 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(dstr), param);
10369 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(dstr), param);
10371 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(dstr), param);
10372 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(dstr), param);
10373 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(dstr), param);
10374 if (IoDIRP(dstr)) {
10375 IoDIRP(dstr) = dirp_dup(IoDIRP(dstr));
10378 /* IoDIRP(dstr) is already a copy of IoDIRP(sstr) */
10381 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(dstr));
10382 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(dstr));
10383 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(dstr));
10386 if (AvARRAY((AV*)sstr)) {
10387 SV **dst_ary, **src_ary;
10388 SSize_t items = AvFILLp((AV*)sstr) + 1;
10390 src_ary = AvARRAY((AV*)sstr);
10391 Newxz(dst_ary, AvMAX((AV*)sstr)+1, SV*);
10392 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10393 AvARRAY((AV*)dstr) = dst_ary;
10394 AvALLOC((AV*)dstr) = dst_ary;
10395 if (AvREAL((AV*)sstr)) {
10396 while (items-- > 0)
10397 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10400 while (items-- > 0)
10401 *dst_ary++ = sv_dup(*src_ary++, param);
10403 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10404 while (items-- > 0) {
10405 *dst_ary++ = &PL_sv_undef;
10409 AvARRAY((AV*)dstr) = NULL;
10410 AvALLOC((AV*)dstr) = (SV**)NULL;
10414 if (HvARRAY((HV*)sstr)) {
10416 const bool sharekeys = !!HvSHAREKEYS(sstr);
10417 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10418 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
10420 Newx(darray, PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10421 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0),
10423 HvARRAY(dstr) = (HE**)darray;
10424 while (i <= sxhv->xhv_max) {
10425 const HE * const source = HvARRAY(sstr)[i];
10426 HvARRAY(dstr)[i] = source
10427 ? he_dup(source, sharekeys, param) : 0;
10432 const struct xpvhv_aux * const saux = HvAUX(sstr);
10433 struct xpvhv_aux * const daux = HvAUX(dstr);
10434 /* This flag isn't copied. */
10435 /* SvOOK_on(hv) attacks the IV flags. */
10436 SvFLAGS(dstr) |= SVf_OOK;
10438 hvname = saux->xhv_name;
10439 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
10441 daux->xhv_riter = saux->xhv_riter;
10442 daux->xhv_eiter = saux->xhv_eiter
10443 ? he_dup(saux->xhv_eiter,
10444 (bool)!!HvSHAREKEYS(sstr), param) : 0;
10445 daux->xhv_backreferences =
10446 saux->xhv_backreferences
10447 ? (AV*) SvREFCNT_inc(
10448 sv_dup((SV*)saux->xhv_backreferences, param))
10451 daux->xhv_mro_meta = saux->xhv_mro_meta
10452 ? mro_meta_dup(saux->xhv_mro_meta, param)
10455 /* Record stashes for possible cloning in Perl_clone(). */
10457 av_push(param->stashes, dstr);
10461 HvARRAY((HV*)dstr) = NULL;
10464 if (!(param->flags & CLONEf_COPY_STACKS)) {
10468 /* NOTE: not refcounted */
10469 CvSTASH(dstr) = hv_dup(CvSTASH(dstr), param);
10471 if (!CvISXSUB(dstr))
10472 CvROOT(dstr) = OpREFCNT_inc(CvROOT(dstr));
10474 if (CvCONST(dstr) && CvISXSUB(dstr)) {
10475 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(dstr)) ?
10476 SvREFCNT_inc(CvXSUBANY(dstr).any_ptr) :
10477 sv_dup_inc((SV *)CvXSUBANY(dstr).any_ptr, param);
10479 /* don't dup if copying back - CvGV isn't refcounted, so the
10480 * duped GV may never be freed. A bit of a hack! DAPM */
10481 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10482 NULL : gv_dup(CvGV(dstr), param) ;
10483 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10485 CvWEAKOUTSIDE(sstr)
10486 ? cv_dup( CvOUTSIDE(dstr), param)
10487 : cv_dup_inc(CvOUTSIDE(dstr), param);
10488 if (!CvISXSUB(dstr))
10489 CvFILE(dstr) = SAVEPV(CvFILE(dstr));
10495 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10501 /* duplicate a context */
10504 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10506 PERL_CONTEXT *ncxs;
10509 return (PERL_CONTEXT*)NULL;
10511 /* look for it in the table first */
10512 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
10516 /* create anew and remember what it is */
10517 Newx(ncxs, max + 1, PERL_CONTEXT);
10518 ptr_table_store(PL_ptr_table, cxs, ncxs);
10519 Copy(cxs, ncxs, max + 1, PERL_CONTEXT);
10522 PERL_CONTEXT * const ncx = &ncxs[ix];
10523 if (CxTYPE(ncx) == CXt_SUBST) {
10524 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
10527 switch (CxTYPE(ncx)) {
10529 ncx->blk_sub.cv = (ncx->blk_sub.olddepth == 0
10530 ? cv_dup_inc(ncx->blk_sub.cv, param)
10531 : cv_dup(ncx->blk_sub.cv,param));
10532 ncx->blk_sub.argarray = (CxHASARGS(ncx)
10533 ? av_dup_inc(ncx->blk_sub.argarray,
10536 ncx->blk_sub.savearray = av_dup_inc(ncx->blk_sub.savearray,
10538 ncx->blk_sub.oldcomppad = (PAD*)ptr_table_fetch(PL_ptr_table,
10539 ncx->blk_sub.oldcomppad);
10542 ncx->blk_eval.old_namesv = sv_dup_inc(ncx->blk_eval.old_namesv,
10544 ncx->blk_eval.cur_text = sv_dup(ncx->blk_eval.cur_text, param);
10546 case CXt_LOOP_LAZYSV:
10547 ncx->blk_loop.state_u.lazysv.end
10548 = sv_dup_inc(ncx->blk_loop.state_u.lazysv.end, param);
10549 /* We are taking advantage of av_dup_inc and sv_dup_inc
10550 actually being the same function, and order equivalance of
10552 We can assert the later [but only at run time :-(] */
10553 assert ((void *) &ncx->blk_loop.state_u.ary.ary ==
10554 (void *) &ncx->blk_loop.state_u.lazysv.cur);
10556 ncx->blk_loop.state_u.ary.ary
10557 = av_dup_inc(ncx->blk_loop.state_u.ary.ary, param);
10558 case CXt_LOOP_LAZYIV:
10559 case CXt_LOOP_PLAIN:
10560 if (CxPADLOOP(ncx)) {
10561 ncx->blk_loop.oldcomppad
10562 = (PAD*)ptr_table_fetch(PL_ptr_table,
10563 ncx->blk_loop.oldcomppad);
10565 ncx->blk_loop.oldcomppad
10566 = (PAD*)gv_dup((GV*)ncx->blk_loop.oldcomppad, param);
10570 ncx->blk_format.cv = cv_dup(ncx->blk_format.cv, param);
10571 ncx->blk_format.gv = gv_dup(ncx->blk_format.gv, param);
10572 ncx->blk_format.dfoutgv = gv_dup_inc(ncx->blk_format.dfoutgv,
10585 /* duplicate a stack info structure */
10588 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
10593 return (PERL_SI*)NULL;
10595 /* look for it in the table first */
10596 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10600 /* create anew and remember what it is */
10601 Newxz(nsi, 1, PERL_SI);
10602 ptr_table_store(PL_ptr_table, si, nsi);
10604 nsi->si_stack = av_dup_inc(si->si_stack, param);
10605 nsi->si_cxix = si->si_cxix;
10606 nsi->si_cxmax = si->si_cxmax;
10607 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
10608 nsi->si_type = si->si_type;
10609 nsi->si_prev = si_dup(si->si_prev, param);
10610 nsi->si_next = si_dup(si->si_next, param);
10611 nsi->si_markoff = si->si_markoff;
10616 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10617 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
10618 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10619 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
10620 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10621 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
10622 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10623 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
10624 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10625 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10626 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10627 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10628 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10629 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10632 #define pv_dup_inc(p) SAVEPV(p)
10633 #define pv_dup(p) SAVEPV(p)
10634 #define svp_dup_inc(p,pp) any_dup(p,pp)
10636 /* map any object to the new equivent - either something in the
10637 * ptr table, or something in the interpreter structure
10641 Perl_any_dup(pTHX_ void *v, const PerlInterpreter *proto_perl)
10646 return (void*)NULL;
10648 /* look for it in the table first */
10649 ret = ptr_table_fetch(PL_ptr_table, v);
10653 /* see if it is part of the interpreter structure */
10654 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
10655 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
10663 /* duplicate the save stack */
10666 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
10669 ANY * const ss = proto_perl->Isavestack;
10670 const I32 max = proto_perl->Isavestack_max;
10671 I32 ix = proto_perl->Isavestack_ix;
10684 void (*dptr) (void*);
10685 void (*dxptr) (pTHX_ void*);
10687 Newxz(nss, max, ANY);
10690 const I32 type = POPINT(ss,ix);
10691 TOPINT(nss,ix) = type;
10693 case SAVEt_HELEM: /* hash element */
10694 sv = (SV*)POPPTR(ss,ix);
10695 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10697 case SAVEt_ITEM: /* normal string */
10698 case SAVEt_SV: /* scalar reference */
10699 sv = (SV*)POPPTR(ss,ix);
10700 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10703 case SAVEt_MORTALIZESV:
10704 sv = (SV*)POPPTR(ss,ix);
10705 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10707 case SAVEt_SHARED_PVREF: /* char* in shared space */
10708 c = (char*)POPPTR(ss,ix);
10709 TOPPTR(nss,ix) = savesharedpv(c);
10710 ptr = POPPTR(ss,ix);
10711 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10713 case SAVEt_GENERIC_SVREF: /* generic sv */
10714 case SAVEt_SVREF: /* scalar reference */
10715 sv = (SV*)POPPTR(ss,ix);
10716 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10717 ptr = POPPTR(ss,ix);
10718 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10720 case SAVEt_HV: /* hash reference */
10721 case SAVEt_AV: /* array reference */
10722 sv = (SV*) POPPTR(ss,ix);
10723 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10725 case SAVEt_COMPPAD:
10727 sv = (SV*) POPPTR(ss,ix);
10728 TOPPTR(nss,ix) = sv_dup(sv, param);
10730 case SAVEt_INT: /* int reference */
10731 ptr = POPPTR(ss,ix);
10732 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10733 intval = (int)POPINT(ss,ix);
10734 TOPINT(nss,ix) = intval;
10736 case SAVEt_LONG: /* long reference */
10737 ptr = POPPTR(ss,ix);
10738 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10740 case SAVEt_CLEARSV:
10741 longval = (long)POPLONG(ss,ix);
10742 TOPLONG(nss,ix) = longval;
10744 case SAVEt_I32: /* I32 reference */
10745 case SAVEt_I16: /* I16 reference */
10746 case SAVEt_I8: /* I8 reference */
10747 case SAVEt_COP_ARYBASE: /* call CopARYBASE_set */
10748 ptr = POPPTR(ss,ix);
10749 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10751 TOPINT(nss,ix) = i;
10753 case SAVEt_IV: /* IV reference */
10754 ptr = POPPTR(ss,ix);
10755 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10757 TOPIV(nss,ix) = iv;
10759 case SAVEt_HPTR: /* HV* reference */
10760 case SAVEt_APTR: /* AV* reference */
10761 case SAVEt_SPTR: /* SV* reference */
10762 ptr = POPPTR(ss,ix);
10763 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10764 sv = (SV*)POPPTR(ss,ix);
10765 TOPPTR(nss,ix) = sv_dup(sv, param);
10767 case SAVEt_VPTR: /* random* reference */
10768 ptr = POPPTR(ss,ix);
10769 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10770 ptr = POPPTR(ss,ix);
10771 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10773 case SAVEt_GENERIC_PVREF: /* generic char* */
10774 case SAVEt_PPTR: /* char* reference */
10775 ptr = POPPTR(ss,ix);
10776 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10777 c = (char*)POPPTR(ss,ix);
10778 TOPPTR(nss,ix) = pv_dup(c);
10780 case SAVEt_GP: /* scalar reference */
10781 gp = (GP*)POPPTR(ss,ix);
10782 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
10783 (void)GpREFCNT_inc(gp);
10784 gv = (GV*)POPPTR(ss,ix);
10785 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
10788 ptr = POPPTR(ss,ix);
10789 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10790 /* these are assumed to be refcounted properly */
10792 switch (((OP*)ptr)->op_type) {
10794 case OP_LEAVESUBLV:
10798 case OP_LEAVEWRITE:
10799 TOPPTR(nss,ix) = ptr;
10802 (void) OpREFCNT_inc(o);
10806 TOPPTR(nss,ix) = NULL;
10811 TOPPTR(nss,ix) = NULL;
10814 c = (char*)POPPTR(ss,ix);
10815 TOPPTR(nss,ix) = pv_dup_inc(c);
10818 hv = (HV*)POPPTR(ss,ix);
10819 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10820 c = (char*)POPPTR(ss,ix);
10821 TOPPTR(nss,ix) = pv_dup_inc(c);
10823 case SAVEt_STACK_POS: /* Position on Perl stack */
10825 TOPINT(nss,ix) = i;
10827 case SAVEt_DESTRUCTOR:
10828 ptr = POPPTR(ss,ix);
10829 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10830 dptr = POPDPTR(ss,ix);
10831 TOPDPTR(nss,ix) = DPTR2FPTR(void (*)(void*),
10832 any_dup(FPTR2DPTR(void *, dptr),
10835 case SAVEt_DESTRUCTOR_X:
10836 ptr = POPPTR(ss,ix);
10837 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10838 dxptr = POPDXPTR(ss,ix);
10839 TOPDXPTR(nss,ix) = DPTR2FPTR(void (*)(pTHX_ void*),
10840 any_dup(FPTR2DPTR(void *, dxptr),
10843 case SAVEt_REGCONTEXT:
10846 TOPINT(nss,ix) = i;
10849 case SAVEt_AELEM: /* array element */
10850 sv = (SV*)POPPTR(ss,ix);
10851 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10853 TOPINT(nss,ix) = i;
10854 av = (AV*)POPPTR(ss,ix);
10855 TOPPTR(nss,ix) = av_dup_inc(av, param);
10858 ptr = POPPTR(ss,ix);
10859 TOPPTR(nss,ix) = ptr;
10863 TOPINT(nss,ix) = i;
10864 ptr = POPPTR(ss,ix);
10867 ((struct refcounted_he *)ptr)->refcounted_he_refcnt++;
10868 HINTS_REFCNT_UNLOCK;
10870 TOPPTR(nss,ix) = ptr;
10871 if (i & HINT_LOCALIZE_HH) {
10872 hv = (HV*)POPPTR(ss,ix);
10873 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
10876 case SAVEt_PADSV_AND_MORTALIZE:
10877 longval = (long)POPLONG(ss,ix);
10878 TOPLONG(nss,ix) = longval;
10879 ptr = POPPTR(ss,ix);
10880 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10881 sv = (SV*)POPPTR(ss,ix);
10882 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
10885 ptr = POPPTR(ss,ix);
10886 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10887 longval = (long)POPBOOL(ss,ix);
10888 TOPBOOL(nss,ix) = (bool)longval;
10890 case SAVEt_SET_SVFLAGS:
10892 TOPINT(nss,ix) = i;
10894 TOPINT(nss,ix) = i;
10895 sv = (SV*)POPPTR(ss,ix);
10896 TOPPTR(nss,ix) = sv_dup(sv, param);
10898 case SAVEt_RE_STATE:
10900 const struct re_save_state *const old_state
10901 = (struct re_save_state *)
10902 (ss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10903 struct re_save_state *const new_state
10904 = (struct re_save_state *)
10905 (nss + ix - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
10907 Copy(old_state, new_state, 1, struct re_save_state);
10908 ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
10910 new_state->re_state_bostr
10911 = pv_dup(old_state->re_state_bostr);
10912 new_state->re_state_reginput
10913 = pv_dup(old_state->re_state_reginput);
10914 new_state->re_state_regeol
10915 = pv_dup(old_state->re_state_regeol);
10916 new_state->re_state_regoffs
10917 = (regexp_paren_pair*)
10918 any_dup(old_state->re_state_regoffs, proto_perl);
10919 new_state->re_state_reglastparen
10920 = (U32*) any_dup(old_state->re_state_reglastparen,
10922 new_state->re_state_reglastcloseparen
10923 = (U32*)any_dup(old_state->re_state_reglastcloseparen,
10925 /* XXX This just has to be broken. The old save_re_context
10926 code did SAVEGENERICPV(PL_reg_start_tmp);
10927 PL_reg_start_tmp is char **.
10928 Look above to what the dup code does for
10929 SAVEt_GENERIC_PVREF
10930 It can never have worked.
10931 So this is merely a faithful copy of the exiting bug: */
10932 new_state->re_state_reg_start_tmp
10933 = (char **) pv_dup((char *)
10934 old_state->re_state_reg_start_tmp);
10935 /* I assume that it only ever "worked" because no-one called
10936 (pseudo)fork while the regexp engine had re-entered itself.
10938 #ifdef PERL_OLD_COPY_ON_WRITE
10939 new_state->re_state_nrs
10940 = sv_dup(old_state->re_state_nrs, param);
10942 new_state->re_state_reg_magic
10943 = (MAGIC*) any_dup(old_state->re_state_reg_magic,
10945 new_state->re_state_reg_oldcurpm
10946 = (PMOP*) any_dup(old_state->re_state_reg_oldcurpm,
10948 new_state->re_state_reg_curpm
10949 = (PMOP*) any_dup(old_state->re_state_reg_curpm,
10951 new_state->re_state_reg_oldsaved
10952 = pv_dup(old_state->re_state_reg_oldsaved);
10953 new_state->re_state_reg_poscache
10954 = pv_dup(old_state->re_state_reg_poscache);
10955 new_state->re_state_reg_starttry
10956 = pv_dup(old_state->re_state_reg_starttry);
10959 case SAVEt_COMPILE_WARNINGS:
10960 ptr = POPPTR(ss,ix);
10961 TOPPTR(nss,ix) = DUP_WARNINGS((STRLEN*)ptr);
10964 ptr = POPPTR(ss,ix);
10965 TOPPTR(nss,ix) = parser_dup((const yy_parser*)ptr, param);
10969 "panic: ss_dup inconsistency (%"IVdf")", (IV) type);
10977 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
10978 * flag to the result. This is done for each stash before cloning starts,
10979 * so we know which stashes want their objects cloned */
10982 do_mark_cloneable_stash(pTHX_ SV *sv)
10984 const HEK * const hvname = HvNAME_HEK((HV*)sv);
10986 GV* const cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
10987 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
10988 if (cloner && GvCV(cloner)) {
10995 mXPUSHs(newSVhek(hvname));
10997 call_sv((SV*)GvCV(cloner), G_SCALAR);
11004 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11012 =for apidoc perl_clone
11014 Create and return a new interpreter by cloning the current one.
11016 perl_clone takes these flags as parameters:
11018 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11019 without it we only clone the data and zero the stacks,
11020 with it we copy the stacks and the new perl interpreter is
11021 ready to run at the exact same point as the previous one.
11022 The pseudo-fork code uses COPY_STACKS while the
11023 threads->create doesn't.
11025 CLONEf_KEEP_PTR_TABLE
11026 perl_clone keeps a ptr_table with the pointer of the old
11027 variable as a key and the new variable as a value,
11028 this allows it to check if something has been cloned and not
11029 clone it again but rather just use the value and increase the
11030 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11031 the ptr_table using the function
11032 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11033 reason to keep it around is if you want to dup some of your own
11034 variable who are outside the graph perl scans, example of this
11035 code is in threads.xs create
11038 This is a win32 thing, it is ignored on unix, it tells perls
11039 win32host code (which is c++) to clone itself, this is needed on
11040 win32 if you want to run two threads at the same time,
11041 if you just want to do some stuff in a separate perl interpreter
11042 and then throw it away and return to the original one,
11043 you don't need to do anything.
11048 /* XXX the above needs expanding by someone who actually understands it ! */
11049 EXTERN_C PerlInterpreter *
11050 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11053 perl_clone(PerlInterpreter *proto_perl, UV flags)
11056 #ifdef PERL_IMPLICIT_SYS
11058 /* perlhost.h so we need to call into it
11059 to clone the host, CPerlHost should have a c interface, sky */
11061 if (flags & CLONEf_CLONE_HOST) {
11062 return perl_clone_host(proto_perl,flags);
11064 return perl_clone_using(proto_perl, flags,
11066 proto_perl->IMemShared,
11067 proto_perl->IMemParse,
11069 proto_perl->IStdIO,
11073 proto_perl->IProc);
11077 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11078 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11079 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11080 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11081 struct IPerlDir* ipD, struct IPerlSock* ipS,
11082 struct IPerlProc* ipP)
11084 /* XXX many of the string copies here can be optimized if they're
11085 * constants; they need to be allocated as common memory and just
11086 * their pointers copied. */
11089 CLONE_PARAMS clone_params;
11090 CLONE_PARAMS* const param = &clone_params;
11092 PerlInterpreter * const my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11093 /* for each stash, determine whether its objects should be cloned */
11094 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11095 PERL_SET_THX(my_perl);
11098 PoisonNew(my_perl, 1, PerlInterpreter);
11104 PL_savestack_ix = 0;
11105 PL_savestack_max = -1;
11106 PL_sig_pending = 0;
11108 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11109 # else /* !DEBUGGING */
11110 Zero(my_perl, 1, PerlInterpreter);
11111 # endif /* DEBUGGING */
11113 /* host pointers */
11115 PL_MemShared = ipMS;
11116 PL_MemParse = ipMP;
11123 #else /* !PERL_IMPLICIT_SYS */
11125 CLONE_PARAMS clone_params;
11126 CLONE_PARAMS* param = &clone_params;
11127 PerlInterpreter * const my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11128 /* for each stash, determine whether its objects should be cloned */
11129 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11130 PERL_SET_THX(my_perl);
11133 PoisonNew(my_perl, 1, PerlInterpreter);
11139 PL_savestack_ix = 0;
11140 PL_savestack_max = -1;
11141 PL_sig_pending = 0;
11143 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11144 # else /* !DEBUGGING */
11145 Zero(my_perl, 1, PerlInterpreter);
11146 # endif /* DEBUGGING */
11147 #endif /* PERL_IMPLICIT_SYS */
11148 param->flags = flags;
11149 param->proto_perl = proto_perl;
11151 INIT_TRACK_MEMPOOL(my_perl->Imemory_debug_header, my_perl);
11153 PL_body_arenas = NULL;
11154 Zero(&PL_body_roots, 1, PL_body_roots);
11156 PL_nice_chunk = NULL;
11157 PL_nice_chunk_size = 0;
11159 PL_sv_objcount = 0;
11161 PL_sv_arenaroot = NULL;
11163 PL_debug = proto_perl->Idebug;
11165 PL_hash_seed = proto_perl->Ihash_seed;
11166 PL_rehash_seed = proto_perl->Irehash_seed;
11168 #ifdef USE_REENTRANT_API
11169 /* XXX: things like -Dm will segfault here in perlio, but doing
11170 * PERL_SET_CONTEXT(proto_perl);
11171 * breaks too many other things
11173 Perl_reentrant_init(aTHX);
11176 /* create SV map for pointer relocation */
11177 PL_ptr_table = ptr_table_new();
11179 /* initialize these special pointers as early as possible */
11180 SvANY(&PL_sv_undef) = NULL;
11181 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11182 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11183 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11185 SvANY(&PL_sv_no) = new_XPVNV();
11186 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11187 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11188 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11189 SvPV_set(&PL_sv_no, savepvn(PL_No, 0));
11190 SvCUR_set(&PL_sv_no, 0);
11191 SvLEN_set(&PL_sv_no, 1);
11192 SvIV_set(&PL_sv_no, 0);
11193 SvNV_set(&PL_sv_no, 0);
11194 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11196 SvANY(&PL_sv_yes) = new_XPVNV();
11197 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11198 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11199 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11200 SvPV_set(&PL_sv_yes, savepvn(PL_Yes, 1));
11201 SvCUR_set(&PL_sv_yes, 1);
11202 SvLEN_set(&PL_sv_yes, 2);
11203 SvIV_set(&PL_sv_yes, 1);
11204 SvNV_set(&PL_sv_yes, 1);
11205 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11207 /* create (a non-shared!) shared string table */
11208 PL_strtab = newHV();
11209 HvSHAREKEYS_off(PL_strtab);
11210 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
11211 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11213 PL_compiling = proto_perl->Icompiling;
11215 /* These two PVs will be free'd special way so must set them same way op.c does */
11216 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11217 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11219 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11220 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11222 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11223 PL_compiling.cop_warnings = DUP_WARNINGS(PL_compiling.cop_warnings);
11224 if (PL_compiling.cop_hints_hash) {
11226 PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
11227 HINTS_REFCNT_UNLOCK;
11229 PL_curcop = (COP*)any_dup(proto_perl->Icurcop, proto_perl);
11230 #ifdef PERL_DEBUG_READONLY_OPS
11235 /* pseudo environmental stuff */
11236 PL_origargc = proto_perl->Iorigargc;
11237 PL_origargv = proto_perl->Iorigargv;
11239 param->stashes = newAV(); /* Setup array of objects to call clone on */
11241 /* Set tainting stuff before PerlIO_debug can possibly get called */
11242 PL_tainting = proto_perl->Itainting;
11243 PL_taint_warn = proto_perl->Itaint_warn;
11245 #ifdef PERLIO_LAYERS
11246 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11247 PerlIO_clone(aTHX_ proto_perl, param);
11250 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11251 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11252 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11253 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11254 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11255 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11258 PL_minus_c = proto_perl->Iminus_c;
11259 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11260 PL_localpatches = proto_perl->Ilocalpatches;
11261 PL_splitstr = proto_perl->Isplitstr;
11262 PL_minus_n = proto_perl->Iminus_n;
11263 PL_minus_p = proto_perl->Iminus_p;
11264 PL_minus_l = proto_perl->Iminus_l;
11265 PL_minus_a = proto_perl->Iminus_a;
11266 PL_minus_E = proto_perl->Iminus_E;
11267 PL_minus_F = proto_perl->Iminus_F;
11268 PL_doswitches = proto_perl->Idoswitches;
11269 PL_dowarn = proto_perl->Idowarn;
11270 PL_doextract = proto_perl->Idoextract;
11271 PL_sawampersand = proto_perl->Isawampersand;
11272 PL_unsafe = proto_perl->Iunsafe;
11273 PL_inplace = SAVEPV(proto_perl->Iinplace);
11274 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11275 PL_perldb = proto_perl->Iperldb;
11276 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11277 PL_exit_flags = proto_perl->Iexit_flags;
11279 /* magical thingies */
11280 /* XXX time(&PL_basetime) when asked for? */
11281 PL_basetime = proto_perl->Ibasetime;
11282 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11284 PL_maxsysfd = proto_perl->Imaxsysfd;
11285 PL_statusvalue = proto_perl->Istatusvalue;
11287 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11289 PL_statusvalue_posix = proto_perl->Istatusvalue_posix;
11291 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11293 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11294 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11295 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11298 /* RE engine related */
11299 Zero(&PL_reg_state, 1, struct re_save_state);
11300 PL_reginterp_cnt = 0;
11301 PL_regmatch_slab = NULL;
11303 /* Clone the regex array */
11304 /* ORANGE FIXME for plugins, probably in the SV dup code.
11305 newSViv(PTR2IV(CALLREGDUPE(
11306 INT2PTR(REGEXP *, SvIVX(regex)), param))))
11308 PL_regex_padav = av_dup_inc(proto_perl->Iregex_padav, param);
11309 PL_regex_pad = AvARRAY(PL_regex_padav);
11311 /* shortcuts to various I/O objects */
11312 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11313 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11314 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11315 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11316 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11317 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11319 /* shortcuts to regexp stuff */
11320 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11322 /* shortcuts to misc objects */
11323 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11325 /* shortcuts to debugging objects */
11326 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11327 PL_DBline = gv_dup(proto_perl->IDBline, param);
11328 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11329 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11330 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11331 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11332 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11334 /* symbol tables */
11335 PL_defstash = hv_dup_inc(proto_perl->Idefstash, param);
11336 PL_curstash = hv_dup(proto_perl->Icurstash, param);
11337 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11338 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11339 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11341 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11342 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11343 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11344 PL_unitcheckav = av_dup_inc(proto_perl->Iunitcheckav, param);
11345 PL_unitcheckav_save = av_dup_inc(proto_perl->Iunitcheckav_save, param);
11346 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11347 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11348 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11350 PL_sub_generation = proto_perl->Isub_generation;
11351 PL_isarev = hv_dup_inc(proto_perl->Iisarev, param);
11353 /* funky return mechanisms */
11354 PL_forkprocess = proto_perl->Iforkprocess;
11356 /* subprocess state */
11357 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11359 /* internal state */
11360 PL_maxo = proto_perl->Imaxo;
11361 if (proto_perl->Iop_mask)
11362 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11365 /* PL_asserting = proto_perl->Iasserting; */
11367 /* current interpreter roots */
11368 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11370 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11372 PL_main_start = proto_perl->Imain_start;
11373 PL_eval_root = proto_perl->Ieval_root;
11374 PL_eval_start = proto_perl->Ieval_start;
11376 /* runtime control stuff */
11377 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11379 PL_filemode = proto_perl->Ifilemode;
11380 PL_lastfd = proto_perl->Ilastfd;
11381 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11384 PL_gensym = proto_perl->Igensym;
11385 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11386 PL_laststatval = proto_perl->Ilaststatval;
11387 PL_laststype = proto_perl->Ilaststype;
11390 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11392 /* interpreter atexit processing */
11393 PL_exitlistlen = proto_perl->Iexitlistlen;
11394 if (PL_exitlistlen) {
11395 Newx(PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11396 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11399 PL_exitlist = (PerlExitListEntry*)NULL;
11401 PL_my_cxt_size = proto_perl->Imy_cxt_size;
11402 if (PL_my_cxt_size) {
11403 Newx(PL_my_cxt_list, PL_my_cxt_size, void *);
11404 Copy(proto_perl->Imy_cxt_list, PL_my_cxt_list, PL_my_cxt_size, void *);
11405 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11406 Newx(PL_my_cxt_keys, PL_my_cxt_size, const char *);
11407 Copy(proto_perl->Imy_cxt_keys, PL_my_cxt_keys, PL_my_cxt_size, char *);
11411 PL_my_cxt_list = (void**)NULL;
11412 #ifdef PERL_GLOBAL_STRUCT_PRIVATE
11413 PL_my_cxt_keys = (const char**)NULL;
11416 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11417 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11418 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11420 PL_profiledata = NULL;
11422 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11424 PAD_CLONE_VARS(proto_perl, param);
11426 #ifdef HAVE_INTERP_INTERN
11427 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11430 /* more statics moved here */
11431 PL_generation = proto_perl->Igeneration;
11432 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11434 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11435 PL_in_clean_all = proto_perl->Iin_clean_all;
11437 PL_uid = proto_perl->Iuid;
11438 PL_euid = proto_perl->Ieuid;
11439 PL_gid = proto_perl->Igid;
11440 PL_egid = proto_perl->Iegid;
11441 PL_nomemok = proto_perl->Inomemok;
11442 PL_an = proto_perl->Ian;
11443 PL_evalseq = proto_perl->Ievalseq;
11444 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11445 PL_origalen = proto_perl->Iorigalen;
11446 #ifdef PERL_USES_PL_PIDSTATUS
11447 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11449 PL_osname = SAVEPV(proto_perl->Iosname);
11450 PL_sighandlerp = proto_perl->Isighandlerp;
11452 PL_runops = proto_perl->Irunops;
11454 PL_parser = parser_dup(proto_perl->Iparser, param);
11456 PL_subline = proto_perl->Isubline;
11457 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11460 PL_cryptseen = proto_perl->Icryptseen;
11463 PL_hints = proto_perl->Ihints;
11465 PL_amagic_generation = proto_perl->Iamagic_generation;
11467 #ifdef USE_LOCALE_COLLATE
11468 PL_collation_ix = proto_perl->Icollation_ix;
11469 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11470 PL_collation_standard = proto_perl->Icollation_standard;
11471 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11472 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11473 #endif /* USE_LOCALE_COLLATE */
11475 #ifdef USE_LOCALE_NUMERIC
11476 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11477 PL_numeric_standard = proto_perl->Inumeric_standard;
11478 PL_numeric_local = proto_perl->Inumeric_local;
11479 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11480 #endif /* !USE_LOCALE_NUMERIC */
11482 /* utf8 character classes */
11483 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
11484 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
11485 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
11486 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
11487 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
11488 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
11489 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
11490 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
11491 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
11492 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
11493 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
11494 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
11495 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
11496 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
11497 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
11498 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
11499 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
11500 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
11501 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
11502 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
11504 /* Did the locale setup indicate UTF-8? */
11505 PL_utf8locale = proto_perl->Iutf8locale;
11506 /* Unicode features (see perlrun/-C) */
11507 PL_unicode = proto_perl->Iunicode;
11509 /* Pre-5.8 signals control */
11510 PL_signals = proto_perl->Isignals;
11512 /* times() ticks per second */
11513 PL_clocktick = proto_perl->Iclocktick;
11515 /* Recursion stopper for PerlIO_find_layer */
11516 PL_in_load_module = proto_perl->Iin_load_module;
11518 /* sort() routine */
11519 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
11521 /* Not really needed/useful since the reenrant_retint is "volatile",
11522 * but do it for consistency's sake. */
11523 PL_reentrant_retint = proto_perl->Ireentrant_retint;
11525 /* Hooks to shared SVs and locks. */
11526 PL_sharehook = proto_perl->Isharehook;
11527 PL_lockhook = proto_perl->Ilockhook;
11528 PL_unlockhook = proto_perl->Iunlockhook;
11529 PL_threadhook = proto_perl->Ithreadhook;
11530 PL_destroyhook = proto_perl->Idestroyhook;
11532 #ifdef THREADS_HAVE_PIDS
11533 PL_ppid = proto_perl->Ippid;
11537 PL_last_swash_hv = NULL; /* reinits on demand */
11538 PL_last_swash_klen = 0;
11539 PL_last_swash_key[0]= '\0';
11540 PL_last_swash_tmps = (U8*)NULL;
11541 PL_last_swash_slen = 0;
11543 PL_glob_index = proto_perl->Iglob_index;
11544 PL_srand_called = proto_perl->Isrand_called;
11545 PL_bitcount = NULL; /* reinits on demand */
11547 if (proto_perl->Ipsig_pend) {
11548 Newxz(PL_psig_pend, SIG_SIZE, int);
11551 PL_psig_pend = (int*)NULL;
11554 if (proto_perl->Ipsig_ptr) {
11555 Newxz(PL_psig_ptr, SIG_SIZE, SV*);
11556 Newxz(PL_psig_name, SIG_SIZE, SV*);
11557 for (i = 1; i < SIG_SIZE; i++) {
11558 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
11559 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
11563 PL_psig_ptr = (SV**)NULL;
11564 PL_psig_name = (SV**)NULL;
11567 /* intrpvar.h stuff */
11569 if (flags & CLONEf_COPY_STACKS) {
11570 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
11571 PL_tmps_ix = proto_perl->Itmps_ix;
11572 PL_tmps_max = proto_perl->Itmps_max;
11573 PL_tmps_floor = proto_perl->Itmps_floor;
11574 Newxz(PL_tmps_stack, PL_tmps_max, SV*);
11576 while (i <= PL_tmps_ix) {
11577 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Itmps_stack[i], param);
11581 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
11582 i = proto_perl->Imarkstack_max - proto_perl->Imarkstack;
11583 Newxz(PL_markstack, i, I32);
11584 PL_markstack_max = PL_markstack + (proto_perl->Imarkstack_max
11585 - proto_perl->Imarkstack);
11586 PL_markstack_ptr = PL_markstack + (proto_perl->Imarkstack_ptr
11587 - proto_perl->Imarkstack);
11588 Copy(proto_perl->Imarkstack, PL_markstack,
11589 PL_markstack_ptr - PL_markstack + 1, I32);
11591 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
11592 * NOTE: unlike the others! */
11593 PL_scopestack_ix = proto_perl->Iscopestack_ix;
11594 PL_scopestack_max = proto_perl->Iscopestack_max;
11595 Newxz(PL_scopestack, PL_scopestack_max, I32);
11596 Copy(proto_perl->Iscopestack, PL_scopestack, PL_scopestack_ix, I32);
11598 /* NOTE: si_dup() looks at PL_markstack */
11599 PL_curstackinfo = si_dup(proto_perl->Icurstackinfo, param);
11601 /* PL_curstack = PL_curstackinfo->si_stack; */
11602 PL_curstack = av_dup(proto_perl->Icurstack, param);
11603 PL_mainstack = av_dup(proto_perl->Imainstack, param);
11605 /* next PUSHs() etc. set *(PL_stack_sp+1) */
11606 PL_stack_base = AvARRAY(PL_curstack);
11607 PL_stack_sp = PL_stack_base + (proto_perl->Istack_sp
11608 - proto_perl->Istack_base);
11609 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
11611 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
11612 * NOTE: unlike the others! */
11613 PL_savestack_ix = proto_perl->Isavestack_ix;
11614 PL_savestack_max = proto_perl->Isavestack_max;
11615 /*Newxz(PL_savestack, PL_savestack_max, ANY);*/
11616 PL_savestack = ss_dup(proto_perl, param);
11620 ENTER; /* perl_destruct() wants to LEAVE; */
11622 /* although we're not duplicating the tmps stack, we should still
11623 * add entries for any SVs on the tmps stack that got cloned by a
11624 * non-refcount means (eg a temp in @_); otherwise they will be
11627 for (i = 0; i<= proto_perl->Itmps_ix; i++) {
11628 SV * const nsv = (SV*)ptr_table_fetch(PL_ptr_table,
11629 proto_perl->Itmps_stack[i]);
11630 if (nsv && !SvREFCNT(nsv)) {
11632 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple(nsv);
11637 PL_start_env = proto_perl->Istart_env; /* XXXXXX */
11638 PL_top_env = &PL_start_env;
11640 PL_op = proto_perl->Iop;
11643 PL_Xpv = (XPV*)NULL;
11644 my_perl->Ina = proto_perl->Ina;
11646 PL_statbuf = proto_perl->Istatbuf;
11647 PL_statcache = proto_perl->Istatcache;
11648 PL_statgv = gv_dup(proto_perl->Istatgv, param);
11649 PL_statname = sv_dup_inc(proto_perl->Istatname, param);
11651 PL_timesbuf = proto_perl->Itimesbuf;
11654 PL_tainted = proto_perl->Itainted;
11655 PL_curpm = proto_perl->Icurpm; /* XXX No PMOP ref count */
11656 PL_rs = sv_dup_inc(proto_perl->Irs, param);
11657 PL_last_in_gv = gv_dup(proto_perl->Ilast_in_gv, param);
11658 PL_ofs_sv = sv_dup_inc(proto_perl->Iofs_sv, param);
11659 PL_defoutgv = gv_dup_inc(proto_perl->Idefoutgv, param);
11660 PL_chopset = proto_perl->Ichopset; /* XXX never deallocated */
11661 PL_toptarget = sv_dup_inc(proto_perl->Itoptarget, param);
11662 PL_bodytarget = sv_dup_inc(proto_perl->Ibodytarget, param);
11663 PL_formtarget = sv_dup(proto_perl->Iformtarget, param);
11665 PL_restartop = proto_perl->Irestartop;
11666 PL_in_eval = proto_perl->Iin_eval;
11667 PL_delaymagic = proto_perl->Idelaymagic;
11668 PL_dirty = proto_perl->Idirty;
11669 PL_localizing = proto_perl->Ilocalizing;
11671 PL_errors = sv_dup_inc(proto_perl->Ierrors, param);
11672 PL_hv_fetch_ent_mh = NULL;
11673 PL_modcount = proto_perl->Imodcount;
11674 PL_lastgotoprobe = NULL;
11675 PL_dumpindent = proto_perl->Idumpindent;
11677 PL_sortcop = (OP*)any_dup(proto_perl->Isortcop, proto_perl);
11678 PL_sortstash = hv_dup(proto_perl->Isortstash, param);
11679 PL_firstgv = gv_dup(proto_perl->Ifirstgv, param);
11680 PL_secondgv = gv_dup(proto_perl->Isecondgv, param);
11681 PL_efloatbuf = NULL; /* reinits on demand */
11682 PL_efloatsize = 0; /* reinits on demand */
11686 PL_screamfirst = NULL;
11687 PL_screamnext = NULL;
11688 PL_maxscream = -1; /* reinits on demand */
11689 PL_lastscream = NULL;
11692 PL_regdummy = proto_perl->Iregdummy;
11693 PL_colorset = 0; /* reinits PL_colors[] */
11694 /*PL_colors[6] = {0,0,0,0,0,0};*/
11698 /* Pluggable optimizer */
11699 PL_peepp = proto_perl->Ipeepp;
11701 PL_stashcache = newHV();
11703 PL_watchaddr = (char **) ptr_table_fetch(PL_ptr_table,
11704 proto_perl->Iwatchaddr);
11705 PL_watchok = PL_watchaddr ? * PL_watchaddr : NULL;
11706 if (PL_debug && PL_watchaddr) {
11707 PerlIO_printf(Perl_debug_log,
11708 "WATCHING: %"UVxf" cloned as %"UVxf" with value %"UVxf"\n",
11709 PTR2UV(proto_perl->Iwatchaddr), PTR2UV(PL_watchaddr),
11710 PTR2UV(PL_watchok));
11713 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11714 ptr_table_free(PL_ptr_table);
11715 PL_ptr_table = NULL;
11718 /* Call the ->CLONE method, if it exists, for each of the stashes
11719 identified by sv_dup() above.
11721 while(av_len(param->stashes) != -1) {
11722 HV* const stash = (HV*) av_shift(param->stashes);
11723 GV* const cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11724 if (cloner && GvCV(cloner)) {
11729 mXPUSHs(newSVhek(HvNAME_HEK(stash)));
11731 call_sv((SV*)GvCV(cloner), G_DISCARD);
11737 SvREFCNT_dec(param->stashes);
11739 /* orphaned? eg threads->new inside BEGIN or use */
11740 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
11741 SvREFCNT_inc_simple_void(PL_compcv);
11742 SAVEFREESV(PL_compcv);
11748 #endif /* USE_ITHREADS */
11751 =head1 Unicode Support
11753 =for apidoc sv_recode_to_utf8
11755 The encoding is assumed to be an Encode object, on entry the PV
11756 of the sv is assumed to be octets in that encoding, and the sv
11757 will be converted into Unicode (and UTF-8).
11759 If the sv already is UTF-8 (or if it is not POK), or if the encoding
11760 is not a reference, nothing is done to the sv. If the encoding is not
11761 an C<Encode::XS> Encoding object, bad things will happen.
11762 (See F<lib/encoding.pm> and L<Encode>).
11764 The PV of the sv is returned.
11769 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11772 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
11786 Passing sv_yes is wrong - it needs to be or'ed set of constants
11787 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11788 remove converted chars from source.
11790 Both will default the value - let them.
11792 XPUSHs(&PL_sv_yes);
11795 call_method("decode", G_SCALAR);
11799 s = SvPV_const(uni, len);
11800 if (s != SvPVX_const(sv)) {
11801 SvGROW(sv, len + 1);
11802 Move(s, SvPVX(sv), len + 1, char);
11803 SvCUR_set(sv, len);
11810 return SvPOKp(sv) ? SvPVX(sv) : NULL;
11814 =for apidoc sv_cat_decode
11816 The encoding is assumed to be an Encode object, the PV of the ssv is
11817 assumed to be octets in that encoding and decoding the input starts
11818 from the position which (PV + *offset) pointed to. The dsv will be
11819 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11820 when the string tstr appears in decoding output or the input ends on
11821 the PV of the ssv. The value which the offset points will be modified
11822 to the last input position on the ssv.
11824 Returns TRUE if the terminator was found, else returns FALSE.
11829 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11830 SV *ssv, int *offset, char *tstr, int tlen)
11834 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11845 offsv = newSViv(*offset);
11847 mXPUSHp(tstr, tlen);
11849 call_method("cat_decode", G_SCALAR);
11851 ret = SvTRUE(TOPs);
11852 *offset = SvIV(offsv);
11858 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
11863 /* ---------------------------------------------------------------------
11865 * support functions for report_uninit()
11868 /* the maxiumum size of array or hash where we will scan looking
11869 * for the undefined element that triggered the warning */
11871 #define FUV_MAX_SEARCH_SIZE 1000
11873 /* Look for an entry in the hash whose value has the same SV as val;
11874 * If so, return a mortal copy of the key. */
11877 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
11880 register HE **array;
11883 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
11884 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
11887 array = HvARRAY(hv);
11889 for (i=HvMAX(hv); i>0; i--) {
11890 register HE *entry;
11891 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
11892 if (HeVAL(entry) != val)
11894 if ( HeVAL(entry) == &PL_sv_undef ||
11895 HeVAL(entry) == &PL_sv_placeholder)
11899 if (HeKLEN(entry) == HEf_SVKEY)
11900 return sv_mortalcopy(HeKEY_sv(entry));
11901 return sv_2mortal(newSVhek(HeKEY_hek(entry)));
11907 /* Look for an entry in the array whose value has the same SV as val;
11908 * If so, return the index, otherwise return -1. */
11911 S_find_array_subscript(pTHX_ AV *av, SV* val)
11914 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
11915 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
11918 if (val != &PL_sv_undef) {
11919 SV ** const svp = AvARRAY(av);
11922 for (i=AvFILLp(av); i>=0; i--)
11929 /* S_varname(): return the name of a variable, optionally with a subscript.
11930 * If gv is non-zero, use the name of that global, along with gvtype (one
11931 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
11932 * targ. Depending on the value of the subscript_type flag, return:
11935 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
11936 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
11937 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
11938 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
11941 S_varname(pTHX_ GV *gv, const char gvtype, PADOFFSET targ,
11942 SV* keyname, I32 aindex, int subscript_type)
11945 SV * const name = sv_newmortal();
11948 buffer[0] = gvtype;
11951 /* as gv_fullname4(), but add literal '^' for $^FOO names */
11953 gv_fullname4(name, gv, buffer, 0);
11955 if ((unsigned int)SvPVX(name)[1] <= 26) {
11957 buffer[1] = SvPVX(name)[1] + 'A' - 1;
11959 /* Swap the 1 unprintable control character for the 2 byte pretty
11960 version - ie substr($name, 1, 1) = $buffer; */
11961 sv_insert(name, 1, 1, buffer, 2);
11965 CV * const cv = find_runcv(NULL);
11969 if (!cv || !CvPADLIST(cv))
11971 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
11972 sv = *av_fetch(av, targ, FALSE);
11973 sv_setpvn(name, SvPV_nolen_const(sv), SvCUR(sv));
11976 if (subscript_type == FUV_SUBSCRIPT_HASH) {
11977 SV * const sv = newSV(0);
11978 *SvPVX(name) = '$';
11979 Perl_sv_catpvf(aTHX_ name, "{%s}",
11980 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
11983 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
11984 *SvPVX(name) = '$';
11985 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
11987 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
11988 Perl_sv_insert(aTHX_ name, 0, 0, STR_WITH_LEN("within "));
11995 =for apidoc find_uninit_var
11997 Find the name of the undefined variable (if any) that caused the operator o
11998 to issue a "Use of uninitialized value" warning.
11999 If match is true, only return a name if it's value matches uninit_sv.
12000 So roughly speaking, if a unary operator (such as OP_COS) generates a
12001 warning, then following the direct child of the op may yield an
12002 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
12003 other hand, with OP_ADD there are two branches to follow, so we only print
12004 the variable name if we get an exact match.
12006 The name is returned as a mortal SV.
12008 Assumes that PL_op is the op that originally triggered the error, and that
12009 PL_comppad/PL_curpad points to the currently executing pad.
12015 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
12023 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
12024 uninit_sv == &PL_sv_placeholder)))
12027 switch (obase->op_type) {
12034 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
12035 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
12038 int subscript_type = FUV_SUBSCRIPT_WITHIN;
12040 if (pad) { /* @lex, %lex */
12041 sv = PAD_SVl(obase->op_targ);
12045 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
12046 /* @global, %global */
12047 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
12050 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
12052 else /* @{expr}, %{expr} */
12053 return find_uninit_var(cUNOPx(obase)->op_first,
12057 /* attempt to find a match within the aggregate */
12059 keysv = find_hash_subscript((HV*)sv, uninit_sv);
12061 subscript_type = FUV_SUBSCRIPT_HASH;
12064 index = find_array_subscript((AV*)sv, uninit_sv);
12066 subscript_type = FUV_SUBSCRIPT_ARRAY;
12069 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
12072 return varname(gv, hash ? '%' : '@', obase->op_targ,
12073 keysv, index, subscript_type);
12077 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
12079 return varname(NULL, '$', obase->op_targ,
12080 NULL, 0, FUV_SUBSCRIPT_NONE);
12083 gv = cGVOPx_gv(obase);
12084 if (!gv || (match && GvSV(gv) != uninit_sv))
12086 return varname(gv, '$', 0, NULL, 0, FUV_SUBSCRIPT_NONE);
12089 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
12092 av = (AV*)PAD_SV(obase->op_targ);
12093 if (!av || SvRMAGICAL(av))
12095 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12096 if (!svp || *svp != uninit_sv)
12099 return varname(NULL, '$', obase->op_targ,
12100 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12103 gv = cGVOPx_gv(obase);
12109 if (!av || SvRMAGICAL(av))
12111 svp = av_fetch(av, (I32)obase->op_private, FALSE);
12112 if (!svp || *svp != uninit_sv)
12115 return varname(gv, '$', 0,
12116 NULL, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
12121 o = cUNOPx(obase)->op_first;
12122 if (!o || o->op_type != OP_NULL ||
12123 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
12125 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
12129 if (PL_op == obase)
12130 /* $a[uninit_expr] or $h{uninit_expr} */
12131 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
12134 o = cBINOPx(obase)->op_first;
12135 kid = cBINOPx(obase)->op_last;
12137 /* get the av or hv, and optionally the gv */
12139 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
12140 sv = PAD_SV(o->op_targ);
12142 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
12143 && cUNOPo->op_first->op_type == OP_GV)
12145 gv = cGVOPx_gv(cUNOPo->op_first);
12148 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
12153 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
12154 /* index is constant */
12158 if (obase->op_type == OP_HELEM) {
12159 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
12160 if (!he || HeVAL(he) != uninit_sv)
12164 SV * const * const svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
12165 if (!svp || *svp != uninit_sv)
12169 if (obase->op_type == OP_HELEM)
12170 return varname(gv, '%', o->op_targ,
12171 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
12173 return varname(gv, '@', o->op_targ, NULL,
12174 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
12177 /* index is an expression;
12178 * attempt to find a match within the aggregate */
12179 if (obase->op_type == OP_HELEM) {
12180 SV * const keysv = find_hash_subscript((HV*)sv, uninit_sv);
12182 return varname(gv, '%', o->op_targ,
12183 keysv, 0, FUV_SUBSCRIPT_HASH);
12186 const I32 index = find_array_subscript((AV*)sv, uninit_sv);
12188 return varname(gv, '@', o->op_targ,
12189 NULL, index, FUV_SUBSCRIPT_ARRAY);
12194 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
12196 o->op_targ, NULL, 0, FUV_SUBSCRIPT_WITHIN);
12201 /* only examine RHS */
12202 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
12205 o = cUNOPx(obase)->op_first;
12206 if (o->op_type == OP_PUSHMARK)
12209 if (!o->op_sibling) {
12210 /* one-arg version of open is highly magical */
12212 if (o->op_type == OP_GV) { /* open FOO; */
12214 if (match && GvSV(gv) != uninit_sv)
12216 return varname(gv, '$', 0,
12217 NULL, 0, FUV_SUBSCRIPT_NONE);
12219 /* other possibilities not handled are:
12220 * open $x; or open my $x; should return '${*$x}'
12221 * open expr; should return '$'.expr ideally
12227 /* ops where $_ may be an implicit arg */
12231 if ( !(obase->op_flags & OPf_STACKED)) {
12232 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
12233 ? PAD_SVl(obase->op_targ)
12236 sv = sv_newmortal();
12237 sv_setpvn(sv, "$_", 2);
12246 /* skip filehandle as it can't produce 'undef' warning */
12247 o = cUNOPx(obase)->op_first;
12248 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
12249 o = o->op_sibling->op_sibling;
12255 match = 1; /* XS or custom code could trigger random warnings */
12260 /* XXX tmp hack: these two may call an XS sub, and currently
12261 XS subs don't have a SUB entry on the context stack, so CV and
12262 pad determination goes wrong, and BAD things happen. So, just
12263 don't try to determine the value under those circumstances.
12264 Need a better fix at dome point. DAPM 11/2007 */
12268 /* def-ness of rval pos() is independent of the def-ness of its arg */
12269 if ( !(obase->op_flags & OPf_MOD))
12274 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
12275 return newSVpvs_flags("${$/}", SVs_TEMP);
12280 if (!(obase->op_flags & OPf_KIDS))
12282 o = cUNOPx(obase)->op_first;
12288 /* if all except one arg are constant, or have no side-effects,
12289 * or are optimized away, then it's unambiguous */
12291 for (kid=o; kid; kid = kid->op_sibling) {
12293 const OPCODE type = kid->op_type;
12294 if ( (type == OP_CONST && SvOK(cSVOPx_sv(kid)))
12295 || (type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
12296 || (type == OP_PUSHMARK)
12300 if (o2) { /* more than one found */
12307 return find_uninit_var(o2, uninit_sv, match);
12309 /* scan all args */
12311 sv = find_uninit_var(o, uninit_sv, 1);
12323 =for apidoc report_uninit
12325 Print appropriate "Use of uninitialized variable" warning
12331 Perl_report_uninit(pTHX_ SV* uninit_sv)
12335 SV* varname = NULL;
12337 varname = find_uninit_var(PL_op, uninit_sv,0);
12339 sv_insert(varname, 0, 0, " ", 1);
12341 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12342 varname ? SvPV_nolen_const(varname) : "",
12343 " in ", OP_DESC(PL_op));
12346 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
12352 * c-indentation-style: bsd
12353 * c-basic-offset: 4
12354 * indent-tabs-mode: t
12357 * ex: set ts=8 sts=4 sw=4 noet: